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