Cyclic0007/obsidian-wikipedia-data
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Cleanup, finish settings, error handling, working alpha.

Browse Source
This commit is contained in:
Evan Harmon
2023-10-21 21:16:44 -05:00
parent 7bc32cf878
commit efa628dc8b
1 changed files with 81 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

144
main.ts
View File

@@ -1,4 +1,4 @@
import { App, Editor, MarkdownView, Modal, Notice, Plugin, PluginSettingTab, Setting, RequestUrlParam, request } from 'obsidian'; import { App, Editor, Notice, Plugin, PluginSettingTab, Setting, RequestUrlParam, request } from 'obsidian';
interface WikipediaDataSettings { interface WikipediaDataSettings {
template: string; template: string;
@@ -8,9 +8,10 @@ interface WikipediaDataSettings {
} }
interface WikiData { interface WikiData {
type: string;
title: string; title: string;
text: string;
description: string; description: string;
text: string;
url: string; url: string;
thumbnailUrl: string; thumbnailUrl: string;
} }
@@ -18,8 +19,8 @@ interface WikiData {
const extractApiUrl = "wikipedia.org/api/rest_v1/page/summary/"; const extractApiUrl = "wikipedia.org/api/rest_v1/page/summary/";
const DEFAULT_SETTINGS: WikipediaDataSettings = { const DEFAULT_SETTINGS: WikipediaDataSettings = {
template: `wikipedia:: [{{title}}]({{url}})\n> {{text}}`, template: `| {{thumbnailTemplate}} | {{text}} |\n|-|-|\n`,
thumbnailTemplate: `![thumbnail | 100]({{thumbnaillUrl}})`, thumbnailTemplate: `![thumbnail \| 100]({{thumbnailUrl}})`,
shouldBoldSearchTerm: true, shouldBoldSearchTerm: true,
language: "en", language: "en",
} }
@@ -43,60 +44,62 @@ export default class WikipediaData extends Plugin {
new Notice(`${searchTerm} not found on Wikipedia.`); new Notice(`${searchTerm} not found on Wikipedia.`);
} }
handleDisambiguation(searchTerm: string, disambiguationUrl: string) {
let linkElement = document.createElement("a");
linkElement.innerHTML = `${searchTerm} Disambiguation Page\n`;
linkElement.href = `${disambiguationUrl}`;
let fragment = new DocumentFragment;
fragment.appendChild(linkElement);
new Notice(`${searchTerm} returned a disambiguation page.`, 10000)
new Notice(fragment, 10000);
}
formatWikiDataText(wikiData: WikiData, searchTerm: string): string {
let formattedText: string = wikiData.text;
if (this.settings.shouldBoldSearchTerm) {
const pattern = new RegExp(searchTerm, "i");
formattedText = formattedText.replace(pattern, `**${searchTerm}**`);
}
return formattedText;
}
formatExtractInsert(wikiData: WikiData, searchTerm: string): string {
const formattedText = this.formatWikiDataText(wikiData, searchTerm);
const template = this.settings.template;
let thumbnailTemplate = "";
if (wikiData.thumbnailUrl === "" ) {
thumbnailTemplate = "replaceThumbnail";
}
else {
thumbnailTemplate = this.settings.thumbnailTemplate;
}
const formattedTemplate = template
.replace("{{text}}", formattedText)
.replace("{{title}}", wikiData.title)
.replace("{{url}}", wikiData.url)
.replace("{{thumbnailTemplate}}", thumbnailTemplate)
.replace("{{thumbnailUrl}}", wikiData.thumbnailUrl)
.replace("replaceThumbnail", "");
return formattedTemplate;
}
parseResponse(json: any): WikiData | undefined { parseResponse(json: any): WikiData | undefined {
console.log(json);
console.log(json.title);
console.log("EVAN");
if (json.title == "The page you requested doesn't exist") {
return undefined;
}
if (json.hasOwnProperty("thumbnail")) {
console.log("has thumbnail");
}
else {
console.log("no thumbnail");
}
const wikiData: WikiData = { const wikiData: WikiData = {
type: json.type,
title: json.title, title: json.title,
text: json.extract, text: json.extract,
description: json.description, description: json.description,
url: json.content_urls.desktop.page, url: json.content_urls.desktop.page,
thumbnailUrl: (json.hasOwnProperty("thumbnail")) ? json.thumbnail.source : "" thumbnailUrl: (json.hasOwnProperty("thumbnail")) ? json.thumbnail.source : ""
}; };
console.log("Parse Response wiki data EVAN");
console.log(wikiData);
return wikiData; return wikiData;
} }
formatWikiDataText(wikiData: WikiData, searchTerm: string): string {
let formattedText: string = wikiData.text;
if (this.settings.shouldBoldSearchTerm) {
const pattern = new RegExp(searchTerm, "i");
formattedText = formattedText.replace(pattern, `**${searchTerm}**`);
}
return formattedText;
}
formatExtractInsert(wikiData: WikiData, searchTerm: string): string {
const formattedText = this.formatWikiDataText(wikiData, searchTerm);
const template = this.settings.template;
const formattedTemplate = template
.replace("{{text}}", formattedText)
.replace("{{title}}", wikiData.title)
.replace("{{url}}", wikiData.url)
.replace("{{thumbnailUrl}}", wikiData.thumbnailUrl);
return formattedTemplate;
}
async getWikiData(title: string): Promise<WikiData | undefined> { async getWikiData(title: string): Promise<WikiData | undefined> {
const url = this.getApiUrl() + encodeURIComponent(title); const url = this.getApiUrl() + encodeURIComponent(title);
const requestParam: RequestUrlParam = { const requestParam: RequestUrlParam = {
url: url, url: url,
}; };
console.log("url");
console.log(url);
console.log("requestParam");
console.log(requestParam);
const resp = await request(requestParam) const resp = await request(requestParam)
.then((r) => JSON.parse(r)) .then((r) => JSON.parse(r))
.catch( .catch(
@@ -105,23 +108,28 @@ export default class WikipediaData extends Plugin {
"Failed to get Wikipedia. Check your internet connection or language prefix." "Failed to get Wikipedia. Check your internet connection or language prefix."
) )
); );
console.log("resp");
console.log(resp);
const wikiData = this.parseResponse(resp); const wikiData = this.parseResponse(resp);
return wikiData; return wikiData;
} }
async pasteIntoEditor(editor: Editor, searchTerm: string) { async pasteIntoEditor(editor: Editor, searchTerm: string) {
let testing2 = this.getWikiData(searchTerm); let apiResponse: WikiData = await this.getWikiData(searchTerm) as WikiData;
console.log(testing2); console.log("API Response");
console.log("type of"); console.log(apiResponse);
console.log(typeof testing2); if (!apiResponse) {
let apiResp: WikiData = await this.getWikiData(searchTerm) as WikiData;
if (!apiResp) {
this.handleNotFound(searchTerm); this.handleNotFound(searchTerm);
return; return;
} }
editor.replaceSelection(this.formatExtractInsert(apiResp, searchTerm)); else if (apiResponse.type.contains("missingtitle")) {
this.handleNotFound(searchTerm);
}
else if (apiResponse.type == "disambiguation") {
this.handleDisambiguation(searchTerm, apiResponse.url);
return;
}
else {
editor.replaceSelection(this.formatExtractInsert(apiResponse, searchTerm));
}
} }
async getWikipediaDataForActiveFile(editor: Editor) { async getWikipediaDataForActiveFile(editor: Editor) {
@@ -135,22 +143,18 @@ export default class WikipediaData extends Plugin {
} }
async onload() { async onload() {
console.log("Loading Wikipedia data plugin"); console.log("Loading Wikipedia Data Plugin");
await this.loadSettings(); await this.loadSettings();
this.addCommand({ this.addCommand({
id: "get-data-for-active-note-title", id: "get-data-for-active-note-title",
name: "Get Wikipedia Data for Active Note Title", name: "Get Wikipedia Data for Active Note Title",
editorCallback: (editor: Editor) => editorCallback: (editor: Editor) => this.getWikipediaDataForActiveFile(editor),
this.getWikipediaDataForActiveFile(editor), });
});
this.addSettingTab(new WikipediaDataSettingTab(this.app, this)); this.addSettingTab(new WikipediaDataSettingTab(this.app, this));
} }
async loadSettings() { async loadSettings() {
this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData()); this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
} }
@@ -179,7 +183,7 @@ class WikipediaDataSettingTab extends PluginSettingTab {
new Setting(containerEl) new Setting(containerEl)
.setName("Wikipedia Language Prefix") .setName("Wikipedia Language Prefix")
.setDesc(`Choose Wikipedia language prefix to use (ex. en for English)`) .setDesc(`Choose Wikipedia language prefix to use for API (ex. en for English)`)
.addText((textField) => { .addText((textField) => {
textField textField
.setValue(this.plugin.settings.language) .setValue(this.plugin.settings.language)
@@ -190,10 +194,10 @@ class WikipediaDataSettingTab extends PluginSettingTab {
}); });
new Setting(containerEl) new Setting(containerEl)
.setName("Wikipedia Extract Template") .setName("Wikipedia Data Template")
.setDesc( .setDesc(
`Set markdown template for extract to be inserted.\n `Set markdown template for data from the Wikipedia API to be inserted.\n
Available template variables are {{text}}, {{searchTerm}} and {{url}}. Available template variables are {{text}} (Short explanation of 1 or 2 sentences), {{title}}, {{url}} (of the Wikipedia page), {{thumbnailTemplate}} (inserts the Wikipedia Thumbnail Template defined below), and {{description}} (shorter, simpler description).
` `
) )
.addTextArea((textarea) => .addTextArea((textarea) =>
@@ -205,6 +209,20 @@ class WikipediaDataSettingTab extends PluginSettingTab {
}) })
); );
new Setting(containerEl)
.setName("Wikipedia Thumbnail Template")
.setDesc(
`Set markdown template for what will be inserted in the 'thumbnailTemplate' variable above. Use the {{thumbnailUrl}} here.`
)
.addTextArea((textarea) =>
textarea
.setValue(this.plugin.settings.thumbnailTemplate)
.onChange(async (value) => {
this.plugin.settings.thumbnailTemplate = value;
await this.plugin.saveSettings();
})
);
new Setting(containerEl) new Setting(containerEl)
.setName("Bold Search Term?") .setName("Bold Search Term?")
.setDesc( .setDesc(