Skip to content

Commit

Permalink
Moved journals operations to separate file
Browse files Browse the repository at this point in the history
  • Loading branch information
@RoadToDream
RoadToDream committed Sep 11, 2023
1 parent 9428a39 commit fe2b7b1
Show file tree
Hide file tree
Showing 5 changed files with 251 additions and 147 deletions.
103 changes: 103 additions & 0 deletions src/chrome/content/book.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
ZotMeta.Journal = {
generateAuthors (author) {
var newAuthorList = [];
if (author) {
author.forEach(element => {
newAuthorList.push(
{
"firstName": element["given"],
"lastName": element["family"],
"creatorType": "author"
}
)
});
}
return newAuthorList;
},

generateDate (date) {
if (!date) {
return null;
}
if (date.length > 0) {
return date[0].join("-");
}
else {
return null;
}
},

getMetaData (item) {
var doi = item.getField('DOI');
if (item.itemTypeID !== Zotero.ItemTypes.getID('journalArticle')) {
Utilities.publishError("Unsupported Item Type", "Only Journal Article is supported.")
return;
}
if (!doi) {
// Utilities.publishError("DOI not found", "DOI is required to retrieve metadata.")
return;
}

var url = 'http://dx.doi.org/' + doi;
const headers = new Headers({'Accept': 'application/vnd.citationstyles.csl+json'});
var requestInfo = { method: 'GET', headers };
return Utilities.fetchWithTimeout(url, requestInfo, 3000)
.then(response => {
if (!response.ok) {
Utilities.publishError("Error retrieving metadata",
"Please check if DOI is correct and if you have network access to dx.doi.org.");
return null;

}
return response.text()
})
.then(data => {
try {
return JSON.parse(data)
} catch (error) {
return null;
}
})
.then(dataJson => {
var Title = Utilities.safeGetFromJson(dataJson, ["title"]);
var Authors = this.generateAuthors(Utilities.safeGetFromJson(dataJson, ["author"]));
var Publication = Utilities.safeGetFromJson(dataJson, ["container-title"]);
var Volume = Utilities.safeGetFromJson(dataJson, ["volume"]);
var Issue = Utilities.safeGetFromJson(dataJson, ["issue"]);
var Pages = Utilities.safeGetFromJson(dataJson, ["page"]);
var PublishDate = this.generateDate(Utilities.safeGetFromJson(dataJson, ["published", "date-parts"]));
var JournalAbbr = Utilities.safeGetFromJson(dataJson, ["container-title-short"]);
var Language = Utilities.safeGetFromJson(dataJson, ["language"]);
return {
"Title": Title ? Title : "",
"Authors": Authors ? Authors : "",
"Publication": Publication ? Publication : "",
"Volume": Volume ? Volume : "",
"Issue": Issue ? Issue : "",
"Pages": Pages ? Pages : "",
"PublishDate": PublishDate ? PublishDate : "",
"JournalAbbr": JournalAbbr ? JournalAbbr : "",
"Language": Language ? Language : ""
};
});
},

async updateMetadata(item) {
var metaData = await this.getMetaData(item);
if (!metaData) {
return 1;
}

if (!Utilities.isEmpty(metaData["Title"])) item.setField('title',metaData["Title"]);
if (!Utilities.isEmpty(metaData["Authors"])) item.setCreators(metaData["Authors"]);
if (!Utilities.isEmpty(metaData["Publication"])) item.setField('publicationTitle',metaData["Publication"]);
if (!Utilities.isEmpty(metaData["Volume"])) item.setField('volume',metaData["Volume"]);
if (!Utilities.isEmpty(metaData["Issue"])) item.setField('issue',metaData["Issue"]);
if (!Utilities.isEmpty(metaData["Pages"])) item.setField('pages',metaData["Pages"]);
if (!Utilities.isEmpty(metaData["PublishDate"])) item.setField('date',metaData["PublishDate"]);
if (!Utilities.isEmpty(metaData["JournalAbbr"])) item.setField('journalAbbreviation',metaData["JournalAbbr"]);
if (!Utilities.isEmpty(metaData["Language"])) item.setField('language',metaData["Language"]);
await item.saveTx();
return 0;
},
}
134 changes: 134 additions & 0 deletions src/chrome/content/journal.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
ZotMeta.Journal = {
generateAuthors (author) {
var newAuthorList = [];
if (author) {
author.forEach(element => {
newAuthorList.push(
{
"firstName": element["given"],
"lastName": element["family"],
"creatorType": "author"
}
)
});
}
return newAuthorList;
},

generateDate (date) {
if (!date) {
return null;
}
if (date.length > 0) {
return date[0].join("-");
}
else {
return null;
}
},

getMetaData (item) {
var doi = item.getField('DOI');
if (item.itemTypeID !== Zotero.ItemTypes.getID('journalArticle')) {
Utilities.publishError("Unsupported Item Type", "Only Journal Article is supported.")
return;
}
if (!doi) {
// Utilities.publishError("DOI not found", "DOI is required to retrieve metadata.")
return;
}

var url = 'http://dx.doi.org/' + doi;
const headers = new Headers({'Accept': 'application/vnd.citationstyles.csl+json'});
var requestInfo = { method: 'GET', headers };
return Utilities.fetchWithTimeout(url, requestInfo, 3000)
.then(response => {
if (!response.ok) {
Utilities.publishError("Error retrieving metadata",
"Please check if DOI is correct and if you have network access to dx.doi.org.");
return null;

}
return response.text()
})
.then(data => {
try {
return JSON.parse(data)
} catch (error) {
return null;
}
})
.then(dataJson => {
var Title = Utilities.safeGetFromJson(dataJson, ["title"]);
var Authors = this.generateAuthors(Utilities.safeGetFromJson(dataJson, ["author"]));
var Publication = Utilities.safeGetFromJson(dataJson, ["container-title"]);
var Volume = Utilities.safeGetFromJson(dataJson, ["volume"]);
var Issue = Utilities.safeGetFromJson(dataJson, ["issue"]);
var Pages = Utilities.safeGetFromJson(dataJson, ["page"]);
var PublishDate = this.generateDate(Utilities.safeGetFromJson(dataJson, ["published", "date-parts"]));
var JournalAbbr = Utilities.safeGetFromJson(dataJson, ["container-title-short"]);
var Language = Utilities.safeGetFromJson(dataJson, ["language"]);
return {
"Title": Title ? Title : "",
"Authors": Authors ? Authors : "",
"Publication": Publication ? Publication : "",
"Volume": Volume ? Volume : "",
"Issue": Issue ? Issue : "",
"Pages": Pages ? Pages : "",
"PublishDate": PublishDate ? PublishDate : "",
"JournalAbbr": JournalAbbr ? JournalAbbr : "",
"Language": Language ? Language : ""
};
});
},

async updateMetadata(item) {
var metaData = await this.getMetaData(item);
if (!metaData) {
return 1;
}

if (!Utilities.isEmpty(metaData["Title"])) item.setField('title',metaData["Title"]);
if (!Utilities.isEmpty(metaData["Authors"])) item.setCreators(metaData["Authors"]);
if (!Utilities.isEmpty(metaData["Publication"])) item.setField('publicationTitle',metaData["Publication"]);
if (!Utilities.isEmpty(metaData["Volume"])) item.setField('volume',metaData["Volume"]);
if (!Utilities.isEmpty(metaData["Issue"])) item.setField('issue',metaData["Issue"]);
if (!Utilities.isEmpty(metaData["Pages"])) item.setField('pages',metaData["Pages"]);
if (!Utilities.isEmpty(metaData["PublishDate"])) item.setField('date',metaData["PublishDate"]);
if (!Utilities.isEmpty(metaData["JournalAbbr"])) item.setField('journalAbbreviation',metaData["JournalAbbr"]);
if (!Utilities.isEmpty(metaData["Language"])) item.setField('language',metaData["Language"]);
await item.saveTx();
return 0;
},

async updateSelectedItemsMetadata() {
var items = Zotero.getActiveZoteroPane().getSelectedItems();
var itemCount = items.length;
if (itemCount === 0) {
Utilities.publishSuccess("Finished", "No item is selected.")
}
var progressHandle = Utilities.initializeProgress("Updating metadata for " + itemCount + " items...")

var pool = new ThreadPool(5);
var progress = 0;
var successCount = 0;
var failedCount = 0;
for (let i = 0; i < itemCount; i++) {
pool.submit(async () => {
var status = await this.updateMetadata(items[i]);
if (status === 0) {
successCount++;
} else if(status === 1) {
failedCount++;
}
progress++;
var progressMapped = Math.round(progress / itemCount * 100);
await Utilities.publishProgress(progressHandle, progressMapped, progress + " out of " + itemCount + " finished updating.");
});
}

pool.execute();
await pool.wait();
await Utilities.publishSuccess("Finished", successCount + " items updated, " + failedCount + " items failed.");
}
}
10 changes: 5 additions & 5 deletions src/chrome/content/threadpool.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class ThreadPool {
};

this.jobsRunning.setOnChangeCallback(async () => {
await this.fill_pool();
await this.fillPool();
});
}

Expand All @@ -37,7 +37,7 @@ class ThreadPool {
}

execute() {
this.fill_pool();
this.fillPool();
}

async wait() {
Expand All @@ -46,14 +46,14 @@ class ThreadPool {
}
}

async fill_pool() {
async fillPool() {
for (let index = 0; index < this.numThreads - this.jobsRunning.value; index++) {
if (this.jobs.length === 0) {
break;
}
const selected_job = this.jobs.shift();
const selectedJob = this.jobs.shift();
this.jobsRunning.value++;
await selected_job();
await selectedJob();
this.jobsRunning.value--;
}
}
Expand Down
16 changes: 8 additions & 8 deletions src/chrome/content/utilities.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ Utilities = {

},
publishProgress(handle, progress, message) {
var validated_progress = Math.min(Math.max(progress, 0), 100);
handle.progress.setProgress(validated_progress);
var validatedProgress = Math.min(Math.max(progress, 0), 100);
handle.progress.setProgress(validatedProgress);
handle.progress.setText(message);
if (progress === 100) {
var successIcon = "chrome://zotero/skin/tick.png";
Expand All @@ -51,19 +51,19 @@ Utilities = {
]);
},

safeGetFromJson(json, key_array) {
safeGetFromJson(json, keyArray) {
if (!json) {
return null;
}
var json_loc = json;
for (const key of key_array) {
if (key in json_loc) {
json_loc = json_loc[key];
var jsonLoc = json;
for (const key of keyArray) {
if (key in jsonLoc) {
jsonLoc = jsonLoc[key];
} else {
return null;
}
}
return json_loc;
return jsonLoc;
},

isEmpty(value) {
Expand Down
Loading

0 comments on commit fe2b7b1

Please sign in to comment.