1 import {Injectable, EventEmitter} from '@angular/core';
2 import {Observable} from 'rxjs';
3 import {map, tap, finalize} from 'rxjs/operators';
4 import {OrgService} from '@eg/core/org.service';
5 import {UnapiService} from '@eg/share/catalog/unapi.service';
6 import {IdlService, IdlObject} from '@eg/core/idl.service';
7 import {NetService} from '@eg/core/net.service';
8 import {PcrudService} from '@eg/core/pcrud.service';
9 import {CatalogSearchContext, CatalogSearchState} from './search-context';
10 import {BibRecordService, BibRecordSummary} from './bib-record.service';
11 import {BasketService} from './basket.service';
12 import {CATALOG_CCVM_FILTERS} from './search-context';
15 export class CatalogService {
17 ccvmMap: {[ccvm: string]: IdlObject[]} = {};
18 cmfMap: {[cmf: string]: IdlObject} = {};
19 copyLocations: IdlObject[];
21 // Keep a reference to the most recently retrieved facet data,
22 // since facet data is consistent across a given search.
23 // No need to re-fetch with every page of search data.
27 // Allow anyone to watch for completed searches.
28 onSearchComplete: EventEmitter<CatalogSearchContext>;
31 private idl: IdlService,
32 private net: NetService,
33 private org: OrgService,
34 private unapi: UnapiService,
35 private pcrud: PcrudService,
36 private bibService: BibRecordService,
37 private basket: BasketService
39 this.onSearchComplete = new EventEmitter<CatalogSearchContext>();
43 search(ctx: CatalogSearchContext): Promise<void> {
44 ctx.searchState = CatalogSearchState.SEARCHING;
47 return this.basketSearch(ctx);
48 } else if (ctx.marcSearch.isSearchable()) {
49 return this.marcSearch(ctx);
50 } else if (ctx.identSearch.isSearchable() &&
51 ctx.identSearch.queryType === 'item_barcode') {
52 return this.barcodeSearch(ctx);
55 ctx.identSearch.isSearchable() &&
56 ctx.identSearch.queryType === 'identifier|tcn') {
57 return this.tcnStaffSearch(ctx);
59 return this.termSearch(ctx);
63 barcodeSearch(ctx: CatalogSearchContext): Promise<void> {
64 return this.net.request(
66 'open-ils.search.multi_home.bib_ids.by_barcode',
68 ).toPromise().then(ids => {
69 // API returns an event for not-found barcodes
70 if (!Array.isArray(ids)) { ids = []; }
73 ids: ids.map(id => [id])
76 this.applyResultData(ctx, result);
77 ctx.searchState = CatalogSearchState.COMPLETE;
78 this.onSearchComplete.emit(ctx);
82 tcnStaffSearch(ctx: CatalogSearchContext): Promise<void> {
83 return this.net.request(
85 'open-ils.search.biblio.tcn',
86 ctx.identSearch.value, 1
87 ).toPromise().then(result => {
88 result.ids = result.ids.map(id => [id]);
89 this.applyResultData(ctx, result);
90 ctx.searchState = CatalogSearchState.COMPLETE;
91 this.onSearchComplete.emit(ctx);
96 // "Search" the basket by loading the IDs and treating
97 // them like a standard query search results set.
98 basketSearch(ctx: CatalogSearchContext): Promise<void> {
100 return this.basket.getRecordIds().then(ids => {
102 // Map our list of IDs into a search results object
103 // the search context can understand.
106 ids: ids.map(id => [id])
109 this.applyResultData(ctx, result);
110 ctx.searchState = CatalogSearchState.COMPLETE;
111 this.onSearchComplete.emit(ctx);
115 marcSearch(ctx: CatalogSearchContext): Promise<void> {
116 let method = 'open-ils.search.biblio.marc';
117 if (ctx.isStaff) { method += '.staff'; }
119 const queryStruct = ctx.compileMarcSearchArgs();
121 return this.net.request('open-ils.search', method, queryStruct)
122 .toPromise().then(result => {
123 // Match the query search return format
124 result.ids = result.ids.map(id => [id]);
126 this.applyResultData(ctx, result);
127 ctx.searchState = CatalogSearchState.COMPLETE;
128 this.onSearchComplete.emit(ctx);
132 termSearch(ctx: CatalogSearchContext): Promise<void> {
134 let method = 'open-ils.search.biblio.multiclass.query';
137 if (ctx.identSearch.isSearchable()) {
138 fullQuery = ctx.compileIdentSearchQuery();
141 fullQuery = ctx.compileTermSearchQuery();
143 if (ctx.termSearch.groupByMetarecord
144 && !ctx.termSearch.fromMetarecord) {
145 method = 'open-ils.search.metabib.multiclass.query';
148 if (ctx.termSearch.hasBrowseEntry) {
149 this.fetchBrowseEntry(ctx);
153 console.debug(`search query: ${fullQuery}`);
159 return this.net.request(
160 'open-ils.search', method, {
161 limit : ctx.pager.limit + 1,
162 offset : ctx.pager.offset
165 .then(result => this.applyResultData(ctx, result))
166 .then(_ => this.fetchFieldHighlights(ctx))
168 ctx.searchState = CatalogSearchState.COMPLETE;
169 this.onSearchComplete.emit(ctx);
173 // When showing titles linked to a browse entry, fetch
174 // the entry data as well so the UI can display it.
175 fetchBrowseEntry(ctx: CatalogSearchContext) {
176 const ts = ctx.termSearch;
178 const parts = ts.hasBrowseEntry.split(',');
179 const mbeId = parts[0];
180 const cmfId = parts[1];
182 this.pcrud.retrieve('mbe', mbeId)
183 .subscribe(mbe => ctx.termSearch.browseEntry = mbe);
186 applyResultData(ctx: CatalogSearchContext, result: any): void {
188 ctx.pager.resultCount = result.count;
190 // records[] tracks the current page of bib summaries.
193 // If this is a new search, reset the result IDs collection.
194 if (this.lastFacetKey !== result.facet_key) {
198 result.ids.forEach((blob, idx) => ctx.addResultId(blob[0], idx));
201 // Appends records to the search result set as they arrive.
202 // Returns a void promise once all records have been retrieved
203 fetchBibSummaries(ctx: CatalogSearchContext): Promise<void> {
205 const depth = ctx.global ?
206 ctx.org.root().ou_type().depth() :
207 ctx.searchOrg.ou_type().depth();
209 const isMeta = ctx.termSearch.isMetarecordSearch();
211 let observable: Observable<BibRecordSummary>;
214 observable = this.bibService.getMetabibSummaries(
215 ctx.currentResultIds(), ctx.searchOrg.id(), ctx.isStaff);
217 observable = this.bibService.getBibSummaries(
218 ctx.currentResultIds(), ctx.searchOrg.id(), ctx.isStaff);
221 return observable.pipe(map(summary => {
222 // Responses are not necessarily returned in request-ID order.
225 idx = ctx.currentResultIds().indexOf(summary.metabibId);
227 idx = ctx.currentResultIds().indexOf(summary.id);
230 if (ctx.result.records) {
231 // May be reset when quickly navigating results.
232 ctx.result.records[idx] = summary;
235 if (ctx.highlightData[summary.id]) {
236 summary.displayHighlights = ctx.highlightData[summary.id];
241 fetchFieldHighlights(ctx: CatalogSearchContext): Promise<any> {
245 // Extract the highlight map. Not all searches have them.
246 if ((hlMap = ctx.result) &&
247 (hlMap = hlMap.global_summary) &&
248 (hlMap = hlMap.query_struct) &&
249 (hlMap = hlMap.additional_data) &&
250 (hlMap = hlMap.highlight_map) &&
251 (Object.keys(hlMap).length > 0)) {
252 } else { return Promise.resolve(); }
255 if (ctx.getHighlightsFor) {
256 ids = [ctx.getHighlightsFor];
258 // ctx.currentResultIds() returns bib IDs or metabib IDs
259 // depending on the search type. If we have metabib IDs, map
260 // them to bib IDs for highlighting.
261 ids = ctx.currentResultIds();
262 if (ctx.termSearch.groupByMetarecord) {
263 // The 4th slot in the result ID reports the master record
264 // for the metarecord in question. Sometimes it's null?
265 ids = ctx.result.ids.map(id => id[4]).filter(id => id !== null);
269 return this.net.requestWithParamList( // API is list-based
271 'open-ils.search.fetch.metabib.display_field.highlight',
273 ).pipe(map(fields => {
275 if (fields.length === 0) { return; }
277 // Each 'fields' collection is an array of display field
278 // values whose text is augmented with highlighting markup.
279 const highlights = ctx.highlightData[fields[0].source] = {};
281 fields.forEach(field => {
282 const dfMap = this.cmfMap[field.field].display_field_map();
283 if (!dfMap) { return; } // pretty sure this can't happen.
285 if (dfMap.multi() === 't') {
286 if (!highlights[dfMap.name()]) {
287 highlights[dfMap.name()] = [];
289 (highlights[dfMap.name()] as string[]).push(field.highlight);
291 highlights[dfMap.name()] = field.highlight;
298 fetchFacets(ctx: CatalogSearchContext): Promise<void> {
301 return Promise.reject('Cannot fetch facets without results');
304 if (!ctx.result.facet_key) {
305 return Promise.resolve();
308 if (this.lastFacetKey === ctx.result.facet_key) {
309 ctx.result.facetData = this.lastFacetData;
310 return Promise.resolve();
313 return new Promise((resolve, reject) => {
314 this.net.request('open-ils.search',
315 'open-ils.search.facet_cache.retrieve',
317 ).subscribe(facets => {
318 const facetData = {};
319 Object.keys(facets).forEach(cmfId => {
320 const facetHash = facets[cmfId];
321 const cmf = this.cmfMap[cmfId];
324 Object.keys(facetHash).forEach(value => {
325 const count = facetHash[value];
326 cmfData.push({value : value, count : count});
329 if (!facetData[cmf.field_class()]) {
330 facetData[cmf.field_class()] = {};
333 facetData[cmf.field_class()][cmf.name()] = {
334 cmfLabel : cmf.label(),
335 valueList : cmfData.sort((a, b) => {
336 if (a.count > b.count) { return -1; }
337 if (a.count < b.count) { return 1; }
338 // secondary alpha sort on display value
339 return a.value < b.value ? -1 : 1;
344 this.lastFacetKey = ctx.result.facet_key;
345 this.lastFacetData = ctx.result.facetData = facetData;
351 fetchCcvms(): Promise<void> {
353 if (Object.keys(this.ccvmMap).length) {
354 return Promise.resolve();
357 return new Promise((resolve, reject) => {
358 this.pcrud.search('ccvm',
359 {ctype : CATALOG_CCVM_FILTERS}, {},
360 {atomic: true, anonymous: true}
361 ).subscribe(list => {
362 this.compileCcvms(list);
368 compileCcvms(ccvms: IdlObject[]): void {
369 ccvms.forEach(ccvm => {
370 if (!this.ccvmMap[ccvm.ctype()]) {
371 this.ccvmMap[ccvm.ctype()] = [];
373 this.ccvmMap[ccvm.ctype()].push(ccvm);
376 Object.keys(this.ccvmMap).forEach(cType => {
377 this.ccvmMap[cType] =
378 this.ccvmMap[cType].sort((a, b) => {
379 return a.value() < b.value() ? -1 : 1;
384 iconFormatLabel(code: string): string {
386 const ccvm = this.ccvmMap.icon_format.filter(
387 format => format.code() === code)[0];
389 return ccvm.search_label();
394 fetchCmfs(): Promise<void> {
395 if (Object.keys(this.cmfMap).length) {
396 return Promise.resolve();
399 return new Promise((resolve, reject) => {
400 this.pcrud.search('cmf',
401 {'-or': [{facet_field : 't'}, {display_field: 't'}]},
402 {flesh: 1, flesh_fields: {cmf: ['display_field_map']}},
403 {atomic: true, anonymous: true}
406 cmfs.forEach(c => this.cmfMap[c.id()] = c);
413 fetchCopyLocations(contextOrg: number | IdlObject): Promise<any> {
414 const orgIds = this.org.fullPath(contextOrg, true);
415 this.copyLocations = [];
417 return this.pcrud.search('acpl',
418 {deleted: 'f', opac_visible: 't', owning_lib: orgIds},
419 {order_by: {acpl: 'name'}},
421 ).pipe(tap(loc => this.copyLocations.push(loc))).toPromise();
424 browse(ctx: CatalogSearchContext): Observable<any> {
425 ctx.searchState = CatalogSearchState.SEARCHING;
426 const bs = ctx.browseSearch;
428 let method = 'open-ils.search.browse';
433 return this.net.request(
435 'open-ils.search.browse.staff', {
436 browse_class: bs.fieldClass,
438 limit : ctx.pager.limit,
440 org_unit: ctx.searchOrg.id()
443 tap(result => ctx.searchState = CatalogSearchState.COMPLETE),
444 finalize(() => this.onSearchComplete.emit(ctx))
448 cnBrowse(ctx: CatalogSearchContext): Observable<any> {
449 ctx.searchState = CatalogSearchState.SEARCHING;
450 const cbs = ctx.cnBrowseSearch;
452 return this.net.request(
454 'open-ils.supercat.call_number.browse',
455 cbs.value, ctx.searchOrg.shortname(), cbs.limit, cbs.offset
456 ).pipe(tap(result => ctx.searchState = CatalogSearchState.COMPLETE));