Templates for file names #8

Author: mProjectsCode

src/main.ts

@@ -2,18 +2,20 @@ import {Notice, Plugin, TFile} from 'obsidian';
 import {DEFAULT_SETTINGS, MediaDbPluginSettings, MediaDbSettingTab} from './settings/Settings';
 import {APIManager} from './api/APIManager';
 import {MediaTypeModel} from './models/MediaTypeModel';
-import {replaceIllegalFileNameCharactersInString, replaceTags} from './utils/Utils';
+import {replaceIllegalFileNameCharactersInString} from './utils/Utils';
 import {OMDbAPI} from './api/apis/OMDbAPI';
 import {MediaDbAdvancedSearchModal} from './modals/MediaDbAdvancedSearchModal';
 import {MediaDbSearchResultModal} from './modals/MediaDbSearchResultModal';
 import {MALAPI} from './api/apis/MALAPI';
 import {MediaDbIdSearchModal} from './modals/MediaDbIdSearchModal';
 import {WikipediaAPI} from './api/apis/WikipediaAPI';
 import {MusicBrainzAPI} from './api/apis/MusicBrainzAPI';
+import {MediaTypeManager} from './utils/MediaTypeManager';
 
 export default class MediaDbPlugin extends Plugin {
 	settings: MediaDbPluginSettings;
 	apiManager: APIManager;
+	mediaTypeManager: MediaTypeManager;
 
 	async onload() {
 		await this.loadSettings();
@@ -54,6 +56,8 @@ export default class MediaDbPlugin extends Plugin {
 		this.apiManager.registerAPI(new WikipediaAPI(this));
 		this.apiManager.registerAPI(new MusicBrainzAPI(this));
 		// this.apiManager.registerAPI(new LocGovAPI(this)); // TODO: parse data
+
+		this.mediaTypeManager = new MediaTypeManager(this.settings);
 	}
 
 	async createMediaDbNote(modal: () => Promise<MediaTypeModel>): Promise<void> {
@@ -68,37 +72,18 @@ export default class MediaDbPlugin extends Plugin {
 		}
 	}
 
-	async createMediaDbNoteFromModel(data: MediaTypeModel): Promise<void> {
+	async createMediaDbNoteFromModel(mediaTypeModel: MediaTypeModel): Promise<void> {
 		try {
 			console.log('MDB | Creating new note...');
-			// console.log(data);
-
-			let fileContent = `---\n${data.toMetaData()}---\n`;
-
-			let templateFile: TFile = null;
-
-			if (data.type === 'movie' && this.settings.movieTemplate) {
-				templateFile = this.app.vault.getFiles().filter((f: TFile) => f.name === this.settings.movieTemplate).first();
-			} else if (data.type === 'series' && this.settings.seriesTemplate) {
-				templateFile = this.app.vault.getFiles().filter((f: TFile) => f.name === this.settings.seriesTemplate).first();
-			} else if (data.type === 'game' && this.settings.gameTemplate) {
-				templateFile = this.app.vault.getFiles().filter((f: TFile) => f.name === this.settings.gameTemplate).first();
-			} else if (data.type === 'wiki' && this.settings.wikiTemplate) {
-				templateFile = this.app.vault.getFiles().filter((f: TFile) => f.name === this.settings.wikiTemplate).first();
-			} else if (data.type === 'musicRelease' && this.settings.musicReleaseTemplate) {
-				templateFile = this.app.vault.getFiles().filter((f: TFile) => f.name === this.settings.musicReleaseTemplate).first();
-			}
+			// console.log(mediaTypeModel);
+
+			let fileContent = `---\n${mediaTypeModel.toMetaData()}---\n`;
 
-			if (templateFile) {
-				let template = await this.app.vault.cachedRead(templateFile);
-				// console.log(template);
-				if (this.settings.templates) {
-					template = replaceTags(template, data);
-				}
-				fileContent += template;
+			if (this.settings.templates) {
+				fileContent += await this.mediaTypeManager.getContent(mediaTypeModel, this.app);
 			}
 
-			const fileName = replaceIllegalFileNameCharactersInString(data.getFileName());
+			const fileName = replaceIllegalFileNameCharactersInString(this.mediaTypeManager.getFileName(mediaTypeModel));
 			const filePath = `${this.settings.folder.replace(/\/$/, '')}/${fileName}.md`;
 
 			await this.app.vault.delete(this.app.vault.getAbstractFileByPath(filePath));
@@ -120,9 +105,9 @@ export default class MediaDbPlugin extends Plugin {
 
 	async openMediaDbSearchModal(): Promise<MediaTypeModel> {
 		return new Promise(((resolve, reject) => {
-			new MediaDbAdvancedSearchModal(this.app, this.apiManager, (err, results) => {
+			new MediaDbAdvancedSearchModal(this.app, this, (err, results) => {
 				if (err) return reject(err);
-				new MediaDbSearchResultModal(this.app, results, (err2, res) => {
+				new MediaDbSearchResultModal(this.app, this, results, (err2, res) => {
 					if (err2) return reject(err2);
 					resolve(res);
 				}).open();
@@ -132,7 +117,7 @@ export default class MediaDbPlugin extends Plugin {
 
 	async openMediaDbIdSearchModal(): Promise<MediaTypeModel> {
 		return new Promise(((resolve, reject) => {
-			new MediaDbIdSearchModal(this.app, this.apiManager, (err, res) => {
+			new MediaDbIdSearchModal(this.app, this, (err, res) => {
 				if (err) return reject(err);
 				resolve(res);
 			}).open();
@@ -165,6 +150,7 @@ export default class MediaDbPlugin extends Plugin {
 	}
 
 	async saveSettings() {
+		this.mediaTypeManager.updateTemplates(this.settings);
 		await this.saveData(this.settings);
 	}
 }

src/modals/MediaDbAdvancedSearchModal.ts

@@ -1,22 +1,22 @@
 import {App, ButtonComponent, Component, Modal, Notice, Setting, TextComponent, ToggleComponent} from 'obsidian';
 import {MediaTypeModel} from '../models/MediaTypeModel';
-import {APIManager} from '../api/APIManager';
 import {debugLog} from '../utils/Utils';
+import MediaDbPlugin from '../main';
 
 export class MediaDbAdvancedSearchModal extends Modal {
 	query: string;
 	isBusy: boolean;
-	apiManager: APIManager;
+	plugin: MediaDbPlugin;
 	searchBtn: ButtonComponent;
 	selectedApis: any;
 	onSubmit: (err: Error, result?: MediaTypeModel[]) => void;
 
-	constructor(app: App, apiManager: APIManager, onSubmit?: (err: Error, result?: MediaTypeModel[]) => void) {
+	constructor(app: App, plugin: MediaDbPlugin, onSubmit?: (err: Error, result?: MediaTypeModel[]) => void) {
 		super(app);
-		this.apiManager = apiManager;
+		this.plugin = plugin;
 		this.onSubmit = onSubmit;
 		this.selectedApis = [];
-		for (const api of this.apiManager.apis) {
+		for (const api of this.plugin.apiManager.apis) {
 			this.selectedApis[api.apiName] = false;
 		}
 	}
@@ -56,7 +56,7 @@ export class MediaDbAdvancedSearchModal extends Modal {
 
 				console.log(`MDB | query started with title ${this.query}`);
 
-				const res = await this.apiManager.query(this.query, this.selectedApis);
+				const res = await this.plugin.apiManager.query(this.query, this.selectedApis);
 				this.onSubmit(null, res);
 			} catch (e) {
 				this.onSubmit(e);
@@ -84,7 +84,7 @@ export class MediaDbAdvancedSearchModal extends Modal {
 		contentEl.createEl('h3', {text: 'APIs to search'});
 
 		const apiToggleComponents: Component[] = [];
-		for (const api of this.apiManager.apis) {
+		for (const api of this.plugin.apiManager.apis) {
 			const apiToggleListElementWrapper = contentEl.createEl('div', {cls: 'media-db-plugin-list-wrapper'});
 
 			const apiToggleTextWrapper = apiToggleListElementWrapper.createEl('div', {cls: 'media-db-plugin-list-text-wrapper'});

src/modals/MediaDbIdSearchModal.ts

@@ -1,19 +1,19 @@
 import {App, ButtonComponent, DropdownComponent, Modal, Notice, Setting, TextComponent} from 'obsidian';
 import {MediaTypeModel} from '../models/MediaTypeModel';
-import {APIManager} from '../api/APIManager';
 import {debugLog} from '../utils/Utils';
+import MediaDbPlugin from '../main';
 
 export class MediaDbIdSearchModal extends Modal {
 	query: string;
 	isBusy: boolean;
-	apiManager: APIManager;
+	plugin: MediaDbPlugin;
 	searchBtn: ButtonComponent;
 	selectedApi: string;
 	onSubmit: (err: Error, result?: MediaTypeModel) => void;
 
-	constructor(app: App, apiManager: APIManager, onSubmit?: (err: Error, result?: MediaTypeModel) => void) {
+	constructor(app: App, plugin: MediaDbPlugin, onSubmit?: (err: Error, result?: MediaTypeModel) => void) {
 		super(app);
-		this.apiManager = apiManager;
+		this.plugin = plugin;
 		this.onSubmit = onSubmit;
 		this.selectedApi = '';
 	}
@@ -46,7 +46,7 @@ export class MediaDbIdSearchModal extends Modal {
 
 				console.log(`MDB | query started with id ${this.query}`);
 
-				const api = this.apiManager.getApiByName(this.selectedApi);
+				const api = this.plugin.apiManager.getApiByName(this.selectedApi);
 				if (!api) {
 					this.onSubmit(new Error('the selected api does not exist'));
 				}
@@ -83,7 +83,7 @@ export class MediaDbIdSearchModal extends Modal {
 		apiSelectorComponent.onChange((value: string) => {
 			this.selectedApi = value;
 		});
-		for (const api of this.apiManager.apis) {
+		for (const api of this.plugin.apiManager.apis) {
 			apiSelectorComponent.addOption(api.apiName, api.apiName);
 		}
 		apiSelectorWrapper.appendChild(apiSelectorComponent.selectEl);

src/modals/MediaDbSearchResultModal.ts

@@ -1,12 +1,15 @@
 import {App, SuggestModal} from 'obsidian';
 import {MediaTypeModel} from '../models/MediaTypeModel';
+import MediaDbPlugin from '../main';
 
 export class MediaDbSearchResultModal extends SuggestModal<MediaTypeModel> {
 	suggestion: MediaTypeModel[];
+	plugin: MediaDbPlugin;
 	onChoose: (error: Error, result?: MediaTypeModel) => void;
 
-	constructor(app: App, suggestion: MediaTypeModel[], onChoose: (error: Error, result?: MediaTypeModel) => void) {
+	constructor(app: App, plugin: MediaDbPlugin, suggestion: MediaTypeModel[], onChoose: (error: Error, result?: MediaTypeModel) => void) {
 		super(app);
+		this.plugin = plugin;
 		this.suggestion = suggestion;
 		this.onChoose = onChoose;
 	}
@@ -20,9 +23,9 @@ export class MediaDbSearchResultModal extends SuggestModal<MediaTypeModel> {
 
 	// Renders each suggestion item.
 	renderSuggestion(item: MediaTypeModel, el: HTMLElement) {
-		el.createEl('div', {text: item.getFileName()});
+		el.createEl('div', {text: this.plugin.mediaTypeManager.getFileName(item)});
 		el.createEl('small', {text: `${item.englishTitle}\n`});
-		el.createEl('small', {text: `${item.type.toUpperCase()} from ${item.dataSource}`});
+		el.createEl('small', {text: `${item.type.toUpperCase() + (item.subType ? ` (${item.subType})` : '')} from ${item.dataSource}`});
 	}
 
 	// Perform action on the selected suggestion.

src/models/GameModel.ts

@@ -1,6 +1,6 @@
 import {MediaTypeModel} from './MediaTypeModel';
-import {stringifyYaml} from 'obsidian';
 import {mediaDbTag} from '../utils/Utils';
+import {MediaType} from '../utils/MediaType';
 
 
 export class GameModel extends MediaTypeModel {
@@ -29,19 +29,15 @@ export class GameModel extends MediaTypeModel {
 
 		Object.assign(this, obj);
 
-		this.type = 'game';
-	}
-
-	toMetaData(): string {
-		return stringifyYaml({...this, tags: '#' + this.getTags().join('/')});
-	}
-
-	getFileName(): string {
-		return this.title + (this.year ? ` (${this.year})` : '');
+		this.type = this.getMediaType();
 	}
 
 	getTags(): string[] {
 		return [mediaDbTag, 'game'];
 	}
 
+	getMediaType(): MediaType {
+		return MediaType.Game;
+	}
+
 }

src/models/MediaTypeModel.ts

@@ -1,3 +1,6 @@
+import {MediaType} from '../utils/MediaType';
+import {stringifyYaml} from 'obsidian';
+
 export abstract class MediaTypeModel {
 	type: string;
 	subType: string;
@@ -8,10 +11,12 @@ export abstract class MediaTypeModel {
 	url: string;
 	id: string;
 
-	abstract toMetaData(): string;
-
-	abstract getFileName(): string;
+	abstract getMediaType(): MediaType;
 
 	abstract getTags(): string[];
 
+	toMetaData(): string {
+		return stringifyYaml({...this, tags: '#' + this.getTags().join('/')});
+	}
+
 }

src/models/MovieModel.ts

@@ -1,6 +1,6 @@
 import {MediaTypeModel} from './MediaTypeModel';
-import {stringifyYaml} from 'obsidian';
 import {mediaDbTag} from '../utils/Utils';
+import {MediaType} from '../utils/MediaType';
 
 
 export class MovieModel extends MediaTypeModel {
@@ -32,19 +32,15 @@ export class MovieModel extends MediaTypeModel {
 
 		Object.assign(this, obj);
 
-		this.type = 'movie';
-	}
-
-	toMetaData(): string {
-		return stringifyYaml({...this, tags: '#' + this.getTags().join('/')});
-	}
-
-	getFileName(): string {
-		return this.title + (this.year ? ` (${this.year})` : '');
+		this.type = this.getMediaType();
 	}
 
 	getTags(): string[] {
 		return [mediaDbTag, 'tv', 'movie'];
 	}
 
+	getMediaType(): MediaType {
+		return MediaType.Movie;
+	}
+
 }

src/models/MusicReleaseModel.ts

@@ -1,6 +1,6 @@
 import {MediaTypeModel} from './MediaTypeModel';
-import {stringifyYaml} from 'obsidian';
 import {mediaDbTag} from '../utils/Utils';
+import {MediaType} from '../utils/MediaType';
 
 
 export class MusicReleaseModel extends MediaTypeModel {
@@ -24,19 +24,15 @@ export class MusicReleaseModel extends MediaTypeModel {
 
 		Object.assign(this, obj);
 
-		this.type = 'musicRelease';
-	}
-
-	toMetaData(): string {
-		return stringifyYaml({...this, tags: '#' + this.getTags().join('/')});
-	}
-
-	getFileName(): string {
-		return this.title + ' (' + this.artists.join(', ') + ' - ' + this.year + ' - ' + this.subType + ')';
+		this.type = this.getMediaType();
 	}
 
 	getTags(): string[] {
 		return [mediaDbTag, 'music', 'album'];
 	}
 
+	getMediaType(): MediaType {
+		return MediaType.MusicRelease;
+	}
+
 }

src/models/SeriesModel.ts

@@ -1,6 +1,6 @@
 import {MediaTypeModel} from './MediaTypeModel';
-import {stringifyYaml} from 'obsidian';
 import {mediaDbTag} from '../utils/Utils';
+import {MediaType} from '../utils/MediaType';
 
 
 export class SeriesModel extends MediaTypeModel {
@@ -35,19 +35,15 @@ export class SeriesModel extends MediaTypeModel {
 
 		Object.assign(this, obj);
 
-		this.type = 'series';
-	}
-
-	toMetaData(): string {
-		return stringifyYaml({...this, tags: '#' + this.getTags().join('/')});
-	}
-
-	getFileName(): string {
-		return this.title + ' (' + this.year + ')';
+		this.type = this.getMediaType();
 	}
 
 	getTags(): string[] {
 		return [mediaDbTag, 'tv', 'series'];
 	}
 
+	getMediaType(): MediaType {
+		return MediaType.Series;
+	}
+
 }