LP#1727487 Display field JS utils more docs
[working/Evergreen.git] / Open-ILS / web / js / ui / default / staff / cat / services / record.js
1 /**
2  * Simple directive for rending the HTML view of a MARC record.
3  *
4  * <eg-record-html record-id="myRecordIdScopeVariable"></eg-record-id>
5  * OR
6  * <eg-record-html marc-xml="myMarcXmlVariable"></eg-record-html>
7  *
8  * The value of myRecordIdScopeVariable is watched internally and the 
9  * record is updated to match.
10  */
11 angular.module('egCoreMod')
12
13 .directive('egRecordHtml', function() {
14     return {
15         restrict : 'AE',
16         scope : {
17             recordId : '=',
18             marcXml  : '@',
19         },
20         link : function(scope, element, attrs) {
21             scope.element = angular.element(element);
22
23             // kill refs to destroyed DOM elements
24             element.bind("$destroy", function() {
25                 delete scope.element;
26             });
27         },
28         controller : 
29                    ['$scope','egCore',
30             function($scope , egCore) {
31
32                 function loadRecordHtml() {
33                     egCore.net.request(
34                         'open-ils.search',
35                         'open-ils.search.biblio.record.html',
36                         $scope.recordId,
37                         false,
38                         $scope.marcXml
39                     ).then(function(html) {
40                         if (!html) return;
41
42                         // Remove those pesky non-i8n labels / actions.
43                         // Note: for printing, use the browser print page
44                         // option.  The end result is the same.
45                         html = html.replace(
46                             /<button onclick="window.print(.*?)<\/button>/,'');
47                         html = html.replace(/<title>(.*?)<\/title>/,'');
48
49                         // remove reference to nonexistant CSS file
50                         html = html.replace(/<link(.*?)\/>/,'');
51
52                         $scope.element.html(html);
53                     });
54                 }
55
56                 $scope.$watch('recordId', 
57                     function(newVal, oldVal) {
58                         if (newVal && newVal !== oldVal) {
59                             loadRecordHtml();
60                         }
61                     }
62                 );
63                 $scope.$watch('marcXml', 
64                     function(newVal, oldVal) {
65                         if (newVal && newVal !== oldVal) {
66                             loadRecordHtml();
67                         }
68                     }
69                 );
70
71                 if ($scope.recordId || $scope.marcXml) 
72                     loadRecordHtml();
73             }
74         ]
75     }
76 })
77
78 .directive('egRecordBreaker', function() {
79     return {
80         restrict : 'AE',
81         template : '<pre>{{breaker}}</pre>',
82         scope : {
83             recordId : '=',
84             marcXml  : '=',
85         },
86         link : function(scope, element, attrs) {
87             scope.element = angular.element(element);
88
89             // kill refs to destroyed DOM elements
90             element.bind("$destroy", function() {
91                 delete scope.element;
92             });
93         },
94         controller : 
95                    ['$scope','egCore',
96             function($scope , egCore) {
97
98                 function loadRecordBreaker() {
99                     var xml;
100                     if ($scope.marcXml) {
101                         $scope.breaker = new MARC21.Record({ marcxml : $scope.marcXml }).toBreaker();
102                     } else {
103                         egCore.pcrud.retrieve('bre', $scope.recordId)
104                         .then(function(rec) {
105                             $scope.breaker = new MARC21.Record({ marcxml : rec.marc() }).toBreaker();
106                         });
107                     }
108                 }
109
110                 $scope.$watch('recordId', 
111                     function(newVal, oldVal) {
112                         if (newVal && newVal !== oldVal) {
113                             loadRecordBreaker();
114                         }
115                     }
116                 );
117                 $scope.$watch('marcXml', 
118                     function(newVal, oldVal) {
119                         if (newVal && newVal !== oldVal) {
120                             loadRecordBreaker();
121                         }
122                     }
123                 );
124
125                 if ($scope.recordId || $scope.marcXml) 
126                     loadRecordBreaker();
127             }
128         ]
129     }
130 })
131
132 /*
133  * A record='foo' attribute is required as a storage location of the 
134  * retrieved record
135  */
136 .directive('egRecordSummary', function() {
137     return {
138         restrict : 'AE',
139         scope : {
140             recordId : '=',
141             record : '=',
142             noMarcLink : '@'
143         },
144         templateUrl : './cat/share/t_record_summary',
145         controller : 
146                    ['$scope','egCore','$sce','egBibDisplay',
147             function($scope , egCore , $sce , egBibDisplay) {
148
149                 function loadRecord() {
150                     egCore.pcrud.retrieve('bre', $scope.recordId, {
151                         flesh : 1,
152                         flesh_fields : {
153                             bre : ['creator','editor','flat_display_entries']
154                         }
155                     }).then(function(rec) {
156                         rec.owner(egCore.org.get(rec.owner()));
157                         $scope.record = rec;
158                         $scope.rec_display = 
159                             egBibDisplay.mfdeToHash(rec.flat_display_entries());
160                     });
161                     $scope.bib_cn = null;
162                     $scope.bib_cn_tooltip = '';
163                     var label_class = 1;
164                     if (egCore.env.aous) 
165                         label_class = egCore.env.aous['cat.default_classification_scheme'] || 1;
166                     egCore.net.request(
167                         'open-ils.cat',
168                         'open-ils.cat.biblio.record.marc_cn.retrieve',
169                         $scope.recordId,
170                         label_class
171                     ).then(function(cn_array) {
172                         var tooltip = '';
173                         if (cn_array.length > 0) {
174                             for (var field in cn_array[0]) {
175                                 $scope.bib_cn = cn_array[0][field];
176                             }
177                             for (var i in cn_array) {
178                                 for (var field in cn_array[i]) {
179                                     tooltip += 
180                                         field + ' : ' + cn_array[i][field] + '<br>';
181                                 }
182                             }
183                             $scope.bib_cn_tooltip = $sce.trustAsHtml(tooltip);
184                         }
185                     });
186                 }
187
188                 $scope.$watch('recordId', 
189                     function(newVal, oldVal) {
190                         if (newVal && newVal !== oldVal) {
191                             loadRecord();
192                         }
193                     }
194                 );
195
196
197                 if ($scope.recordId) 
198                     loadRecord();
199
200                 $scope.toggle_expand_summary = function() {
201                     if ($scope.collapseRecordSummary) {
202                         $scope.collapseRecordSummary = false;
203                         egCore.hatch.removeItem('eg.cat.record.summary.collapse');
204                     } else {
205                         $scope.collapseRecordSummary = true;
206                         egCore.hatch.setItem('eg.cat.record.summary.collapse', true);
207                     }
208                 }
209             
210                 $scope.collapse_summary = function() {
211                     return $scope.collapseRecordSummary;
212                 }
213             
214                 egCore.hatch.getItem('eg.cat.record.summary.collapse')
215                 .then(function(val) {$scope.collapseRecordSummary = Boolean(val)});
216
217             }
218         ]
219     }
220 })
221
222 /**
223  * Utility functions for translating bib record display fields into
224  * various formats / structures.
225  *
226  * Note that 'mwde' objects (which are proper IDL objects) only contain
227  * the prescribed fields from the IDL (and database view), while the
228  * 'mfde' hash-based objects contain all configured display fields,
229  * including custom fields.
230  * 
231  * MWDE objects are best suited to cases where the available set of
232  * display fields must be auto-generated from the IDL.  They work well
233  * with egGrids because it can automatically determine from the IDL
234  * which fields should be added to the column picker.
235  *
236  * MFDE lists are well suited to cases where the set of fields to
237  * display is known in advance (e.g. hard-coded in the template) or when
238  * the caller needs data for custom fields.  FWIW, MFDE data is slightly
239  * leaner for retrieval in that it does not require the JSON round-trip
240  * for delivery.
241  *
242  * Example:
243  *
244  *  --
245  *  // MVR-style canned fields
246  *
247  *  $scope.record = copy.call_number().record();
248  *
249  *  // translate wide display entry values inline
250  *  egBibDisplay.mwdeJSONToJS($scope.record.wide_display_entry());
251  *
252  *  <div>Title:</div>
253  *  <div>{{record.wide_display_entry().title()}}</div>
254  *
255  *  ---
256  *  //  Display any field using known keys
257  *
258  *  $scope.all_display_fields = 
259  *      egBibDisplay.mfdeToHash(record.flat_display_entries());
260  *
261  *  <div>Title:</div>
262  *  <div>{{all_display_fields.title}}</div>
263  *
264  *  ---
265  *  // Display all fields dynamically, using confgured labels
266  *
267  *  $scope.all_display_fields_with_meta = 
268  *      egBibDisplay.mfdeToMetaHash(record.flat_display_entries());
269  *
270  *  <div ng-repeat="(key, content) in all_display_fields_with_meta">
271  *    <div>Field Label</div><div>{{content.label}}</div>
272  *    <div ng-if="content.multi == 't'">
273  *      <div ng-repeat="val in content.value">
274  *        <div>Field Value</div><div>{{val}}</div>
275  *      </div>
276  *    </div>
277  *    <div ng-if="content.multi == 'f'">
278  *      <div>Field Value</div><div>{{content.value}}</div>
279  *    </div>
280  *  </div>
281  *
282  */
283 .factory('egBibDisplay', ['$q', 'egCore', function($q, egCore) {
284     var service = {};
285
286     /**
287      * Converts JSON-encoded values within a mwde object to Javascript
288      * native strings, numbers, and arrays.
289      *
290      * @collapseMulti collapse multi=true array values down to a single 
291      * comma-separated string.  This is useful for quickly  building 
292      * displays (e.g. grids) without having to first munge the array 
293      * into a string.
294      */
295     service.mwdeJSONToJS = function(entry, collapseMulti) {
296         angular.forEach(egCore.idl.classes.mwde.fields, function(f) {
297             if (f.virtual) return;
298             var val = JSON.parse(entry[f.name]());
299             if (collapseMulti && angular.isArray(val))
300                 val = val.join(', ');
301             entry[f.name](val);
302         });
303     }
304
305     /**
306      * Converts a list of 'mfde' entry objects to a simple key=>value hash.
307      * Non-multi values are strings or numbers.
308      * Multi values are arrays of strings or numbers.
309      *
310      * @collapseMulti See egBibDisplay.mwdeJSONToJS()
311      */
312     service.mfdeToHash = function(entries, collapseMulti) {
313         var hash = service.mfdeToMetaHash(entries, collapseMulti);
314         angular.forEach(hash, 
315             function(sub_hash, name) { hash[name] = sub_hash.value });
316         return hash;
317     }
318
319     /**
320      * Converts a list of 'mfde' entry objects to a nested hash like so:
321      * {name => field_name, label => field_label, value => scalar_or_array}
322      * The scalar_or_array value is a string/number or an array of
323      * string/numbers
324      *
325      * @collapseMulti See egBibDisplay.mwdeJSONToJS()
326      */
327     service.mfdeToMetaHash = function(entries, collapseMulti) {
328         var hash = {};
329         angular.forEach(entries, function(entry) {
330
331             if (!hash[entry.name()]) {
332                 hash[entry.name()] = {
333                     name : entry.name(),
334                     label : entry.label(),
335                     multi : entry.multi() == 't',
336                     value : entry.multi() == 't' ? [] : null
337                 }
338             }
339
340             if (entry.multi() == 't') {
341                 if (collapseMulti) {
342                     if (angular.isArray(hash[entry.name()].value)) {
343                         // start a new collapsed string
344                         hash[entry.name()].value = entry.value();
345                     } else {
346                         // append to collapsed string in progress
347                         hash[entry.name()].value += ', ' + entry.value();
348                     }
349                 } else {
350                     hash[entry.name()].value.push(entry.value());
351                 }
352             } else {
353                 hash[entry.name()].value = entry.value();
354             }
355         });
356
357         return hash;
358     }
359
360     return service;
361 }])