]> git.evergreen-ils.org Git - Evergreen.git/blob - Open-ILS/web/js/ui/default/staff/circ/patron/regctl.js
9f6dbeb3559b84d4f3fdc30e4ef12c1ae4be106a
[Evergreen.git] / Open-ILS / web / js / ui / default / staff / circ / patron / regctl.js
1
2 angular.module('egCoreMod')
3 // toss tihs onto egCoreMod since the page app may vary
4
5 .factory('patronRegSvc', ['$q', '$filter', 'egCore', 'egLovefield', function($q, $filter, egCore, egLovefield) {
6
7     var service = {
8         field_doc : {},            // config.idl_field_doc
9         profiles : [],             // permission groups
10         profile_entries : [],      // permission gorup display entries
11         edit_profiles : [],        // perm groups we can modify
12         edit_profile_entries : [], // perm group display entries we can modify
13         sms_carriers : [],
14         user_settings : {},        // applied user settings
15         user_setting_types : {},   // config.usr_setting_type
16         opt_in_setting_types : {}, // config.usr_setting_type for event-def opt-in
17         surveys : [],
18         survey_questions : {},
19         survey_answers : {},
20         survey_responses : {},     // survey.responses for loaded patron in progress
21         stat_cats : [],
22         stat_cat_entry_maps : {},   // cat.id to selected value
23         virt_id : -1,               // virtual ID for new objects
24         init_done : false           // have we loaded our initialization data?
25     };
26
27     // Launch a series of parallel data retrieval calls.
28     service.init = function(scope) {
29
30         // These are fetched with every instance of the page.
31         var page_data = [
32             service.get_user_settings(),
33             service.get_clone_user(),
34             service.get_stage_user()
35         ];
36
37         var common_data = [];
38         if (!service.init_done) {
39             // These are fetched with every instance of the app.
40             common_data = [
41                 service.get_field_doc(),
42                 service.get_perm_groups(),
43                 service.get_perm_group_entries(),
44                 service.get_ident_types(),
45                 service.get_org_settings(),
46                 service.get_stat_cats(),
47                 service.get_surveys(),
48                 service.get_net_access_levels()
49             ];
50             service.init_done = true;
51         }
52
53         return $q.all(common_data.concat(page_data));
54     };
55
56     service.get_clone_user = function() {
57         if (!service.clone_id) return $q.when();
58         // we could load egUser and use its get() function, but loading
59         // user.js into the standalone register UI would mean creating a
60         // new module, since egUser is not loaded into egCoreMod.  This
61         // is a lot simpler.
62         return egCore.net.request(
63             'open-ils.actor',
64             'open-ils.actor.user.fleshed.retrieve',
65             egCore.auth.token(), service.clone_id, 
66             ['billing_address', 'mailing_address'])
67         .then(function(cuser) {
68             if (e = egCore.evt.parse(cuser)) {
69                 alert(e);
70             } else {
71                 service.clone_user = cuser;
72             }
73         });
74     }
75
76     // When editing a user with addresses linked to other users, fetch
77     // the linked user(s) so we can display their names and edit links.
78     service.get_linked_addr_users = function(addrs) {
79         angular.forEach(addrs, function(addr) {
80             if (addr.usr == service.existing_patron.id()) return;
81             egCore.pcrud.retrieve('au', addr.usr)
82             .then(function(usr) {
83                 addr._linked_owner_id = usr.id();
84                 addr._linked_owner = service.format_name(
85                     usr.family_name(),
86                     usr.first_given_name(),
87                     usr.second_given_name()
88                 );
89             })
90         });
91     }
92
93     service.apply_secondary_groups = function(user_id, group_ids) {
94         return egCore.net.request(
95             'open-ils.actor',
96             'open-ils.actor.user.set_groups',
97             egCore.auth.token(), user_id, group_ids)
98         .then(function(resp) {
99             if (resp == 1) {
100                 return true;
101             } else {
102                 // debugging -- should be no events
103                 alert('linked groups failure ' + egCore.evt.parse(resp));
104             }
105         });
106     }
107
108     service.get_stage_user = function() {
109         if (!service.stage_username) return $q.when();
110
111         // fetch the staged user object
112         return egCore.net.request(
113             'open-ils.actor',
114             'open-ils.actor.user.stage.retrieve.by_username',
115             egCore.auth.token(), 
116             service.stage_username
117         ).then(function(suser) {
118             if (e = egCore.evt.parse(suser)) {
119                 alert(e);
120             } else {
121                 service.stage_user = suser;
122             }
123         }).then(function() {
124
125             if (!service.stage_user) return;
126             var requestor = service.stage_user.user.requesting_usr();
127
128             if (!requestor) return;
129
130             // fetch the requesting user
131             return egCore.net.request(
132                 'open-ils.actor', 
133                 'open-ils.actor.user.retrieve.parts',
134                 egCore.auth.token(),
135                 requestor, 
136                 ['family_name', 'first_given_name', 'second_given_name'] 
137             ).then(function(parts) {
138                 service.stage_user_requestor = 
139                     service.format_name(parts[0], parts[1], parts[2]);
140             })
141         });
142     }
143
144     // See note above about not loading egUser.
145     // TODO: i18n
146     service.format_name = function(last, first, middle) {
147         return last + ', ' + first + (middle ? ' ' + middle : '');
148     }
149
150     service.check_dupe_username = function(usrname) {
151
152         // empty usernames can't be dupes
153         if (!usrname) return $q.when(false);
154
155         // avoid dupe check if username matches the originally loaded usrname
156         if (service.existing_patron) {
157             if (usrname == service.existing_patron.usrname())
158                 return $q.when(false);
159         }
160
161         return egCore.net.request(
162             'open-ils.actor',
163             'open-ils.actor.username.exists',
164             egCore.auth.token(), usrname);
165     }
166
167     //service.check_grp_app_perm = function(grp_id) {
168
169     // determine which user groups our user is not allowed to modify
170     service.set_edit_profiles = function() {
171         var all_app_perms = [];
172         var failed_perms = [];
173
174         // extract the application permissions
175         angular.forEach(service.profiles, function(grp) {
176             if (grp.application_perm())
177                 all_app_perms.push(grp.application_perm());
178         }); 
179
180         // fill in service.edit_profiles by inspecting failed_perms
181         function traverse_grp_tree(grp, failed) {
182             failed = failed || 
183                 failed_perms.indexOf(grp.application_perm()) > -1;
184
185             if (!failed) service.edit_profiles.push(grp);
186
187             angular.forEach(
188                 service.profiles.filter( // children of grp
189                     function(p) { return p.parent() == grp.id() }),
190                 function(child) {traverse_grp_tree(child, failed)}
191             );
192         }
193
194         return egCore.perm.hasPermAt(all_app_perms, true).then(
195             function(perm_orgs) {
196                 angular.forEach(all_app_perms, function(p) {
197                     if (perm_orgs[p].length == 0)
198                         failed_perms.push(p);
199                 });
200
201                 traverse_grp_tree(egCore.env.pgt.tree);
202             }
203         );
204     }
205
206     service.set_edit_profile_entries = function() {
207         var all_app_perms = [];
208         var failed_perms = [];
209
210         // extract the application permissions
211         angular.forEach(service.profile_entries, function(entry) {
212             if (entry.grp().application_perm())
213                 all_app_perms.push(entry.grp().application_perm());
214         });
215
216         // fill in service.edit_profiles by inspecting failed_perms
217         function traverse_grp_tree(entry, failed) {
218             failed = failed ||
219                 failed_perms.indexOf(entry.grp().application_perm()) > -1;
220
221             if (!failed) service.edit_profile_entries.push(entry);
222
223             angular.forEach(
224                 service.profile_entries.filter( // children of grp
225                     function(p) { return p.parent() == entry.id() }),
226                 function(child) {traverse_grp_tree(child, failed)}
227             );
228         }
229
230         return egCore.perm.hasPermAt(all_app_perms, true).then(
231             function(perm_orgs) {
232                 angular.forEach(all_app_perms, function(p) {
233                     if (perm_orgs[p].length == 0)
234                         failed_perms.push(p);
235                 });
236
237                 angular.forEach(egCore.env.pgtde.tree, function(tree) {
238                     traverse_grp_tree(tree);
239                 });
240             }
241         );
242     }
243
244     // resolves to a hash of perm-name => boolean value indicating
245     // wether the user has the permission at org_id.
246     service.has_perms_for_org = function(org_id) {
247
248         var perms_needed = [
249             'UPDATE_USER',
250             'CREATE_USER',
251             'CREATE_USER_GROUP_LINK', 
252             'UPDATE_PATRON_COLLECTIONS_EXEMPT',
253             'UPDATE_PATRON_CLAIM_RETURN_COUNT',
254             'UPDATE_PATRON_CLAIM_NEVER_CHECKED_OUT_COUNT',
255             'UPDATE_PATRON_ACTIVE_CARD',
256             'UPDATE_PATRON_PRIMARY_CARD'
257         ];
258
259         return egCore.perm.hasPermAt(perms_needed, true)
260         .then(function(perm_map) {
261
262             angular.forEach(perms_needed, function(perm) {
263                 perm_map[perm] = 
264                     Boolean(perm_map[perm].indexOf(org_id) > -1);
265             });
266
267             return perm_map;
268         });
269     }
270
271     service.get_surveys = function() {
272         var org_ids = egCore.org.fullPath(egCore.auth.user().ws_ou(), true);
273
274         return egCore.pcrud.search('asv', {
275                 owner : org_ids,
276                 start_date : {'<=' : 'now'},
277                 end_date : {'>=' : 'now'}
278             }, {   
279                 flesh : 2, 
280                 flesh_fields : {
281                     asv : ['questions'], 
282                     asvq : ['answers']
283                 }
284             }, 
285             {atomic : true}
286         ).then(function(surveys) {
287             surveys = surveys.sort(function(a,b) {
288                 return a.name() < b.name() ? -1 : 1 });
289             service.surveys = surveys;
290             angular.forEach(surveys, function(survey) {
291                 angular.forEach(survey.questions(), function(question) {
292                     service.survey_questions[question.id()] = question;
293                     angular.forEach(question.answers(), function(answer) {
294                         service.survey_answers[answer.id()] = answer;
295                     });
296                 });
297             });
298
299             egLovefield.setListInOfflineCache('asv', service.surveys)
300             egLovefield.setListInOfflineCache('asvq', service.survey_questions)
301             egLovefield.setListInOfflineCache('asva', service.survey_answers)
302
303         });
304     }
305
306     service.get_stat_cats = function() {
307         return egCore.net.request(
308             'open-ils.circ',
309             'open-ils.circ.stat_cat.actor.retrieve.all',
310             egCore.auth.token(), egCore.auth.user().ws_ou()
311         ).then(function(cats) {
312             cats = cats.sort(function(a, b) {
313                 return a.name() < b.name() ? -1 : 1});
314             angular.forEach(cats, function(cat) {
315                 cat.entries(
316                     cat.entries().sort(function(a,b) {
317                         return a.value() < b.value() ? -1 : 1
318                     })
319                 );
320             });
321             service.stat_cats = cats;
322             return egLovefield.setStatCatsCache(cats);
323         });
324     };
325
326     service.get_org_settings = function() {
327         return egCore.org.settings([
328             'global.password_regex',
329             'global.juvenile_age_threshold',
330             'patron.password.use_phone',
331             'ui.patron.default_inet_access_level',
332             'ui.patron.default_ident_type',
333             'ui.patron.default_country',
334             'ui.patron.registration.require_address',
335             'circ.holds.behind_desk_pickup_supported',
336             'circ.patron_edit.clone.copy_address',
337             'ui.patron.edit.au.prefix.require',
338             'ui.patron.edit.au.prefix.show',
339             'ui.patron.edit.au.prefix.suggest',
340             'ui.patron.edit.ac.barcode.regex',
341             'ui.patron.edit.au.second_given_name.show',
342             'ui.patron.edit.au.second_given_name.suggest',
343             'ui.patron.edit.au.suffix.show',
344             'ui.patron.edit.au.suffix.suggest',
345             'ui.patron.edit.au.alias.show',
346             'ui.patron.edit.au.alias.suggest',
347             'ui.patron.edit.au.dob.require',
348             'ui.patron.edit.au.dob.show',
349             'ui.patron.edit.au.dob.suggest',
350             'ui.patron.edit.au.dob.calendar',
351             'ui.patron.edit.au.juvenile.show',
352             'ui.patron.edit.au.juvenile.suggest',
353             'ui.patron.edit.au.ident_value.show',
354             'ui.patron.edit.au.ident_value.suggest',
355             'ui.patron.edit.au.ident_value2.show',
356             'ui.patron.edit.au.ident_value2.suggest',
357             'ui.patron.edit.au.email.require',
358             'ui.patron.edit.au.email.show',
359             'ui.patron.edit.au.email.suggest',
360             'ui.patron.edit.au.email.regex',
361             'ui.patron.edit.au.email.example',
362             'ui.patron.edit.au.day_phone.require',
363             'ui.patron.edit.au.day_phone.show',
364             'ui.patron.edit.au.day_phone.suggest',
365             'ui.patron.edit.au.day_phone.regex',
366             'ui.patron.edit.au.day_phone.example',
367             'ui.patron.edit.au.evening_phone.require',
368             'ui.patron.edit.au.evening_phone.show',
369             'ui.patron.edit.au.evening_phone.suggest',
370             'ui.patron.edit.au.evening_phone.regex',
371             'ui.patron.edit.au.evening_phone.example',
372             'ui.patron.edit.au.other_phone.require',
373             'ui.patron.edit.au.other_phone.show',
374             'ui.patron.edit.au.other_phone.suggest',
375             'ui.patron.edit.au.other_phone.regex',
376             'ui.patron.edit.au.other_phone.example',
377             'ui.patron.edit.phone.regex',
378             'ui.patron.edit.phone.example',
379             'ui.patron.edit.au.active.show',
380             'ui.patron.edit.au.active.suggest',
381             'ui.patron.edit.au.barred.show',
382             'ui.patron.edit.au.barred.suggest',
383             'ui.patron.edit.au.master_account.show',
384             'ui.patron.edit.au.master_account.suggest',
385             'ui.patron.edit.au.claims_returned_count.show',
386             'ui.patron.edit.au.claims_returned_count.suggest',
387             'ui.patron.edit.au.claims_never_checked_out_count.show',
388             'ui.patron.edit.au.claims_never_checked_out_count.suggest',
389             'ui.patron.edit.au.alert_message.show',
390             'ui.patron.edit.au.alert_message.suggest',
391             'ui.patron.edit.aua.post_code.regex',
392             'ui.patron.edit.aua.post_code.example',
393             'ui.patron.edit.aua.county.require',
394             'format.date',
395             'ui.patron.edit.default_suggested',
396             'opac.barcode_regex',
397             'opac.username_regex',
398             'sms.enable',
399             'ui.patron.edit.aua.state.require',
400             'ui.patron.edit.aua.state.suggest',
401             'ui.patron.edit.aua.state.show',
402             'ui.admin.work_log.max_entries',
403             'ui.admin.patron_log.max_entries'
404         ]).then(function(settings) {
405             service.org_settings = settings;
406             if (egCore && egCore.env && !egCore.env.aous) {
407                 egCore.env.aous = settings;
408                 console.log('setting egCore.env.aous');
409             }
410             return service.process_org_settings(settings);
411         });
412     };
413
414     // some org settings require the retrieval of additional data
415     service.process_org_settings = function(settings) {
416
417         var promises = [egLovefield.setSettingsCache(settings)];
418
419         if (settings['sms.enable']) {
420             // fetch SMS carriers
421             promises.push(
422                 egCore.pcrud.search('csc', 
423                     {active: 'true'}, 
424                     {'order_by':[
425                         {'class':'csc', 'field':'name'},
426                         {'class':'csc', 'field':'region'}
427                     ]}, {atomic : true}
428                 ).then(function(carriers) {
429                     service.sms_carriers = carriers;
430                 })
431             );
432         } else {
433             // if other promises are added below, this is not necessary.
434             promises.push($q.when());  
435         }
436
437         // other post-org-settings processing goes here,
438         // adding to promises as needed.
439
440         return $q.all(promises);
441     };
442
443     service.get_ident_types = function() {
444         if (egCore.env.cit) {
445             service.ident_types = egCore.env.cit.list;
446             return $q.when();
447         } else {
448             return egCore.pcrud.retrieveAll('cit', {}, {atomic : true})
449             .then(function(types) { 
450                 egCore.env.absorbList(types, 'cit')
451                 service.ident_types = types 
452             });
453         }
454     };
455
456     service.get_net_access_levels = function() {
457         if (egCore.env.cnal) {
458             service.net_access_levels = egCore.env.cnal.list;
459             return $q.when();
460         } else {
461             return egCore.pcrud.retrieveAll('cnal', {}, {atomic : true})
462             .then(function(levels) { 
463                 egCore.env.absorbList(levels, 'cnal')
464                 service.net_access_levels = levels 
465             });
466         }
467     }
468
469     service.get_perm_groups = function() {
470         if (egCore.env.pgt) {
471             service.profiles = egCore.env.pgt.list;
472             return service.set_edit_profiles();
473         } else {
474             return egCore.pcrud.search('pgt', {parent : null}, 
475                 {flesh : -1, flesh_fields : {pgt : ['children']}}
476             ).then(
477                 function(tree) {
478                     egCore.env.absorbTree(tree, 'pgt')
479                     service.profiles = egCore.env.pgt.list;
480                     return service.set_edit_profiles();
481                 }
482             );
483         }
484     }
485
486     service.searchPermGroupEntries = function(org) {
487         return egCore.pcrud.search('pgtde', {org: org, parent: null},
488             {flesh: -1, flesh_fields: {pgtde: ['grp', 'children']}}, {atomic: true}
489         ).then(function(treeArray) {
490             if (!treeArray.length && egCore.org.get(org).parent_ou()) {
491                 return service.searchPermGroupEntries(egCore.org.get(org).parent_ou());
492             }
493             return treeArray;
494         });
495     }
496
497     service.get_perm_group_entries = function() {
498         if (egCore.env.pgtde) {
499             service.profile_entries = egCore.env.pgtde.list;
500             return service.set_edit_profile_entries();
501         } else {
502             return service.searchPermGroupEntries(egCore.auth.user().ws_ou()).then(function(treeArray) {
503                 function compare(a,b) {
504                   if (a.position() > b.position())
505                     return -1;
506                   if (a.position() < b.position())
507                     return 1;
508                   return 0;
509                 }
510
511                 var list = [];
512                 function squash(node) {
513                     node.children().sort(compare);
514                     list.push(node);
515                     angular.forEach(node.children(), squash);
516                 }
517
518                 angular.forEach(treeArray, squash);
519                 var blob = egCore.env.absorbList(list, 'pgtde');
520                 blob.tree = treeArray;
521
522                 service.profile_entries = egCore.env.pgtde.list;
523                 return service.set_edit_profile_entries();
524             });
525         }
526     }
527
528     service.get_field_doc = function() {
529         var to_cache = [];
530         return egCore.pcrud.search('fdoc', {
531             fm_class: ['au', 'ac', 'aua', 'actsc', 'asv', 'asvq', 'asva']})
532         .then(
533             function () {
534                 return egLovefield.setListInOfflineCache('fdoc', to_cache)
535             },
536             null,
537             function(doc) {
538                 if (!service.field_doc[doc.fm_class()]) {
539                     service.field_doc[doc.fm_class()] = {};
540                 }
541                 service.field_doc[doc.fm_class()][doc.field()] = doc;
542                 to_cache.push(doc);
543             }
544         );
545
546     };
547
548     service.get_user_setting_types = function() {
549
550         // No need to re-fetch the common setting types.
551         if (Object.keys(service.user_setting_types).length) 
552             return $q.when();
553
554         var org_ids = egCore.org.ancestors(egCore.auth.user().ws_ou(), true);
555
556         var static_types = [
557             'circ.holds_behind_desk', 
558             'circ.collections.exempt', 
559             'opac.hold_notify', 
560             'opac.default_phone', 
561             'opac.default_pickup_location', 
562             'opac.default_sms_carrier', 
563             'opac.default_sms_notify'];
564
565         return egCore.pcrud.search('cust', {
566             '-or' : [
567                 {name : static_types}, // common user settings
568                 {name : { // opt-in notification user settings
569                     'in': {
570                         select : {atevdef : ['opt_in_setting']}, 
571                         from : 'atevdef',
572                         // we only care about opt-in settings for 
573                         // event_defs our users encounter
574                         where : {'+atevdef' : {owner : org_ids}}
575                     }
576                 }}
577             ]
578         }, {}, {atomic : true}).then(function(setting_types) {
579
580             egCore.env.absorbList(setting_types, 'cust'); // why not...
581
582             angular.forEach(setting_types, function(stype) {
583                 service.user_setting_types[stype.name()] = stype;
584                 if (static_types.indexOf(stype.name()) == -1) {
585                     service.opt_in_setting_types[stype.name()] = stype;
586                 }
587             });
588         });
589     };
590
591     service.get_user_settings = function() {
592
593         return service.get_user_setting_types()
594         .then(function() {
595
596             var setting_types = Object.values(service.user_setting_types);
597
598             if (service.patron_id) {
599                 // retrieve applied values for the current user 
600                 // for the setting types we care about.
601
602                 var setting_names = 
603                     setting_types.map(function(obj) { return obj.name() });
604
605                 return egCore.net.request(
606                     'open-ils.actor', 
607                     'open-ils.actor.patron.settings.retrieve.authoritative',
608                     egCore.auth.token(),
609                     service.patron_id,
610                     setting_names
611                 ).then(function(settings) {
612                     service.user_settings = settings;
613                 });
614
615             } else {
616
617                 // apply default user setting values
618                 angular.forEach(setting_types, function(stype, index) {
619                     if (stype.reg_default() != undefined) {
620                         var val = stype.reg_default();
621                         if (stype.datatype() == 'bool') {
622                             // A boolean user setting type whose default 
623                             // value starts with t/T is considered 'true',
624                             // false otherwise.
625                             val = Boolean((val+'').match(/^t/i));
626                         }
627                         service.user_settings[stype.name()] = val;
628                     }
629                 });
630             }
631         });
632     }
633
634     service.invalidate_field = function(patron, field) {
635         console.log('Invalidating patron field ' + field);
636
637         return egCore.net.request(
638             'open-ils.actor',
639             'open-ils.actor.invalidate.' + field,
640             egCore.auth.token(), patron.id, null, patron.home_ou.id()
641
642         ).then(function(res) {
643             // clear the invalid value from the form
644             patron[field] = '';
645
646             // update last_xact_id so future save operations
647             // on this patron will be allowed
648             patron.last_xact_id = res.payload.last_xact_id[patron.id];
649         });
650     }
651
652     service.dupe_patron_search = function(patron, type, value) {
653         var search;
654
655         console.log('Dupe search called with "'+ type +'" and value '+ value);
656
657         if (type.match(/phone/)) type = 'phone'; // day_phone, etc.
658
659         switch (type) {
660
661             case 'name':
662                 var fname = patron.first_given_name;   
663                 var lname = patron.family_name;   
664                 if (!(fname && lname)) return $q.when({count:0});
665                 search = {
666                     first_given_name : {value : fname, group : 0},
667                     family_name : {value : lname, group : 0}
668                 };
669                 break;
670
671             case 'email':
672                 search = {email : {value : value, group : 0}};
673                 break;
674
675             case 'ident':
676                 search = {ident : {value : value, group : 2}};
677                 break;
678
679             case 'phone':
680                 search = {phone : {value : value, group : 2}};
681                 break;
682
683             case 'address':
684                 search = {};
685                 angular.forEach(['street1', 'street2', 'city', 'post_code'],
686                     function(field) {
687                         if(value[field])
688                             search[field] = {value : value[field], group: 1};
689                     }
690                 );
691                 break;
692         }
693
694         return egCore.net.request( 
695             'open-ils.actor', 
696             'open-ils.actor.patron.search.advanced',
697             egCore.auth.token(), search, null, null, 1
698         ).then(function(res) {
699             res = res.filter(function(id) {return id != patron.id});
700             return {
701                 count : res.length,
702                 search : search
703             };
704         });
705     }
706
707     service.init_patron = function(current) {
708
709         if (!current)
710             return $q.when(service.init_new_patron());
711
712         service.patron = current;
713         return $q.when(service.init_existing_patron(current));
714     }
715
716     service.ingest_address = function(patron, addr) {
717         addr.valid = addr.valid == 't';
718         addr.within_city_limits = addr.within_city_limits == 't';
719         addr._is_mailing = (patron.mailing_address && 
720             addr.id == patron.mailing_address.id);
721         addr._is_billing = (patron.billing_address && 
722             addr.id == patron.billing_address.id);
723     }
724
725     /*
726      * Existing patron objects reqire some data munging before insertion
727      * into the scope.
728      *
729      * 1. Turn everything into a hash
730      * 2. ... Except certain fields (selectors) whose widgets require objects
731      * 3. Bools must be Boolean, not t/f.
732      */
733     service.init_existing_patron = function(current) {
734
735         service.existing_patron = current;
736
737         var patron = egCore.idl.toHash(current);
738
739         patron.home_ou = egCore.org.get(patron.home_ou.id);
740         patron.expire_date = new Date(Date.parse(patron.expire_date));
741         patron.dob = service.parse_dob(patron.dob);
742         patron.profile = current.profile(); // pre-hash version
743         patron.net_access_level = current.net_access_level();
744         patron.ident_type = current.ident_type();
745         patron.ident_type2 = current.ident_type2();
746         patron.groups = current.groups(); // pre-hash
747
748         angular.forEach(
749             ['juvenile', 'barred', 'active', 'master_account'],
750             function(field) { patron[field] = patron[field] == 't'; }
751         );
752
753         angular.forEach(patron.cards, function(card) {
754             card.active = card.active == 't';
755             if (card.id == patron.card.id) {
756                 patron.card = card;
757                 card._primary = 'on';
758             }
759         });
760
761         angular.forEach(patron.addresses, 
762             function(addr) { service.ingest_address(patron, addr) });
763
764         service.get_linked_addr_users(patron.addresses);
765
766         // Remove stat cat entries that link to out-of-scope stat
767         // cats.  With this, we avoid unnecessarily updating (or worse,
768         // modifying) stat cat values that are not ours to modify.
769         patron.stat_cat_entries = patron.stat_cat_entries.filter(
770             function(map) {
771                 return Boolean(
772                     // service.stat_cats only contains in-scope stat cats.
773                     service.stat_cats.filter(function(cat) { 
774                         return (cat.id() == map.stat_cat.id) })[0]
775                 );
776             }
777         );
778
779         // toss entries for existing stat cat maps into our living 
780         // stat cat entry map, which is modified within the template.
781         angular.forEach(patron.stat_cat_entries, function(map) {
782             service.stat_cat_entry_maps[map.stat_cat.id] = map.stat_cat_entry;
783         });
784
785         service.patron = patron;
786         return patron;
787     }
788
789     service.init_new_patron = function() {
790         var addr = {
791             id : service.virt_id--,
792             isnew : true,
793             valid : true,
794             address_type : egCore.strings.REG_ADDR_TYPE,
795             _is_mailing : true,
796             _is_billing : true,
797             within_city_limits : false,
798             country : service.org_settings['ui.patron.default_country'],
799         };
800
801         var card = {
802             id : service.virt_id--,
803             isnew : true,
804             active : true,
805             _primary : 'on'
806         };
807
808         var user = {
809             isnew : true,
810             active : true,
811             card : card,
812             cards : [card],
813             home_ou : egCore.org.get(egCore.auth.user().ws_ou()),
814             stat_cat_entries : [],
815             groups : [],
816             addresses : [addr]
817         };
818
819         if (service.clone_user)
820             service.copy_clone_data(user);
821
822         if (service.stage_user)
823             service.copy_stage_data(user);
824
825         return user;
826     }
827
828     // dob is always YYYY-MM-DD
829     // Dates of birth do not contain timezone info, which can lead to
830     // inconcistent timezone handling, potentially representing
831     // different points in time, depending on the implementation.
832     // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse
833     // See "Differences in assumed time zone"
834     // TODO: move this into egDate ?
835     service.parse_dob = function(dob) {
836         if (!dob) return null;
837         var parts = dob.split('-');
838         return new Date(parts[0], parts[1] - 1, parts[2])
839     }
840
841     service.copy_stage_data = function(user) {
842         var cuser = service.stage_user;
843
844         // copy the data into our new user object
845
846         for (var key in egCore.idl.classes.stgu.field_map) {
847             if (egCore.idl.classes.au.field_map[key] &&
848                 !egCore.idl.classes.stgu.field_map[key].virtual) {
849                 if (cuser.user[key]() !== null)
850                     user[key] = cuser.user[key]();
851             }
852         }
853
854         if (user.home_ou) user.home_ou = egCore.org.get(user.home_ou);
855         if (user.profile) user.profile = egCore.env.pgt.map[user.profile];
856         if (user.ident_type) 
857             user.ident_type = egCore.env.cit.map[user.ident_type];
858         if (user.ident_type2)
859             user.ident_type2 = egCore.env.cit.map[user.ident_type2];
860         user.dob = service.parse_dob(user.dob);
861
862         // Clear the usrname if it looks like a UUID
863         if (user.usrname.replace(/-/g,'').match(/[0-9a-f]{32}/)) 
864             user.usrname = '';
865
866         // Don't use stub address if we have one from the staged user.
867         if (cuser.mailing_addresses.length || cuser.billing_addresses.length)
868             user.addresses = [];
869
870         // is_mailing=false implies is_billing
871         function addr_from_stage(stage_addr) {
872             if (!stage_addr) return;
873             var cls = stage_addr.classname;
874
875             var addr = {
876                 id : service.virt_id--,
877                 usr : user.id,
878                 isnew : true,
879                 valid : true,
880                 _is_mailing : cls == 'stgma',
881                 _is_billing : cls == 'stgba'
882             };
883
884             user.mailing_address = addr;
885             user.addresses.push(addr);
886
887             for (var key in egCore.idl.classes[cls].field_map) {
888                 if (egCore.idl.classes.aua.field_map[key] &&
889                     !egCore.idl.classes[cls].field_map[key].virtual) {
890                     if (stage_addr[key]() !== null)
891                         addr[key] = stage_addr[key]();
892                 }
893             }
894         }
895
896         addr_from_stage(cuser.mailing_addresses[0]);
897         addr_from_stage(cuser.billing_addresses[0]);
898
899         if (user.addresses.length == 1) {
900             // If there is only one address, 
901             // use it as both mailing and billing.
902             var addr = user.addresses[0];
903             addr._is_mailing = addr._is_billing = true;
904             user.mailing_address = user.billing_address = addr;
905         }
906
907         if (cuser.cards.length) {
908             user.card = {
909                 id : service.virt_id--,
910                 barcode : cuser.cards[0].barcode(),
911                 isnew : true,
912                 active : true,
913                 _primary : 'on'
914             };
915
916             user.cards.push(user.card);
917             if (user.usrname == '') 
918                 user.usrname = card.barcode;
919         }
920
921         angular.forEach(cuser.settings, function(setting) {
922             service.user_settings[setting.setting()] = Boolean(setting.value());
923         });
924     }
925
926     // copy select values from the cloned user to the new user.
927     // user is a hash
928     service.copy_clone_data = function(user) {
929         var clone_user = service.clone_user;
930
931         // flesh the home org locally
932         user.home_ou = egCore.org.get(clone_user.home_ou());
933         if (user.profile) user.profile = egCore.env.pgt.map[user.profile];
934
935         if (!clone_user.billing_address() &&
936             !clone_user.mailing_address())
937             return; // no addresses to copy or link
938
939         // if the cloned user has any addresses, we don't need 
940         // the stub address created in init_new_patron.
941         user.addresses = [];
942
943         var copy_addresses = 
944             service.org_settings['circ.patron_edit.clone.copy_address'];
945
946         var clone_fields = [
947             'day_phone',
948             'evening_phone',
949             'other_phone',
950             'usrgroup'
951         ]; 
952
953         angular.forEach(clone_fields, function(field) {
954             user[field] = clone_user[field]();
955         });
956
957         if (copy_addresses) {
958             var bill_addr, mail_addr;
959
960             // copy the billing and mailing addresses into new addresses
961             function clone_addr(addr) {
962                 var new_addr = egCore.idl.toHash(addr);
963                 new_addr.id = service.virt_id--;
964                 new_addr.usr = user.id;
965                 new_addr.isnew = true;
966                 new_addr.valid = true;
967                 user.addresses.push(new_addr);
968                 return new_addr;
969             }
970
971             if (bill_addr = clone_user.billing_address()) {
972                 var addr = clone_addr(bill_addr);
973                 addr._is_billing = true;
974                 user.billing_address = addr;
975             }
976
977             if (mail_addr = clone_user.mailing_address()) {
978
979                 if (bill_addr && bill_addr.id() == mail_addr.id()) {
980                     user.mailing_address = user.billing_address;
981                     user.mailing_address._is_mailing = true;
982                 } else {
983                     var addr = clone_addr(mail_addr);
984                     addr._is_mailing = true;
985                     user.mailing_address = addr;
986                 }
987
988                 if (!bill_addr) {
989                     // if there is no billing addr, use the mailing addr
990                     user.billing_address = user.mailing_address;
991                     user.billing_address._is_billing = true;
992                 }
993             }
994
995
996         } else {
997
998             // link the billing and mailing addresses
999             var addr;
1000             if (addr = clone_user.billing_address()) {
1001                 user.billing_address = egCore.idl.toHash(addr);
1002                 user.billing_address._is_billing = true;
1003                 user.addresses.push(user.billing_address);
1004                 user.billing_address._linked_owner_id = clone_user.id();
1005                 user.billing_address._linked_owner = service.format_name(
1006                     clone_user.family_name(),
1007                     clone_user.first_given_name(),
1008                     clone_user.second_given_name()
1009                 );
1010             }
1011
1012             if (addr = clone_user.mailing_address()) {
1013                 if (user.billing_address && 
1014                     addr.id() == user.billing_address.id) {
1015                     // mailing matches billing
1016                     user.mailing_address = user.billing_address;
1017                     user.mailing_address._is_mailing = true;
1018                 } else {
1019                     user.mailing_address = egCore.idl.toHash(addr);
1020                     user.mailing_address._is_mailing = true;
1021                     user.addresses.push(user.mailing_address);
1022                     user.mailing_address._linked_owner_id = clone_user.id();
1023                     user.mailing_address._linked_owner = service.format_name(
1024                         clone_user.family_name(),
1025                         clone_user.first_given_name(),
1026                         clone_user.second_given_name()
1027                     );
1028                 }
1029             }
1030         }
1031     }
1032
1033     // translate the patron back into IDL form
1034     service.save_user = function(phash) {
1035
1036         var patron = egCore.idl.fromHash('au', phash);
1037
1038         patron.home_ou(patron.home_ou().id());
1039         patron.expire_date(patron.expire_date().toISOString());
1040         patron.profile(patron.profile().id());
1041         if (patron.dob()) 
1042             patron.dob(patron.dob().toISOString().replace(/T.*/,''));
1043         if (patron.ident_type()) 
1044             patron.ident_type(patron.ident_type().id());
1045         if (patron.net_access_level())
1046             patron.net_access_level(patron.net_access_level().id());
1047
1048         angular.forEach(
1049             ['juvenile', 'barred', 'active', 'master_account'],
1050             function(field) { patron[field](phash[field] ? 't' : 'f'); }
1051         );
1052
1053         var card_hashes = patron.cards();
1054         patron.cards([]);
1055         angular.forEach(card_hashes, function(chash) {
1056             var card = egCore.idl.fromHash('ac', chash)
1057             card.usr(patron.id());
1058             card.active(chash.active ? 't' : 'f');
1059             patron.cards().push(card);
1060             if (chash._primary) {
1061                 patron.card(card);
1062             }
1063         });
1064
1065         var addr_hashes = patron.addresses();
1066         patron.addresses([]);
1067         angular.forEach(addr_hashes, function(addr_hash) {
1068             if (!addr_hash.isnew && !addr_hash.isdeleted) 
1069                 addr_hash.ischanged = true;
1070             var addr = egCore.idl.fromHash('aua', addr_hash);
1071             patron.addresses().push(addr);
1072             addr.valid(addr.valid() ? 't' : 'f');
1073             addr.within_city_limits(addr.within_city_limits() ? 't' : 'f');
1074             if (addr_hash._is_mailing) patron.mailing_address(addr);
1075             if (addr_hash._is_billing) patron.billing_address(addr);
1076         });
1077
1078         patron.survey_responses([]);
1079         angular.forEach(service.survey_responses, function(answer) {
1080             var question = service.survey_questions[answer.question()];
1081             var resp = new egCore.idl.asvr();
1082             resp.isnew(true);
1083             resp.survey(question.survey());
1084             resp.question(question.id());
1085             resp.answer(answer.id());
1086             resp.usr(patron.id());
1087             resp.answer_date('now');
1088             patron.survey_responses().push(resp);
1089         });
1090         
1091         // re-object-ify the patron stat cat entry maps
1092         var maps = [];
1093         angular.forEach(patron.stat_cat_entries(), function(entry) {
1094             var e = egCore.idl.fromHash('actscecm', entry);
1095             e.stat_cat(e.stat_cat().id);
1096             maps.push(e);
1097         });
1098         patron.stat_cat_entries(maps);
1099
1100         // service.stat_cat_entry_maps maps stats to values
1101         // patron.stat_cat_entries is an array of stat_cat_entry_usr_map's
1102         angular.forEach(
1103             service.stat_cat_entry_maps, function(value, cat_id) {
1104
1105             // see if we already have a mapping for this entry
1106             var existing = patron.stat_cat_entries().filter(
1107                 function(e) { return e.stat_cat() == cat_id })[0];
1108
1109             if (existing) { // we have a mapping
1110                 // if the existing mapping matches the new one,
1111                 // there' nothing left to do
1112                 if (existing.stat_cat_entry() == value) return;
1113
1114                 // mappings differ.  delete the old one and create
1115                 // a new one below.
1116                 existing.isdeleted(true);
1117             }
1118
1119             var newmap = new egCore.idl.actscecm();
1120             newmap.target_usr(patron.id());
1121             newmap.isnew(true);
1122             newmap.stat_cat(cat_id);
1123             newmap.stat_cat_entry(value);
1124             patron.stat_cat_entries().push(newmap);
1125         });
1126
1127         if (!patron.isnew()) patron.ischanged(true);
1128
1129         return egCore.net.request(
1130             'open-ils.actor', 
1131             'open-ils.actor.patron.update',
1132             egCore.auth.token(), patron);
1133     }
1134
1135     service.remove_staged_user = function() {
1136         if (!service.stage_user) return $q.when();
1137         return egCore.net.request(
1138             'open-ils.actor',
1139             'open-ils.actor.user.stage.delete',
1140             egCore.auth.token(),
1141             service.stage_user.user.row_id()
1142         );
1143     }
1144
1145     service.save_user_settings = function(new_user, user_settings) {
1146
1147         var settings = {};
1148         if (service.patron_id) {
1149             // Update all user editor setting values for existing 
1150             // users regardless of whether a value changed.
1151             settings = user_settings;
1152
1153         } else {
1154             // Create settings for all non-null setting values for new patrons.
1155             angular.forEach(user_settings, function(val, key) {
1156                 if (val !== null) settings[key] = val;
1157             });
1158         }
1159
1160         if (Object.keys(settings).length == 0) return $q.when();
1161
1162         return egCore.net.request(
1163             'open-ils.actor',
1164             'open-ils.actor.patron.settings.update',
1165             egCore.auth.token(), new_user.id(), settings
1166         ).then(function(resp) {
1167             return resp;
1168         });
1169     }
1170
1171     // Applies field-specific validation regex's from org settings 
1172     // to form fields.  Be careful not remove any pattern data we
1173     // are not explicitly over-writing in the provided patterns obj.
1174     service.set_field_patterns = function(patterns) {
1175         if (service.org_settings['opac.username_regex']) {
1176             patterns.au.usrname = 
1177                 new RegExp(service.org_settings['opac.username_regex']);
1178         }
1179
1180         if (service.org_settings['ui.patron.edit.ac.barcode.regex']) {
1181             patterns.ac.barcode = 
1182                 new RegExp(service.org_settings['ui.patron.edit.ac.barcode.regex']);
1183         }
1184
1185         if (service.org_settings['global.password_regex']) {
1186             patterns.au.passwd = 
1187                 new RegExp(service.org_settings['global.password_regex']);
1188         }
1189
1190         var phone_reg = service.org_settings['ui.patron.edit.phone.regex'];
1191         if (phone_reg) {
1192             // apply generic phone regex first, replace below as needed.
1193             patterns.au.day_phone = new RegExp(phone_reg);
1194             patterns.au.evening_phone = new RegExp(phone_reg);
1195             patterns.au.other_phone = new RegExp(phone_reg);
1196         }
1197
1198         // the remaining patterns fit a well-known key name pattern
1199
1200         angular.forEach(service.org_settings, function(val, key) {
1201             if (!val) return;
1202             var parts = key.match(/ui.patron.edit\.(\w+)\.(\w+)\.regex/);
1203             if (!parts) return;
1204             var cls = parts[1];
1205             var name = parts[2];
1206             patterns[cls][name] = new RegExp(val);
1207         });
1208     }
1209
1210     return service;
1211 }])
1212
1213 .controller('PatronRegCtrl',
1214        ['$scope','$routeParams','$q','$uibModal','$window','egCore',
1215         'patronSvc','patronRegSvc','egUnloadPrompt','egAlertDialog',
1216         'egWorkLog',
1217 function($scope , $routeParams , $q , $uibModal , $window , egCore ,
1218          patronSvc , patronRegSvc , egUnloadPrompt, egAlertDialog ,
1219          egWorkLog) {
1220
1221     $scope.page_data_loaded = false;
1222     $scope.hold_notify_type = { phone : null, email : null, sms : null };
1223     $scope.clone_id = patronRegSvc.clone_id = $routeParams.clone_id;
1224     $scope.stage_username = 
1225         patronRegSvc.stage_username = $routeParams.stage_username;
1226     $scope.patron_id = 
1227         patronRegSvc.patron_id = $routeParams.edit_id || $routeParams.id;
1228
1229     // for existing patrons, disable barcode input by default
1230     $scope.disable_bc = $scope.focus_usrname = Boolean($scope.patron_id);
1231     $scope.focus_bc = !Boolean($scope.patron_id);
1232     $scope.address_alerts = [];
1233     $scope.dupe_counts = {};
1234
1235     // map of perm name to true/false for perms the logged in user
1236     // has at the currently selected patron home org unit.
1237     $scope.perms = {};
1238
1239     $scope.name_tab = 'primary';
1240
1241     if (!$scope.edit_passthru) {
1242         // in edit more, scope.edit_passthru is delivered to us by
1243         // the enclosing controller.  In register mode, there is 
1244         // no enclosing controller, so we create our own.
1245         $scope.edit_passthru = {};
1246     }
1247
1248     // 0=all, 1=suggested, 2=all
1249     $scope.edit_passthru.vis_level = 0; 
1250
1251     // Apply default values for new patrons during initial registration
1252     // prs is shorthand for patronSvc
1253     function set_new_patron_defaults(prs) {
1254         if (!$scope.patron.passwd) {
1255             // passsword may originate from staged user.
1256             $scope.generate_password();
1257         }
1258         $scope.hold_notify_type.phone = true;
1259         $scope.hold_notify_type.email = true;
1260         $scope.hold_notify_type.sms = false;
1261
1262         // staged users may be loaded w/ a profile.
1263         $scope.set_expire_date();
1264
1265         if (prs.org_settings['ui.patron.default_ident_type']) {
1266             // $scope.patron needs this field to be an object
1267             var id = prs.org_settings['ui.patron.default_ident_type'];
1268             var ident_type = $scope.ident_types.filter(
1269                 function(type) { return type.id() == id })[0];
1270             $scope.patron.ident_type = ident_type;
1271         }
1272         if (prs.org_settings['ui.patron.default_inet_access_level']) {
1273             // $scope.patron needs this field to be an object
1274             var id = prs.org_settings['ui.patron.default_inet_access_level'];
1275             var level = $scope.net_access_levels.filter(
1276                 function(lvl) { return lvl.id() == id })[0];
1277             $scope.patron.net_access_level = level;
1278         }
1279         if (prs.org_settings['ui.patron.default_country']) {
1280             $scope.patron.addresses[0].country = 
1281                 prs.org_settings['ui.patron.default_country'];
1282         }
1283     }
1284
1285     // A null or undefined pattern leads to exceptions.  Before the
1286     // patterns are loaded from the server, default all patterns
1287     // to an innocuous regex.  To avoid re-creating numerous
1288     // RegExp objects, cache the stub RegExp after initial creation.
1289     // note: angular docs say ng-pattern accepts a regexp or string,
1290     // but as of writing, it only works with a regexp object.
1291     // (Likely an angular 1.2 vs. 1.4 issue).
1292     var field_patterns = {au : {}, ac : {}, aua : {}};
1293     $scope.field_pattern = function(cls, field) { 
1294         if (!field_patterns[cls][field])
1295             field_patterns[cls][field] = new RegExp('.*');
1296         return field_patterns[cls][field];
1297     }
1298
1299     // Main page load function.  Kicks off tab init and data loading.
1300     $q.all([
1301
1302         $scope.initTab ? // initTab comes from patron app
1303             $scope.initTab('edit', $routeParams.id) : $q.when(),
1304
1305         patronRegSvc.init(),
1306
1307     ]).then(function(){ return patronRegSvc.init_patron(patronSvc ? patronSvc.current : patronRegSvc.patron ) })
1308       .then(function(patron) {
1309         // called after initTab and patronRegSvc.init have completed
1310         // in standalone mode, we have no patronSvc
1311         var prs = patronRegSvc;
1312         $scope.patron = patron;
1313         $scope.field_doc = prs.field_doc;
1314         $scope.edit_profiles = prs.edit_profiles;
1315         $scope.edit_profile_entries = prs.edit_profile_entries;
1316         $scope.ident_types = prs.ident_types;
1317         $scope.net_access_levels = prs.net_access_levels;
1318         $scope.user_setting_types = prs.user_setting_types;
1319         $scope.opt_in_setting_types = prs.opt_in_setting_types;
1320         $scope.org_settings = prs.org_settings;
1321         $scope.sms_carriers = prs.sms_carriers;
1322         $scope.stat_cats = prs.stat_cats;
1323         $scope.surveys = prs.surveys;
1324         $scope.survey_responses = prs.survey_responses;
1325         $scope.stat_cat_entry_maps = prs.stat_cat_entry_maps;
1326         $scope.stage_user = prs.stage_user;
1327         $scope.stage_user_requestor = prs.stage_user_requestor;
1328
1329         $scope.user_settings = prs.user_settings;
1330         prs.user_settings = {};
1331
1332         // If a default pickup lib is applied to the patron, apply it 
1333         // to the UI at page load time.  Otherwise, leave the value unset.
1334         if ($scope.user_settings['opac.default_pickup_location']) {
1335             $scope.patron._pickup_lib = egCore.org.get(
1336                 $scope.user_settings['opac.default_pickup_location']);
1337         }
1338
1339         extract_hold_notify();
1340         if ($scope.patron.isnew)
1341             set_new_patron_defaults(prs);
1342
1343         $scope.handle_home_org_changed();
1344
1345         if ($scope.org_settings['ui.patron.edit.default_suggested'])
1346             $scope.edit_passthru.vis_level = 1;
1347
1348         // Stat cats are fetched from open-ils.storage, where 't'==1
1349         $scope.hasRequiredStatCat = prs.stat_cats.filter(
1350                 function(cat) {return cat.required() == 1} ).length > 0;
1351
1352         $scope.page_data_loaded = true;
1353
1354         prs.set_field_patterns(field_patterns);
1355         apply_username_regex();
1356
1357         add_date_watchers();
1358     });
1359
1360     function add_date_watchers() {
1361
1362         $scope.$watch('patron.dob', function(newVal, oldVal) {
1363             // Even though this runs after page data load, there
1364             // are still times when it fires unnecessarily.
1365             if (newVal === oldVal) return;
1366
1367             console.debug('dob change: ' + newVal + ' : ' + oldVal);
1368             maintain_juvenile_flag();
1369         });
1370
1371         // No need to watch expire_date
1372     }
1373
1374
1375     // update the currently displayed field documentation
1376     $scope.set_selected_field_doc = function(cls, field) {
1377         $scope.selected_field_doc = $scope.field_doc[cls][field];
1378     }
1379
1380     // returns the tree depth of the selected profile group tree node.
1381     $scope.pgt_depth = function(grp) {
1382         var d = 0;
1383         while (grp = egCore.env.pgt.map[grp.parent()]) d++;
1384         return d;
1385     }
1386
1387     // returns the tree depth of the selected profile group tree node.
1388     $scope.pgtde_depth = function(entry) {
1389         var d = 0;
1390         while (entry = egCore.env.pgtde.map[entry.parent()]) d++;
1391         return d;
1392     }
1393
1394     // IDL fields used for labels in the UI.
1395     $scope.idl_fields = {
1396         au  : egCore.idl.classes.au.field_map,
1397         ac  : egCore.idl.classes.ac.field_map,
1398         aua : egCore.idl.classes.aua.field_map
1399     };
1400
1401     // field visibility cache.  Some fields are universally required.
1402     // 3 == value universally required
1403     // 2 == field is visible by default
1404     // 1 == field is suggested by default
1405     var field_visibility = {};
1406     var default_field_visibility = {
1407         'ac.barcode' : 3,
1408         'au.usrname' : 3,
1409         'au.passwd' :  3,
1410         'au.first_given_name' : 3,
1411         'au.family_name' : 3,
1412         'au.pref_first_given_name' : 2,
1413         'au.pref_family_name' : 2,
1414         'au.ident_type' : 3,
1415         'au.ident_type2' : 2,
1416         'au.home_ou' : 3,
1417         'au.profile' : 3,
1418         'au.expire_date' : 3,
1419         'au.net_access_level' : 3,
1420         'aua.address_type' : 3,
1421         'aua.post_code' : 3,
1422         'aua.street1' : 3,
1423         'aua.street2' : 2,
1424         'aua.city' : 3,
1425         'aua.county' : 2,
1426         'aua.state' : 2,
1427         'aua.country' : 3,
1428         'aua.valid' : 2,
1429         'aua.within_city_limits' : 2,
1430         'stat_cats' : 1,
1431         'surveys' : 1,
1432         'au.name_keywords': 1
1433     }; 
1434
1435     // Returns true if the selected field should be visible
1436     // given the current required/suggested/all setting.
1437     // The visibility flag applied to each field as a result of calling
1438     // this function also sets (via the same flag) the requiredness state.
1439     $scope.show_field = function(field_key) {
1440         // org settings have not been received yet.
1441         if (!$scope.org_settings) return false;
1442
1443         if (field_visibility[field_key] == undefined) {
1444             // compile and cache the visibility for the selected field
1445
1446             // The preferred name fields use the primary name field settings
1447             var org_key = field_key;
1448             var alt_name = false;
1449             if (field_key.match(/^au.alt_/)) {
1450                 alt_name = true;
1451                 org_key = field_key.slice(7);
1452             }
1453
1454             var req_set = 'ui.patron.edit.' + org_key + '.require';
1455             var sho_set = 'ui.patron.edit.' + org_key + '.show';
1456             var sug_set = 'ui.patron.edit.' + org_key + '.suggest';
1457
1458             if ($scope.org_settings[req_set]) {
1459                 if (alt_name) {
1460                     // Avoid requiring alt name fields when primary 
1461                     // name fields are required.
1462                     field_visibility[field_key] = 2;
1463                 } else {
1464                     field_visibility[field_key] = 3;
1465                 }
1466
1467             } else if ($scope.org_settings[sho_set]) {
1468                 field_visibility[field_key] = 2;
1469
1470             } else if ($scope.org_settings[sug_set]) {
1471                 field_visibility[field_key] = 1;
1472             }
1473         }
1474
1475         if (field_visibility[field_key] == undefined) {
1476             // No org settings were applied above.  Use the default
1477             // settings if present or assume the field has no
1478             // visibility flags applied.
1479             field_visibility[field_key] = 
1480                 default_field_visibility[field_key] || 0;
1481         }
1482
1483         return field_visibility[field_key] >= $scope.edit_passthru.vis_level;
1484     }
1485
1486     // See $scope.show_field().
1487     // A field with visbility level 3 means it's required.
1488     $scope.field_required = function(cls, field) {
1489
1490         // Value in the password field is not required
1491         // for existing patrons.
1492         if (field == 'passwd' && $scope.patron && !$scope.patron.isnew) 
1493           return false;
1494
1495         return (field_visibility[cls + '.' + field] == 3);
1496     }
1497
1498     // generates a random 4-digit password
1499     $scope.generate_password = function() {
1500         $scope.patron.passwd = Math.floor(Math.random()*9000) + 1000;
1501     }
1502
1503     $scope.set_expire_date = function() {
1504         if (!$scope.patron.profile) return;
1505         var seconds = egCore.date.intervalToSeconds(
1506             $scope.patron.profile.perm_interval());
1507         var now_epoch = new Date().getTime();
1508         $scope.patron.expire_date = new Date(
1509             now_epoch + (seconds * 1000 /* milliseconds */))
1510         $scope.field_modified();
1511     }
1512
1513     // grp is the pgt object
1514     $scope.set_profile = function(grp) {
1515         $scope.patron.profile = grp;
1516         $scope.set_expire_date();
1517         $scope.field_modified();
1518     }
1519
1520     $scope.invalid_profile = function() {
1521         return !(
1522             $scope.patron && 
1523             $scope.patron.profile && 
1524             $scope.patron.profile.usergroup() == 't'
1525         );
1526     }
1527
1528     $scope.new_address = function() {
1529         var addr = egCore.idl.toHash(new egCore.idl.aua());
1530         patronRegSvc.ingest_address($scope.patron, addr);
1531         addr.id = patronRegSvc.virt_id--;
1532         addr.isnew = true;
1533         addr.valid = true;
1534         addr.within_city_limits = true;
1535         addr.country = $scope.org_settings['ui.patron.default_country'];
1536         $scope.patron.addresses.push(addr);
1537     }
1538
1539     // keep deleted addresses out of the patron object so
1540     // they won't appear in the UI.  They'll be re-inserted
1541     // when the patron is updated.
1542     deleted_addresses = [];
1543     $scope.delete_address = function(id) {
1544
1545         if ($scope.patron.isnew &&
1546             $scope.patron.addresses.length == 1 &&
1547             $scope.org_settings['ui.patron.registration.require_address']) {
1548             egAlertDialog.open(egCore.strings.REG_ADDR_REQUIRED);
1549             return;
1550         }
1551
1552         var addresses = [];
1553         angular.forEach($scope.patron.addresses, function(addr) {
1554             if (addr.id == id) {
1555                 if (id > 0) {
1556                     addr.isdeleted = true;
1557                     deleted_addresses.push(addr);
1558                 }
1559             } else {
1560                 addresses.push(addr);
1561             }
1562         });
1563         $scope.patron.addresses = addresses;
1564     } 
1565
1566     $scope.post_code_changed = function(addr) { 
1567         egCore.net.request(
1568             'open-ils.search', 'open-ils.search.zip', addr.post_code)
1569         .then(function(resp) {
1570             if (!resp) return;
1571             if (resp.city) addr.city = resp.city;
1572             if (resp.state) addr.state = resp.state;
1573             if (resp.county) addr.county = resp.county;
1574             if (resp.alert) alert(resp.alert);
1575         });
1576     }
1577
1578     $scope.replace_card = function() {
1579         $scope.patron.card.active = false;
1580         $scope.patron.card.ischanged = true;
1581         $scope.disable_bc = false;
1582
1583         var new_card = egCore.idl.toHash(new egCore.idl.ac());
1584         new_card.id = patronRegSvc.virt_id--;
1585         new_card.isnew = true;
1586         new_card.active = true;
1587         new_card._primary = 'on';
1588         $scope.patron.card = new_card;
1589
1590         // Remove any previous attempts to replace the card, since they
1591         // may be incomplete or created by accident.
1592         $scope.patron.cards =
1593             $scope.patron.cards.filter(function(c) {return !c.isnew})
1594         $scope.patron.cards.push(new_card);
1595     }
1596
1597     $scope.day_phone_changed = function(phone) {
1598         if (phone && $scope.patron.isnew && 
1599             $scope.org_settings['patron.password.use_phone']) {
1600             $scope.patron.passwd = phone.substr(-4);
1601         }
1602     }
1603
1604     $scope.barcode_changed = function(bc) {
1605         if (!bc) return;
1606         $scope.dupe_barcode = false;
1607         egCore.net.request(
1608             'open-ils.actor',
1609             'open-ils.actor.barcode.exists',
1610             egCore.auth.token(), bc
1611         ).then(function(resp) {
1612             if (resp == '1') { // duplicate card
1613                 $scope.dupe_barcode = true;
1614                 console.log('duplicate barcode detected: ' + bc);
1615             } else {
1616                 if (!$scope.patron.usrname)
1617                     $scope.patron.usrname = bc;
1618                 // No dupe -- A-OK
1619             }
1620         });
1621     }
1622
1623     $scope.cards_dialog = function() {
1624         $uibModal.open({
1625             templateUrl: './circ/patron/t_patron_cards_dialog',
1626             backdrop: 'static',
1627             controller: 
1628                    ['$scope','$uibModalInstance','cards','perms',
1629             function($scope , $uibModalInstance , cards , perms) {
1630                 // scope here is the modal-level scope
1631                 $scope.args = {cards : cards};
1632                 $scope.perms = perms;
1633                 $scope.ok = function() { $uibModalInstance.close($scope.args) }
1634                 $scope.cancel = function () { $uibModalInstance.dismiss() }
1635             }],
1636             resolve : {
1637                 cards : function() {
1638                     // scope here is the controller-level scope
1639                     return $scope.patron.cards;
1640                 },
1641                 perms : function() {
1642                     return $scope.perms;
1643                 }
1644             }
1645         }).result.then(
1646             function(args) {
1647                 angular.forEach(args.cards, function(card) {
1648                     card.ischanged = true; // assume cards need updating, OK?
1649                     if (card._primary == 'on' && 
1650                         card.id != $scope.patron.card.id) {
1651                         $scope.patron.card = card;
1652                     }
1653                 });
1654             }
1655         );
1656     }
1657
1658     $scope.set_addr_type = function(addr, type) {
1659         var addrs = $scope.patron.addresses;
1660         if (addr['_is_'+type]) {
1661             angular.forEach(addrs, function(a) {
1662                 if (a.id != addr.id) a['_is_'+type] = false;
1663             });
1664         } else {
1665             // unchecking mailing/billing means we have to randomly
1666             // select another address to fill that role.  Select the
1667             // first address in the list (that does not match the
1668             // modifed address)
1669             for (var i = 0; i < addrs.length; i++) {
1670                 if (addrs[i].id != addr.id) {
1671                     addrs[i]['_is_' + type] = true;
1672                     break;
1673                 }
1674             }
1675         }
1676     }
1677
1678
1679     // Translate hold notify preferences from the form/scope back into a 
1680     // single user setting value for opac.hold_notify.
1681     function compress_hold_notify() {
1682         var hold_notify_methods = [];
1683         if ($scope.hold_notify_type.phone) {
1684             hold_notify_methods.push('phone');
1685         }
1686         if ($scope.hold_notify_type.email) {
1687             hold_notify_methods.push('email');
1688         }
1689         if ($scope.hold_notify_type.sms) {
1690             hold_notify_methods.push('sms');
1691         }
1692
1693         $scope.user_settings['opac.hold_notify'] = hold_notify_methods.join(':');
1694     }
1695
1696     // dialog for selecting additional permission groups
1697     $scope.secondary_groups_dialog = function() {
1698         $uibModal.open({
1699             templateUrl: './circ/patron/t_patron_groups_dialog',
1700             backdrop: 'static',
1701             controller: 
1702                    ['$scope','$uibModalInstance','linked_groups','pgt_depth',
1703             function($scope , $uibModalInstance , linked_groups , pgt_depth) {
1704
1705                 $scope.pgt_depth = pgt_depth;
1706                 $scope.args = {
1707                     linked_groups : linked_groups,
1708                     edit_profiles : patronRegSvc.edit_profiles,
1709                     new_profile   : patronRegSvc.edit_profiles[0]
1710                 };
1711
1712                 // add a new group to the linked groups list
1713                 $scope.link_group = function($event, grp) {
1714                     var found = false; // avoid duplicates
1715                     angular.forEach($scope.args.linked_groups, 
1716                         function(g) {if (g.id() == grp.id()) found = true});
1717                     if (!found) $scope.args.linked_groups.push(grp);
1718                     $event.preventDefault(); // avoid close
1719                 }
1720
1721                 // remove a group from the linked groups list
1722                 $scope.unlink_group = function($event, grp) {
1723                     $scope.args.linked_groups = 
1724                         $scope.args.linked_groups.filter(function(g) {
1725                         return g.id() != grp.id()
1726                     });
1727                     $event.preventDefault(); // avoid close
1728                 }
1729
1730                 $scope.ok = function() { $uibModalInstance.close($scope.args) }
1731                 $scope.cancel = function () { $uibModalInstance.dismiss() }
1732             }],
1733             resolve : {
1734                 linked_groups : function() { return $scope.patron.groups },
1735                 pgt_depth : function() { return $scope.pgt_depth }
1736             }
1737         }).result.then(
1738             function(args) {
1739
1740                 if ($scope.patron.isnew) {
1741                     // groups must be linked for new patrons after the
1742                     // patron is created.
1743                     $scope.patron.groups = args.linked_groups;
1744                     return;
1745                 }
1746
1747                 // update links groups for existing users in real time.
1748                 var ids = args.linked_groups.map(function(g) {return g.id()});
1749                 patronRegSvc.apply_secondary_groups($scope.patron.id, ids)
1750                 .then(function(success) {
1751                     if (success)
1752                         $scope.patron.groups = args.linked_groups;
1753                 });
1754             }
1755         );
1756     }
1757
1758     function extract_hold_notify() {
1759         var notify = $scope.user_settings['opac.hold_notify'];
1760         if (!notify) return;
1761         $scope.hold_notify_type.phone = Boolean(notify.match(/phone/));
1762         $scope.hold_notify_type.email = Boolean(notify.match(/email/));
1763         $scope.hold_notify_type.sms = Boolean(notify.match(/sms/));
1764     }
1765
1766     $scope.invalidate_field = function(field) {
1767         patronRegSvc.invalidate_field($scope.patron, field);
1768     }
1769
1770     address_alert = function(addr) {
1771         var args = {
1772             street1: addr.street1,
1773             street2: addr.street2,
1774             city: addr.city,
1775             state: addr.state,
1776             county: addr.county,
1777             country: addr.country,
1778             post_code: addr.post_code,
1779             mailing_address: addr._is_mailing,
1780             billing_address: addr._is_billing
1781         }
1782
1783         egCore.net.request(
1784             'open-ils.actor',
1785             'open-ils.actor.address_alert.test',
1786             egCore.auth.token(), egCore.auth.user().ws_ou(), args
1787             ).then(function(res) {
1788                 $scope.address_alerts = res;
1789         });
1790     }
1791
1792     $scope.dupe_value_changed = function(type, value) {
1793         if (!$scope.dupe_search_encoded)
1794             $scope.dupe_search_encoded = {};
1795
1796         $scope.dupe_counts[type] = 0;
1797
1798         patronRegSvc.dupe_patron_search($scope.patron, type, value)
1799         .then(function(res) {
1800             $scope.dupe_counts[type] = res.count;
1801             if (res.count) {
1802                 $scope.dupe_search_encoded[type] = 
1803                     encodeURIComponent(js2JSON(res.search));
1804             } else {
1805                 $scope.dupe_search_encoded[type] = '';
1806             }
1807         });
1808     }
1809
1810     $scope.handle_home_org_changed = function() {
1811         org_id = $scope.patron.home_ou.id();
1812         patronRegSvc.has_perms_for_org(org_id).then(function(map) {
1813             angular.forEach(map, function(v, k) { $scope.perms[k] = v });
1814         });
1815     }
1816
1817     $scope.handle_pulib_changed = function(org) {
1818         if (!$scope.user_settings) return; // still rendering
1819         $scope.user_settings['opac.default_pickup_location'] = org.id();
1820     }
1821
1822     // This is called with every character typed in a form field,
1823     // since that's the only way to gaurantee something has changed.
1824     // See handle_field_changed for ng-change vs. ng-blur.
1825     $scope.field_modified = function() {
1826         // Call attach with every field change, regardless of whether
1827         // it's been called before.  This will allow for re-attach after
1828         // the user clicks through the unload warning. egUnloadPrompt
1829         // will ensure we only attach once.
1830         egUnloadPrompt.attach($scope);
1831     }
1832
1833     // also monitor when form is changed *by the user*, as using
1834     // an ng-change handler doesn't work with eg-date-input
1835     $scope.$watch('reg_form.$pristine', function(newVal, oldVal) {
1836         if (!newVal) egUnloadPrompt.attach($scope);
1837     });
1838
1839     // username regex (if present) must be removed any time
1840     // the username matches the barcode to avoid firing the
1841     // invalid field handlers.
1842     function apply_username_regex() {
1843         var regex = $scope.org_settings['opac.username_regex'];
1844         if (regex) {
1845             if ($scope.patron.card.barcode) {
1846                 // username must match the regex or the barcode
1847                 field_patterns.au.usrname = 
1848                     new RegExp(
1849                         regex + '|^' + $scope.patron.card.barcode + '$');
1850             } else {
1851                 // username must match the regex
1852                 field_patterns.au.usrname = new RegExp(regex);
1853             }
1854         } else {
1855             // username can be any format.
1856             field_patterns.au.usrname = new RegExp('.*');
1857         }
1858     }
1859
1860     // obj could be the patron, an address, etc.
1861     // This is called any time a form field achieves then loses focus.
1862     // It does not necessarily mean the field has changed.
1863     // The alternative is ng-change, but it's called with each character
1864     // typed, which would be overkill for many of the actions called here.
1865     $scope.handle_field_changed = function(obj, field_name) {
1866         var cls = obj.classname; // set by egIdl
1867         var value = obj[field_name];
1868
1869         console.debug('changing field ' + field_name + ' to ' + value);
1870
1871         switch (field_name) {
1872             case 'day_phone' : 
1873                 if ($scope.patron.day_phone && 
1874                     $scope.patron.isnew && 
1875                     $scope.org_settings['patron.password.use_phone']) {
1876                     $scope.patron.passwd = $scope.patron.day_phone.substr(-4);
1877                 }
1878             case 'evening_phone' : 
1879             case 'other_phone' : 
1880                 $scope.dupe_value_changed(field_name, value);
1881                 break;
1882
1883             case 'ident_value':
1884             case 'ident_value2':
1885                 $scope.dupe_value_changed('ident', value);
1886                 break;
1887
1888             case 'first_given_name':
1889             case 'family_name':
1890                 $scope.dupe_value_changed('name', value);
1891                 break;
1892
1893             case 'email':
1894                 $scope.dupe_value_changed('email', value);
1895                 break;
1896
1897             case 'street1':
1898             case 'street2':
1899             case 'city':
1900                 // dupe search on address wants the address object as the value.
1901                 $scope.dupe_value_changed('address', obj);
1902                 address_alert(obj);
1903                 break;
1904
1905             case 'post_code':
1906                 $scope.post_code_changed(obj);
1907                 break;
1908
1909             case 'usrname':
1910                 patronRegSvc.check_dupe_username(value)
1911                 .then(function(yes) {$scope.dupe_username = Boolean(yes)});
1912                 break;
1913
1914             case 'barcode':
1915                 // TODO: finish barcode_changed handler.
1916                 $scope.barcode_changed(value);
1917                 apply_username_regex();
1918                 break;
1919         }
1920     }
1921
1922     // patron.juvenile is set to true if the user was born after
1923     function maintain_juvenile_flag() {
1924         if ( !($scope.patron && $scope.patron.dob) ) return;
1925
1926         var juv_interval = 
1927             $scope.org_settings['global.juvenile_age_threshold'] 
1928             || '18 years';
1929
1930         var base = new Date();
1931
1932         base.setTime(base.getTime() - 
1933             Number(egCore.date.intervalToSeconds(juv_interval) + '000'));
1934
1935         $scope.patron.juvenile = ($scope.patron.dob > base);
1936     }
1937
1938     // returns true (disable) for orgs that cannot have users.
1939     $scope.disable_home_org = function(org_id) {
1940         if (!org_id) return;
1941         var org = egCore.org.get(org_id);
1942         return (
1943             org &&
1944             org.ou_type() &&
1945             org.ou_type().can_have_users() == 'f'
1946         );
1947     }
1948
1949     // returns true (disable) for orgs that cannot have vols (for holds pickup)
1950     $scope.disable_pulib = function(org_id) {
1951         if (!org_id) return;
1952         return !egCore.org.CanHaveVolumes(org_id);
1953     }
1954
1955     // Returns true if the Save and Save & Clone buttons should be disabled.
1956     $scope.edit_passthru.hide_save_actions = function() {
1957         return $scope.patron.isnew ?
1958             !$scope.perms.CREATE_USER : 
1959             !$scope.perms.UPDATE_USER;
1960     }
1961
1962     // Returns true if any input elements are tagged as invalid
1963     // via Angular patterns or required attributes.
1964     function form_has_invalid_fields() {
1965         return $('#patron-reg-container .ng-invalid').length > 0;
1966     }
1967
1968     function form_is_incomplete() {
1969         return (
1970             $scope.dupe_username ||
1971             $scope.dupe_barcode ||
1972             form_has_invalid_fields()
1973         );
1974
1975     }
1976
1977     $scope.edit_passthru.save = function(save_args) {
1978         if (!save_args) save_args = {};
1979
1980         if (form_is_incomplete()) {
1981             // User has not provided valid values for all required fields.
1982             return egAlertDialog.open(egCore.strings.REG_INVALID_FIELDS);
1983         }
1984
1985         // remove page unload warning prompt
1986         egUnloadPrompt.clear();
1987
1988         // toss the deleted addresses back into the patron's list of
1989         // addresses so it's included in the update
1990         $scope.patron.addresses = 
1991             $scope.patron.addresses.concat(deleted_addresses);
1992         
1993         compress_hold_notify();
1994
1995         var updated_user;
1996
1997         patronRegSvc.save_user($scope.patron)
1998         .then(function(new_user) { 
1999             if (new_user && new_user.classname) {
2000                 updated_user = new_user;
2001                 return patronRegSvc.save_user_settings(
2002                     new_user, $scope.user_settings); 
2003             } else {
2004                 var evt = egCore.evt.parse(new_user);
2005
2006                 if (evt && evt.textcode == 'XACT_COLLISION') {
2007                     return egAlertDialog.open(
2008                         egCore.strings.PATRON_EDIT_COLLISION).result;
2009                 }
2010
2011                 // debug only -- should not get here.
2012                 alert('Patron update failed. \n\n' + js2JSON(new_user));
2013             }
2014
2015         }).then(function() {
2016
2017             // only remove the staged user if the update succeeded.
2018             if (updated_user) 
2019                 return patronRegSvc.remove_staged_user();
2020
2021             return $q.when();
2022
2023         }).then(function() {
2024
2025             // linked groups for new users must be created after the new
2026             // user is created.
2027             if ($scope.patron.isnew && 
2028                 $scope.patron.groups && $scope.patron.groups.length) {
2029                 var ids = $scope.patron.groups.map(function(g) {return g.id()});
2030                 return patronRegSvc.apply_secondary_groups(updated_user.id(), ids)
2031             }
2032
2033             return $q.when();
2034
2035         }).then(function() {
2036
2037             if (updated_user) {
2038                 egWorkLog.record(
2039                     $scope.patron.isnew
2040                     ? egCore.strings.EG_WORK_LOG_REGISTERED_PATRON
2041                     : egCore.strings.EG_WORK_LOG_EDITED_PATRON, {
2042                         'action' : $scope.patron.isnew ? 'registered_patron' : 'edited_patron',
2043                         'patron_id' : updated_user.id()
2044                     }
2045                 );
2046             }
2047
2048             // reloading the page means potentially losing some information
2049             // (e.g. last patron search), but is the only way to ensure all
2050             // components are properly updated to reflect the modified patron.
2051             if (updated_user && save_args.clone) {
2052                 // open a separate tab for registering a new 
2053                 // patron from our cloned data.
2054                 var url = 'https://' 
2055                     + $window.location.hostname 
2056                     + egCore.env.basePath 
2057                     + '/circ/patron/register/clone/' 
2058                     + updated_user.id();
2059                 $window.open(url, '_blank').focus();
2060
2061             } else {
2062                 // reload the current page
2063                 $window.location.href = location.href;
2064             }
2065         });
2066     }
2067
2068     $scope.edit_passthru.print = function() {
2069         var print_data = {patron : $scope.patron}
2070
2071         return egCore.print.print({
2072             context : 'default',
2073             template : 'patron_data',
2074             scope : print_data
2075         });
2076     }
2077 }])