Skip to content

Commit

Permalink
zotero.org: Update translator to work with new Web Library (zotero#2129)
Browse files Browse the repository at this point in the history
  • Loading branch information
@tnajdek @MylesFTOP
tnajdek authored and MylesFTOP committed Aug 23, 2020
1 parent 4dfebaa commit ce17ffe
Showing 1 changed file with 165 additions and 38 deletions.
203 changes: 165 additions & 38 deletions zotero.org.js
View file
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"translatorID": "c82c574d-7fe8-49ca-a360-a05d6e34fec0",
"label": "zotero.org",
"creator": "Dan Stillman and Aurimas Vinckevicius",
"target": "^https?://[^/]*zotero\\.org(:\\d+)?/.+/items(/|$)",
"creator": "Dan Stillman, Aurimas Vinckevicius, Tomasz Najdek",
"target": "^https?://[^/]*zotero\\.org(:\\d+)?/.+/(items|collections|library|publications|trash|search|item-list|item-details)(/|$)",
"minVersion": "3.0",
"maxVersion": "",
"priority": 100,
"inRepository": true,
"translatorType": 4,
"browserSupport": "gcsv",
"lastUpdated": "2017-10-20 20:50:32"
"lastUpdated": "2020-02-21 14:40:54"
}

/*
Expand All @@ -35,21 +35,18 @@
***** END LICENSE BLOCK *****
*/


var sessionKey;

function scrape(text) {
var item = JSON.parse(text);
var newItem = new Zotero.Item();
for (var prop in item.data) {
switch (prop) {
case 'key':
case 'version':
case 'collections':
case 'relations':
case 'dateAdded':
case 'dateModified':
continue;
case 'key':
case 'version':
case 'collections':
case 'relations':
case 'dateAdded':
case 'dateModified':
continue;
}
newItem[prop] = item.data[prop];
}
Expand All @@ -64,61 +61,115 @@ function getListTitles(doc) {
+ '/span[not(contains(@class,"sprite-treeitem-attachment"))]]');
}

function getLibraryURI(doc) {
function isNewWebLibrary(doc) {
return !!doc.querySelector('#zotero-web-library');
}

function legacyGetLibraryURI(doc) {
var feed = ZU.xpath(doc, '//a[@type="application/atom+xml" and @rel="alternate"]')[0];
if (!feed) return;
if (!feed) return false;
var url = feed.href.match(/^.+?\/(?:users|groups)\/\w+/);
if (!url) {
url = decodeURIComponent(feed.href)
.match(/https?:\/\/[^\/]+\/(?:users|groups)\/\w+/);
if (!url) return;
.match(/https?:\/\/[^/]+\/(?:users|groups)\/\w+/);
if (!url) return false;
}
if (!url) return;
if (!url) return false;
return (url[0] + '/items/').replace("https://api.zotero.org", "https://www.zotero.org/api");
}

function getLibraryURI(doc, url) {
if (!isNewWebLibrary(doc)) {
return legacyGetLibraryURI(doc);
}

var groupMatch = url.match(/zotero.org\/groups\/(\d+)\/.*?/i);
if (groupMatch) {
const groupId = groupMatch[1];
return `https://www.zotero.org/api/groups/${groupId}/items`;
}
else {
const config = JSON.parse(doc.querySelector('#zotero-web-library-config').textContent);
const { userId } = config;
return `https://www.zotero.org/api/users/${userId}/items`;
}
}

function getSessionKey(doc) {
var matches = doc.cookie.match(/zotero_www_session_v2=([a-z0-9]+)/);
return matches ? matches[1] : null;
}

function detectWeb(doc, url) {
//disable for libraries where we can't get a library URI or an apiKey
if (!getLibraryURI(doc)) return;

//single item
if ( url.match(/\/itemKey\/\w+/) ) {
function legacyDetectWeb(doc, url) {
// single item
if (url.match(/\/itemKey\/\w+/)) {
return ZU.xpathText(doc, '//div[@id="item-details-div"]//td[preceding-sibling::th[text()="Item Type"]]/@class')
|| false;
}

// Library and collections
if ( ( url.match(/\/items\/?([?#].*)?$/)
if ((url.match(/\/items\/?([?#].*)?$/)
|| url.includes('/collectionKey/')
|| url.match(/\/collection\/\w+/)
|| url.includes('/tag/') )
&& getListTitles(doc).length ) {
|| url.includes('/tag/'))
&& getListTitles(doc).length) {
return "multiple";
}

return false;
}

function doWeb(doc, url) {
function detectWeb(doc, url) {
// disable for libraries where we can't get a library URI or an apiKey
if (!getLibraryURI(doc, url)) {
return false;
}

if (!isNewWebLibrary(doc)) {
return legacyDetectWeb(doc, url);
}

const singleItemDataEl = doc.querySelector('script#translator-current-item');

if (singleItemDataEl) {
const { itemType } = JSON.parse(singleItemDataEl.textContent);
return itemType;
}

const multipleItemsDataEl = doc.querySelector('script#translator-items-list');

if (multipleItemsDataEl) {
return 'multiple';
}

return null;
}

function getCommon(doc, url) {
var headers = {
'Zotero-API-Version': 3
};
var libraryURI = getLibraryURI(doc);
var libraryURI = getLibraryURI(doc, url);
// Pass session key in URL, as required for CSRF protection. This allows saving of items
// in private libraries.
var sessionKey = getSessionKey(doc);
var suffix = sessionKey ? '?session=' + sessionKey : "";

return { headers, libraryURI, sessionKey, suffix };
}

function legacyDoWeb(doc, url) {
const { headers, libraryURI, suffix } = getCommon(doc, url);
var itemRe = /\/itemKey\/(\w+)/;

if (detectWeb(doc, url) == "multiple") {
var elems = getListTitles(doc);
var items = ZU.getItemArray(doc, elems);

Zotero.selectItems(items, function(selectedItems) {
if ( !selectedItems ) return true;

Zotero.selectItems(items, (selectedItems) => {
if (!selectedItems) {
return;
}

var apiURIs = [], itemID;
for (var url in selectedItems) {
Expand All @@ -128,18 +179,75 @@ function doWeb(doc, url) {

Zotero.Utilities.HTTP.doGet(apiURIs, scrape, null, null, headers);
});
} else {
}
else {
var itemID = url.match(itemRe)[1];
var itemURI = libraryURI + itemID + suffix;
Zotero.Utilities.doGet(itemURI, scrape, null, null, headers);
}
}

function doWeb(doc, url) {
if (!isNewWebLibrary(doc)) {
legacyDoWeb(doc, url);
}

const { headers, libraryURI, suffix } = getCommon(doc, url);

const singleItemDataEl = doc.querySelector('script#translator-current-item');

if (singleItemDataEl) {
const item = JSON.parse(singleItemDataEl.textContent);
const itemURI = `${libraryURI}/${item.key}${suffix}`;
Zotero.Utilities.doGet(itemURI, scrape, null, null, headers);
}
else {
const multipleItemsDataEl = doc.querySelector('script#translator-items-list');

if (multipleItemsDataEl) {
const options = JSON.parse(multipleItemsDataEl.textContent);
Zotero.selectItems(options, (selectedItems) => {
if (!selectedItems) {
return;
}

const selectedItemsURIs = Object.keys(selectedItems).map(itemKey => `${libraryURI}/${itemKey}${suffix}`);
Zotero.Utilities.HTTP.doGet(selectedItemsURIs, scrape, null, null, headers);
});
}
}
}

/** BEGIN TEST CASES **/
var testCases = [
{
"type": "web",
"url": "https://www.zotero.org/groups/729/all_things_zotero/items/itemKey/HXTTNJGD",
"url": "https://www.zotero.org/groups/729/all_things_zotero/items/itemKey/HXTTNJGD?usenewlibrary=0",
"defer": true,
"items": [
{
"itemType": "journalArticle",
"title": "Expert Searching, Zotero: A New Breed of Search Tool",
"creators": [
{
"creatorType": "author",
"firstName": "Mark",
"lastName": "Desirto"
}
],
"date": "April 2007",
"extra": "00000 \nCited by 0000",
"publicationTitle": "Medical Library Association Newsletter",
"attachments": [],
"tags": [],
"notes": [],
"seeAlso": []
}
]
},
{
"type": "web",
"url": "https://www.zotero.org/groups/729/all_things_zotero/items/HXTTNJGD?usenewlibrary=1",
"defer": true,
"items": [
{
Expand All @@ -164,21 +272,40 @@ var testCases = [
},
{
"type": "web",
"url": "https://www.zotero.org/groups/all_things_zotero/items",
"url": "https://www.zotero.org/groups/all_things_zotero/items?usenewlibrary=0",
"defer": true,
"items": "multiple"
},
{
"type": "web",
"url": "https://www.zotero.org/groups/all_things_zotero/items/collectionKey/XX99JMW8",
"url": "https://www.zotero.org/groups/729/all_things_zotero/items/BBNKRTN9,BVRM2S5S,VMUNGCPG/item-list?usenewlibrary=1",
"defer": true,
"items": "multiple"
},
{
"type": "web",
"url": "https://www.zotero.org/groups/devtesting/items/tag/tag2",
"url": "https://www.zotero.org/groups/all_things_zotero/items/collectionKey/XX99JMW8?usenewlibrary=0",
"defer": true,
"items": "multiple"
},
{
"type": "web",
"url": "https://www.zotero.org/groups/729/all_things_zotero/collections/XX99JMW8/items/BVRM2S5S,HXTTNJGD,92N4P9MH/item-list?usenewlibrary=1",
"defer": true,
"items": "multiple"
},
{
"type": "web",
"url": "https://www.zotero.org/groups/devtesting/items/tag/tag2?usenewlibrary=0",
"defer": true,
"items": "multiple"
},
{
"type": "web",
"url": "https://www.zotero.org/groups/729/all_things_zotero/tags/blogs/item-list?usenewlibrary=1",
"defer": true,
"items": "multiple"
}
];

]
/** END TEST CASES **/

0 comments on commit ce17ffe

Please sign in to comment.