b6e2638bbfa27f849f33423c15f8555c8867ac53
[working/Evergreen.git] / Open-ILS / src / eg2 / src / app / share / fm-editor / fm-editor.component.ts
1 import {Component, OnInit, Input, ViewChild,
2     Output, EventEmitter, TemplateRef} from '@angular/core';
3 import {IdlService, IdlObject} from '@eg/core/idl.service';
4 import {Observable} from 'rxjs';
5 import {map} from 'rxjs/operators';
6 import {AuthService} from '@eg/core/auth.service';
7 import {PcrudService} from '@eg/core/pcrud.service';
8 import {DialogComponent} from '@eg/share/dialog/dialog.component';
9 import {ToastService} from '@eg/share/toast/toast.service';
10 import {StringComponent} from '@eg/share/string/string.component';
11 import {NgbModal, NgbModalOptions} from '@ng-bootstrap/ng-bootstrap';
12 import {ComboboxEntry} from '@eg/share/combobox/combobox.component';
13 import {TranslateComponent} from '@eg/staff/share/translate/translate.component';
14
15
16 interface CustomFieldTemplate {
17     template: TemplateRef<any>;
18
19     // Allow the caller to pass in a free-form context blob to
20     // be addedto the caller's custom template context, along
21     // with our stock context.
22     context?: {[fields: string]: any};
23 }
24
25 export interface CustomFieldContext {
26     // Current create/edit/view record
27     record: IdlObject;
28
29     // IDL field definition blob
30     field: any;
31
32     // additional context values passed via CustomFieldTemplate
33     [fields: string]: any;
34 }
35
36 // Collection of extra options that may be applied to fields
37 // for controling non-default behaviour.
38 export interface FmFieldOptions {
39
40     // Render the field as a combobox using these values, regardless
41     // of the field's datatype.
42     customValues?: {[field: string]: ComboboxEntry[]};
43
44     // Provide / override the "selector" value for the linked class.
45     // This is the field the combobox will search for typeahead.  If no
46     // field is defined, the "selector" field is used.  If no "selector"
47     // field exists, the combobox will pre-load all linked values so
48     // the user can click to navigate.
49     linkedSearchField?: string;
50
51     // When true for combobox fields, pre-fetch the combobox data
52     // so the user can click or type to find values.
53     preloadLinkedValues?: boolean;
54
55     // Directly override the required state of the field.
56     // This only has an affect if the value is true.
57     isRequired?: boolean;
58
59     // If this function is defined, the function will be called
60     // at render time to see if the field should be marked are required.
61     // This supersedes all other isRequired specifiers.
62     isRequiredOverride?: (field: string, record: IdlObject) => boolean;
63
64     // Directly apply the readonly status of the field.
65     // This only has an affect if the value is true.
66     isReadonly?: boolean;
67
68     // Render the field using this custom template instead of chosing
69     // from the default set of form inputs.
70     customTemplate?: CustomFieldTemplate;
71 }
72
73 @Component({
74   selector: 'eg-fm-record-editor',
75   templateUrl: './fm-editor.component.html',
76   /* align checkboxes when not using class="form-check" */
77   styles: ['input[type="checkbox"] {margin-left: 0px;}']
78 })
79 export class FmRecordEditorComponent
80     extends DialogComponent implements OnInit {
81
82     // IDL class hint (e.g. "aou")
83     @Input() idlClass: string;
84
85     recId: any;
86
87     // IDL record we are editing
88     record: IdlObject;
89
90     // Permissions extracted from the permacrud defs in the IDL
91     // for the current IDL class
92     modePerms: {[mode: string]: string};
93
94     // Collection of FmFieldOptions for specifying non-default
95     // behaviour for each field (by field name).
96     @Input() fieldOptions: {[fieldName: string]: FmFieldOptions} = {};
97
98     // list of fields that should not be displayed
99     @Input() hiddenFieldsList: string[] = [];
100     @Input() hiddenFields: string; // comma-separated string version
101
102     // list of fields that should always be read-only
103     @Input() readonlyFieldsList: string[] = [];
104     @Input() readonlyFields: string; // comma-separated string version
105
106     // list of required fields; this supplements what the IDL considers
107     // required
108     @Input() requiredFieldsList: string[] = [];
109     @Input() requiredFields: string; // comma-separated string version
110
111     // list of org_unit fields where a default value may be applied by
112     // the org-select if no value is present.
113     @Input() orgDefaultAllowedList: string[] = [];
114     @Input() orgDefaultAllowed: string; // comma-separated string version
115
116     // IDL record display label.  Defaults to the IDL label.
117     @Input() recordLabel: string;
118
119     // When true at the component level, pre-fetch the combobox data
120     // for all combobox fields.  See also FmFieldOptions.
121     @Input() preloadLinkedValues: boolean;
122
123     // Display within a modal dialog window or inline in the page.
124     @Input() displayMode: 'dialog' | 'inline' = 'dialog';
125
126     // Emit the modified object when the save action completes.
127     @Output() onSave$ = new EventEmitter<IdlObject>();
128
129     // Emit the original object when the save action is canceled.
130     @Output() onCancel$ = new EventEmitter<IdlObject>();
131
132     // Emit an error message when the save action fails.
133     @Output() onError$ = new EventEmitter<string>();
134
135     @ViewChild('translator') private translator: TranslateComponent;
136     @ViewChild('successStr') successStr: StringComponent;
137     @ViewChild('failStr') failStr: StringComponent;
138
139     // IDL info for the the selected IDL class
140     idlDef: any;
141
142     // Can we edit the primary key?
143     pkeyIsEditable = false;
144
145     // List of IDL field definitions.  This is a subset of the full
146     // list of fields on the IDL, since some are hidden, virtual, etc.
147     fields: any[];
148
149     // DOM id prefix to prevent id collisions.
150     idPrefix: string;
151
152     // mode: 'create' for creating a new record,
153     //       'update' for editing an existing record
154     //       'view' for viewing an existing record without editing
155     @Input() mode: 'create' | 'update' | 'view' = 'create';
156
157     // Record ID to view/update.  Value is dynamic.  Records are not
158     // fetched until .open() is called.
159     @Input() set recordId(id: any) {
160         if (id) { this.recId = id; }
161     }
162
163     // custom function for munging the record before it gets saved;
164     // will get passed mode and the record itself
165     @Input() preSave: Function;
166
167     constructor(
168       private modal: NgbModal, // required for passing to parent
169       private idl: IdlService,
170       private auth: AuthService,
171       private toast: ToastService,
172       private pcrud: PcrudService) {
173       super(modal);
174     }
175
176     // Avoid fetching data on init since that may lead to unnecessary
177     // data retrieval.
178     ngOnInit() {
179
180         // In case the caller sets the value to null / undef.
181         if (!this.fieldOptions) { this.fieldOptions = {}; }
182
183         this.listifyInputs();
184         this.idlDef = this.idl.classes[this.idlClass];
185         this.recordLabel = this.idlDef.label;
186
187         // Add some randomness to the generated DOM IDs to ensure against clobbering
188         this.idPrefix = 'fm-editor-' + Math.floor(Math.random() * 100000);
189
190         if (this.isDialog()) {
191             this.onOpen$.subscribe(() => this.initRecord());
192         } else {
193             this.initRecord();
194         }
195     }
196
197     open(args?: NgbModalOptions): Observable<any> {
198         if (!args) {
199             args = {};
200         }
201         // ensure we don't hang on to our copy of the record
202         // if the user dismisses the dialog
203         args.beforeDismiss = () => {
204             this.record = undefined;
205             return true;
206         };
207         return super.open(args);
208     }
209
210     isDialog(): boolean {
211         return this.displayMode === 'dialog';
212     }
213
214     // Set the record value and clear the recId value to
215     // indicate the record is our current source of data.
216     setRecord(record: IdlObject) {
217         this.record = record;
218         this.recId = null;
219     }
220
221     // Translate comma-separated string versions of various inputs
222     // to arrays.
223     private listifyInputs() {
224         if (this.hiddenFields) {
225             this.hiddenFieldsList = this.hiddenFields.split(/,/);
226         }
227         if (this.readonlyFields) {
228             this.readonlyFieldsList = this.readonlyFields.split(/,/);
229         }
230         if (this.requiredFields) {
231             this.requiredFieldsList = this.requiredFields.split(/,/);
232         }
233         if (this.orgDefaultAllowed) {
234             this.orgDefaultAllowedList = this.orgDefaultAllowed.split(/,/);
235         }
236     }
237
238     private initRecord(): Promise<any> {
239
240         const pc = this.idlDef.permacrud || {};
241         this.modePerms = {
242             view:   pc.retrieve ? pc.retrieve.perms : [],
243             create: pc.create ? pc.create.perms : [],
244             update: pc.update ? pc.update.perms : [],
245         };
246
247         this.pkeyIsEditable = !('pkey_sequence' in this.idlDef);
248
249         if (this.mode === 'update' || this.mode === 'view') {
250
251             let promise;
252             if (this.record && this.recId === null) {
253                 promise = Promise.resolve(this.record);
254             } else {
255                 promise =
256                     this.pcrud.retrieve(this.idlClass, this.recId).toPromise();
257             }
258
259             return promise.then(rec => {
260
261                 if (!rec) {
262                     return Promise.reject(`No '${this.idlClass}'
263                         record found with id ${this.recId}`);
264                 }
265
266                 this.record = rec;
267                 this.convertDatatypesToJs();
268                 return this.getFieldList();
269             });
270         }
271
272         // In 'create' mode.
273         //
274         // Create a new record from the stub record provided by the
275         // caller or a new from-scratch record
276         this.setRecord(this.record || this.idl.create(this.idlClass));
277
278         return this.getFieldList();
279     }
280
281     // Modifies the FM record in place, replacing IDL-compatible values
282     // with native JS values.
283     private convertDatatypesToJs() {
284         this.idlDef.fields.forEach(field => {
285             if (field.datatype === 'bool') {
286                 if (this.record[field.name]() === 't') {
287                     this.record[field.name](true);
288                 } else if (this.record[field.name]() === 'f') {
289                     this.record[field.name](false);
290                 }
291             }
292         });
293     }
294
295     // Modifies the provided FM record in place, replacing JS values
296     // with IDL-compatible values.
297     convertDatatypesToIdl(rec: IdlObject) {
298         const fields = this.idlDef.fields;
299         fields.forEach(field => {
300             if (field.datatype === 'bool') {
301                 if (rec[field.name]() === true) {
302                     rec[field.name]('t');
303                 // } else if (rec[field.name]() === false) {
304                 } else { // TODO: some bools can be NULL
305                     rec[field.name]('f');
306                 }
307             } else if (field.datatype === 'org_unit') {
308                 const org = rec[field.name]();
309                 if (org && typeof org === 'object') {
310                     rec[field.name](org.id());
311                 }
312             }
313         });
314     }
315
316     // Returns the name of the field on a class (typically via a linked
317     // field) that acts as the selector value for display / search.
318     getClassSelector(class_: string): string {
319         if (class_) {
320             const linkedClass = this.idl.classes[class_];
321             return linkedClass.pkey ?
322                 linkedClass.field_map[linkedClass.pkey].selector : null;
323         }
324         return null;
325     }
326
327     private flattenLinkedValues(field: any, list: IdlObject[]): ComboboxEntry[] {
328         const class_ = field.class;
329         const fieldOptions = this.fieldOptions[field.name] || {};
330         const idField = this.idl.classes[class_].pkey;
331
332         const selector = fieldOptions.linkedSearchField
333             || this.getClassSelector(class_) || idField;
334
335         return list.map(item => {
336             return {id: item[idField](), label: item[selector]()};
337         });
338     }
339
340     private getFieldList(): Promise<any> {
341
342         this.fields = this.idlDef.fields.filter(f =>
343             !f.virtual && !this.hiddenFieldsList.includes(f.name)
344         );
345
346         // Wait for all network calls to complete
347         return Promise.all(
348             this.fields.map(field => this.constructOneField(field)));
349     }
350
351     private constructOneField(field: any): Promise<any> {
352
353         let promise = null;
354         const fieldOptions = this.fieldOptions[field.name] || {};
355
356         field.readOnly = this.mode === 'view'
357             || fieldOptions.isReadonly === true
358             || this.readonlyFieldsList.includes(field.name);
359
360         if (fieldOptions.isRequiredOverride) {
361             field.isRequired = () => {
362                 return fieldOptions.isRequiredOverride(field.name, this.record);
363             };
364         } else {
365             field.isRequired = () => {
366                 return field.required
367                     || fieldOptions.isRequired
368                     || this.requiredFieldsList.includes(field.name);
369             };
370         }
371
372         if (fieldOptions.customValues) {
373
374             field.linkedValues = fieldOptions.customValues;
375
376         } else if (field.datatype === 'link' && field.readOnly) {
377
378             // no need to fetch all possible values for read-only fields
379             const idToFetch = this.record[field.name]();
380
381             if (idToFetch) {
382
383                 // If the linked class defines a selector field, fetch the
384                 // linked data so we can display the data within the selector
385                 // field.  Otherwise, avoid the network lookup and let the
386                 // bare value (usually an ID) be displayed.
387                 const selector = fieldOptions.linkedSearchField ||
388                     this.getClassSelector(field.class);
389
390                 if (selector && selector !== field.name) {
391                     promise = this.pcrud.retrieve(field.class, idToFetch)
392                         .toPromise().then(list => {
393                             field.linkedValues =
394                                 this.flattenLinkedValues(field, Array(list));
395                         });
396                 } else {
397                     // No selector, display the raw id/key value.
398                     field.linkedValues = [{id: idToFetch, name: idToFetch}];
399                 }
400             }
401
402         } else if (field.datatype === 'link') {
403
404             promise = this.wireUpCombobox(field);
405
406         } else if (field.datatype === 'org_unit') {
407             field.orgDefaultAllowed =
408                 this.orgDefaultAllowedList.includes(field.name);
409         }
410
411         if (fieldOptions.customTemplate) {
412             field.template = fieldOptions.customTemplate.template;
413             field.context = fieldOptions.customTemplate.context;
414         }
415
416         return promise || Promise.resolve();
417     }
418
419     wireUpCombobox(field: any): Promise<any> {
420
421         const fieldOptions = this.fieldOptions[field.name] || {};
422
423         // globally preloading unless a field-specific value is set.
424         if (this.preloadLinkedValues) {
425             if (!('preloadLinkedValues' in fieldOptions)) {
426                 fieldOptions.preloadLinkedValues = true;
427             }
428         }
429
430         const selector = fieldOptions.linkedSearchField ||
431             this.getClassSelector(field.class);
432
433         if (!selector && !fieldOptions.preloadLinkedValues) {
434             // User probably expects an async data source, but we can't
435             // provide one without a selector.  Warn the user.
436             console.warn(`Class ${field.class} has no selector.
437                 Pre-fetching all rows for combobox`);
438         }
439
440         if (fieldOptions.preloadLinkedValues || !selector) {
441             return this.pcrud.retrieveAll(field.class, {}, {atomic : true})
442             .toPromise().then(list => {
443                 field.linkedValues =
444                     this.flattenLinkedValues(field, list);
445             });
446         }
447
448         // If we have a selector, wire up for async data retrieval
449         field.linkedValuesSource =
450             (term: string): Observable<ComboboxEntry> => {
451
452             const search = {};
453             const orderBy = {order_by: {}};
454             const idField = this.idl.classes[field.class].pkey || 'id';
455
456             search[selector] = {'ilike': `%${term}%`};
457             orderBy.order_by[field.class] = selector;
458
459             return this.pcrud.search(field.class, search, orderBy)
460             .pipe(map(idlThing =>
461                 // Map each object into a ComboboxEntry upon arrival
462                 this.flattenLinkedValues(field, [idlThing])[0]
463             ));
464         };
465
466         // Using an async data source, but a value is already set
467         // on the field.  Fetch the linked object and add it to the
468         // combobox entry list so it will be avilable for display
469         // at dialog load time.
470         const linkVal = this.record[field.name]();
471         if (linkVal !== null && linkVal !== undefined) {
472             return this.pcrud.retrieve(field.class, linkVal).toPromise()
473             .then(idlThing => {
474                 field.linkedValues =
475                     this.flattenLinkedValues(field, Array(idlThing));
476             });
477         }
478
479         // No linked value applied, nothing to pre-fetch.
480         return Promise.resolve();
481     }
482
483     // Returns a context object to be inserted into a custom
484     // field template.
485     customTemplateFieldContext(fieldDef: any): CustomFieldContext {
486         return Object.assign(
487             {   record : this.record,
488                 field: fieldDef // from this.fields
489             },  fieldDef.context || {}
490         );
491     }
492
493     save() {
494         const recToSave = this.idl.clone(this.record);
495         if (this.preSave) {
496             this.preSave(this.mode, recToSave);
497         }
498         this.convertDatatypesToIdl(recToSave);
499         this.pcrud[this.mode]([recToSave]).toPromise().then(
500             result => {
501                 this.onSave$.emit(result);
502                 this.successStr.current().then(msg => this.toast.success(msg));
503                 if (this.isDialog()) { this.record = undefined; this.close(result); }
504             },
505             error => {
506                 this.onError$.emit(error);
507                 this.failStr.current().then(msg => this.toast.warning(msg));
508                 if (this.isDialog()) { this.error(error); }
509             }
510         );
511     }
512
513     cancel() {
514         this.onCancel$.emit(this.record);
515         this.record = undefined;
516         this.close();
517     }
518
519     closeEditor() {
520         this.record = undefined;
521         this.close();
522     }
523
524     // Returns a string describing the type of input to display
525     // for a given field.  This helps cut down on the if/else
526     // nesti-ness in the template.  Each field will match
527     // exactly one type.
528     inputType(field: any): string {
529
530         if (field.template) {
531             return 'template';
532         }
533
534         // Some widgets handle readOnly for us.
535         if (   field.datatype === 'timestamp'
536             || field.datatype === 'org_unit'
537             || field.datatype === 'bool') {
538             return field.datatype;
539         }
540
541         if (field.readOnly) {
542             if (field.datatype === 'money') {
543                 return 'readonly-money';
544             }
545
546             if (field.datatype === 'link' || field.linkedValues) {
547                 return 'readonly-list';
548             }
549
550             return 'readonly';
551         }
552
553         if (field.datatype === 'id' && !this.pkeyIsEditable) {
554             return 'readonly';
555         }
556
557         if (   field.datatype === 'int'
558             || field.datatype === 'float'
559             || field.datatype === 'money') {
560             return field.datatype;
561         }
562
563         if (field.datatype === 'link' || field.linkedValues) {
564             return 'list';
565         }
566
567         // datatype == text / interval / editable-pkey
568         return 'text';
569     }
570
571     openTranslator(field: string) {
572         this.translator.fieldName = field;
573         this.translator.idlObject = this.record;
574
575         this.translator.open().subscribe(
576             newValue => {
577                 if (newValue) {
578                     this.record[field](newValue);
579                 }
580             }
581         );
582     }
583 }
584
585