LP#1699566: item barcode completion in web client
[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             controller: 
710                 ['$scope', '$uibModalInstance', 
711                 function($scope, $uibModalInstance) {
712                 $scope.events = evt;
713                 $scope.auto_override =
714                     evt.filter(function(e){
715                         return service.checkout_auto_override_after_first.indexOf(evt.textcode) > -1;
716                     }).length > 0;
717                 $scope.copy_barcode = params.copy_barcode; // may be null
718                 $scope.ok = function() { $uibModalInstance.close() }
719                 $scope.cancel = function ($event) { 
720                     $uibModalInstance.dismiss();
721                     $event.preventDefault();
722                 }
723             }]
724         }).result.then(
725             function() {
726                 options.override = true;
727
728                 if (action == 'checkin') {
729                     return service.checkin(params, options);
730                 }
731
732                 // checkout/renew support override-after-first
733                 angular.forEach(evt, function(e){
734                     if (service.checkout_auto_override_after_first.indexOf(e.textcode) > -1)
735                         service.auto_override_checkout_events[e.textcode] = true;
736                 });
737
738                 return service[action](params, options);
739             }
740         );
741     }
742
743     service.copy_not_avail_dialog = function(evt, params, options) {
744         if (angular.isArray(evt)) evt = evt[0];
745         return $uibModal.open({
746             templateUrl: './circ/share/t_copy_not_avail_dialog',
747             controller: 
748                        ['$scope','$uibModalInstance','copyStatus',
749                 function($scope , $uibModalInstance , copyStatus) {
750                 $scope.copyStatus = copyStatus;
751                 $scope.ok = function() {$uibModalInstance.close()}
752                 $scope.cancel = function() {$uibModalInstance.dismiss()}
753             }],
754             resolve : {
755                 copyStatus : function() {
756                     return egCore.pcrud.retrieve(
757                         'ccs', evt.payload.status());
758                 }
759             }
760         }).result.then(
761             function() {
762                 options.override = true;
763                 return service.checkout(params, options);
764             }
765         );
766     }
767
768     // Opens a dialog allowing the user to fill in the desired non-cat count.
769     // Unlike other dialogs, which kickoff circ actions internally
770     // as a result of events, this dialog does not kick off any circ
771     // actions. It just collects the count and and resolves the promise.
772     //
773     // This assumes the caller has already handled the noncat-type
774     // selection and just needs to collect the count info.
775     service.noncat_dialog = function(params, options) {
776         var noncatMax = 99; // hard-coded max
777         
778         // the caller should presumably have fetched the noncat_types via
779         // our API already, but fetch them again (from cache) to be safe.
780         return service.get_noncat_types().then(function() {
781
782             params.noncat = true;
783             var type = egCore.env.cnct.map[params.noncat_type];
784
785             return $uibModal.open({
786                 templateUrl: './circ/share/t_noncat_dialog',
787                 controller: 
788                     ['$scope', '$uibModalInstance',
789                     function($scope, $uibModalInstance) {
790                     $scope.focusMe = true;
791                     $scope.type = type;
792                     $scope.count = 1;
793                     $scope.noncatMax = noncatMax;
794                     $scope.ok = function(count) { $uibModalInstance.close(count) }
795                     $scope.cancel = function ($event) { 
796                         $uibModalInstance.dismiss() 
797                         $event.preventDefault();
798                     }
799                 }],
800             }).result.then(
801                 function(count) {
802                     if (count && count > 0 && count <= noncatMax) { 
803                         // NOTE: in Chrome, form validation ensure a valid number
804                         params.noncat_count = count;
805                         return $q.when(params);
806                     } else {
807                         return $q.reject();
808                     }
809                 }
810             );
811         });
812     }
813
814     // Opens a dialog allowing the user to fill in pre-cat copy info.
815     service.precat_dialog = function(params, options) {
816
817         return $uibModal.open({
818             templateUrl: './circ/share/t_precat_dialog',
819             controller: 
820                 ['$scope', '$uibModalInstance', 'circMods',
821                 function($scope, $uibModalInstance, circMods) {
822                 $scope.focusMe = true;
823                 $scope.precatArgs = {
824                     copy_barcode : params.copy_barcode
825                 };
826                 $scope.circModifiers = circMods;
827                 $scope.ok = function(args) { $uibModalInstance.close(args) }
828                 $scope.cancel = function () { $uibModalInstance.dismiss() }
829             }],
830             resolve : {
831                 circMods : function() { 
832                     return service.get_circ_mods();
833                 }
834             }
835         }).result.then(
836             function(args) {
837                 if (!args || !args.dummy_title) return $q.reject();
838                 if(args.circ_modifier == "") args.circ_modifier = null;
839                 angular.forEach(args, function(val, key) {params[key] = val});
840                 params.precat = true;
841                 return service.checkout(params, options);
842             }
843         );
844     }
845
846     // find the open transit for the given copy barcode; flesh the org
847     // units locally.
848     service.find_copy_transit = function(evt, params, options) {
849         if (angular.isArray(evt)) evt = evt[0];
850
851         if (evt && evt.payload && evt.payload.transit)
852             return $q.when(evt.payload.transit);
853
854          return egCore.pcrud.search('atc',
855             {   dest_recv_time : null},
856             {   flesh : 1, 
857                 flesh_fields : {atc : ['target_copy']},
858                 join : {
859                     acp : {
860                         filter : {
861                             barcode : params.copy_barcode,
862                             deleted : 'f'
863                         }
864                     }
865                 },
866                 limit : 1,
867                 order_by : {atc : 'source_send_time desc'}, 
868             }
869         ).then(function(transit) {
870             transit.source(egCore.org.get(transit.source()));
871             transit.dest(egCore.org.get(transit.dest()));
872             return transit;
873         });
874     }
875
876     service.copy_in_transit_dialog = function(evt, params, options) {
877         if (angular.isArray(evt)) evt = evt[0];
878         return $uibModal.open({
879             templateUrl: './circ/share/t_copy_in_transit_dialog',
880             controller: 
881                        ['$scope','$uibModalInstance','transit',
882                 function($scope , $uibModalInstance , transit) {
883                 $scope.transit = transit;
884                 $scope.ok = function() { $uibModalInstance.close(transit) }
885                 $scope.cancel = function() { $uibModalInstance.dismiss() }
886             }],
887             resolve : {
888                 // fetch the conflicting open transit w/ fleshed copy
889                 transit : function() {
890                     return service.find_copy_transit(evt, params, options);
891                 }
892             }
893         }).result.then(
894             function(transit) {
895                 // user chose to abort the transit then checkout
896                 return service.abort_transit(transit.id())
897                 .then(function() {
898                     return service.checkout(params, options);
899                 });
900             }
901         );
902     }
903
904     service.abort_transit = function(transit_id) {
905         return egCore.net.request(
906             'open-ils.circ',
907             'open-ils.circ.transit.abort',
908             egCore.auth.token(), {transitid : transit_id}
909         ).then(function(resp) {
910             if (evt = egCore.evt.parse(resp)) {
911                 alert(evt);
912                 return $q.reject();
913             }
914             return $q.when();
915         });
916     }
917
918     service.last_copy_circ = function(copy_id) {
919         return egCore.pcrud.search('circ', 
920             {target_copy : copy_id},
921             {order_by : {circ : 'xact_start desc' }, limit : 1}
922         );
923     }
924
925     service.circ_exists_dialog = function(evt, params, options) {
926         if (angular.isArray(evt)) evt = evt[0];
927
928         if (!evt.payload.old_circ) {
929             return egCore.pcrud.search('circ',
930                 {target_copy : evt.payload.copy.id(), checkin_time : null},
931                 {limit : 1} // should only ever be 1
932             ).then(function(old_circ) {
933                 evt.payload.old_circ = old_circ;
934                return service.circ_exists_dialog_impl(evt, params, options);
935             });
936         } else {
937             return service.circ_exists_dialog_impl( evt, params, options );
938         }
939     },
940
941     service.circ_exists_dialog_impl = function (evt, params, options) {
942
943         var openCirc = evt.payload.old_circ;
944         var sameUser = openCirc.usr() == params.patron_id;
945         
946         return $uibModal.open({
947             templateUrl: './circ/share/t_circ_exists_dialog',
948             controller: 
949                        ['$scope','$uibModalInstance',
950                 function($scope , $uibModalInstance) {
951                 $scope.args = {forgive_fines : false};
952                 $scope.circDate = openCirc.xact_start();
953                 $scope.sameUser = sameUser;
954                 $scope.ok = function() { $uibModalInstance.close($scope.args) }
955                 $scope.cancel = function($event) { 
956                     $uibModalInstance.dismiss();
957                     $event.preventDefault(); // form, avoid calling ok();
958                 }
959             }]
960         }).result.then(
961             function(args) {
962                 if (sameUser) {
963                     params.void_overdues = args.forgive_fines;
964                     options.override = true;
965                     return service.renew(params, options);
966                 }
967
968                 return service.checkin({
969                     barcode : params.copy_barcode,
970                     noop : true,
971                     override : true,
972                     void_overdues : args.forgive_fines
973                 }).then(function(checkin_resp) {
974                     if (checkin_resp.evt[0].textcode == 'SUCCESS') {
975                         return service.checkout(params, options);
976                     } else {
977                         alert(egCore.evt.parse(checkin_resp.evt[0]));
978                         return $q.reject();
979                     }
980                 });
981             }
982         );
983     }
984
985     service.batch_backdate = function(circ_ids, backdate) {
986         return egCore.net.request(
987             'open-ils.circ',
988             'open-ils.circ.post_checkin_backdate.batch',
989             egCore.auth.token(), circ_ids, backdate);
990     }
991
992     service.backdate_dialog = function(circ_ids) {
993         return $uibModal.open({
994             templateUrl: './circ/share/t_backdate_dialog',
995             controller: 
996                        ['$scope','$uibModalInstance',
997                 function($scope , $uibModalInstance) {
998
999                 var today = new Date();
1000                 $scope.dialog = {
1001                     num_circs : circ_ids.length,
1002                     num_processed : 0,
1003                     backdate : today
1004                 }
1005
1006                 $scope.$watch('dialog.backdate', function(newval) {
1007                     if (newval && newval > today) 
1008                         $scope.dialog.backdate = today;
1009                 });
1010
1011
1012                 $scope.cancel = function() { 
1013                     $uibModalInstance.dismiss();
1014                 }
1015
1016                 $scope.ok = function() { 
1017
1018                     var bd = $scope.dialog.backdate.toISOString().replace(/T.*/,'');
1019                     service.batch_backdate(circ_ids, bd)
1020                     .then(
1021                         function() { // on complete
1022                             $uibModalInstance.close({backdate : bd});
1023                         },
1024                         null,
1025                         function(resp) { // on response
1026                             console.debug('backdate returned ' + resp);
1027                             if (resp == '1') {
1028                                 $scope.num_processed++;
1029                             } else {
1030                                 console.error(egCore.evt.parse(resp));
1031                             }
1032                         }
1033                     );
1034                 }
1035             }]
1036         }).result;
1037     }
1038
1039     service.mark_claims_returned = function(barcode, date, override) {
1040
1041         var method = 'open-ils.circ.circulation.set_claims_returned';
1042         if (override) method += '.override';
1043
1044         console.debug('claims returned ' + method);
1045
1046         return egCore.net.request(
1047             'open-ils.circ', method, egCore.auth.token(),
1048             {barcode : barcode, backdate : date})
1049
1050         .then(function(resp) {
1051
1052             if (resp == 1) { // success
1053                 console.debug('claims returned succeeded for ' + barcode);
1054                 return barcode;
1055
1056             } else if (evt = egCore.evt.parse(resp)) {
1057                 console.debug('claims returned failed: ' + evt.toString());
1058
1059                 if (evt.textcode == 'PATRON_EXCEEDS_CLAIMS_RETURN_COUNT') {
1060                     // TODO check perms before offering override option?
1061
1062                     if (override) return;// just to be safe
1063
1064                     return egConfirmDialog.open(
1065                         egCore.strings.TOO_MANY_CLAIMS_RETURNED, '', {}
1066                     ).result.then(function() {
1067                         return service.mark_claims_returned(barcode, date, true);
1068                     });
1069                 }
1070
1071                 if (evt.textcode == 'PERM_FAILURE') {
1072                     console.error('claims returned permission denied')
1073                     // TODO: auth override dialog?
1074                 }
1075             }
1076         });
1077     }
1078
1079     service.mark_claims_returned_dialog = function(copy_barcodes) {
1080         if (!copy_barcodes.length) return;
1081
1082         return $uibModal.open({
1083             templateUrl: './circ/share/t_mark_claims_returned_dialog',
1084             controller: 
1085                        ['$scope','$uibModalInstance',
1086                 function($scope , $uibModalInstance) {
1087
1088                 var today = new Date();
1089                 $scope.args = {
1090                     barcodes : copy_barcodes,
1091                     date : today
1092                 };
1093
1094                 $scope.$watch('args.date', function(newval) {
1095                     if (newval && newval > today) 
1096                         $scope.args.backdate = today;
1097                 });
1098
1099                 $scope.cancel = function() {$uibModalInstance.dismiss()}
1100                 $scope.ok = function() { 
1101
1102                     var date = $scope.args.date.toISOString().replace(/T.*/,'');
1103
1104                     var deferred = $q.defer();
1105
1106                     // serialize the action on each barcode so that the 
1107                     // caller will never see multiple alerts at the same time.
1108                     function mark_one() {
1109                         var bc = copy_barcodes.pop();
1110                         if (!bc) {
1111                             deferred.resolve();
1112                             $uibModalInstance.close();
1113                             return;
1114                         }
1115
1116                         // finally -> continue even when one fails
1117                         service.mark_claims_returned(bc, date)
1118                         .finally(function(barcode) {
1119                             if (barcode) deferred.notify(barcode);
1120                             mark_one();
1121                         });
1122                     }
1123                     mark_one(); // kick it off
1124                     return deferred.promise;
1125                 }
1126             }]
1127         }).result;
1128     }
1129
1130     // serially checks in each barcode with claims_never_checked_out set
1131     // returns promise, notified on each barcode, resolved after all
1132     // checkins are complete.
1133     service.mark_claims_never_checked_out = function(barcodes) {
1134         if (!barcodes.length) return;
1135
1136         var deferred = $q.defer();
1137         egConfirmDialog.open(
1138             egCore.strings.MARK_NEVER_CHECKED_OUT, '', {barcodes : barcodes}
1139
1140         ).result.then(function() {
1141             function mark_one() {
1142                 var bc = barcodes.pop();
1143
1144                 if (!bc) { // all done
1145                     deferred.resolve();
1146                     return;
1147                 }
1148
1149                 service.checkin(
1150                     {claims_never_checked_out : true, copy_barcode : bc})
1151                 .finally(function() { 
1152                     deferred.notify(bc);
1153                     mark_one();
1154                 })
1155             }
1156             mark_one();
1157         });
1158
1159         return deferred.promise;
1160     }
1161
1162     service.mark_damaged = function(copy_ids) {
1163         return egConfirmDialog.open(
1164             egCore.strings.MARK_DAMAGED_CONFIRM, '',
1165             {   num_items : copy_ids.length,
1166                 ok : function() {},
1167                 cancel : function() {}
1168             }
1169
1170         ).result.then(function() {
1171             var promises = [];
1172             angular.forEach(copy_ids, function(copy_id) {
1173                 promises.push(
1174                     egCore.net.request(
1175                         'open-ils.circ',
1176                         'open-ils.circ.mark_item_damaged',
1177                         egCore.auth.token(), copy_id
1178                     ).then(function(resp) {
1179                         if (evt = egCore.evt.parse(resp)) {
1180                             console.error('mark damaged failed: ' + evt);
1181                         }
1182                     })
1183                 );
1184             });
1185
1186             return $q.all(promises);
1187         });
1188     }
1189
1190     service.mark_missing = function(copy_ids) {
1191         return egConfirmDialog.open(
1192             egCore.strings.MARK_MISSING_CONFIRM, '',
1193             {   num_items : copy_ids.length,
1194                 ok : function() {},
1195                 cancel : function() {}
1196             }
1197         ).result.then(function() {
1198             var promises = [];
1199             angular.forEach(copy_ids, function(copy_id) {
1200                 promises.push(
1201                     egCore.net.request(
1202                         'open-ils.circ',
1203                         'open-ils.circ.mark_item_missing',
1204                         egCore.auth.token(), copy_id
1205                     ).then(function(resp) {
1206                         if (evt = egCore.evt.parse(resp)) {
1207                             console.error('mark missing failed: ' + evt);
1208                         }
1209                     })
1210                 );
1211             });
1212
1213             return $q.all(promises);
1214         });
1215     }
1216
1217
1218
1219     // Mark circulations as lost via copy barcode.  As each item is 
1220     // processed, the returned promise is notified of the barcode.
1221     // No confirmation dialog is presented.
1222     service.mark_lost = function(copy_barcodes) {
1223         var deferred = $q.defer();
1224         var promises = [];
1225
1226         angular.forEach(copy_barcodes, function(barcode) {
1227             promises.push(
1228                 egCore.net.request(
1229                     'open-ils.circ',
1230                     'open-ils.circ.circulation.set_lost',
1231                     egCore.auth.token(), {barcode : barcode}
1232                 ).then(function(resp) {
1233                     if (evt = egCore.evt.parse(resp)) {
1234                         console.error("Mark lost failed: " + evt.toString());
1235                         return;
1236                     }
1237                     // inform the caller as each item is processed
1238                     deferred.notify(barcode);
1239                 })
1240             );
1241         });
1242
1243         $q.all(promises).then(function() {deferred.resolve()});
1244         return deferred.promise;
1245     }
1246
1247     service.abort_transits = function(transit_ids) {
1248         return egConfirmDialog.open(
1249             egCore.strings.ABORT_TRANSIT_CONFIRM, '',
1250             {   num_transits : transit_ids.length,
1251                 ok : function() {},
1252                 cancel : function() {}
1253             }
1254
1255         ).result.then(function() {
1256             var promises = [];
1257             angular.forEach(transit_ids, function(transit_id) {
1258                 promises.push(
1259                     egCore.net.request(
1260                         'open-ils.circ',
1261                         'open-ils.circ.transit.abort',
1262                         egCore.auth.token(), {transitid : transit_id}
1263                     ).then(function(resp) {
1264                         if (evt = egCore.evt.parse(resp)) {
1265                             console.error('abort transit failed: ' + evt);
1266                         }
1267                     })
1268                 );
1269             });
1270
1271             return $q.all(promises);
1272         });
1273     }
1274
1275
1276
1277     // alert when copy location alert_message is set.
1278     // This does not affect processing, it only produces a click-through
1279     service.handle_checkin_loc_alert = function(evt, params, options) {
1280         if (angular.isArray(evt)) evt = evt[0];
1281
1282         var copy = evt && evt.payload ? evt.payload.copy : null;
1283
1284         if (copy && !options.suppress_checkin_popups
1285             && copy.location().checkin_alert() == 't') {
1286
1287             return egAlertDialog.open(
1288                 egCore.strings.LOCATION_ALERT_MSG, {copy : copy}).result;
1289         }
1290
1291         return $q.when();
1292     }
1293
1294     service.handle_checkin_resp = function(evt, params, options) {
1295         if (!angular.isArray(evt)) evt = [evt];
1296
1297         var final_resp = {evt : evt, params : params, options : options};
1298
1299         var copy, hold, transit;
1300         if (evt[0].payload) {
1301             copy = evt[0].payload.copy;
1302             hold = evt[0].payload.hold;
1303             transit = evt[0].payload.transit;
1304         }
1305
1306         // track the barcode regardless of whether it's valid
1307         angular.forEach(evt, function(e){ e.copy_barcode = params.copy_barcode; });
1308
1309         angular.forEach(evt, function(e){ console.debug('checkin event ' + e.textcode); });
1310
1311         if (evt.filter(function(e){return service.checkin_overridable_events.indexOf(e.textcode) > -1;}).length > 0)
1312             return service.handle_overridable_checkin_event(evt, params, options);
1313
1314         switch (evt[0].textcode) {
1315
1316             case 'SUCCESS':
1317             case 'NO_CHANGE':
1318
1319                 switch(Number(copy.status().id())) {
1320
1321                     case 0: /* AVAILABLE */                                        
1322                     case 4: /* MISSING */                                          
1323                     case 7: /* RESHELVING */ 
1324
1325                         egCore.audio.play('success.checkin');
1326
1327                         // see if the copy location requires an alert
1328                         return service.handle_checkin_loc_alert(evt, params, options)
1329                         .then(function() {return final_resp});
1330
1331                     case 8: /* ON HOLDS SHELF */
1332                         egCore.audio.play('info.checkin.holds_shelf');
1333                         
1334                         if (hold) {
1335
1336                             if (hold.pickup_lib() == egCore.auth.user().ws_ou()) {
1337                                 // inform user if the item is on the local holds shelf
1338                             
1339                                 evt[0].route_to = egCore.strings.ROUTE_TO_HOLDS_SHELF;
1340                                 return service.route_dialog(
1341                                     './circ/share/t_hold_shelf_dialog', 
1342                                     evt[0], params, options
1343                                 ).then(function() { return final_resp });
1344
1345                             } else {
1346                                 // normally, if the hold was on the shelf at a 
1347                                 // different location, it would be put into 
1348                                 // transit, resulting in a ROUTE_ITEM event.
1349                                 egCore.audio.play('warning.checkin.wrong_shelf');
1350                                 return $q.when(final_resp);
1351                             }
1352                         } else {
1353
1354                             console.error('checkin: item on holds shelf, '
1355                                 + 'but hold info not returned from checkin');
1356                             return $q.when(final_resp);
1357                         }
1358
1359                     case 11: /* CATALOGING */
1360                         egCore.audio.play('info.checkin.cataloging');
1361                         evt[0].route_to = egCore.strings.ROUTE_TO_CATALOGING;
1362                         return $q.when(final_resp);
1363
1364                     case 15: /* ON_RESERVATION_SHELF */
1365                         egCore.audio.play('info.checkin.reservation');
1366                         // TODO: show booking reservation dialog
1367                         return $q.when(final_resp);
1368
1369                     default:
1370                         egCore.audio.play('error.checkin.unknown');
1371                         console.error('Unhandled checkin copy status: ' 
1372                             + copy.status().id() + ' : ' + copy.status().name());
1373                         return $q.when(final_resp);
1374                 }
1375                 
1376             case 'ROUTE_ITEM':
1377                 return service.route_dialog(
1378                     './circ/share/t_transit_dialog', 
1379                     evt[0], params, options
1380                 ).then(function() { return final_resp });
1381
1382             case 'ASSET_COPY_NOT_FOUND':
1383                 egCore.audio.play('error.checkin.not_found');
1384                 return egAlertDialog.open(
1385                     egCore.strings.UNCAT_ALERT_DIALOG, params)
1386                     .result.then(function() {return final_resp});
1387
1388             case 'ITEM_NOT_CATALOGED':
1389                 egCore.audio.play('error.checkin.not_cataloged');
1390                 evt[0].route_to = egCore.strings.ROUTE_TO_CATALOGING;
1391                 if (options.no_precat_alert) 
1392                     return $q.when(final_resp);
1393                 return egAlertDialog.open(
1394                     egCore.strings.PRECAT_CHECKIN_MSG, params)
1395                     .result.then(function() {return final_resp});
1396
1397             default:
1398                 egCore.audio.play('error.checkin.unknown');
1399                 console.warn('unhandled checkin response : ' + evt[0].textcode);
1400                 return $q.when(final_resp);
1401         }
1402     }
1403
1404     // collect transit, address, and hold info that's not already
1405     // included in responses.
1406     service.collect_route_data = function(tmpl, evt, params, options) {
1407         if (angular.isArray(evt)) evt = evt[0];
1408         var promises = [];
1409         var data = {};
1410
1411         if (evt.org && !tmpl.match(/hold_shelf/)) {
1412             promises.push(
1413                 service.get_org_addr(evt.org, 'holds_address')
1414                 .then(function(addr) { data.address = addr })
1415             );
1416         }
1417
1418         if (evt.payload.hold) {
1419             promises.push(
1420                 egCore.pcrud.retrieve('au', 
1421                     evt.payload.hold.usr(), {
1422                         flesh : 1,
1423                         flesh_fields : {'au' : ['card']}
1424                     }
1425                 ).then(function(patron) {data.patron = patron})
1426             );
1427         }
1428
1429         if (!tmpl.match(/hold_shelf/)) {
1430             promises.push(
1431                 service.find_copy_transit(evt, params, options)
1432                 .then(function(trans) {data.transit = trans})
1433             );
1434         }
1435
1436         return $q.all(promises).then(function() { return data });
1437     }
1438
1439     service.route_dialog = function(tmpl, evt, params, options) {
1440         if (angular.isArray(evt)) evt = evt[0];
1441
1442         return service.collect_route_data(tmpl, evt, params, options)
1443         .then(function(data) {
1444
1445             var template = data.transit ?
1446                 (data.patron ? 'hold_transit_slip' : 'transit_slip') :
1447                 'hold_shelf_slip';
1448             if (service.never_auto_print[template]) {
1449                 // do not show the dialog or print if the
1450                 // disabled automatic print attempt type list includes
1451                 // the specified template
1452                 return;
1453             }
1454
1455             // All actions flow from the print data
1456
1457             var print_context = {
1458                 copy : egCore.idl.toHash(evt.payload.copy),
1459                 title : evt.title,
1460                 author : evt.author
1461             }
1462
1463             if (data.transit) {
1464                 // route_dialog includes the "route to holds shelf" 
1465                 // dialog, which has no transit
1466                 print_context.transit = egCore.idl.toHash(data.transit);
1467                 if (data.address) {
1468                     print_context.dest_address = egCore.idl.toHash(data.address);
1469                 }
1470                 print_context.dest_location =
1471                     egCore.idl.toHash(egCore.org.get(data.transit.dest()));
1472             }
1473
1474             if (data.patron) {
1475                 print_context.hold = egCore.idl.toHash(evt.payload.hold);
1476                 print_context.patron = egCore.idl.toHash(data.patron);
1477             }
1478
1479             var sound = 'info.checkin.transit';
1480             if (evt.payload.hold) sound += '.hold';
1481             egCore.audio.play(sound);
1482
1483             function print_transit(template) {
1484                 return egCore.print.print({
1485                     context : 'default', 
1486                     template : template, 
1487                     scope : print_context
1488                 });
1489             }
1490
1491             // when auto-print is on, skip the dialog and go straight
1492             // to printing.
1493             if (options.auto_print_holds_transits) 
1494                 return print_transit(template);
1495
1496             return $uibModal.open({
1497                 templateUrl: tmpl,
1498                 controller: [
1499                             '$scope','$uibModalInstance',
1500                     function($scope , $uibModalInstance) {
1501
1502                     $scope.today = new Date();
1503
1504                     // copy the print scope into the dialog scope
1505                     angular.forEach(print_context, function(val, key) {
1506                         $scope[key] = val;
1507                     });
1508
1509                     $scope.ok = function() {$uibModalInstance.close()}
1510
1511                     $scope.print = function() { 
1512                         $uibModalInstance.close();
1513                         print_transit(template);
1514                     }
1515                 }]
1516
1517             }).result;
1518         });
1519     }
1520
1521     // action == what action to take if the user confirms the alert
1522     service.copy_alert_dialog = function(evt, params, options, action) {
1523         if (angular.isArray(evt)) evt = evt[0];
1524         return egConfirmDialog.open(
1525             egCore.strings.COPY_ALERT_MSG_DIALOG_TITLE, 
1526             evt.payload,  // payload == alert message text
1527             {   copy_barcode : params.copy_barcode,
1528                 ok : function() {},
1529                 cancel : function() {}
1530             }
1531         ).result.then(function() {
1532             options.override = true;
1533             return service[action](params, options);
1534         });
1535     }
1536
1537     // action == what action to take if the user confirms the alert
1538     service.hold_capture_delay_dialog = function(evt, params, options, action) {
1539         if (angular.isArray(evt)) evt = evt[0];
1540         return $uibModal.open({
1541             templateUrl: './circ/checkin/t_hold_verify',
1542             controller:
1543                        ['$scope','$uibModalInstance','params',
1544                 function($scope , $uibModalInstance , params) {
1545                 $scope.copy_barcode = params.copy_barcode;
1546                 $scope.capture = function() {
1547                     params.capture = 'capture';
1548                     $uibModalInstance.close();
1549                 };
1550                 $scope.nocapture = function() {
1551                     params.capture = 'nocapture';
1552                     $uibModalInstance.close();
1553                 };
1554                 $scope.cancel = function() { $uibModalInstance.dismiss(); };
1555             }],
1556             resolve : {
1557                 params : function() {
1558                     return params;
1559                 }
1560             }
1561         }).result.then(
1562             function(r) {
1563                 return service[action](params, options);
1564             }
1565         );
1566     }
1567
1568     // check the barcode.  If it's no good, show the warning dialog
1569     // Resolves on success, rejected on error
1570     service.test_barcode = function(bc) {
1571
1572         var ok = service.check_barcode(bc);
1573         if (ok) return $q.when();
1574
1575         egCore.audio.play('warning.circ.bad_barcode');
1576         return $uibModal.open({
1577             templateUrl: './circ/share/t_bad_barcode_dialog',
1578             controller: 
1579                 ['$scope', '$uibModalInstance', 
1580                 function($scope, $uibModalInstance) {
1581                 $scope.barcode = bc;
1582                 $scope.ok = function() { $uibModalInstance.close() }
1583                 $scope.cancel = function() { $uibModalInstance.dismiss() }
1584             }]
1585         }).result;
1586     }
1587
1588     // check() and checkdigit() copied directly 
1589     // from chrome/content/util/barcode.js
1590
1591     service.check_barcode = function(bc) {
1592         if (bc != Number(bc)) return false;
1593         bc = bc.toString();
1594         // "16.00" == Number("16.00"), but the . is bad.
1595         // Throw out any barcode that isn't just digits
1596         if (bc.search(/\D/) != -1) return false;
1597         var last_digit = bc.substr(bc.length-1);
1598         var stripped_barcode = bc.substr(0,bc.length-1);
1599         return service.barcode_checkdigit(stripped_barcode).toString() == last_digit;
1600     }
1601
1602     service.barcode_checkdigit = function(bc) {
1603         var reverse_barcode = bc.toString().split('').reverse();
1604         var check_sum = 0; var multiplier = 2;
1605         for (var i = 0; i < reverse_barcode.length; i++) {
1606             var digit = reverse_barcode[i];
1607             var product = digit * multiplier; product = product.toString();
1608             var temp_sum = 0;
1609             for (var j = 0; j < product.length; j++) {
1610                 temp_sum += Number( product[j] );
1611             }
1612             check_sum += Number( temp_sum );
1613             multiplier = ( multiplier == 2 ? 1 : 2 );
1614         }
1615         check_sum = check_sum.toString();
1616         var next_multiple_of_10 = (check_sum.match(/(\d*)\d$/)[1] * 10) + 10;
1617         var check_digit = next_multiple_of_10 - Number(check_sum);
1618         if (check_digit == 10) check_digit = 0;
1619         return check_digit;
1620     }
1621
1622     service.handle_barcode_completion = function(barcode) {
1623         return egCore.net.request(
1624             'open-ils.actor',
1625             'open-ils.actor.get_barcodes',
1626             egCore.auth.token(), egCore.auth.user().ws_ou(), 
1627             'asset', barcode)
1628
1629         .then(function(resp) {
1630             // TODO: handle event during barcode lookup
1631             if (evt = egCore.evt.parse(resp)) {
1632                 console.error(evt.toString());
1633                 return $q.reject();
1634             }
1635
1636             // no matching barcodes: return the barcode as entered
1637             // by the user (so that, e.g., checkout can fall back to
1638             // precat/noncat handling)
1639             if (!resp || !resp[0]) {
1640                 return barcode;
1641             }
1642
1643             // exactly one matching barcode: return it
1644             if (resp.length == 1) {
1645                 return resp[0].barcode;
1646             }
1647
1648             // multiple matching barcodes: let the user pick one 
1649             console.debug('multiple matching barcodes');
1650             var matches = [];
1651             var promises = [];
1652             var final_barcode;
1653             angular.forEach(resp, function(cp) {
1654                 promises.push(
1655                     egCore.net.request(
1656                         'open-ils.circ',
1657                         'open-ils.circ.copy_details.retrieve',
1658                         egCore.auth.token(), cp.id
1659                     ).then(function(r) {
1660                         matches.push({
1661                             barcode: r.copy.barcode(),
1662                             title: r.mvr.title(),
1663                             org_name: egCore.org.get(r.copy.circ_lib()).name(),
1664                             org_shortname: egCore.org.get(r.copy.circ_lib()).shortname()
1665                         });
1666                     })
1667                 );
1668             });
1669             return $q.all(promises)
1670             .then(function() {
1671                 return $uibModal.open({
1672                     templateUrl: './circ/share/t_barcode_choice_dialog',
1673                     controller:
1674                         ['$scope', '$uibModalInstance',
1675                         function($scope, $uibModalInstance) {
1676                         $scope.matches = matches;
1677                         $scope.ok = function(barcode) {
1678                             $uibModalInstance.close();
1679                             final_barcode = barcode;
1680                         }
1681                         $scope.cancel = function() {$uibModalInstance.dismiss()}
1682                     }],
1683                 }).result.then(function() { return final_barcode });
1684             })
1685         });
1686     }
1687
1688     service.create_penalty = function(user_id) {
1689         return $uibModal.open({
1690             templateUrl: './circ/share/t_new_message_dialog',
1691             controller: 
1692                    ['$scope','$uibModalInstance','staffPenalties',
1693             function($scope , $uibModalInstance , staffPenalties) {
1694                 $scope.focusNote = true;
1695                 $scope.penalties = staffPenalties;
1696                 $scope.require_initials = service.require_initials;
1697                 $scope.args = {penalty : 21}; // default to Note
1698                 $scope.setPenalty = function(id) {
1699                     args.penalty = id;
1700                 }
1701                 $scope.ok = function(count) { $uibModalInstance.close($scope.args) }
1702                 $scope.cancel = function($event) { 
1703                     $uibModalInstance.dismiss();
1704                     $event.preventDefault();
1705                 }
1706             }],
1707             resolve : { staffPenalties : service.get_staff_penalty_types }
1708         }).result.then(
1709             function(args) {
1710                 var pen = new egCore.idl.ausp();
1711                 pen.usr(user_id);
1712                 pen.org_unit(egCore.auth.user().ws_ou());
1713                 pen.note(args.note);
1714                 if (args.initials) pen.note(args.note + ' [' + args.initials + ']');
1715                 if (args.custom_penalty) {
1716                     pen.standing_penalty(args.custom_penalty);
1717                 } else {
1718                     pen.standing_penalty(args.penalty);
1719                 }
1720                 pen.staff(egCore.auth.user().id());
1721                 pen.set_date('now');
1722                 return egCore.pcrud.create(pen);
1723             }
1724         );
1725     }
1726
1727     // assumes, for now anyway,  penalty type is fleshed onto usr_penalty.
1728     service.edit_penalty = function(usr_penalty) {
1729         return $uibModal.open({
1730             templateUrl: './circ/share/t_new_message_dialog',
1731             controller: 
1732                    ['$scope','$uibModalInstance','staffPenalties',
1733             function($scope , $uibModalInstance , staffPenalties) {
1734                 $scope.focusNote = true;
1735                 $scope.penalties = staffPenalties;
1736                 $scope.require_initials = service.require_initials;
1737                 $scope.args = {
1738                     penalty : usr_penalty.standing_penalty().id(),
1739                     note : usr_penalty.note()
1740                 }
1741                 $scope.setPenalty = function(id) { args.penalty = id; }
1742                 $scope.ok = function(count) { $uibModalInstance.close($scope.args) }
1743                 $scope.cancel = function($event) { 
1744                     $uibModalInstance.dismiss();
1745                     $event.preventDefault();
1746                 }
1747             }],
1748             resolve : { staffPenalties : service.get_staff_penalty_types }
1749         }).result.then(
1750             function(args) {
1751                 usr_penalty.note(args.note);
1752                 if (args.initials) usr_penalty.note(args.note + ' [' + args.initials + ']');
1753                 usr_penalty.standing_penalty(args.penalty);
1754                 return egCore.pcrud.update(usr_penalty);
1755             }
1756         );
1757     }
1758
1759     return service;
1760
1761 }]);
1762
1763