2 * Checkin, checkout, and renew
5 angular.module('egCoreMod')
8 ['$uibModal','$q','egCore','egAlertDialog','egConfirmDialog',
10 function($uibModal , $q , egCore , egAlertDialog , egConfirmDialog,
14 // auto-override these events after the first override
15 auto_override_checkout_events : {},
16 require_initials : false
19 egCore.startup.go().finally(function() {
21 'ui.staff.require_initials.patron_standing_penalty',
22 'ui.admin.work_log.max_entries',
23 'ui.admin.patron_log.max_entries'
24 ]).then(function(set) {
25 service.require_initials = Boolean(set['ui.staff.require_initials.patron_standing_penalty']);
29 service.reset = function() {
30 service.auto_override_checkout_events = {};
33 // these events can be overridden by staff during checkout
34 service.checkout_overridable_events = [
35 'PATRON_EXCEEDS_OVERDUE_COUNT',
36 'PATRON_EXCEEDS_CHECKOUT_COUNT',
37 'PATRON_EXCEEDS_FINES',
39 'CIRC_EXCEEDS_COPY_RANGE',
40 'ITEM_DEPOSIT_REQUIRED',
41 'ITEM_RENTAL_FEE_REQUIRED',
42 'PATRON_EXCEEDS_LOST_COUNT',
43 'COPY_CIRC_NOT_ALLOWED',
50 // after the first override of any of these events,
51 // auto-override them in subsequent calls.
52 service.checkout_auto_override_after_first = [
53 'PATRON_EXCEEDS_OVERDUE_COUNT',
55 'PATRON_EXCEEDS_LOST_COUNT',
56 'PATRON_EXCEEDS_CHECKOUT_COUNT',
57 'PATRON_EXCEEDS_FINES'
61 // overridable during renewal
62 service.renew_overridable_events = [
63 'PATRON_EXCEEDS_OVERDUE_COUNT',
64 'PATRON_EXCEEDS_LOST_COUNT',
65 'PATRON_EXCEEDS_CHECKOUT_COUNT',
66 'PATRON_EXCEEDS_FINES',
67 'CIRC_EXCEEDS_COPY_RANGE',
68 'ITEM_DEPOSIT_REQUIRED',
69 'ITEM_RENTAL_FEE_REQUIRED',
71 'COPY_CIRC_NOT_ALLOWED',
74 'COPY_NEEDED_FOR_HOLD',
75 'MAX_RENEWALS_REACHED',
76 'CIRC_CLAIMS_RETURNED'
79 // these checkin events do not produce alerts when
80 // options.suppress_alerts is in effect.
81 service.checkin_suppress_overrides = [
85 'PATRON_ACCOUNT_EXPIRED',
87 'CIRC_CLAIMS_RETURNED',
90 'COPY_STATUS_LONG_OVERDUE',
91 'COPY_STATUS_MISSING',
92 'PATRON_EXCEEDS_FINES'
95 // these events can be overridden by staff during checkin
96 service.checkin_overridable_events =
97 service.checkin_suppress_overrides.concat([
98 'TRANSIT_CHECKIN_INTERVAL_BLOCK'
101 // Performs a checkout.
102 // Returns a promise resolved with the original params and options
103 // and the final checkout event (e.g. in the case of override).
104 // Rejected if the checkout cannot be completed.
106 // params : passed directly as arguments to the server API
107 // options : non-parameter controls. e.g. "override", "check_barcode"
108 service.checkout = function(params, options) {
109 if (!options) options = {};
111 console.debug('egCirc.checkout() : '
112 + js2JSON(params) + ' : ' + js2JSON(options));
114 var promise = options.check_barcode ?
115 service.test_barcode(params.copy_barcode) : $q.when();
117 // avoid re-check on override, etc.
118 delete options.check_barcode;
120 return promise.then(function() {
122 var method = 'open-ils.circ.checkout.full';
123 if (options.override) method += '.override';
125 return egCore.net.request(
126 'open-ils.circ', method, egCore.auth.token(), params
128 ).then(function(evt) {
130 if (!angular.isArray(evt)) evt = [evt];
132 return service.flesh_response_data('checkout', evt, params, options)
134 return service.handle_checkout_resp(evt, params, options);
136 .then(function(final_resp) {
137 return service.munge_resp_data(final_resp,'checkout',method)
143 // Performs a renewal.
144 // Returns a promise resolved with the original params and options
145 // and the final checkout event (e.g. in the case of override)
146 // Rejected if the renewal cannot be completed.
147 service.renew = function(params, options) {
148 if (!options) options = {};
150 console.debug('egCirc.renew() : '
151 + js2JSON(params) + ' : ' + js2JSON(options));
153 var promise = options.check_barcode ?
154 service.test_barcode(params.copy_barcode) : $q.when();
156 // avoid re-check on override, etc.
157 delete options.check_barcode;
159 return promise.then(function() {
161 var method = 'open-ils.circ.renew';
162 if (options.override) method += '.override';
164 return egCore.net.request(
165 'open-ils.circ', method, egCore.auth.token(), params
167 ).then(function(evt) {
169 if (!angular.isArray(evt)) evt = [evt];
171 return service.flesh_response_data(
172 'renew', evt, params, options)
174 return service.handle_renew_resp(evt, params, options);
176 .then(function(final_resp) {
177 return service.munge_resp_data(final_resp,'renew',method)
183 // Performs a checkin
184 // Returns a promise resolved with the original params and options,
185 // plus the final checkin event (e.g. in the case of override).
186 // Rejected if the checkin cannot be completed.
187 service.checkin = function(params, options) {
188 if (!options) options = {};
190 console.debug('egCirc.checkin() : '
191 + js2JSON(params) + ' : ' + js2JSON(options));
193 var promise = options.check_barcode ?
194 service.test_barcode(params.copy_barcode) : $q.when();
196 // avoid re-check on override, etc.
197 delete options.check_barcode;
199 return promise.then(function() {
201 var method = 'open-ils.circ.checkin';
202 if (options.override) method += '.override';
204 return egCore.net.request(
205 'open-ils.circ', method, egCore.auth.token(), params
207 ).then(function(evt) {
209 if (!angular.isArray(evt)) evt = [evt];
210 return service.flesh_response_data(
211 'checkin', evt, params, options)
213 return service.handle_checkin_resp(evt, params, options);
215 .then(function(final_resp) {
216 return service.munge_resp_data(final_resp,'checkin',method)
222 // provide consistent formatting of the final response data
223 service.munge_resp_data = function(final_resp,worklog_action,worklog_method) {
224 var data = final_resp.data = {};
226 if (!final_resp.evt[0]) return;
228 var payload = final_resp.evt[0].payload;
229 if (!payload) return;
231 data.circ = payload.circ;
232 data.parent_circ = payload.parent_circ;
233 data.hold = payload.hold;
234 data.record = payload.record;
235 data.acp = payload.copy;
236 data.acn = payload.volume ? payload.volume : payload.copy ? payload.copy.call_number() : null;
237 data.au = payload.patron;
238 data.transit = payload.transit;
239 data.status = payload.status;
240 data.message = payload.message;
241 data.title = final_resp.evt[0].title;
242 data.author = final_resp.evt[0].author;
243 data.isbn = final_resp.evt[0].isbn;
244 data.route_to = final_resp.evt[0].route_to;
246 // for checkin, the mbts lives on the main circ
247 if (payload.circ && payload.circ.billable_transaction())
248 data.mbts = payload.circ.billable_transaction().summary();
250 // on renewals, the mbts lives on the parent circ
251 if (payload.parent_circ && payload.parent_circ.billable_transaction())
252 data.mbts = payload.parent_circ.billable_transaction().summary();
254 if (!data.route_to) {
256 data.route_to = data.transit.dest().shortname();
257 } else if (data.acp) {
258 data.route_to = data.acp.location().name();
263 worklog_action == 'checkout'
264 ? egCore.strings.EG_WORK_LOG_CHECKOUT
265 : (worklog_action == 'renew'
266 ? egCore.strings.EG_WORK_LOG_RENEW
267 : egCore.strings.EG_WORK_LOG_CHECKIN // worklog_action == 'checkin'
269 'action' : worklog_action,
270 'method' : worklog_method,
271 'response' : final_resp
278 service.handle_overridable_checkout_event = function(evt, params, options) {
280 if (options.override) {
281 // override attempt already made and failed.
282 // NOTE: I don't think we'll ever get here, since the
283 // override attempt should produce a perm failure...
284 angular.forEach(evt, function(e){ console.debug('override failed: ' + e.textcode); });
289 if (evt.filter(function(e){return !service.auto_override_checkout_events[e.textcode];}).length == 0) {
290 // user has already opted to override these type
291 // of events. Re-run the checkout w/ override.
292 options.override = true;
293 return service.checkout(params, options);
296 // Ask the user if they would like to override this event.
297 // Some events offer a stock override dialog, while others
298 // require additional context.
300 switch(evt[0].textcode) {
301 case 'COPY_NOT_AVAILABLE':
302 return service.copy_not_avail_dialog(evt[0], params, options);
303 case 'COPY_ALERT_MESSAGE':
304 return service.copy_alert_dialog(evt[0], params, options, 'checkout');
306 return service.override_dialog(evt, params, options, 'checkout');
310 service.handle_overridable_renew_event = function(evt, params, options) {
312 if (options.override) {
313 // override attempt already made and failed.
314 // NOTE: I don't think we'll ever get here, since the
315 // override attempt should produce a perm failure...
316 angular.forEach(evt, function(e){ console.debug('override failed: ' + e.textcode); });
321 // renewal auto-overrides are the same as checkout
322 if (evt.filter(function(e){return !service.auto_override_checkout_events[e.textcode];}).length == 0) {
323 // user has already opted to override these type
324 // of events. Re-run the renew w/ override.
325 options.override = true;
326 return service.renew(params, options);
329 // Ask the user if they would like to override this event.
330 // Some events offer a stock override dialog, while others
331 // require additional context.
333 switch(evt[0].textcode) {
334 case 'COPY_ALERT_MESSAGE':
335 return service.copy_alert_dialog(evt[0], params, options, 'renew');
337 return service.override_dialog(evt, params, options, 'renew');
342 service.handle_overridable_checkin_event = function(evt, params, options) {
344 if (options.override) {
345 // override attempt already made and failed.
346 // NOTE: I don't think we'll ever get here, since the
347 // override attempt should produce a perm failure...
348 angular.forEach(evt, function(e){ console.debug('override failed: ' + e.textcode); });
353 if (options.suppress_checkin_popups
354 && evt.filter(function(e){return service.checkin_suppress_overrides.indexOf(e.textcode) == -1;}).length == 0) {
355 // Events are suppressed. Re-run the checkin w/ override.
356 options.override = true;
357 return service.checkin(params, options);
360 // Ask the user if they would like to override this event.
361 // Some events offer a stock override dialog, while others
362 // require additional context.
364 switch(evt[0].textcode) {
365 case 'COPY_ALERT_MESSAGE':
366 return service.copy_alert_dialog(evt[0], params, options, 'checkin');
368 return service.override_dialog(evt, params, options, 'checkin');
373 service.handle_renew_resp = function(evt, params, options) {
375 var final_resp = {evt : evt, params : params, options : options};
377 // track the barcode regardless of whether it refers to a copy
378 angular.forEach(evt, function(e){ e.copy_barcode = params.copy_barcode; });
380 // Overridable Events
381 if (evt.filter(function(e){return service.renew_overridable_events.indexOf(e.textcode) > -1;}).length > 0)
382 return service.handle_overridable_renew_event(evt, params, options);
385 switch (evt[0].textcode) {
387 return $q.when(final_resp);
389 case 'COPY_IN_TRANSIT':
390 case 'PATRON_CARD_INACTIVE':
391 case 'PATRON_INACTIVE':
392 case 'PATRON_ACCOUNT_EXPIRED':
393 case 'CIRC_CLAIMS_RETURNED':
394 return service.exit_alert(
395 egCore.strings[evt[0].textcode],
396 {barcode : params.copy_barcode}
400 return service.exit_alert(
401 egCore.strings[evt[0].textcode],
402 {permission : evt[0].ilsperm}
406 return service.exit_alert(
407 egCore.strings.CHECKOUT_FAILED_GENERIC, {
408 barcode : params.copy_barcode,
409 textcode : evt[0].textcode,
417 service.handle_checkout_resp = function(evt, params, options) {
419 var final_resp = {evt : evt, params : params, options : options};
421 // track the barcode regardless of whether it refers to a copy
422 angular.forEach(evt, function(e){ e.copy_barcode = params.copy_barcode; });
424 // Overridable Events
425 if (evt.filter(function(e){return service.checkout_overridable_events.indexOf(e.textcode) > -1;}).length > 0)
426 return service.handle_overridable_checkout_event(evt, params, options);
429 switch (evt[0].textcode) {
431 return $q.when(final_resp);
433 case 'ITEM_NOT_CATALOGED':
434 return service.precat_dialog(params, options);
436 case 'OPEN_CIRCULATION_EXISTS':
437 return service.circ_exists_dialog(evt, params, options);
439 case 'COPY_IN_TRANSIT':
440 return service.copy_in_transit_dialog(evt, params, options);
442 case 'PATRON_CARD_INACTIVE':
443 case 'PATRON_INACTIVE':
444 case 'PATRON_ACCOUNT_EXPIRED':
445 case 'CIRC_CLAIMS_RETURNED':
446 return service.exit_alert(
447 egCore.strings[evt[0].textcode],
448 {barcode : params.copy_barcode}
452 return service.exit_alert(
453 egCore.strings[evt[0].textcode],
454 {permission : evt[0].ilsperm}
458 return service.exit_alert(
459 egCore.strings.CHECKOUT_FAILED_GENERIC, {
460 barcode : params.copy_barcode,
461 textcode : evt[0].textcode,
468 // returns a promise resolved with the list of circ mods
469 service.get_circ_mods = function() {
471 return $q.when(egCore.env.ccm.list);
473 return egCore.pcrud.retrieveAll('ccm', null, {atomic : true})
474 .then(function(list) {
475 egCore.env.absorbList(list, 'ccm');
480 // returns a promise resolved with the list of noncat types
481 service.get_noncat_types = function() {
483 return $q.when(egCore.env.cnct.list);
485 return egCore.pcrud.search('cnct',
487 egCore.org.fullPath(egCore.auth.user().ws_ou(), true)},
488 null, {atomic : true}
489 ).then(function(list) {
490 egCore.env.absorbList(list, 'cnct');
495 service.get_staff_penalty_types = function() {
497 return $q.when(egCore.env.csp.list);
498 return egCore.pcrud.search(
499 // id <= 100 are reserved for system use
500 'csp', {id : {'>': 100}}, {}, {atomic : true})
501 .then(function(penalties) {
502 return egCore.env.absorbList(penalties, 'csp').list;
506 // ideally all of these data should be returned with the response,
507 // but until then, grab what we need.
508 service.flesh_response_data = function(action, evt, params, options) {
511 if (!evt[0] || !(payload = evt[0].payload)) return $q.when();
513 promises.push(service.flesh_copy_location(payload.copy));
516 service.flesh_copy_status(payload.copy)
519 // copy is in transit, but no transit was delivered
520 // in the payload. Do this here instead of below to
521 // ensure consistent copy status fleshiness
522 if (!payload.transit && payload.copy.status().id() == 6) { // in-transit
523 return service.find_copy_transit(evt, params, options)
524 .then(function(trans) {
526 trans.source(egCore.org.get(trans.source()));
527 trans.dest(egCore.org.get(trans.dest()));
528 payload.transit = trans;
536 // local flesh transit
537 if (transit = payload.transit) {
538 transit.source(egCore.org.get(transit.source()));
539 transit.dest(egCore.org.get(transit.dest()));
542 // TODO: renewal responses should include the patron
543 if (!payload.patron && payload.circ) {
545 egCore.pcrud.retrieve('au', payload.circ.usr())
546 .then(function(user) {payload.patron = user})
550 // extract precat values
551 angular.forEach(evt, function(e){ e.title = payload.record ? payload.record.title() :
552 (payload.copy ? payload.copy.dummy_title() : null);});
554 angular.forEach(evt, function(e){ e.author = payload.record ? payload.record.author() :
555 (payload.copy ? payload.copy.dummy_author() : null);});
557 angular.forEach(evt, function(e){ e.isbn = payload.record ? payload.record.isbn() :
558 (payload.copy ? payload.copy.dummy_isbn() : null);});
560 return $q.all(promises);
563 // fetches the full list of copy statuses
564 service.flesh_copy_status = function(copy) {
565 if (!copy) return $q.when();
567 return $q.when(copy.status(egCore.env.ccs.map[copy.status()]));
568 return egCore.pcrud.retrieveAll('ccs', {}, {atomic : true}).then(
570 egCore.env.absorbList(list, 'ccs');
571 copy.status(egCore.env.ccs.map[copy.status()]);
576 // there may be *many* copy locations and we may be handling items
577 // for other locations. Fetch copy locations as-needed and cache.
578 service.flesh_copy_location = function(copy) {
579 if (!copy) return $q.when();
580 if (angular.isObject(copy.location())) return $q.when(copy);
581 if (egCore.env.acpl) {
582 if (egCore.env.acpl.map[copy.location()]) {
583 copy.location(egCore.env.acpl.map[copy.location()]);
584 return $q.when(copy);
587 return egCore.pcrud.retrieve('acpl', copy.location())
588 .then(function(loc) {
589 egCore.env.absorbList([loc], 'acpl'); // append to cache
596 // fetch org unit addresses as needed.
597 service.get_org_addr = function(org_id, addr_type) {
598 var org = egCore.org.get(org_id);
599 var addr_id = org[addr_type]();
601 if (egCore.env.aoa && egCore.env.aoa.map[addr_id])
602 return $q.when(egCore.env.aoa.map[addr_id]);
604 return egCore.pcrud.retrieve('aoa', addr_id).then(function(addr) {
605 egCore.env.absorbList([addr], 'aoa');
606 return egCore.env.aoa.map[addr_id];
610 service.exit_alert = function(msg, scope) {
611 return egAlertDialog.open(msg, scope).result.then(
612 function() {return $q.reject()});
615 // opens a dialog asking the user if they would like to override
616 // the returned event.
617 service.override_dialog = function(evt, params, options, action) {
618 if (!angular.isArray(evt)) evt = [evt];
619 return $uibModal.open({
620 templateUrl: './circ/share/t_event_override_dialog',
622 ['$scope', '$uibModalInstance',
623 function($scope, $uibModalInstance) {
625 $scope.auto_override =
626 evt.filter(function(e){
627 return service.checkout_auto_override_after_first.indexOf(evt.textcode) > -1;
629 $scope.copy_barcode = params.copy_barcode; // may be null
630 $scope.ok = function() { $uibModalInstance.close() }
631 $scope.cancel = function ($event) {
632 $uibModalInstance.dismiss();
633 $event.preventDefault();
638 options.override = true;
640 if (action == 'checkin') {
641 return service.checkin(params, options);
644 // checkout/renew support override-after-first
645 angular.forEach(evt, function(e){
646 if (service.checkout_auto_override_after_first.indexOf(e.textcode) > -1)
647 service.auto_override_checkout_events[e.textcode] = true;
650 return service[action](params, options);
655 service.copy_not_avail_dialog = function(evt, params, options) {
656 if (angular.isArray(evt)) evt = evt[0];
657 return $uibModal.open({
658 templateUrl: './circ/share/t_copy_not_avail_dialog',
660 ['$scope','$uibModalInstance','copyStatus',
661 function($scope , $uibModalInstance , copyStatus) {
662 $scope.copyStatus = copyStatus;
663 $scope.ok = function() {$uibModalInstance.close()}
664 $scope.cancel = function() {$uibModalInstance.dismiss()}
667 copyStatus : function() {
668 return egCore.pcrud.retrieve(
669 'ccs', evt.payload.status());
674 options.override = true;
675 return service.checkout(params, options);
680 // Opens a dialog allowing the user to fill in the desired non-cat count.
681 // Unlike other dialogs, which kickoff circ actions internally
682 // as a result of events, this dialog does not kick off any circ
683 // actions. It just collects the count and and resolves the promise.
685 // This assumes the caller has already handled the noncat-type
686 // selection and just needs to collect the count info.
687 service.noncat_dialog = function(params, options) {
688 var noncatMax = 99; // hard-coded max
690 // the caller should presumably have fetched the noncat_types via
691 // our API already, but fetch them again (from cache) to be safe.
692 return service.get_noncat_types().then(function() {
694 params.noncat = true;
695 var type = egCore.env.cnct.map[params.noncat_type];
697 return $uibModal.open({
698 templateUrl: './circ/share/t_noncat_dialog',
700 ['$scope', '$uibModalInstance',
701 function($scope, $uibModalInstance) {
702 $scope.focusMe = true;
705 $scope.noncatMax = noncatMax;
706 $scope.ok = function(count) { $uibModalInstance.close(count) }
707 $scope.cancel = function ($event) {
708 $uibModalInstance.dismiss()
709 $event.preventDefault();
714 if (count && count > 0 && count <= noncatMax) {
715 // NOTE: in Chrome, form validation ensure a valid number
716 params.noncat_count = count;
717 return $q.when(params);
726 // Opens a dialog allowing the user to fill in pre-cat copy info.
727 service.precat_dialog = function(params, options) {
729 return $uibModal.open({
730 templateUrl: './circ/share/t_precat_dialog',
732 ['$scope', '$uibModalInstance', 'circMods',
733 function($scope, $uibModalInstance, circMods) {
734 $scope.focusMe = true;
735 $scope.precatArgs = {
736 copy_barcode : params.copy_barcode,
737 circ_modifier : circMods.length ? circMods[0].code() : null
739 $scope.circModifiers = circMods;
740 $scope.ok = function(args) { $uibModalInstance.close(args) }
741 $scope.cancel = function () { $uibModalInstance.dismiss() }
744 circMods : function() {
745 return service.get_circ_mods();
750 if (!args || !args.dummy_title) return $q.reject();
751 angular.forEach(args, function(val, key) {params[key] = val});
752 params.precat = true;
753 return service.checkout(params, options);
758 // find the open transit for the given copy barcode; flesh the org
760 service.find_copy_transit = function(evt, params, options) {
761 if (angular.isArray(evt)) evt = evt[0];
763 if (evt && evt.payload && evt.payload.transit)
764 return $q.when(evt.payload.transit);
766 return egCore.pcrud.search('atc',
767 { dest_recv_time : null},
769 flesh_fields : {atc : ['target_copy']},
773 barcode : params.copy_barcode,
779 order_by : {atc : 'source_send_time desc'},
781 ).then(function(transit) {
782 transit.source(egCore.org.get(transit.source()));
783 transit.dest(egCore.org.get(transit.dest()));
788 service.copy_in_transit_dialog = function(evt, params, options) {
789 if (angular.isArray(evt)) evt = evt[0];
790 return $uibModal.open({
791 templateUrl: './circ/share/t_copy_in_transit_dialog',
793 ['$scope','$uibModalInstance','transit',
794 function($scope , $uibModalInstance , transit) {
795 $scope.transit = transit;
796 $scope.ok = function() { $uibModalInstance.close(transit) }
797 $scope.cancel = function() { $uibModalInstance.dismiss() }
800 // fetch the conflicting open transit w/ fleshed copy
801 transit : function() {
802 return service.find_copy_transit(evt, params, options);
807 // user chose to abort the transit then checkout
808 return service.abort_transit(transit.id())
810 return service.checkout(params, options);
816 service.abort_transit = function(transit_id) {
817 return egCore.net.request(
819 'open-ils.circ.transit.abort',
820 egCore.auth.token(), {transitid : transit_id}
821 ).then(function(resp) {
822 if (evt = egCore.evt.parse(resp)) {
830 service.last_copy_circ = function(copy_id) {
831 return egCore.pcrud.search('circ',
832 {target_copy : copy_id},
833 {order_by : {circ : 'xact_start desc' }, limit : 1}
837 service.circ_exists_dialog = function(evt, params, options) {
838 if (angular.isArray(evt)) evt = evt[0];
840 if (!evt.payload.old_circ) {
841 return egCore.net.request(
843 'open-ils.search.asset.copy.fleshed2.find_by_barcode',
845 ).then(function(resp){
847 if (egCore.evt.parse(resp)) {
848 console.error(egCore.evt.parse(resp));
850 evt.payload.old_circ = resp.circulations()[0];
851 return service.circ_exists_dialog_impl( evt, params, options );
855 return service.circ_exists_dialog_impl( evt, params, options );
859 service.circ_exists_dialog_impl = function (evt, params, options) {
861 var openCirc = evt.payload.old_circ;
862 var sameUser = openCirc.usr() == params.patron_id;
864 return $uibModal.open({
865 templateUrl: './circ/share/t_circ_exists_dialog',
867 ['$scope','$uibModalInstance',
868 function($scope , $uibModalInstance) {
869 $scope.args = {forgive_fines : false};
870 $scope.circDate = openCirc.xact_start();
871 $scope.sameUser = sameUser;
872 $scope.ok = function() { $uibModalInstance.close($scope.args) }
873 $scope.cancel = function($event) {
874 $uibModalInstance.dismiss();
875 $event.preventDefault(); // form, avoid calling ok();
881 params.void_overdues = args.forgive_fines;
882 options.override = true;
883 return service.renew(params, options);
886 return service.checkin({
887 barcode : params.copy_barcode,
890 void_overdues : args.forgive_fines
891 }).then(function(checkin_resp) {
892 if (checkin_resp.evt[0].textcode == 'SUCCESS') {
893 return service.checkout(params, options);
895 alert(egCore.evt.parse(checkin_resp.evt[0]));
903 service.batch_backdate = function(circ_ids, backdate) {
904 return egCore.net.request(
906 'open-ils.circ.post_checkin_backdate.batch',
907 egCore.auth.token(), circ_ids, backdate);
910 service.backdate_dialog = function(circ_ids) {
911 return $uibModal.open({
912 templateUrl: './circ/share/t_backdate_dialog',
914 ['$scope','$uibModalInstance',
915 function($scope , $uibModalInstance) {
917 var today = new Date();
919 num_circs : circ_ids.length,
924 $scope.$watch('dialog.backdate', function(newval) {
925 if (newval && newval > today)
926 $scope.dialog.backdate = today;
930 $scope.cancel = function() {
931 $uibModalInstance.dismiss();
934 $scope.ok = function() {
936 var bd = $scope.dialog.backdate.toISOString().replace(/T.*/,'');
937 service.batch_backdate(circ_ids, bd)
939 function() { // on complete
940 $uibModalInstance.close({backdate : bd});
943 function(resp) { // on response
944 console.debug('backdate returned ' + resp);
946 $scope.num_processed++;
948 console.error(egCore.evt.parse(resp));
957 service.mark_claims_returned = function(barcode, date, override) {
959 var method = 'open-ils.circ.circulation.set_claims_returned';
960 if (override) method += '.override';
962 console.debug('claims returned ' + method);
964 return egCore.net.request(
965 'open-ils.circ', method, egCore.auth.token(),
966 {barcode : barcode, backdate : date})
968 .then(function(resp) {
970 if (resp == 1) { // success
971 console.debug('claims returned succeeded for ' + barcode);
974 } else if (evt = egCore.evt.parse(resp)) {
975 console.debug('claims returned failed: ' + evt.toString());
977 if (evt.textcode == 'PATRON_EXCEEDS_CLAIMS_RETURN_COUNT') {
978 // TODO check perms before offering override option?
980 if (override) return;// just to be safe
982 return egConfirmDialog.open(
983 egCore.strings.TOO_MANY_CLAIMS_RETURNED, '', {}
984 ).result.then(function() {
985 return service.mark_claims_returned(barcode, date, true);
989 if (evt.textcode == 'PERM_FAILURE') {
990 console.error('claims returned permission denied')
991 // TODO: auth override dialog?
997 service.mark_claims_returned_dialog = function(copy_barcodes) {
998 if (!copy_barcodes.length) return;
1000 return $uibModal.open({
1001 templateUrl: './circ/share/t_mark_claims_returned_dialog',
1003 ['$scope','$uibModalInstance',
1004 function($scope , $uibModalInstance) {
1006 var today = new Date();
1008 barcodes : copy_barcodes,
1012 $scope.$watch('args.date', function(newval) {
1013 if (newval && newval > today)
1014 $scope.args.backdate = today;
1017 $scope.cancel = function() {$uibModalInstance.dismiss()}
1018 $scope.ok = function() {
1020 var date = $scope.args.date.toISOString().replace(/T.*/,'');
1022 var deferred = $q.defer();
1024 // serialize the action on each barcode so that the
1025 // caller will never see multiple alerts at the same time.
1026 function mark_one() {
1027 var bc = copy_barcodes.pop();
1030 $uibModalInstance.close();
1034 // finally -> continue even when one fails
1035 service.mark_claims_returned(bc, date)
1036 .finally(function(barcode) {
1037 if (barcode) deferred.notify(barcode);
1041 mark_one(); // kick it off
1042 return deferred.promise;
1048 // serially checks in each barcode with claims_never_checked_out set
1049 // returns promise, notified on each barcode, resolved after all
1050 // checkins are complete.
1051 service.mark_claims_never_checked_out = function(barcodes) {
1052 if (!barcodes.length) return;
1054 var deferred = $q.defer();
1055 egConfirmDialog.open(
1056 egCore.strings.MARK_NEVER_CHECKED_OUT, '', {barcodes : barcodes}
1058 ).result.then(function() {
1059 function mark_one() {
1060 var bc = barcodes.pop();
1062 if (!bc) { // all done
1068 {claims_never_checked_out : true, copy_barcode : bc})
1069 .finally(function() {
1070 deferred.notify(bc);
1077 return deferred.promise;
1080 service.mark_damaged = function(copy_ids) {
1081 return egConfirmDialog.open(
1082 egCore.strings.MARK_DAMAGED_CONFIRM, '',
1083 { num_items : copy_ids.length,
1085 cancel : function() {}
1088 ).result.then(function() {
1090 angular.forEach(copy_ids, function(copy_id) {
1094 'open-ils.circ.mark_item_damaged',
1095 egCore.auth.token(), copy_id
1096 ).then(function(resp) {
1097 if (evt = egCore.evt.parse(resp)) {
1098 console.error('mark damaged failed: ' + evt);
1104 return $q.all(promises);
1108 service.mark_missing = function(copy_ids) {
1109 return egConfirmDialog.open(
1110 egCore.strings.MARK_MISSING_CONFIRM, '',
1111 { num_items : copy_ids.length,
1113 cancel : function() {}
1115 ).result.then(function() {
1117 angular.forEach(copy_ids, function(copy_id) {
1121 'open-ils.circ.mark_item_missing',
1122 egCore.auth.token(), copy_id
1123 ).then(function(resp) {
1124 if (evt = egCore.evt.parse(resp)) {
1125 console.error('mark missing failed: ' + evt);
1131 return $q.all(promises);
1137 // Mark circulations as lost via copy barcode. As each item is
1138 // processed, the returned promise is notified of the barcode.
1139 // No confirmation dialog is presented.
1140 service.mark_lost = function(copy_barcodes) {
1141 var deferred = $q.defer();
1144 angular.forEach(copy_barcodes, function(barcode) {
1148 'open-ils.circ.circulation.set_lost',
1149 egCore.auth.token(), {barcode : barcode}
1150 ).then(function(resp) {
1151 if (evt = egCore.evt.parse(resp)) {
1152 console.error("Mark lost failed: " + evt.toString());
1155 // inform the caller as each item is processed
1156 deferred.notify(barcode);
1161 $q.all(promises).then(function() {deferred.resolve()});
1162 return deferred.promise;
1165 service.abort_transits = function(transit_ids) {
1166 return egConfirmDialog.open(
1167 egCore.strings.ABORT_TRANSIT_CONFIRM, '',
1168 { num_transits : transit_ids.length,
1170 cancel : function() {}
1173 ).result.then(function() {
1175 angular.forEach(transit_ids, function(transit_id) {
1179 'open-ils.circ.transit.abort',
1180 egCore.auth.token(), {transitid : transit_id}
1181 ).then(function(resp) {
1182 if (evt = egCore.evt.parse(resp)) {
1183 console.error('abort transit failed: ' + evt);
1189 return $q.all(promises);
1195 // alert when copy location alert_message is set.
1196 // This does not affect processing, it only produces a click-through
1197 service.handle_checkin_loc_alert = function(evt, params, options) {
1198 if (angular.isArray(evt)) evt = evt[0];
1200 var copy = evt && evt.payload ? evt.payload.copy : null;
1202 if (copy && !options.suppress_checkin_popups
1203 && copy.location().checkin_alert() == 't') {
1205 return egAlertDialog.open(
1206 egCore.strings.LOCATION_ALERT_MSG, {copy : copy}).result;
1212 service.handle_checkin_resp = function(evt, params, options) {
1213 if (!angular.isArray(evt)) evt = [evt];
1215 var final_resp = {evt : evt, params : params, options : options};
1217 var copy, hold, transit;
1218 if (evt[0].payload) {
1219 copy = evt[0].payload.copy;
1220 hold = evt[0].payload.hold;
1221 transit = evt[0].payload.transit;
1224 // track the barcode regardless of whether it's valid
1225 angular.forEach(evt, function(e){ e.copy_barcode = params.copy_barcode; });
1227 angular.forEach(evt, function(e){ console.debug('checkin event ' + e.textcode); });
1229 if (evt.filter(function(e){return service.checkin_overridable_events.indexOf(e.textcode) > -1;}).length > 0)
1230 return service.handle_overridable_checkin_event(evt, params, options);
1232 switch (evt[0].textcode) {
1237 switch(Number(copy.status().id())) {
1239 case 0: /* AVAILABLE */
1240 case 4: /* MISSING */
1241 case 7: /* RESHELVING */
1243 // see if the copy location requires an alert
1244 return service.handle_checkin_loc_alert(evt, params, options)
1245 .then(function() {return final_resp});
1247 case 8: /* ON HOLDS SHELF */
1252 if (hold.pickup_lib() == egCore.auth.user().ws_ou()) {
1253 // inform user if the item is on the local holds shelf
1255 evt[0].route_to = egCore.strings.ROUTE_TO_HOLDS_SHELF;
1256 return service.route_dialog(
1257 './circ/share/t_hold_shelf_dialog',
1258 evt[0], params, options
1259 ).then(function() { return final_resp });
1262 // normally, if the hold was on the shelf at a
1263 // different location, it would be put into
1264 // transit, resulting in a ROUTE_ITEM event.
1265 return $q.when(final_resp);
1269 console.error('checkin: item on holds shelf, '
1270 + 'but hold info not returned from checkin');
1271 return $q.when(final_resp);
1274 case 11: /* CATALOGING */
1275 evt[0].route_to = egCore.strings.ROUTE_TO_CATALOGING;
1276 return $q.when(final_resp);
1278 case 15: /* ON_RESERVATION_SHELF */
1279 // TODO: show booking reservation dialog
1280 return $q.when(final_resp);
1283 console.error('Unhandled checkin copy status: '
1284 + copy.status().id() + ' : ' + copy.status().name());
1285 return $q.when(final_resp);
1289 return service.route_dialog(
1290 './circ/share/t_transit_dialog',
1291 evt[0], params, options
1292 ).then(function() { return final_resp });
1294 case 'ASSET_COPY_NOT_FOUND':
1295 return egAlertDialog.open(
1296 egCore.strings.UNCAT_ALERT_DIALOG, params)
1297 .result.then(function() {return final_resp});
1299 case 'ITEM_NOT_CATALOGED':
1300 evt[0].route_to = egCore.strings.ROUTE_TO_CATALOGING;
1301 if (options.no_precat_alert)
1302 return $q.when(final_resp);
1303 return egAlertDialog.open(
1304 egCore.strings.PRECAT_CHECKIN_MSG, params)
1305 .result.then(function() {return final_resp});
1308 console.warn('unhandled checkin response : ' + evt[0].textcode);
1309 return $q.when(final_resp);
1313 // collect transit, address, and hold info that's not already
1314 // included in responses.
1315 service.collect_route_data = function(tmpl, evt, params, options) {
1316 if (angular.isArray(evt)) evt = evt[0];
1320 if (evt.org && !tmpl.match(/hold_shelf/)) {
1322 service.get_org_addr(evt.org, 'holds_address')
1323 .then(function(addr) { data.address = addr })
1327 if (evt.payload.hold) {
1329 egCore.pcrud.retrieve('au',
1330 evt.payload.hold.usr(), {
1332 flesh_fields : {'au' : ['card']}
1334 ).then(function(patron) {data.patron = patron})
1338 if (!tmpl.match(/hold_shelf/)) {
1340 service.find_copy_transit(evt, params, options)
1341 .then(function(trans) {data.transit = trans})
1345 return $q.all(promises).then(function() { return data });
1348 service.route_dialog = function(tmpl, evt, params, options) {
1349 if (angular.isArray(evt)) evt = evt[0];
1351 return service.collect_route_data(tmpl, evt, params, options)
1352 .then(function(data) {
1354 // All actions flow from the print data
1356 var print_context = {
1357 copy : egCore.idl.toHash(evt.payload.copy),
1363 // route_dialog includes the "route to holds shelf"
1364 // dialog, which has no transit
1365 print_context.transit = egCore.idl.toHash(data.transit);
1366 print_context.dest_address = egCore.idl.toHash(data.address);
1367 print_context.dest_location =
1368 egCore.idl.toHash(egCore.org.get(data.transit.dest()));
1372 print_context.hold = egCore.idl.toHash(evt.payload.hold);
1373 print_context.patron = egCore.idl.toHash(data.patron);
1376 function print_transit() {
1377 var template = data.transit ?
1378 (data.patron ? 'hold_transit_slip' : 'transit_slip') :
1381 return egCore.print.print({
1382 context : 'default',
1383 template : template,
1384 scope : print_context
1388 // when auto-print is on, skip the dialog and go straight
1390 if (options.auto_print_holds_transits)
1391 return print_transit();
1393 return $uibModal.open({
1396 '$scope','$uibModalInstance',
1397 function($scope , $uibModalInstance) {
1399 $scope.today = new Date();
1401 // copy the print scope into the dialog scope
1402 angular.forEach(print_context, function(val, key) {
1406 $scope.ok = function() {$uibModalInstance.close()}
1408 $scope.print = function() {
1409 $uibModalInstance.close();
1418 // action == what action to take if the user confirms the alert
1419 service.copy_alert_dialog = function(evt, params, options, action) {
1420 if (angular.isArray(evt)) evt = evt[0];
1421 return egConfirmDialog.open(
1422 egCore.strings.COPY_ALERT_MSG_DIALOG_TITLE,
1423 evt.payload, // payload == alert message text
1424 { copy_barcode : params.copy_barcode,
1426 cancel : function() {}
1428 ).result.then(function() {
1429 options.override = true;
1430 return service[action](params, options);
1434 // check the barcode. If it's no good, show the warning dialog
1435 // Resolves on success, rejected on error
1436 service.test_barcode = function(bc) {
1438 var ok = service.check_barcode(bc);
1439 if (ok) return $q.when();
1441 return $uibModal.open({
1442 templateUrl: './circ/share/t_bad_barcode_dialog',
1444 ['$scope', '$uibModalInstance',
1445 function($scope, $uibModalInstance) {
1446 $scope.barcode = bc;
1447 $scope.ok = function() { $uibModalInstance.close() }
1448 $scope.cancel = function() { $uibModalInstance.dismiss() }
1453 // check() and checkdigit() copied directly
1454 // from chrome/content/util/barcode.js
1456 service.check_barcode = function(bc) {
1457 if (bc != Number(bc)) return false;
1459 // "16.00" == Number("16.00"), but the . is bad.
1460 // Throw out any barcode that isn't just digits
1461 if (bc.search(/\D/) != -1) return false;
1462 var last_digit = bc.substr(bc.length-1);
1463 var stripped_barcode = bc.substr(0,bc.length-1);
1464 return service.barcode_checkdigit(stripped_barcode).toString() == last_digit;
1467 service.barcode_checkdigit = function(bc) {
1468 var reverse_barcode = bc.toString().split('').reverse();
1469 var check_sum = 0; var multiplier = 2;
1470 for (var i = 0; i < reverse_barcode.length; i++) {
1471 var digit = reverse_barcode[i];
1472 var product = digit * multiplier; product = product.toString();
1474 for (var j = 0; j < product.length; j++) {
1475 temp_sum += Number( product[j] );
1477 check_sum += Number( temp_sum );
1478 multiplier = ( multiplier == 2 ? 1 : 2 );
1480 check_sum = check_sum.toString();
1481 var next_multiple_of_10 = (check_sum.match(/(\d*)\d$/)[1] * 10) + 10;
1482 var check_digit = next_multiple_of_10 - Number(check_sum);
1483 if (check_digit == 10) check_digit = 0;
1487 service.create_penalty = function(user_id) {
1488 return $uibModal.open({
1489 templateUrl: './circ/share/t_new_message_dialog',
1491 ['$scope','$uibModalInstance','staffPenalties',
1492 function($scope , $uibModalInstance , staffPenalties) {
1493 $scope.focusNote = true;
1494 $scope.penalties = staffPenalties;
1495 $scope.require_initials = service.require_initials;
1496 $scope.args = {penalty : 21}; // default to Note
1497 $scope.setPenalty = function(id) {
1500 $scope.ok = function(count) { $uibModalInstance.close($scope.args) }
1501 $scope.cancel = function($event) {
1502 $uibModalInstance.dismiss();
1503 $event.preventDefault();
1506 resolve : { staffPenalties : service.get_staff_penalty_types }
1509 var pen = new egCore.idl.ausp();
1511 pen.org_unit(egCore.auth.user().ws_ou());
1512 pen.note(args.note);
1513 if (args.initials) pen.note(args.note + ' [' + args.initials + ']');
1514 if (args.custom_penalty) {
1515 pen.standing_penalty(args.custom_penalty);
1517 pen.standing_penalty(args.penalty);
1519 pen.staff(egCore.auth.user().id());
1520 pen.set_date('now');
1521 return egCore.pcrud.create(pen);
1526 // assumes, for now anyway, penalty type is fleshed onto usr_penalty.
1527 service.edit_penalty = function(usr_penalty) {
1528 return $uibModal.open({
1529 templateUrl: './circ/share/t_new_message_dialog',
1531 ['$scope','$uibModalInstance','staffPenalties',
1532 function($scope , $uibModalInstance , staffPenalties) {
1533 $scope.focusNote = true;
1534 $scope.penalties = staffPenalties;
1535 $scope.require_initials = service.require_initials;
1537 penalty : usr_penalty.standing_penalty().id(),
1538 note : usr_penalty.note()
1540 $scope.setPenalty = function(id) { args.penalty = id; }
1541 $scope.ok = function(count) { $uibModalInstance.close($scope.args) }
1542 $scope.cancel = function($event) {
1543 $uibModalInstance.dismiss();
1544 $event.preventDefault();
1547 resolve : { staffPenalties : service.get_staff_penalty_types }
1550 usr_penalty.note(args.note);
1551 if (args.initials) usr_penalty.note(args.note + ' [' + args.initials + ']');
1552 usr_penalty.standing_penalty(args.penalty);
1553 return egCore.pcrud.update(usr_penalty);