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         var d = new Date(); // always local time zone, yay.
 756         d.setFullYear(parts[0]);
 757         d.setMonth(parts[1] - 1);
 758         d.setDate(parts[2]);
 759         return d;
 760     }
 761
 762     service.copy_stage_data = function(user) {
 763         var cuser = service.stage_user;
 764
 765         // copy the data into our new user object
 766
 767         for (var key in egCore.idl.classes.stgu.field_map) {
 768             if (egCore.idl.classes.au.field_map[key] &&
 769                 !egCore.idl.classes.stgu.field_map[key].virtual) {
 770                 if (cuser.user[key]() !== null)
 771                     user[key] = cuser.user[key]();
 772             }
 773         }
 774
 775         if (user.home_ou) user.home_ou = egCore.org.get(user.home_ou);
 776         if (user.profile) user.profile = egCore.env.pgt.map[user.profile];
 777         if (user.ident_type)
 778             user.ident_type = egCore.env.cit.map[user.ident_type];
 779         if (user.ident_type2)
 780             user.ident_type2 = egCore.env.cit.map[user.ident_type2];
 781         user.dob = service.parse_dob(user.dob);
 782
 783         // Clear the usrname if it looks like a UUID
 784         if (user.usrname.replace(/-/g,'').match(/[0-9a-f]{32}/))
 785             user.usrname = '';
 786
 787         // Don't use stub address if we have one from the staged user.
 788         if (cuser.mailing_addresses.length || cuser.billing_addresses.length)
 789             user.addresses = [];
 790
 791         // is_mailing=false implies is_billing
 792         function addr_from_stage(stage_addr) {
 793             if (!stage_addr) return;
 794             var cls = stage_addr.classname;
 795
 796             var addr = {
 797                 id : service.virt_id--,
 798                 usr : user.id,
 799                 isnew : true,
 800                 valid : true,
 801                 _is_mailing : cls == 'stgma',
 802                 _is_billing : cls == 'stgba'
 803             };
 804
 805             user.mailing_address = addr;
 806             user.addresses.push(addr);
 807
 808             for (var key in egCore.idl.classes[cls].field_map) {
 809                 if (egCore.idl.classes.aua.field_map[key] &&
 810                     !egCore.idl.classes[cls].field_map[key].virtual) {
 811                     if (stage_addr[key]() !== null)
 812                         addr[key] = stage_addr[key]();
 813                 }
 814             }
 815         }
 816
 817         addr_from_stage(cuser.mailing_addresses[0]);
 818         addr_from_stage(cuser.billing_addresses[0]);
 819
 820         if (user.addresses.length == 1) {
 821             // If there is only one address,
 822             // use it as both mailing and billing.
 823             var addr = user.addresses[0];
 824             addr._is_mailing = addr._is_billing = true;
 825             user.mailing_address = user.billing_address = addr;
 826         }
 827
 828         if (cuser.cards.length) {
 829             user.card = {
 830                 id : service.virt_id--,
 831                 barcode : cuser.cards[0].barcode(),
 832                 isnew : true,
 833                 active : true,
 834                 _primary : 'on'
 835             };
 836
 837             user.cards.push(user.card);
 838             if (user.usrname == '')
 839                 user.usrname = card.barcode;
 840         }
 841
 842         angular.forEach(cuser.settings, function(setting) {
 843             service.user_settings[setting.setting()] = Boolean(setting.value());
 844         });
 845     }
 846
 847     // copy select values from the cloned user to the new user.
 848     // user is a hash
 849     service.copy_clone_data = function(user) {
 850         var clone_user = service.clone_user;
 851
 852         // flesh the home org locally
 853         user.home_ou = egCore.org.get(clone_user.home_ou());
 854         if (user.profile) user.profile = egCore.env.pgt.map[user.profile];
 855
 856         if (!clone_user.billing_address() &&
 857             !clone_user.mailing_address())
 858             return; // no addresses to copy or link
 859
 860         // if the cloned user has any addresses, we don't need
 861         // the stub address created in init_new_patron.
 862         user.addresses = [];
 863
 864         var copy_addresses =
 865             service.org_settings['circ.patron_edit.clone.copy_address'];
 866
 867         var clone_fields = [
 868             'day_phone',
 869             'evening_phone',
 870             'other_phone',
 871             'usrgroup'
 872         ];
 873
 874         angular.forEach(clone_fields, function(field) {
 875             user[field] = clone_user[field]();
 876         });
 877
 878         if (copy_addresses) {
 879             var bill_addr, mail_addr;
 880
 881             // copy the billing and mailing addresses into new addresses
 882             function clone_addr(addr) {
 883                 var new_addr = egCore.idl.toHash(addr);
 884                 new_addr.id = service.virt_id--;
 885                 new_addr.usr = user.id;
 886                 new_addr.isnew = true;
 887                 new_addr.valid = true;
 888                 user.addresses.push(new_addr);
 889                 return new_addr;
 890             }
 891
 892             if (bill_addr = clone_user.billing_address()) {
 893                 var addr = clone_addr(bill_addr);
 894                 addr._is_billing = true;
 895                 user.billing_address = addr;
 896             }
 897
 898             if (mail_addr = clone_user.mailing_address()) {
 899
 900                 if (bill_addr && bill_addr.id() == mail_addr.id()) {
 901                     user.mailing_address = user.billing_address;
 902                     user.mailing_address._is_mailing = true;
 903                 } else {
 904                     var addr = clone_addr(mail_addr);
 905                     addr._is_mailing = true;
 906                     user.mailing_address = addr;
 907                 }
 908
 909                 if (!bill_addr) {
 910                     // if there is no billing addr, use the mailing addr
 911                     user.billing_address = user.mailing_address;
 912                     user.billing_address._is_billing = true;
 913                 }
 914             }
 915
 916
 917         } else {
 918
 919             // link the billing and mailing addresses
 920             var addr;
 921             if (addr = clone_user.billing_address()) {
 922                 user.billing_address = egCore.idl.toHash(addr);
 923                 user.billing_address._is_billing = true;
 924                 user.addresses.push(user.billing_address);
 925                 user.billing_address._linked_owner_id = clone_user.id();
 926                 user.billing_address._linked_owner = service.format_name(
 927                     clone_user.family_name(),
 928                     clone_user.first_given_name(),
 929                     clone_user.second_given_name()
 930                 );
 931             }
 932
 933             if (addr = clone_user.mailing_address()) {
 934                 if (user.billing_address &&
 935                     addr.id() == user.billing_address.id) {
 936                     // mailing matches billing
 937                     user.mailing_address = user.billing_address;
 938                     user.mailing_address._is_mailing = true;
 939                 } else {
 940                     user.mailing_address = egCore.idl.toHash(addr);
 941                     user.mailing_address._is_mailing = true;
 942                     user.addresses.push(user.mailing_address);
 943                     user.mailing_address._linked_owner_id = clone_user.id();
 944                     user.mailing_address._linked_owner = service.format_name(
 945                         clone_user.family_name(),
 946                         clone_user.first_given_name(),
 947                         clone_user.second_given_name()
 948                     );
 949                 }
 950             }
 951         }
 952     }
 953
 954     // translate the patron back into IDL form
 955     service.save_user = function(phash) {
 956
 957         var patron = egCore.idl.fromHash('au', phash);
 958
 959         patron.home_ou(patron.home_ou().id());
 960         patron.expire_date(patron.expire_date().toISOString());
 961         patron.profile(patron.profile().id());
 962         if (patron.dob())
 963             patron.dob(patron.dob().toISOString().replace(/T.*/,''));
 964         if (patron.ident_type())
 965             patron.ident_type(patron.ident_type().id());
 966         if (patron.net_access_level())
 967             patron.net_access_level(patron.net_access_level().id());
 968
 969         angular.forEach(
 970             ['juvenile', 'barred', 'active', 'master_account'],
 971             function(field) { patron[field](phash[field] ? 't' : 'f'); }
 972         );
 973
 974         var card_hashes = patron.cards();
 975         patron.cards([]);
 976         angular.forEach(card_hashes, function(chash) {
 977             var card = egCore.idl.fromHash('ac', chash)
 978             card.usr(patron.id());
 979             card.active(chash.active ? 't' : 'f');
 980             patron.cards().push(card);
 981             if (chash._primary) {
 982                 patron.card(card);
 983             }
 984         });
 985
 986         var addr_hashes = patron.addresses();
 987         patron.addresses([]);
 988         angular.forEach(addr_hashes, function(addr_hash) {
 989             if (!addr_hash.isnew && !addr_hash.isdeleted)
 990                 addr_hash.ischanged = true;
 991             var addr = egCore.idl.fromHash('aua', addr_hash);
 992             patron.addresses().push(addr);
 993             addr.valid(addr.valid() ? 't' : 'f');
 994             addr.within_city_limits(addr.within_city_limits() ? 't' : 'f');
 995             if (addr_hash._is_mailing) patron.mailing_address(addr);
 996             if (addr_hash._is_billing) patron.billing_address(addr);
 997         });
 998
 999         patron.survey_responses([]);
1000         angular.forEach(service.survey_responses, function(answer) {
1001             var question = service.survey_questions[answer.question()];
1002             var resp = new egCore.idl.asvr();
1003             resp.isnew(true);
1004             resp.survey(question.survey());
1005             resp.question(question.id());
1006             resp.answer(answer.id());
1007             resp.usr(patron.id());
1008             resp.answer_date('now');
1009             patron.survey_responses().push(resp);
1010         });
1011
1012         // re-object-ify the patron stat cat entry maps
1013         var maps = [];
1014         angular.forEach(patron.stat_cat_entries(), function(entry) {
1015             var e = egCore.idl.fromHash('actscecm', entry);
1016             e.stat_cat(e.stat_cat().id);
1017             maps.push(e);
1018         });
1019         patron.stat_cat_entries(maps);
1020
1021         // service.stat_cat_entry_maps maps stats to values
1022         // patron.stat_cat_entries is an array of stat_cat_entry_usr_map's
1023         angular.forEach(
1024             service.stat_cat_entry_maps, function(value, cat_id) {
1025
1026             // see if we already have a mapping for this entry
1027             var existing = patron.stat_cat_entries().filter(
1028                 function(e) { return e.stat_cat() == cat_id })[0];
1029
1030             if (existing) { // we have a mapping
1031                 // if the existing mapping matches the new one,
1032                 // there' nothing left to do
1033                 if (existing.stat_cat_entry() == value) return;
1034
1035                 // mappings differ.  delete the old one and create
1036                 // a new one below.
1037                 existing.isdeleted(true);
1038             }
1039
1040             var newmap = new egCore.idl.actscecm();
1041             newmap.target_usr(patron.id());
1042             newmap.isnew(true);
1043             newmap.stat_cat(cat_id);
1044             newmap.stat_cat_entry(value);
1045             patron.stat_cat_entries().push(newmap);
1046         });
1047
1048         if (!patron.isnew()) patron.ischanged(true);
1049
1050         return egCore.net.request(
1051             'open-ils.actor',
1052             'open-ils.actor.patron.update',
1053             egCore.auth.token(), patron);
1054     }
1055
1056     service.remove_staged_user = function() {
1057         if (!service.stage_user) return $q.when();
1058         return egCore.net.request(
1059             'open-ils.actor',
1060             'open-ils.actor.user.stage.delete',
1061             egCore.auth.token(),
1062             service.stage_user.user.row_id()
1063         );
1064     }
1065
1066     service.save_user_settings = function(new_user, user_settings) {
1067
1068         var settings = {};
1069         if (service.patron_id) {
1070             // Update all user editor setting values for existing
1071             // users regardless of whether a value changed.
1072             settings = user_settings;
1073
1074         } else {
1075             // Create settings for all non-null setting values for new patrons.
1076             angular.forEach(user_settings, function(val, key) {
1077                 if (val !== null) settings[key] = val;
1078             });
1079         }
1080
1081         if (Object.keys(settings).length == 0) return $q.when();
1082
1083         return egCore.net.request(
1084             'open-ils.actor',
1085             'open-ils.actor.patron.settings.update',
1086             egCore.auth.token(), new_user.id(), settings
1087         ).then(function(resp) {
1088             return resp;
1089         });
1090     }
1091
1092     // Applies field-specific validation regex's from org settings
1093     // to form fields.  Be careful not remove any pattern data we
1094     // are not explicitly over-writing in the provided patterns obj.
1095     service.set_field_patterns = function(patterns) {
1096         if (service.org_settings['opac.username_regex']) {
1097             patterns.au.usrname =
1098                 new RegExp(service.org_settings['opac.username_regex']);
1099         }
1100
1101         if (service.org_settings['ui.patron.edit.ac.barcode.regex']) {
1102             patterns.ac.barcode =
1103                 new RegExp(service.org_settings['ui.patron.edit.ac.barcode.regex']);
1104         }
1105
1106         if (service.org_settings['global.password_regex']) {
1107             patterns.au.passwd =
1108                 new RegExp(service.org_settings['global.password_regex']);
1109         }
1110
1111         var phone_reg = service.org_settings['ui.patron.edit.phone.regex'];
1112         if (phone_reg) {
1113             // apply generic phone regex first, replace below as needed.
1114             patterns.au.day_phone = new RegExp(phone_reg);
1115             patterns.au.evening_phone = new RegExp(phone_reg);
1116             patterns.au.other_phone = new RegExp(phone_reg);
1117         }
1118
1119         // the remaining patterns fit a well-known key name pattern
1120
1121         angular.forEach(service.org_settings, function(val, key) {
1122             if (!val) return;
1123             var parts = key.match(/ui.patron.edit\.(\w+)\.(\w+)\.regex/);
1124             if (!parts) return;
1125             var cls = parts[1];
1126             var name = parts[2];
1127             patterns[cls][name] = new RegExp(val);
1128         });
1129     }
1130
1131     return service;
1132 }])
1133
1134 .controller('PatronRegCtrl',
1135        ['$scope','$routeParams','$q','$uibModal','$window','egCore',
1136         'patronSvc','patronRegSvc','egUnloadPrompt','egAlertDialog',
1137         'egWorkLog',
1138 function($scope , $routeParams , $q , $uibModal , $window , egCore ,
1139          patronSvc , patronRegSvc , egUnloadPrompt, egAlertDialog ,
1140          egWorkLog) {
1141
1142     $scope.page_data_loaded = false;
1143     $scope.hold_notify_type = { phone : null, email : null, sms : null };
1144     $scope.clone_id = patronRegSvc.clone_id = $routeParams.clone_id;
1145     $scope.stage_username =
1146         patronRegSvc.stage_username = $routeParams.stage_username;
1147     $scope.patron_id =
1148         patronRegSvc.patron_id = $routeParams.edit_id || $routeParams.id;
1149
1150     // for existing patrons, disable barcode input by default
1151     $scope.disable_bc = $scope.focus_usrname = Boolean($scope.patron_id);
1152     $scope.focus_bc = !Boolean($scope.patron_id);
1153     $scope.address_alerts = [];
1154     $scope.dupe_counts = {};
1155
1156     // map of perm name to true/false for perms the logged in user
1157     // has at the currently selected patron home org unit.
1158     $scope.perms = {};
1159
1160     if (!$scope.edit_passthru) {
1161         // in edit more, scope.edit_passthru is delivered to us by
1162         // the enclosing controller.  In register mode, there is
1163         // no enclosing controller, so we create our own.
1164         $scope.edit_passthru = {};
1165     }
1166
1167     // 0=all, 1=suggested, 2=all
1168     $scope.edit_passthru.vis_level = 0;
1169
1170     // Apply default values for new patrons during initial registration
1171     // prs is shorthand for patronSvc
1172     function set_new_patron_defaults(prs) {
1173         if (!$scope.patron.passwd) {
1174             // passsword may originate from staged user.
1175             $scope.generate_password();
1176         }
1177         $scope.hold_notify_type.phone = true;
1178         $scope.hold_notify_type.email = true;
1179         $scope.hold_notify_type.sms = false;
1180
1181         // staged users may be loaded w/ a profile.
1182         $scope.set_expire_date();
1183
1184         if (prs.org_settings['ui.patron.default_ident_type']) {
1185             // $scope.patron needs this field to be an object
1186             var id = prs.org_settings['ui.patron.default_ident_type'];
1187             var ident_type = $scope.ident_types.filter(
1188                 function(type) { return type.id() == id })[0];
1189             $scope.patron.ident_type = ident_type;
1190         }
1191         if (prs.org_settings['ui.patron.default_inet_access_level']) {
1192             // $scope.patron needs this field to be an object
1193             var id = prs.org_settings['ui.patron.default_inet_access_level'];
1194             var level = $scope.net_access_levels.filter(
1195                 function(lvl) { return lvl.id() == id })[0];
1196             $scope.patron.net_access_level = level;
1197         }
1198         if (prs.org_settings['ui.patron.default_country']) {
1199             $scope.patron.addresses[0].country =
1200                 prs.org_settings['ui.patron.default_country'];
1201         }
1202     }
1203
1204     // A null or undefined pattern leads to exceptions.  Before the
1205     // patterns are loaded from the server, default all patterns
1206     // to an innocuous regex.  To avoid re-creating numerous
1207     // RegExp objects, cache the stub RegExp after initial creation.
1208     // note: angular docs say ng-pattern accepts a regexp or string,
1209     // but as of writing, it only works with a regexp object.
1210     // (Likely an angular 1.2 vs. 1.4 issue).
1211     var field_patterns = {au : {}, ac : {}, aua : {}};
1212     $scope.field_pattern = function(cls, field) {
1213         if (!field_patterns[cls][field])
1214             field_patterns[cls][field] = new RegExp('.*');
1215         return field_patterns[cls][field];
1216     }
1217
1218     // Main page load function.  Kicks off tab init and data loading.
1219     $q.all([
1220
1221         $scope.initTab ? // initTab comes from patron app
1222             $scope.initTab('edit', $routeParams.id) : $q.when(),
1223
1224         patronRegSvc.init(),
1225
1226     ]).then(function(){ return patronRegSvc.init_patron(patronSvc ? patronSvc.current : patronRegSvc.patron ) })
1227       .then(function(patron) {
1228         // called after initTab and patronRegSvc.init have completed
1229         // in standalone mode, we have no patronSvc
1230         var prs = patronRegSvc;
1231         $scope.patron = patron;
1232         $scope.field_doc = prs.field_doc;
1233         $scope.edit_profiles = prs.edit_profiles;
1234         $scope.ident_types = prs.ident_types;
1235         $scope.net_access_levels = prs.net_access_levels;
1236         $scope.user_setting_types = prs.user_setting_types;
1237         $scope.opt_in_setting_types = prs.opt_in_setting_types;
1238         $scope.org_settings = prs.org_settings;
1239         $scope.sms_carriers = prs.sms_carriers;
1240         $scope.stat_cats = prs.stat_cats;
1241         $scope.surveys = prs.surveys;
1242         $scope.survey_responses = prs.survey_responses;
1243         $scope.stat_cat_entry_maps = prs.stat_cat_entry_maps;
1244         $scope.stage_user = prs.stage_user;
1245         $scope.stage_user_requestor = prs.stage_user_requestor;
1246
1247         $scope.user_settings = prs.user_settings;
1248         prs.user_settings = {};
1249
1250         // If a default pickup lib is applied to the patron, apply it
1251         // to the UI at page load time.  Otherwise, leave the value unset.
1252         if ($scope.user_settings['opac.default_pickup_location']) {
1253             $scope.patron._pickup_lib = egCore.org.get(
1254                 $scope.user_settings['opac.default_pickup_location']);
1255         }
1256
1257         extract_hold_notify();
1258         if ($scope.patron.isnew)
1259             set_new_patron_defaults(prs);
1260
1261         $scope.handle_home_org_changed();
1262
1263         if ($scope.org_settings['ui.patron.edit.default_suggested'])
1264             $scope.edit_passthru.vis_level = 1;
1265
1266         // Stat cats are fetched from open-ils.storage, where 't'==1
1267         $scope.hasRequiredStatCat = prs.stat_cats.filter(
1268                 function(cat) {return cat.required() == 1} ).length > 0;
1269
1270         $scope.page_data_loaded = true;
1271
1272         prs.set_field_patterns(field_patterns);
1273         apply_username_regex();
1274     });
1275
1276
1277     // update the currently displayed field documentation
1278     $scope.set_selected_field_doc = function(cls, field) {
1279         $scope.selected_field_doc = $scope.field_doc[cls][field];
1280     }
1281
1282     // returns the tree depth of the selected profile group tree node.
1283     $scope.pgt_depth = function(grp) {
1284         var d = 0;
1285         while (grp = egCore.env.pgt.map[grp.parent()]) d++;
1286         return d;
1287     }
1288
1289     // IDL fields used for labels in the UI.
1290     $scope.idl_fields = {
1291         au  : egCore.idl.classes.au.field_map,
1292         ac  : egCore.idl.classes.ac.field_map,
1293         aua : egCore.idl.classes.aua.field_map
1294     };
1295
1296     // field visibility cache.  Some fields are universally required.
1297     // 3 == value universally required
1298     // 2 == field is visible by default
1299     // 1 == field is suggested by default
1300     var field_visibility = {};
1301     var default_field_visibility = {
1302         'ac.barcode' : 3,
1303         'au.usrname' : 3,
1304         'au.passwd' :  3,
1305         'au.first_given_name' : 3,
1306         'au.family_name' : 3,
1307         'au.ident_type' : 3,
1308         'au.ident_type2' : 2,
1309         'au.home_ou' : 3,
1310         'au.profile' : 3,
1311         'au.expire_date' : 3,
1312         'au.net_access_level' : 3,
1313         'aua.address_type' : 3,
1314         'aua.post_code' : 3,
1315         'aua.street1' : 3,
1316         'aua.street2' : 2,
1317         'aua.city' : 3,
1318         'aua.county' : 2,
1319         'aua.state' : 2,
1320         'aua.country' : 3,
1321         'aua.valid' : 2,
1322         'aua.within_city_limits' : 2,
1323         'stat_cats' : 1,
1324         'surveys' : 1
1325     };
1326
1327     // Returns true if the selected field should be visible
1328     // given the current required/suggested/all setting.
1329     // The visibility flag applied to each field as a result of calling
1330     // this function also sets (via the same flag) the requiredness state.
1331     $scope.show_field = function(field_key) {
1332         // org settings have not been received yet.
1333         if (!$scope.org_settings) return false;
1334
1335         if (field_visibility[field_key] == undefined) {
1336             // compile and cache the visibility for the selected field
1337
1338             var req_set = 'ui.patron.edit.' + field_key + '.require';
1339             var sho_set = 'ui.patron.edit.' + field_key + '.show';
1340             var sug_set = 'ui.patron.edit.' + field_key + '.suggest';
1341
1342             if ($scope.org_settings[req_set]) {
1343                 field_visibility[field_key] = 3;
1344
1345             } else if ($scope.org_settings[sho_set]) {
1346                 field_visibility[field_key] = 2;
1347
1348             } else if ($scope.org_settings[sug_set]) {
1349                 field_visibility[field_key] = 1;
1350             }
1351         }
1352
1353         if (field_visibility[field_key] == undefined) {
1354             // No org settings were applied above.  Use the default
1355             // settings if present or assume the field has no
1356             // visibility flags applied.
1357             field_visibility[field_key] =
1358                 default_field_visibility[field_key] || 0;
1359         }
1360
1361         return field_visibility[field_key] >= $scope.edit_passthru.vis_level;
1362     }
1363
1364     // See $scope.show_field().
1365     // A field with visbility level 3 means it's required.
1366     $scope.field_required = function(cls, field) {
1367
1368         // Value in the password field is not required
1369         // for existing patrons.
1370         if (field == 'passwd' && $scope.patron && !$scope.patron.isnew)
1371           return false;
1372
1373         return (field_visibility[cls + '.' + field] == 3);
1374     }
1375
1376     // generates a random 4-digit password
1377     $scope.generate_password = function() {
1378         $scope.patron.passwd = Math.floor(Math.random()*9000) + 1000;
1379     }
1380
1381     $scope.set_expire_date = function() {
1382         if (!$scope.patron.profile) return;
1383         var seconds = egCore.date.intervalToSeconds(
1384             $scope.patron.profile.perm_interval());
1385         var now_epoch = new Date().getTime();
1386         $scope.patron.expire_date = new Date(
1387             now_epoch + (seconds * 1000 /* milliseconds */))
1388     }
1389
1390     // grp is the pgt object
1391     $scope.set_profile = function(grp) {
1392         $scope.patron.profile = grp;
1393         $scope.set_expire_date();
1394         $scope.field_modified();
1395     }
1396
1397     $scope.invalid_profile = function() {
1398         return !(
1399             $scope.patron &&
1400             $scope.patron.profile &&
1401             $scope.patron.profile.usergroup() == 't'
1402         );
1403     }
1404
1405     $scope.new_address = function() {
1406         var addr = egCore.idl.toHash(new egCore.idl.aua());
1407         patronRegSvc.ingest_address($scope.patron, addr);
1408         addr.id = patronRegSvc.virt_id--;
1409         addr.isnew = true;
1410         addr.valid = true;
1411         addr.within_city_limits = true;
1412         addr.country = $scope.org_settings['ui.patron.default_country'];
1413         $scope.patron.addresses.push(addr);
1414     }
1415
1416     // keep deleted addresses out of the patron object so
1417     // they won't appear in the UI.  They'll be re-inserted
1418     // when the patron is updated.
1419     deleted_addresses = [];
1420     $scope.delete_address = function(id) {
1421
1422         if ($scope.patron.isnew &&
1423             $scope.patron.addresses.length == 1 &&
1424             $scope.org_settings['ui.patron.registration.require_address']) {
1425             egAlertDialog.open(egCore.strings.REG_ADDR_REQUIRED);
1426             return;
1427         }
1428
1429         var addresses = [];
1430         angular.forEach($scope.patron.addresses, function(addr) {
1431             if (addr.id == id) {
1432                 if (id > 0) {
1433                     addr.isdeleted = true;
1434                     deleted_addresses.push(addr);
1435                 }
1436             } else {
1437                 addresses.push(addr);
1438             }
1439         });
1440         $scope.patron.addresses = addresses;
1441     }
1442
1443     $scope.post_code_changed = function(addr) {
1444         egCore.net.request(
1445             'open-ils.search', 'open-ils.search.zip', addr.post_code)
1446         .then(function(resp) {
1447             if (!resp) return;
1448             if (resp.city) addr.city = resp.city;
1449             if (resp.state) addr.state = resp.state;
1450             if (resp.county) addr.county = resp.county;
1451             if (resp.alert) alert(resp.alert);
1452         });
1453     }
1454
1455     $scope.replace_card = function() {
1456         $scope.patron.card.active = false;
1457         $scope.patron.card.ischanged = true;
1458         $scope.disable_bc = false;
1459
1460         var new_card = egCore.idl.toHash(new egCore.idl.ac());
1461         new_card.id = patronRegSvc.virt_id--;
1462         new_card.isnew = true;
1463         new_card.active = true;
1464         new_card._primary = 'on';
1465         $scope.patron.card = new_card;
1466
1467         // Remove any previous attempts to replace the card, since they
1468         // may be incomplete or created by accident.
1469         $scope.patron.cards =
1470             $scope.patron.cards.filter(function(c) {return !c.isnew})
1471         $scope.patron.cards.push(new_card);
1472     }
1473
1474     $scope.day_phone_changed = function(phone) {
1475         if (phone && $scope.patron.isnew &&
1476             $scope.org_settings['patron.password.use_phone']) {
1477             $scope.patron.passwd = phone.substr(-4);
1478         }
1479     }
1480
1481     $scope.barcode_changed = function(bc) {
1482         if (!bc) return;
1483         $scope.dupe_barcode = false;
1484         egCore.net.request(
1485             'open-ils.actor',
1486             'open-ils.actor.barcode.exists',
1487             egCore.auth.token(), bc
1488         ).then(function(resp) {
1489             if (resp == '1') { // duplicate card
1490                 $scope.dupe_barcode = true;
1491                 console.log('duplicate barcode detected: ' + bc);
1492             } else {
1493                 if (!$scope.patron.usrname)
1494                     $scope.patron.usrname = bc;
1495                 // No dupe -- A-OK
1496             }
1497         });
1498     }
1499
1500     $scope.cards_dialog = function() {
1501         $uibModal.open({
1502             templateUrl: './circ/patron/t_patron_cards_dialog',
1503             backdrop: 'static',
1504             controller:
1505                    ['$scope','$uibModalInstance','cards','perms',
1506             function($scope , $uibModalInstance , cards , perms) {
1507                 // scope here is the modal-level scope
1508                 $scope.args = {cards : cards};
1509                 $scope.perms = perms;
1510                 $scope.ok = function() { $uibModalInstance.close($scope.args) }
1511                 $scope.cancel = function () { $uibModalInstance.dismiss() }
1512             }],
1513             resolve : {
1514                 cards : function() {
1515                     // scope here is the controller-level scope
1516                     return $scope.patron.cards;
1517                 },
1518                 perms : function() {
1519                     return $scope.perms;
1520                 }
1521             }
1522         }).result.then(
1523             function(args) {
1524                 angular.forEach(args.cards, function(card) {
1525                     card.ischanged = true; // assume cards need updating, OK?
1526                     if (card._primary == 'on' &&
1527                         card.id != $scope.patron.card.id) {
1528                         $scope.patron.card = card;
1529                     }
1530                 });
1531             }
1532         );
1533     }
1534
1535     $scope.set_addr_type = function(addr, type) {
1536         var addrs = $scope.patron.addresses;
1537         if (addr['_is_'+type]) {
1538             angular.forEach(addrs, function(a) {
1539                 if (a.id != addr.id) a['_is_'+type] = false;
1540             });
1541         } else {
1542             // unchecking mailing/billing means we have to randomly
1543             // select another address to fill that role.  Select the
1544             // first address in the list (that does not match the
1545             // modifed address)
1546             for (var i = 0; i < addrs.length; i++) {
1547                 if (addrs[i].id != addr.id) {
1548                     addrs[i]['_is_' + type] = true;
1549                     break;
1550                 }
1551             }
1552         }
1553     }
1554
1555
1556     // Translate hold notify preferences from the form/scope back into a
1557     // single user setting value for opac.hold_notify.
1558     function compress_hold_notify() {
1559         var hold_notify_methods = [];
1560         if ($scope.hold_notify_type.phone) {
1561             hold_notify_methods.push('phone');
1562         }
1563         if ($scope.hold_notify_type.email) {
1564             hold_notify_methods.push('email');
1565         }
1566         if ($scope.hold_notify_type.sms) {
1567             hold_notify_methods.push('sms');
1568         }
1569
1570         $scope.user_settings['opac.hold_notify'] = hold_notify_methods.join(':');
1571     }
1572
1573     // dialog for selecting additional permission groups
1574     $scope.secondary_groups_dialog = function() {
1575         $uibModal.open({
1576             templateUrl: './circ/patron/t_patron_groups_dialog',
1577             backdrop: 'static',
1578             controller:
1579                    ['$scope','$uibModalInstance','linked_groups','pgt_depth',
1580             function($scope , $uibModalInstance , linked_groups , pgt_depth) {
1581
1582                 $scope.pgt_depth = pgt_depth;
1583                 $scope.args = {
1584                     linked_groups : linked_groups,
1585                     edit_profiles : patronRegSvc.edit_profiles,
1586                     new_profile   : patronRegSvc.edit_profiles[0]
1587                 };
1588
1589                 // add a new group to the linked groups list
1590                 $scope.link_group = function($event, grp) {
1591                     var found = false; // avoid duplicates
1592                     angular.forEach($scope.args.linked_groups,
1593                         function(g) {if (g.id() == grp.id()) found = true});
1594                     if (!found) $scope.args.linked_groups.push(grp);
1595                     $event.preventDefault(); // avoid close
1596                 }
1597
1598                 // remove a group from the linked groups list
1599                 $scope.unlink_group = function($event, grp) {
1600                     $scope.args.linked_groups =
1601                         $scope.args.linked_groups.filter(function(g) {
1602                         return g.id() != grp.id()
1603                     });
1604                     $event.preventDefault(); // avoid close
1605                 }
1606
1607                 $scope.ok = function() { $uibModalInstance.close($scope.args) }
1608                 $scope.cancel = function () { $uibModalInstance.dismiss() }
1609             }],
1610             resolve : {
1611                 linked_groups : function() { return $scope.patron.groups },
1612                 pgt_depth : function() { return $scope.pgt_depth }
1613             }
1614         }).result.then(
1615             function(args) {
1616
1617                 if ($scope.patron.isnew) {
1618                     // groups must be linked for new patrons after the
1619                     // patron is created.
1620                     $scope.patron.groups = args.linked_groups;
1621                     return;
1622                 }
1623
1624                 // update links groups for existing users in real time.
1625                 var ids = args.linked_groups.map(function(g) {return g.id()});
1626                 patronRegSvc.apply_secondary_groups($scope.patron.id, ids)
1627                 .then(function(success) {
1628                     if (success)
1629                         $scope.patron.groups = args.linked_groups;
1630                 });
1631             }
1632         );
1633     }
1634
1635     function extract_hold_notify() {
1636         var notify = $scope.user_settings['opac.hold_notify'];
1637         if (!notify) return;
1638         $scope.hold_notify_type.phone = Boolean(notify.match(/phone/));
1639         $scope.hold_notify_type.email = Boolean(notify.match(/email/));
1640         $scope.hold_notify_type.sms = Boolean(notify.match(/sms/));
1641     }
1642
1643     $scope.invalidate_field = function(field) {
1644         patronRegSvc.invalidate_field($scope.patron, field);
1645     }
1646
1647     address_alert = function(addr) {
1648         var args = {
1649             street1: addr.street1,
1650             street2: addr.street2,
1651             city: addr.city,
1652             state: addr.state,
1653             county: addr.county,
1654             country: addr.country,
1655             post_code: addr.post_code,
1656             mailing_address: addr._is_mailing,
1657             billing_address: addr._is_billing
1658         }
1659
1660         egCore.net.request(
1661             'open-ils.actor',
1662             'open-ils.actor.address_alert.test',
1663             egCore.auth.token(), egCore.auth.user().ws_ou(), args
1664             ).then(function(res) {
1665                 $scope.address_alerts = res;
1666         });
1667     }
1668
1669     $scope.dupe_value_changed = function(type, value) {
1670         if (!$scope.dupe_search_encoded)
1671             $scope.dupe_search_encoded = {};
1672
1673         $scope.dupe_counts[type] = 0;
1674
1675         patronRegSvc.dupe_patron_search($scope.patron, type, value)
1676         .then(function(res) {
1677             $scope.dupe_counts[type] = res.count;
1678             if (res.count) {
1679                 $scope.dupe_search_encoded[type] =
1680                     encodeURIComponent(js2JSON(res.search));
1681             } else {
1682                 $scope.dupe_search_encoded[type] = '';
1683             }
1684         });
1685     }
1686
1687     $scope.handle_home_org_changed = function() {
1688         org_id = $scope.patron.home_ou.id();
1689         patronRegSvc.has_perms_for_org(org_id).then(function(map) {
1690             angular.forEach(map, function(v, k) { $scope.perms[k] = v });
1691         });
1692     }
1693
1694     $scope.handle_pulib_changed = function(org) {
1695         if (!$scope.user_settings) return; // still rendering
1696         $scope.user_settings['opac.default_pickup_location'] = org.id();
1697     }
1698
1699     // This is called with every character typed in a form field,
1700     // since that's the only way to gaurantee something has changed.
1701     // See handle_field_changed for ng-change vs. ng-blur.
1702     $scope.field_modified = function() {
1703         // Call attach with every field change, regardless of whether
1704         // it's been called before.  This will allow for re-attach after
1705         // the user clicks through the unload warning. egUnloadPrompt
1706         // will ensure we only attach once.
1707         egUnloadPrompt.attach($scope);
1708     }
1709
1710     // also monitor when form is changed *by the user*, as using
1711     // an ng-change handler doesn't work with eg-date-input
1712     $scope.$watch('reg_form.$pristine', function(newVal, oldVal) {
1713         if (!newVal) egUnloadPrompt.attach($scope);
1714     });
1715
1716     // username regex (if present) must be removed any time
1717     // the username matches the barcode to avoid firing the
1718     // invalid field handlers.
1719     function apply_username_regex() {
1720         var regex = $scope.org_settings['opac.username_regex'];
1721         if (regex) {
1722             if ($scope.patron.card.barcode) {
1723                 // username must match the regex or the barcode
1724                 field_patterns.au.usrname =
1725                     new RegExp(
1726                         regex + '|^' + $scope.patron.card.barcode + '$');
1727             } else {
1728                 // username must match the regex
1729                 field_patterns.au.usrname = new RegExp(regex);
1730             }
1731         } else {
1732             // username can be any format.
1733             field_patterns.au.usrname = new RegExp('.*');
1734         }
1735     }
1736
1737     // obj could be the patron, an address, etc.
1738     // This is called any time a form field achieves then loses focus.
1739     // It does not necessarily mean the field has changed.
1740     // The alternative is ng-change, but it's called with each character
1741     // typed, which would be overkill for many of the actions called here.
1742     $scope.handle_field_changed = function(obj, field_name) {
1743         var cls = obj.classname; // set by egIdl
1744         var value = obj[field_name];
1745
1746         console.log('changing field ' + field_name + ' to ' + value);
1747
1748         switch (field_name) {
1749             case 'day_phone' :
1750                 if ($scope.patron.day_phone &&
1751                     $scope.patron.isnew &&
1752                     $scope.org_settings['patron.password.use_phone']) {
1753                     $scope.patron.passwd = $scope.patron.day_phone.substr(-4);
1754                 }
1755             case 'evening_phone' :
1756             case 'other_phone' :
1757                 $scope.dupe_value_changed(field_name, value);
1758                 break;
1759
1760             case 'ident_value':
1761             case 'ident_value2':
1762                 $scope.dupe_value_changed('ident', value);
1763                 break;
1764
1765             case 'first_given_name':
1766             case 'family_name':
1767                 $scope.dupe_value_changed('name', value);
1768                 break;
1769
1770             case 'email':
1771                 $scope.dupe_value_changed('email', value);
1772                 break;
1773
1774             case 'street1':
1775             case 'street2':
1776             case 'city':
1777                 // dupe search on address wants the address object as the value.
1778                 $scope.dupe_value_changed('address', obj);
1779                 address_alert(obj);
1780                 break;
1781
1782             case 'post_code':
1783                 $scope.post_code_changed(obj);
1784                 break;
1785
1786             case 'usrname':
1787                 patronRegSvc.check_dupe_username(value)
1788                 .then(function(yes) {$scope.dupe_username = Boolean(yes)});
1789                 break;
1790
1791             case 'barcode':
1792                 // TODO: finish barcode_changed handler.
1793                 $scope.barcode_changed(value);
1794                 apply_username_regex();
1795                 break;
1796
1797             case 'dob':
1798                 maintain_juvenile_flag();
1799                 break;
1800         }
1801     }
1802
1803     // patron.juvenile is set to true if the user was born after
1804     function maintain_juvenile_flag() {
1805         if ( !($scope.patron && $scope.patron.dob) ) return;
1806
1807         var juv_interval =
1808             $scope.org_settings['global.juvenile_age_threshold']
1809             || '18 years';
1810
1811         var base = new Date();
1812
1813         base.setTime(base.getTime() -
1814             Number(egCore.date.intervalToSeconds(juv_interval) + '000'));
1815
1816         $scope.patron.juvenile = ($scope.patron.dob > base);
1817     }
1818
1819     // returns true (disable) for orgs that cannot have users.
1820     $scope.disable_home_org = function(org_id) {
1821         if (!org_id) return;
1822         var org = egCore.org.get(org_id);
1823         return (
1824             org &&
1825             org.ou_type() &&
1826             org.ou_type().can_have_users() == 'f'
1827         );
1828     }
1829
1830     // returns true (disable) for orgs that cannot have vols (for holds pickup)
1831     $scope.disable_pulib = function(org_id) {
1832         if (!org_id) return;
1833         return !egCore.org.CanHaveVolumes(org_id);
1834     }
1835
1836     // Returns true if the Save and Save & Clone buttons should be disabled.
1837     $scope.edit_passthru.hide_save_actions = function() {
1838         return $scope.patron.isnew ?
1839             !$scope.perms.CREATE_USER :
1840             !$scope.perms.UPDATE_USER;
1841     }
1842
1843     // Returns true if any input elements are tagged as invalid
1844     // via Angular patterns or required attributes.
1845     function form_has_invalid_fields() {
1846         return $('#patron-reg-container .ng-invalid').length > 0;
1847     }
1848
1849     function form_is_incomplete() {
1850         return (
1851             $scope.dupe_username ||
1852             $scope.dupe_barcode ||
1853             form_has_invalid_fields()
1854         );
1855
1856     }
1857
1858     $scope.edit_passthru.save = function(save_args) {
1859         if (!save_args) save_args = {};
1860
1861         if (form_is_incomplete()) {
1862             // User has not provided valid values for all required fields.
1863             return egAlertDialog.open(egCore.strings.REG_INVALID_FIELDS);
1864         }
1865
1866         // remove page unload warning prompt
1867         egUnloadPrompt.clear();
1868
1869         // toss the deleted addresses back into the patron's list of
1870         // addresses so it's included in the update
1871         $scope.patron.addresses =
1872             $scope.patron.addresses.concat(deleted_addresses);
1873
1874         compress_hold_notify();
1875
1876         var updated_user;
1877
1878         patronRegSvc.save_user($scope.patron)
1879         .then(function(new_user) {
1880             if (new_user && new_user.classname) {
1881                 updated_user = new_user;
1882                 return patronRegSvc.save_user_settings(
1883                     new_user, $scope.user_settings);
1884             } else {
1885                 var evt = egCore.evt.parse(new_user);
1886
1887                 if (evt && evt.textcode == 'XACT_COLLISION') {
1888                     return egAlertDialog.open(
1889                         egCore.strings.PATRON_EDIT_COLLISION).result;
1890                 }
1891
1892                 // debug only -- should not get here.
1893                 alert('Patron update failed. \n\n' + js2JSON(new_user));
1894             }
1895
1896         }).then(function() {
1897
1898             // only remove the staged user if the update succeeded.
1899             if (updated_user)
1900                 return patronRegSvc.remove_staged_user();
1901
1902             return $q.when();
1903
1904         }).then(function() {
1905
1906             // linked groups for new users must be created after the new
1907             // user is created.
1908             if ($scope.patron.isnew &&
1909                 $scope.patron.groups && $scope.patron.groups.length) {
1910                 var ids = $scope.patron.groups.map(function(g) {return g.id()});
1911                 return patronRegSvc.apply_secondary_groups(updated_user.id(), ids)
1912             }
1913
1914             return $q.when();
1915
1916         }).then(function() {
1917
1918             if (updated_user) {
1919                 egWorkLog.record(
1920                     $scope.patron.isnew
1921                     ? egCore.strings.EG_WORK_LOG_REGISTERED_PATRON
1922                     : egCore.strings.EG_WORK_LOG_EDITED_PATRON, {
1923                         'action' : $scope.patron.isnew ? 'registered_patron' : 'edited_patron',
1924                         'patron_id' : updated_user.id()
1925                     }
1926                 );
1927             }
1928
1929             // reloading the page means potentially losing some information
1930             // (e.g. last patron search), but is the only way to ensure all
1931             // components are properly updated to reflect the modified patron.
1932             if (updated_user && save_args.clone) {
1933                 // open a separate tab for registering a new
1934                 // patron from our cloned data.
1935                 var url = 'https://'
1936                     + $window.location.hostname
1937                     + egCore.env.basePath
1938                     + '/circ/patron/register/clone/'
1939                     + updated_user.id();
1940                 $window.open(url, '_blank').focus();
1941
1942             } else {
1943                 // reload the current page
1944                 $window.location.href = location.href;
1945             }
1946         });
1947     }
1948 }])