LP#1846042: take advantage of ngbDropdown container="body"
[Evergreen.git] / Open-ILS / src / eg2 / src / app / staff / share / admin-page / admin-page.component.ts
1 import {Component, Input, OnInit, TemplateRef, ViewChild} from '@angular/core';
2 import {ActivatedRoute} from '@angular/router';
3 import {Location} from '@angular/common';
4 import {IdlService, IdlObject} from '@eg/core/idl.service';
5 import {FormatService} from '@eg/core/format.service';
6 import {GridDataSource, GridColumn} from '@eg/share/grid/grid';
7 import {GridComponent} from '@eg/share/grid/grid.component';
8 import {TranslateComponent} from '@eg/share/translate/translate.component';
9 import {ToastService} from '@eg/share/toast/toast.service';
10 import {Pager} from '@eg/share/util/pager';
11 import {PcrudService} from '@eg/core/pcrud.service';
12 import {OrgService} from '@eg/core/org.service';
13 import {PermService} from '@eg/core/perm.service';
14 import {AuthService} from '@eg/core/auth.service';
15 import {FmRecordEditorComponent, FmFieldOptions
16     } from '@eg/share/fm-editor/fm-editor.component';
17 import {StringComponent} from '@eg/share/string/string.component';
18 import {OrgFamily} from '@eg/share/org-family-select/org-family-select.component';
19
20 /**
21  * General purpose CRUD interface for IDL objects
22  *
23  * Object types using this component must be editable via PCRUD.
24  */
25
26 @Component({
27     selector: 'eg-admin-page',
28     templateUrl: './admin-page.component.html'
29 })
30
31 export class AdminPageComponent implements OnInit {
32
33     @Input() idlClass: string;
34
35     // Default sort field, used when no grid sorting is applied.
36     @Input() sortField: string;
37
38     // Data source may be provided by the caller.  This gives the caller
39     // complete control over the contents of the grid.  If no data source
40     // is provided, a generic one is create which is sufficient for data
41     // that requires no special handling, filtering, etc.
42     @Input() dataSource: GridDataSource;
43
44     // Size of create/edito dialog.  Uses large by default.
45     @Input() dialogSize: 'sm' | 'lg' = 'lg';
46
47     // comma-separated list of fields to hide.
48     // This does not imply all other fields should be visible, only that
49     // the selected fields will be hidden.
50     @Input() hideGridFields: string;
51
52     // If an org unit field is specified, an org unit filter
53     // is added to the top of the page.
54     @Input() orgField: string;
55
56     // Disable the auto-matic org unit field filter
57     @Input() disableOrgFilter: boolean;
58
59     // Include objects linking to org units which are ancestors
60     // of the selected org unit.
61     @Input() includeOrgAncestors: boolean;
62
63     // Ditto includeOrgAncestors, but descendants.
64     @Input() includeOrgDescendants: boolean;
65
66     // Optional grid persist key.  This is the part of the key
67     // following eg.grid.
68     @Input() persistKey: string;
69
70     // Optional path component to add to the generated grid persist key,
71     // formatted as (for example):
72     // 'eg.grid.admin.${persistKeyPfx}.config.billing_type'
73     @Input() persistKeyPfx: string;
74
75     // Optional comma-separated list of read-only fields
76     @Input() readonlyFields: string;
77
78     // Optional template containing help/about text which will
79     // be added to the page, above the grid.
80     @Input() helpTemplate: TemplateRef<any>;
81
82     // Override field options for create/edit dialog
83     @Input() fieldOptions: {[field: string]: FmFieldOptions};
84
85     // Override default values for fm-editor
86     @Input() defaultNewRecord: IdlObject;
87
88     // Used as the first part of the routerLink path when creating
89     // links to related tables via configField's.
90     @Input() configLinkBasePath: string;
91
92     @ViewChild('grid', { static: true }) grid: GridComponent;
93     @ViewChild('editDialog', { static: true }) editDialog: FmRecordEditorComponent;
94     @ViewChild('successString', { static: true }) successString: StringComponent;
95     @ViewChild('createString', { static: true }) createString: StringComponent;
96     @ViewChild('createErrString', { static: true }) createErrString: StringComponent;
97     @ViewChild('updateFailedString', { static: true }) updateFailedString: StringComponent;
98     @ViewChild('deleteFailedString', { static: true }) deleteFailedString: StringComponent;
99     @ViewChild('deleteSuccessString', { static: true }) deleteSuccessString: StringComponent;
100     @ViewChild('translator', { static: true }) translator: TranslateComponent;
101
102     idlClassDef: any;
103     pkeyField: string;
104     configFields: any[]; // IDL field definitions
105
106     // True if any columns on the object support translations
107     translateRowIdx: number;
108     translateFieldIdx: number;
109     translatableFields: string[];
110
111     contextOrg: IdlObject;
112     searchOrgs: OrgFamily;
113     orgFieldLabel: string;
114     viewPerms: string;
115     canCreate: boolean;
116
117     // Filters may be passed via URL query param.
118     // They are used to augment the grid data search query.
119     gridFilters: {[key: string]: string | number};
120
121     constructor(
122         private route: ActivatedRoute,
123         private ngLocation: Location,
124         private format: FormatService,
125         public idl: IdlService,
126         private org: OrgService,
127         public auth: AuthService,
128         public pcrud: PcrudService,
129         private perm: PermService,
130         public toast: ToastService
131     ) {
132         this.translatableFields = [];
133         this.configFields = [];
134     }
135
136     applyOrgValues(orgId?: number) {
137
138         if (this.disableOrgFilter) {
139             this.orgField = null;
140             return;
141         }
142
143         if (!this.orgField) {
144             // If no org unit field is specified, try to find one.
145             // If an object type has multiple org unit fields, the
146             // caller should specify one or disable org unit filter.
147             this.idlClassDef.fields.forEach(field => {
148                 if (field['class'] === 'aou') {
149                     this.orgField = field.name;
150                 }
151             });
152         }
153
154         if (this.orgField) {
155             this.orgFieldLabel = this.idlClassDef.field_map[this.orgField].label;
156             this.contextOrg = this.org.get(orgId) || this.org.root();
157             this.searchOrgs = {primaryOrgId: this.contextOrg.id()};
158         }
159     }
160
161     ngOnInit() {
162
163         this.idlClassDef = this.idl.classes[this.idlClass];
164         this.pkeyField = this.idlClassDef.pkey || 'id';
165
166         this.translatableFields =
167             this.idlClassDef.fields.filter(f => f.i18n).map(f => f.name);
168
169         if (!this.persistKey) {
170             this.persistKey =
171                 'admin.' +
172                 (this.persistKeyPfx ? this.persistKeyPfx + '.' : '') +
173                 this.idlClassDef.table;
174         }
175
176
177         // Note the field filter could be based purely on fields
178         // which are links, but that leads to cases where links
179         // are created to tables which are too big and/or admin
180         // interfaces which are not otherwise used because they
181         // have custom UI's instead.
182         // this.idlClassDef.fields.filter(f => f.datatype === 'link');
183         this.configFields =
184             this.idlClassDef.fields.filter(f => f.config_field);
185
186         // gridFilters are a JSON encoded string
187         const filters = this.route.snapshot.queryParamMap.get('gridFilters');
188         if (filters) {
189             try {
190                 this.gridFilters = JSON.parse(filters);
191             } catch (E) {
192                 console.error('Invalid grid filters provided: ', filters);
193             }
194
195             // Use the grid filters as the basis for our default
196             // new record (passed to fm-editor).
197             if (!this.defaultNewRecord) {
198                 const rec = this.idl.create(this.idlClass);
199                 Object.keys(this.gridFilters).forEach(field => {
200                     // When filtering on the primary key of the current
201                     // object type, avoid using it in the default new object.
202                     if (rec[field] && this.pkeyField !== field) {
203                         rec[field](this.gridFilters[field]);
204                     }
205                 });
206                 this.defaultNewRecord = rec;
207             }
208         }
209
210         // Limit the view org selector to orgs where the user has
211         // permacrud-encoded view permissions.
212         const pc = this.idlClassDef.permacrud;
213         if (pc && pc.retrieve) {
214             this.viewPerms = pc.retrieve.perms;
215         }
216
217         const contextOrg = this.route.snapshot.queryParamMap.get('contextOrg');
218         this.checkCreatePerms();
219         this.applyOrgValues(Number(contextOrg));
220
221         // If the caller provides not data source, create a generic one.
222         if (!this.dataSource) {
223             this.initDataSource();
224         }
225
226         // TODO: pass the row activate handler via the grid markup
227         this.grid.onRowActivate.subscribe(
228             (idlThing: IdlObject) => this.showEditDialog(idlThing)
229         );
230     }
231
232     checkCreatePerms() {
233         this.canCreate = false;
234         const pc = this.idlClassDef.permacrud || {};
235         const perms = pc.create ? pc.create.perms : [];
236         if (perms.length === 0) { return; }
237
238         this.perm.hasWorkPermAt(perms, true).then(permMap => {
239             Object.keys(permMap).forEach(key => {
240                 if (permMap[key].length > 0) {
241                     this.canCreate = true;
242                 }
243             });
244         });
245     }
246
247     initDataSource() {
248         this.dataSource = new GridDataSource();
249
250         this.dataSource.getRows = (pager: Pager, sort: any[]) => {
251             const orderBy: any = {};
252
253             if (sort.length) {
254                 // Sort specified from grid
255                 orderBy[this.idlClass] = sort[0].name + ' ' + sort[0].dir;
256
257             } else if (this.sortField) {
258                 // Default sort field
259                 orderBy[this.idlClass] = this.sortField;
260             }
261
262             const searchOps = {
263                 offset: pager.offset,
264                 limit: pager.limit,
265                 order_by: orderBy
266             };
267
268             console.debug(this.dataSource);
269             console.debug(this.dataSource.filters);
270             if (!this.contextOrg && !this.gridFilters && !Object.keys(this.dataSource.filters).length) {
271                 // No org filter -- fetch all rows
272                 return this.pcrud.retrieveAll(
273                     this.idlClass, searchOps, {fleshSelectors: true});
274             }
275
276             const search: any = new Array();
277             const orgFilter: any = {};
278
279             if (this.orgField && (this.searchOrgs || this.contextOrg)) {
280                 orgFilter[this.orgField] =
281                     this.searchOrgs.orgIds || [this.contextOrg.id()];
282                 search.push(orgFilter)
283             }
284
285             Object.keys(this.dataSource.filters).forEach(key => {
286                 Object.keys(this.dataSource.filters[key]).forEach(key2 => {
287                     search.push(this.dataSource.filters[key][key2]);
288                 });
289             });
290
291             // FIXME - do we want to remove this, whose only present user
292             // is the booking grid, in favor of switching it to the built-in
293             // grid filtering?
294             if (this.gridFilters) {
295                 // Lay the URL grid filters over our search object.
296                 Object.keys(this.gridFilters).forEach(key => {
297                     search[key] = this.gridFilters[key];
298                 });
299             }
300
301             return this.pcrud.search(
302                 this.idlClass, search, searchOps, {fleshSelectors: true});
303         };
304     }
305
306     showEditDialog(idlThing: IdlObject): Promise<any> {
307         this.editDialog.mode = 'update';
308         this.editDialog.recordId = idlThing[this.pkeyField]();
309         return new Promise((resolve, reject) => {
310             this.editDialog.open({size: this.dialogSize}).subscribe(
311                 result => {
312                     this.successString.current()
313                         .then(str => this.toast.success(str));
314                     this.grid.reload();
315                     resolve(result);
316                 },
317                 error => {
318                     this.updateFailedString.current()
319                         .then(str => this.toast.danger(str));
320                     reject(error);
321                 }
322             );
323         });
324     }
325
326     editSelected(idlThings: IdlObject[]) {
327
328         // Edit each IDL thing one at a time
329         const editOneThing = (thing: IdlObject) => {
330             if (!thing) { return; }
331
332             this.showEditDialog(thing).then(
333                 () => editOneThing(idlThings.shift()));
334         };
335
336         editOneThing(idlThings.shift());
337     }
338
339     deleteSelected(idlThings: IdlObject[]) {
340         idlThings.forEach(idlThing => idlThing.isdeleted(true));
341         this.pcrud.autoApply(idlThings).subscribe(
342             val => {
343                 console.debug('deleted: ' + val);
344                 this.deleteSuccessString.current()
345                     .then(str => this.toast.success(str));
346             },
347             err => {
348                 this.deleteFailedString.current()
349                     .then(str => this.toast.danger(str));
350             },
351             ()  => this.grid.reload()
352         );
353     }
354
355     createNew() {
356         this.editDialog.mode = 'create';
357         // We reuse the same editor for all actions.  Be sure
358         // create action does not try to modify an existing record.
359         this.editDialog.recordId = null;
360         this.editDialog.record = null;
361         this.editDialog.open({size: this.dialogSize}).subscribe(
362             ok => {
363                 this.createString.current()
364                     .then(str => this.toast.success(str));
365                 this.grid.reload();
366             },
367             rejection => {
368                 if (!rejection.dismissed) {
369                     this.createErrString.current()
370                         .then(str => this.toast.danger(str));
371                 }
372             }
373         );
374     }
375     // Open the field translation dialog.
376     // Link the next/previous actions to cycle through each translatable
377     // field on each row.
378     translate() {
379         this.translateRowIdx = 0;
380         this.translateFieldIdx = 0;
381         this.translator.fieldName = this.translatableFields[this.translateFieldIdx];
382         this.translator.idlObject = this.dataSource.data[this.translateRowIdx];
383
384         this.translator.nextString = () => {
385
386             if (this.translateFieldIdx < this.translatableFields.length - 1) {
387                 this.translateFieldIdx++;
388
389             } else if (this.translateRowIdx < this.dataSource.data.length - 1) {
390                 this.translateRowIdx++;
391                 this.translateFieldIdx = 0;
392             }
393
394             this.translator.idlObject =
395                 this.dataSource.data[this.translateRowIdx];
396             this.translator.fieldName =
397                 this.translatableFields[this.translateFieldIdx];
398         };
399
400         this.translator.prevString = () => {
401
402             if (this.translateFieldIdx > 0) {
403                 this.translateFieldIdx--;
404
405             } else if (this.translateRowIdx > 0) {
406                 this.translateRowIdx--;
407                 this.translateFieldIdx = 0;
408             }
409
410             this.translator.idlObject =
411                 this.dataSource.data[this.translateRowIdx];
412             this.translator.fieldName =
413                 this.translatableFields[this.translateFieldIdx];
414         };
415
416         this.translator.open({size: 'lg'});
417     }
418
419     // Construct a routerLink path for a configField.
420     configFieldRouteLink(row: any, col: GridColumn): string {
421         const cf = this.configFields.filter(field => field.name === col.name)[0];
422         const linkClass = this.idl.classes[cf['class']];
423         const pathParts = linkClass.table.split(/\./); // schema.tablename
424         return `${this.configLinkBasePath}/${pathParts[0]}/${pathParts[1]}`;
425     }
426
427     // Compiles a gridFilter value used when navigating to a linked
428     // class via configField.  The filter ensures the linked page
429     // only shows rows which refer back to the object from which the
430     // link was clicked.
431     configFieldRouteParams(row: any, col: GridColumn): any {
432         const cf = this.configFields.filter(field => field.name === col.name)[0];
433         let value = this.configFieldLinkedValue(row, col);
434
435         // For certain has-a relationships, the linked object will be
436         // fleshed so its display (selector) value can be used.
437         // Extract the scalar value found at the remote target field.
438         if (value && typeof value === 'object') { value = value[cf.key](); }
439
440         const filter: any = {};
441         filter[cf.key] = value;
442
443         return {gridFilters : JSON.stringify(filter)};
444     }
445
446     // Returns the value on the local object for the field which
447     // refers to the remote object.  This may be a scalar or a
448     // fleshed IDL object.
449     configFieldLinkedValue(row: any, col: GridColumn): any {
450         const cf = this.configFields.filter(field => field.name === col.name)[0];
451         const linkClass = this.idl.classes[cf['class']];
452
453         // cf.key is the name of the field on the linked object that matches
454         // the value on our local object.
455         // In as has_many relationship, the remote field has its own
456         // 'key' value which determines which field on the local object
457         // represents the other end of the relationship.  This is
458         // typically, but not always the local pkey field.
459
460         const localField =
461             cf.reltype === 'has_many' ?
462             (linkClass.field_map[cf.key].key || this.pkeyField) : cf.name;
463
464         return row[localField]();
465     }
466
467     // Returns a URL suitable for using as an href.
468     // We use an href to jump to the secondary admin page because
469     // routerLink within the same base component results in component
470     // reuse of a series of components which were not designed with
471     // reuse in mind.
472     configFieldLinkUrl(row: any, col: GridColumn): string {
473         const path = this.configFieldRouteLink(row, col);
474         const filters = this.configFieldRouteParams(row, col);
475         const url = path + '?gridFilters=' +
476             encodeURIComponent(filters.gridFilters);
477
478         return this.ngLocation.prepareExternalUrl(url);
479     }
480
481     configLinkLabel(row: any, col: GridColumn): string {
482         const cf = this.configFields.filter(field => field.name === col.name)[0];
483
484         // Has-many links have no specific value to use for display
485         // so just use the column label.
486         if (cf.reltype === 'has_many') { return col.label; }
487
488         return this.format.transform({
489             value: row[col.name](),
490             idlClass: this.idlClass,
491             idlField: col.name
492         });
493     }
494
495     clearGridFiltersUrl(): string {
496         const parts = this.idlClassDef.table.split(/\./);
497         const url = this.configLinkBasePath + '/' + parts[0] + '/' + parts[1];
498         return this.ngLocation.prepareExternalUrl(url);
499     }
500 }
501
502