1 import {Injectable} from '@angular/core';
2 import {Observable} from 'rxjs';
3 import {tap} from 'rxjs/operators';
4 import {IdlObject, IdlService} from './idl.service';
5 import {NetService} from './net.service';
6 import {AuthService} from './auth.service';
7 import {PcrudService} from './pcrud.service';
8 import {DbStoreService} from './db-store.service';
10 type OrgNodeOrId = number | IdlObject;
13 canHaveUsers?: boolean;
14 canHaveVolumes?: boolean;
15 opacVisible?: boolean;
20 interface OrgSettingsBatch {
24 @Injectable({providedIn: 'root'})
25 export class OrgService {
27 private orgList: IdlObject[] = [];
28 private orgTree: IdlObject; // root node + children
29 private orgMap: {[id: number]: IdlObject} = {};
30 private settingsCache: OrgSettingsBatch = {};
32 private orgTypeMap: {[id: number]: IdlObject} = {};
33 private orgTypeList: IdlObject[] = [];
36 private db: DbStoreService,
37 private net: NetService,
38 private auth: AuthService,
39 private pcrud: PcrudService
42 get(nodeOrId: OrgNodeOrId): IdlObject {
43 if (typeof nodeOrId === 'object') {
46 return this.orgMap[nodeOrId];
53 typeList(): IdlObject[] {
54 return this.orgTypeList;
57 typeMap(): {[id: number]: IdlObject} {
58 return this.orgTypeMap;
62 * Returns a list of org units that match the selected criteria.
63 * All filters must match for an org to be included in the result set.
64 * Unset filter options are ignored.
66 filterList(filter: OrgFilter, asId?: boolean): any[] {
68 this.list().forEach(org => {
70 const chu = filter.canHaveUsers;
71 if (chu && !this.canHaveUsers(org)) { return; }
72 if (chu === false && this.canHaveUsers(org)) { return; }
74 const chv = filter.canHaveVolumes;
75 if (chv && !this.canHaveVolumes(org)) { return; }
76 if (chv === false && this.canHaveVolumes(org)) { return; }
78 const ov = filter.opacVisible;
79 if (ov && !this.opacVisible(org)) { return; }
80 if (ov === false && this.opacVisible(org)) { return; }
82 if (filter.inList && !filter.inList.includes(org.id())) {
86 if (filter.notInList && filter.notInList.includes(org.id())) {
90 // All filter tests passed. Add it to the list
91 list.push(asId ? org.id() : org);
103 return this.orgList[0];
106 // list of org_unit objects or IDs for ancestors + me
107 ancestors(nodeOrId: OrgNodeOrId, asId?: boolean): any[] {
108 let node = this.get(nodeOrId);
109 if (!node) { return []; }
110 const nodes = [node];
111 while ( (node = this.get(node.parent_ou())) ) {
115 return nodes.map(n => n.id());
120 // tests that a node can have users
121 canHaveUsers(nodeOrId): boolean {
122 return this.get(nodeOrId).ou_type().can_have_users() === 't';
125 // tests that a node can have volumes
126 canHaveVolumes(nodeOrId): boolean {
130 .can_have_vols() === 't';
133 opacVisible(nodeOrId): boolean {
134 return this.get(nodeOrId).opac_visible() === 't';
137 // list of org_unit objects or IDs for me + descendants
138 descendants(nodeOrId: OrgNodeOrId, asId?: boolean): any[] {
139 const node = this.get(nodeOrId);
140 if (!node) { return []; }
142 const descend = (n) => {
144 n.children().forEach(descend);
148 return nodes.map(n => n.id());
153 // list of org_unit objects or IDs for ancestors + me + descendants
154 fullPath(nodeOrId: OrgNodeOrId, asId?: boolean): any[] {
155 const list = this.ancestors(nodeOrId, false).concat(
156 this.descendants(nodeOrId, false).slice(1));
158 return list.map(n => n.id());
163 sortTree(sortField?: string, node?: IdlObject): void {
164 if (!sortField) { sortField = 'shortname'; }
165 if (!node) { node = this.orgTree; }
167 node.children().sort((a, b) => {
168 return a[sortField]() < b[sortField]() ? -1 : 1;
171 node.children().forEach(n => this.sortTree(sortField, n));
174 absorbTree(node?: IdlObject): void {
179 this.orgMap[node.id()] = node;
180 this.orgList.push(node);
182 node.children().forEach(c => this.absorbTree(c));
186 * Grabs all of the org units from the server, chops them up into
187 * various shapes, then returns an "all done" promise.
189 fetchOrgs(): Promise<void> {
191 // Grab org types separately so we are guaranteed to fetch types
192 // that are not yet in use by an org unit.
193 return this.pcrud.retrieveAll(
194 'aout', {}, {anonymous: true, atomic: true}).toPromise()
196 this.orgTypeList = types;
197 types.forEach(t => this.orgTypeMap[Number(t.id())] = t);
199 return this.pcrud.search('aou', {parent_ou : null},
200 {flesh : -1, flesh_fields : {aou : ['children', 'ou_type']}},
212 private appendSettingsFromCache(names: string[], batch: OrgSettingsBatch) {
213 names.forEach(name => {
214 if (name in this.settingsCache) {
215 batch[name] = this.settingsCache[name];
220 // Pulls setting values from IndexedDB.
221 // Update local cache with any values found.
222 private appendSettingsFromDb(names: string[],
223 batch: OrgSettingsBatch): Promise<OrgSettingsBatch> {
225 if (names.length === 0) { return Promise.resolve(batch); }
227 return this.db.request({
230 action: 'selectWhereIn',
233 }).then(settings => {
235 // array of key => JSON-string objects
236 settings.forEach(setting => {
237 const value = JSON.parse(setting.value);
238 // propagate to local cache as well
239 batch[setting.name] = this.settingsCache[setting.name] = value;
243 }).catch(_ => batch);
246 // Add values for the list of named settings from the 'batch' to
247 // IndexedDB, copying the local cache as well.
248 private addSettingsToDb(names: string[],
249 batch: OrgSettingsBatch): Promise<OrgSettingsBatch> {
252 names.forEach(name => {
253 // Anything added to the db should also be cached locally.
254 this.settingsCache[name] = batch[name];
255 rows.push({name: name, value: JSON.stringify(batch[name])});
258 if (rows.length === 0) { return Promise.resolve(batch); }
260 return this.db.request({
263 action: 'insertOrReplace',
265 }).then(_ => batch).catch(_ => batch);
269 * Append the named settings from the network to the in-progress
270 * batch of settings. 'auth' is null for anonymous lookup.
272 private appendSettingsFromNet(orgId: number, names: string[],
273 batch: OrgSettingsBatch, auth?: string): Promise<OrgSettingsBatch> {
275 if (names.length === 0) { return Promise.resolve(batch); }
277 return this.net.request(
279 'open-ils.actor.ou_setting.ancestor_default.batch',
282 ).pipe(tap(settings => {
283 Object.keys(settings).forEach(key => {
284 const val = settings[key]; // null or hash
285 batch[key] = val ? val.value : null;
287 })).toPromise().then(_ => batch);
290 // Given a set of setting names and an in-progress settings batch,
291 // return the list of names which are not yet represented in the ,
292 // indicating their data needs to be fetched from the next layer up
293 // (cache, network, etc.).
294 settingNamesRemaining(names: string[], settings: OrgSettingsBatch): string[] {
295 return names.filter(name => !(name in settings));
298 // Returns a key/value batch of org unit settings.
299 // Cacheable settings (orgId === here) are pulled from local cache,
300 // then IndexedDB, then the network. Non-cacheable settings are
301 // fetched from the network each time.
302 settings(name: string | string[],
303 orgId?: number, anonymous?: boolean): Promise<OrgSettingsBatch> {
305 let names = [].concat(name);
306 let auth: string = null;
307 let useCache = false;
308 const batch: OrgSettingsBatch = {};
310 if (names.length === 0) { return Promise.resolve(batch); }
312 if (this.auth.user()) {
314 useCache = Number(orgId) === Number(this.auth.user().ws_ou());
316 orgId = this.auth.user().ws_ou();
320 // avoid passing auth token when anonymous is requested.
322 auth = this.auth.token();
325 } else if (!anonymous) {
326 console.warn('Attempt to fetch org setting(s)',
327 name, 'in non-anonymous mode without an authtoken');
328 return Promise.resolve({});
332 return this.appendSettingsFromNet(orgId, names, batch, auth);
335 this.appendSettingsFromCache(names, batch);
336 names = this.settingNamesRemaining(names, batch);
338 return this.appendSettingsFromDb(names, batch)
341 names = this.settingNamesRemaining(names, batch);
343 return this.appendSettingsFromNet(orgId, names, batch, auth)
344 .then(__ => this.addSettingsToDb(names, batch));
348 // remove setting values cached in the indexeddb settings table.
349 clearCachedSettings(): Promise<any> {
350 return this.db.request({