LP#1308590: Fix schema.org type mapping
[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
95         schema_typemap.bluray = 'Movie'; # Movie could also be TVSeries
96         schema_typemap.book = 'Book';
97         schema_typemap.braille = 'Book';
98         schema_typemap.casaudiobook = 'Book AudioObject';
99         schema_typemap.casmusic = 'MusicAlbum';
100         schema_typemap.cdaudiobook = 'Book AudioObject';
101         schema_typemap.cdmusic = 'MusicAlbum';
102         schema_typemap.dvd = 'Movie';
103         schema_typemap.eaudio = 'AudioObject';
104         schema_typemap.ebook = 'Book';
105         # schema_typemap.equip = '';
106         schema_typemap.evideo = 'Movie';
107         # schema_typemap.kit = '';
108         schema_typemap.lpbook = 'Book';
109         schema_typemap.map = 'Map';
110         # schema_typemap.microform = '';
111         schema_typemap.music = 'MusicAlbum';
112         schema_typemap.phonomusic = 'MusicAlbum';
113         # schema_typemap.phonospoken = '';
114         # schema_typemap.picture = ''; Painting or Photograph?
115         schema_typemap.score = 'Book'; # schema.org has no generic Music type
116         schema_typemap.serial = 'Periodical';
117         schema_typemap.software = 'SoftwareApplication';
118         schema_typemap.vhs = 'Movie';
119
120         schema_typemap.a = 'Book';
121         schema_typemap.e = 'Map';
122         schema_typemap.j = 'MusicAlbum';
123
124         # Hard-coded to match defaults in config.copy_status for all OPAC-visible statuses
125         schema_copy_status = {};
126         schema_copy_status.0 = '<link property="availability" href="http://schema.org/InStock" />'; # Available
127         schema_copy_status.1 = '<link property="availability" href="http://schema.org/OutOfStock" />'; # Checked out
128         schema_copy_status.5 = '<link property="availability" href="http://schema.org/PreOrder" />'; # In process
129         schema_copy_status.6 = '<link property="availability" href="http://schema.org/PreOrder" />'; # In transit
130         schema_copy_status.7 = '<link property="availability" href="http://schema.org/InStock" />'; # Reshelving
131         schema_copy_status.8 = '<link property="availability" href="http://schema.org/OutOfStock" />'; # On holds shelf
132         schema_copy_status.9 = '<link property="availability" href="http://schema.org/PreOrder" />'; # On order
133         schema_copy_status.12 = '<link property="availability" href="http://schema.org/InStoreOnly" />'; # Reserves
134
135         args.isbns = [];
136         FOR isbn IN xml.findnodes('//*[@tag="020"]/*[@code="a"]');
137             args.isbns.push(isbn.textContent);
138         END;
139
140         args.upcs = [];
141         FOR upc IN xml.findnodes('//*[@tag="024"]/*[@code="a"]');
142             args.upcs.push(upc.textContent);
143         END;
144         args.upc = args.upcs.0; # use first UPC as the default
145
146         args.issns = [];
147         FOR sub IN xml.findnodes('//*[@tag="022"]/*[@code="a"]');
148             args.issns.push(sub.textContent);
149         END;
150         args.issn = (args.issns.size) ? args.issn.0 : '';
151
152         graphic_880s = [];
153         get_graphic_880s(target_field='100');
154         get_graphic_880s(target_field='110');
155         get_graphic_880s(target_field='111');
156         args.graphic_authors = graphic_880s;
157         args.authors = [];
158         FOR author IN args.graphic_authors;
159             args.authors.push(author.primary.value);
160         END;
161         args.author = (args.authors.size) ? args.authors.0 : '';
162
163         # Include subfields 'abnp' to generate a more comprehensive title display in search results
164         titresults = xml.findnodes('//*[@tag="245"]/*[@code="a" or @code="b" or @code="n" or @code="p"]');
165         titresults_content = [];
166             FOR sub IN titresults; titresults_content.push(sub.textContent); END;
167         args.title = titresults_content.join(" ");
168         # Avoid ugly trailing syntax on brief titles
169         args.title = args.title | replace('[:;/]$', '');
170
171         graphic_880s = [];
172         get_graphic_880s(target_field='245');
173         args.graphic_titles = graphic_880s;
174         args.titles = [];
175         FOR title IN args.graphic_titles;
176             args.titles.push(title.primary.value);
177         END;
178         args.title_extended = (args.titles.size) ? args.titles.0 : '';
179
180         args.pubplaces = [];
181         pubplace_hunt = xml.findnodes('//*[@tag="260"]/*[@code="a"]') ||
182             xml.findnodes('//*[@tag="264" and @ind2="1"]/*[@code="a"]');
183         FOR sub IN pubplace_hunt;
184             args.pubplaces.push(sub.textContent);
185         END;
186         args.pubplace = (args.pubplaces.size) ? args.pubplaces.0 : '';
187
188         args.publishers = [];
189         publishers_hunt = xml.findnodes('//*[@tag="260"]/*[@code="b"]') ||
190             xml.findnodes('//*[@tag="264" and @ind2="1"]/*[@code="b"]');
191         FOR sub IN publishers_hunt;
192             args.publishers.push(sub.textContent);
193         END;
194         args.publisher = (args.publishers.size) ? args.publishers.0 : '';
195
196         args.pubdates = [];
197         pubdates_hunt = xml.findnodes('//*[@tag="260"]/*[@code="c"]') || 
198             xml.findnodes('//*[@tag="264" and @ind2="1"]/*[@code="c"]');
199         FOR sub IN pubdates_hunt;
200             args.pubdates.push(sub.textContent);
201         END;
202         args.pubdate = (args.pubdates.size) ? args.pubdates.0 : '';
203
204         # Full publisher info
205         args.pubinfo = "$args.pubplace $args.publisher $args.pubdate";
206
207         # RDA adds 264 to the pubinfo 880 consideration mix
208         graphic_880s = [];
209         get_graphic_880s(target_field='260');
210         get_graphic_880s(target_field='264');
211         args.graphic_pubinfos = graphic_880s;
212         args.pubinfos = [];
213         FOR pubinfo IN args.graphic_pubinfos;
214             args.pubinfos.push(pubinfo.primary.value);
215         END;
216         args.pubinfo = (args.pubinfos.size) ? args.pubinfos.0 : '';
217
218         args.summaries = [];
219         FOR sub IN xml.findnodes('//*[@tag="520"]/*[@code="a"]');
220             args.summaries.push(sub.textContent);
221         END;
222         args.summary = (args.summaries.size) ? args.summaries.0 : '';
223
224         # 250 gets pride of place for edition statement, and is the
225         # only logical choice for 880 graphic fields
226         graphic_880s = [];
227         get_graphic_880s(target_field='250');
228         args.graphic_editions = graphic_880s;
229         args.editions = [];
230         FOR edition IN args.graphic_editions;
231             args.editions.push(edition.primary.value);
232         END;
233
234         ed_hunt = xml.findnodes('//*[@tag="250"]/*[@code="a"]') ||
235             xml.findnodes('//*[@tag="534"]/*[@code="b"]') ||
236             xml.findnodes('//*[@tag="775"]/*[@code="b"]');
237         FOR sub IN ed_hunt;
238             args.editions.push(sub.textContent);
239         END;
240         args.edition = (args.editions.size) ? args.editions.0 : '';
241
242         phys_content = [];
243         FOR sub IN xml.findnodes(
244             '//*[@tag="300"]/*[@code="a" or @code="b" or @code="c" or @code="e"]'
245         );
246             phys_content.push(sub.textContent);
247         END;
248         args.phys_desc = phys_content.join(" ");
249
250         graphic_880s = [];
251         get_graphic_880s(target_field='505');
252         args.graphic_contents = graphic_880s;
253         FOR content IN args.graphic_contents;
254             args.contents.push(content.primary.value);
255         END;
256         args.content = (args.contents.size) ? args.contents.0 : '';
257
258         # Maintain contents_list in case any custom use was made of it
259         args.contents_list = [];
260         FOR sub IN xml.findnodes('//*[@tag="505"]');
261             args.contents_list.push(sub.textContent);
262         END;
263
264         # MARC Callnumber
265         args.marc_cns = [];
266         FOR sub IN xml.findnodes('//*[@tag="092" or @tag="099"]/*');
267             args.marc_cns.push(sub.textContent);
268         END;
269         args.marc_cn = (args.marc_cns.size ) ? args.marc_cns.0 : '';
270             
271
272         # clean up the ISBN
273         args.isbn_clean = args.isbns.0.replace('\ .*', '');
274         FOR isbn IN args.isbns;
275             clean_isbn = isbn.replace('\ .*', '');
276             clean_isbn = clean_isbn.replace('-', '');
277             IF clean_isbn.length == 13;
278                 args.gtin13 = clean_isbn;
279                 LAST;
280             END;
281         END;
282
283         # Extract the 856 URLs that are not otherwise represented by asset.uri's
284         args.online_res = [];
285         FOR node IN xml.findnodes('//*[@tag="856" and @ind1="4" and (@ind2="0" or @ind2="1")]');
286             IF node.findnodes('./*[@code="9" or @code="w" or @code="n"]'); NEXT; END; # asset.uri's
287             label = node.findnodes('./*[@code="y"]');
288             notes = node.findnodes('./*[@code="z" or @code="3"]');
289             FOR href IN node.findnodes('./*[@code="u"]');
290                 NEXT UNLESS href;
291                 # it's possible for multiple $u's to exist within 1 856 tag.
292                 # in that case, honor the label/notes data for the first $u, but
293                 # leave any subsequent $u's as unadorned href's. 
294                 # use href/link/note keys to be consistent with args.uri's
295                 args.online_res.push({
296                     href => href.textContent, 
297                     link => (loop.first AND label) ? label.textContent : href.textContent,
298                     note => (loop.first) ? notes.textContent : ''
299                 });
300             END;
301         END;
302  
303         args.holdings = [];
304         args.uris = [];
305         args.issns = [];
306         args.resolver_isbns = [];
307         args.resolver_issns = [];
308
309         # we use $9 of ISBN and ISSN as a flag for e-version
310         FOR resolver_isbn IN xml.findnodes('//*[@tag="020"]/*[@code="9"]');
311             IF resolver_isbn.textContent == "SFX" || resolver_isbn.textContent == "CUFTS";
312                 my_parent = resolver_isbn.parentNode();
313                 FOR resolver_isbn_val IN my_parent.findnodes('./*[@code="a"]');
314                     args.resolver_isbns.push(
315                         resolver_isbn_val.textContent.replace('-', '').replace('\ .*', '')
316                     );
317                 END;
318             END;
319         END;
320
321         FOR resolver_issn IN xml.findnodes('//*[@tag="022"]/*[@code="9"]');
322             IF resolver_issn.textContent == "SFX" || resolver_issn.textContent == "CUFTS";
323                 my_parent = resolver_issn.parentNode();
324                 FOR resolver_issn_val IN my_parent.findnodes('./*[@code="a"]');
325                     args.resolver_issns.push(
326                         resolver_issn_val.textContent.replace('[^\d\-X]', '')
327                     );
328                 END;
329             END;
330         END;
331
332         # now snag all issns 
333         FOR rawissn IN xml.findnodes('//*[@tag="022"]/*[@code="a"]');
334             args.issns.push(
335                 rawissn.textContent.replace('[^\d\-X]', '')
336             );
337         END;
338
339         ou_hiding_disabled = ctx.org_hiding_disabled();
340
341         FOR volume IN xml.findnodes('//*[local-name()="volumes"]/*[local-name()="volume"]');
342
343             # Check volume visibility - could push this into XPath
344             vol.label = volume.getAttribute('label');
345
346             # Prepend prefix, if any
347             prefix = volume.findnodes('./*[local-name()="call_number_prefix"][@ident!="-1"]');
348             IF prefix.getAttribute('label') != '';
349                 vol.label = prefix.getAttribute('label') _ " " _ vol.label;
350             END;
351
352             # Append prefix, if any
353             suffix = volume.findnodes('./*[local-name()="call_number_suffix"][@ident!="-1"]');
354             IF suffix.getAttribute('label') != '';
355                 vol.label = vol.label _ " " _ suffix.getAttribute('label');
356             END;
357
358             vol.id = volume.getAttribute('id');
359             NEXT IF volume.getAttribute('opac_visible') == 'false';
360             NEXT IF volume.getAttribute('deleted') == 'true';
361
362             IF vol.label == '##URI##';
363                 FOR uri IN volume.findnodes('./*[local-name()="uris"]/*[local-name()="uri"]');
364                     res = {};
365                     res.href = uri.getAttribute('href');
366                     res.link = uri.getAttribute('label');
367                     res.note = uri.getAttribute('use_restriction');
368                     args.uris.push(res);
369                 END;
370                 NEXT;
371             ELSE;
372                 copies = volume.findnodes('./*[local-name()="copies"]/*[local-name()="copy"]');
373                 FOR copy IN copies;
374                     parts = copy.findnodes('./*[local-name()="monograph_parts"]/*[local-name()="monograph_part"]');
375                     FOREACH part IN parts;
376                         part_label = part.getAttribute('label');
377                         LAST IF part_label != '';
378                     END;
379                     # Check copy visibility
380                     cp.deleted = copy.getAttribute('deleted');    
381                     cp.visible = copy.getAttribute('opac_visible');
382                     NEXT IF (cp.deleted == 'true' OR cp.visible == 'false');
383
384                     # Iterate through all of the children to determine visibility
385                     FOR node IN cp.childNodes;
386                         NEXT IF cp.visible == 'false';
387                         vis = node.getAttribute('opac_visible');
388                         del = node.getAttribute('deleted');
389                         IF vis == 'false' or del == 'true';
390                             cp.visible = 'false';
391                         END;
392                     END;
393
394                     NEXT IF cp.visible == 'false';
395                     
396                     loc = copy.findnodes('./*[local-name()="location"]');
397                     NEXT IF loc.getAttribute('opac_visible') == 'false';
398
399                     circlib = copy.findnodes('./*[local-name()="circlib"]');
400                     NEXT IF circlib.getAttribute('opac_visible') == 'false';
401
402                     status = copy.findnodes('./*[local-name()="status"]');
403                     NEXT IF status.getAttribute('opac_visible') == 'false';
404
405                     # extract the circ_lib id from the circ_lib node
406                     circ_lib = copy.findnodes('./*[local-name()="circ_lib"]');
407                     circ_lib_id = circ_lib.getAttribute('id').replace('.*/', '');
408
409                     UNLESS ou_hiding_disabled;
410                         NEXT UNLESS ctx.org_within_hiding_scope(circ_lib_id);
411                     END;
412
413                     holding = {
414                         circ_lib => circ_lib_id,
415                         label => vol.label,
416                         part_label => part_label,
417                         location => loc.textContent,
418                         library => circlib.textContent,
419                         status => status.textContent,
420                         status_code => status.getAttribute('ident'),
421                         barcode => copy.getAttribute('barcode'),
422                         owner => volume.getAttribute('lib')
423                     };
424                     args.holdings.push(holding);
425                     part_label = '';
426                 END;
427             END;
428         END;
429
430         # Extract the copy count summary
431         count_type = (ctx.is_staff) ? 'staff' : 'public';
432
433         # Consortial copy count summary first
434         xpath = '//*[local-name()="counts"]/*[local-name()="count"][@type="' _ count_type _ '"]';
435         args.copy_counts = {};
436         FOR node IN xml.findnodes(xpath);
437             FOR attr IN ['count', 'available', 'unshadow', 'transcendant', 'org_unit']; 
438                 depth = node.getAttribute('depth');
439                 count_org_unit = node.getAttribute('org_unit');
440                 args.copy_counts.$depth.$attr = node.getAttribute(attr);
441                 args.org_copy_counts.$count_org_unit.$attr = node.getAttribute(attr);
442             END;
443         END;
444
445         # Get preferred library copy count
446         args.plib_copy_counts = {};
447         count_type = 'pref_lib';
448         xpath = '//*[local-name()="counts"]/*[local-name()="count"][@type="' _ count_type _ '"]';
449         FOR node IN xml.findnodes(xpath);
450             FOR attr IN ['count', 'available', 'unshadow', 'transcendant', 'org_unit']; 
451                 depth = node.getAttribute('depth');
452                 args.plib_copy_counts.$depth.$attr = node.getAttribute(attr);
453             END;
454         END;
455
456         # "mattype" == "custom marc format specifier"
457         icon_style = ctx.get_cgf('opac.icon_attr').value || 'item_type';
458         formats_xpath = '//*[local-name()="attributes"]/*[local-name()="field"][@name="' _ icon_style _ '"]';
459
460         args.all_formats = [];
461         FOR node IN xml.findnodes(formats_xpath);
462             IF node AND node.textContent;
463                 ccvm = ctx.get_ccvm(node.getAttribute('cvmid'));
464                 NEXT IF ccvm.opac_visible == 'f';
465
466                 format = {};
467                 type = ccvm.code.remove('-'); # blu-ray to bluray
468                 format.label = ccvm.search_label || ccvm.value;
469                 format.icon = PROCESS get_ccvm_icon ccvm=ccvm;
470                 format.itemtype = schema_typemap.$type || 'CreativeWork';
471
472                 args.all_formats.push(format); # metarecords want all formats
473
474                 IF !args.format_label;
475                     # use the first format as the default
476                     args.format_label = format.label; 
477                     args.schema.itemtype = format.itemtype;
478                     args.format_icon = format.icon;
479                 END;
480             END;
481         END;
482         
483         args.bibid = [];
484         FOR bibid IN xml.findnodes('//*[@tag="901"]/*[@code="c"]');
485             args.bibid.push(bibid.textContent);
486         END;
487         args.bibid = args.bibid.0; 
488
489     END;
490
491     # Get the library or location group
492     # get_library()
493     # magically upgrades any use of 'loc' to 'locg', 
494     # which is a superset of 'loc'.
495     BLOCK get_library;
496         loc_name = 'locg';
497         loc_value = ctx.copy_location_group_org ||  # resolved locg
498             CGI.param(loc_name) || CGI.param('loc') || ctx.search_ou;
499     END;
500
501 %]