63b82b4d5f4d2839abf5bc6d4a5b3e19eadbedbd
[working/Evergreen.git] / Open-ILS / src / templates / opac / parts / misc_util.tt2
1 [% 
2     # Support multiscript records via alternate graphic 880 fields
3     # get_graphic_880s(target_field='100')
4     # See "Model A" in http://www.loc.gov/marc/bibliographic/ecbdmulti.html
5     # and $6 description in http://www.loc.gov/marc/bibliographic/ecbdcntf.html
6     MACRO get_graphic_880s BLOCK;
7         FOR node IN xml.findnodes('//*[@tag="' _ target_field _ '"]');
8             raw_vals = [];
9             core_val = '';
10             FOR subnode IN node.findnodes('./*[not(contains("w 0 4 5 6 8 9", @code))]');
11                 raw_vals.push(subnode.textContent());
12             END;
13             core_val = raw_vals.join(" ");
14             raw_vals = [];
15
16             linked_fields = [];
17             FOR sub IN node.findnodes('./*[@code="6"]');
18                 linked_fields.push(sub.textContent);
19             END;
20             graphics = [];
21             get_linked_880s;
22             graphic_880s.push({
23                 primary => {"occur" => occurrence, "value" => core_val},
24                 graphic => graphics
25             });
26         END;
27     END;
28
29     MACRO get_linked_880s BLOCK;
30         FOR link_field IN linked_fields;
31             target = target_field _ link_field.substr(3);
32             # Get the linked 880 value
33             raw_val = '';
34             dir = '';
35             occurrence = '';
36             script = '';
37             FOR node IN xml.findnodes('//*[@tag="880"]');
38                 # Operate only on the target linked fields
39                 FOR linknode IN node.findnodes('./*[@code="6"]');
40                     lf = linknode.textContent();
41                     IF lf.substr(0, target.length) == target;
42                         occurrence = lf.substr(4, 2);
43                         rawscript = lf.substr(7, 2);
44                         SWITCH rawscript;
45                         CASE '(3';
46                             script = 'Arabic';
47                         CASE '(B';
48                             script = 'Latin';
49                         CASE '$1';
50                             script = 'CJK';
51                         CASE '(N';
52                             script = 'Cyrillic';
53                         CASE '(S';
54                             script = 'Greek';
55                         CASE '(2';
56                             script = 'Hebrew';
57                         END;
58
59                         rawdir = lf.substr(9, 1);
60                         SWITCH rawdir;
61                         CASE 'r';
62                             dir = 'rtl';
63                         END;
64
65                         raw_vals = [];
66                         FOR subnode IN node.findnodes('./*[not(contains("w 0 5 6 8 9", @code))]');
67                             raw_vals.push(subnode.textContent());
68                         END;
69                         raw_val = raw_vals.join(" ");
70                     END;
71                 END;
72             END;
73             graphics.push({
74                 occur => occurrence,
75                 value => raw_val,
76                 script => script,
77                 dir => dir
78             });
79         END;
80     END;
81
82     BLOCK get_ccvm_icon;
83         ctx.media_prefix _ '/images/format_icons/' _ ccvm.ctype _ '/' _ ccvm.code _ '.png';
84     END;
85
86     # Extract MARC fields from XML
87     #   get_marc_attrs( { marc_xml => doc } )
88     BLOCK get_marc_attrs;
89         xml = args.marc_xml;
90
91         # Map item types to schema.org types; impedance mismatch :(
92         args.schema.itemtype = {};
93         schema_typemap = {};
94         schema_typemap.a = 'http://schema.org/Book';
95         schema_typemap.e = 'http://schema.org/Map';
96         schema_typemap.j = 'http://schema.org/MusicAlbum';
97
98         # Hard-coded to match defaults in config.copy_status for all OPAC-visible statuses
99         schema_copy_status = {};
100         schema_copy_status.0 = '<link property="availability" href="http://schema.org/InStock" />'; # Available
101         schema_copy_status.1 = '<link property="availability" href="http://schema.org/OutOfStock" />'; # Checked out
102         schema_copy_status.5 = '<link property="availability" href="http://schema.org/PreOrder" />'; # In process
103         schema_copy_status.6 = '<link property="availability" href="http://schema.org/PreOrder" />'; # In transit
104         schema_copy_status.7 = '<link property="availability" href="http://schema.org/InStock" />'; # Reshelving
105         schema_copy_status.8 = '<link property="availability" href="http://schema.org/OutOfStock" />'; # On holds shelf
106         schema_copy_status.9 = '<link property="availability" href="http://schema.org/PreOrder" />'; # On order
107         schema_copy_status.12 = '<link property="availability" href="http://schema.org/InStoreOnly" />'; # Reserves
108
109         args.isbns = [];
110         FOR isbn IN xml.findnodes('//*[@tag="020"]/*[@code="a"]');
111             args.isbns.push(isbn.textContent);
112         END;
113
114         args.upcs = [];
115         FOR upc IN xml.findnodes('//*[@tag="024"]/*[@code="a"]');
116             args.upcs.push(upc.textContent);
117         END;
118         args.upc = args.upcs.0; # use first UPC as the default
119
120         args.issns = [];
121         FOR sub IN xml.findnodes('//*[@tag="022"]/*[@code="a"]');
122             args.issns.push(sub.textContent);
123         END;
124         args.issn = (args.issns.size) ? args.issn.0 : '';
125
126         graphic_880s = [];
127         get_graphic_880s(target_field='100');
128         get_graphic_880s(target_field='110');
129         get_graphic_880s(target_field='111');
130         args.graphic_authors = graphic_880s;
131         args.authors = [];
132         FOR author IN args.graphic_authors;
133             args.authors.push(author.primary.value);
134         END;
135         args.author = (args.authors.size) ? args.authors.0 : '';
136
137         # Include subfields 'abnp' to generate a more comprehensive title display in search results
138         titresults = xml.findnodes('//*[@tag="245"]/*[@code="a" or @code="b" or @code="n" or @code="p"]');
139         titresults_content = [];
140             FOR sub IN titresults; titresults_content.push(sub.textContent); END;
141         args.title = titresults_content.join(" ");
142         # Avoid ugly trailing syntax on brief titles
143         args.title = args.title | replace('[:;/]$', '');
144
145         graphic_880s = [];
146         get_graphic_880s(target_field='245');
147         args.graphic_titles = graphic_880s;
148         args.titles = [];
149         FOR title IN args.graphic_titles;
150             args.titles.push(title.primary.value);
151         END;
152         args.title_extended = (args.titles.size) ? args.titles.0 : '';
153
154         args.pubplaces = [];
155         pubplace_hunt = xml.findnodes('//*[@tag="260"]/*[@code="a"]') ||
156             xml.findnodes('//*[@tag="264" and @ind2="1"]/*[@code="a"]');
157         FOR sub IN pubplace_hunt;
158             args.pubplaces.push(sub.textContent);
159         END;
160         args.pubplace = (args.pubplaces.size) ? args.pubplaces.0 : '';
161
162         args.publishers = [];
163         publishers_hunt = xml.findnodes('//*[@tag="260"]/*[@code="b"]') ||
164             xml.findnodes('//*[@tag="264" and @ind2="1"]/*[@code="b"]');
165         FOR sub IN publishers_hunt;
166             args.publishers.push(sub.textContent);
167         END;
168         args.publisher = (args.publishers.size) ? args.publishers.0 : '';
169
170         args.pubdates = [];
171         pubdates_hunt = xml.findnodes('//*[@tag="260"]/*[@code="c"]') || 
172             xml.findnodes('//*[@tag="264" and @ind2="1"]/*[@code="c"]');
173         FOR sub IN pubdates_hunt;
174             args.pubdates.push(sub.textContent);
175         END;
176         args.pubdate = (args.pubdates.size) ? args.pubdates.0 : '';
177
178         # Full publisher info
179         args.pubinfo = "$args.pubplace $args.publisher $args.pubdate";
180
181         # RDA adds 264 to the pubinfo 880 consideration mix
182         graphic_880s = [];
183         get_graphic_880s(target_field='260');
184         get_graphic_880s(target_field='264');
185         args.graphic_pubinfos = graphic_880s;
186         args.pubinfos = [];
187         FOR pubinfo IN args.graphic_pubinfos;
188             args.pubinfos.push(pubinfo.primary.value);
189         END;
190         args.pubinfo = (args.pubinfos.size) ? args.pubinfos.0 : '';
191
192         args.summaries = [];
193         FOR sub IN xml.findnodes('//*[@tag="520"]/*[@code="a"]');
194             args.summaries.push(sub.textContent);
195         END;
196         args.summary = (args.summaries.size) ? args.summaries.0 : '';
197
198         # 250 gets pride of place for edition statement, and is the
199         # only logical choice for 880 graphic fields
200         graphic_880s = [];
201         get_graphic_880s(target_field='250');
202         args.graphic_editions = graphic_880s;
203         args.editions = [];
204         FOR edition IN args.graphic_editions;
205             args.editions.push(edition.primary.value);
206         END;
207
208         ed_hunt = xml.findnodes('//*[@tag="250"]/*[@code="a"]') ||
209             xml.findnodes('//*[@tag="534"]/*[@code="b"]') ||
210             xml.findnodes('//*[@tag="775"]/*[@code="b"]');
211         FOR sub IN ed_hunt;
212             args.editions.push(sub.textContent);
213         END;
214         args.edition = (args.editions.size) ? args.editions.0 : '';
215
216         phys_content = [];
217         FOR sub IN xml.findnodes(
218             '//*[@tag="300"]/*[@code="a" or @code="b" or @code="c" or @code="e"]'
219         );
220             phys_content.push(sub.textContent);
221         END;
222         args.phys_desc = phys_content.join(" ");
223
224         graphic_880s = [];
225         get_graphic_880s(target_field='505');
226         args.graphic_contents = graphic_880s;
227         FOR content IN args.graphic_contents;
228             args.contents.push(content.primary.value);
229         END;
230         args.content = (args.contents.size) ? args.contents.0 : '';
231
232         # Maintain contents_list in case any custom use was made of it
233         args.contents_list = [];
234         FOR sub IN xml.findnodes('//*[@tag="505"]');
235             args.contents_list.push(sub.textContent);
236         END;
237
238         # MARC Callnumber
239         args.marc_cns = [];
240         FOR sub IN xml.findnodes('//*[@tag="092" or @tag="099"]/*');
241             args.marc_cns.push(sub.textContent);
242         END;
243         args.marc_cn = (args.marc_cns.size ) ? args.marc_cns.0 : '';
244             
245
246         # clean up the ISBN
247         args.isbn_clean = args.isbns.0.replace('\ .*', '');
248         FOR isbn IN args.isbns;
249             clean_isbn = isbn.replace('\ .*', '');
250             clean_isbn = clean_isbn.replace('-', '');
251             IF clean_isbn.length == 13;
252                 args.gtin13 = clean_isbn;
253                 LAST;
254             END;
255         END;
256
257         # Extract the 856 URLs that are not otherwise represented by asset.uri's
258         args.online_res = [];
259         FOR node IN xml.findnodes('//*[@tag="856" and @ind1="4" and (@ind2="0" or @ind2="1")]');
260             IF node.findnodes('./*[@code="9" or @code="w" or @code="n"]'); NEXT; END; # asset.uri's
261             label = node.findnodes('./*[@code="y"]');
262             notes = node.findnodes('./*[@code="z" or @code="3"]');
263             FOR href IN node.findnodes('./*[@code="u"]');
264                 NEXT UNLESS href;
265                 # it's possible for multiple $u's to exist within 1 856 tag.
266                 # in that case, honor the label/notes data for the first $u, but
267                 # leave any subsequent $u's as unadorned href's. 
268                 # use href/link/note keys to be consistent with args.uri's
269                 args.online_res.push({
270                     href => href.textContent, 
271                     link => (loop.first AND label) ? label.textContent : href.textContent,
272                     note => (loop.first) ? notes.textContent : ''
273                 });
274             END;
275         END;
276  
277         args.holdings = [];
278         args.uris = [];
279         args.issns = [];
280         args.resolver_isbns = [];
281         args.resolver_issns = [];
282
283         # we use $9 of ISBN and ISSN as a flag for e-version
284         FOR resolver_isbn IN xml.findnodes('//*[@tag="020"]/*[@code="9"]');
285             IF resolver_isbn.textContent == "SFX" || resolver_isbn.textContent == "CUFTS";
286                 my_parent = resolver_isbn.parentNode();
287                 FOR resolver_isbn_val IN my_parent.findnodes('./*[@code="a"]');
288                     args.resolver_isbns.push(
289                         resolver_isbn_val.textContent.replace('-', '').replace('\ .*', '')
290                     );
291                 END;
292             END;
293         END;
294
295         FOR resolver_issn IN xml.findnodes('//*[@tag="022"]/*[@code="9"]');
296             IF resolver_issn.textContent == "SFX" || resolver_issn.textContent == "CUFTS";
297                 my_parent = resolver_issn.parentNode();
298                 FOR resolver_issn_val IN my_parent.findnodes('./*[@code="a"]');
299                     args.resolver_issns.push(
300                         resolver_issn_val.textContent.replace('[^\d\-X]', '')
301                     );
302                 END;
303             END;
304         END;
305
306         # now snag all issns 
307         FOR rawissn IN xml.findnodes('//*[@tag="022"]/*[@code="a"]');
308             args.issns.push(
309                 rawissn.textContent.replace('[^\d\-X]', '')
310             );
311         END;
312
313         ou_hiding_disabled = ctx.org_hiding_disabled();
314
315         FOR volume IN xml.findnodes('//*[local-name()="volumes"]/*[local-name()="volume"]');
316
317             # Check volume visibility - could push this into XPath
318             vol.label = volume.getAttribute('label');
319
320             # Prepend prefix, if any
321             prefix = volume.findnodes('./*[local-name()="call_number_prefix"][@ident!="-1"]');
322             IF prefix.getAttribute('label') != '';
323                 vol.label = prefix.getAttribute('label') _ " " _ vol.label;
324             END;
325
326             # Append prefix, if any
327             suffix = volume.findnodes('./*[local-name()="call_number_suffix"][@ident!="-1"]');
328             IF suffix.getAttribute('label') != '';
329                 vol.label = vol.label _ " " _ suffix.getAttribute('label');
330             END;
331
332             vol.id = volume.getAttribute('id');
333             NEXT IF volume.getAttribute('opac_visible') == 'false';
334             NEXT IF volume.getAttribute('deleted') == 'true';
335
336             IF vol.label == '##URI##';
337                 FOR uri IN volume.findnodes('./*[local-name()="uris"]/*[local-name()="uri"]');
338                     res = {};
339                     res.href = uri.getAttribute('href');
340                     res.link = uri.getAttribute('label');
341                     res.note = uri.getAttribute('use_restriction');
342                     args.uris.push(res);
343                 END;
344                 NEXT;
345             ELSE;
346                 copies = volume.findnodes('./*[local-name()="copies"]/*[local-name()="copy"]');
347                 FOR copy IN copies;
348                     parts = copy.findnodes('./*[local-name()="monograph_parts"]/*[local-name()="monograph_part"]');
349                     FOREACH part IN parts;
350                         part_label = part.getAttribute('label');
351                         LAST IF part_label != '';
352                     END;
353                     # Check copy visibility
354                     cp.deleted = copy.getAttribute('deleted');    
355                     cp.visible = copy.getAttribute('opac_visible');
356                     NEXT IF (cp.deleted == 'true' OR cp.visible == 'false');
357
358                     # Iterate through all of the children to determine visibility
359                     FOR node IN cp.childNodes;
360                         NEXT IF cp.visible == 'false';
361                         vis = node.getAttribute('opac_visible');
362                         del = node.getAttribute('deleted');
363                         IF vis == 'false' or del == 'true';
364                             cp.visible = 'false';
365                         END;
366                     END;
367
368                     NEXT IF cp.visible == 'false';
369                     
370                     loc = copy.findnodes('./*[local-name()="location"]');
371                     NEXT IF loc.getAttribute('opac_visible') == 'false';
372
373                     circlib = copy.findnodes('./*[local-name()="circlib"]');
374                     NEXT IF circlib.getAttribute('opac_visible') == 'false';
375
376                     status = copy.findnodes('./*[local-name()="status"]');
377                     NEXT IF status.getAttribute('opac_visible') == 'false';
378
379                     # extract the circ_lib id from the circ_lib node
380                     circ_lib = copy.findnodes('./*[local-name()="circ_lib"]');
381                     circ_lib_id = circ_lib.getAttribute('id').replace('.*/', '');
382
383                     UNLESS ou_hiding_disabled;
384                         NEXT UNLESS ctx.org_within_hiding_scope(circ_lib_id);
385                     END;
386
387                     holding = {
388                         circ_lib => circ_lib_id,
389                         label => vol.label,
390                         part_label => part_label,
391                         location => loc.textContent,
392                         library => circlib.textContent,
393                         status => status.textContent,
394                         status_code => status.getAttribute('ident'),
395                         barcode => copy.getAttribute('barcode'),
396                         owner => volume.getAttribute('lib')
397                     };
398                     args.holdings.push(holding);
399                     part_label = '';
400                 END;
401             END;
402         END;
403
404         # Extract the copy count summary
405         count_type = (ctx.is_staff) ? 'staff' : 'public';
406
407         # Consortial copy count summary first
408         xpath = '//*[local-name()="counts"]/*[local-name()="count"][@type="' _ count_type _ '"]';
409         args.copy_counts = {};
410         FOR node IN xml.findnodes(xpath);
411             FOR attr IN ['count', 'available', 'unshadow', 'transcendant', 'org_unit']; 
412                 depth = node.getAttribute('depth');
413                 count_org_unit = node.getAttribute('org_unit');
414                 args.copy_counts.$depth.$attr = node.getAttribute(attr);
415                 args.org_copy_counts.$count_org_unit.$attr = node.getAttribute(attr);
416             END;
417         END;
418
419         # Get preferred library copy count
420         args.plib_copy_counts = {};
421         count_type = 'pref_lib';
422         xpath = '//*[local-name()="counts"]/*[local-name()="count"][@type="' _ count_type _ '"]';
423         FOR node IN xml.findnodes(xpath);
424             FOR attr IN ['count', 'available', 'unshadow', 'transcendant', 'org_unit']; 
425                 depth = node.getAttribute('depth');
426                 args.plib_copy_counts.$depth.$attr = node.getAttribute(attr);
427             END;
428         END;
429
430         # "mattype" == "custom marc format specifier"
431         icon_style = ctx.get_cgf('opac.icon_attr').value || 'item_type';
432         formats_xpath = '//*[local-name()="attributes"]/*[local-name()="field"][@name="' _ icon_style _ '"]';
433
434         args.all_formats = [];
435         FOR node IN xml.findnodes(formats_xpath);
436             IF node AND node.textContent;
437                 ccvm = ctx.get_ccvm(node.getAttribute('cvmid'));
438                 NEXT IF ccvm.opac_visible == 'f';
439
440                 format = {};
441                 type = node.textContent;
442                 format.label = ccvm.search_label || ccvm.value;
443                 format.icon = PROCESS get_ccvm_icon ccvm=ccvm;
444                 format.itemtype = schema_typemap.$type || 'CreativeWork';
445
446                 args.all_formats.push(format); # metarecords want all formats
447
448                 IF !args.format_label;
449                     # use the first format as the default
450                     args.format_label = format.label; 
451                     args.schema.itemtype = format.itemtype;
452                     args.format_icon = format.icon;
453                 END;
454             END;
455         END;
456         
457         args.bibid = [];
458         FOR bibid IN xml.findnodes('//*[@tag="901"]/*[@code="c"]');
459             args.bibid.push(bibid.textContent);
460         END;
461         args.bibid = args.bibid.0; 
462
463     END;
464
465     # Get the library or location group
466     # get_library()
467     # magically upgrades any use of 'loc' to 'locg', 
468     # which is a superset of 'loc'.
469     BLOCK get_library;
470         loc_name = 'locg';
471         loc_value = ctx.copy_location_group_org ||  # resolved locg
472             CGI.param(loc_name) || CGI.param('loc') || ctx.search_ou;
473     END;
474
475 %]