Merge pull request #183 from ltctceplrm/api-toggle

mProjectsCode · web-flow · commit 917f7ab41144 · 2025-05-20T12:05:56.000+02:00
Restored and updated the api toggle + added a download option for poster images
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 ## Obsidian Media DB Plugin
 
-A plugin that can query multiple APIs for movies, series, anime, manga, games, music and wiki articles, and import them into your vault.
+A plugin that can query multiple APIs for movies, series, anime, manga, books, games, music and wiki articles, and import them into your vault.
 
 ### Features
 
@@ -36,6 +36,10 @@ Available variables that can be used in template tags are the same variables fro
 
 I also published my own templates [here](https://github.com/mProjectsCode/obsidian-media-db-templates).
 
+#### Download poster images
+
+Allows you to automatically download the poster images for a new media, ensuring offline access. The images are saved as `type_title (year)` e.g. `movie_The Perfect Storm (2000)` with a user chosen save location.
+
 #### Metadata field customization
 
 Allows you to rename the metadata fields this plugin generates through mappings.
@@ -113,7 +117,6 @@ Now you select the result you want and the plugin will cast it's magic and creat
 
 ### Currently supported APIs:
 
-
 | Name                                                 | Description                                                                                       | Supported formats                                     | Authentification                                                                                                                                                                   | Rate limiting                                                                                                                                                                                                                      | SFW filter support |
 | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
 | [Jikan](https://jikan.moe/)                          | Jikan is an API that uses [My Anime List](https://myanimelist.net) and offers metadata for anime. | series, movies, specials, OVAs, manga, manwha, novels | No                                                                                                                                                                                 | 60 per minute and 3 per second                                                                                                                                                                                                     | Yes                |
@@ -124,7 +127,7 @@ Now you select the result you want and the plugin will cast it's magic and creat
 | [Open Library](https://openlibrary.org)              | The OpenLibrary API offers metadata for books                                                     | books                                                 | No                                                                                                                                                                                 | Cover access is rate-limited when not using CoverID or OLID by max 100 requests/IP every 5 minutes. This plugin uses OLID so there shouldn't be a rate limit.                                                                      | No                 |
 | [Moby Games](https://www.mobygames.com)              | The Moby Games API offers metadata for games for all platforms                                    | games                                                 | Yes, by making an account [here](https://www.mobygames.com/user/register/). NOTE: As of September 2024 the API key is no longer free so consider using Giant Bomb or steam instead | API requests are limited to 360 per hour (one every ten seconds). In addition, requests should be made no more frequently than one per second.                                                                                     | No                 |
 | [Giant Bomb](https://www.giantbomb.com)              | The Giant Bomb API offers metadata for games for all platforms                                    | games                                                 | Yes, by making an account [here](https://www.giantbomb.com/login-signup/)                                                                                                          | API requests are limited to 200 requests per resource, per hour. In addition, they implement velocity detection to prevent malicious use. If too many requests are made per second, you may receive temporary blocks to resources. | No                 |
-| Comic Vine                                           | The Comic Vine API offers metadata for comic books                                                | comicbooks                                            | Yes, by making an account [here](https://comicvine.gamespot.com/login-signup/) and going to the [api section](https://comicvine.gamespot.com/api/) of the site                     | 200 requests per resource, per hour. There is also a velocity detection to prevent malicious use. If too many requests are made per second, you may receive temporary blocks to resources.                                         | No                 
+| Comic Vine                                           | The Comic Vine API offers metadata for comic books                                                | comicbooks                                            | Yes, by making an account [here](https://comicvine.gamespot.com/login-signup/) and going to the [api section](https://comicvine.gamespot.com/api/) of the site                     | 200 requests per resource, per hour. There is also a velocity detection to prevent malicious use. If too many requests are made per second, you may receive temporary blocks to resources.                                         | No                 |
 
 #### Notes
 
@@ -149,6 +152,10 @@ Now you select the result you want and the plugin will cast it's magic and creat
         - e.g. for "Rogue One" the URL looks like this `https://www.imdb.com/title/tt3748528/` so the ID is `tt3748528`
 - [MusicBrainz](https://musicbrainz.org/)
     - the id of a release is not easily accessible, you are better off just searching by title
+    - the search is generally for albums but you can have a more granular search like so:
+        - search for albums by a specific `artist:"Lady Gaga" AND primarytype:"album"`
+        - search for a specific album by a specific artist `artist:"Lady Gaga" AND primarytype:"album" AND releasegroup:"The Fame"`
+        - search for a specific entry (song or album) by a specific `artist:"Lady Gaga" AND releasegroup:"Poker face"`
 - [Wikipedia](https://en.wikipedia.org/wiki/Main_Page)
     - [here](https://en.wikipedia.org/wiki/Wikipedia:Finding_a_Wikidata_ID) is a guide to finding the Wikipedia ID for an article
 - [Steam](https://store.steampowered.com/)
diff --git a/src/api/APIModel.ts b/src/api/APIModel.ts
@@ -10,22 +10,19 @@ export abstract class APIModel {
 	plugin!: MediaDbPlugin;
 
 	/**
-	 * This function should query the api and return a list of matches. The matches should be caped at 20.
+	 * This function should query the api and return a list of matches. The matches should be capped at 20.
 	 *
 	 * @param title the title to query for
 	 */
 	abstract searchByTitle(title: string): Promise<MediaTypeModel[]>;
 
 	abstract getById(id: string): Promise<MediaTypeModel>;
 
+	abstract getDisabledMediaTypes(): MediaType[];
+
 	hasType(type: MediaType): boolean {
-		// if (
-		// 	this.types.contains(type) &&
-		// 	(Boolean((this.plugin.settings.apiToggle as any)?.[this.apiName]?.[type]) === true || (this.plugin.settings.apiToggle as any)?.[this.apiName]?.[type] === undefined)
-		// ) {
-		// 	return true;
-		// }
-		return this.types.contains(type);
+		const disabledMediaTypes = this.getDisabledMediaTypes();
+		return this.types.includes(type) && !disabledMediaTypes.includes(type);
 	}
 
 	hasTypeOverlap(types: MediaType[]): boolean {
diff --git a/src/api/apis/BoardGameGeekAPI.ts b/src/api/apis/BoardGameGeekAPI.ts
@@ -117,4 +117,7 @@ export class BoardGameGeekAPI extends APIModel {
 			},
 		});
 	}
+	getDisabledMediaTypes(): MediaType[] {
+		return this.plugin.settings.BoardgameGeekAPI_disabledMediaTypes as MediaType[];
+	}
 }
diff --git a/src/api/apis/ComicVineAPI.ts b/src/api/apis/ComicVineAPI.ts
@@ -95,4 +95,7 @@ export class ComicVineAPI extends APIModel {
 			},
 		});
 	}
+	getDisabledMediaTypes(): MediaType[] {
+		return this.plugin.settings.ComicVineAPI_disabledMediaTypes as MediaType[];
+	}
 }
diff --git a/src/api/apis/GiantBombAPI.ts b/src/api/apis/GiantBombAPI.ts
@@ -106,4 +106,7 @@ export class GiantBombAPI extends APIModel {
 			},
 		});
 	}
+	getDisabledMediaTypes(): MediaType[] {
+		return this.plugin.settings.GiantBombAPI_disabledMediaTypes as MediaType[];
+	}
 }
diff --git a/src/api/apis/MALAPI.ts b/src/api/apis/MALAPI.ts
@@ -195,4 +195,7 @@ export class MALAPI extends APIModel {
 
 		throw new Error(`MDB | Unknown media type for id ${id}`);
 	}
+	getDisabledMediaTypes(): MediaType[] {
+		return this.plugin.settings.MALAPI_disabledMediaTypes as MediaType[];
+	}
 }
diff --git a/src/api/apis/MALAPIManga.ts b/src/api/apis/MALAPIManga.ts
@@ -126,4 +126,7 @@ export class MALAPIManga extends APIModel {
 			},
 		});
 	}
+	getDisabledMediaTypes(): MediaType[] {
+		return this.plugin.settings.MALAPIManga_disabledMediaTypes as MediaType[];
+	}
 }
diff --git a/src/api/apis/MobyGamesAPI.ts b/src/api/apis/MobyGamesAPI.ts
@@ -107,4 +107,7 @@ export class MobyGamesAPI extends APIModel {
 			},
 		});
 	}
+	getDisabledMediaTypes(): MediaType[] {
+		return this.plugin.settings.MobyGamesAPI_disabledMediaTypes as MediaType[];
+	}
 }
diff --git a/src/api/apis/MusicBrainzAPI.ts b/src/api/apis/MusicBrainzAPI.ts
@@ -99,4 +99,7 @@ export class MusicBrainzAPI extends APIModel {
 			},
 		});
 	}
+	getDisabledMediaTypes(): MediaType[] {
+		return this.plugin.settings.MusicBrainzAPI_disabledMediaTypes as MediaType[];
+	}
 }
diff --git a/src/api/apis/OMDbAPI.ts b/src/api/apis/OMDbAPI.ts
@@ -151,7 +151,7 @@ export class OMDbAPI extends APIModel {
 				duration: result.Runtime ?? 'unknown',
 				onlineRating: Number.parseFloat(result.imdbRating ?? 0),
 				actors: result.Actors?.split(', ') ?? [],
-				image: result.Poster ?? '',
+				image: result.Poster ? result.Poster.replace('_SX300', '_SX600') : '',
 
 				released: true,
 				streamingServices: [],
@@ -181,7 +181,7 @@ export class OMDbAPI extends APIModel {
 				duration: result.Runtime ?? 'unknown',
 				onlineRating: Number.parseFloat(result.imdbRating ?? 0),
 				actors: result.Actors?.split(', ') ?? [],
-				image: result.Poster ?? '',
+				image: result.Poster ? result.Poster.replace('_SX300', '_SX600') : '',
 
 				released: true,
 				streamingServices: [],
@@ -209,7 +209,7 @@ export class OMDbAPI extends APIModel {
 				publishers: [],
 				genres: result.Genre?.split(', ') ?? [],
 				onlineRating: Number.parseFloat(result.imdbRating ?? 0),
-				image: result.Poster ?? '',
+				image: result.Poster ? result.Poster.replace('_SX300', '_SX600') : '',
 
 				released: true,
 				releaseDate: this.plugin.dateFormatter.format(result.Released, this.apiDateFormat) ?? 'unknown',
@@ -223,4 +223,8 @@ export class OMDbAPI extends APIModel {
 
 		throw new Error(`MDB | Unknown media type for id ${id}`);
 	}
+
+	getDisabledMediaTypes(): MediaType[] {
+		return this.plugin.settings.OMDbAPI_disabledMediaTypes as MediaType[];
+	}
 }
diff --git a/src/api/apis/OpenLibraryAPI.ts b/src/api/apis/OpenLibraryAPI.ts
@@ -89,4 +89,7 @@ export class OpenLibraryAPI extends APIModel {
 			},
 		});
 	}
+	getDisabledMediaTypes(): MediaType[] {
+		return this.plugin.settings.OpenLibraryAPI_disabledMediaTypes as MediaType[];
+	}
 }
diff --git a/src/api/apis/SteamAPI.ts b/src/api/apis/SteamAPI.ts
@@ -4,6 +4,7 @@ import { GameModel } from '../../models/GameModel';
 import type { MediaTypeModel } from '../../models/MediaTypeModel';
 import { MediaType } from '../../utils/MediaType';
 import { APIModel } from '../APIModel';
+import { imageUrlExists } from '../../utils/Utils';
 
 export class SteamAPI extends APIModel {
 	plugin: MediaDbPlugin;
@@ -85,6 +86,16 @@ export class SteamAPI extends APIModel {
 
 		// console.debug(result);
 
+		// Check if a poster version of the image exists, else use the header image
+		const imageUrl = `https://steamcdn-a.akamaihd.net/steam/apps/${result.steam_appid}/library_600x900_2x.jpg`;
+		const exists = await imageUrlExists(imageUrl);
+		let finalimageurl;
+		if (exists) {
+			finalimageurl = imageUrl;
+		} else {
+			finalimageurl = result.header_image ?? '';
+		}
+
 		return new GameModel({
 			type: MediaType.Game,
 			title: result.name,
@@ -98,7 +109,7 @@ export class SteamAPI extends APIModel {
 			publishers: result.publishers,
 			genres: result.genres?.map((x: any) => x.description) ?? [],
 			onlineRating: Number.parseFloat(result.metacritic?.score ?? 0),
-			image: result.header_image ?? '',
+			image: finalimageurl ?? '',
 
 			released: !result.release_date?.coming_soon,
 			releaseDate: this.plugin.dateFormatter.format(result.release_date?.date, this.apiDateFormat) ?? 'unknown',
@@ -109,4 +120,7 @@ export class SteamAPI extends APIModel {
 			},
 		});
 	}
+	getDisabledMediaTypes(): MediaType[] {
+		return this.plugin.settings.SteamAPI_disabledMediaTypes as MediaType[];
+	}
 }
diff --git a/src/api/apis/WikipediaAPI.ts b/src/api/apis/WikipediaAPI.ts
@@ -79,4 +79,7 @@ export class WikipediaAPI extends APIModel {
 			userData: {},
 		});
 	}
+	getDisabledMediaTypes(): MediaType[] {
+		return this.plugin.settings.WikipediaAPI_disabledMediaTypes as MediaType[];
+	}
 }
diff --git a/src/main.ts b/src/main.ts
@@ -1,4 +1,5 @@
 import { MarkdownView, Notice, parseYaml, Plugin, stringifyYaml, TFile, TFolder } from 'obsidian';
+import { requestUrl, normalizePath } from 'obsidian'; // Add requestUrl import
 import type { MediaType } from 'src/utils/MediaType';
 import { APIManager } from './api/APIManager';
 import { BoardGameGeekAPI } from './api/apis/BoardGameGeekAPI';
@@ -219,13 +220,17 @@ export default class MediaDbPlugin extends Plugin {
 				(await this.modalHelper.openSelectModal({ elements: apiSearchResults }, async selectModalData => {
 					return await this.queryDetails(selectModalData.selected);
 				})) ?? [];
-			if (!selectResults) {
+			if (!selectResults || selectResults.length < 1) {
 				return;
 			}
 
-			proceed = await this.modalHelper.openPreviewModal({ elements: selectResults }, async previewModalData => {
+			const confirmed = await this.modalHelper.openPreviewModal({ elements: selectResults }, async previewModalData => {
 				return previewModalData.confirmed;
 			});
+			if (!confirmed) {
+				return;
+			}
+			break;
 		}
 
 		await this.createMediaDbNotes(selectResults!);
@@ -249,13 +254,17 @@ export default class MediaDbPlugin extends Plugin {
 				(await this.modalHelper.openSelectModal({ elements: apiSearchResults }, async selectModalData => {
 					return await this.queryDetails(selectModalData.selected);
 				})) ?? [];
-			if (!selectResults) {
+			if (!selectResults || selectResults.length < 1) {
 				return;
 			}
 
-			proceed = await this.modalHelper.openPreviewModal({ elements: selectResults }, async previewModalData => {
+			const confirmed = await this.modalHelper.openPreviewModal({ elements: selectResults }, async previewModalData => {
 				return previewModalData.confirmed;
 			});
+			if (!confirmed) {
+				return;
+			}
+			break;
 		}
 
 		await this.createMediaDbNotes(selectResults!);
@@ -307,6 +316,33 @@ export default class MediaDbPlugin extends Plugin {
 
 			options.openNote = this.settings.openNoteInNewTab;
 
+			if (mediaTypeModel.image && typeof mediaTypeModel.image === 'string' && mediaTypeModel.image.startsWith('http')) {
+				if (this.settings.imageDownload) {
+					try {
+						const imageurl = mediaTypeModel.image;
+						const imageext = imageurl.split('.').pop()?.split(/\#|\?/)[0] || 'jpg';
+						const imagefileName = `${replaceIllegalFileNameCharactersInString(`${mediaTypeModel.type}_${mediaTypeModel.title} (${mediaTypeModel.year})`)}.${imageext}`;
+						const imagepath = normalizePath(`${this.settings.imageFolder}/${imagefileName}`);
+
+						if (!this.app.vault.getAbstractFileByPath(this.settings.imageFolder)) {
+							await this.app.vault.createFolder(this.settings.imageFolder);
+						}
+
+						if (!this.app.vault.getAbstractFileByPath(imagepath)) {
+							const response = await requestUrl({ url: imageurl, method: 'GET' });
+							await this.app.vault.createBinary(imagepath, response.arrayBuffer);
+						}
+
+						// Update model to use local image path
+						mediaTypeModel.image = `[[${imagepath}]]`;
+					} catch (e) {
+						console.warn('MDB | Failed to download image:', e);
+					}
+				} else {
+					mediaTypeModel.image = mediaTypeModel.image;
+				}
+			}
+
 			const fileContent = await this.generateMediaDbNoteContents(mediaTypeModel, options);
 
 			if (!options.folder) {
diff --git a/src/models/MediaTypeModel.ts b/src/models/MediaTypeModel.ts
@@ -9,6 +9,7 @@ export abstract class MediaTypeModel {
 	dataSource: string;
 	url: string;
 	id: string;
+	image?: string;
 
 	userData: object;
 
@@ -21,6 +22,8 @@ export abstract class MediaTypeModel {
 		this.dataSource = '';
 		this.url = '';
 		this.id = '';
+		this.image = '';
+
 		this.userData = {};
 	}
 
diff --git a/src/settings/Settings.ts b/src/settings/Settings.ts
diff --git a/src/utils/ModalHelper.ts b/src/utils/ModalHelper.ts
diff --git a/src/utils/Utils.ts b/src/utils/Utils.ts

Original file line number	Diff line number	Diff line change
`@@ -117,4 +117,7 @@ export class BoardGameGeekAPI extends APIModel {`
`117`	`117`	`},`
`118`	`118`	`});`
`119`	`119`	`}`
	`120`	`+ getDisabledMediaTypes(): MediaType[] {`
	`121`	`+ return this.plugin.settings.BoardgameGeekAPI_disabledMediaTypes as MediaType[];`
	`122`	`+ }`
`120`	`123`	`}`
Original file line number	Diff line number	Diff line change
`@@ -95,4 +95,7 @@ export class ComicVineAPI extends APIModel {`
`95`	`95`	`},`
`96`	`96`	`});`
`97`	`97`	`}`
	`98`	`+ getDisabledMediaTypes(): MediaType[] {`
	`99`	`+ return this.plugin.settings.ComicVineAPI_disabledMediaTypes as MediaType[];`
	`100`	`+ }`
`98`	`101`	`}`
Original file line number	Diff line number	Diff line change
`@@ -106,4 +106,7 @@ export class GiantBombAPI extends APIModel {`
`106`	`106`	`},`
`107`	`107`	`});`
`108`	`108`	`}`
	`109`	`+ getDisabledMediaTypes(): MediaType[] {`
	`110`	`+ return this.plugin.settings.GiantBombAPI_disabledMediaTypes as MediaType[];`
	`111`	`+ }`
`109`	`112`	`}`
Original file line number	Diff line number	Diff line change
`@@ -195,4 +195,7 @@ export class MALAPI extends APIModel {`
`195`	`195`
`196`	`196`	throw new Error(`MDB \| Unknown media type for id ${id}`);
`197`	`197`	`}`
	`198`	`+ getDisabledMediaTypes(): MediaType[] {`
	`199`	`+ return this.plugin.settings.MALAPI_disabledMediaTypes as MediaType[];`
	`200`	`+ }`
`198`	`201`	`}`
Original file line number	Diff line number	Diff line change
`@@ -126,4 +126,7 @@ export class MALAPIManga extends APIModel {`
`126`	`126`	`},`
`127`	`127`	`});`
`128`	`128`	`}`
	`129`	`+ getDisabledMediaTypes(): MediaType[] {`
	`130`	`+ return this.plugin.settings.MALAPIManga_disabledMediaTypes as MediaType[];`
	`131`	`+ }`
`129`	`132`	`}`
Original file line number	Diff line number	Diff line change
`@@ -107,4 +107,7 @@ export class MobyGamesAPI extends APIModel {`
`107`	`107`	`},`
`108`	`108`	`});`
`109`	`109`	`}`
	`110`	`+ getDisabledMediaTypes(): MediaType[] {`
	`111`	`+ return this.plugin.settings.MobyGamesAPI_disabledMediaTypes as MediaType[];`
	`112`	`+ }`
`110`	`113`	`}`
Original file line number	Diff line number	Diff line change
`@@ -99,4 +99,7 @@ export class MusicBrainzAPI extends APIModel {`
`99`	`99`	`},`
`100`	`100`	`});`
`101`	`101`	`}`
	`102`	`+ getDisabledMediaTypes(): MediaType[] {`
	`103`	`+ return this.plugin.settings.MusicBrainzAPI_disabledMediaTypes as MediaType[];`
	`104`	`+ }`
`102`	`105`	`}`