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