2 * List of patron items checked out
5 angular.module('egPatronApp')
7 .controller('PatronItemsOutCtrl',
8 ['$scope','$q','$routeParams','$timeout','egCore','egUser','patronSvc',
9 '$location','egGridDataProvider','$uibModal','egCirc','egConfirmDialog',
10 'egBilling','$window','egBibDisplay',
11 function($scope , $q , $routeParams , $timeout , egCore , egUser , patronSvc ,
12 $location , egGridDataProvider , $uibModal , egCirc , egConfirmDialog ,
13 egBilling , $window , egBibDisplay) {
15 // list of noncatatloged circulations. Define before initTab to
16 // avoid any possibility of race condition, since they are loaded
17 // during init, but may be referenced before init completes.
18 $scope.noncat_list = [];
20 $scope.initTab('items_out', $routeParams.id).then(function() {
21 // sort inline to support paging
22 $scope.noncat_list = patronSvc.noncat_ids.sort();
25 // cache of circ objects for grid display
26 patronSvc.items_out = [];
28 // main list of checked out items
29 $scope.main_list = [];
31 // list of alt circs (lost, etc.) and/or check-in with fines circs
35 'ui.circ.suppress_checkin_popups' // add other settings as needed
36 ]).then(function(set) {
37 $scope.suppress_popups = set['ui.circ.suppress_checkin_popups'];
40 // these are fetched during startup (i.e. .configure())
41 // By default, show lost/lo/cr items in the alt list
42 var display_lost = Number(
43 egCore.env.aous['ui.circ.items_out.lost']) || 2;
44 var display_lo = Number(
45 egCore.env.aous['ui.circ.items_out.longoverdue']) || 2;
46 var display_cr = Number(
47 egCore.env.aous['ui.circ.items_out.claimsreturned']) || 2;
49 var fetch_checked_in = true;
50 $scope.show_alt_circs = true;
51 if (display_lost & 4 && display_lo & 4 && display_cr & 4) {
52 // all special types are configured to be hidden once
53 // checked in, so there's no need to fetch checked-in circs.
54 fetch_checked_in = false;
56 if (display_lost & 1 && display_lo & 1 && display_cr & 1) {
57 // additionally, if all types are configured to display
58 // in the main list while checked out, nothing will
59 // ever appear in the alternate list, so we can hide
60 // the alternate list from the UI.
61 $scope.show_alt_circs = false;
65 $scope.items_out_display = 'main';
66 $scope.show_main_list = function(refresh_grid) {
67 // don't need a full reset_page() to swap tabs
68 $scope.items_out_display = 'main';
69 patronSvc.items_out = [];
70 // only refresh the grid when navigating from a tab that
71 // shares the same grid.
72 if (refresh_grid) provider.refresh();
75 $scope.show_alt_list = function(refresh_grid) {
76 // don't need a full reset_page() to swap tabs
77 $scope.items_out_display = 'alt';
78 patronSvc.items_out = [];
79 // only refresh the grid when navigating from a tab that
80 // shares the same grid.
81 if (refresh_grid) provider.refresh();
84 $scope.show_noncat_list = function() {
85 // don't need a full reset_page() to swap tabs
86 $scope.items_out_display = 'noncat';
87 patronSvc.items_out = [];
88 // Grid refresh is not necessary because switching to the
89 // noncat_list always involves instantiating a new grid.
92 // Reload the user to pick up changes in items out, fines, etc.
93 // Reload circs since the contents of the main vs. alt list may
95 function reset_page() {
96 patronSvc.refreshPrimary();
97 patronSvc.items_out = [];
98 $scope.main_list = [];
100 $timeout(provider.refresh); // allow scope changes to propagate
103 var provider = egGridDataProvider.instance({});
104 $scope.gridDataProvider = provider;
106 function fetch_circs(id_list, offset, count) {
107 if (!id_list.length || id_list.length < offset + 1) return $q.when();
109 var deferred = $q.defer();
112 // fetch the lot of circs and stream the results back via notify
113 egCore.pcrud.search('circ', {id : id_list},
116 circ : ['target_copy', 'workstation', 'checkin_workstation'],
117 acp : ['call_number', 'holds_count', 'status', 'circ_lib', 'location', 'floating', 'age_protect', 'parts'],
119 acn : ['record', 'owning_lib', 'prefix', 'suffix'],
120 bre : ['wide_display_entry']
122 // avoid fetching the MARC blob by specifying which
123 // fields on the bre to select. More may be needed.
124 // note that fleshed fields are explicitly selected.
125 select : { bre : ['id'] },
126 // TODO: LP#1697954 Fetch all circs on grid render
127 // to support client-side sorting. Migrate to server-side
128 // sorting to avoid the need for fetching all items.
131 // we need an order-by to support paging
132 order_by : {circ : ['xact_start']}
134 }).then(deferred.resolve, null, function(circ) {
135 circ.circ_lib(egCore.org.get(circ.circ_lib())); // local fleshing
137 // Translate bib display field JSON blobs to JS.
138 // Collapse multi/array fields down to comma-separated strings.
139 egBibDisplay.mwdeJSONToJS(
140 circ.target_copy().call_number().record().wide_display_entry(), true);
142 if (circ.target_copy().call_number().id() == -1) {
143 // dummy-up a record for precat items
144 circ.target_copy().call_number().record().wide_display_entry({
145 title : function() {return circ.target_copy().dummy_title()},
146 author : function() {return circ.target_copy().dummy_author()},
147 isbn : function() {return circ.target_copy().dummy_isbn()}
150 circ._parts = circ.target_copy().parts().map(function(part) {
154 // call open-ils to get overdue notice count and Last notice date
158 'open-ils.actor.user.itemsout.notices',
159 egCore.auth.token(), circ.id(), $scope.patron_id)
160 .then(function(notice){
161 if (notice.numNotices){
162 circ.action_trigger_event_count = notice.numNotices;
163 circ.action_trigger_latest_event_date = notice.lastDt;
165 patronSvc.items_out.push(circ);
168 if (rendered++ >= offset && rendered <= count){ deferred.notify(circ) };
171 return deferred.promise;
174 function fetch_noncat_circs(id_list, offset, count) {
175 if (!id_list.length) return $q.when();
177 var deferred = $q.defer();
180 egCore.pcrud.search('ancc', {id : id_list},
182 flesh_fields : {ancc : ['item_type','staff']},
183 // TODO: LP#1697954 Fetch all circs on grid render
184 // to support client-side sorting. Migrate to server-side
185 // sorting to avoid the need for fetching all items.
188 // we need an order-by to support paging
189 order_by : {circ : ['circ_time']}
191 }).then(deferred.resolve, null, function(noncat_circ) {
193 // calculate the virtual due date from the item type duration
194 var seconds = egCore.date.intervalToSeconds(
195 noncat_circ.item_type().circ_duration());
196 var d = new Date(Date.parse(noncat_circ.circ_time()));
197 d.setSeconds(d.getSeconds() + seconds);
198 noncat_circ.duedate(d.toISOString());
200 // local flesh org unit
201 noncat_circ.circ_lib(egCore.org.get(noncat_circ.circ_lib()));
203 patronSvc.items_out.push(noncat_circ); // cache it
205 // We fetch all noncat circs for client-side sorting, but
206 // only notify the caller for the page of requested circs.
207 if (rendered++ >= offset && rendered <= count)
208 deferred.notify(noncat_circ);
211 return deferred.promise;
215 // decide which list each circ belongs to
216 function promote_circs(list, display_code, open) {
218 if (1 & display_code) { // bitflag 1 == top list
219 $scope.main_list = $scope.main_list.concat(list);
221 $scope.alt_list = $scope.alt_list.concat(list);
224 if (4 & display_code) return; // bitflag 4 == hide on checkin
225 $scope.alt_list = $scope.alt_list.concat(list);
229 // fetch IDs for circs we care about
230 function get_circ_ids() {
231 $scope.main_list = [];
232 $scope.alt_list = [];
234 // we can fetch these in parallel
235 var promise1 = egCore.net.request(
237 'open-ils.actor.user.checked_out.authoritative',
238 egCore.auth.token(), $scope.patron_id
239 ).then(function(outs) {
240 $scope.main_list = outs.overdue.concat(outs.out);
241 promote_circs(outs.lost, display_lost, true);
242 promote_circs(outs.long_overdue, display_lo, true);
243 promote_circs(outs.claims_returned, display_cr, true);
246 // only fetched checked-in-with-bills circs if configured to display
247 var promise2 = !fetch_checked_in ? $q.when() : egCore.net.request(
249 'open-ils.actor.user.checked_in_with_fines.authoritative',
250 egCore.auth.token(), $scope.patron_id
251 ).then(function(outs) {
252 promote_circs(outs.lost, display_lost);
253 promote_circs(outs.long_overdue, display_lo);
254 promote_circs(outs.claims_returned, display_cr);
257 return $q.all([promise1, promise2]);
260 provider.get = function(offset, count) {
262 var id_list = $scope[$scope.items_out_display + '_list'];
264 // see if we have the requested range cached
265 // Note this items_out list is reset w/ each items-out tab change
266 if (patronSvc.items_out[offset]) {
267 return provider.arrayNotifier(
268 patronSvc.items_out, offset, count);
271 if ($scope.items_out_display == 'noncat') {
272 // if there are any noncat circ IDs, we already have them
273 return fetch_noncat_circs(id_list, offset, count);
276 // See if we have the circ IDs for this range already loaded.
277 // this would happen navigating to a subsequent page.
278 if (id_list[offset]) {
279 return fetch_circs(id_list, offset, count);
282 // avoid returning the request directly to the caller so the
283 // notify()'s from egCore.net.request don't leak into the
284 // final set of notifies (i.e. the real responses);
286 var deferred = $q.defer();
287 get_circ_ids().then(function() {
289 id_list = $scope[$scope.items_out_display + '_list'];
290 $scope.gridDataProvider.grid.totalCount = id_list.length;
291 // relay the notified circs back to the grid through our promise
292 fetch_circs(id_list, offset, count).then(
293 deferred.resolve, null, deferred.notify);
296 return deferred.promise;
300 // true if circ is overdue, false otherwise
301 $scope.circIsOverdue = function(circ) {
302 // circ may not exist yet for rendered row
303 if (!circ) return false;
305 var date = new Date();
306 date.setTime(Date.parse(circ.due_date()));
307 return date < new Date();
310 $scope.edit_due_date = function(items) {
311 if (!items.length) return;
314 templateUrl : './circ/patron/t_edit_due_date_dialog',
317 '$scope','$uibModalInstance',
318 function($scope , $uibModalInstance) {
320 // if there is only one circ, default to the due date
321 // of that circ. Otherwise, default to today.
322 var due_date = items.length == 1 ?
323 Date.parse(items[0].due_date()) : new Date();
326 num_circs : items.length,
330 // Fire off the due-date updater for each circ.
331 // When all is done, close the dialog
332 $scope.ok = function(args) {
333 var due = $scope.args.due_date.toISOString();
334 console.debug("applying due date of " + due);
337 angular.forEach(items, function(circ) {
341 'open-ils.circ.circulation.due_date.update',
342 egCore.auth.token(), circ.id(), due
344 ).then(function(new_circ) {
345 // update the grid circ with the canonical
346 // date from the modified circulation.
347 circ.due_date(new_circ.due_date());
352 $q.all(promises).then(function() {
353 $uibModalInstance.close();
357 $scope.cancel = function($event) {
358 $uibModalInstance.dismiss();
359 $event.preventDefault();
366 $scope.print_receipt = function(items) {
367 if (items.length == 0) return $q.when();
368 var print_data = {circulations : []};
369 var cusr = patronSvc.current;
371 angular.forEach(items, function(circ) {
372 print_data.circulations.push({
373 circ : egCore.idl.toHash(circ),
374 copy : egCore.idl.toHash(circ.target_copy()),
375 call_number : egCore.idl.toHash(circ.target_copy().call_number()),
376 title : circ.target_copy().call_number().record().wide_display_entry().title(),
377 author : circ.target_copy().call_number().record().wide_display_entry().author()
381 print_data.patron = {
382 prefix : cusr.prefix(),
383 first_given_name : cusr.first_given_name(),
384 second_given_name : cusr.second_given_name(),
385 family_name : cusr.family_name(),
386 suffix : cusr.suffix(),
387 pref_prefix : cusr.pref_prefix(),
388 pref_first_given_name : cusr.pref_first_given_name(),
389 pref_second_given_name : cusr.pref_second_given_name(),
390 pref_family_name : cusr.pref_family_name(),
391 pref_suffix : cusr.pref_suffix(),
392 card : { barcode : cusr.card().barcode() },
393 money_summary : patronSvc.patron_stats.fines,
394 expire_date : cusr.expire_date(),
395 alias : cusr.alias(),
396 has_email : Boolean(patronSvc.current.email() && patronSvc.current.email().match(/.*@.*/)),
397 has_phone : Boolean(cusr.day_phone() || cusr.evening_phone() || cusr.other_phone())
400 return egCore.print.print({
402 template : 'items_out',
407 function batch_action_with_flat_copies(items, action) {
408 if (!items.length) return;
409 var copies = items.map(function(circ)
410 { return egCore.idl.toHash(circ.target_copy()) });
411 action(copies).then(reset_page);
413 function batch_action_with_barcodes(items, action) {
414 if (!items.length) return;
415 var barcodes = items.map(function(circ)
416 { return circ.target_copy().barcode() });
417 action(barcodes).then(reset_page);
419 $scope.mark_damaged = function(items) {
420 if (items.length == 0) return;
422 angular.forEach(items, function(circ) {
423 egCirc.mark_damaged({
424 id: circ.target_copy().id(),
425 barcode: circ.target_copy().barcode(),
426 circ_lib: circ.target_copy().circ_lib().id()
427 }).then(() => $timeout(reset_page,1000)) // reset after each, because rejecting one stops the $q.all() chain
430 $scope.mark_missing = function(items) {
431 batch_action_with_flat_copies(items, egCirc.mark_missing);
433 $scope.mark_lost = function(items) {
434 batch_action_with_barcodes(items, egCirc.mark_lost);
436 $scope.mark_claims_returned = function(items) {
437 batch_action_with_barcodes(items, egCirc.mark_claims_returned_dialog);
439 $scope.mark_claims_never_checked_out = function(items) {
440 batch_action_with_barcodes(items, egCirc.mark_claims_never_checked_out);
443 $scope.show_recent_circs = function(items) {
444 var focus = items.length == 1;
445 angular.forEach(items, function(item) {
446 var url = egCore.env.basePath +
448 item.target_copy().id() +
450 $timeout(function() { var x = $window.open(url, '_blank'); if (focus) x.focus() });
454 $scope.show_triggered_events = function(items) {
455 var focus = items.length == 1;
456 angular.forEach(items, function(item) {
457 var url = egCore.env.basePath +
459 item.target_copy().id() +
461 $timeout(function() { var x = $window.open(url, '_blank'); if (focus) x.focus() });
465 $scope.renew = function(items, msg) {
466 if (!items.length) return;
467 var barcodes = items.map(function(circ)
468 { return circ.target_copy().barcode() });
470 if (!msg) msg = egCore.strings.RENEW_ITEMS;
472 return egConfirmDialog.open(msg, barcodes.join(' '), {}).result
475 var bc = barcodes.pop();
476 if (!bc) { reset_page(); return }
477 // finally -> continue even when one fails
478 egCirc.renew({copy_barcode : bc}).finally(do_one);
484 $scope.renew_all = function() {
485 var circs = patronSvc.items_out.filter(function(circ) {
487 // all others will be rejected at the server
488 !circ.stop_fines() ||
489 circ.stop_fines() == 'MAXFINES'
492 $scope.renew(circs, egCore.strings.RENEW_ALL_ITEMS);
495 $scope.renew_with_date = function(items) {
496 if (!items.length) return;
497 var barcodes = items.map(function(circ)
498 { return circ.target_copy().barcode() });
500 return $uibModal.open({
501 templateUrl : './circ/patron/t_renew_with_date_dialog',
504 '$scope','$uibModalInstance',
505 function($scope , $uibModalInstance) {
506 var now = new Date();
507 $scope.outOfRange = false;
508 $scope.minDate = new Date(now);
513 $scope.cancel = function() {$uibModalInstance.dismiss()}
515 // Fire off the due-date updater for each circ.
516 // When all is done, close the dialog
517 $scope.ok = function() {
518 var due = $scope.args.date.toISOString().replace(/T.*/,'');
519 console.debug("renewing with due date: " + due);
522 if (bc = barcodes.pop()) {
523 egCirc.renew({copy_barcode : bc, due_date : due})
526 $uibModalInstance.close();
530 do_one(); // kick it off
537 $scope.checkin = function(items) {
538 if (!items.length) return;
539 var copies = items.map(function(circ) { return circ.target_copy() });
540 var barcodes = copies.map(function(copy) { return copy.barcode() });
544 if (copy = copies.pop()) {
545 // Checkin expects a barcode, but will pass other
546 // parameters too. Passing the copy ID allows
547 // for the checkin of deleted copies on the server.
549 {copy_barcode: copy.barcode(), copy_id: copy.id()},
550 {suppress_popups: $scope.suppress_popups})
556 if ($scope.suppress_popups) {
559 return egConfirmDialog.open(
560 egCore.strings.CHECK_IN_CONFIRM, barcodes.join(' '), {
562 }).result.then(function() {
563 do_one(); // kick it off
568 $scope.add_billing = function(items) {
569 if (!items.length) return;
570 var circs = items.concat(); // don't pop from grid array
572 var circ; // don't clobber window.circ!
573 if (circ = circs.pop()) {
574 egBilling.showBillDialog({
575 // let the dialog fetch the transaction, since it's
576 // not sufficiently fleshed here.
578 patron : patronSvc.current