2 angular.module('egCoreMod')
3 // toss tihs onto egCoreMod since the page app may vary
5 .factory('patronRegSvc', ['$q', 'egCore', function($q, egCore) {
8 field_doc : {}, // config.idl_field_doc
9 profiles : [], // permission groups
11 user_settings : {}, // applied user settings
12 user_setting_types : {}, // config.usr_setting_type
13 modified_user_settings : {}, // settings modifed this session
14 virt_id : -1 // virtual ID for new objects
17 // launch a series of parallel data retrieval calls
18 service.init = function(scope) {
20 service.get_field_doc(),
21 service.get_perm_groups(),
22 service.get_ident_types(),
23 service.get_user_settings(),
24 service.get_org_settings(),
25 service.get_stat_cats(),
26 service.get_surveys(),
27 service.get_net_access_levels()
31 service.get_surveys = function() {
32 var org_ids = egCore.org.ancestors(egCore.auth.user().ws_ou(), true);
34 return egCore.pcrud.search('asv',
36 {flesh : 1, flesh_fields : {asv : ['questions']}},
38 ).then(function(surveys) {
39 service.surveys = surveys;
43 service.get_stat_cats = function() {
44 return egCore.net.request(
46 'open-ils.circ.stat_cat.actor.retrieve.all',
47 egCore.auth.token(), egCore.auth.user().ws_ou()
48 ).then(function(cats) {
49 service.stat_cats = cats;
53 service.get_org_settings = function() {
54 return egCore.org.settings([
55 'global.password_regex',
56 'global.juvenile_age_threshold',
57 'patron.password.use_phone',
58 'ui.patron.default_inet_access_level',
59 'ui.patron.default_ident_type',
60 'ui.patron.default_country',
61 'ui.patron.registration.require_address',
62 'circ.holds.behind_desk_pickup_supported',
63 'circ.patron_edit.clone.copy_address',
64 'ui.patron.edit.au.prefix.require',
65 'ui.patron.edit.au.prefix.show',
66 'ui.patron.edit.au.prefix.suggest',
67 'ui.patron.edit.ac.barcode.regex',
68 'ui.patron.edit.au.second_given_name.show',
69 'ui.patron.edit.au.second_given_name.suggest',
70 'ui.patron.edit.au.suffix.show',
71 'ui.patron.edit.au.suffix.suggest',
72 'ui.patron.edit.au.alias.show',
73 'ui.patron.edit.au.alias.suggest',
74 'ui.patron.edit.au.dob.require',
75 'ui.patron.edit.au.dob.show',
76 'ui.patron.edit.au.dob.suggest',
77 'ui.patron.edit.au.dob.calendar',
78 'ui.patron.edit.au.juvenile.show',
79 'ui.patron.edit.au.juvenile.suggest',
80 'ui.patron.edit.au.ident_value.show',
81 'ui.patron.edit.au.ident_value.suggest',
82 'ui.patron.edit.au.ident_value2.show',
83 'ui.patron.edit.au.ident_value2.suggest',
84 'ui.patron.edit.au.email.require',
85 'ui.patron.edit.au.email.show',
86 'ui.patron.edit.au.email.suggest',
87 'ui.patron.edit.au.email.regex',
88 'ui.patron.edit.au.email.example',
89 'ui.patron.edit.au.day_phone.require',
90 'ui.patron.edit.au.day_phone.show',
91 'ui.patron.edit.au.day_phone.suggest',
92 'ui.patron.edit.au.day_phone.regex',
93 'ui.patron.edit.au.day_phone.example',
94 'ui.patron.edit.au.evening_phone.require',
95 'ui.patron.edit.au.evening_phone.show',
96 'ui.patron.edit.au.evening_phone.suggest',
97 'ui.patron.edit.au.evening_phone.regex',
98 'ui.patron.edit.au.evening_phone.example',
99 'ui.patron.edit.au.other_phone.require',
100 'ui.patron.edit.au.other_phone.show',
101 'ui.patron.edit.au.other_phone.suggest',
102 'ui.patron.edit.au.other_phone.regex',
103 'ui.patron.edit.au.other_phone.example',
104 'ui.patron.edit.phone.regex',
105 'ui.patron.edit.phone.example',
106 'ui.patron.edit.au.active.show',
107 'ui.patron.edit.au.active.suggest',
108 'ui.patron.edit.au.barred.show',
109 'ui.patron.edit.au.barred.suggest',
110 'ui.patron.edit.au.master_account.show',
111 'ui.patron.edit.au.master_account.suggest',
112 'ui.patron.edit.au.claims_returned_count.show',
113 'ui.patron.edit.au.claims_returned_count.suggest',
114 'ui.patron.edit.au.claims_never_checked_out_count.show',
115 'ui.patron.edit.au.claims_never_checked_out_count.suggest',
116 'ui.patron.edit.au.alert_message.show',
117 'ui.patron.edit.au.alert_message.suggest',
118 'ui.patron.edit.aua.post_code.regex',
119 'ui.patron.edit.aua.post_code.example',
120 'ui.patron.edit.aua.county.require',
122 'ui.patron.edit.default_suggested',
123 'opac.barcode_regex',
124 'opac.username_regex',
126 'ui.patron.edit.aua.state.require',
127 'ui.patron.edit.aua.state.suggest',
128 'ui.patron.edit.aua.state.show'
129 ]).then(function(settings) {
130 service.org_settings = settings;
131 return service.process_org_settings(settings);
135 // some org settings require the retrieval of additional data
136 service.process_org_settings = function(settings) {
140 if (settings['sms.enable']) {
141 // fetch SMS carriers
143 egCore.pcrud.search('csc',
146 {'class':'csc', 'field':'name'},
147 {'class':'csc', 'field':'region'}
149 ).then(function(carriers) {
150 service.sms_carriers = carriers;
154 // if other promises are added below, this is not necessary.
155 promises.push($q.when());
158 // other post-org-settings processing goes here,
159 // adding to promises as needed.
161 return $q.all(promises);
164 service.get_ident_types = function() {
165 return egCore.pcrud.retrieveAll('cit', {}, {atomic : true})
166 .then(function(types) { service.ident_types = types });
169 service.get_net_access_levels = function() {
170 return egCore.pcrud.retrieveAll('cnal', {}, {atomic : true})
171 .then(function(levels) { service.net_access_levels = levels });
174 service.get_perm_groups = function() {
175 if (egCore.env.pgt) {
176 service.profiles = egCore.env.pgt.list;
179 return egCore.pcrud.search('pgt', {parent : null},
180 {flesh : -1, flesh_fields : {pgt : ['children']}}
183 egCore.env.absorbTree(tree, 'pgt')
184 service.profiles = egCore.env.pgt.list;
190 service.get_field_doc = function() {
192 return egCore.pcrud.search('fdoc', {
193 fm_class: ['au', 'ac', 'aua', 'actsc', 'asv', 'asvq', 'asva']})
194 .then(null, null, function(doc) {
195 if (!service.field_doc[doc.fm_class()]) {
196 service.field_doc[doc.fm_class()] = {};
198 service.field_doc[doc.fm_class()][doc.field()] = doc;
202 service.get_user_settings = function() {
203 var org_ids = egCore.org.ancestors(egCore.auth.user().ws_ou(), true);
205 return egCore.pcrud.search('cust', {
207 {name : [ // common user settings
208 'circ.holds_behind_desk',
209 'circ.collections.exempt',
211 'opac.default_phone',
212 'opac.default_pickup_location',
213 'opac.default_sms_carrier',
214 'opac.default_sms_notify']},
215 {name : { // opt-in notification user settings
217 select : {atevdef : ['opt_in_setting']},
219 // we only care about opt-in settings for
220 // event_defs our users encounter
221 where : {'+atevdef' : {owner : org_ids}}
225 }, {}, {atomic : true}).then(function(setting_types) {
227 angular.forEach(setting_types, function(stype) {
228 service.user_setting_types[stype.name()] = stype;
231 if (service.patron_id) {
232 // retrieve applied values for the current user
233 // for the setting types we care about.
236 setting_types.map(function(obj) { return obj.name() });
238 return egCore.net.request(
240 'open-ils.actor.patron.settings.retrieve.authoritative',
244 ).then(function(settings) {
245 service.user_settings = settings;
249 // apply default user setting values
250 angular.forEach(setting_types, function(stype, index) {
251 if (stype.reg_default() != undefined) {
252 service.user_settings[setting.name()] =
253 setting.reg_default();
260 service.init_patron = function(current) {
263 return service.init_new_patron();
265 service.patron = current;
266 return service.init_existing_patron(current)
269 service.ingest_address = function(patron, addr) {
270 addr.valid = addr.valid == 't';
271 addr.within_city_limits = addr.within_city_limits == 't';
272 addr._is_mailing = (patron.mailing_address &&
273 addr.id == patron.mailing_address.id);
274 addr._is_billing = (patron.billing_address &&
275 addr.id == patron.billing_address.id);
279 * Existing patron objects reqire some data munging before insertion
282 * 1. Turn everything into a hash
283 * 2. ... Except certain fields (selectors) whose widgets require objects
284 * 3. Bools must be Boolean, not t/f.
286 service.init_existing_patron = function(current) {
288 var patron = egCore.idl.toHash(current);
290 patron.home_ou = egCore.org.get(patron.home_ou.id);
291 patron.expire_date = new Date(Date.parse(patron.expire_date));
292 patron.dob = new Date(Date.parse(patron.dob));
293 patron.profile = current.profile(); // pre-hash version
294 patron.net_access_level = current.net_access_level();
295 patron.ident_type = current.ident_type();
298 ['juvenile', 'barred', 'active', 'master_account'],
299 function(field) { patron[field] = patron[field] == 't'; }
302 angular.forEach(patron.cards, function(card) {
303 card.active = card.active == 't';
304 if (card.id == patron.card.id) {
306 card._primary = 'on';
310 angular.forEach(patron.addresses,
311 function(addr) { service.ingest_address(patron, addr) });
316 service.init_new_patron = function() {
318 id : service.virt_id--,
321 address_type : egCore.strings.REG_ADDR_TYPE,
324 within_city_limits : true
328 id : service.virt_id--,
339 home_ou : egCore.org.get(egCore.auth.user().ws_ou()),
341 // TODO default profile group?
346 // translate the patron back into IDL form
347 service.save_patron = function(phash) {
349 var patron = new egCore.idl.au();
351 for (var key in phash) {
352 if (typeof patron[key] == 'function')
353 patron[key](phash[key]);
356 patron.home_ou(patron.home_ou().id());
358 patron.expire_date().toISOString().replace(/T.*/,''));
359 patron.profile(patron.profile().id());
361 patron.dob(patron.dob().toISOString().replace(/T.*/,''));
362 if (patron.ident_type())
363 patron.ident_type(patron.ident_type().id());
364 if (patron.net_access_level())
365 patron.net_access_level(patron.net_access_level().id());
368 ['juvenile', 'barred', 'active', 'master_account'],
369 function(field) { patron[field](phash[field] ? 't' : 'f'); }
372 var card_hashes = patron.cards();
374 angular.forEach(card_hashes, function(chash) {
375 var card = new egCore.idl.ac();
376 for (var key in chash) {
377 if (typeof card[key] == 'function')
378 card[key](chash[key]);
380 card.usr(patron.id());
381 card.active(chash.active ? 't' : 'f');
382 patron.cards().push(card);
384 if (chash._primary) {
389 var addr_hashes = patron.addresses();
390 patron.addresses([]);
391 angular.forEach(addr_hashes, function(addr_hash) {
392 var addr = new egCore.idl.aua();
393 patron.addresses().push(addr);
394 for (var key in addr_hash) {
395 if (typeof addr[key] == 'function')
396 addr[key](addr_hash[key]);
399 addr.valid(addr.valid() ? 't' : 'f');
400 addr.within_city_limits(addr.within_city_limits() ? 't' : 'f');
401 if (addr_hash._is_mailing) patron.mailing_address(addr);
402 if (addr_hash._is_billing) patron.billing_address(addr);
405 // TODO extract hold_notify_phone, etc.
407 if (!patron.isnew()) patron.ischanged(true);
409 console.log(js2JSON(patron)); // TODO: debugging
413 'open-ils.actor.patron.update',
414 egCore.auth.token(), patron)
415 .then(function(resp) {
416 // TODO: see original
417 console.log(js2JSON(resp));
425 function PatronRegCtrl($scope, $routeParams,
426 $q, $modal, egCore, patronSvc, patronRegSvc) {
428 $scope.clone_id = $routeParams.clone_id;
429 $scope.stage_username = $routeParams.stage_username;
431 patronRegSvc.patron_id = $routeParams.edit_id || $routeParams.id;
433 if (!$scope.edit_passthru) {
434 // in edit more, scope.edit_passthru is delivered to us by
435 // the enclosing controller. In register mode, there is
436 // no enclosing controller, so we create our own.
437 $scope.edit_passthru = {};
440 // 0=all, 1=suggested, 2=all
441 $scope.edit_passthru.vis_level = 0;
442 // TODO: add save/clone handlers here
446 $scope.initTab ? // initTab comes from patron app
447 $scope.initTab('edit', $routeParams.id) : $q.when(),
452 // called after initTab and patronRegSvc.init have completed
454 var prs = patronRegSvc; // brevity
455 // in standalone mode, we have no patronSvc
456 $scope.patron = prs.init_patron(patronSvc ? patronSvc.current : null);
457 $scope.field_doc = prs.field_doc;
458 $scope.profiles = prs.profiles;
459 $scope.ident_types = prs.ident_types;
460 $scope.net_access_levels = prs.net_access_levels;
461 $scope.user_settings = prs.user_settings;
462 $scope.user_setting_types = prs.user_setting_types;
463 $scope.modified_user_settings = prs.modified_user_settings;
464 $scope.org_settings = prs.org_settings;
465 $scope.sms_carriers = prs.sms_carriers;
466 $scope.stat_cats = prs.stat_cats;
467 $scope.surveys = prs.surveys;
469 if ($scope.org_settings['ui.patron.edit.default_suggested'])
470 $scope.edit_passthru.vis_level = 1;
472 if ($scope.patron.isnew) {
473 $scope.generate_password();
474 $scope.hold_notify_phone = true;
475 $scope.hold_notify_email = true;
477 if (prs.org_settings['ui.patron.default_ident_type']) {
478 $scope.patron.ident_type =
479 prs.org_settings['ui.patron.default_ident_type'];
481 if (prs.org_settings['ui.patron.default_inet_access_level']) {
482 $scope.patron.ident_type =
483 prs.org_settings['ui.patron.default_inet_access_level'];
485 if (prs.org_settings['ui.patron.default_country']) {
486 $scope.patron.addresses[0].country =
487 prs.org_settings['ui.patron.default_country'];
493 // returns the tree depth of the selected profile group tree node.
494 $scope.pgt_depth = function(grp) {
496 while (grp = egCore.env.pgt.map[grp.parent()]) d++;
500 // IDL fields used for labels in the UI.
501 $scope.idl_fields = {
502 au : egCore.idl.classes.au.field_map,
503 ac : egCore.idl.classes.ac.field_map,
504 aua : egCore.idl.classes.aua.field_map
507 // field visibility cache. Some fields are universally required.
508 var field_visibility = {
513 'au.first_given_name' : 2,
514 'au.family_name' : 2,
518 'au.expire_date' : 2,
519 'au.net_access_level' : 2,
520 'aua.address_type' : 2,
529 'aua.within_city_limits' : 2,
534 // returns true if the selected field should be visible
535 // given the current required/suggested/all setting.
536 $scope.show_field = function(field_key) {
538 if (field_visibility[field_key] == undefined) {
539 // compile and cache the visibility for the selected field
541 // org settings have not been received yet.
542 if (!$scope.org_settings) return false;
544 var req_set = 'ui.patron.edit.' + field_key + '.require';
545 var sho_set = 'ui.patron.edit.' + field_key + '.show';
546 var sug_set = 'ui.patron.edit.' + field_key + '.suggest';
548 if ($scope.org_settings[req_set]) {
549 field_visibility[field_key] = 2;
550 } else if ($scope.org_settings[sho_set]) {
551 field_visibility[field_key] = 2;
552 } else if ($scope.org_settings[sug_set]) {
553 field_visibility[field_key] = 1;
555 field_visibility[field_key] = 0;
559 return field_visibility[field_key] >= $scope.edit_passthru.vis_level;
562 // generates a random 4-digit password
563 $scope.generate_password = function() {
564 $scope.patron.passwd = Math.floor(Math.random()*9000) + 1000;
567 $scope.set_expire_date = function() {
568 if (!$scope.patron.profile) return;
569 var seconds = egCore.date.intervalToSeconds(
570 $scope.patron.profile.perm_interval());
571 var now_epoch = new Date().getTime();
572 $scope.patron.expire_date = new Date(
573 now_epoch + (seconds * 1000 /* milliseconds */))
576 // grp is the pgt object
577 $scope.set_profile = function(grp) {
578 $scope.patron.profile = grp;
579 $scope.set_expire_date();
582 $scope.new_address = function() {
583 var addr = egCore.idl.toHash(new egCore.idl.aua());
584 patronRegSvc.ingest_address($scope.patron, addr);
585 addr.id = patronRegSvc.virt_id--;
587 addr.within_city_limits = true;
588 $scope.patron.addresses.push(addr);
591 // keep deleted addresses out of the patron object so
592 // they won't appear in the UI. They'll be re-inserted
593 // when the patron is updated.
594 deleted_addresses = [];
595 $scope.delete_address = function(id) {
597 angular.forEach($scope.patron.addresses, function(addr) {
600 addr.isdeleted = true;
601 deleted_addresses.push(addr);
604 addresses.push(addr);
607 $scope.patron.addresses = addresses;
610 $scope.post_code_changed = function(addr) {
612 'open-ils.search', 'open-ils.search.zip', addr.post_code)
613 .then(function(resp) {
615 if (resp.city) addr.city = resp.city;
616 if (resp.state) addr.state = resp.state;
617 if (resp.county) addr.county = resp.county;
618 if (resp.alert) alert(resp.alert);
622 $scope.replace_card = function() {
623 $scope.patron.card.active = false;
624 $scope.patron.card.ischanged = true;
626 var new_card = egCore.idl.toHash(new egCore.idl.ac());
627 new_card.id = patronRegSvc.virt_id--;
628 new_card.isnew = true;
629 new_card.active = true;
630 new_card._primary = 'on';
631 $scope.patron.card = new_card;
632 $scope.patron.cards.push(new_card);
635 $scope.barcode_changed = function(bc) {
639 'open-ils.actor.barcode.exists',
640 egCore.auth.token(), bc
641 ).then(function(resp) {
643 console.log('duplicate barcode detected: ' + bc);
651 $scope.cards_dialog = function() {
653 templateUrl: './circ/patron/t_patron_cards_dialog',
655 ['$scope','$modalInstance','cards',
656 function($scope , $modalInstance , cards) {
657 // scope here is the modal-level scope
658 $scope.args = {cards : cards};
659 $scope.ok = function() { $modalInstance.close($scope.args) }
660 $scope.cancel = function () { $modalInstance.dismiss() }
664 // scope here is the controller-level scope
665 return $scope.patron.cards;
670 angular.forEach(args.cards, function(card) {
671 card.ischanged = true; // assume cards need updating, OK?
672 if (card._primary == 'on' &&
673 card.id != $scope.patron.card.id) {
674 $scope.patron.card = card;
681 $scope.edit_passthru.save = function() {
682 patronRegSvc.save_patron($scope.patron);
688 // TODO: $inject controller params