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