4 * Search, checkout, items out, holds, bills, edit, etc.
7 angular.module('egPatronApp', ['ngRoute', 'ui.bootstrap',
8 'egCoreMod', 'egUiMod', 'egGridMod', 'egUserMod'])
10 .config(function($routeProvider, $locationProvider, $compileProvider) {
11 $locationProvider.html5Mode(true);
12 $compileProvider.aHrefSanitizationWhitelist(/^\s*(https?|blob):/); // grid export
14 // data loaded at startup which only requires an authtoken goes
15 // here. this allows the requests to be run in parallel instead of
16 // waiting until startup has completed.
17 var resolver = {delay : ['egCore','egUser', function(egCore , egUser) {
19 // fetch the org settings we care about during egStartup
20 // and toss them into egCore.env as egCore.env.aous[name] = value.
21 // note: only load settings here needed by all tabs; load tab-
22 // specific settings from within their respective controllers
23 egCore.env.classLoaders.aous = function() {
24 return egCore.org.settings([
25 'circ.do_not_tally_claims_returned',
28 'ui.circ.show_billing_tab_on_bills',
29 'circ.patron_expires_soon_warning',
30 'ui.circ.items_out.lost',
31 'ui.circ.items_out.longoverdue',
32 'ui.circ.items_out.claimsreturned'
33 ]).then(function(settings) {
34 // local settings are cached within egOrg. Caching them
35 // again in egEnv just simplifies the syntax for access.
36 egCore.env.aous = settings;
40 egCore.env.loadClasses.push('aous');
42 // app-globally modify the default flesh fields for
43 // fleshed user retrieval.
44 if (egUser.defaultFleshFields.indexOf('profile') == -1) {
45 egUser.defaultFleshFields = egUser.defaultFleshFields.concat([
54 return egCore.startup.go().then(function() {
56 // This call requires orgs to be loaded, because it
57 // calls egCore.org.ancestors(), so call it after startup
58 return egCore.pcrud.search('actsc',
59 {owner : egCore.org.ancestors(
60 egCore.auth.user().ws_ou(), true)},
62 ).then(function(cats) {
63 egCore.env.absorbList(cats, 'actsc');
68 $routeProvider.when('/circ/patron/search', {
69 templateUrl: './circ/patron/t_search',
70 controller: 'PatronSearchCtrl',
74 $routeProvider.when('/circ/patron/bcsearch', {
75 templateUrl: './circ/patron/t_bcsearch',
76 controller: 'PatronBarcodeSearchCtrl',
80 $routeProvider.when('/circ/patron/credentials', {
81 templateUrl: './circ/patron/t_credentials',
82 controller: 'PatronVerifyCredentialsCtrl',
86 $routeProvider.when('/circ/patron/last', {
87 templateUrl: './circ/patron/t_last_patron',
88 controller: 'PatronFetchLastCtrl',
92 // the following require a patron ID
94 $routeProvider.when('/circ/patron/:id/alerts', {
95 templateUrl: './circ/patron/t_alerts',
96 controller: 'PatronAlertsCtrl',
100 $routeProvider.when('/circ/patron/:id/checkout', {
101 templateUrl: './circ/patron/t_checkout',
102 controller: 'PatronCheckoutCtrl',
106 $routeProvider.when('/circ/patron/:id/items_out', {
107 templateUrl: './circ/patron/t_items_out',
108 controller: 'PatronItemsOutCtrl',
112 $routeProvider.when('/circ/patron/:id/holds', {
113 templateUrl: './circ/patron/t_holds',
114 controller: 'PatronHoldsCtrl',
118 $routeProvider.when('/circ/patron/:id/holds/create', {
119 templateUrl: './circ/patron/t_holds_create',
120 controller: 'PatronHoldsCreateCtrl',
124 $routeProvider.when('/circ/patron/:id/holds/:hold_id', {
125 templateUrl: './circ/patron/t_holds',
126 controller: 'PatronHoldsCtrl',
130 $routeProvider.when('/circ/patron/:id/hold/:hold_id', {
131 templateUrl: './circ/patron/t_hold_details',
132 controller: 'PatronHoldDetailsCtrl',
136 $routeProvider.when('/circ/patron/:id/bills', {
137 templateUrl: './circ/patron/t_bills',
138 controller: 'PatronBillsCtrl',
142 $routeProvider.when('/circ/patron/:id/bill/:xact_id', {
143 templateUrl: './circ/patron/t_xact_details',
144 controller: 'XactDetailsCtrl',
148 $routeProvider.when('/circ/patron/:id/bill_history/:history_tab', {
149 templateUrl: './circ/patron/t_bill_history',
150 controller: 'BillHistoryCtrl',
154 $routeProvider.when('/circ/patron/:id/messages', {
155 templateUrl: './circ/patron/t_messages',
156 controller: 'PatronMessagesCtrl',
160 $routeProvider.when('/circ/patron/:id/edit', {
161 templateUrl: './circ/patron/t_edit',
162 controller: 'PatronEditCtrl',
166 $routeProvider.when('/circ/patron/:id/credentials', {
167 templateUrl: './circ/patron/t_credentials',
168 controller: 'PatronVerifyCredentialsCtrl',
172 $routeProvider.when('/circ/patron/:id/notes', {
173 templateUrl: './circ/patron/t_notes',
174 controller: 'PatronNotesCtrl',
178 $routeProvider.when('/circ/patron/:id/triggered_events', {
179 templateUrl: './circ/patron/t_triggered_events',
180 controller: 'PatronTriggeredEventsCtrl',
184 $routeProvider.when('/circ/patron/:id/edit_perms', {
185 templateUrl: './circ/patron/t_edit_perms',
186 controller: 'PatronPermsCtrl',
190 $routeProvider.when('/circ/patron/:id/group', {
191 templateUrl: './circ/patron/t_group',
192 controller: 'PatronGroupCtrl',
196 $routeProvider.when('/circ/patron/:id/stat_cats', {
197 templateUrl: './circ/patron/t_stat_cats',
198 controller: 'PatronStatCatsCtrl',
202 $routeProvider.otherwise({redirectTo : '/circ/patron/search'});
208 .factory('patronSvc',
209 ['$q','$timeout','$location','egCore','egUser','$locale',
210 function($q , $timeout , $location , egCore, egUser , $locale) {
213 // cached patron search results
216 // currently selected patron object
219 // patron circ stats (overdues, fines, holds)
222 // event types manually overridden, which should always be
223 // overridden for checkouts to this patron for this instance of
225 checkout_overrides : {},
228 // when we change the default patron, we need to clear out any
229 // data collected on that patron
230 service.resetPatronLists = function() {
231 service.checkouts = [];
232 service.items_out = []
233 service.items_out_ids = [];
235 service.hold_ids = [];
236 service.checkout_overrides = {};
237 service.patron_stats = null;
238 service.noncat_ids = [];
239 service.hasAlerts = false;
240 service.alertsShown = false;
241 service.patronExpired = false;
242 service.patronExpiresSoon = false;
243 service.retrievedWithInactive = false;
244 service.invalidAddresses = false;
246 service.resetPatronLists(); // initialize
248 // shortcut to force-reload the current primary
249 service.refreshPrimary = function() {
250 if (!service.current) return $q.when();
251 return service.setPrimary(service.current.id(), null, true);
254 // clear the currently focused user
255 service.clearPrimary = function() {
256 // reset with no patron
257 service.resetPatronLists();
258 service.current = null;
259 service.patron_stats = null;
263 // sets the primary display user, fetching data as necessary.
264 service.setPrimary = function(id, user, force) {
265 var user_id = id ? id : (user ? user.id() : null);
267 console.debug('setting primary user to: ' + user_id);
269 if (!user_id) return $q.reject();
271 // when loading a new patron, update the last patron setting
272 if (!service.current || service.current.id() != user_id)
273 egCore.hatch.setLocalItem('eg.circ.last_patron', user_id);
275 // avoid running multiple retrievals for the same patron, which
276 // can happen during dbl-click by maintaining a single running
277 // data retrieval promise
278 if (service.primaryUserPromise) {
279 if (service.primaryUserId == user_id) {
280 return service.primaryUserPromise.promise;
282 service.primaryUserPromise = null;
286 service.primaryUserPromise = $q.defer();
287 service.primaryUserId = user_id;
289 service.getPrimary(id, user, force)
291 var p = service.primaryUserPromise;
292 service.primaryUserId = null;
293 // clear before resolution just to be safe.
294 service.primaryUserPromise = null;
298 return service.primaryUserPromise.promise;
301 service.getPrimary = function(id, user, force) {
304 if (!force && service.current &&
305 service.current.id() == user.id()) {
306 if (service.patron_stats) {
309 return service.fetchUserStats();
313 service.resetPatronLists();
314 service.current = user;
315 service.localFlesh(user);
316 return service.fetchUserStats();
319 if (!force && service.current && service.current.id() == id) {
320 if (service.patron_stats) {
323 return service.fetchUserStats();
327 service.resetPatronLists();
329 return egUser.get(id).then(
331 service.current = user;
332 service.localFlesh(user);
333 return service.fetchUserStats();
337 "unable to fetch user "+id+': '+js2JSON(err))
342 // fetching a null user clears the primary user.
343 // NOTE: this should probably reject() and log an error,
344 // but calling clear for backwards compat for now.
345 return service.clearPrimary();
349 // flesh some additional user fields locally
350 service.localFlesh = function(user) {
351 if (!angular.isObject(typeof user.home_ou()))
352 user.home_ou(egCore.org.get(user.home_ou()));
355 user.standing_penalties(),
357 if (!angular.isObject(penalty.org_unit()))
358 penalty.org_unit(egCore.org.get(penalty.org_unit()));
362 // stat_cat_entries == stat_cat_entry_user_map
363 angular.forEach(user.stat_cat_entries(), function(map) {
364 if (angular.isObject(map.stat_cat())) return;
365 // At page load, we only retrieve org-visible stat cats.
366 // For the common case, ignore entries for remote stat cats.
367 var cat = egCore.env.actsc.map[map.stat_cat()];
370 cat.owner(egCore.org.get(cat.owner()));
375 // resolves to true if the patron account has expired or will
376 // expire soon, based on YAOUS circ.patron_expires_soon_warning
377 // note: returning a promise is no longer strictly necessary
378 // (no more async activity) if the calling function is changed too.
379 service.testExpire = function() {
381 var expire = Date.parse(service.current.expire_date());
382 if (expire < new Date()) {
383 return $q.when(service.patronExpired = true);
386 var soon = egCore.env.aous['circ.patron_expires_soon_warning'];
388 var preExpire = new Date();
389 preExpire.setDate(preExpire.getDate() + Number(soon));
390 if (expire < preExpire)
391 return $q.when(service.patronExpiresSoon = true);
394 return $q.when(false);
397 // resolves to true if the patron account has any invalid addresses.
398 service.testInvalidAddrs = function() {
400 if (service.invalidAddresses)
401 return $q.when(true);
406 service.current.addresses(),
407 function(addr) { if (addr.valid() == 'f') fail = true }
410 return $q.when(fail);
413 // resolves to true if there is any aspect of the patron account
414 // which should produce a message in the alerts panel
415 service.checkAlerts = function() {
417 if (service.hasAlerts) // already checked
418 return $q.when(true);
420 var deferred = $q.defer();
421 var p = service.current;
423 if (service.alert_penalties.length ||
427 service.patron_stats.holds.ready) {
429 service.hasAlerts = true;
432 // see if the user was retrieved with an inactive card
433 if (bc = $location.search().card) {
434 var card = p.cards().filter(
435 function(c) { return c.barcode() == bc })[0];
437 if (card && card.active() == 'f') {
438 service.hasAlerts = true;
439 service.retrievedWithInactive = true;
443 // regardless of whether we know of alerts, we still need
444 // to test/fetch the expire data for display
445 service.testExpire().then(function(bool) {
446 if (bool) service.hasAlerts = true;
447 deferred.resolve(service.hasAlerts);
450 service.testInvalidAddrs().then(function(bool) {
451 if (bool) service.invalidAddresses = true;
452 deferred.resolve(service.invalidAddresses);
455 return deferred.promise;
458 service.fetchGroupFines = function() {
459 return egCore.net.request(
461 'open-ils.actor.usergroup.members.balance_owed',
462 egCore.auth.token(), service.current.usrgroup()
463 ).then(function(list) {
465 angular.forEach(list, function(u) {
466 total += 100 * Number(u.balance_owed)
468 service.patron_stats.fines.group_balance_owed = total / 100;
472 service.getUserStats = function(id) {
473 return egCore.net.request(
475 'open-ils.actor.user.opac.vital_stats.authoritative',
476 egCore.auth.token(), id
479 // force numeric to ensure correct boolean handling in templates
480 stats.fines.balance_owed = Number(stats.fines.balance_owed);
481 stats.checkouts.overdue = Number(stats.checkouts.overdue);
482 stats.checkouts.claims_returned =
483 Number(stats.checkouts.claims_returned);
484 stats.checkouts.lost = Number(stats.checkouts.lost);
485 stats.checkouts.out = Number(stats.checkouts.out);
486 stats.checkouts.total_out =
487 stats.checkouts.out + stats.checkouts.overdue;
489 if (!egCore.env.aous['circ.do_not_tally_claims_returned'])
490 stats.checkouts.total_out += stats.checkouts.claims_returned;
492 if (egCore.env.aous['circ.tally_lost'])
493 stats.checkouts.total_out += stats.checkouts.lost
500 // Fetches the IDs of any active non-cat checkouts for the current
501 // user. Also sets the patron_stats non_cat count value to match.
502 service.getUserNonCats = function(id) {
503 return egCore.net.request(
505 'open-ils.circ.open_non_cataloged_circulation.user.authoritative',
506 egCore.auth.token(), id
507 ).then(function(noncat_ids) {
508 service.noncat_ids = noncat_ids;
509 service.patron_stats.checkouts.noncat = noncat_ids.length;
513 // grab additional circ info
514 service.fetchUserStats = function() {
515 return service.getUserStats(service.current.id())
516 .then(function(stats) {
517 service.patron_stats = stats
518 service.alert_penalties = service.current.standing_penalties()
519 .filter(function(pen) {
520 return pen.standing_penalty().staff_alert() == 't'
523 service.summary_stat_cats = [];
524 angular.forEach(service.current.stat_cat_entries(),
526 if (angular.isObject(map.stat_cat()) &&
527 map.stat_cat().usr_summary() == 't') {
528 service.summary_stat_cats.push(map);
533 // run these two in parallel
534 var p1 = service.getUserNonCats(service.current.id());
535 var p2 = service.fetchGroupFines();
536 return $q.all([p1, p2]);
540 // Avoid using parens [e.g. (1.23)] to indicate negative numbers,
541 // which is the Angular default.
542 // http://stackoverflow.com/questions/17441254/why-angularjs-currency-filter-formats-negative-numbers-with-parenthesis
543 // FIXME: This change needs to be moved into a project-wide collection
544 // of locale overrides.
545 $locale.NUMBER_FORMATS.PATTERNS[1].negPre = '-';
546 $locale.NUMBER_FORMATS.PATTERNS[1].negSuf = '';
552 * Manages tabbed patron view.
553 * This is the parent scope of all patron tab scopes.
556 .controller('PatronCtrl',
557 ['$scope','$q','$location','$filter','egCore','egUser','patronSvc',
558 function($scope, $q, $location , $filter, egCore, egUser, patronSvc) {
560 // returns true if a redirect occurs
561 function redirectToAlertPanel() {
563 $scope.alert_penalties =
564 function() {return patronSvc.alert_penalties}
566 if (patronSvc.alertsShown) return false;
567 patronSvc.alertsShown = true;
569 // if the patron has any unshown alerts, show them now
570 if (patronSvc.hasAlerts &&
571 !$location.path().match(/alerts$/)) {
574 .path('/circ/patron/' + patronSvc.current.id() + '/alerts')
575 .search('card', null);
579 // no alert required. If the patron has fines and the show-bills
580 // OUS is applied, direct to the bills page.
581 if ($scope.patron_stats().fines.balance_owed > 0 // TODO: != 0 ?
582 && egCore.env.aous['ui.circ.show_billing_tab_on_bills']
583 && !$location.path().match(/bills$/)) {
585 $scope.tab = 'bills';
587 .path('/circ/patron/' + patronSvc.current.id() + '/bills')
588 .search('card', null);
596 // called after each route-specified controller is instantiated.
597 // this doubles as a way to inform the top-level controller that
598 // egStartup.go() has completed, which means we are clear to
599 // fetch the patron, etc.
600 $scope.initTab = function(tab, patron_id) {
601 console.log('init tab ' + tab);
603 $scope.aous = egCore.env.aous;
606 $scope.patron_id = patron_id;
607 return patronSvc.setPrimary($scope.patron_id)
608 .then(function() {return patronSvc.checkAlerts()})
609 .then(redirectToAlertPanel);
614 $scope.patron = function() { return patronSvc.current }
615 $scope.patron_stats = function() { return patronSvc.patron_stats }
616 $scope.summary_stat_cats = function() { return patronSvc.summary_stat_cats }
618 $scope.print_address = function(addr) {
621 template : 'patron_address',
623 patron : egCore.idl.toHash(patronSvc.current),
624 address : egCore.idl.toHash(addr)
629 $scope.toggle_expand_summary = function() {
630 if ($scope.collapsePatronSummary) {
631 $scope.collapsePatronSummary = false;
632 egCore.hatch.removeItem('eg.circ.patron.summary.collapse');
634 $scope.collapsePatronSummary = true;
635 egCore.hatch.setItem('eg.circ.patron.summary.collapse', true);
639 // always expand the patron summary in the search UI, regardless
640 // of stored preference.
641 $scope.collapse_summary = function() {
642 return $scope.tab != 'search' && $scope.collapsePatronSummary;
645 egCore.hatch.getItem('eg.circ.patron.summary.collapse')
646 .then(function(val) {$scope.collapsePatronSummary = Boolean(val)});
649 .controller('PatronBarcodeSearchCtrl',
650 ['$scope','$location','egCore','egConfirmDialog','egUser','patronSvc',
651 function($scope , $location , egCore , egConfirmDialog , egUser , patronSvc) {
652 $scope.selectMe = true; // focus text input
653 patronSvc.clearPrimary(); // clear the default user
655 // jump to the patron checkout UI
656 function loadPatron(user_id) {
658 .path('/circ/patron/' + user_id + '/checkout')
659 .search('card', $scope.args.barcode);
662 // create an opt-in=yes response for the loaded user
663 function createOptIn(user_id) {
666 'open-ils.actor.user.org_unit_opt_in.create',
667 egCore.auth.token(), user_id).then(function(resp) {
668 if (evt = egCore.evt.parse(resp)) return alert(evt);
674 $scope.submitBarcode = function(args) {
675 $scope.bcNotFound = null;
676 if (!args.barcode) return;
678 // blur so next time it's set to true it will re-apply select()
679 $scope.selectMe = false;
686 'open-ils.actor.get_barcodes',
687 egCore.auth.token(), egCore.auth.user().ws_ou(),
688 'actor', args.barcode)
690 .then(function(resp) { // get_barcodes
692 if (evt = egCore.evt.parse(resp)) {
697 if (!resp || !resp[0]) {
698 $scope.bcNotFound = args.barcode;
699 $scope.selectMe = true;
703 // see if an opt-in request is needed
704 user_id = resp[0].id;
705 return egCore.net.request(
707 'open-ils.actor.user.org_unit_opt_in.check',
708 egCore.auth.token(), user_id);
710 }).then(function(optInResp) { // opt_in_check
712 if (evt = egCore.evt.parse(optInResp)) {
717 if (optInResp == 1) {
718 // opt-in handled or not needed
719 return loadPatron(user_id);
722 // opt-in needed, show the opt-in dialog
723 egUser.get(user_id, {useFields : []})
725 .then(function(user) { // retrieve user
726 egConfirmDialog.open(
727 egCore.strings.OPT_IN_DIALOG, '',
728 { org : egCore.org.get(user.home_ou()),
730 ok : function() { createOptIn(user.id()) },
731 cancel : function() {}
741 * Manages patron search
743 .controller('PatronSearchCtrl',
744 ['$scope','$q','$routeParams','$timeout','$window','$location','egCore',
745 '$filter','egUser', 'patronSvc','egGridDataProvider','$document',
746 function($scope, $q, $routeParams, $timeout, $window, $location, egCore,
747 $filter, egUser, patronSvc , egGridDataProvider , $document) {
749 $scope.initTab('search');
750 $scope.focusMe = true;
751 $scope.searchArgs = {
752 // default to searching globally
753 home_ou : egCore.org.tree()
756 // last used patron search form element
759 $scope.gridControls = {
760 activateItem : function(item) {
761 $location.path('/circ/patron/' + item.id() + '/checkout');
763 selectedItems : function() {return []}
766 // Handle URL-encoded searches
767 if ($location.search().search) {
768 patronSvc.urlSearch = {search : JSON2js($location.search().search)};
770 // why the double-JSON encoded sort?
771 patronSvc.urlSearch.sort =
772 JSON2js(patronSvc.urlSearch.search.search_sort);
773 delete patronSvc.urlSearch.search.search_sort;
777 if (patronSvc.lastSearch) {
778 propagate = patronSvc.lastSearch.search;
779 } else if (patronSvc.urlSearch) {
780 propagate = patronSvc.urlSearch.search;
783 if (egCore.env.pgt) {
784 $scope.profiles = egCore.env.pgt.list;
786 egCore.pcrud.search('pgt', {parent : null},
787 {flesh : -1, flesh_fields : {pgt : ['children']}}
790 egCore.env.absorbTree(tree, 'pgt')
791 $scope.profiles = egCore.env.pgt.list;
797 // populate the search form with our cached / preexisting search info
798 angular.forEach(propagate, function(val, key) {
799 if (key == 'profile')
800 val.value = $scope.profiles.filter(function(p) { p.id() == val.value })[0];
801 if (key == 'home_ou')
802 val.value = egCore.org.get(val.value);
803 $scope.searchArgs[key] = val.value;
807 var provider = egGridDataProvider.instance({});
810 function() {return $scope.gridControls.selectedItems()},
813 patronSvc.setPrimary(null, list[0]);
818 provider.get = function(offset, count) {
819 var deferred = $q.defer();
822 if (patronSvc.urlSearch) {
823 fullSearch = patronSvc.urlSearch;
824 // enusre the urlSearch only runs once.
825 delete patronSvc.urlSearch;
829 var search = compileSearch($scope.searchArgs);
830 if (Object.keys(search) == 0) return $q.when();
832 var home_ou = search.home_ou;
833 delete search.home_ou;
834 var inactive = search.inactive;
835 delete search.inactive;
839 sort : compileSort(),
845 fullSearch.count = count;
846 fullSearch.offset = offset;
848 if (patronSvc.lastSearch) {
849 // search repeated, return the cached results
850 if (angular.equals(fullSearch, patronSvc.lastSearch)) {
851 console.log('patron search returning ' +
852 patronSvc.patrons.length + ' cached results');
854 // notify has to happen after returning the promise
857 angular.forEach(patronSvc.patrons, function(user) {
858 deferred.notify(user);
863 return deferred.promise;
867 patronSvc.lastSearch = fullSearch;
869 if (fullSearch.search.id) {
870 // search by user id performs a direct ID lookup
871 var userId = fullSearch.search.id.value;
874 egUser.get(userId).then(function(user) {
875 patronSvc.localFlesh(user);
876 patronSvc.patrons = [user];
877 deferred.notify(user);
882 return deferred.promise;
885 patronSvc.patrons = [];
888 'open-ils.actor.patron.search.advanced.fleshed',
895 egUser.defaultFleshFields,
899 function() { deferred.resolve() },
902 patronSvc.localFlesh(user); // inline
903 patronSvc.patrons.push(user);
904 deferred.notify(user);
908 return deferred.promise;
911 $scope.patronSearchGridProvider = provider;
913 // determine the tree depth of the profile group
914 $scope.pgt_depth = function(grp) {
916 while (grp = egCore.env.pgt.map[grp.parent()]) d++;
920 $scope.clearForm = function () {
921 $scope.searchArgs={};
922 if (lastFormElement) lastFormElement.focus();
925 $scope.applyShowExtras = function($event, bool) {
927 $scope.showExtras = true;
928 egCore.hatch.setItem('eg.circ.patron.search.show_extras', true);
930 $scope.showExtras = false;
931 egCore.hatch.removeItem('eg.circ.patron.search.show_extras');
933 if (lastFormElement) lastFormElement.focus();
934 $event.preventDefault();
937 egCore.hatch.getItem('eg.circ.patron.search.show_extras')
938 .then(function(val) {$scope.showExtras = val});
940 // map form arguments into search params
941 function compileSearch(args) {
943 angular.forEach(args, function(val, key) {
945 if (key == 'profile' && args.profile) {
946 search.profile = {value : args.profile.id(), group : 0};
947 } else if (key == 'home_ou' && args.home_ou) {
948 search.home_ou = args.home_ou.id(); // passed separately
949 } else if (key == 'inactive') {
950 search.inactive = val;
952 search[key] = {value : val, group : 0};
954 if (key.match(/phone|ident/)) {
955 search[key].group = 2;
957 if (key.match(/street|city|state|post_code/)) {
958 search[key].group = 1;
959 } else if (key == 'card') {
960 search[key].group = 3
968 function compileSort() {
970 if (!provider.sort.length) {
973 "first_given_name ASC",
974 "second_given_name ASC",
983 if (angular.isObject(sortdef)) {
984 var name = Object.keys(sortdef)[0];
985 var dir = sortdef[name];
986 sort.push(name + ' ' + dir);
996 $scope.setLastFormElement = function() {
997 lastFormElement = $document[0].activeElement;
1000 // search form submit action; tells the results grid to
1002 $scope.search = function(args) { // args === $scope.searchArgs
1003 if (args && Object.keys(args).length)
1004 $scope.gridControls.refresh();
1005 if (lastFormElement) lastFormElement.focus();
1008 // TODO: move this into the (forthcoming) grid row activate action
1009 $scope.onPatronDblClick = function($event, user) {
1010 $location.path('/circ/patron/' + user.id() + '/checkout');
1013 if (patronSvc.urlSearch) {
1014 // force the grid to load the url-based search on page load
1023 .controller('PatronMessagesCtrl',
1024 ['$scope','$q','$routeParams','egCore','$modal','patronSvc','egCirc',
1025 function($scope , $q , $routeParams, egCore , $modal , patronSvc , egCirc) {
1026 $scope.initTab('messages', $routeParams.id);
1027 var usr_id = $routeParams.id;
1029 // setup date filters
1030 var start = new Date(); // now - 1 year
1031 start.setFullYear(start.getFullYear() - 1),
1034 end_date : new Date()
1037 function date_range() {
1038 var start = $scope.dates.start_date.toISOString().replace(/T.*/,'');
1039 var end = $scope.dates.end_date.toISOString().replace(/T.*/,'');
1040 var today = new Date().toISOString().replace(/T.*/,'');
1041 if (end == today) end = 'now';
1042 return [start, end];
1047 var activeGrid = $scope.activeGridControls = {
1048 setSort : function() {
1049 return ['set_date'];
1051 setQuery : function() {
1056 {stop_date : {'>' : 'now'}}
1062 var archiveGrid = $scope.archiveGridControls = {
1063 setSort : function() {
1064 return ['set_date'];
1066 setQuery : function() {
1069 stop_date : {'<=' : 'now'},
1070 set_date : {between : date_range()}
1075 $scope.removePenalty = function(selected) {
1076 // the grid stores flattened penalties. Fetch penalty objects first
1078 var ids = selected.map(function(s){ return s.id });
1079 egCore.pcrud.search('ausp',
1081 {atomic : true, authoritative : true}
1084 ).then(function(penalties) {
1085 return egCore.pcrud.remove(penalties);
1087 // then refresh the grid
1088 }).then(function() {
1089 activeGrid.refresh();
1093 $scope.archivePenalty = function(selected) {
1094 // the grid stores flattened penalties. Fetch penalty objects first
1096 var ids = selected.map(function(s){ return s.id });
1097 egCore.pcrud.search('ausp',
1099 {atomic : true, authoritative : true}
1102 ).then(function(penalties) {
1103 angular.forEach(penalties, function(p){ p.stop_date('now') });
1104 return egCore.pcrud.update(penalties);
1106 // then refresh the grid
1107 }).then(function() {
1108 activeGrid.refresh();
1109 archiveGrid.refresh();
1113 // leverage egEnv for caching
1114 function fetchPenaltyTypes() {
1116 return $q.when(egCore.env.csp.list);
1117 return egCore.pcrud.search(
1118 // id <= 100 are reserved for system use
1119 'csp', {id : {'>': 100}}, {}, {atomic : true})
1120 .then(function(penalties) {
1121 egCore.env.absorbList(penalties, 'csp');
1126 $scope.createPenalty = function() {
1127 egCirc.create_penalty(usr_id).then(function() {
1128 activeGrid.refresh();
1129 // force a refresh of the user, since they may now
1130 // have blocking penalties, etc.
1131 patronSvc.setPrimary(patronSvc.current.id(), null, true);
1135 $scope.editPenalty = function(selected) {
1136 if (selected.length == 0) return;
1138 // grab the penalty from the user object
1139 var penalty = patronSvc.current.standing_penalties().filter(
1140 function(p) {return p.id() == selected[0].id})[0];
1142 egCirc.edit_penalty(penalty).then(function() {
1143 activeGrid.refresh();
1144 // force a refresh of the user, since they may now
1145 // have blocking penalties, etc.
1146 patronSvc.setPrimary(patronSvc.current.id(), null, true);
1153 * Link to patron edit UI
1155 .controller('PatronEditCtrl',
1156 ['$scope','$routeParams','$location','egCore','patronSvc',
1157 function($scope, $routeParams, $location , egCore , patronSvc) {
1158 $scope.initTab('edit', $routeParams.id);
1160 var url = $location.absUrl().replace(/\/staff.*/, '/actor/user/register');
1161 url += '?usr=' + encodeURIComponent($routeParams.id);
1164 on_save : function() {
1165 patronSvc.refreshPrimary();
1169 $scope.patron_edit_url = url;
1173 * Credentials tester
1175 .controller('PatronVerifyCredentialsCtrl',
1176 ['$scope','$routeParams','$location','egCore',
1177 function($scope, $routeParams , $location , egCore) {
1178 $scope.verified = null;
1179 $scope.focusMe = true;
1181 // called with a patron, pre-populate the form args
1182 $scope.initTab('other', $routeParams.id).then(
1184 if ($routeParams.id && $scope.patron()) {
1185 $scope.prepop = true;
1186 $scope.username = $scope.patron().usrname();
1187 $scope.barcode = $scope.patron().card().barcode();
1189 $scope.username = '';
1190 $scope.barcode = '';
1191 $scope.password = '';
1196 // verify login credentials
1197 $scope.verify = function() {
1198 $scope.verified = null;
1199 $scope.notFound = false;
1203 'open-ils.actor.verify_user_password',
1204 egCore.auth.token(), $scope.barcode,
1205 $scope.username, hex_md5($scope.password || '')
1207 ).then(function(resp) {
1208 $scope.focusMe = true;
1209 if (evt = egCore.evt.parse(resp)) {
1211 } else if (resp == 1) {
1212 $scope.verified = true;
1214 $scope.verified = false;
1219 // load the main patron UI for the provided username or barcode
1220 $scope.load = function($event) {
1221 $scope.notFound = false;
1222 $scope.verified = null;
1226 'open-ils.actor.user.retrieve_id_by_barcode_or_username',
1227 egCore.auth.token(), $scope.barcode, $scope.username
1229 ).then(function(resp) {
1232 $location.path('/circ/patron/' + resp + '/checkout');
1236 // something went wrong...
1237 $scope.focusMe = true;
1238 if (evt = egCore.evt.parse(resp)) {
1239 if (evt.textcode == 'ACTOR_USR_NOT_FOUND') {
1240 $scope.notFound = true;
1249 // load() button sits within the verify form.
1250 // avoid submitting the verify() form action on load()
1251 $event.preventDefault();
1255 .controller('PatronAlertsCtrl',
1256 ['$scope','$routeParams','$location','egCore','patronSvc',
1257 function($scope, $routeParams , $location , egCore , patronSvc) {
1259 $scope.initTab('other', $routeParams.id)
1261 $scope.patronExpired = patronSvc.patronExpired;
1262 $scope.patronExpiresSoon = patronSvc.patronExpiresSoon;
1263 $scope.retrievedWithInactive = patronSvc.retrievedWithInactive;
1264 $scope.invalidAddresses = patronSvc.invalidAddresses;
1269 .controller('PatronNotesCtrl',
1270 ['$scope','$routeParams','$location','egCore','patronSvc','$modal',
1271 function($scope, $routeParams , $location , egCore , patronSvc , $modal) {
1272 $scope.initTab('other', $routeParams.id);
1273 var usr_id = $routeParams.id;
1276 function refreshPage() {
1278 egCore.pcrud.search('aun',
1280 {flesh : 1, flesh_fields : {aun : ['creator']}},
1281 {authoritative : true})
1282 .then(null, null, function(note) {
1283 $scope.notes.push(note);
1287 // open the new-note dialog and create the note
1288 $scope.newNote = function() {
1290 templateUrl: './circ/patron/t_new_note_dialog',
1292 ['$scope', '$modalInstance',
1293 function($scope, $modalInstance) {
1294 $scope.focusNote = true;
1296 $scope.ok = function(count) { $modalInstance.close($scope.args) }
1297 $scope.cancel = function () { $modalInstance.dismiss() }
1301 if (!args.value) return;
1302 var note = new egCore.idl.aun();
1304 note.title(args.title);
1305 note.value(args.value);
1306 note.pub(args.pub ? 't' : 'f');
1307 note.creator(egCore.auth.user().id());
1308 egCore.pcrud.create(note).then(function() {refreshPage()});
1313 // delete the selected note
1314 $scope.deleteNote = function(note) {
1315 egCore.pcrud.remove(note).then(function() {refreshPage()});
1318 // print the selected note
1319 $scope.printNote = function(note) {
1320 var hash = egCore.idl.toHash(note);
1321 hash.usr = egCore.idl.toHash($scope.patron());
1322 egCore.print.print({
1323 context : 'default',
1324 template : 'patron_note',
1325 scope : {note : hash}
1329 // perform the initial note fetch
1333 .controller('PatronGroupCtrl',
1334 ['$scope','$routeParams','$q','$window','$timeout','$location','egCore',
1335 'patronSvc','$modal','egPromptDialog','egConfirmDialog',
1336 function($scope, $routeParams , $q , $window , $timeout, $location , egCore ,
1337 patronSvc , $modal , egPromptDialog , egConfirmDialog) {
1339 var usr_id = $routeParams.id;
1341 $scope.totals = {owed : 0, total_out : 0, overdue : 0}
1343 var grid = $scope.gridControls = {
1344 activateItem : function(item) {
1345 $location.path('/circ/patron/' + item.id + '/checkout');
1347 itemRetrieved : function(item) {
1349 if (item.id == patronSvc.current.id()) {
1350 item.stats = patronSvc.patron_stats;
1353 // flesh stats for other group members
1354 patronSvc.getUserStats(item.id).then(function(stats) {
1356 $scope.totals.total_out += stats.checkouts.total_out;
1357 $scope.totals.overdue += stats.checkouts.overdue;
1361 setSort : function() {
1362 return ['create_date'];
1366 $scope.initTab('other', $routeParams.id)
1367 .then(function(redirect) {
1368 // if we are redirecting to the alerts page, avoid updating the
1370 if (redirect) return;
1371 // let initTab() fetch the user first so we can know the usrgroup
1374 usrgroup : patronSvc.current.usrgroup(),
1377 $scope.totals.owed = patronSvc.patron_stats.fines.group_balance_owed;
1380 $scope.removeFromGroup = function(selected) {
1382 angular.forEach(selected, function(user) {
1383 console.debug('removing user ' + user.id + ' from group');
1388 'open-ils.actor.usergroup.new',
1389 egCore.auth.token(), user.id, true
1394 $q.all(promises).then(function() {grid.refresh()});
1397 function addUserToGroup(user) {
1398 user.usrgroup(patronSvc.current.usrgroup());
1399 user.ischanged(true);
1402 'open-ils.actor.patron.update',
1403 egCore.auth.token(), user
1405 ).then(function() {grid.refresh()});
1408 // fetch each user ("selected" has flattened users)
1409 // update the usrgroup, then update the user object
1410 // After all updates are complete, refresh the grid.
1411 function moveUsersToGroup(target_user, selected) {
1414 angular.forEach(selected, function(user) {
1416 egCore.pcrud.retrieve('au', user.id)
1418 u.usrgroup(target_user.usrgroup());
1420 return egCore.net.request(
1422 'open-ils.actor.patron.update',
1423 egCore.auth.token(), u
1429 $q.all(promises).then(function() {grid.refresh()});
1432 function showMoveToGroupConfirm(barcode, selected, outbound) {
1435 egCore.pcrud.search('ac', {barcode : barcode})
1437 // fetch the fleshed user
1438 .then(function(card) {
1440 if (!card) return; // TODO: warn user
1442 egCore.pcrud.retrieve('au', card.usr())
1443 .then(function(user) {
1446 templateUrl: './circ/patron/t_move_to_group_dialog',
1448 '$scope','$modalInstance',
1449 function($scope , $modalInstance) {
1451 $scope.selected = selected;
1452 $scope.outbound = outbound;
1454 function(count) { $modalInstance.close() }
1456 function () { $modalInstance.dismiss() }
1459 }).result.then(function() {
1461 moveUsersToGroup(user, selected);
1463 addUserToGroup(user);
1470 // selected == move selected patrons to another patron's group
1471 // !selected == patron from a different group moves into our group
1472 function moveToGroup(selected, outbound) {
1473 egPromptDialog.open(
1474 egCore.strings.GROUP_ADD_USER, '',
1475 {ok : function(value) {
1477 showMoveToGroupConfirm(value, selected, outbound);
1482 $scope.moveToGroup = function() { moveToGroup([], false) };
1483 $scope.moveToAnotherGroup = function(selected) { moveToGroup(selected, true) };
1485 $scope.cloneUser = function(selected) {
1486 if (!selected.length) return;
1487 var url = $location.absUrl().replace(
1489 '/patron/register/clone/' + selected[0].id);
1490 $window.open(url, '_blank').focus();
1493 $scope.retrieveSelected = function(selected) {
1494 if (!selected.length) return;
1495 angular.forEach(selected, function(usr) {
1496 $timeout(function() {
1497 var url = $location.absUrl().replace(
1499 '/patron/' + usr.id + '/checkout');
1500 $window.open(url, '_blank')
1507 .controller('PatronStatCatsCtrl',
1508 ['$scope','$routeParams','$q','egCore','patronSvc',
1509 function($scope, $routeParams , $q , egCore , patronSvc) {
1510 $scope.initTab('other', $routeParams.id)
1511 .then(function(redirect) {
1512 // Entries for org-visible stat cats are fleshed. Any others
1513 // have to be fleshed within.
1516 angular.forEach(patronSvc.current.stat_cat_entries(),
1518 if (!angular.isObject(entry.stat_cat())) {
1519 to_flesh[entry.stat_cat()] = entry;
1524 if (!Object.keys(to_flesh).length) return;
1526 egCore.pcrud.search('actsc', {id : Object.keys(to_flesh)})
1527 .then(null, null, function(cat) { // stream
1528 cat.owner(egCore.org.get(cat.owner())); // owner flesh
1529 to_flesh[cat.id()].stat_cat(cat);
1534 .controller('PatronFetchLastCtrl',
1535 ['$scope','$location','egCore',
1536 function($scope , $location , egCore) {
1538 var id = egCore.hatch.getLocalItem('eg.circ.last_patron');
1539 if (id) return $location.path('/circ/patron/' + id + '/checkout');
1541 $scope.no_last = true;
1544 .controller('PatronTriggeredEventsCtrl',
1545 ['$scope','$routeParams','$location','egCore','patronSvc',
1546 function($scope, $routeParams, $location , egCore , patronSvc) {
1547 $scope.initTab('other', $routeParams.id);
1549 var url = $location.absUrl().replace(/\/staff.*/, '/actor/user/event_log');
1550 url += '?patron_id=' + encodeURIComponent($routeParams.id);
1552 $scope.triggered_events_url = url;
1556 .controller('PatronPermsCtrl',
1557 ['$scope','$routeParams','$window','$location','egCore',
1558 function($scope , $routeParams , $window , $location , egCore) {
1559 $scope.initTab('other', $routeParams.id);
1561 var url = $location.absUrl().replace(
1562 /\/eg\/staff.*/, '/xul/server/patron/user_edit.xhtml');
1564 url += '?usr=' + encodeURIComponent($routeParams.id);
1566 // user_edit does not load the session via cookie. It uses URL
1567 // params or xulG instead. Pass via xulG.
1569 ses : egCore.auth.token(),
1570 on_patron_save : function() {
1571 $scope.funcs.reload();
1575 $scope.user_perms_url = url;