forked from zotero/translators
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathEmbedded Metadata.js
1932 lines (1815 loc) · 62.6 KB
/
Embedded Metadata.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"translatorID": "951c027d-74ac-47d4-a107-9c3069ab7b48",
"label": "Embedded Metadata",
"creator": "Simon Kornblith and Avram Lyon",
"target": "",
"minVersion": "3.0.4",
"maxVersion": "",
"priority": 320,
"inRepository": true,
"translatorType": 4,
"browserSupport": "gcsibv",
"lastUpdated": "2022-01-03 16:51:36"
}
/*
***** BEGIN LICENSE BLOCK *****
Copyright © 2011 Avram Lyon and the Center for History and New Media
George Mason University, Fairfax, Virginia, USA
http://zotero.org
This file is part of Zotero.
Zotero is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Zotero is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with Zotero. If not, see <http://www.gnu.org/licenses/>.
***** END LICENSE BLOCK *****
*/
/* eslint-disable camelcase */
var HIGHWIRE_MAPPINGS = {
citation_title: "title",
citation_publication_date: "date", // perhaps this is still used in some old implementations
citation_cover_date: "date", // used e.g. by Springer http://link.springer.com/article/10.1023/A:1021669308832
citation_date: "date",
citation_journal_title: "publicationTitle",
citation_journal_abbrev: "journalAbbreviation",
citation_inbook_title: "publicationTitle", // used as bookTitle or proceedingTitle, e.g. http://pubs.rsc.org/en/content/chapter/bk9781849730518-00330/978-1-84973-051-8
citation_book_title: "bookTitle",
citation_volume: "volume",
citation_issue: "issue",
citation_series_title: "series",
citation_conference_title: "conferenceName",
citation_conference: "conferenceName",
citation_dissertation_institution: "university",
citation_technical_report_institution: "institution",
citation_technical_report_number: "number",
citation_publisher: "publisher",
citation_isbn: "ISBN",
citation_abstract: "abstractNote",
citation_doi: "DOI",
citation_public_url: "url",
citation_language: "language"
/* the following are handled separately in addHighwireMetadata()
"citation_author"
"citation_authors"
"citation_firstpage"
"citation_lastpage"
"citation_issn"
"citation_eIssn"
"citation_pdf_url"
"citation_abstract_html_url"
"citation_fulltext_html_url"
"citation_pmid"
"citation_online_date"
"citation_year"
"citation_keywords"
*/
};
/* eslint-enable */
// Maps actual prefix in use to URI
// The defaults are set to help out in case a namespace is not declared
// Copied from RDF translator
var _prefixes = {
bib: "http://purl.org/net/biblio#",
bibo: "http://purl.org/ontology/bibo/",
dc: "http://purl.org/dc/elements/1.1/",
dcterms: "http://purl.org/dc/terms/",
prism: "http://prismstandard.org/namespaces/1.2/basic/",
foaf: "http://xmlns.com/foaf/0.1/",
vcard: "http://nwalsh.com/rdf/vCard#",
link: "http://purl.org/rss/1.0/modules/link/",
z: "http://www.zotero.org/namespaces/export#",
eprint: "http://purl.org/eprint/terms/",
eprints: "http://purl.org/eprint/terms/",
og: "http://ogp.me/ns#", // Used for Facebook's OpenGraph Protocol
article: "http://ogp.me/ns/article#",
book: "http://ogp.me/ns/book#",
music: "http://ogp.me/ns/music#",
video: "http://ogp.me/ns/video#",
so: "http://schema.org/",
codemeta: "https://codemeta.github.io/terms/",
rdf: "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
};
var _prefixRemap = {
// DC should be in lower case
"http://purl.org/DC/elements/1.0/": "http://purl.org/dc/elements/1.0/",
"http://purl.org/DC/elements/1.1/": "http://purl.org/dc/elements/1.1/"
};
var namespaces = {};
var _haveItem = false,
_itemType;
var RDF;
var CUSTOM_FIELD_MAPPINGS;
function addCustomFields(customFields) {
CUSTOM_FIELD_MAPPINGS = customFields;
}
function setPrefixRemap(map) {
_prefixRemap = map;
}
function remapPrefix(uri) {
if (_prefixRemap[uri]) return _prefixRemap[uri];
return uri;
}
function getPrefixes(doc) {
var links = doc.getElementsByTagName("link");
for (let i = 0; i < links.length; i++) {
let link = links[i];
// Look for the schema's URI in our known schemata
var rel = link.getAttribute("rel");
if (rel) {
var matches = rel.match(/^schema\.([a-zA-Z]+)/);
if (matches) {
let uri = remapPrefix(link.getAttribute("href"));
// Zotero.debug("Prefix '" + matches[1].toLowerCase() +"' => '" + uri + "'");
_prefixes[matches[1].toLowerCase()] = uri;
}
}
}
// also look in html and head elements
var prefixes = (doc.documentElement.getAttribute('prefix') || '')
+ (doc.head.getAttribute('prefix') || '');
var prefixRE = /(\w+):\s+(\S+)/g;
var m;
while ((m = prefixRE.exec(prefixes))) {
let uri = remapPrefix(m[2]);
Z.debug("Prefix '" + m[1].toLowerCase() + "' => '" + uri + "'");
_prefixes[m[1].toLowerCase()] = uri;
}
}
// Boolean Parameters (default values false)
// * strict = false: compare only ending substring, e.g. bepress
// * strict = true: compare exactly
// * all = false: return only first match
// * all = true: concatenate all values
function getContentText(doc, name, strict, all) {
let csspath = 'html>head>meta[name' + (strict ? '="' : '$="') + name + '"]';
if (all) {
return Array.from(doc.querySelectorAll(csspath)).map(obj => obj.content || obj.contents).join(', ');
}
else {
return attr(doc, csspath, 'content') || attr(doc, csspath, 'contents');
}
}
function getContent(doc, name, strict) {
var xpath = '/x:html/x:head/x:meta['
+ (strict ? '@name' : 'substring(@name, string-length(@name)-' + (name.length - 1) + ')')
+ '="' + name + '"]/';
return ZU.xpath(doc, xpath + '@content | ' + xpath + '@contents', namespaces);
}
function fixCase(authorName) {
// fix case if all upper or all lower case
if (authorName.toUpperCase() === authorName
|| authorName.toLowerCase() === authorName) {
return ZU.capitalizeTitle(authorName, true);
}
return authorName;
}
function processFields(doc, item, fieldMap, strict) {
for (var metaName in fieldMap) {
var zoteroName = fieldMap[metaName];
// only concatenate values for ISSN and ISBN; otherwise take the first
var allValues = (zoteroName == "ISSN" || zoteroName == "ISBN");
var value = getContentText(doc, metaName, strict, allValues);
if (value && value.trim()) {
item[zoteroName] = ZU.trimInternal(value);
}
}
}
function completeItem(doc, newItem, hwType) {
// Strip off potential junk from RDF
newItem.seeAlso = [];
addHighwireMetadata(doc, newItem, hwType);
addOtherMetadata(doc, newItem);
addLowQualityMetadata(doc, newItem);
finalDataCleanup(doc, newItem);
if (CUSTOM_FIELD_MAPPINGS) {
processFields(doc, newItem, CUSTOM_FIELD_MAPPINGS, true);
}
newItem.complete();
}
// eslint-disable-next-line consistent-return
function detectWeb(doc, url) {
// blacklist wordpress jetpack comment plugin so it doesn't override other metadata
if (url.includes("jetpack.wordpress.com/jetpack-comment/")) return false;
if (exports.itemType) return exports.itemType;
init(doc, url, Zotero.done);
}
function init(doc, url, callback, forceLoadRDF) {
getPrefixes(doc);
var metaTags = doc.head.getElementsByTagName("meta");
Z.debug("Embedded Metadata: found " + metaTags.length + " meta tags.");
if (forceLoadRDF /* check if this is called from doWeb */ && !metaTags.length) {
if (doc.head) {
Z.debug(doc.head.innerHTML
.replace(/<style[^<]+(?:<\/style>|\/>)/ig, '')
.replace(/<link[^>]+>/ig, '')
.replace(/(?:\s*[\r\n]\s*)+/g, '\n')
);
}
else {
Z.debug("Embedded Metadata: No head tag");
}
}
var hwType, hwTypeGuess, generatorType, statements = [];
for (let i = 0; i < metaTags.length; i++) {
let metaTag = metaTags[i];
// Two formats allowed:
// <meta name="..." content="..." />
// <meta property="..." content="..." />
// The first is more common; the second is recommended by Facebook
// for their OpenGraph vocabulary
var tags = metaTag.getAttribute("name");
if (!tags) tags = metaTag.getAttribute("property");
var value = metaTag.getAttribute("content");
if (!tags || !value) continue;
// Z.debug(tags + " -> " + value);
tags = tags.split(/\s+/);
for (var j = 0, m = tags.length; j < m; j++) {
var tag = tags[j];
let parts = tag.split(/[.:_]/);
let prefix;
let prefixLength;
if (parts.length > 2) {
// e.g. og:video:release_date
prefix = parts[1].toLowerCase();
prefixLength = parts[0].length + parts[1].length + 1;
}
if (!prefix || !_prefixes[prefix]) {
prefix = parts[0].toLowerCase();
prefixLength = parts[0].length;
}
if (_prefixes[prefix]) {
var prop = tag.substr(prefixLength + 1);
prop = prop.charAt(0).toLowerCase() + prop.slice(1);
// bib and bibo types are special, they use rdf:type to define type
var specialNS = [_prefixes.bib, _prefixes.bibo];
if (prop == 'type' && specialNS.includes(_prefixes[prefix])) {
value = _prefixes[prefix] + value;
prefix = 'rdf';
}
// This debug is for seeing what is being sent to RDF
// Zotero.debug(_prefixes[prefix]+prop +"=>"+value);
statements.push([url, _prefixes[prefix] + prop, value]);
}
else if (tag.toLowerCase() == 'generator') {
var lcValue = value.toLowerCase();
if (lcValue.includes('blogger')
|| lcValue.includes('wordpress')
|| lcValue.includes('wooframework')
) {
generatorType = 'blogPost';
}
}
else {
var shortTag = tag.slice(tag.lastIndexOf('citation_'));
switch (shortTag) {
case "citation_journal_title":
hwType = "journalArticle";
break;
case "citation_technical_report_institution":
hwType = "report";
break;
case "citation_conference_title":
case "citation_conference":
hwType = "conferencePaper";
break;
case "citation_book_title":
hwType = "bookSection";
break;
case "citation_dissertation_institution":
hwType = "thesis";
break;
case "citation_title": // fall back to journalArticle, since this is quite common
case "citation_series_title": // possibly journal article, though it could be book
hwTypeGuess = hwTypeGuess || "journalArticle";
break;
case 'citation_isbn':
hwTypeGuess = "book"; // Unlikely, but other item types may have ISBNs as well (e.g. Reports?)
break;
}
}
}
}
if (statements.length || forceLoadRDF) {
// load RDF translator, so that we don't need to replicate import code
var translator = Zotero.loadTranslator("import");
translator.setTranslator("5e3ad958-ac79-463d-812b-a86a9235c28f");
translator.setHandler("itemDone", function (obj, newItem) {
_haveItem = true;
// Z.debug(newItem)
completeItem(doc, newItem, hwType);
});
translator.getTranslatorObject(function (rdf) {
for (var i = 0; i < statements.length; i++) {
var statement = statements[i];
rdf.Zotero.RDF.addStatement(statement[0], statement[1], statement[2], true);
}
var nodes = rdf.getNodes(true);
rdf.defaultUnknownType = hwTypeGuess || generatorType
// if we have RDF data, then default to webpage
|| (nodes.length ? "webpage" : false);
// if itemType is overridden, no reason to run RDF.detectWeb
if (exports.itemType) {
rdf.itemType = exports.itemType;
_itemType = exports.itemType;
}
else if (hwType) _itemType = hwType; // hwTypes are generally most accurate
else {
_itemType = nodes.length ? rdf.detectType({}, nodes[0], {}) : rdf.defaultUnknownType;
}
RDF = rdf;
callback(_itemType);
});
}
else {
callback(exports.itemType || hwType || hwTypeGuess || generatorType);
}
}
function doWeb(doc, url) {
// set default namespace
namespaces.x = doc.documentElement.namespaceURI;
// populate _rdfPresent, _itemType, and _prefixes
// As of https://github.com/zotero/zotero/commit/0cd183613f5dacc85676109c3a5c6930e3632fae
// globals do not seem to be isolated to individual translators, so
// RDF object, importantly the "itemDone" handlers, can get overridden
// by other translators, so we cannot reuse the RDF object from detectWeb
RDF = false;
if (!RDF) init(doc, url, function () {
importRDF(doc, url);
}, true);
else importRDF(doc, url);
}
// perform RDF import
function importRDF(doc) {
RDF.doImport();
if (!_haveItem) {
completeItem(doc, new Zotero.Item(_itemType));
}
}
/**
* Adds HighWire metadata and completes the item
*/
function addHighwireMetadata(doc, newItem, hwType) {
// HighWire metadata
processFields(doc, newItem, HIGHWIRE_MAPPINGS);
var authorNodes = getContent(doc, 'citation_author');
if (authorNodes.length == 0) {
authorNodes = getContent(doc, 'citation_authors');
}
var editorNodes = getContent(doc, 'citation_editor');
if (editorNodes.length == 0) {
editorNodes = getContent(doc, 'citation_editors');
}
// save rdfCreators for later
var rdfCreators = newItem.creators;
newItem.creators = processHighwireCreators(authorNodes, "author", doc).concat(processHighwireCreators(editorNodes, "editor", doc));
if (!newItem.creators.length) {
newItem.creators = rdfCreators;
}
else if (rdfCreators.length) {
// try to use RDF creator roles to update the creators we have
for (let i = 0, n = newItem.creators.length; i < n; i++) {
var name = newItem.creators[i].firstName
+ newItem.creators[i].lastName;
for (let j = 0, m = rdfCreators.length; j < m; j++) {
var creator = rdfCreators[j];
if (name.toLowerCase() == (creator.firstName + creator.lastName).toLowerCase()) {
// highwire should set all to author, so we only care about editor
// contributor is not always a contributor
if (creator.creatorType == 'editor') {
newItem.creators[i].creatorType = creator.creatorType;
}
rdfCreators.splice(j, 1);
break;
}
}
}
/* This may introduce duplicates
// if there are leftover creators from RDF, we should use them
if(rdfCreators.length) {
for(var i=0, n=rdfCreators.length; i<n; i++) {
newItem.creators.push(rdfCreators[i]);
}
}*/
}
// Deal with tags in a string
// we might want to look at the citation_keyword metatag later
if (!newItem.tags || !newItem.tags.length) {
var tags = getContent(doc, 'citation_keywords');
newItem.tags = [];
for (let i = 0; i < tags.length; i++) {
var tag = tags[i].textContent.trim();
if (tag) {
var splitTags = tag.split(';');
for (let j = 0; j < splitTags.length; j++) {
if (!splitTags[j].trim()) continue;
newItem.tags.push(splitTags[j].trim());
}
}
}
}
// sometimes RDF has more info, let's not drop it
var rdfPages = (newItem.pages) ? newItem.pages.split(/\s*-\s*/) : [];
// matches hyphens and en-dashes
let dashRe = /[-\u2013]/g;
var firstpage = getContentText(doc, 'citation_firstpage');
var lastpage = getContentText(doc, 'citation_lastpage');
if (firstpage) {
firstpage = firstpage.replace(dashRe, '-');
if (firstpage.includes("-")) {
firstpage = firstpage.split(/\s*-\s*/)[0];
lastpage = lastpage || firstpage.split(/\s*-\s*/)[1];
}
}
if (lastpage) {
lastpage = lastpage.replace(dashRe, '-');
if (lastpage.includes('-')) {
firstpage = firstpage || lastpage.split(/\s*-\s*/)[0];
lastpage = lastpage.split(/\s*-\s*/)[1];
}
}
firstpage = firstpage || rdfPages[0];
lastpage = lastpage || rdfPages[1];
if (firstpage && (firstpage = firstpage.trim())) {
newItem.pages = firstpage
+ ((lastpage && (lastpage = lastpage.trim())) ? '-' + lastpage : '');
}
// swap in hwType for itemType
if (hwType && hwType != newItem.itemType) {
newItem.itemType = hwType;
}
// fall back to some other date options
if (!newItem.date) {
var onlineDate = getContentText(doc, 'citation_online_date');
var citationYear = getContentText(doc, 'citation_year');
if (onlineDate && citationYear) {
onlineDate = ZU.strToISO(onlineDate);
if (citationYear < onlineDate.substr(0, 4)) {
// online date can be years after the citation year
newItem.date = citationYear;
}
else {
newItem.date = onlineDate;
}
}
else {
newItem.date = onlineDate || citationYear;
}
}
// prefer ISSN over eISSN
var issn = getContentText(doc, 'citation_issn', null, true)
|| getContentText(doc, 'citation_ISSN', null, true)
|| getContentText(doc, 'citation_eIssn', null, true);
if (issn) newItem.ISSN = issn;
// This may not always yield desired results
// i.e. if there is more than one pdf attachment (not common)
var pdfURL = getContent(doc, 'citation_pdf_url');
if (pdfURL.length) {
pdfURL = pdfURL[0].textContent;
// delete any pdf attachments if present
// would it be ok to just delete all attachments??
for (let i = newItem.attachments.length - 1; i >= 0; i--) {
if (newItem.attachments[i].mimeType == 'application/pdf') {
newItem.attachments.splice(i, 1);
}
}
newItem.attachments.push({ title: "Full Text PDF", url: pdfURL, mimeType: "application/pdf" });
}
// add snapshot
newItem.attachments.push({ document: doc, title: "Snapshot" });
// store PMID in Extra and as a link attachment
// e.g. http://www.sciencemag.org/content/332/6032/977.full
var PMID = getContentText(doc, 'citation_pmid');
if (PMID) {
if (newItem.extra) newItem.extra += '\n';
else newItem.extra = '';
newItem.extra += 'PMID: ' + PMID;
newItem.attachments.push({
title: "PubMed entry",
url: "http://www.ncbi.nlm.nih.gov/pubmed/" + PMID,
mimeType: "text/html",
snapshot: false
});
}
// Other last chances
if (!newItem.url) {
newItem.url = getContentText(doc, "citation_abstract_html_url")
|| getContentText(doc, "citation_fulltext_html_url");
}
}
// process highwire creators; currently only editor and author, but easy to extend
function processHighwireCreators(creatorNodes, role, doc) {
let itemCreators = [];
for (let creatorNode of creatorNodes) {
let creators = creatorNode.nodeValue.split(/\s*;\s*/);
if (creators.length == 1 && creatorNodes.length == 1) {
var authorsByComma = creators[0].split(/\s*,\s*/);
/* If there is only one author node and
we get nothing when splitting by semicolon, there are at least two
words on either side of a comma, and it doesn't appear to be a
two-word Spanish surname, we split by comma. */
let lang = getContentText(doc, 'citation_language');
let twoWordName = authorsByComma.length == 2
&& ['es', 'spa', 'Spanish', 'español'].includes(lang)
&& authorsByComma[0].split(' ').length == 2;
if (authorsByComma.length > 1
&& authorsByComma[0].includes(" ")
&& authorsByComma[1].includes(" ")
&& !twoWordName) creators = authorsByComma;
}
for (let creator of creators) {
creator = creator.trim();
// skip empty authors. Try to match something other than punctuation
if (!creator || !creator.match(/[^\s,-.;]/)) continue;
creator = ZU.cleanAuthor(creator, role, creator.includes(","));
if (creator.firstName) {
// fix case for personal names
creator.firstName = fixCase(creator.firstName);
creator.lastName = fixCase(creator.lastName);
}
itemCreators.push(creator);
}
}
return itemCreators;
}
function addOtherMetadata(doc, newItem) {
// Scrape parsely metadata http://parsely.com/api/crawler.html
var parselyJSON = ZU.xpathText(doc, '(//x:meta[@name="parsely-page"]/@content)[1]', namespaces);
if (parselyJSON) {
try {
var parsely = JSON.parse(parselyJSON);
}
catch (e) {}
if (parsely) {
if (!newItem.title && parsely.title) {
newItem.title = parsely.title;
}
if (!newItem.url && parsely.url) {
newItem.url = parsely.url;
}
if (!newItem.date && parsely.pub_date) {
var date = new Date(parsely.pub_date);
if (!isNaN(date.getUTCFullYear())) {
newItem.date = ZU.formatDate({
year: date.getUTCFullYear(),
month: date.getUTCMonth(),
day: date.getUTCDate()
}, true);
}
}
if (!newItem.creators.length && parsely.author) {
newItem.creators.push(ZU.cleanAuthor('' + parsely.author, 'author'));
}
if (!newItem.tags.length && parsely.tags && parsely.tags.length) {
newItem.tags = parsely.tags;
}
}
}
}
function addLowQualityMetadata(doc, newItem) {
// if we don't have a creator, look for byline on the page
// but first, we're desperate for a title
if (!newItem.title) {
Z.debug("Title was not found in meta tags. Using document title as title");
newItem.title = doc.title;
}
if (newItem.title) {
newItem.title = newItem.title.replace(/\s+/g, ' '); // make sure all spaces are \u0020
if (newItem.publicationTitle) {
// remove publication title from the end of title (see #604)
// this can occur if we have to doc.title, og:title etc.
// Make sure we escape all regex special chars in publication title
var removePubTitleRegex = new RegExp('\\s*[-–—=_:|~#]\\s*'
+ newItem.publicationTitle.replace(/([()[\]$^*+.?|])/g, '\\$1') + '\\s*$', 'i');
newItem.title = newItem.title.replace(removePubTitleRegex, '');
}
}
if (!newItem.creators.length) {
// the authors in the standard W3 author tag are safer than byline guessing
var w3authors = new Set(
Array.from(doc.querySelectorAll('meta[name="author" i], meta[property="author" i]'))
.map(authorNode => authorNode.content)
.filter(content => content && /[^\s,-.;]/.test(content)));
if (w3authors.size) {
for (let author of w3authors) {
newItem.creators.push(ZU.cleanAuthor(author, "author"));
}
}
else if (tryOgAuthors(doc)) {
newItem.creators = tryOgAuthors(doc);
}
else {
getAuthorFromByline(doc, newItem);
}
}
// fall back to "keywords"
if (!newItem.tags.length) {
newItem.tags = attr(doc, 'meta[name="keywords" i]', 'content');
}
// We can try getting abstract from 'description'
if (!newItem.abstractNote) {
newItem.abstractNote = ZU.trimInternal(
attr(doc, 'meta[name="description" i]', 'content'));
}
if (!newItem.url) {
newItem.url = ZU.xpathText(doc, '//head/link[@rel="canonical"]/@href') || doc.location.href;
}
if (!newItem.language) {
newItem.language = attr(doc, 'meta[name="language" i]', 'content')
|| ZU.xpathText(doc, '//x:meta[@name="lang"]/@content', namespaces)
|| ZU.xpathText(doc, '//x:meta[@http-equiv="content-language"]/@content', namespaces)
|| ZU.xpathText(doc, '//html/@lang')
|| doc.documentElement.getAttribute('xml:lang');
}
newItem.libraryCatalog = doc.location.host;
// add access date
newItem.accessDate = 'CURRENT_TIMESTAMP';
}
/* returns an array of objects of Og authors, but only where they do not contain a URL to prevent getting facebook profiles
In a worst case scenario, where real authors and social media profiles are mixed, we might miss some, but that's still
preferable to garbage */
function tryOgAuthors(doc) {
var authors = [];
var ogAuthors = ZU.xpath(doc, '//meta[@property="article:author" or @property="video:director" or @property="music:musician"]');
for (var i = 0; i < ogAuthors.length; i++) {
if (ogAuthors[i].content && ogAuthors[i].content.search(/(https?:\/\/)?[\da-z.-]+\.[a-z.]{2,6}/) < 0 && ogAuthors[i].content !== "false") {
authors.push(ZU.cleanAuthor(ogAuthors[i].content, "author"));
}
}
return authors.length ? authors : null;
}
function getAuthorFromByline(doc, newItem) {
var bylineClasses = ['byline', 'bylines', 'vcard', 'article-byline'];
Z.debug("Looking for authors in " + bylineClasses.join(', '));
var bylines = [], byline;
for (var i = 0; i < bylineClasses.length; i++) {
byline = doc.getElementsByClassName(bylineClasses[i]);
Z.debug("Found " + byline.length + " elements with '" + bylineClasses[i] + "' class");
for (var j = 0; j < byline.length; j++) {
if (!byline[j].innerText.trim()) continue;
bylines.push(byline[j]);
}
}
var actualByline;
if (!bylines.length) {
Z.debug("No byline found.");
return;
}
else if (bylines.length == 1) {
actualByline = bylines[0];
}
else if (newItem.title) {
Z.debug(bylines.length + " bylines found:");
Z.debug(bylines.map(function (n) {
return ZU.trimInternal(n.innerText);
}).join('\n'));
Z.debug("Locating the one closest to title.");
// find the closest one to the title (in DOM)
actualByline = false;
var parentLevel = 1;
var skipList = [];
// Wrap title in quotes so we can use it in the xpath
var xpathTitle = newItem.title.toLowerCase();
if (xpathTitle.includes('"')) {
if (!xpathTitle.includes("'")) {
// We can just use single quotes then
xpathTitle = "'" + xpathTitle + "'";
}
else {
// Escaping double quotes in xpaths is really hard
// Solution taken from http://kushalm.com/the-perils-of-xpath-expressions-specifically-escaping-quotes
xpathTitle = 'concat("' + xpathTitle.replace(/"+/g, '",\'$&\', "') + '")';
}
}
else {
xpathTitle = '"' + xpathTitle + '"';
}
var titleXPath = './/*[normalize-space(translate(text(),"ABCDEFGHJIKLMNOPQRSTUVWXYZ\u00a0","abcdefghjiklmnopqrstuvwxyz "))='
+ xpathTitle + ']';
Z.debug("Looking for title using: " + titleXPath);
while (!actualByline && bylines.length != skipList.length && parentLevel < 5) {
Z.debug("Parent level " + parentLevel);
for (let i = 0; i < bylines.length; i++) {
if (skipList.includes(i)) continue;
if (parentLevel == 1) {
// skip bylines that contain bylines
var containsBylines = false;
for (let j = 0; !containsBylines && j < bylineClasses.length; j++) {
containsBylines = bylines[i].getElementsByClassName(bylineClasses[j]).length;
}
if (containsBylines) {
Z.debug("Skipping potential byline " + i + ". Contains other bylines");
skipList.push(i);
continue;
}
}
var bylineParent = bylines[i];
for (let j = 0; j < parentLevel; j++) {
bylineParent = bylineParent.parentElement;
}
if (!bylineParent) {
Z.debug("Skipping potential byline " + i + ". Nowhere near title");
skipList.push(i);
continue;
}
if (ZU.xpath(bylineParent, titleXPath).length) {
if (actualByline) {
// found more than one, bail
Z.debug('More than one possible byline found. Will not proceed');
return;
}
actualByline = bylines[i];
}
}
parentLevel++;
}
}
if (actualByline) {
// are any of these actual likely to appear in the real world?
// well, no, but things happen:
// https://github.com/zotero/translators/issues/2001
let irrelevantTags = 'time, button, textarea, script';
if (actualByline.querySelector(irrelevantTags)) {
actualByline = actualByline.cloneNode(true);
for (let child of actualByline.querySelectorAll(irrelevantTags)) {
child.parentNode.removeChild(child);
}
}
byline = ZU.trimInternal(actualByline.innerText);
Z.debug("Extracting author(s) from byline: " + byline);
var li = actualByline.getElementsByTagName('li');
if (li.length) {
for (let i = 0; i < li.length; i++) {
var author = ZU.trimInternal(li[i].textContent).replace(/[,\s]+$/, "");
newItem.creators.push(ZU.cleanAuthor(fixCase(author), 'author', author.includes(',')));
}
}
else {
byline = byline.split(/\bby[:\s]+/i);
byline = byline[byline.length - 1].replace(/\s*[[(].+?[)\]]\s*/g, '');
var authors = byline.split(/\s*(?:(?:,\s*)?\band\b|,|&)\s*/i);
if (authors.length == 2 && authors[0].split(' ').length == 1) {
// this was probably last, first
newItem.creators.push(ZU.cleanAuthor(fixCase(byline), 'author', true));
}
else {
for (let i = 0, n = authors.length; i < n; i++) {
if (!authors[i].length || authors[i].includes('@')) {
// skip some odd splits and twitter handles
continue;
}
if (authors[i].split(/\s/).length == 1) {
// probably corporate author
newItem.creators.push({
lastName: authors[i],
creatorType: 'author',
fieldMode: 1
});
}
else {
newItem.creators.push(
ZU.cleanAuthor(fixCase(authors[i]), 'author'));
}
}
}
}
}
else {
Z.debug("No reliable byline found.");
}
}
/** If we already have tags - run through them one by one,
* split where necessary and concat them.
* This will deal with multiple tags, some of them comma delimited,
* some semicolon, some individual
*/
function finalDataCleanup(doc, newItem) {
if (typeof newItem.tags == 'string') {
newItem.tags = [newItem.tags];
}
if (newItem.tags && newItem.tags.length && Zotero.parentTranslator) {
if (exports.splitTags) {
var tags = [];
for (let i in newItem.tags) {
newItem.tags[i] = newItem.tags[i].trim();
if (!newItem.tags[i].includes(';')) {
// split by comma, since there are no semicolons
tags = tags.concat(newItem.tags[i].split(/\s*,\s*/));
}
else {
tags = tags.concat(newItem.tags[i].split(/\s*;\s*/));
}
}
for (let i = 0; i < tags.length; i++) {
if (tags[i] === "") tags.splice(i, 1);
}
newItem.tags = tags;
}
}
else {
// Unless called from another translator, don't include automatic tags,
// because most of the time they are not right
newItem.tags = [];
}
// Cleanup DOI
if (newItem.DOI) {
newItem.DOI = ZU.cleanDOI(newItem.DOI);
}
// Add DOI to non-supported item types
if (newItem.DOI && !ZU.fieldIsValidForType("DOI", newItem.itemType)) {
if (newItem.extra) {
newItem.extra += "\nDOI: " + newItem.DOI;
}
else {
newItem.extra = "DOI: " + newItem.DOI;
}
}
// URLs in meta tags can technically be relative (see the ccc.de test for
// an example), so we need to handle that
if (newItem.url) {
newItem.url = relativeToAbsolute(doc, newItem.url);
}
// remove itemID - comes from RDF translator, doesn't make any sense for online data
newItem.itemID = "";
// worst case, if this is not called from another translator, use URL for title
if (!newItem.title && !Zotero.parentTranslator) newItem.title = newItem.url;
}
function relativeToAbsolute(doc, url) {
if (ZU.resolveURL) {
return ZU.resolveURL(url);
}
// adapted from Nuclear Receptor Signaling translator
if (!url) {
return doc.location.href;
}
// check whether it's already absolute
if (url.match(/^(\w+:)?\/\//)) {
return url;
}
if (url[0] == '/') {
if (url[1] == '/') {
// protocol-relative
return doc.location.protocol + url;
}
else {
// relative to root
return doc.location.protocol + '//' + doc.location.host
+ url;
}
}
// relative to current directory
let location = doc.location.href;
if (location.includes('?')) {
location = location.slice(0, location.indexOf('?'));
}
return location.replace(/([^/]\/)[^/]+$/, '$1') + url;
}
var exports = {
doWeb: doWeb,
detectWeb: detectWeb,
addCustomFields: addCustomFields,
itemType: false,
// activate/deactivate splitting tags in final data cleanup when they contain commas or semicolons
splitTags: true,
fixSchemaURI: setPrefixRemap
};
/** BEGIN TEST CASES **/
var testCases = [
{
"type": "web",