1 import {Component, OnInit, Input, Output, EventEmitter, ViewChild} from '@angular/core';
2 import {Location} from '@angular/common';
3 import {Observable, Observer, of, from} from 'rxjs';
4 import {concatMap} from 'rxjs/operators';
5 import {IdlObject} from '@eg/core/idl.service';
6 import {NetService} from '@eg/core/net.service';
7 import {OrgService} from '@eg/core/org.service';
8 import {AuthService} from '@eg/core/auth.service';
9 import {Pager} from '@eg/share/util/pager';
10 import {ServerStoreService} from '@eg/core/server-store.service';
11 import {GridDataSource, GridCellTextGenerator} from '@eg/share/grid/grid';
12 import {GridComponent} from '@eg/share/grid/grid.component';
13 import {ProgressDialogComponent} from '@eg/share/dialog/progress.component';
14 import {ConfirmDialogComponent} from '@eg/share/dialog/confirm.component';
15 import {MarkDamagedDialogComponent
16 } from '@eg/staff/share/holdings/mark-damaged-dialog.component';
17 import {MarkMissingDialogComponent
18 } from '@eg/staff/share/holdings/mark-missing-dialog.component';
19 import {MarkDiscardDialogComponent
20 } from '@eg/staff/share/holdings/mark-discard-dialog.component';
21 import {HoldRetargetDialogComponent
22 } from '@eg/staff/share/holds/retarget-dialog.component';
23 import {HoldTransferDialogComponent} from './transfer-dialog.component';
24 import {HoldCancelDialogComponent} from './cancel-dialog.component';
25 import {HoldManageDialogComponent} from './manage-dialog.component';
26 import {PrintService} from '@eg/share/print/print.service';
27 import {HoldingsService} from '@eg/staff/share/holdings/holdings.service';
28 import {OrgSelectComponent} from '@eg/share/org-select/org-select.component';
29 import {ComboboxEntry} from '@eg/share/combobox/combobox.component';
30 import {HoldCopyLocationsDialogComponent} from './copy-locations-dialog.component';
32 /** Holds grid with access to detail page and other actions */
35 selector: 'eg-holds-grid',
36 templateUrl: 'grid.component.html',
37 styles: ['.input-group > .form-control { width: auto; flex-grow: 0; }']
39 export class HoldsGridComponent implements OnInit {
41 // Hide the "Holds Count" header
42 @Input() hideHoldsCount = false;
44 // If either are set/true, the pickup lib selector will display
45 @Input() initialPickupLib: number | IdlObject;
46 @Input() hidePickupLibFilter: boolean;
48 // Setting a value here puts us into "pull list" mode.
49 @Input() pullListOrg: number;
51 // If true, only retrieve holds with a Hopeless Date
52 // and enable related Actions
53 @Input() hopeless: boolean;
56 @Input() persistKey: string;
58 @Input() preFetchSetting: string;
60 @Input() printTemplate: string;
62 // Adds a Place Hold grid toolbar button that emits
63 // placeHoldRequested on click.
64 @Input() showPlaceHoldButton = false;
66 // If set, all holds are fetched on grid load and sorting/paging all
67 // happens in the client. If false, sorting and paging occur on
69 @Input() enablePreFetch: boolean;
71 // How to sort when no sort parameters have been applied
72 // via grid controls. This uses the eg-grid sort format:
73 // [{name: fname, dir: 'asc'}, {name: fname2, dir: 'desc'}]
74 @Input() defaultSort: any[];
76 // To pass through to the underlying eg-grid
77 @Input() showFields: string;
79 // Display bib record summary along the top of the detail page.
80 @Input() showRecordSummary = false;
82 // If true, avoid popping up the progress dialog. Note the grid
83 // has it's own generic embedded 'loading' progress indicator.
84 @Input() noLoadProgress = false;
86 // Some default columns and actions do or don't make sense when
87 // displaying holds for a specific patron vs. e.g. a specific title.
88 @Input() patronFocused = false;
90 mode: 'list' | 'detail' | 'manage' = 'list';
95 gridDataSource: GridDataSource;
98 transferTarget: number;
99 uncancelHoldCount: number;
100 copyLocationClass?: string;
101 copyLocationEntries: ComboboxEntry[] = [];
102 copyLocationIds: number[] = [];
104 @ViewChild('holdsGrid', { static: false }) private holdsGrid: GridComponent;
105 @ViewChild('progressDialog', { static: true })
106 private progressDialog: ProgressDialogComponent;
107 @ViewChild('transferDialog', { static: true })
108 private transferDialog: HoldTransferDialogComponent;
109 @ViewChild('markDamagedDialog', { static: true })
110 private markDamagedDialog: MarkDamagedDialogComponent;
111 @ViewChild('markMissingDialog', { static: true })
112 private markMissingDialog: MarkMissingDialogComponent;
113 @ViewChild('markDiscardDialog')
114 private markDiscardDialog: MarkDiscardDialogComponent;
115 @ViewChild('retargetDialog', { static: true })
116 private retargetDialog: HoldRetargetDialogComponent;
117 @ViewChild('cancelDialog', { static: true })
118 private cancelDialog: HoldCancelDialogComponent;
119 @ViewChild('manageDialog', { static: true })
120 private manageDialog: HoldManageDialogComponent;
121 @ViewChild('uncancelDialog') private uncancelDialog: ConfirmDialogComponent;
122 @ViewChild('copyLocationsDialog')
123 private copyLocationsDialog: HoldCopyLocationsDialogComponent;
124 @ViewChild('clearCopyLocationsDialog')
125 private clearCopyLocationsDialog: ConfirmDialogComponent;
126 @ViewChild('pullPickupLibFilter')
127 private pullPickupLibFilter: OrgSelectComponent;
131 @Input() set recordId(id: number) {
133 if (this.initDone) { // reload on update
134 this.holdsGrid.reload();
138 get recordId(): number {
139 return this._recordId;
143 @Input() set patronId(id: number) {
146 this.holdsGrid.reload();
149 get patronId(): number {
150 return this._patronId;
153 // If true, show recently canceled holds only.
154 @Input() showRecentlyCanceled = false;
156 // Include holds fulfilled on or after hte provided date.
157 // If no value is passed, fulfilled holds are not displayed.
158 _showFulfilledSince: Date;
159 @Input() set showFulfilledSince(show: Date) {
160 this._showFulfilledSince = show;
161 if (this.initDone) { // reload on update
162 this.holdsGrid.reload();
165 get showFulfilledSince(): Date {
166 return this._showFulfilledSince;
170 cellTextGenerator: GridCellTextGenerator;
172 // Include holds marked Hopeless on or after this date.
173 _showHopelessAfter: Date;
174 @Input() set showHopelessAfter(show: Date) {
175 this._showHopelessAfter = show;
176 if (this.initDone) { // reload on update
177 this.holdsGrid.reload();
181 // Include holds marked Hopeless on or before this date.
182 _showHopelessBefore: Date;
183 @Input() set showHopelessBefore(show: Date) {
184 this._showHopelessBefore = show;
185 if (this.initDone) { // reload on update
186 this.holdsGrid.reload();
190 // Notify the caller the place hold button was clicked.
191 @Output() placeHoldRequested: EventEmitter<void> = new EventEmitter<void>();
194 private ngLocation: Location,
195 private net: NetService,
196 private org: OrgService,
197 private store: ServerStoreService,
198 private auth: AuthService,
199 private printer: PrintService,
200 private holdings: HoldingsService
202 this.gridDataSource = new GridDataSource();
203 this.enablePreFetch = null;
207 this.initDone = true;
208 this.pickupLib = this.org.get(this.initialPickupLib);
210 if (this.preFetchSetting) {
211 this.store.getItem(this.preFetchSetting).then(
212 applied => this.enablePreFetch = Boolean(applied)
215 this.enablePreFetch = false;
218 if (!this.defaultSort) {
219 if (this.pullListOrg) {
222 {name: 'copy_location_order_position', dir: 'asc'},
223 {name: 'acpl_name', dir: 'asc'},
224 {name: 'ancp_label', dir: 'asc'}, // NOTE: API typo "ancp"
225 {name: 'cn_label_sortkey', dir: 'asc'},
226 {name: 'ancs_label', dir: 'asc'} // NOTE: API typo "ancs"
230 this.defaultSort = [{name: 'request_time', dir: 'asc'}];
234 this.gridDataSource.getRows = (pager: Pager, sort: any[]) => {
236 if (!this.hidePickupLibFilter || this.pullListOrg) {
237 // When the pickup lib selector is active, avoid any
238 // data fetches until it has settled on a default value.
239 // Once the final value is applied, its onchange will
240 // fire and we'll be back here with plCompLoaded=true.
241 if (!this.plCompLoaded) {return of([]);}
244 sort = sort.length > 0 ? sort : this.defaultSort;
245 return this.fetchHolds(pager, sort);
248 // Text-ify function for cells that use display templates.
249 this.cellTextGenerator = {
250 title: row => row.title,
251 // eslint-disable-next-line eqeqeq
252 cp_barcode: row => (row.cp_barcode == null) ? '' : row.cp_barcode,
253 current_item: row => row.current_copy ? row.cp_barcode : '',
254 requested_item: row => this.isCopyHold(row) ? row.cp_barcode : '',
255 ucard_barcode: row => row.ucard_barcode,
256 status_string: row => {
257 switch (row.hold_status) {
258 /* eslint-disable no-magic-numbers */
260 return $localize`Waiting for Item`;
262 return $localize`Waiting for Capture`;
264 return $localize`In Transit`;
266 return $localize`Ready for Pickup`;
268 return $localize`Hold Shelf Delay`;
270 return $localize`Canceled`;
272 return $localize`Suspended`;
274 return $localize`Wrong Shelf`;
276 return $localize`Fulfilled`;
278 return $localize`Unknown Error`;
279 /* eslint-enable no-magic-numbers */
284 if (this.pullListOrg) {
285 this.store.getItem('eg.holds.pull_list_filters').then(data => {
287 this.copyLocationClass = data.copyLocationClass;
288 this.copyLocationEntries = data.copyLocationEntries;
289 this.copyLocationIds = data.copyLocationIds;
290 if (data.pickupLib) {
291 this.pickupLib = this.org.get(data.pickupLib);
294 this.copyLocationClass = 'acpl';
300 // Returns true after all data/settings/etc required to render the
301 // grid have been fetched.
302 initComplete(): boolean {
303 return this.enablePreFetch !== null;
306 pickupLibChanged(org: IdlObject) {
307 this.pickupLib = org;
308 this.holdsGrid.reload();
311 pullPickupLibLoaded(): void {
312 this.plCompLoaded = true;
313 this.holdsGrid.reload();
316 resetPullPickupLibFilter(): void {
317 if (this.pickupLib) {
318 this.pullPickupLibFilter.reset();
322 pullPickupLibChanged(org: IdlObject): void {
323 if (org?.id() !== this.pickupLib?.id()) {
324 this.pickupLib = org;
325 this.savePullFilterSettings();
326 this.holdsGrid.reload();
330 openCopyLocationsDialog(): void {
331 this.copyLocationsDialog.init();
332 this.copyLocationsDialog.open({size: 'lg'}).subscribe(
333 ([fmClass, entries, ids]) => {
334 this.copyLocationClass = fmClass;
335 this.copyLocationEntries = entries;
336 this.copyLocationIds = ids;
337 this.savePullFilterSettings();
338 this.holdsGrid.reload();
343 clearCopyLocations(): void {
344 if (!this.copyLocationEntries.length) {return;}
345 this.clearCopyLocationsDialog.open().subscribe(data => {
347 this.copyLocationClass = 'acpl';
348 this.copyLocationEntries = [];
349 this.copyLocationIds = [];
350 this.savePullFilterSettings();
351 this.holdsGrid.reload();
356 pullListSettingsLoaded(): boolean {
357 return !!this.copyLocationClass;
360 savePullFilterSettings(): void {
361 this.store.setItem('eg.holds.pull_list_filters', {
362 copyLocationClass: this.copyLocationClass,
363 copyLocationEntries: this.copyLocationEntries,
364 copyLocationIds: this.copyLocationIds,
365 pickupLib: this.pickupLib ? +this.pickupLib.id() : undefined
369 pullListOrgChanged(org: IdlObject): void {
370 if (org && +org.id() !== +this.pullListOrg) {
371 this.pullListOrg = org.id();
372 this.holdsGrid.reload();
376 preFetchHolds(apply: boolean) {
377 this.enablePreFetch = apply;
380 setTimeout(() => this.holdsGrid.reload());
383 if (this.preFetchSetting) {
385 this.store.setItem(this.preFetchSetting, apply);
389 applyFilters(): any {
391 const filters: any = {};
393 if (this.copyLocationIds.length) {
394 filters['acpl.id'] = this.copyLocationIds;
397 if (this.pickupLib) {
399 this.org.descendants(this.pickupLib, true);
402 if (this.pullListOrg) {
403 filters.cancel_time = null;
404 filters.capture_time = null;
405 filters.frozen = 'f';
407 // cp.* fields are set for copy-level holds even if they
408 // have no current_copy. Make sure current_copy is set.
409 filters.current_copy = {'is not': null};
411 // There are aliases for these (cp_status, cp_circ_lib),
412 // but the API complains when I use them.
413 filters['cp.status'] = {'in':{'select':{'ccs':['id']},'from':'ccs','where':{'holdable':'t','is_available':'t'}}};
414 filters['cp.circ_lib'] = this.pullListOrg;
415 // Avoid deleted copies AND this uses a database index on copy circ_lib where deleted is false.
416 filters['cp.deleted'] = 'f';
421 if (this._showFulfilledSince) {
422 filters.fulfillment_time = this._showFulfilledSince.toISOString();
424 filters.fulfillment_time = null;
429 filters['hopeless_holds'] = {
430 'start_date' : this._showHopelessAfter
432 // FIXME -- consistency desired, string or object
433 typeof this._showHopelessAfter === 'object'
434 ? this._showHopelessAfter.toISOString()
435 : this._showHopelessAfter
437 : '1970-01-01T00:00:00.000Z',
438 'end_date' : this._showHopelessBefore
440 // FIXME -- consistency desired, string or object
441 typeof this._showHopelessBefore === 'object'
442 ? this._showHopelessBefore.toISOString()
443 : this._showHopelessBefore
445 : (new Date()).toISOString()
450 filters.record_id = this.recordId;
454 filters.usr_id = this.patronId;
460 fetchHolds(pager: Pager, sort: any[]): Observable<any> {
462 // We need at least one filter.
463 if (!this.recordId && !this.pickupLib && !this.patronId && !this.pullListOrg) {
467 const filters = this.applyFilters();
469 const orderBy: any = [];
470 if (sort.length > 0) {
471 sort.forEach(obj => {
472 const subObj: any = {};
473 subObj[obj.name] = {dir: obj.dir, nulls: 'last'};
474 orderBy.push(subObj);
478 const limit = this.enablePreFetch ? null : pager.limit;
479 const offset = this.enablePreFetch ? 0 : pager.offset;
480 const options: any = {};
481 if (this.showRecentlyCanceled) {
482 options.recently_canceled = true;
484 filters.cancel_time = null;
487 let observer: Observer<any>;
488 const observable = new Observable(obs => observer = obs);
490 if (!this.noLoadProgress) {
491 // Note remaining dialog actions have no impact
492 this.progressDialog.open();
495 this.progressDialog.update({value: 0, max: 1});
501 'open-ils.circ.hold.wide_hash.stream',
502 this.auth.token(), filters, orderBy, limit, offset, options
506 if (first) { // First response is the hold count.
507 this.holdsCount = Number(holdData);
510 } else { // Subsequent responses are hold data blobs
512 this.progressDialog.update(
513 {value: ++loadCount, max: this.holdsCount});
515 observer.next(holdData);
519 this.progressDialog.close();
523 this.progressDialog.close();
531 metaRecordHoldsSelected(rows: IdlObject[]) {
533 rows.forEach( row => {
534 if (row.hold_type === 'M') {
541 nonTitleHoldsSelected(rows: IdlObject[]) {
543 rows.forEach( row => {
544 if (row.hold_type !== 'T') {
551 showDetails(rows: any[]) {
552 this.showDetail(rows[0]);
555 showHoldsForTitle(rows: any[]) {
556 if (rows.length === 0) { return; }
558 const url = this.ngLocation.prepareExternalUrl(
559 `/staff/catalog/record/${rows[0].record_id}/holds`);
561 window.open(url, '_blank');
564 showDetail(row: any) {
566 this.mode = 'detail';
567 this.detailHold = row;
571 showManager(rows: any[]) {
573 this.mode = 'manage';
574 this.editHolds = rows.map(r => r.id);
578 handleModify(rowsModified: boolean) {
582 // give the grid a chance to render then ask it to reload
583 setTimeout(() => this.holdsGrid.reload());
589 showRecentCircs(rows: any[]) {
590 const copyIds = Array.from(new Set( rows.map(r => r.cp_id).filter( cp_id => Boolean(cp_id)) ));
591 copyIds.forEach( copyId => {
593 '/eg/staff/cat/item/' + copyId + '/circ_list';
594 window.open(url, '_blank');
598 showPatron(rows: any[]) {
599 const usrIds = Array.from(new Set( rows.map(r => r.usr_id).filter( usr_id => Boolean(usr_id)) ));
600 usrIds.forEach( usrId => {
602 '/eg/staff/circ/patron/' + usrId + '/checkout';
603 window.open(url, '_blank');
607 showOrder(rows: any[]) {
608 // Doesn't work in Typescript currently without compiler option:
609 // const bibIds = [...new Set( rows.map(r => r.record_id) )];
610 const bibIds = Array.from(
611 new Set( rows.filter(r => r.hold_type !== 'M').map(r => r.record_id) ));
612 bibIds.forEach( bibId => {
614 '/eg/staff/acq/legacy/lineitem/related/' + bibId + '?target=bib';
615 window.open(url, '_blank');
619 addVolume(rows: any[]) {
620 const bibIds = Array.from(
621 new Set( rows.filter(r => r.hold_type !== 'M').map(r => r.record_id) ));
622 bibIds.forEach( bibId => {
623 this.holdings.spawnAddHoldingsUi(bibId);
627 showTitle(rows: any[]) {
628 const bibIds = Array.from(new Set( rows.map(r => r.record_id) ));
629 bibIds.forEach( bibId => {
630 // const url = '/eg/staff/cat/catalog/record/' + bibId;
631 const url = '/eg2/staff/catalog/record/' + bibId;
632 window.open(url, '_blank');
636 showManageDialog(rows: any[]) {
637 const holdIds = rows.map(r => r.id).filter(id => Boolean(id));
638 if (holdIds.length > 0) {
639 this.manageDialog.holdIds = holdIds;
640 this.manageDialog.open({size: 'lg'}).subscribe(
643 this.holdsGrid.reload();
650 showTransferDialog(rows: any[]) {
651 const holdIds = rows.filter(r => r.hold_type === 'T').map(r => r.id).filter(id => Boolean(id));
652 if (holdIds.length > 0) {
653 this.transferDialog.holdIds = holdIds;
654 this.transferDialog.open({}).subscribe(
657 this.holdsGrid.reload();
664 async showMarkDamagedDialog(rows: any[]) {
665 const copyIds = rows.map(r => r.cp_id).filter(id => Boolean(id));
666 if (copyIds.length === 0) { return; }
668 let rowsModified = false;
670 const markNext = async(ids: number[]) => {
671 if (ids.length === 0) {
672 return Promise.resolve();
675 this.markDamagedDialog.copyId = ids.pop();
676 return this.markDamagedDialog.open({size: 'lg'}).subscribe(
678 if (ok) { rowsModified = true; }
679 return markNext(ids);
681 (dismiss: unknown) => markNext(ids)
685 await markNext(copyIds);
687 this.holdsGrid.reload();
691 showMarkMissingDialog(rows: any[]) {
692 const copyIds = rows.map(r => r.cp_id).filter(id => Boolean(id));
693 if (copyIds.length > 0) {
694 this.markMissingDialog.copyIds = copyIds;
695 this.markMissingDialog.open({}).subscribe(
698 this.holdsGrid.reload();
705 showMarkDiscardDialog(rows: any[]) {
706 const copyIds = rows.map(r => r.cp_id).filter(id => Boolean(id));
707 if (copyIds.length > 0) {
708 this.markDiscardDialog.copyIds = copyIds;
709 this.markDiscardDialog.open({}).subscribe(
712 this.holdsGrid.reload();
720 showRetargetDialog(rows: any[]) {
721 const holdIds = rows.map(r => r.id).filter(id => Boolean(id));
722 if (holdIds.length > 0) {
723 this.retargetDialog.holdIds = holdIds;
724 this.retargetDialog.open({}).subscribe(
727 this.holdsGrid.reload();
734 showCancelDialog(rows: any[]) {
735 const holdIds = rows.map(r => r.id).filter(id => Boolean(id));
736 if (holdIds.length > 0) {
737 this.cancelDialog.holdIds = holdIds;
738 this.cancelDialog.open({}).subscribe(
741 this.holdsGrid.reload();
748 showUncancelDialog(rows: any[]) {
749 const holdIds = rows.map(r => r.id).filter(id => Boolean(id));
750 if (holdIds.length === 0) { return; }
751 this.uncancelHoldCount = holdIds.length;
753 this.uncancelDialog.open().subscribe(confirmed => {
754 if (!confirmed) { return; }
755 this.progressDialog.open();
757 from(holdIds).pipe(concatMap(holdId => {
758 return this.net.request(
760 'open-ils.circ.hold.uncancel',
761 this.auth.token(), holdId
763 // eslint-disable-next-line rxjs/no-nested-subscribe
766 if (Number(resp) !== 1) {
767 console.error('Failed uncanceling hold', resp);
772 this.progressDialog.close();
773 this.holdsGrid.reload();
780 // Request a page with no limit to get all of the wide holds for
781 // printing. Call requestPage() directly instead of grid.reload()
782 // since we may already have the data.
784 const pager = new Pager();
788 if (this.gridDataSource.sort.length === 0) {
789 this.gridDataSource.sort = this.defaultSort;
792 this.gridDataSource.requestPage(pager).then(() => {
793 if (this.gridDataSource.data.length > 0) {
795 templateName: this.printTemplate || 'holds_for_bib',
796 contextData: this.gridDataSource.data,
797 printContext: 'default'
803 isCopyHold(holdData: any): boolean {
804 if (holdData && holdData.hold_type) {
805 return holdData.hold_type.match(/C|R|F/) !== null;