]> git.evergreen-ils.org Git - working/Evergreen.git/blob - Open-ILS/web/js/ui/default/staff/circ/patron/regctl.js
LP#1452950 browser client patron reg additions
[working/Evergreen.git] / Open-ILS / web / js / ui / default / staff / circ / patron / regctl.js
1
2 angular.module('egCoreMod')
3 // toss tihs onto egCoreMod since the page app may vary
4
5 .factory('patronRegSvc', ['$q', '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     /*
269      * Existing patron objects reqire some data munging before insertion
270      * into the scope.
271      *
272      * 1. Turn everything into a hash
273      * 2. ... Except certain fields (selectors) whose widgets require objects
274      * 3. Bools must be Boolean, not t/f.
275      */
276     service.init_existing_patron = function(current) {
277
278         var patron = egCore.idl.toHash(current);
279
280         patron.home_ou = egCore.org.get(patron.home_ou.id);
281         patron.expire_date = new Date(Date.parse(patron.expire_date));
282         patron.dob = new Date(Date.parse(patron.dob));
283         patron.profile = current.profile(); // pre-hash version
284         patron.net_access_level = current.net_access_level();
285         patron.ident_type = current.ident_type();
286
287         angular.forEach(
288             ['juvenile', 'barred', 'active', 'master_account'],
289             function(field) { patron[field] = patron[field] == 't'; }
290         );
291
292         angular.forEach(patron.addresses, function(addr) {
293             addr.valid = addr.valid == 't';
294             addr.within_city_limits = addr.within_city_limits == 't';
295         });
296
297         return patron;
298     }
299
300     service.init_new_patron = function() {
301
302         var addr = {
303             valid : true,
304             within_city_limits : true
305             // default state, etc.
306         };
307
308         return {
309             isnew : true,
310             active : true,
311             card : {},
312             home_ou : egCore.org.get(egCore.auth.user().ws_ou()),
313             // TODO default profile group?
314             mailing_address : addr,
315             addresses : [addr]
316         };
317     }
318
319     return service;
320 }]);
321
322
323 function PatronRegCtrl($scope, $routeParams, 
324     $q, egCore, patronSvc, patronRegSvc) {
325
326
327     $scope.clone_id = $routeParams.clone_id;
328     $scope.stage_username = $routeParams.stage_username;
329     $scope.patron_id = 
330         patronRegSvc.patron_id = $routeParams.edit_id || $routeParams.id;
331
332     if (!$scope.edit_passthru) {
333         // in edit more, scope.edit_passthru is delivered to us by
334         // the enclosing controller.  In register mode, there is 
335         // no enclosing controller, so we create our own.
336         $scope.edit_passthru = {};
337     }
338
339     // 0=all, 1=suggested, 2=all
340     $scope.edit_passthru.vis_level = 0; 
341     // TODO: add save/clone handlers here
342
343     $q.all([
344
345         $scope.initTab ? // initTab comes from patron app
346             $scope.initTab('edit', $routeParams.id) : $q.when(),
347
348         patronRegSvc.init()
349
350     ]).then(function() {
351         // called after initTab and patronRegSvc.init have completed
352
353         var prs = patronRegSvc; // brevity
354         // in standalone mode, we have no patronSvc
355         $scope.patron = prs.init_patron(patronSvc ? patronSvc.current : null);
356         $scope.field_doc = prs.field_doc;
357         $scope.profiles = prs.profiles;
358         $scope.ident_types = prs.ident_types;
359         $scope.net_access_levels = prs.net_access_levels;
360         $scope.user_settings = prs.user_settings;
361         $scope.user_setting_types = prs.user_setting_types;
362         $scope.modified_user_settings = prs.modified_user_settings;
363         $scope.org_settings = prs.org_settings;
364         $scope.sms_carriers = prs.sms_carriers;
365         $scope.stat_cats = prs.stat_cats;
366         $scope.surveys = prs.surveys;
367
368         if ($scope.org_settings['ui.patron.edit.default_suggested'])
369             $scope.edit_passthru.vis_level = 1;
370     });
371
372     // returns the tree depth of the selected profile group tree node.
373     $scope.pgt_depth = function(grp) {
374         var d = 0;
375         while (grp = egCore.env.pgt.map[grp.parent()]) d++;
376         return d;
377     }
378
379     // IDL fields used for labels in the UI.
380     $scope.idl_fields = {
381         au  : egCore.idl.classes.au.field_map,
382         ac  : egCore.idl.classes.ac.field_map,
383         aua : egCore.idl.classes.aua.field_map
384     };
385
386     // field visibility cache.  Some fields are universally required.
387     var field_visibility = {
388         'ac.barcode' : 2,
389         'au.usrname' : 2,
390         'au.passwd' :  2,
391         // TODO passwd2 2,
392         'au.first_given_name' : 2,
393         'au.family_name' : 2,
394         'au.ident_type' : 2,
395         'au.home_ou' : 2,
396         'au.profile' : 2,
397         'au.expire_date' : 2,
398         'au.net_access_level' : 2,
399         'aua.address_type' : 2,
400         'aua.post_code' : 2,
401         'aua.street1' : 2,
402         'aua.street2' : 2,
403         'aua.city' : 2,
404         'aua.county' : 2,
405         'aua.state' : 2,
406         'aua.country' : 2,
407         'aua.valid' : 2,
408         'aua.within_city_limits' : 2,
409         'stat_cats' : 1,
410         'surveys' : 1
411     }; 
412
413     // returns true if the selected field should be visible
414     // given the current required/suggested/all setting.
415     $scope.show_field = function(field_key) {
416
417         if (field_visibility[field_key] == undefined) {
418             // compile and cache the visibility for the selected field
419
420             // org settings have not been received yet.
421             if (!$scope.org_settings) return false;
422
423             var req_set = 'ui.patron.edit.' + field_key + '.require';
424             var sho_set = 'ui.patron.edit.' + field_key + '.show';
425             var sug_set = 'ui.patron.edit.' + field_key + '.suggest';
426
427             if ($scope.org_settings[req_set]) {
428                 field_visibility[field_key] = 2;
429             } else if ($scope.org_settings[sho_set]) {
430                 field_visibility[field_key] = 2;
431             } else if ($scope.org_settings[sug_set]) {
432                 field_visibility[field_key] = 1;
433             } else {
434                 field_visibility[field_key] = 0;
435             }
436         }
437
438         return field_visibility[field_key] >= $scope.edit_passthru.vis_level;
439     }
440
441     // generates a random 4-digit password
442     $scope.generate_password = function() {
443         $scope.patron.passwd = Math.floor(Math.random()*9000) + 1000;
444     }
445
446     $scope.set_expire_date = function() {
447         if (!$scope.patron.profile) return;
448         var seconds = egCore.date.intervalToSeconds(
449             $scope.patron.profile.perm_interval());
450         var now_epoch = new Date().getTime();
451         $scope.patron.expire_date = new Date(
452             now_epoch + (seconds * 1000 /* milliseconds */))
453     }
454
455     // grp is the pgt object
456     $scope.set_profile = function(grp) {
457         $scope.patron.profile = grp;
458         $scope.set_expire_date();
459     }
460 }
461
462
463 // TODO: $inject controller params