blue
/
Zotero-TLDR
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update code

This commit is contained in:
shenyutao 2023-08-18 18:31:10 +08:00
parent 7fd2de3554
commit 24c229f736
7 changed files with 248 additions and 223 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
addon/chrome/content/preferences.xhtml
View File

@ -1 +0,0 @@

2
addon/prefs.js
View File

@ -1 +1 @@
/* eslint-disable no-undef */ /* eslint-disable no-undef */

41
src/hooks.ts
View File

@ -1,7 +1,4 @@
import { import { RegisterFactory, UIFactory } from "./modules/Common";
RegisterFactory,
UIFactory,
} from "./modules/Common";
import { config } from "../package.json"; import { config } from "../package.json";
import { getString, initLocale } from "./utils/locale"; import { getString, initLocale } from "./utils/locale";
import { registerPrefsScripts } from "./modules/preferenceScript"; import { registerPrefsScripts } from "./modules/preferenceScript";
@ -17,7 +14,7 @@ async function onStartup() {
]); ]);
initLocale(); initLocale();
await DataStorage.instance(TLDRFieldKey).getAsync(); // 加载TLDR数据 await DataStorage.instance(TLDRFieldKey).getAsync(); // 加载TLDR数据
RegisterFactory.registerPrefs(); RegisterFactory.registerPrefs();
@ -92,9 +89,11 @@ function onLoad() {
(async () => { (async () => {
let needFetchItems: Zotero.Item[] = []; let needFetchItems: Zotero.Item[] = [];
for (const lib of Zotero.Libraries.getAll()) { for (const lib of Zotero.Libraries.getAll()) {
needFetchItems = needFetchItems.concat((await Zotero.Items.getAll(lib.id)).filter((item: Zotero.Item) => { needFetchItems = needFetchItems.concat(
return item.isRegularItem() && !item.isCollection(); (await Zotero.Items.getAll(lib.id)).filter((item: Zotero.Item) => {
})); return item.isRegularItem() && !item.isCollection();
}),
);
} }
onUpdateItems(needFetchItems, false); onUpdateItems(needFetchItems, false);
})(); })();
@ -102,7 +101,7 @@ function onLoad() {
function noNotifyDeleteItem(ids: (string | number)[]) { function noNotifyDeleteItem(ids: (string | number)[]) {
DataStorage.instance(TLDRFieldKey).modify((data: any) => { DataStorage.instance(TLDRFieldKey).modify((data: any) => {
ids.forEach(id => { ids.forEach((id) => {
delete data[id]; delete data[id];
}); });
return data; return data;
@ -125,11 +124,17 @@ function onNotifyAddItems(ids: (string | number)[]) {
function onUpdateItems(items: Zotero.Item[], forceFetch: boolean = false) { function onUpdateItems(items: Zotero.Item[], forceFetch: boolean = false) {
items = items.filter((item: Zotero.Item) => { items = items.filter((item: Zotero.Item) => {
if (!item.getField('title')) { return false; } if (!item.getField("title")) {
if (!forceFetch) { return DataStorage.instance(TLDRFieldKey).get()[item.id] === undefined; } return false;
}
if (!forceFetch) {
return DataStorage.instance(TLDRFieldKey).get()[item.id] === undefined;
}
return true; return true;
}); });
if (items.length <= 0) { return; } if (items.length <= 0) {
return;
}
const newPopWin = (closeOnClick = false) => { const newPopWin = (closeOnClick = false) => {
return new ztoolkit.ProgressWindow(config.addonName, { return new ztoolkit.ProgressWindow(config.addonName, {
closeOnClick: closeOnClick, closeOnClick: closeOnClick,
@ -138,7 +143,7 @@ function onUpdateItems(items: Zotero.Item[], forceFetch: boolean = false) {
type: "default", type: "default",
progress: 0, progress: 0,
}); });
} };
const popupWin = newPopWin().show(-1); const popupWin = newPopWin().show(-1);
(async function () { (async function () {
const count = items.length; const count = items.length;
@ -146,12 +151,16 @@ function onUpdateItems(items: Zotero.Item[], forceFetch: boolean = false) {
const succeedItems: Zotero.Item[] = []; const succeedItems: Zotero.Item[] = [];
await (async function () { await (async function () {
for (const [index, item] of items.entries()) { for (const [index, item] of items.entries()) {
await new TLDRFetcher(item).fetchTLDR() ? succeedItems.push(item) : failedItems.push(item); (await new TLDRFetcher(item).fetchTLDR())
? succeedItems.push(item)
: failedItems.push(item);
await Zotero.Promise.delay(50); await Zotero.Promise.delay(50);
ztoolkit.ItemBox.refresh(); ztoolkit.ItemBox.refresh();
popupWin.changeLine({ popupWin.changeLine({
progress: index * 100 / count, progress: (index * 100) / count,
text: `Waiting: ${count - index - 1}, succeed: ${succeedItems.length}, failed: ${failedItems.length}`, text: `Waiting: ${count - index - 1}, succeed: ${
succeedItems.length
}, failed: ${failedItems.length}`,
}); });
} }
})(); })();

19
src/modules/Common.ts
View File

@ -11,7 +11,7 @@ export class RegisterFactory {
event: string, event: string,
type: string, type: string,
ids: number[] | string[], ids: number[] | string[],
extraData: { [key: string]: any } extraData: { [key: string]: any },
) => { ) => {
if (!addon?.data.alive) { if (!addon?.data.alive) {
this.unregisterNotifier(notifierID); this.unregisterNotifier(notifierID);
@ -22,9 +22,7 @@ export class RegisterFactory {
}; };
// Register the callback in Zotero as an item observer // Register the callback in Zotero as an item observer
const notifierID = Zotero.Notifier.registerObserver(callback, [ const notifierID = Zotero.Notifier.registerObserver(callback, ["item"]);
"item",
]);
// Unregister callback when the window closes (important to avoid a memory leak) // Unregister callback when the window closes (important to avoid a memory leak)
window.addEventListener( window.addEventListener(
@ -32,7 +30,7 @@ export class RegisterFactory {
(e: Event) => { (e: Event) => {
this.unregisterNotifier(notifierID); this.unregisterNotifier(notifierID);
}, },
false false,
); );
} }
@ -40,7 +38,6 @@ export class RegisterFactory {
Zotero.Notifier.unregisterObserver(notifierID); Zotero.Notifier.unregisterObserver(notifierID);
} }
// 注册首选项配置 // 注册首选项配置
static registerPrefs() { static registerPrefs() {
// const prefOptions = { // const prefOptions = {
@ -79,9 +76,13 @@ export class UIFactory {
tag: "menuitem", tag: "menuitem",
id: "zotero-collectionmenu-tldr", id: "zotero-collectionmenu-tldr",
label: getString("menucollection-updatetldrlabel"), label: getString("menucollection-updatetldrlabel"),
commandListener: (ev) => addon.hooks.onUpdateItems(ZoteroPane.getSelectedCollection()?.getChildItems() ?? [], false), commandListener: (ev) =>
addon.hooks.onUpdateItems(
ZoteroPane.getSelectedCollection()?.getChildItems() ?? [],
false,
),
icon: menuIcon, icon: menuIcon,
}) });
} }
// tldr行 // tldr行
@ -120,4 +121,4 @@ export class UIFactory {
}, },
); );
} }
} }

125
src/modules/dataStorage.ts
View File

@ -1,80 +1,89 @@
import { config } from "../../package.json"; import { config } from "../../package.json";
export class Data { export class Data {
private filePath: string private filePath: string;
private inited = false; private inited = false;
private _data: any private _data: any;
constructor(filePath: string) { constructor(filePath: string) {
this.filePath = filePath; this.filePath = filePath;
} }
async getAsync() { async getAsync() {
await this.initDataIfNeed(); await this.initDataIfNeed();
return this.data; return this.data;
} }
get() { get() {
return this.data; return this.data;
} }
async modify(action: (data: any) => Promise<any>) { async modify(action: (data: any) => Promise<any>) {
await this.initDataIfNeed(); await this.initDataIfNeed();
const data = await this.data; const data = await this.data;
const newData = await action(data); const newData = await action(data);
try { try {
await IOUtils.writeJSON(this.filePath, newData, {mode: 'overwrite', compress: false}); await IOUtils.writeJSON(this.filePath, newData, {
this.data = newData; mode: "overwrite",
return newData; compress: false,
} catch (error) { });
return data; this.data = newData;
} return newData;
} catch (error) {
return data;
} }
}
async delete() { async delete() {
try { try {
await IOUtils.remove(this.filePath); await IOUtils.remove(this.filePath);
this.data = {}; this.data = {};
return true; return true;
} catch (error) { } catch (error) {
return false; return false;
}
} }
}
private get data() { private get data() {
return this._data; return this._data;
} }
private set data(value: any) { private set data(value: any) {
this._data = value; this._data = value;
} }
private async initDataIfNeed() { private async initDataIfNeed() {
if (this.inited) { return; } if (this.inited) {
try { return;
this.data = await IOUtils.readJSON(this.filePath, {decompress: false});
} catch (error) {
this.data = {};
}
} }
try {
this.data = await IOUtils.readJSON(this.filePath, { decompress: false });
} catch (error) {
this.data = {};
}
}
} }
export class DataStorage { export class DataStorage {
private readonly dataDir = PathUtils.join(PathUtils.profileDir, 'extensions', config.addonName); private readonly dataDir = PathUtils.join(
private dataMap: { [key: string]: Data } = {}; PathUtils.profileDir,
"extensions",
config.addonName,
);
private dataMap: { [key: string]: Data } = {};
private static shared = new DataStorage(); private static shared = new DataStorage();
static instance(dataType: string) { static instance(dataType: string) {
const path = PathUtils.join(this.shared.dataDir, dataType); const path = PathUtils.join(this.shared.dataDir, dataType);
if (this.shared.dataMap[dataType] === undefined) { if (this.shared.dataMap[dataType] === undefined) {
const data = new Data(path); const data = new Data(path);
this.shared.dataMap[dataType] = data; this.shared.dataMap[dataType] = data;
return data; return data;
} else { } else {
return this.shared.dataMap[dataType]; return this.shared.dataMap[dataType];
}
} }
}
private constructor() { } private constructor() {}
} }

3
src/modules/preferenceScript.ts
View File

@ -14,5 +14,4 @@ export async function registerPrefsScripts(_window: Window) {
bindPrefEvents(); bindPrefEvents();
} }
function bindPrefEvents() { function bindPrefEvents() {}
}

280
src/modules/tldrFetcher.ts
View File

@ -1,157 +1,165 @@
import { DataStorage } from "./dataStorage"; import { DataStorage } from "./dataStorage";
type SemanticScholarItemInfo = { type SemanticScholarItemInfo = {
title?: string, title?: string;
abstract?: string, abstract?: string;
tldr?: string, tldr?: string;
}; };
export const TLDRFieldKey = 'TLDR'; export const TLDRFieldKey = "TLDR";
export const TLDRUnrelated = 'tldr-unrelated' // semantic scholar 找到了该item，但是该item没有tldr export const TLDRUnrelated = "tldr-unrelated"; // semantic scholar 找到了该item，但是该item没有tldr
export const TLDRItemNotFound = 'tldr-itemnotfound' // semantic scholar 找不到该item， export const TLDRItemNotFound = "tldr-itemnotfound"; // semantic scholar 找不到该item，
export class TLDRFetcher { export class TLDRFetcher {
private readonly zoteroItem: Zotero.Item; private readonly zoteroItem: Zotero.Item;
private readonly title?: string; private readonly title?: string;
private readonly abstract?: string; private readonly abstract?: string;
constructor(item: Zotero.Item) { constructor(item: Zotero.Item) {
this.zoteroItem = item; this.zoteroItem = item;
if (item.isRegularItem() && !item.isCollection()) { if (item.isRegularItem() && !item.isCollection()) {
this.title = item.getField('title') as string; this.title = item.getField("title") as string;
this.abstract = item.getField('abstractNote') as string; this.abstract = item.getField("abstractNote") as string;
}
} }
}
async fetchTLDR() { async fetchTLDR() {
if (!this.title || this.title.length <= 0) { return false; } if (!this.title || this.title.length <= 0) {
try { return false;
const infos = await this.fetchRelevanceItemInfos(this.title);
for (const info of infos) {
let match = false;
if (info.title && this.title && this.checkLCS(info.title, this.title)) {
match = true;
} else if (info.abstract && this.abstract && this.checkLCS(info.abstract, this.abstract)) {
match = true;
}
if (match) {
const result = info.tldr ?? TLDRUnrelated;
DataStorage.instance(TLDRFieldKey).modify((data: any) => {
data[this.zoteroItem.id] = result;
return data;
});
return true;
}
}
DataStorage.instance(TLDRFieldKey).modify((data: any) => {
data[this.zoteroItem.id] = TLDRItemNotFound;
return data;
});
return false;
} catch (error) {
Zotero.log(`post semantic scholar request error: ${error}`);
return false;
}
} }
try {
const infos = await this.fetchRelevanceItemInfos(this.title);
for (const info of infos) {
let match = false;
if (info.title && this.title && this.checkLCS(info.title, this.title)) {
match = true;
} else if (
info.abstract &&
this.abstract &&
this.checkLCS(info.abstract, this.abstract)
) {
match = true;
}
if (match) {
const result = info.tldr ?? TLDRUnrelated;
DataStorage.instance(TLDRFieldKey).modify((data: any) => {
data[this.zoteroItem.id] = result;
return data;
});
return true;
}
}
DataStorage.instance(TLDRFieldKey).modify((data: any) => {
data[this.zoteroItem.id] = TLDRItemNotFound;
return data;
});
return false;
} catch (error) {
Zotero.log(`post semantic scholar request error: ${error}`);
return false;
}
}
private async fetchRelevanceItemInfos(title: string): Promise<SemanticScholarItemInfo[]> { private async fetchRelevanceItemInfos(
const semanticScholarURL = 'https://www.semanticscholar.org/api/1/search'; title: string,
const params = { ): Promise<SemanticScholarItemInfo[]> {
queryString: title, const semanticScholarURL = "https://www.semanticscholar.org/api/1/search";
page: 1, const params = {
pageSize: 10, queryString: title,
sort: 'relevance', page: 1,
authors: [], pageSize: 10,
coAuthors: [], sort: "relevance",
venues: [], authors: [],
performTitleMatch: true, coAuthors: [],
requireViewablePdf: false, venues: [],
includeTldrs: true, performTitleMatch: true,
requireViewablePdf: false,
includeTldrs: true,
};
const resp = await Zotero.HTTP.request("POST", semanticScholarURL, {
headers: { "Content-Type": "application/json" },
body: JSON.stringify(params),
});
if (resp.status === 200) {
const results = JSON.parse(resp.response).results;
return results.map((item: any) => {
const result = {
title: item.title.text,
abstract: item.paperAbstract.text,
tldr: undefined,
}; };
const resp = await Zotero.HTTP.request("POST", semanticScholarURL, { if (item.tldr) {
headers: {'Content-Type': 'application/json'}, result.tldr = item.tldr.text;
body: JSON.stringify(params),
});
if (resp.status === 200) {
const results = JSON.parse(resp.response).results;
return results.map((item: any) => {
const result = {
title: item.title.text,
abstract: item.paperAbstract.text,
tldr: undefined,
};
if (item.tldr) {
result.tldr = item.tldr.text;
}
return result;
});
} }
return []; return result;
});
} }
return [];
}
private checkLCS(pattern: string, content: string): boolean { private checkLCS(pattern: string, content: string): boolean {
const LCS = StringMatchUtils.longestCommonSubsequence(pattern, content); const LCS = StringMatchUtils.longestCommonSubsequence(pattern, content);
return LCS.length >= Math.max(pattern.length, content.length) * 0.9 return LCS.length >= Math.max(pattern.length, content.length) * 0.9;
} }
} }
class StringMatchUtils { class StringMatchUtils {
static longestCommonSubsequence(text1: string, text2: string): string { static longestCommonSubsequence(text1: string, text2: string): string {
const m = text1.length; const m = text1.length;
const n = text2.length; const n = text2.length;
const dp: number[][] = new Array(m + 1); const dp: number[][] = new Array(m + 1);
for (let i = 0; i <= m; i++) { for (let i = 0; i <= m; i++) {
dp[i] = new Array(n + 1).fill(0); dp[i] = new Array(n + 1).fill(0);
}
for (let i = 1; i <= m; i++) {
for (let j = 1; j <= n; j++) {
if (text1[i - 1] === text2[j - 1]) {
dp[i][j] = dp[i - 1][j - 1] + 1;
} else {
dp[i][j] = Math.max(dp[i - 1][j], dp[i][j - 1]);
}
}
}
let i = m, j = n;
const lcs: string[] = [];
while (i > 0 && j > 0) {
if (text1[i - 1] === text2[j - 1]) {
lcs.unshift(text1[i - 1]);
i--;
j--;
} else if (dp[i - 1][j] > dp[i][j - 1]) {
i--;
} else {
j--;
}
}
return lcs.join('');
} }
// static minWindow(s: string, t: string): [number, number] | null { for (let i = 1; i <= m; i++) {
// const m = s.length, n = t.length for (let j = 1; j <= n; j++) {
// let start = -1, minLen = Number.MAX_SAFE_INTEGER, i = 0, j = 0, end; if (text1[i - 1] === text2[j - 1]) {
// while (i < m) { dp[i][j] = dp[i - 1][j - 1] + 1;
// if (s[i] == t[j]) { } else {
// if (++j == n) { dp[i][j] = Math.max(dp[i - 1][j], dp[i][j - 1]);
// end = i + 1; }
// while (--j >= 0) { }
// while (s[i--] != t[j]); }
// }
// ++i; ++j; let i = m,
// if (end - i < minLen) { j = n;
// minLen = end - i; const lcs: string[] = [];
// start = i; while (i > 0 && j > 0) {
// } if (text1[i - 1] === text2[j - 1]) {
// } lcs.unshift(text1[i - 1]);
// } i--;
// ++i; j--;
// } } else if (dp[i - 1][j] > dp[i][j - 1]) {
// return start == -1 ? null : [start, minLen]; i--;
// } } else {
} j--;
}
}
return lcs.join("");
}
// static minWindow(s: string, t: string): [number, number] | null {
// const m = s.length, n = t.length
// let start = -1, minLen = Number.MAX_SAFE_INTEGER, i = 0, j = 0, end;
// while (i < m) {
// if (s[i] == t[j]) {
// if (++j == n) {
// end = i + 1;
// while (--j >= 0) {
// while (s[i--] != t[j]);
// }
// ++i; ++j;
// if (end - i < minLen) {
// minLen = end - i;
// start = i;
// }
// }
// }
// ++i;
// }
// return start == -1 ? null : [start, minLen];
// }
}