afiqzudinhadi/obsidian-media-db-sync
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Templates for file names #8

Browse source
This commit is contained in:
mProjectsCode 2022-05-22 12:59:14 +02:00
parent 16299feced
commit 2c57094332
14 changed files with 231 additions and 115 deletions
Download patch file Download diff file Expand all files Collapse all files

44
src/main.ts
View file

@ -2,7 +2,7 @@ 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';
@ -10,10 +10,12 @@ 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);
// console.log(mediaTypeModel);
let fileContent = `---\n${data.toMetaData()}---\n`;
let fileContent = `---\n${mediaTypeModel.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();
if (this.settings.templates) {
fileContent += await this.mediaTypeManager.getContent(mediaTypeModel, this.app);
}
if (templateFile) {
let template = await this.app.vault.cachedRead(templateFile);
// console.log(template);
if (this.settings.templates) {
template = replaceTags(template, data);
}
fileContent += template;
}
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);
}
}

14
src/modals/MediaDbAdvancedSearchModal.ts
View file

@ -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'});

12
src/modals/MediaDbIdSearchModal.ts
View file

@ -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);

9
src/modals/MediaDbSearchResultModal.ts
View file

@ -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.

16
src/models/GameModel.ts
View file

@ -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;
}
}

11
src/models/MediaTypeModel.ts
View file

@ -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('/')});
}
}

16
src/models/MovieModel.ts
View file

@ -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;
}
}

16
src/models/MusicReleaseModel.ts
View file

@ -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;
}
}

16
src/models/SeriesModel.ts
View file

@ -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;
}
}

16
src/models/WikiModel.ts
View file

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

111
src/settings/Settings.ts
View file

@ -9,11 +9,19 @@ export interface MediaDbPluginSettings {
folder: string,
sfwFilter: boolean,
OMDbKey: string,
movieTemplate: string,
seriesTemplate: string,
gameTemplate: string,
wikiTemplate: string,
musicReleaseTemplate: string,
movieFileNameTemplate: string,
seriesFileNameTemplate: string,
gameFileNameTemplate: string,
wikiFileNameTemplate: string,
musicReleaseFileNameTemplate: string,
templates: boolean,
}
@ -21,11 +29,19 @@ export const DEFAULT_SETTINGS: MediaDbPluginSettings = {
folder: '',
sfwFilter: true,
OMDbKey: '',
movieTemplate: '',
seriesTemplate: '',
gameTemplate: '',
wikiTemplate: '',
musicReleaseTemplate: '',
movieFileNameTemplate: '{{ title }} ({{ year }})',
seriesFileNameTemplate: '{{ title }} ({{ year }})',
gameFileNameTemplate: '{{ title }} ({{ year }})',
wikiFileNameTemplate: '{{ title }}',
musicReleaseFileNameTemplate: '{{ title }} (by {{ artists.0 }} - {{ year }})',
templates: true,
};
@ -57,6 +73,29 @@ export class MediaDbSettingTab extends PluginSettingTab {
});
});
new Setting(containerEl)
.setName('OMDb API key')
.setDesc('API key for "www.omdbapi.com".')
.addText(cb => {
cb.setPlaceholder('API key')
.setValue(this.plugin.settings.OMDbKey)
.onChange(data => {
this.plugin.settings.OMDbKey = data;
this.plugin.saveSettings();
});
});
new Setting(containerEl)
.setName('SFW filter')
.setDesc('Only shows SFW results for APIs that offer filtering.')
.addToggle(cb => {
cb.setValue(this.plugin.settings.sfwFilter)
.onChange(data => {
this.plugin.settings.sfwFilter = data;
this.plugin.saveSettings();
});
});
new Setting(containerEl)
.setName('Resolve {{ tags }} in templates')
.setDesc('Whether to resolve {{ tags }} in templates. The spaces inside the curly braces are important.')
@ -68,6 +107,9 @@ export class MediaDbSettingTab extends PluginSettingTab {
});
});
containerEl.createEl('h3', {text: 'Template Settings'});
// region templates
new Setting(containerEl)
.setName('Movie template')
.setDesc('Template file to be used when creating a new note for a movie.')
@ -132,29 +174,76 @@ export class MediaDbSettingTab extends PluginSettingTab {
this.plugin.saveSettings();
});
});
// endregion
containerEl.createEl('h3', {text: 'File Name Settings'});
// region file name templates
new Setting(containerEl)
.setName('OMDb API key')
.setDesc('API key for "www.omdbapi.com".')
.addText(cb => {
cb.setPlaceholder('API key')
.setValue(this.plugin.settings.OMDbKey)
.setName('Movie file name template')
.setDesc('Template for the file name used when creating a new note for a movie.')
.addSearch(cb => {
new FileSuggest(this.app, cb.inputEl);
cb.setPlaceholder(`Example: ${DEFAULT_SETTINGS.movieFileNameTemplate}`)
.setValue(this.plugin.settings.movieFileNameTemplate)
.onChange(data => {
this.plugin.settings.OMDbKey = data;
this.plugin.settings.movieFileNameTemplate = data;
this.plugin.saveSettings();
});
});
new Setting(containerEl)
.setName('SFW filter')
.setDesc('Only shows SFW results for APIs that offer filtering.')
.addToggle(cb => {
cb.setValue(this.plugin.settings.sfwFilter)
.setName('Series file name template')
.setDesc('Template for the file name used when creating a new note for a series.')
.addSearch(cb => {
new FileSuggest(this.app, cb.inputEl);
cb.setPlaceholder(`Example: ${DEFAULT_SETTINGS.seriesFileNameTemplate}`)
.setValue(this.plugin.settings.seriesFileNameTemplate)
.onChange(data => {
this.plugin.settings.sfwFilter = data;
this.plugin.settings.seriesFileNameTemplate = data;
this.plugin.saveSettings();
});
});
new Setting(containerEl)
.setName('Game file name template')
.setDesc('Template for the file name used when creating a new note for a game.')
.addSearch(cb => {
new FileSuggest(this.app, cb.inputEl);
cb.setPlaceholder(`Example: ${DEFAULT_SETTINGS.gameFileNameTemplate}`)
.setValue(this.plugin.settings.gameFileNameTemplate)
.onChange(data => {
this.plugin.settings.gameFileNameTemplate = data;
this.plugin.saveSettings();
});
});
new Setting(containerEl)
.setName('Wiki file name template')
.setDesc('Template for the file name used when creating a new note for a wiki entry.')
.addSearch(cb => {
new FileSuggest(this.app, cb.inputEl);
cb.setPlaceholder(`Example: ${DEFAULT_SETTINGS.wikiFileNameTemplate}`)
.setValue(this.plugin.settings.wikiFileNameTemplate)
.onChange(data => {
this.plugin.settings.wikiFileNameTemplate = data;
this.plugin.saveSettings();
});
});
new Setting(containerEl)
.setName('Music Release file name template')
.setDesc('Template for the file name used when creating a new note for a music release.')
.addSearch(cb => {
new FileSuggest(this.app, cb.inputEl);
cb.setPlaceholder(`Example: ${DEFAULT_SETTINGS.musicReleaseFileNameTemplate}`)
.setValue(this.plugin.settings.musicReleaseFileNameTemplate)
.onChange(data => {
this.plugin.settings.musicReleaseFileNameTemplate = data;
this.plugin.saveSettings();
});
});
// endregion
}
}

7
src/utils/MediaType.ts Normal file
View file

@ -0,0 +1,7 @@
export enum MediaType {
Movie = 'movie',
Series = 'series',
Game = 'game',
MusicRelease = 'musicRelease',
Wiki = 'wiki',
}

52
src/utils/MediaTypeManager.ts Normal file
View file

@ -0,0 +1,52 @@
import {MediaDbPluginSettings} from '../settings/Settings';
import {MediaType} from './MediaType';
import {MediaTypeModel} from '../models/MediaTypeModel';
import {replaceTags} from './Utils';
import {App, TFile} from 'obsidian';
export class MediaTypeManager {
mediaFileNameTemplateMap: Map<MediaType, string>;
mediaTemplateMap: Map<MediaType, string>;
constructor(settings: MediaDbPluginSettings) {
this.updateTemplates(settings);
}
updateTemplates(settings: MediaDbPluginSettings) {
this.mediaFileNameTemplateMap = new Map<MediaType, string>();
this.mediaFileNameTemplateMap.set(MediaType.Movie, settings.movieFileNameTemplate);
this.mediaFileNameTemplateMap.set(MediaType.Series, settings.seriesFileNameTemplate);
this.mediaFileNameTemplateMap.set(MediaType.Game, settings.gameFileNameTemplate);
this.mediaFileNameTemplateMap.set(MediaType.Wiki, settings.wikiFileNameTemplate);
this.mediaFileNameTemplateMap.set(MediaType.MusicRelease, settings.musicReleaseFileNameTemplate);
this.mediaTemplateMap = new Map<MediaType, string>();
this.mediaTemplateMap.set(MediaType.Movie, settings.movieTemplate);
this.mediaTemplateMap.set(MediaType.Series, settings.seriesTemplate);
this.mediaTemplateMap.set(MediaType.Game, settings.gameTemplate);
this.mediaTemplateMap.set(MediaType.Wiki, settings.wikiTemplate);
this.mediaTemplateMap.set(MediaType.MusicRelease, settings.musicReleaseTemplate);
}
getFileName(mediaTypeModel: MediaTypeModel): string {
return replaceTags(this.mediaFileNameTemplateMap.get(mediaTypeModel.getMediaType()), mediaTypeModel);
}
async getContent(mediaTypeModel: MediaTypeModel, app: App) {
const templateFileName = this.mediaTemplateMap.get(mediaTypeModel.getMediaType());
if (!templateFileName) {
return '';
}
const templateFile: TFile = app.vault.getFiles().filter((f: TFile) => f.name === templateFileName).first();
if (!templateFile) {
return '';
}
const template = await app.vault.cachedRead(templateFile);
// console.log(template);
return replaceTags(template, mediaTypeModel);
}
}

6
src/utils/Utils.ts
View file

@ -1,5 +1,4 @@
import {MediaTypeModel} from '../models/MediaTypeModel';
import {TFile} from 'obsidian';
export const pluginName: string = 'obsidian-media-db-plugin';
@ -8,7 +7,6 @@ export const mediaDbTag: string = 'mediaDB';
export const mediaDbVersion: string = '0.1.8';
export const debug: boolean = false;
export function wrapAround(value: number, size: number): number {
return ((value % size) + size) % size;
}
@ -86,7 +84,3 @@ function traverseMetaData(path: Array<string>, mediaTypeModel: MediaTypeModel):
return o;
}
export function updateNote(file: TFile) {
}