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