LP#1789256 Monograph Part Column in Check Out
[Evergreen.git] / Open-ILS / web / js / ui / default / staff / circ / services / circ.js
1 /**
2  * Checkin, checkout, and renew
3  */
4
5 angular.module('egCoreMod')
6
7 .factory('egCirc',
8
9        ['$uibModal','$q','egCore','egAlertDialog','egConfirmDialog','egAddCopyAlertDialog','egCopyAlertManagerDialog','egCopyAlertEditorDialog',
10         'egWorkLog',
11 function($uibModal , $q , egCore , egAlertDialog , egConfirmDialog,  egAddCopyAlertDialog , egCopyAlertManagerDialog,  egCopyAlertEditorDialog ,
12          egWorkLog) {
13
14     var service = {
15         // auto-override these events after the first override
16         auto_override_checkout_events : {},
17         require_initials : false,
18         never_auto_print : {
19             hold_shelf_slip : false,
20             hold_transit_slip : false,
21             transit_slip : false
22         },
23         in_flight_checkins: {}
24     };
25
26     egCore.startup.go().finally(function() {
27         egCore.org.settings([
28             'ui.staff.require_initials.patron_standing_penalty',
29             'ui.admin.work_log.max_entries',
30             'ui.admin.patron_log.max_entries',
31             'circ.staff_client.do_not_auto_attempt_print',
32             'circ.clear_hold_on_checkout'
33         ]).then(function(set) {
34             service.require_initials = Boolean(set['ui.staff.require_initials.patron_standing_penalty']);
35             service.clearHold = Boolean(set['circ.clear_hold_on_checkout']);
36
37             if (angular.isArray(set['circ.staff_client.do_not_auto_attempt_print'])) {
38                 if (set['circ.staff_client.do_not_auto_attempt_print'].indexOf('Hold Slip') > 1)
39                     service.never_auto_print['hold_shelf_slip'] = true;
40                 if (set['circ.staff_client.do_not_auto_attempt_print'].indexOf('Hold/Transit Slip') > 1)
41                     service.never_auto_print['hold_transit_slip'] = true;
42                 if (set['circ.staff_client.do_not_auto_attempt_print'].indexOf('Transit Slip') > 1)
43                     service.never_auto_print['transit_slip'] = true;
44             }
45         });
46     });
47
48     service.reset = function() {
49         service.auto_override_checkout_events = {};
50     }
51
52     // these events can be overridden by staff during checkout
53     service.checkout_overridable_events = [
54         'PATRON_EXCEEDS_OVERDUE_COUNT',
55         'PATRON_EXCEEDS_CHECKOUT_COUNT',
56         'PATRON_EXCEEDS_FINES',
57         'PATRON_BARRED',
58         'CIRC_EXCEEDS_COPY_RANGE',
59         'ITEM_DEPOSIT_REQUIRED',
60         'ITEM_RENTAL_FEE_REQUIRED',
61         'PATRON_EXCEEDS_LOST_COUNT',
62         'COPY_CIRC_NOT_ALLOWED',
63         'COPY_NOT_AVAILABLE',
64         'COPY_IS_REFERENCE',
65         'COPY_ALERT_MESSAGE',
66         'ITEM_ON_HOLDS_SHELF',
67         'STAFF_C',
68         'STAFF_CH',
69         'STAFF_CHR',
70         'STAFF_CR',
71         'STAFF_H',
72         'STAFF_HR',
73         'STAFF_R'
74     ]
75
76     // after the first override of any of these events, 
77     // auto-override them in subsequent calls.
78     service.checkout_auto_override_after_first = [
79         'PATRON_EXCEEDS_OVERDUE_COUNT',
80         'PATRON_BARRED',
81         'PATRON_EXCEEDS_LOST_COUNT',
82         'PATRON_EXCEEDS_CHECKOUT_COUNT',
83         'PATRON_EXCEEDS_FINES'
84     ]
85
86
87     // overridable during renewal
88     service.renew_overridable_events = [
89         'PATRON_EXCEEDS_OVERDUE_COUNT',
90         'PATRON_EXCEEDS_LOST_COUNT',
91         'PATRON_EXCEEDS_CHECKOUT_COUNT',
92         'PATRON_EXCEEDS_FINES',
93         'CIRC_EXCEEDS_COPY_RANGE',
94         'ITEM_DEPOSIT_REQUIRED',
95         'ITEM_RENTAL_FEE_REQUIRED',
96         'ITEM_DEPOSIT_PAID',
97         'COPY_CIRC_NOT_ALLOWED',
98         'COPY_IS_REFERENCE',
99         'COPY_ALERT_MESSAGE',
100         'COPY_NEEDED_FOR_HOLD',
101         'MAX_RENEWALS_REACHED',
102         'CIRC_CLAIMS_RETURNED',
103         'STAFF_C',
104         'STAFF_CH',
105         'STAFF_CHR',
106         'STAFF_CR',
107         'STAFF_H',
108         'STAFF_HR',
109         'STAFF_R'
110     ];
111
112     // these checkin events do not produce alerts when 
113     // options.suppress_alerts is in effect.
114     service.checkin_suppress_overrides = [
115         'COPY_BAD_STATUS',
116         'PATRON_BARRED',
117         'PATRON_INACTIVE',
118         'PATRON_ACCOUNT_EXPIRED',
119         'ITEM_DEPOSIT_PAID',
120         'CIRC_CLAIMS_RETURNED',
121         'COPY_ALERT_MESSAGE',
122         'COPY_STATUS_LOST',
123         'COPY_STATUS_LOST_AND_PAID',
124         'COPY_STATUS_LONG_OVERDUE',
125         'COPY_STATUS_MISSING',
126         'PATRON_EXCEEDS_FINES'
127     ]
128
129     // these events can be overridden by staff during checkin
130     service.checkin_overridable_events = 
131         service.checkin_suppress_overrides.concat([
132         'HOLD_CAPTURE_DELAYED', // not technically overridable, but special prompt and param
133         'TRANSIT_CHECKIN_INTERVAL_BLOCK'
134     ])
135
136     // Performs a checkout.
137     // Returns a promise resolved with the original params and options
138     // and the final checkout event (e.g. in the case of override).
139     // Rejected if the checkout cannot be completed.
140     //
141     // params : passed directly as arguments to the server API 
142     // options : non-parameter controls.  e.g. "override", "check_barcode"
143     service.checkout = function(params, options) {
144         if (!options) options = {};
145         params.new_copy_alerts = 1;
146
147         console.debug('egCirc.checkout() : ' 
148             + js2JSON(params) + ' : ' + js2JSON(options));
149
150         // handle barcode completion
151         return service.handle_barcode_completion(params.copy_barcode)
152         .then(function(barcode) {
153             console.debug('barcode after completion: ' + barcode);
154             params.copy_barcode = barcode;
155
156             var promise = options.check_barcode ? 
157                 service.test_barcode(params.copy_barcode) : $q.when();
158
159             // avoid re-check on override, etc.
160             delete options.check_barcode;
161
162             return promise.then(function() {
163
164                 var method = 'open-ils.circ.checkout.full';
165                 if (options.override) method += '.override';
166
167                 return egCore.net.request(
168                     'open-ils.circ', method, egCore.auth.token(), params
169
170                 ).then(function(evt) {
171
172                     if (!angular.isArray(evt)) evt = [evt];
173
174                     if (evt[0].payload && evt[0].payload.auto_renew == 1) {
175                         // open circulation found with auto-renew toggle on.
176                         console.debug('Auto-renewing item ' + params.copy_barcode);
177                         options.auto_renew = true;
178                         return service.renew(params, options);
179                     }
180
181                     var action = params.noncat ? 'noncat_checkout' : 'checkout';
182
183                     return service.flesh_response_data(action, evt, params, options)
184                     .then(function() {
185                         return service.handle_checkout_resp(evt, params, options);
186                     })
187                     .then(function(final_resp) {
188                         return service.munge_resp_data(final_resp,action,method)
189                     })
190                 });
191             });
192         });
193     }
194
195     // Performs a renewal.
196     // Returns a promise resolved with the original params and options
197     // and the final checkout event (e.g. in the case of override)
198     // Rejected if the renewal cannot be completed.
199     service.renew = function(params, options) {
200         if (!options) options = {};
201         params.new_copy_alerts = 1;
202
203         console.debug('egCirc.renew() : ' 
204             + js2JSON(params) + ' : ' + js2JSON(options));
205
206         // handle barcode completion
207         return service.handle_barcode_completion(params.copy_barcode)
208         .then(function(barcode) {
209             params.copy_barcode = barcode;
210
211             var promise = options.check_barcode ? 
212                 service.test_barcode(params.copy_barcode) : $q.when();
213
214             // avoid re-check on override, etc.
215             delete options.check_barcode;
216
217             return promise.then(function() {
218
219                 var method = 'open-ils.circ.renew';
220                 if (options.override) method += '.override';
221
222                 return egCore.net.request(
223                     'open-ils.circ', method, egCore.auth.token(), params
224
225                 ).then(function(evt) {
226
227                     if (!angular.isArray(evt)) evt = [evt];
228
229                     return service.flesh_response_data(
230                         'renew', evt, params, options)
231                     .then(function() {
232                         return service.handle_renew_resp(evt, params, options);
233                     })
234                     .then(function(final_resp) {
235                         final_resp.auto_renew = options.auto_renew;
236                         return service.munge_resp_data(final_resp,'renew',method)
237                     })
238                 });
239             });
240         });
241     }
242
243     // Performs a checkin
244     // Returns a promise resolved with the original params and options,
245     // plus the final checkin event (e.g. in the case of override).
246     // Rejected if the checkin cannot be completed.
247     service.checkin = function(params, options) {
248         if (!options) options = {};
249         params.new_copy_alerts = 1;
250
251         console.debug('egCirc.checkin() : ' 
252             + js2JSON(params) + ' : ' + js2JSON(options));
253
254         // handle barcode completion
255         return service.handle_barcode_completion(params.copy_barcode)
256         .then(function(barcode) {
257             params.copy_barcode = barcode;
258
259             var promise = options.check_barcode ? 
260                 service.test_barcode(params.copy_barcode) : $q.when();
261
262             // avoid re-check on override, etc.
263             delete options.check_barcode;
264
265             return promise.then(function() {
266
267                 var method = 'open-ils.circ.checkin';
268                 if (options.override) method += '.override';
269
270                 // Multiple checkin API calls should never be active
271                 // for a single barcode.
272                 if (service.in_flight_checkins[barcode]) {
273                     console.error('Barcode ' + barcode 
274                         + ' is already in flight for checkin, skipping');
275                     return $q.reject();
276                 }
277                 service.in_flight_checkins[barcode] = true;
278
279                 return egCore.net.request(
280                     'open-ils.circ', method, egCore.auth.token(), params
281
282                 ).then(function(evt) {
283                     delete service.in_flight_checkins[barcode];
284
285                     if (!angular.isArray(evt)) evt = [evt];
286                     return service.flesh_response_data(
287                         'checkin', evt, params, options)
288                     .then(function() {
289                         return service.handle_checkin_resp(evt, params, options);
290                     })
291                     .then(function(final_resp) {
292                         return service.munge_resp_data(final_resp,'checkin',method)
293                     })
294                 }, function() {delete service.in_flight_checkins[barcode]});
295             });
296         });
297     }
298
299     // provide consistent formatting of the final response data
300     service.munge_resp_data = function(final_resp,worklog_action,worklog_method) {
301         var data = final_resp.data = {};
302
303         if (!final_resp.evt[0]) {
304             egCore.audio.play('error.unknown.no_event');
305             return;
306         }
307
308         var payload = final_resp.evt[0].payload;
309         if (!payload) {
310             egCore.audio.play('error.unknown.no_payload');
311             return;
312         }
313
314         // retrieve call number affixes prior to sending payload data to the grid
315         if (payload.volume && typeof payload.volume.prefix() != 'object') {
316             egCore.pcrud.retrieve('acnp',payload.volume.prefix()).then(function(p) {payload.volume.prefix(p)});
317         };
318         if (payload.volume && typeof payload.volume.suffix() != 'object') {
319             egCore.pcrud.retrieve('acns',payload.volume.suffix()).then(function(s) {payload.volume.suffix(s)});
320         };
321
322         data.circ = payload.circ;
323         data.parent_circ = payload.parent_circ;
324         data.hold = payload.hold;
325         data.record = payload.record;
326         data.acp = payload.copy;
327         data.acn = payload.volume ?  payload.volume : payload.copy ? payload.copy.call_number() : null;
328         data.alci = egCore.idl.toHash(payload.latest_inventory, true);
329         data.au = payload.patron;
330         data.transit = payload.transit;
331         data.status = payload.status;
332         data.message = payload.message;
333         data.title = final_resp.evt[0].title;
334         data.author = final_resp.evt[0].author;
335         data.isbn = final_resp.evt[0].isbn;
336         data.route_to = final_resp.evt[0].route_to;
337
338
339         if (payload.circ) data.duration = payload.circ.duration();
340         if (payload.circ) data.circ_lib = payload.circ.circ_lib();
341         if (payload.do_inventory_update) {
342             if (payload.latest_inventory.id()) {
343                 egCore.pcrud.update(payload.latest_inventory);
344             } else {
345                 egCore.pcrud.create(payload.latest_inventory);
346             }
347         }
348
349         // for checkin, the mbts lives on the main circ
350         if (payload.circ && payload.circ.billable_transaction())
351             data.mbts = payload.circ.billable_transaction().summary();
352
353         // on renewals, the mbts lives on the parent circ
354         if (payload.parent_circ && payload.parent_circ.billable_transaction())
355             data.mbts = payload.parent_circ.billable_transaction().summary();
356
357         if (!data.route_to) {
358             if (data.transit) {
359                 data.route_to = data.transit.dest().shortname();
360             } else if (data.acp) {
361                 data.route_to = data.acp.location().name();
362             }
363         }
364         // allow us to get at the monograph parts associated with a copy
365         if (payload.copy && payload.copy.parts()) {
366             data._monograph_part = payload.copy.parts().map(function(part) {
367                 return part.label();
368             }).join(',');
369         }
370
371         egWorkLog.record(
372             (worklog_action == 'checkout' || worklog_action == 'noncat_checkout')
373             ? egCore.strings.EG_WORK_LOG_CHECKOUT
374             : (worklog_action == 'renew'
375                 ? egCore.strings.EG_WORK_LOG_RENEW
376                 : egCore.strings.EG_WORK_LOG_CHECKIN // worklog_action == 'checkin'
377             ),{
378                 'action' : worklog_action,
379                 'method' : worklog_method,
380                 'response' : final_resp
381             }
382         );
383
384         return final_resp;
385     }
386
387     service.handle_overridable_checkout_event = function(evt, params, options) {
388
389         if (options.override) {
390             // override attempt already made and failed.
391             // NOTE: I don't think we'll ever get here, since the
392             // override attempt should produce a perm failure...
393             angular.forEach(evt, function(e){ console.debug('override failed: ' + e.textcode); });
394             return $q.reject();
395
396         } 
397
398         if (evt.filter(function(e){return !service.auto_override_checkout_events[e.textcode];}).length == 0) {
399             // user has already opted to override these type
400             // of events.  Re-run the checkout w/ override.
401             options.override = true;
402             return service.checkout(params, options);
403         } 
404
405         // Ask the user if they would like to override this event.
406         // Some events offer a stock override dialog, while others
407         // require additional context.
408
409         switch(evt[0].textcode) {
410             case 'COPY_NOT_AVAILABLE':
411                 return service.copy_not_avail_dialog(evt, params, options);
412             case 'COPY_ALERT_MESSAGE':
413                 return service.copy_alert_dialog(evt[0], params, options, 'checkout');
414             default: 
415                 return service.override_dialog(evt, params, options, 'checkout');
416         }
417     }
418
419     service.handle_overridable_renew_event = function(evt, params, options) {
420
421         if (options.override) {
422             // override attempt already made and failed.
423             // NOTE: I don't think we'll ever get here, since the
424             // override attempt should produce a perm failure...
425             angular.forEach(evt, function(e){ console.debug('override failed: ' + e.textcode); });
426             return $q.reject();
427
428         } 
429
430         // renewal auto-overrides are the same as checkout
431         if (evt.filter(function(e){return !service.auto_override_checkout_events[e.textcode];}).length == 0) {
432             // user has already opted to override these type
433             // of events.  Re-run the renew w/ override.
434             options.override = true;
435             return service.renew(params, options);
436         } 
437
438         // Ask the user if they would like to override this event.
439         // Some events offer a stock override dialog, while others
440         // require additional context.
441
442         switch(evt[0].textcode) {
443             case 'COPY_ALERT_MESSAGE':
444                 return service.copy_alert_dialog(evt[0], params, options, 'renew');
445             default: 
446                 return service.override_dialog(evt, params, options, 'renew');
447         }
448     }
449
450
451     service.handle_overridable_checkin_event = function(evt, params, options) {
452
453         if (options.override) {
454             // override attempt already made and failed.
455             // NOTE: I don't think we'll ever get here, since the
456             // override attempt should produce a perm failure...
457             angular.forEach(evt, function(e){ console.debug('override failed: ' + e.textcode); });
458             return $q.reject();
459
460         } 
461
462         if (options.suppress_checkin_popups
463             && evt.filter(function(e){return service.checkin_suppress_overrides.indexOf(e.textcode) == -1;}).length == 0) {
464             // Events are suppressed.  Re-run the checkin w/ override.
465             options.override = true;
466             return service.checkin(params, options);
467         } 
468
469         // Ask the user if they would like to override this event.
470         // Some events offer a stock override dialog, while others
471         // require additional context.
472
473         switch(evt[0].textcode) {
474             case 'COPY_ALERT_MESSAGE':
475                 return service.copy_alert_dialog(evt[0], params, options, 'checkin');
476             case 'HOLD_CAPTURE_DELAYED':
477                 return service.hold_capture_delay_dialog(evt[0], params, options, 'checkin');
478             default: 
479                 return service.override_dialog(evt, params, options, 'checkin');
480         }
481     }
482
483
484     service.handle_renew_resp = function(evt, params, options) {
485
486         var final_resp = {evt : evt, params : params, options : options};
487
488         // track the barcode regardless of whether it refers to a copy
489         angular.forEach(evt, function(e){ e.copy_barcode = params.copy_barcode; });
490
491         // Overridable Events
492         if (evt.filter(function(e){return service.renew_overridable_events.indexOf(e.textcode) > -1;}).length > 0)
493             return service.handle_overridable_renew_event(evt, params, options);
494
495         // Other events
496         switch (evt[0].textcode) {
497             case 'SUCCESS':
498                 egCore.audio.play('info.renew');
499                 return $q.when(final_resp);
500
501             case 'COPY_IN_TRANSIT':
502             case 'PATRON_CARD_INACTIVE':
503             case 'PATRON_INACTIVE':
504             case 'PATRON_ACCOUNT_EXPIRED':
505             case 'CIRC_CLAIMS_RETURNED':
506                 egCore.audio.play('warning.renew');
507                 return service.exit_alert(
508                     egCore.strings[evt[0].textcode],
509                     {barcode : params.copy_barcode}
510                 );
511
512             default:
513                 egCore.audio.play('warning.renew.unknown');
514                 return service.exit_alert(
515                     egCore.strings.CHECKOUT_FAILED_GENERIC, {
516                         barcode : params.copy_barcode,
517                         textcode : evt[0].textcode,
518                         desc : evt[0].desc
519                     }
520                 );
521         }
522     }
523
524
525     service.handle_checkout_resp = function(evt, params, options) {
526
527         var final_resp = {evt : evt, params : params, options : options};
528
529         // track the barcode regardless of whether it refers to a copy
530         angular.forEach(evt, function(e){ e.copy_barcode = params.copy_barcode; });
531
532         // Overridable Events
533         if (evt.filter(function(e){return service.checkout_overridable_events.indexOf(e.textcode) > -1;}).length > 0)
534             return service.handle_overridable_checkout_event(evt, params, options);
535
536         // Other events
537         switch (evt[0].textcode) {
538             case 'SUCCESS':
539                 egCore.audio.play('success.checkout');
540                 return $q.when(final_resp);
541
542             case 'ITEM_NOT_CATALOGED':
543                 egCore.audio.play('error.checkout.no_cataloged');
544                 return service.precat_dialog(params, options);
545
546             case 'OPEN_CIRCULATION_EXISTS':
547                 // auto_renew checked in service.checkout()
548                 egCore.audio.play('error.checkout.open_circ');
549                 return service.circ_exists_dialog(evt, params, options);
550
551             case 'COPY_IN_TRANSIT':
552                 egCore.audio.play('warning.checkout.in_transit');
553                 return service.copy_in_transit_dialog(evt, params, options);
554
555             case 'PATRON_CARD_INACTIVE':
556             case 'PATRON_INACTIVE':
557             case 'PATRON_ACCOUNT_EXPIRED':
558             case 'CIRC_CLAIMS_RETURNED':
559                 egCore.audio.play('warning.checkout');
560                 return service.exit_alert(
561                     egCore.strings[evt[0].textcode],
562                     {barcode : params.copy_barcode}
563                 );
564
565             default:
566                 egCore.audio.play('error.checkout.unknown');
567                 return service.exit_alert(
568                     egCore.strings.CHECKOUT_FAILED_GENERIC, {
569                         barcode : params.copy_barcode,
570                         textcode : evt[0].textcode,
571                         desc : evt[0].desc
572                     }
573                 );
574         }
575     }
576
577     // returns a promise resolved with the list of circ mods
578     service.get_circ_mods = function() {
579         if (egCore.env.ccm) 
580             return $q.when(egCore.env.ccm.list);
581
582         return egCore.pcrud.retrieveAll('ccm', null, {atomic : true})
583         .then(function(list) { 
584             egCore.env.absorbList(list, 'ccm');
585             return list;
586         });
587     };
588
589     // returns a promise resolved with the list of noncat types
590     service.get_noncat_types = function() {
591         if (egCore.env.cnct) 
592             return $q.when(egCore.env.cnct.list);
593
594         return egCore.pcrud.search('cnct', 
595             {owning_lib : 
596                 egCore.org.fullPath(egCore.auth.user().ws_ou(), true)}, 
597             null, {atomic : true}
598         ).then(function(list) { 
599             egCore.env.absorbList(list, 'cnct');
600             return list;
601         });
602     }
603
604     service.get_staff_penalty_types = function() {
605         if (egCore.env.csp) 
606             return $q.when(egCore.env.csp.list);
607         return egCore.pcrud.search(
608             // id <= 100 are reserved for system use
609             'csp', {id : {'>': 100}}, {}, {atomic : true})
610         .then(function(penalties) {
611             return egCore.env.absorbList(penalties, 'csp').list;
612         });
613     }
614
615     // ideally all of these data should be returned with the response,
616     // but until then, grab what we need.
617     service.flesh_response_data = function(action, evt, params, options) {
618         var promises = [];
619         var payload;
620         if (!evt[0] || !(payload = evt[0].payload)) return $q.when();
621         
622         promises.push(service.flesh_copy_location(payload.copy));
623         if (payload.copy) {
624             promises.push(service.flesh_acn_owning_lib(payload.volume));
625             promises.push(service.flesh_copy_circ_library(payload.copy));
626             promises.push(service.flesh_copy_circ_modifier(payload.copy));
627             promises.push(
628                 service.flesh_copy_status(payload.copy)
629
630                 .then(function() {
631                     // copy is in transit, but no transit was delivered
632                     // in the payload.  Do this here instead of below to
633                     // ensure consistent copy status fleshiness
634                     if (!payload.transit && payload.copy.status().id() == 6) { // in-transit
635                         return service.find_copy_transit(evt, params, options)
636                         .then(function(trans) {
637                             if (trans) {
638                                 trans.source(egCore.org.get(trans.source()));
639                                 trans.dest(egCore.org.get(trans.dest()));
640                                 payload.transit = trans;
641                             }
642                         })
643                     }
644                 })
645             );
646         }
647
648         // local flesh transit
649         if (transit = payload.transit) {
650             transit.source(egCore.org.get(transit.source()));
651             transit.dest(egCore.org.get(transit.dest()));
652         } 
653
654         // TODO: renewal responses should include the patron
655         if (!payload.patron) {
656             var user_id;
657             if (payload.circ) user_id = payload.circ.usr();
658             if (payload.noncat_circ) user_id = payload.noncat_circ.patron();
659             if (user_id) {
660                 promises.push(
661                     egCore.pcrud.retrieve('au', user_id)
662                     .then(function(user) {payload.patron = user})
663                 );
664             }
665         }
666
667         // extract precat values
668         angular.forEach(evt, function(e){ e.title = payload.record ? payload.record.title() : 
669             (payload.copy ? payload.copy.dummy_title() : null);});
670
671         angular.forEach(evt, function(e){ e.author = payload.record ? payload.record.author() : 
672             (payload.copy ? payload.copy.dummy_author() : null);});
673
674         angular.forEach(evt, function(e){ e.isbn = payload.record ? payload.record.isbn() : 
675             (payload.copy ? payload.copy.dummy_isbn() : null);});
676
677         return $q.all(promises);
678     }
679
680     service.flesh_acn_owning_lib = function(acn) {
681         if (!acn) return $q.when();
682         return $q.when(acn.owning_lib(egCore.org.get( acn.owning_lib() )));
683     }
684
685     service.flesh_copy_circ_library = function(copy) {
686         if (!copy) return $q.when();
687         
688         return $q.when(copy.circ_lib(egCore.org.get( copy.circ_lib() )));
689     }
690
691     // fetches the full list of circ modifiers
692     service.flesh_copy_circ_modifier = function(copy) {
693         if (!copy) return $q.when();
694         if (egCore.env.ccm)
695             return $q.when(copy.circ_modifier(egCore.env.ccm.map[copy.circ_modifier()]));
696         return egCore.pcrud.retrieveAll('ccm', {}, {atomic : true}).then(
697             function(list) {
698                 egCore.env.absorbList(list, 'ccm');
699                 copy.circ_modifier(egCore.env.ccm.map[copy.circ_modifier()]);
700             }
701         );
702     }
703
704     // fetches the full list of copy statuses
705     service.flesh_copy_status = function(copy) {
706         if (!copy) return $q.when();
707         if (egCore.env.ccs) 
708             return $q.when(copy.status(egCore.env.ccs.map[copy.status()]));
709         return egCore.pcrud.retrieveAll('ccs', {}, {atomic : true}).then(
710             function(list) {
711                 egCore.env.absorbList(list, 'ccs');
712                 copy.status(egCore.env.ccs.map[copy.status()]);
713             }
714         );
715     }
716
717     // there may be *many* copy locations and we may be handling items
718     // for other locations.  Fetch copy locations as-needed and cache.
719     service.flesh_copy_location = function(copy) {
720         if (!copy) return $q.when();
721         if (angular.isObject(copy.location())) return $q.when(copy);
722         if (egCore.env.acpl) {
723             if (egCore.env.acpl.map[copy.location()]) {
724                 copy.location(egCore.env.acpl.map[copy.location()]);
725                 return $q.when(copy);
726             }
727         } 
728         return egCore.pcrud.retrieve('acpl', copy.location())
729         .then(function(loc) {
730             egCore.env.absorbList([loc], 'acpl'); // append to cache
731             copy.location(loc);
732             return copy;
733         });
734     }
735
736
737     // fetch org unit addresses as needed.
738     service.get_org_addr = function(org_id, addr_type) {
739         var org = egCore.org.get(org_id);
740         var addr_id = org[addr_type]();
741
742         if (!addr_id) return $q.when(null);
743
744         if (egCore.env.aoa && egCore.env.aoa.map[addr_id]) 
745             return $q.when(egCore.env.aoa.map[addr_id]); 
746
747         return egCore.pcrud.retrieve('aoa', addr_id).then(function(addr) {
748             egCore.env.absorbList([addr], 'aoa');
749             return egCore.env.aoa.map[addr_id]; 
750         });
751     }
752
753     service.exit_alert = function(msg, scope) {
754         return egAlertDialog.open(msg, scope).result.then(
755             function() {return $q.reject()});
756     }
757
758     // opens a dialog asking the user if they would like to override
759     // the returned event.
760     service.override_dialog = function(evt, params, options, action) {
761         if (!angular.isArray(evt)) evt = [evt];
762
763         egCore.audio.play('warning.circ.event_override');
764         var copy_alert = evt.filter(function(e) {
765             return e.textcode == 'COPY_ALERT_MESSAGE';
766         });
767         evt = evt.filter(function(e) {
768             return e.textcode !== 'COPY_ALERT_MESSAGE';
769         });
770
771         return $uibModal.open({
772             templateUrl: './circ/share/t_event_override_dialog',
773             backdrop: 'static',
774             controller: 
775                 ['$scope', '$uibModalInstance', 
776                 function($scope, $uibModalInstance) {
777                 $scope.events = evt;
778
779                 // Find the event, if any, that is for ITEM_ON_HOLDS_SHELF
780                 //  and grab the patron name of the owner. 
781                 $scope.holdEvent = evt.filter(function(e) {
782                     return e.textcode === 'ITEM_ON_HOLDS_SHELF'
783                 });
784
785                 if ($scope.holdEvent.length > 0) {
786                     // Ensure we have a scalar here
787                     if (angular.isArray($scope.holdEvent)) {
788                         $scope.holdEvent = $scope.holdEvent[0];
789                     }
790
791                     $scope.patronName = $scope.holdEvent.payload.patron_name;
792                     $scope.holdID = $scope.holdEvent.payload.hold_id;
793                     $scope.patronID = $scope.holdEvent.payload.patron_id;
794                 }
795
796                 $scope.auto_override =
797                     evt.filter(function(e){
798                         return service.checkout_auto_override_after_first.indexOf(evt.textcode) > -1;
799                     }).length > 0;
800                 $scope.copy_barcode = params.copy_barcode; // may be null
801
802                 // Implementation note: Why not use a primitive here? It
803                 // doesn't work.  See: 
804                 // http://stackoverflow.com/questions/18642371/checkbox-not-binding-to-scope-in-angularjs
805                 $scope.formdata = {clearHold : service.clearHold};
806
807                 $scope.ok = function() { 
808                     // Handle the cancellation of the assciated hold here
809                     if ($scope.formdata.clearHold && $scope.holdID) {
810                         egCore.net.request(
811                             'open-ils.circ',
812                             'open-ils.circ.hold.cancel',
813                             egCore.auth.token(), $scope.holdID,
814                             5, // staff forced
815                             'Item checked out by other patron' // FIXME I18n
816                         );
817                     }
818                     $uibModalInstance.close();
819                 }
820
821                 $scope.cancel = function ($event) { 
822                     $uibModalInstance.dismiss();
823                     $event.preventDefault();
824                 }
825             }]
826         }).result.then(
827             function() {
828                 options.override = true;
829
830                 if (copy_alert.length > 0) {
831                     return service.copy_alert_dialog(copy_alert, params, options, action);
832                 }
833
834                 if (action == 'checkin') {
835                     return service.checkin(params, options);
836                 }
837
838                 // checkout/renew support override-after-first
839                 angular.forEach(evt, function(e){
840                     if (service.checkout_auto_override_after_first.indexOf(e.textcode) > -1)
841                         service.auto_override_checkout_events[e.textcode] = true;
842                 });
843
844                 return service[action](params, options);
845             }
846         );
847     }
848
849     service.copy_not_avail_dialog = function(evt, params, options) {
850         if (!angular.isArray(evt)) evt = [evt];
851
852         var copy_alert = evt.filter(function(e) {
853             return e.textcode == 'COPY_ALERT_MESSAGE';
854         });
855         evt = evt.filter(function(e) {
856             return e.textcode !== 'COPY_ALERT_MESSAGE';
857         });
858         evt = evt[0];
859
860         return $uibModal.open({
861             templateUrl: './circ/share/t_copy_not_avail_dialog',
862             backdrop: 'static',
863             controller: 
864                        ['$scope','$uibModalInstance','copyStatus',
865                 function($scope , $uibModalInstance , copyStatus) {
866                 $scope.copyStatus = copyStatus;
867                 $scope.ok = function() {$uibModalInstance.close()}
868                 $scope.cancel = function() {$uibModalInstance.dismiss()}
869             }],
870             resolve : {
871                 copyStatus : function() {
872                     return egCore.pcrud.retrieve(
873                         'ccs', evt.payload.status());
874                 }
875             }
876         }).result.then(
877             function() {
878                 options.override = true;
879
880                 if (copy_alert.length > 0) {
881                     return service.copy_alert_dialog(copy_alert, params, options, 'checkout');
882                 }
883
884                 return service.checkout(params, options);
885             }
886         );
887     }
888
889     // Opens a dialog allowing the user to fill in the desired non-cat count.
890     // Unlike other dialogs, which kickoff circ actions internally
891     // as a result of events, this dialog does not kick off any circ
892     // actions. It just collects the count and and resolves the promise.
893     //
894     // This assumes the caller has already handled the noncat-type
895     // selection and just needs to collect the count info.
896     service.noncat_dialog = function(params, options) {
897         var noncatMax = 99; // hard-coded max
898         
899         // the caller should presumably have fetched the noncat_types via
900         // our API already, but fetch them again (from cache) to be safe.
901         return service.get_noncat_types().then(function() {
902
903             params.noncat = true;
904             var type = egCore.env.cnct.map[params.noncat_type];
905
906             return $uibModal.open({
907                 templateUrl: './circ/share/t_noncat_dialog',
908                 backdrop: 'static',
909                 controller: 
910                     ['$scope', '$uibModalInstance',
911                     function($scope, $uibModalInstance) {
912                     $scope.focusMe = true;
913                     $scope.type = type;
914                     $scope.count = 1;
915                     $scope.noncatMax = noncatMax;
916                     $scope.ok = function(count) { $uibModalInstance.close(count) }
917                     $scope.cancel = function ($event) { 
918                         $uibModalInstance.dismiss() 
919                         $event.preventDefault();
920                     }
921                 }],
922             }).result.then(
923                 function(count) {
924                     if (count && count > 0 && count <= noncatMax) { 
925                         // NOTE: in Chrome, form validation ensure a valid number
926                         params.noncat_count = count;
927                         return $q.when(params);
928                     } else {
929                         return $q.reject();
930                     }
931                 }
932             );
933         });
934     }
935
936     // Opens a dialog allowing the user to fill in pre-cat copy info.
937     service.precat_dialog = function(params, options) {
938
939         return $uibModal.open({
940             templateUrl: './circ/share/t_precat_dialog',
941             backdrop: 'static',
942             controller: 
943                 ['$scope', '$uibModalInstance', 'circMods',
944                 function($scope, $uibModalInstance, circMods) {
945                 $scope.focusMe = true;
946                 $scope.precatArgs = {
947                     copy_barcode : params.copy_barcode
948                 };
949                 $scope.circModifiers = circMods;
950                 $scope.ok = function(args) { $uibModalInstance.close(args) }
951                 $scope.cancel = function () { $uibModalInstance.dismiss() }
952
953                 // use this function as a keydown handler on form
954                 // elements that should not submit the form on enter.
955                 $scope.preventSubmit = function($event) {
956                     if ($event.keyCode == 13)
957                         $event.preventDefault();
958                 }
959             }],
960             resolve : {
961                 circMods : function() { 
962                     return service.get_circ_mods();
963                 }
964             }
965         }).result.then(
966             function(args) {
967                 if (!args || !args.dummy_title) return $q.reject();
968                 if(args.circ_modifier == "") args.circ_modifier = null;
969                 angular.forEach(args, function(val, key) {params[key] = val});
970                 params.precat = true;
971                 return service.checkout(params, options);
972             }
973         );
974     }
975
976     // find the open transit for the given copy barcode; flesh the org
977     // units locally.
978     service.find_copy_transit = function(evt, params, options) {
979         if (angular.isArray(evt)) evt = evt[0];
980
981         // NOTE: evt.payload.transit may exist, but it's not necessarily
982         // the transit we want, since a transit close + open in the API
983         // returns the closed transit.
984
985          return egCore.pcrud.search('atc',
986             {   dest_recv_time : null, cancel_time : null},
987             {   flesh : 1, 
988                 flesh_fields : {atc : ['target_copy']},
989                 join : {
990                     acp : {
991                         filter : {
992                             barcode : params.copy_barcode,
993                             deleted : 'f'
994                         }
995                     }
996                 },
997                 limit : 1,
998                 order_by : {atc : 'source_send_time desc'}, 
999             }, {authoritative : true}
1000         ).then(function(transit) {
1001             transit.source(egCore.org.get(transit.source()));
1002             transit.dest(egCore.org.get(transit.dest()));
1003             return transit;
1004         });
1005     }
1006
1007     service.copy_in_transit_dialog = function(evt, params, options) {
1008         if (angular.isArray(evt)) evt = evt[0];
1009         return $uibModal.open({
1010             templateUrl: './circ/share/t_copy_in_transit_dialog',
1011             backdrop: 'static',
1012             controller: 
1013                        ['$scope','$uibModalInstance','transit',
1014                 function($scope , $uibModalInstance , transit) {
1015                 $scope.transit = transit;
1016                 $scope.ok = function() { $uibModalInstance.close(transit) }
1017                 $scope.cancel = function() { $uibModalInstance.dismiss() }
1018             }],
1019             resolve : {
1020                 // fetch the conflicting open transit w/ fleshed copy
1021                 transit : function() {
1022                     return service.find_copy_transit(evt, params, options);
1023                 }
1024             }
1025         }).result.then(
1026             function(transit) {
1027                 // user chose to abort the transit then checkout
1028                 return service.abort_transit(transit.id())
1029                 .then(function() {
1030                     return service.checkout(params, options);
1031                 });
1032             }
1033         );
1034     }
1035
1036     service.abort_transit = function(transit_id) {
1037         return egCore.net.request(
1038             'open-ils.circ',
1039             'open-ils.circ.transit.abort',
1040             egCore.auth.token(), {transitid : transit_id}
1041         ).then(function(resp) {
1042             if (evt = egCore.evt.parse(resp)) {
1043                 alert(evt);
1044                 return $q.reject();
1045             }
1046             return $q.when();
1047         });
1048     }
1049
1050     service.last_copy_circ = function(copy_id) {
1051         return egCore.pcrud.search('circ', 
1052             {target_copy : copy_id},
1053             {order_by : {circ : 'xact_start desc' }, limit : 1}
1054         );
1055     }
1056
1057     service.circ_exists_dialog = function(evt, params, options) {
1058         if (angular.isArray(evt)) evt = evt[0];
1059
1060         if (!evt.payload.old_circ) {
1061             return egCore.net.request(
1062                 'open-ils.search',
1063                 'open-ils.search.asset.copy.fleshed2.find_by_barcode',
1064                 params.copy_barcode
1065             ).then(function(resp){
1066                 console.log(resp);
1067                 if (egCore.evt.parse(resp)) {
1068                     console.error(egCore.evt.parse(resp));
1069                 } else {
1070                     return egCore.net.request(
1071                          'open-ils.circ',
1072                          'open-ils.circ.copy_checkout_history.retrieve',
1073                          egCore.auth.token(), resp.id(), 1
1074                     ).then( function (circs) {
1075                         evt.payload.old_circ = circs[0];
1076                         return service.circ_exists_dialog_impl( evt, params, options );
1077                     });
1078                 }
1079             });
1080         } else {
1081             return service.circ_exists_dialog_impl( evt, params, options );
1082         }
1083     },
1084
1085     service.circ_exists_dialog_impl = function (evt, params, options) {
1086
1087         var openCirc = evt.payload.old_circ;
1088         var sameUser = openCirc.usr() == params.patron_id;
1089         
1090         return $uibModal.open({
1091             templateUrl: './circ/share/t_circ_exists_dialog',
1092             backdrop: 'static',
1093             controller: 
1094                        ['$scope','$uibModalInstance',
1095                 function($scope , $uibModalInstance) {
1096                 $scope.args = {forgive_fines : false};
1097                 $scope.circDate = openCirc.xact_start();
1098                 $scope.sameUser = sameUser;
1099                 $scope.ok = function() { $uibModalInstance.close($scope.args) }
1100                 $scope.cancel = function($event) { 
1101                     $uibModalInstance.dismiss();
1102                     $event.preventDefault(); // form, avoid calling ok();
1103                 }
1104             }]
1105         }).result.then(
1106             function(args) {
1107                 if (sameUser) {
1108                     params.void_overdues = args.forgive_fines;
1109                     return service.renew(params, options);
1110                 }
1111
1112                 return service.checkin({
1113                     barcode : params.copy_barcode,
1114                     noop : true,
1115                     void_overdues : args.forgive_fines
1116                 }).then(function(checkin_resp) {
1117                     if (checkin_resp.evt[0].textcode == 'SUCCESS') {
1118                         return service.checkout(params, options);
1119                     } else {
1120                         alert(egCore.evt.parse(checkin_resp.evt[0]));
1121                         return $q.reject();
1122                     }
1123                 });
1124             }
1125         );
1126     }
1127
1128     service.batch_backdate = function(circ_ids, backdate) {
1129         return egCore.net.request(
1130             'open-ils.circ',
1131             'open-ils.circ.post_checkin_backdate.batch',
1132             egCore.auth.token(), circ_ids, backdate);
1133     }
1134
1135     service.backdate_dialog = function(circ_ids) {
1136         return $uibModal.open({
1137             templateUrl: './circ/share/t_backdate_dialog',
1138             backdrop: 'static',
1139             controller: 
1140                        ['$scope','$uibModalInstance',
1141                 function($scope , $uibModalInstance) {
1142
1143                 var today = new Date();
1144                 $scope.dialog = {
1145                     num_circs : circ_ids.length,
1146                     num_processed : 0,
1147                     backdate : today
1148                 }
1149
1150                 $scope.$watch('dialog.backdate', function(newval) {
1151                     if (newval && newval > today) 
1152                         $scope.dialog.backdate = today;
1153                 });
1154
1155
1156                 $scope.cancel = function() { 
1157                     $uibModalInstance.dismiss();
1158                 }
1159
1160                 $scope.ok = function() { 
1161
1162                     var bd = $scope.dialog.backdate.toISOString().replace(/T.*/,'');
1163                     service.batch_backdate(circ_ids, bd)
1164                     .then(
1165                         function() { // on complete
1166                             $uibModalInstance.close({backdate : bd});
1167                         },
1168                         null,
1169                         function(resp) { // on response
1170                             console.debug('backdate returned ' + resp);
1171                             if (resp == '1') {
1172                                 $scope.num_processed++;
1173                             } else {
1174                                 console.error(egCore.evt.parse(resp));
1175                             }
1176                         }
1177                     );
1178                 }
1179             }]
1180         }).result;
1181     }
1182
1183     service.mark_claims_returned = function(barcode, date, override) {
1184
1185         var method = 'open-ils.circ.circulation.set_claims_returned';
1186         if (override) method += '.override';
1187
1188         console.debug('claims returned ' + method);
1189
1190         return egCore.net.request(
1191             'open-ils.circ', method, egCore.auth.token(),
1192             {barcode : barcode, backdate : date})
1193
1194         .then(function(resp) {
1195
1196             if (resp == 1) { // success
1197                 console.debug('claims returned succeeded for ' + barcode);
1198                 return barcode;
1199
1200             } else if (evt = egCore.evt.parse(resp)) {
1201                 console.debug('claims returned failed: ' + evt.toString());
1202
1203                 if (evt.textcode == 'PATRON_EXCEEDS_CLAIMS_RETURN_COUNT') {
1204                     // TODO check perms before offering override option?
1205
1206                     if (override) return;// just to be safe
1207
1208                     return egConfirmDialog.open(
1209                         egCore.strings.TOO_MANY_CLAIMS_RETURNED, '', {}
1210                     ).result.then(function() {
1211                         return service.mark_claims_returned(barcode, date, true);
1212                     });
1213                 }
1214
1215                 if (evt.textcode == 'PERM_FAILURE') {
1216                     console.error('claims returned permission denied')
1217                     // TODO: auth override dialog?
1218                 }
1219             }
1220         });
1221     }
1222
1223     service.mark_claims_returned_dialog = function(copy_barcodes) {
1224         if (!copy_barcodes.length) return;
1225
1226         return $uibModal.open({
1227             templateUrl: './circ/share/t_mark_claims_returned_dialog',
1228             backdrop: 'static',
1229             controller: 
1230                        ['$scope','$uibModalInstance',
1231                 function($scope , $uibModalInstance) {
1232
1233                 var today = new Date();
1234                 $scope.args = {
1235                     barcodes : copy_barcodes,
1236                     date : today
1237                 };
1238
1239                 $scope.$watch('args.date', function(newval) {
1240                     if (newval && newval > today) 
1241                         $scope.args.backdate = today;
1242                 });
1243
1244                 $scope.cancel = function() {$uibModalInstance.dismiss()}
1245                 $scope.ok = function() { 
1246
1247                     var date = $scope.args.date.toISOString().replace(/T.*/,'');
1248
1249                     var deferred = $q.defer();
1250
1251                     // serialize the action on each barcode so that the 
1252                     // caller will never see multiple alerts at the same time.
1253                     function mark_one() {
1254                         var bc = copy_barcodes.pop();
1255                         if (!bc) {
1256                             deferred.resolve();
1257                             $uibModalInstance.close();
1258                             return;
1259                         }
1260
1261                         // finally -> continue even when one fails
1262                         service.mark_claims_returned(bc, date)
1263                         .finally(function(barcode) {
1264                             if (barcode) deferred.notify(barcode);
1265                             mark_one();
1266                         });
1267                     }
1268                     mark_one(); // kick it off
1269                     return deferred.promise;
1270                 }
1271             }]
1272         }).result;
1273     }
1274
1275     // serially checks in each barcode with claims_never_checked_out set
1276     // returns promise, notified on each barcode, resolved after all
1277     // checkins are complete.
1278     service.mark_claims_never_checked_out = function(barcodes) {
1279         if (!barcodes.length) return;
1280
1281         var deferred = $q.defer();
1282         egConfirmDialog.open(
1283             egCore.strings.MARK_NEVER_CHECKED_OUT, '', {barcodes : barcodes}
1284
1285         ).result.then(function() {
1286             function mark_one() {
1287                 var bc = barcodes.pop();
1288
1289                 if (!bc) { // all done
1290                     deferred.resolve();
1291                     return;
1292                 }
1293
1294                 service.checkin(
1295                     {claims_never_checked_out : true, copy_barcode : bc})
1296                 .finally(function() { 
1297                     deferred.notify(bc);
1298                     mark_one();
1299                 })
1300             }
1301             mark_one();
1302         });
1303
1304         return deferred.promise;
1305     }
1306
1307     service.mark_damaged = function(params) {
1308         if (!params) return $q.when();
1309         return $uibModal.open({
1310             templateUrl: './circ/share/t_mark_damaged',
1311             controller:
1312                 ['$scope', '$uibModalInstance', 'egCore', 'egBilling', 'egItem',
1313                 function($scope, $uibModalInstance, egCore, egBilling, egItem) {
1314                     var doRefresh = params.refresh;
1315                     
1316                     $scope.billArgs = {charge: params.charge};
1317                     $scope.mode = 'charge';
1318                     $scope.barcode = params.barcode;
1319                     if (params.charge && params.charge > 0) {
1320                         $scope.applyFine = "apply";
1321                     }
1322                     if (params.circ) {
1323                         $scope.circ = params.circ;
1324                         $scope.circ_checkin_time = params.circ.checkin_time();
1325                         $scope.circ_patron_name = params.circ.usr().family_name() + ", "
1326                             + params.circ.usr().first_given_name() + " "
1327                             + params.circ.usr().second_given_name();
1328                     }
1329                     egBilling.fetchBillingTypes().then(function(res) {
1330                         $scope.billingTypes = res;
1331                     });
1332
1333                     $scope.btnChargeFees = function() {
1334                         $scope.mode = 'charge';
1335                         $scope.billArgs.charge = params.charge;
1336                         $scope.applyFine = "apply";
1337                     }
1338                     $scope.btnWaiveFees = function() {
1339                         $scope.mode = 'waive';
1340                         $scope.billArgs.charge = 0;
1341                         $scope.applyFine = "noapply";
1342                     }
1343
1344                     $scope.cancel = function ($event) { 
1345                         $uibModalInstance.dismiss();
1346                     }
1347                     $scope.ok = function() {
1348                         handle_mark_item_damaged();
1349                     }
1350
1351                     var handle_mark_item_damaged = function() {
1352                         egCore.net.request(
1353                             'open-ils.circ',
1354                             'open-ils.circ.mark_item_damaged',
1355                             egCore.auth.token(), params.id, {
1356                                 apply_fines: $scope.applyFine,
1357                                 override_amount: $scope.billArgs.charge,
1358                                 override_btype: $scope.billArgs.type,
1359                                 override_note: $scope.billArgs.note,
1360                                 handle_checkin: !$scope.applyFine
1361                         }).then(function(resp) {
1362                             if (evt = egCore.evt.parse(resp)) {
1363                                 doRefresh = false;
1364                                 console.debug("mark damaged more information required. Pushing back.");
1365                                 service.mark_damaged({
1366                                     id: params.id,
1367                                     barcode: params.barcode,
1368                                     charge: evt.payload.charge,
1369                                     circ: evt.payload.circ,
1370                                     refresh: params.refresh
1371                                 });
1372                                 console.error('mark damaged failed: ' + evt);
1373                             }
1374                         }).then(function() {
1375                             if (doRefresh) egItem.add_barcode_to_list(params.barcode);
1376                         });
1377                         $uibModalInstance.close();
1378                     }
1379                 }]
1380         }).result;
1381     }
1382
1383     service.mark_missing = function(copy_ids) {
1384         return egConfirmDialog.open(
1385             egCore.strings.MARK_MISSING_CONFIRM, '',
1386             {   num_items : copy_ids.length,
1387                 ok : function() {},
1388                 cancel : function() {}
1389             }
1390         ).result.then(function() {
1391             var promises = [];
1392             angular.forEach(copy_ids, function(copy_id) {
1393                 promises.push(
1394                     egCore.net.request(
1395                         'open-ils.circ',
1396                         'open-ils.circ.mark_item_missing',
1397                         egCore.auth.token(), copy_id
1398                     ).then(function(resp) {
1399                         if (evt = egCore.evt.parse(resp)) {
1400                             console.error('mark missing failed: ' + evt);
1401                         }
1402                     })
1403                 );
1404             });
1405
1406             return $q.all(promises);
1407         });
1408     }
1409
1410
1411
1412     // Mark circulations as lost via copy barcode.  As each item is 
1413     // processed, the returned promise is notified of the barcode.
1414     // No confirmation dialog is presented.
1415     service.mark_lost = function(copy_barcodes) {
1416         var deferred = $q.defer();
1417         var promises = [];
1418
1419         angular.forEach(copy_barcodes, function(barcode) {
1420             promises.push(
1421                 egCore.net.request(
1422                     'open-ils.circ',
1423                     'open-ils.circ.circulation.set_lost',
1424                     egCore.auth.token(), {barcode : barcode}
1425                 ).then(function(resp) {
1426                     if (evt = egCore.evt.parse(resp)) {
1427                         console.error("Mark lost failed: " + evt.toString());
1428                         return;
1429                     }
1430                     // inform the caller as each item is processed
1431                     deferred.notify(barcode);
1432                 })
1433             );
1434         });
1435
1436         $q.all(promises).then(function() {deferred.resolve()});
1437         return deferred.promise;
1438     }
1439
1440     service.abort_transits = function(transit_ids) {
1441         return egConfirmDialog.open(
1442             egCore.strings.ABORT_TRANSIT_CONFIRM, '',
1443             {   num_transits : transit_ids.length,
1444                 ok : function() {},
1445                 cancel : function() {}
1446             }
1447
1448         ).result.then(function() {
1449             var promises = [];
1450             angular.forEach(transit_ids, function(transit_id) {
1451                 promises.push(
1452                     egCore.net.request(
1453                         'open-ils.circ',
1454                         'open-ils.circ.transit.abort',
1455                         egCore.auth.token(), {transitid : transit_id}
1456                     ).then(function(resp) {
1457                         if (evt = egCore.evt.parse(resp)) {
1458                             console.error('abort transit failed: ' + evt);
1459                         }
1460                     })
1461                 );
1462             });
1463
1464             return $q.all(promises);
1465         });
1466     }
1467
1468     service.add_copy_alerts = function(item_ids) {
1469         return egAddCopyAlertDialog.open({
1470             copy_ids : item_ids,
1471             ok : function() { },
1472             cancel : function() {}
1473         }).result.then(function() { });
1474     }
1475
1476     service.manage_copy_alerts = function(item_ids) {
1477         return egCopyAlertEditorDialog.open({
1478             copy_id : item_ids[0],
1479             ok : function() { },
1480             cancel : function() {}
1481         }).result.then(function() { });
1482     }
1483
1484     // alert when copy location alert_message is set.
1485     // This does not affect processing, it only produces a click-through
1486     service.handle_checkin_loc_alert = function(evt, params, options) {
1487         if (angular.isArray(evt)) evt = evt[0];
1488
1489         var copy = evt && evt.payload ? evt.payload.copy : null;
1490
1491         if (copy && !options.suppress_checkin_popups
1492             && copy.location().checkin_alert() == 't') {
1493
1494             return egAlertDialog.open(
1495                 egCore.strings.LOCATION_ALERT_MSG, {copy : copy}).result;
1496         }
1497
1498         return $q.when();
1499     }
1500
1501     service.handle_checkin_resp = function(evt, params, options) {
1502         if (!angular.isArray(evt)) evt = [evt];
1503
1504         var final_resp = {evt : evt, params : params, options : options};
1505
1506         var copy, hold, transit, latest_inventory;
1507         if (evt[0].payload) {
1508             copy = evt[0].payload.copy;
1509             hold = evt[0].payload.hold;
1510             transit = evt[0].payload.transit;
1511             latest_inventory = evt[0].payload.latest_inventory;
1512         }
1513
1514         // track the barcode regardless of whether it's valid
1515         angular.forEach(evt, function(e){ e.copy_barcode = params.copy_barcode; });
1516
1517         angular.forEach(evt, function(e){ console.debug('checkin event ' + e.textcode); });
1518
1519         if (evt.filter(function(e){return service.checkin_overridable_events.indexOf(e.textcode) > -1;}).length > 0)
1520             return service.handle_overridable_checkin_event(evt, params, options);
1521
1522         switch (evt[0].textcode) {
1523
1524             case 'SUCCESS':
1525             case 'NO_CHANGE':
1526
1527                 switch(Number(copy.status().id())) {
1528
1529                     case 0: /* AVAILABLE */                                        
1530                     case 4: /* MISSING */                                          
1531                     case 7: /* RESHELVING */ 
1532
1533                         egCore.audio.play('success.checkin');
1534
1535                         // see if the copy location requires an alert
1536                         return service.handle_checkin_loc_alert(evt, params, options)
1537                         .then(function() {return final_resp});
1538
1539                     case 8: /* ON HOLDS SHELF */
1540                         egCore.audio.play('info.checkin.holds_shelf');
1541                         
1542                         if (hold) {
1543
1544                             if (hold.pickup_lib() == egCore.auth.user().ws_ou()) {
1545                                 // inform user if the item is on the local holds shelf
1546                             
1547                                 evt[0].route_to = egCore.strings.ROUTE_TO_HOLDS_SHELF;
1548                                 return service.route_dialog(
1549                                     './circ/share/t_hold_shelf_dialog', 
1550                                     evt[0], params, options
1551                                 ).then(function() { return final_resp });
1552
1553                             } else {
1554                                 // normally, if the hold was on the shelf at a 
1555                                 // different location, it would be put into 
1556                                 // transit, resulting in a ROUTE_ITEM event.
1557                                 egCore.audio.play('warning.checkin.wrong_shelf');
1558                                 return $q.when(final_resp);
1559                             }
1560                         } else {
1561
1562                             console.error('checkin: item on holds shelf, '
1563                                 + 'but hold info not returned from checkin');
1564                             return $q.when(final_resp);
1565                         }
1566
1567                     case 11: /* CATALOGING */
1568                         egCore.audio.play('info.checkin.cataloging');
1569                         evt[0].route_to = egCore.strings.ROUTE_TO_CATALOGING;
1570                         if (options.no_precat_alert)
1571                             return $q.when(final_resp);
1572                         return egAlertDialog.open(
1573                             egCore.strings.PRECAT_CHECKIN_MSG, params)
1574                             .result.then(function() {return final_resp});
1575
1576
1577                     case 15: /* ON_RESERVATION_SHELF */
1578                         egCore.audio.play('info.checkin.reservation');
1579                         // TODO: show booking reservation dialog
1580                         return $q.when(final_resp);
1581
1582                     default:
1583                         egCore.audio.play('success.checkin');
1584                         console.debug('Unusual checkin copy status (may have been set via copy alert): '
1585                             + copy.status().id() + ' : ' + copy.status().name());
1586                         return $q.when(final_resp);
1587                 }
1588                 
1589             case 'ROUTE_ITEM':
1590                 return service.route_dialog(
1591                     './circ/share/t_transit_dialog', 
1592                     evt[0], params, options
1593                 ).then(function() { return final_resp });
1594
1595             case 'ASSET_COPY_NOT_FOUND':
1596                 egCore.audio.play('error.checkin.not_found');
1597                 return egAlertDialog.open(
1598                     egCore.strings.UNCAT_ALERT_DIALOG, params)
1599                     .result.then(function() {return final_resp});
1600
1601             case 'ITEM_NOT_CATALOGED':
1602                 egCore.audio.play('error.checkin.not_cataloged');
1603                 evt[0].route_to = egCore.strings.ROUTE_TO_CATALOGING;
1604                 if (options.no_precat_alert) 
1605                     return $q.when(final_resp);
1606                 return egAlertDialog.open(
1607                     egCore.strings.PRECAT_CHECKIN_MSG, params)
1608                     .result.then(function() {return final_resp});
1609
1610             default:
1611                 egCore.audio.play('error.checkin.unknown');
1612                 console.warn('unhandled checkin response : ' + evt[0].textcode);
1613                 return $q.when(final_resp);
1614         }
1615     }
1616
1617     // collect transit, address, and hold info that's not already
1618     // included in responses.
1619     service.collect_route_data = function(tmpl, evt, params, options) {
1620         if (angular.isArray(evt)) evt = evt[0];
1621         var promises = [];
1622         var data = {};
1623
1624         if (evt.org && !tmpl.match(/hold_shelf/)) {
1625             promises.push(
1626                 service.get_org_addr(evt.org, 'holds_address')
1627                 .then(function(addr) { data.address = addr })
1628             );
1629         }
1630
1631         if (evt.payload.hold) {
1632             promises.push(
1633                 egCore.pcrud.retrieve('au', 
1634                     evt.payload.hold.usr(), {
1635                         flesh : 1,
1636                         flesh_fields : {'au' : ['card']}
1637                     }
1638                 ).then(function(patron) {data.patron = patron})
1639             );
1640         }
1641
1642
1643         if (!tmpl.match(/hold_shelf/)) {
1644             var courier_deferred = $q.defer();
1645             promises.push(courier_deferred.promise);
1646             promises.push(
1647                 service.find_copy_transit(evt, params, options)
1648                 .then(function(trans) {
1649                     data.transit = trans;
1650                     egCore.org.settings('lib.courier_code', trans.dest().id())
1651                     .then(function(s) {
1652                         data.dest_courier_code = s['lib.courier_code'];
1653                         courier_deferred.resolve();
1654                     });
1655                 })
1656             );
1657         }
1658
1659         return $q.all(promises).then(function() { return data });
1660     }
1661
1662     service.route_dialog = function(tmpl, evt, params, options) {
1663         if (angular.isArray(evt)) evt = evt[0];
1664
1665         return service.collect_route_data(tmpl, evt, params, options)
1666         .then(function(data) {
1667
1668             var template = data.transit ?
1669                 (data.patron ? 'hold_transit_slip' : 'transit_slip') :
1670                 'hold_shelf_slip';
1671             if (service.never_auto_print[template]) {
1672                 // do not show the dialog or print if the
1673                 // disabled automatic print attempt type list includes
1674                 // the specified template
1675                 return;
1676             }
1677
1678             // All actions flow from the print data
1679
1680             var print_context = {
1681                 copy : egCore.idl.toHash(evt.payload.copy),
1682                 title : evt.title,
1683                 author : evt.author,
1684                 call_number : egCore.idl.toHash(evt.payload.volume)
1685             };
1686
1687             var acn = print_context.call_number; // fix up pre/suffixes
1688             if (acn.prefix == -1) acn.prefix = "";
1689             if (acn.suffix == -1) acn.suffix = "";
1690
1691             if (data.transit) {
1692                 // route_dialog includes the "route to holds shelf" 
1693                 // dialog, which has no transit
1694                 print_context.transit = egCore.idl.toHash(data.transit);
1695                 print_context.dest_courier_code = data.dest_courier_code;
1696                 if (data.address) {
1697                     print_context.dest_address = egCore.idl.toHash(data.address);
1698                 }
1699                 print_context.dest_location =
1700                     egCore.idl.toHash(egCore.org.get(data.transit.dest()));
1701             }
1702
1703             if (data.patron) {
1704                 print_context.hold = egCore.idl.toHash(evt.payload.hold);
1705                 var notes = print_context.hold.notes;
1706                 if(notes.length > 0){
1707                     print_context.hold_notes = [];
1708                     angular.forEach(notes, function(n){
1709                         print_context.hold_notes.push(n);
1710                     });
1711                 }
1712                 print_context.patron = egCore.idl.toHash(data.patron);
1713             }
1714
1715             var sound = 'info.checkin.transit';
1716             if (evt.payload.hold) sound += '.hold';
1717             egCore.audio.play(sound);
1718
1719             function print_transit(template) {
1720                 return egCore.print.print({
1721                     context : 'default', 
1722                     template : template, 
1723                     scope : print_context
1724                 });
1725             }
1726
1727             // when auto-print is on, skip the dialog and go straight
1728             // to printing.
1729             if (options.auto_print_holds_transits) 
1730                 return print_transit(template);
1731
1732             return $uibModal.open({
1733                 templateUrl: tmpl,
1734                 backdrop: 'static',
1735                 controller: [
1736                             '$scope','$uibModalInstance',
1737                     function($scope , $uibModalInstance) {
1738
1739                     $scope.today = new Date();
1740
1741                     // copy the print scope into the dialog scope
1742                     angular.forEach(print_context, function(val, key) {
1743                         $scope[key] = val;
1744                     });
1745
1746                     $scope.ok = function() {$uibModalInstance.close()}
1747
1748                     $scope.print = function() { 
1749                         $uibModalInstance.close();
1750                         print_transit(template);
1751                     }
1752                 }]
1753
1754             }).result;
1755         });
1756     }
1757
1758     // action == what action to take if the user confirms the alert
1759     service.copy_alert_dialog = function(evt, params, options, action) {
1760         if (angular.isArray(evt)) evt = evt[0];
1761         if (!angular.isArray(evt.payload)) {
1762             return egConfirmDialog.open(
1763                 egCore.strings.COPY_ALERT_MSG_DIALOG_TITLE, 
1764                 evt.payload,  // payload == alert message text
1765                 {   copy_barcode : params.copy_barcode,
1766                     ok : function() {},
1767                     cancel : function() {}
1768                 }
1769             ).result.then(function() {
1770                 options.override = true;
1771                 return service[action](params, options);
1772             });
1773         } else { // we got a list of copy alert objects ...
1774             return egCopyAlertManagerDialog.open({
1775                 alerts : evt.payload,
1776                 mode : action,
1777                 ok : function(the_next_status) {
1778                         if (the_next_status !== null) {
1779                             params.next_copy_status = [ the_next_status ];
1780                             params.capture = 'nocapture';
1781                         }
1782                      },
1783                 cancel : function() {}
1784             }).result.then(function() {
1785                 options.override = true;
1786                 return service[action](params, options);
1787             });
1788         }
1789     }
1790
1791     // action == what action to take if the user confirms the alert
1792     service.hold_capture_delay_dialog = function(evt, params, options, action) {
1793         if (angular.isArray(evt)) evt = evt[0];
1794         return $uibModal.open({
1795             templateUrl: './circ/checkin/t_hold_verify',
1796             backdrop: 'static',
1797             controller:
1798                        ['$scope','$uibModalInstance','params',
1799                 function($scope , $uibModalInstance , params) {
1800                 $scope.copy_barcode = params.copy_barcode;
1801                 $scope.capture = function() {
1802                     params.capture = 'capture';
1803                     $uibModalInstance.close();
1804                 };
1805                 $scope.nocapture = function() {
1806                     params.capture = 'nocapture';
1807                     $uibModalInstance.close();
1808                 };
1809                 $scope.cancel = function() { $uibModalInstance.dismiss(); };
1810             }],
1811             resolve : {
1812                 params : function() {
1813                     return params;
1814                 }
1815             }
1816         }).result.then(
1817             function(r) {
1818                 return service[action](params, options);
1819             }
1820         );
1821     }
1822
1823     // check the barcode.  If it's no good, show the warning dialog
1824     // Resolves on success, rejected on error
1825     service.test_barcode = function(bc) {
1826
1827         var ok = service.check_barcode(bc);
1828         if (ok) return $q.when();
1829
1830         egCore.audio.play('warning.circ.bad_barcode');
1831         return $uibModal.open({
1832             templateUrl: './circ/share/t_bad_barcode_dialog',
1833             backdrop: 'static',
1834             controller: 
1835                 ['$scope', '$uibModalInstance', 
1836                 function($scope, $uibModalInstance) {
1837                 $scope.barcode = bc;
1838                 $scope.ok = function() { $uibModalInstance.close() }
1839                 $scope.cancel = function() { $uibModalInstance.dismiss() }
1840             }]
1841         }).result;
1842     }
1843
1844     // check() and checkdigit() copied directly 
1845     // from chrome/content/util/barcode.js
1846
1847     service.check_barcode = function(bc) {
1848         if (bc != Number(bc)) return false;
1849         bc = bc.toString();
1850         // "16.00" == Number("16.00"), but the . is bad.
1851         // Throw out any barcode that isn't just digits
1852         if (bc.search(/\D/) != -1) return false;
1853         var last_digit = bc.substr(bc.length-1);
1854         var stripped_barcode = bc.substr(0,bc.length-1);
1855         return service.barcode_checkdigit(stripped_barcode).toString() == last_digit;
1856     }
1857
1858     service.barcode_checkdigit = function(bc) {
1859         var reverse_barcode = bc.toString().split('').reverse();
1860         var check_sum = 0; var multiplier = 2;
1861         for (var i = 0; i < reverse_barcode.length; i++) {
1862             var digit = reverse_barcode[i];
1863             var product = digit * multiplier; product = product.toString();
1864             var temp_sum = 0;
1865             for (var j = 0; j < product.length; j++) {
1866                 temp_sum += Number( product[j] );
1867             }
1868             check_sum += Number( temp_sum );
1869             multiplier = ( multiplier == 2 ? 1 : 2 );
1870         }
1871         check_sum = check_sum.toString();
1872         var next_multiple_of_10 = (check_sum.match(/(\d*)\d$/)[1] * 10) + 10;
1873         var check_digit = next_multiple_of_10 - Number(check_sum);
1874         if (check_digit == 10) check_digit = 0;
1875         return check_digit;
1876     }
1877
1878     service.handle_barcode_completion = function(barcode) {
1879         return egCore.net.request(
1880             'open-ils.actor',
1881             'open-ils.actor.get_barcodes',
1882             egCore.auth.token(), egCore.auth.user().ws_ou(), 
1883             'asset', barcode)
1884
1885         .then(function(resp) {
1886             // TODO: handle event during barcode lookup
1887             if (evt = egCore.evt.parse(resp)) {
1888                 console.error(evt.toString());
1889                 return $q.reject();
1890             }
1891
1892             // no matching barcodes: return the barcode as entered
1893             // by the user (so that, e.g., checkout can fall back to
1894             // precat/noncat handling)
1895             if (!resp || !resp[0]) {
1896                 return barcode;
1897             }
1898
1899             // exactly one matching barcode: return it
1900             if (resp.length == 1) {
1901                 return resp[0].barcode;
1902             }
1903
1904             // multiple matching barcodes: let the user pick one 
1905             console.debug('multiple matching barcodes');
1906             var matches = [];
1907             var promises = [];
1908             var final_barcode;
1909             angular.forEach(resp, function(cp) {
1910                 promises.push(
1911                     egCore.net.request(
1912                         'open-ils.circ',
1913                         'open-ils.circ.copy_details.retrieve',
1914                         egCore.auth.token(), cp.id
1915                     ).then(function(r) {
1916                         matches.push({
1917                             barcode: r.copy.barcode(),
1918                             title: r.mvr.title(),
1919                             org_name: egCore.org.get(r.copy.circ_lib()).name(),
1920                             org_shortname: egCore.org.get(r.copy.circ_lib()).shortname()
1921                         });
1922                     })
1923                 );
1924             });
1925             return $q.all(promises)
1926             .then(function() {
1927                 return $uibModal.open({
1928                     templateUrl: './circ/share/t_barcode_choice_dialog',
1929                     backdrop: 'static',
1930                     controller:
1931                         ['$scope', '$uibModalInstance',
1932                         function($scope, $uibModalInstance) {
1933                         $scope.matches = matches;
1934                         $scope.ok = function(barcode) {
1935                             $uibModalInstance.close();
1936                             final_barcode = barcode;
1937                         }
1938                         $scope.cancel = function() {$uibModalInstance.dismiss()}
1939                     }],
1940                 }).result.then(function() { return final_barcode });
1941             })
1942         });
1943     }
1944
1945     service.create_penalty = function(user_id) {
1946         return $uibModal.open({
1947             templateUrl: './circ/share/t_new_message_dialog',
1948             backdrop: 'static',
1949             controller: 
1950                    ['$scope','$uibModalInstance','staffPenalties',
1951             function($scope , $uibModalInstance , staffPenalties) {
1952                 $scope.focusNote = true;
1953                 $scope.penalties = staffPenalties;
1954                 $scope.require_initials = service.require_initials;
1955                 $scope.args = {penalty : 21}; // default to Note
1956                 $scope.setPenalty = function(id) {
1957                     args.penalty = id;
1958                 }
1959                 $scope.ok = function(count) { $uibModalInstance.close($scope.args) }
1960                 $scope.cancel = function($event) { 
1961                     $uibModalInstance.dismiss();
1962                     $event.preventDefault();
1963                 }
1964             }],
1965             resolve : { staffPenalties : service.get_staff_penalty_types }
1966         }).result.then(
1967             function(args) {
1968                 var pen = new egCore.idl.ausp();
1969                 pen.usr(user_id);
1970                 pen.org_unit(egCore.auth.user().ws_ou());
1971                 pen.note(args.note);
1972                 if (args.initials) pen.note(args.note + ' [' + args.initials + ']');
1973                 if (args.custom_penalty) {
1974                     pen.standing_penalty(args.custom_penalty);
1975                 } else {
1976                     pen.standing_penalty(args.penalty);
1977                 }
1978                 pen.staff(egCore.auth.user().id());
1979                 pen.set_date('now');
1980
1981                 return egCore.net.request(
1982                     'open-ils.actor',
1983                     'open-ils.actor.user.penalty.apply',
1984                     egCore.auth.token(), pen
1985                 );
1986             }
1987         );
1988     }
1989
1990     // assumes, for now anyway,  penalty type is fleshed onto usr_penalty.
1991     service.edit_penalty = function(usr_penalty) {
1992         return $uibModal.open({
1993             templateUrl: './circ/share/t_new_message_dialog',
1994             backdrop: 'static',
1995             controller: 
1996                    ['$scope','$uibModalInstance','staffPenalties',
1997             function($scope , $uibModalInstance , staffPenalties) {
1998                 $scope.focusNote = true;
1999                 $scope.penalties = staffPenalties;
2000                 $scope.require_initials = service.require_initials;
2001                 $scope.args = {
2002                     penalty : usr_penalty.standing_penalty().id(),
2003                     note : usr_penalty.note()
2004                 }
2005                 $scope.setPenalty = function(id) { args.penalty = id; }
2006                 $scope.ok = function(count) { $uibModalInstance.close($scope.args) }
2007                 $scope.cancel = function($event) { 
2008                     $uibModalInstance.dismiss();
2009                     $event.preventDefault();
2010                 }
2011             }],
2012             resolve : { staffPenalties : service.get_staff_penalty_types }
2013         }).result.then(
2014             function(args) {
2015                 usr_penalty.note(args.note);
2016                 if (args.initials) usr_penalty.note(args.note + ' [' + args.initials + ']');
2017                 usr_penalty.standing_penalty(args.penalty);
2018                 return egCore.pcrud.update(usr_penalty);
2019             }
2020         );
2021     }
2022
2023     return service;
2024
2025 }]);
2026
2027