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', function($q, egCore) {
   6
   7     var service = {
   8         field_doc : {},             // config.idl_field_doc
   9         profiles : [],              // permission groups
  10         sms_carriers : [],
  11         user_settings : {},         // applied user settings
  12         user_setting_types : {},    // config.usr_setting_type
  13         modified_user_settings : {} // settings modifed this session
  14     };
  15
  16     // launch a series of parallel data retrieval calls
  17     service.init = function(scope) {
  18         return $q.all([
  19             service.get_field_doc(),
  20             service.get_perm_groups(),
  21             service.get_ident_types(),
  22             service.get_user_settings(),
  23             service.get_org_settings(),
  24             service.get_stat_cats(),
  25             service.get_surveys(),
  26             service.get_net_access_levels()
  27         ]);
  28     };
  29
  30     service.get_surveys = function() {
  31         var org_ids = egCore.org.ancestors(egCore.auth.user().ws_ou(), true);
  32
  33         return egCore.pcrud.search('asv',
  34             {owner : org_ids},
  35             {flesh : 1, flesh_fields : {asv : ['questions']}},
  36             {atomic : true}
  37         ).then(function(surveys) {
  38             service.surveys = surveys;
  39         });
  40     }
  41
  42     service.get_stat_cats = function() {
  43         return egCore.net.request(
  44             'open-ils.circ',
  45             'open-ils.circ.stat_cat.actor.retrieve.all',
  46             egCore.auth.token(), egCore.auth.user().ws_ou()
  47         ).then(function(cats) {
  48             service.stat_cats = cats;
  49         });
  50     };
  51
  52     service.get_org_settings = function() {
  53         return egCore.org.settings([
  54             'global.password_regex',
  55             'global.juvenile_age_threshold',
  56             'patron.password.use_phone',
  57             'ui.patron.default_inet_access_level',
  58             'ui.patron.default_ident_type',
  59             'ui.patron.default_country',
  60             'ui.patron.registration.require_address',
  61             'circ.holds.behind_desk_pickup_supported',
  62             'circ.patron_edit.clone.copy_address',
  63             'ui.patron.edit.au.prefix.require',
  64             'ui.patron.edit.au.prefix.show',
  65             'ui.patron.edit.au.prefix.suggest',
  66             'ui.patron.edit.ac.barcode.regex',
  67             'ui.patron.edit.au.second_given_name.show',
  68             'ui.patron.edit.au.second_given_name.suggest',
  69             'ui.patron.edit.au.suffix.show',
  70             'ui.patron.edit.au.suffix.suggest',
  71             'ui.patron.edit.au.alias.show',
  72             'ui.patron.edit.au.alias.suggest',
  73             'ui.patron.edit.au.dob.require',
  74             'ui.patron.edit.au.dob.show',
  75             'ui.patron.edit.au.dob.suggest',
  76             'ui.patron.edit.au.dob.calendar',
  77             'ui.patron.edit.au.juvenile.show',
  78             'ui.patron.edit.au.juvenile.suggest',
  79             'ui.patron.edit.au.ident_value.show',
  80             'ui.patron.edit.au.ident_value.suggest',
  81             'ui.patron.edit.au.ident_value2.show',
  82             'ui.patron.edit.au.ident_value2.suggest',
  83             'ui.patron.edit.au.email.require',
  84             'ui.patron.edit.au.email.show',
  85             'ui.patron.edit.au.email.suggest',
  86             'ui.patron.edit.au.email.regex',
  87             'ui.patron.edit.au.email.example',
  88             'ui.patron.edit.au.day_phone.require',
  89             'ui.patron.edit.au.day_phone.show',
  90             'ui.patron.edit.au.day_phone.suggest',
  91             'ui.patron.edit.au.day_phone.regex',
  92             'ui.patron.edit.au.day_phone.example',
  93             'ui.patron.edit.au.evening_phone.require',
  94             'ui.patron.edit.au.evening_phone.show',
  95             'ui.patron.edit.au.evening_phone.suggest',
  96             'ui.patron.edit.au.evening_phone.regex',
  97             'ui.patron.edit.au.evening_phone.example',
  98             'ui.patron.edit.au.other_phone.require',
  99             'ui.patron.edit.au.other_phone.show',
 100             'ui.patron.edit.au.other_phone.suggest',
 101             'ui.patron.edit.au.other_phone.regex',
 102             'ui.patron.edit.au.other_phone.example',
 103             'ui.patron.edit.phone.regex',
 104             'ui.patron.edit.phone.example',
 105             'ui.patron.edit.au.active.show',
 106             'ui.patron.edit.au.active.suggest',
 107             'ui.patron.edit.au.barred.show',
 108             'ui.patron.edit.au.barred.suggest',
 109             'ui.patron.edit.au.master_account.show',
 110             'ui.patron.edit.au.master_account.suggest',
 111             'ui.patron.edit.au.claims_returned_count.show',
 112             'ui.patron.edit.au.claims_returned_count.suggest',
 113             'ui.patron.edit.au.claims_never_checked_out_count.show',
 114             'ui.patron.edit.au.claims_never_checked_out_count.suggest',
 115             'ui.patron.edit.au.alert_message.show',
 116             'ui.patron.edit.au.alert_message.suggest',
 117             'ui.patron.edit.aua.post_code.regex',
 118             'ui.patron.edit.aua.post_code.example',
 119             'ui.patron.edit.aua.county.require',
 120             'format.date',
 121             'ui.patron.edit.default_suggested',
 122             'opac.barcode_regex',
 123             'opac.username_regex',
 124             'sms.enable',
 125             'ui.patron.edit.aua.state.require',
 126             'ui.patron.edit.aua.state.suggest',
 127             'ui.patron.edit.aua.state.show'
 128         ]).then(function(settings) {
 129             service.org_settings = settings;
 130             return service.process_org_settings(settings);
 131         });
 132     };
 133
 134     // some org settings require the retrieval of additional data
 135     service.process_org_settings = function(settings) {
 136
 137         var promises = [];
 138
 139         if (settings['sms.enable']) {
 140             // fetch SMS carriers
 141             promises.push(
 142                 egCore.pcrud.search('csc',
 143                     {active: 'true'},
 144                     {'order_by':[
 145                         {'class':'csc', 'field':'name'},
 146                         {'class':'csc', 'field':'region'}
 147                     ]}, {atomic : true}
 148                 ).then(function(carriers) {
 149                     service.sms_carriers = carriers;
 150                 })
 151             );
 152         } else {
 153             // if other promises are added below, this is not necessary.
 154             promises.push($q.when());
 155         }
 156
 157         // other post-org-settings processing goes here,
 158         // adding to promises as needed.
 159
 160         return $q.all(promises);
 161     };
 162
 163     service.get_ident_types = function() {
 164         return egCore.pcrud.retrieveAll('cit', {}, {atomic : true})
 165         .then(function(types) { service.ident_types = types });
 166     };
 167
 168     service.get_net_access_levels = function() {
 169         return egCore.pcrud.retrieveAll('cnal', {}, {atomic : true})
 170         .then(function(levels) { service.net_access_levels = levels });
 171     }
 172
 173     service.get_perm_groups = function() {
 174         if (egCore.env.pgt) {
 175             service.profiles = egCore.env.pgt.list;
 176             return $q.when();
 177         } else {
 178             return egCore.pcrud.search('pgt', {parent : null},
 179                 {flesh : -1, flesh_fields : {pgt : ['children']}}
 180             ).then(
 181                 function(tree) {
 182                     egCore.env.absorbTree(tree, 'pgt')
 183                     service.profiles = egCore.env.pgt.list;
 184                 }
 185             );
 186         }
 187     }
 188
 189     service.get_field_doc = function() {
 190
 191         return egCore.pcrud.search('fdoc', {
 192             fm_class: ['au', 'ac', 'aua', 'actsc', 'asv', 'asvq', 'asva']})
 193         .then(null, null, function(doc) {
 194             if (!service.field_doc[doc.fm_class()]) {
 195                 service.field_doc[doc.fm_class()] = {};
 196             }
 197             service.field_doc[doc.fm_class()][doc.field()] = doc;
 198         });
 199     };
 200
 201     service.get_user_settings = function() {
 202         var org_ids = egCore.org.ancestors(egCore.auth.user().ws_ou(), true);
 203
 204         return egCore.pcrud.search('cust', {
 205             '-or' : [
 206                 {name : [ // common user settings
 207                     'circ.holds_behind_desk',
 208                     'circ.collections.exempt',
 209                     'opac.hold_notify',
 210                     'opac.default_phone',
 211                     'opac.default_pickup_location',
 212                     'opac.default_sms_carrier',
 213                     'opac.default_sms_notify']},
 214                 {name : { // opt-in notification user settings
 215                     'in': {
 216                         select : {atevdef : ['opt_in_setting']},
 217                         from : 'atevdef',
 218                         // we only care about opt-in settings for
 219                         // event_defs our users encounter
 220                         where : {'+atevdef' : {owner : org_ids}}
 221                     }
 222                 }}
 223             ]
 224         }, {}, {atomic : true}).then(function(setting_types) {
 225
 226             angular.forEach(setting_types, function(stype) {
 227                 service.user_setting_types[stype.name()] = stype;
 228             });
 229
 230             if(service.patron_id) {
 231                 // retrieve applied values for the current user
 232                 // for the setting types we care about.
 233
 234                 var setting_names =
 235                     setting_types.map(function(obj) { return obj.name() });
 236
 237                 return egCore.net.request(
 238                     'open-ils.actor',
 239                     'open-ils.actor.patron.settings.retrieve.authoritative',
 240                     egCore.auth.token(),
 241                     service.patron_id,
 242                     setting_names
 243                 ).then(function(settings) {
 244                     service.user_settings = settings;
 245                 });
 246             }
 247
 248             // apply default user setting values
 249             angular.forEach(setting_types, function(stype, index) {
 250                 if (stype.reg_default() != undefined) {
 251                     service.modified_user_settings[setting.name()] =
 252                         service.user_settings[setting.name()] =
 253                         setting.reg_default();
 254                 }
 255             });
 256         });
 257     }
 258
 259     service.init_patron = function(current) {
 260
 261         if (!current)
 262             return service.init_new_patron();
 263
 264         service.patron = current;
 265         return service.init_existing_patron(current)
 266     }
 267
 268     service.ingest_address = function(patron, addr) {
 269         addr.valid = addr.valid == 't';
 270         addr.within_city_limits = addr.within_city_limits == 't';
 271         addr._is_mailing = (patron.mailing_address &&
 272             addr.id == patron.mailing_address.id);
 273         addr._is_billing = (patron.billing_address &&
 274             addr.id == patron.billing_address.id);
 275     }
 276
 277     /*
 278      * Existing patron objects reqire some data munging before insertion
 279      * into the scope.
 280      *
 281      * 1. Turn everything into a hash
 282      * 2. ... Except certain fields (selectors) whose widgets require objects
 283      * 3. Bools must be Boolean, not t/f.
 284      */
 285     service.init_existing_patron = function(current) {
 286
 287         var patron = egCore.idl.toHash(current);
 288
 289         patron.home_ou = egCore.org.get(patron.home_ou.id);
 290         patron.expire_date = new Date(Date.parse(patron.expire_date));
 291         patron.dob = new Date(Date.parse(patron.dob));
 292         patron.profile = current.profile(); // pre-hash version
 293         patron.net_access_level = current.net_access_level();
 294         patron.ident_type = current.ident_type();
 295
 296         angular.forEach(
 297             ['juvenile', 'barred', 'active', 'master_account'],
 298             function(field) { patron[field] = patron[field] == 't'; }
 299         );
 300
 301         angular.forEach(patron.addresses,
 302             function(addr) { service.ingest_address(patron, addr) });
 303
 304         return patron;
 305     }
 306
 307     service.init_new_patron = function() {
 308
 309         var addr = {
 310             valid : true,
 311             within_city_limits : true
 312             // default state, etc.
 313         };
 314
 315         return {
 316             isnew : true,
 317             active : true,
 318             card : {},
 319             home_ou : egCore.org.get(egCore.auth.user().ws_ou()),
 320             // TODO default profile group?
 321             mailing_address : addr,
 322             addresses : [addr]
 323         };
 324     }
 325
 326     return service;
 327 }]);
 328
 329
 330 function PatronRegCtrl($scope, $routeParams,
 331     $q, egCore, patronSvc, patronRegSvc) {
 332
 333
 334     $scope.clone_id = $routeParams.clone_id;
 335     $scope.stage_username = $routeParams.stage_username;
 336     $scope.patron_id =
 337         patronRegSvc.patron_id = $routeParams.edit_id || $routeParams.id;
 338
 339     if (!$scope.edit_passthru) {
 340         // in edit more, scope.edit_passthru is delivered to us by
 341         // the enclosing controller.  In register mode, there is
 342         // no enclosing controller, so we create our own.
 343         $scope.edit_passthru = {};
 344     }
 345
 346     // 0=all, 1=suggested, 2=all
 347     $scope.edit_passthru.vis_level = 0;
 348     // TODO: add save/clone handlers here
 349
 350     $q.all([
 351
 352         $scope.initTab ? // initTab comes from patron app
 353             $scope.initTab('edit', $routeParams.id) : $q.when(),
 354
 355         patronRegSvc.init()
 356
 357     ]).then(function() {
 358         // called after initTab and patronRegSvc.init have completed
 359
 360         var prs = patronRegSvc; // brevity
 361         // in standalone mode, we have no patronSvc
 362         $scope.patron = prs.init_patron(patronSvc ? patronSvc.current : null);
 363         $scope.field_doc = prs.field_doc;
 364         $scope.profiles = prs.profiles;
 365         $scope.ident_types = prs.ident_types;
 366         $scope.net_access_levels = prs.net_access_levels;
 367         $scope.user_settings = prs.user_settings;
 368         $scope.user_setting_types = prs.user_setting_types;
 369         $scope.modified_user_settings = prs.modified_user_settings;
 370         $scope.org_settings = prs.org_settings;
 371         $scope.sms_carriers = prs.sms_carriers;
 372         $scope.stat_cats = prs.stat_cats;
 373         $scope.surveys = prs.surveys;
 374
 375         if ($scope.org_settings['ui.patron.edit.default_suggested'])
 376             $scope.edit_passthru.vis_level = 1;
 377     });
 378
 379     // returns the tree depth of the selected profile group tree node.
 380     $scope.pgt_depth = function(grp) {
 381         var d = 0;
 382         while (grp = egCore.env.pgt.map[grp.parent()]) d++;
 383         return d;
 384     }
 385
 386     // IDL fields used for labels in the UI.
 387     $scope.idl_fields = {
 388         au  : egCore.idl.classes.au.field_map,
 389         ac  : egCore.idl.classes.ac.field_map,
 390         aua : egCore.idl.classes.aua.field_map
 391     };
 392
 393     // field visibility cache.  Some fields are universally required.
 394     var field_visibility = {
 395         'ac.barcode' : 2,
 396         'au.usrname' : 2,
 397         'au.passwd' :  2,
 398         // TODO passwd2 2,
 399         'au.first_given_name' : 2,
 400         'au.family_name' : 2,
 401         'au.ident_type' : 2,
 402         'au.home_ou' : 2,
 403         'au.profile' : 2,
 404         'au.expire_date' : 2,
 405         'au.net_access_level' : 2,
 406         'aua.address_type' : 2,
 407         'aua.post_code' : 2,
 408         'aua.street1' : 2,
 409         'aua.street2' : 2,
 410         'aua.city' : 2,
 411         'aua.county' : 2,
 412         'aua.state' : 2,
 413         'aua.country' : 2,
 414         'aua.valid' : 2,
 415         'aua.within_city_limits' : 2,
 416         'stat_cats' : 1,
 417         'surveys' : 1
 418     };
 419
 420     // returns true if the selected field should be visible
 421     // given the current required/suggested/all setting.
 422     $scope.show_field = function(field_key) {
 423
 424         if (field_visibility[field_key] == undefined) {
 425             // compile and cache the visibility for the selected field
 426
 427             // org settings have not been received yet.
 428             if (!$scope.org_settings) return false;
 429
 430             var req_set = 'ui.patron.edit.' + field_key + '.require';
 431             var sho_set = 'ui.patron.edit.' + field_key + '.show';
 432             var sug_set = 'ui.patron.edit.' + field_key + '.suggest';
 433
 434             if ($scope.org_settings[req_set]) {
 435                 field_visibility[field_key] = 2;
 436             } else if ($scope.org_settings[sho_set]) {
 437                 field_visibility[field_key] = 2;
 438             } else if ($scope.org_settings[sug_set]) {
 439                 field_visibility[field_key] = 1;
 440             } else {
 441                 field_visibility[field_key] = 0;
 442             }
 443         }
 444
 445         return field_visibility[field_key] >= $scope.edit_passthru.vis_level;
 446     }
 447
 448     // generates a random 4-digit password
 449     $scope.generate_password = function() {
 450         $scope.patron.passwd = Math.floor(Math.random()*9000) + 1000;
 451     }
 452
 453     $scope.set_expire_date = function() {
 454         if (!$scope.patron.profile) return;
 455         var seconds = egCore.date.intervalToSeconds(
 456             $scope.patron.profile.perm_interval());
 457         var now_epoch = new Date().getTime();
 458         $scope.patron.expire_date = new Date(
 459             now_epoch + (seconds * 1000 /* milliseconds */))
 460     }
 461
 462     // grp is the pgt object
 463     $scope.set_profile = function(grp) {
 464         $scope.patron.profile = grp;
 465         $scope.set_expire_date();
 466     }
 467
 468     var new_addr_id = -1;
 469     $scope.new_address = function() {
 470         var addr = egCore.idl.toHash(new egCore.idl.aua());
 471         patronRegSvc.ingest_address($scope.patron, addr);
 472         addr.id = new_addr_id--;
 473         addr.valid = true;
 474         addr.within_city_limits = true;
 475         $scope.patron.addresses.push(addr);
 476     }
 477
 478     // keep deleted addresses out of the patron object so
 479     // they won't appear in the UI.  They'll be re-inserted
 480     // when the patron is updated.
 481     deleted_addresses = [];
 482     $scope.delete_address = function(id) {
 483         var addresses = [];
 484         angular.forEach($scope.patron.addresses, function(addr) {
 485             if (addr.id == id) {
 486                 if (id > 0) {
 487                     addr.isdeleted = true;
 488                     deleted_addresses.push(addr);
 489                 }
 490             } else {
 491                 addresses.push(addr);
 492             }
 493         });
 494         $scope.patron.addresses = addresses;
 495     }
 496 }
 497
 498
 499 // TODO: $inject controller params