Open-ILS/web/js/ui/default/staff/circ/patron/items_out.js

   1 /**
   2  * List of patron items checked out
   3  */
   4
   5 angular.module('egPatronApp')
   6
   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) {
  14
  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 = [];
  19
  20     $scope.initTab('items_out', $routeParams.id).then(function() {
  21         // sort inline to support paging
  22         $scope.noncat_list = patronSvc.noncat_ids.sort();
  23     });
  24
  25     // cache of circ objects for grid display
  26     patronSvc.items_out = [];
  27
  28     // main list of checked out items
  29     $scope.main_list = [];
  30
  31     // list of alt circs (lost, etc.) and/or check-in with fines circs
  32     $scope.alt_list = [];
  33
  34     // these are fetched during startup (i.e. .configure())
  35     // By default, show lost/lo/cr items in the alt list
  36     var display_lost = Number(
  37         egCore.env.aous['ui.circ.items_out.lost']) || 2;
  38     var display_lo = Number(
  39         egCore.env.aous['ui.circ.items_out.longoverdue']) || 2;
  40     var display_cr = Number(
  41         egCore.env.aous['ui.circ.items_out.claimsreturned']) || 2;
  42
  43     var fetch_checked_in = true;
  44     $scope.show_alt_circs = true;
  45     if (display_lost & 4 && display_lo & 4 && display_cr & 4) {
  46         // all special types are configured to be hidden once
  47         // checked in, so there's no need to fetch checked-in circs.
  48         fetch_checked_in = false;
  49
  50         if (display_lost & 1 && display_lo & 1 && display_cr & 1) {
  51             // additionally, if all types are configured to display
  52             // in the main list while checked out, nothing will
  53             // ever appear in the alternate list, so we can hide
  54             // the alternate list from the UI.
  55             $scope.show_alt_circs = false;
  56         }
  57     }
  58
  59     $scope.items_out_display = 'main';
  60     $scope.show_main_list = function(refresh_grid) {
  61         // don't need a full reset_page() to swap tabs
  62         $scope.items_out_display = 'main';
  63         patronSvc.items_out = [];
  64         // only refresh the grid when navigating from a tab that
  65         // shares the same grid.
  66         if (refresh_grid) provider.refresh();
  67     }
  68
  69     $scope.show_alt_list = function(refresh_grid) {
  70         // don't need a full reset_page() to swap tabs
  71         $scope.items_out_display = 'alt';
  72         patronSvc.items_out = [];
  73         // only refresh the grid when navigating from a tab that
  74         // shares the same grid.
  75         if (refresh_grid) provider.refresh();
  76     }
  77
  78     $scope.show_noncat_list = function() {
  79         // don't need a full reset_page() to swap tabs
  80         $scope.items_out_display = 'noncat';
  81         patronSvc.items_out = [];
  82         // Grid refresh is not necessary because switching to the
  83         // noncat_list always involves instantiating a new grid.
  84     }
  85
  86     // Reload the user to pick up changes in items out, fines, etc.
  87     // Reload circs since the contents of the main vs. alt list may
  88     // have changed.
  89     function reset_page() {
  90         patronSvc.refreshPrimary();
  91         patronSvc.items_out = [];
  92         $scope.main_list = [];
  93         $scope.alt_list = [];
  94         $timeout(provider.refresh);  // allow scope changes to propagate
  95     }
  96
  97     var provider = egGridDataProvider.instance({});
  98     $scope.gridDataProvider = provider;
  99
 100     function fetch_circs(id_list, offset, count) {
 101         if (!id_list.length || id_list.length < offset + 1) return $q.when();
 102
 103         var deferred = $q.defer();
 104         var rendered = 0;
 105
 106         // fetch the lot of circs and stream the results back via notify
 107         egCore.pcrud.search('circ', {id : id_list},
 108             {   flesh : 4,
 109                 flesh_fields : {
 110                     circ : ['target_copy', 'workstation', 'checkin_workstation'],
 111                     acp : ['call_number', 'holds_count', 'status', 'circ_lib'],
 112                     acn : ['record', 'owning_lib', 'prefix', 'suffix'],
 113                     bre : ['wide_display_entry']
 114                 },
 115                 // avoid fetching the MARC blob by specifying which
 116                 // fields on the bre to select.  More may be needed.
 117                 // note that fleshed fields are explicitly selected.
 118                 select : { bre : ['id'] },
 119                 // TODO: LP#1697954 Fetch all circs on grid render
 120                 // to support client-side sorting.  Migrate to server-side
 121                 // sorting to avoid the need for fetching all items.
 122                 //limit  : count,
 123                 //offset : offset,
 124                 // we need an order-by to support paging
 125                 order_by : {circ : ['xact_start']}
 126
 127         }).then(deferred.resolve, null, function(circ) {
 128             circ.circ_lib(egCore.org.get(circ.circ_lib())); // local fleshing
 129
 130             // Translate bib display field JSON blobs to JS.
 131             // Collapse multi/array fields down to comma-separated strings.
 132             egBibDisplay.mwdeJSONToJS(
 133                 circ.target_copy().call_number().record().wide_display_entry(), true);
 134
 135             if (circ.target_copy().call_number().id() == -1) {
 136                 // dummy-up a record for precat items
 137                 circ.target_copy().call_number().record().wide_display_entry({
 138                     title : function() {return circ.target_copy().dummy_title()},
 139                     author : function() {return circ.target_copy().dummy_author()},
 140                     isbn : function() {return circ.target_copy().dummy_isbn()}
 141                 })
 142             }
 143
 144             // call open-ils to get overdue notice count and  Last notice date
 145
 146            egCore.net.request(
 147                'open-ils.actor',
 148                'open-ils.actor.user.itemsout.notices',
 149                egCore.auth.token(), circ.id(), $scope.patron_id)
 150            .then(function(notice){
 151                if (notice.numNotices){
 152                    circ.action_trigger_event_count = notice.numNotices;
 153                    circ.action_trigger_latest_event_date = notice.lastDt;
 154                }
 155                patronSvc.items_out.push(circ);
 156            });
 157
 158                if (rendered++ >= offset && rendered <= count){ deferred.notify(circ) };
 159         });
 160
 161         return deferred.promise;
 162     }
 163
 164     function fetch_noncat_circs(id_list, offset, count) {
 165         if (!id_list.length) return $q.when();
 166
 167         var deferred = $q.defer();
 168         var rendered = 0;
 169
 170         egCore.pcrud.search('ancc', {id : id_list},
 171             {   flesh : 1,
 172                 flesh_fields : {ancc : ['item_type','staff']},
 173                 // TODO: LP#1697954 Fetch all circs on grid render
 174                 // to support client-side sorting.  Migrate to server-side
 175                 // sorting to avoid the need for fetching all items.
 176                 //limit  : count,
 177                 //offset : offset,
 178                 // we need an order-by to support paging
 179                 order_by : {circ : ['circ_time']}
 180
 181         }).then(deferred.resolve, null, function(noncat_circ) {
 182
 183             // calculate the virtual due date from the item type duration
 184             var seconds = egCore.date.intervalToSeconds(
 185                 noncat_circ.item_type().circ_duration());
 186             var d = new Date(Date.parse(noncat_circ.circ_time()));
 187             d.setSeconds(d.getSeconds() + seconds);
 188             noncat_circ.duedate(d.toISOString());
 189
 190             // local flesh org unit
 191             noncat_circ.circ_lib(egCore.org.get(noncat_circ.circ_lib()));
 192
 193             patronSvc.items_out.push(noncat_circ); // cache it
 194
 195             // We fetch all noncat circs for client-side sorting, but
 196             // only notify the caller for the page of requested circs.
 197             if (rendered++ >= offset && rendered <= count)
 198                 deferred.notify(noncat_circ);
 199         });
 200
 201         return deferred.promise;
 202     }
 203
 204
 205     // decide which list each circ belongs to
 206     function promote_circs(list, display_code, open) {
 207         if (open) {
 208             if (1 & display_code) { // bitflag 1 == top list
 209                 $scope.main_list = $scope.main_list.concat(list);
 210             } else {
 211                 $scope.alt_list = $scope.alt_list.concat(list);
 212             }
 213         } else {
 214             if (4 & display_code) return;  // bitflag 4 == hide on checkin
 215             $scope.alt_list = $scope.alt_list.concat(list);
 216         }
 217     }
 218
 219     // fetch IDs for circs we care about
 220     function get_circ_ids() {
 221         $scope.main_list = [];
 222         $scope.alt_list = [];
 223
 224         // we can fetch these in parallel
 225         var promise1 = egCore.net.request(
 226             'open-ils.actor',
 227             'open-ils.actor.user.checked_out.authoritative',
 228             egCore.auth.token(), $scope.patron_id
 229         ).then(function(outs) {
 230             $scope.main_list = outs.overdue.concat(outs.out);
 231             promote_circs(outs.lost, display_lost, true);
 232             promote_circs(outs.long_overdue, display_lo, true);
 233             promote_circs(outs.claims_returned, display_cr, true);
 234         });
 235
 236         // only fetched checked-in-with-bills circs if configured to display
 237         var promise2 = !fetch_checked_in ? $q.when() : egCore.net.request(
 238             'open-ils.actor',
 239             'open-ils.actor.user.checked_in_with_fines.authoritative',
 240             egCore.auth.token(), $scope.patron_id
 241         ).then(function(outs) {
 242             promote_circs(outs.lost, display_lost);
 243             promote_circs(outs.long_overdue, display_lo);
 244             promote_circs(outs.claims_returned, display_cr);
 245         });
 246
 247         return $q.all([promise1, promise2]);
 248     }
 249
 250     provider.get = function(offset, count) {
 251
 252         var id_list = $scope[$scope.items_out_display + '_list'];
 253
 254         // see if we have the requested range cached
 255         // Note this items_out list is reset w/ each items-out tab change
 256         if (patronSvc.items_out[offset]) {
 257             return provider.arrayNotifier(
 258                 patronSvc.items_out, offset, count);
 259         }
 260
 261         if ($scope.items_out_display == 'noncat') {
 262             // if there are any noncat circ IDs, we already have them
 263             return fetch_noncat_circs(id_list, offset, count);
 264         }
 265
 266         // See if we have the circ IDs for this range already loaded.
 267         // this would happen navigating to a subsequent page.
 268         if (id_list[offset]) {
 269             return fetch_circs(id_list, offset, count);
 270         }
 271
 272         // avoid returning the request directly to the caller so the
 273         // notify()'s from egCore.net.request don't leak into the
 274         // final set of notifies (i.e. the real responses);
 275
 276         var deferred = $q.defer();
 277         get_circ_ids().then(function() {
 278
 279             id_list = $scope[$scope.items_out_display + '_list'];
 280             $scope.gridDataProvider.grid.totalCount = id_list.length;
 281             // relay the notified circs back to the grid through our promise
 282             fetch_circs(id_list, offset, count).then(
 283                 deferred.resolve, null, deferred.notify);
 284         });
 285
 286         return deferred.promise;
 287     }
 288
 289
 290     // true if circ is overdue, false otherwise
 291     $scope.circIsOverdue = function(circ) {
 292         // circ may not exist yet for rendered row
 293         if (!circ) return false;
 294
 295         var date = new Date();
 296         date.setTime(Date.parse(circ.due_date()));
 297         return date < new Date();
 298     }
 299
 300     $scope.edit_due_date = function(items) {
 301         if (!items.length) return;
 302
 303         $uibModal.open({
 304             templateUrl : './circ/patron/t_edit_due_date_dialog',
 305             backdrop: 'static',
 306             controller : [
 307                         '$scope','$uibModalInstance',
 308                 function($scope , $uibModalInstance) {
 309
 310                     // if there is only one circ, default to the due date
 311                     // of that circ.  Otherwise, default to today.
 312                     var due_date = items.length == 1 ?
 313                         Date.parse(items[0].due_date()) : new Date();
 314
 315                     $scope.args = {
 316                         num_circs : items.length,
 317                         due_date : due_date
 318                     }
 319
 320                     // Fire off the due-date updater for each circ.
 321                     // When all is done, close the dialog
 322                     $scope.ok = function(args) {
 323                         // toISOString gives us Zulu time, so
 324                         // adjust for that before truncating to date
 325                         var adjust_date = new Date( $scope.args.due_date );
 326                         adjust_date.setMinutes(
 327                             $scope.args.due_date.getMinutes() - adjust_date.getTimezoneOffset()
 328                         );
 329                         var due = adjust_date.toISOString().replace(/T.*/,'');
 330                         console.debug("applying due date of " + due);
 331
 332                         var promises = [];
 333                         angular.forEach(items, function(circ) {
 334                             promises.push(
 335                                 egCore.net.request(
 336                                     'open-ils.circ',
 337                                     'open-ils.circ.circulation.due_date.update',
 338                                     egCore.auth.token(), circ.id(), due
 339
 340                                 ).then(function(new_circ) {
 341                                     // update the grid circ with the canonical
 342                                     // date from the modified circulation.
 343                                     circ.due_date(new_circ.due_date());
 344                                 })
 345                             );
 346                         });
 347
 348                         $q.all(promises).then(function() {
 349                             $uibModalInstance.close();
 350                             provider.refresh();
 351                         });
 352                     }
 353                     $scope.cancel = function($event) {
 354                         $uibModalInstance.dismiss();
 355                         $event.preventDefault();
 356                     }
 357                 }
 358             ]
 359         });
 360     }
 361
 362     $scope.print_receipt = function(items) {
 363         if (items.length == 0) return $q.when();
 364         var print_data = {circulations : []};
 365         var cusr = patronSvc.current;
 366
 367         angular.forEach(patronSvc.items_out, function(circ) {
 368             print_data.circulations.push({
 369                 circ : egCore.idl.toHash(circ),
 370                 copy : egCore.idl.toHash(circ.target_copy()),
 371                 call_number : egCore.idl.toHash(circ.target_copy().call_number()),
 372                 title : circ.target_copy().call_number().record().wide_display_entry().title(),
 373                 author : circ.target_copy().call_number().record().wide_display_entry().author()
 374             })
 375         });
 376
 377         print_data.patron = {
 378             prefix : cusr.prefix(),
 379             first_given_name : cusr.first_given_name(),
 380             second_given_name : cusr.second_given_name(),
 381             family_name : cusr.family_name(),
 382             suffix : cusr.suffix(),
 383             card : { barcode : cusr.card().barcode() },
 384             money_summary : patronSvc.patron_stats.fines,
 385             expire_date : cusr.expire_date(),
 386             alias : cusr.alias(),
 387             has_email : Boolean(patronSvc.current.email() && patronSvc.current.email().match(/.*@.*/).length),
 388             has_phone : Boolean(cusr.day_phone() || cusr.evening_phone() || cusr.other_phone())
 389         };
 390
 391         return egCore.print.print({
 392             context : 'default',
 393             template : 'items_out',
 394             scope : print_data,
 395         });
 396     }
 397
 398     function batch_action_with_barcodes(items, action) {
 399         if (!items.length) return;
 400         var barcodes = items.map(function(circ)
 401             { return circ.target_copy().barcode() });
 402         action(barcodes).then(reset_page);
 403     }
 404     $scope.mark_lost = function(items) {
 405         batch_action_with_barcodes(items, egCirc.mark_lost);
 406     }
 407     $scope.mark_claims_returned = function(items) {
 408         batch_action_with_barcodes(items, egCirc.mark_claims_returned_dialog);
 409     }
 410     $scope.mark_claims_never_checked_out = function(items) {
 411         batch_action_with_barcodes(items, egCirc.mark_claims_never_checked_out);
 412     }
 413
 414     $scope.show_recent_circs = function(items) {
 415         var focus = items.length == 1;
 416         angular.forEach(items, function(item) {
 417             var url = egCore.env.basePath +
 418                       '/cat/item/' +
 419                       item.target_copy().id() +
 420                       '/circ_list';
 421             $timeout(function() { var x = $window.open(url, '_blank'); if (focus) x.focus() });
 422         });
 423     }
 424
 425     $scope.show_triggered_events = function(items) {
 426         var focus = items.length == 1;
 427         angular.forEach(items, function(item) {
 428             var url = egCore.env.basePath +
 429                       '/cat/item/' +
 430                       item.target_copy().id() +
 431                       '/triggered_events';
 432             $timeout(function() { var x = $window.open(url, '_blank'); if (focus) x.focus() });
 433         });
 434     }
 435
 436     $scope.renew = function(items, msg) {
 437         if (!items.length) return;
 438         var barcodes = items.map(function(circ)
 439             { return circ.target_copy().barcode() });
 440
 441         if (!msg) msg = egCore.strings.RENEW_ITEMS;
 442
 443         return egConfirmDialog.open(msg, barcodes.join(' '), {}).result
 444         .then(function() {
 445             function do_one() {
 446                 var bc = barcodes.pop();
 447                 if (!bc) { reset_page(); return }
 448                 // finally -> continue even when one fails
 449                 egCirc.renew({copy_barcode : bc}).finally(do_one);
 450             }
 451             do_one();
 452         });
 453     }
 454
 455     $scope.renew_all = function() {
 456         var circs = patronSvc.items_out.filter(function(circ) {
 457             return (
 458                 // all others will be rejected at the server
 459                 !circ.stop_fines() ||
 460                 circ.stop_fines() == 'MAXFINES'
 461             );
 462         });
 463         $scope.renew(circs, egCore.strings.RENEW_ALL_ITEMS);
 464     }
 465
 466     $scope.renew_with_date = function(items) {
 467         if (!items.length) return;
 468         var barcodes = items.map(function(circ)
 469             { return circ.target_copy().barcode() });
 470
 471         return $uibModal.open({
 472             templateUrl : './circ/patron/t_renew_with_date_dialog',
 473             backdrop: 'static',
 474             controller : [
 475                         '$scope','$uibModalInstance',
 476                 function($scope , $uibModalInstance) {
 477                     $scope.args = {
 478                         barcodes : barcodes,
 479                         date : new Date()
 480                     }
 481                     $scope.cancel = function() {$uibModalInstance.dismiss()}
 482
 483                     // Fire off the due-date updater for each circ.
 484                     // When all is done, close the dialog
 485                     $scope.ok = function() {
 486                         var due = $scope.args.date.toISOString().replace(/T.*/,'');
 487                         console.debug("renewing with due date: " + due);
 488
 489                         function do_one() {
 490                             if (bc = barcodes.pop()) {
 491                                 egCirc.renew({copy_barcode : bc, due_date : due})
 492                                 .finally(do_one);
 493                             } else {
 494                                 $uibModalInstance.close();
 495                                 reset_page();
 496                             }
 497                         }
 498                        do_one(); // kick it off
 499                     }
 500                 }
 501             ]
 502         }).result;
 503     }
 504
 505     $scope.checkin = function(items) {
 506         if (!items.length) return;
 507         var barcodes = items.map(function(circ)
 508             { return circ.target_copy().barcode() });
 509
 510         return egConfirmDialog.open(
 511             egCore.strings.CHECK_IN_CONFIRM, barcodes.join(' '), {
 512
 513         }).result.then(function() {
 514             function do_one() {
 515                 if (bc = barcodes.pop()) {
 516                     egCirc.checkin({copy_barcode : bc})
 517                     .finally(do_one);
 518                 } else {
 519                     reset_page();
 520                 }
 521             }
 522             do_one(); // kick it off
 523         });
 524     }
 525
 526     $scope.add_billing = function(items) {
 527         if (!items.length) return;
 528         var circs = items.concat(); // don't pop from grid array
 529         function do_one() {
 530             var circ; // don't clobber window.circ!
 531             if (circ = circs.pop()) {
 532                 egBilling.showBillDialog({
 533                     // let the dialog fetch the transaction, since it's
 534                     // not sufficiently fleshed here.
 535                     xact_id : circ.id(),
 536                     patron : patronSvc.current
 537                 }).finally(do_one);
 538             } else {
 539                 reset_page();
 540             }
 541         }
 542         do_one();
 543     }
 544
 545 }]);
 546