Skip to content

Commit

Permalink
adding suport for templated filenames
Browse files Browse the repository at this point in the history 
- adding template support for filenames
- File templates support the same tags as movie Notes do
  • Loading branch information
@Superschnizel
Superschnizel committed Nov 30, 2023
1 parent 80c36ce commit b822041
Show file tree
Hide file tree
Showing 3 changed files with 166 additions and 142 deletions.
162 changes: 23 additions & 139 deletions main.ts
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { App, Editor, MarkdownView, Modal, Menu, Notice, Plugin, PluginSettingTab, Setting, requestUrl, normalizePath, WorkspaceLeaf, TFile, TAbstractFile } from 'obsidian';

import {MoviegrabberSettings, DEFAULT_SETTINGS, DEFAULT_TEMPLATE} from "./src/MoviegrabberSettings"
import {MoviegrabberSettings, DEFAULT_SETTINGS, DEFAULT_TEMPLATE, MoviegrabberSettingTab} from "./src/MoviegrabberSettings"
import {MoviegrabberSearchModal} from "./src/MoviegrabberSearchModal"
import {MOVIE_DATA_LOWER, MovieData, MovieRating, MovieSearch, MovieSearchItem, Rating, TEST_SEARCH} from "./src/MoviegrabberSearchObject"
import { MoviegrabberSelectionModal } from 'src/MoviegrabberSelectionModal';
Expand Down Expand Up @@ -209,49 +209,53 @@ export default class Moviegrabber extends Plugin {

async tryCreateNote(item : MovieSearchItem | MovieData, type : 'movie' | 'series') {
// create path and check for directory before posting the request
// Transform Search into MovieData
var itemData = ('Response' in item ) ? item as MovieData : await this.getOmdbData(item);

if (itemData == null || itemData == undefined){
var n = new Notice(`something went wrong in fetching ${item.Title} data`)
n.noticeEl.addClass("notice_error")
return;
}


var dir = type == 'movie' ? this.settings.MovieDirectory : this.settings.SeriesDirectory;

dir = this.CleanPath(dir);
dir = dir != '' ? `${dir}/` : ''; // this might be unecessary.

if (!(await this.app.vault.adapter.exists(dir))) {
var n = new Notice(`Folder for ${type}: ${dir} does not exist!`)
var n = new Notice(`Folder for ${type}: "${dir}" does not exist!`)
n.noticeEl.addClass("notice_error")
return;
}

let path = `${dir}${item.Title.replace(/[/\\?%*:|"<>]/g, '')}.md`
let title = await this.FillTemplate(this.settings.FilenameTemplate, itemData);
title = title == '' ? item.Title : title;

let path = `${dir}${title.replace(/[/\\?%*:|"<>]/g, '')}.md`
let file = this.app.vault.getAbstractFileByPath(path);

// console.log(`${file}, path: ${path}`);
if (file != null && file instanceof TFile) {
new ConfirmOverwriteModal(this.app, item, () => {
this.createNote(item, type, path, file as TFile);
this.createNote(itemData!, type, path, file as TFile);
}).open();
return;
}

this.createNote(item, type, path);
this.createNote(itemData, type, path);
}

async createNote(item : MovieSearchItem | MovieData, type : 'movie' | 'series', path : string, tFile : TFile | null=null) {

var itemData = ('Response' in item ) ? item : await this.getOmdbData(item);

if (itemData == null){
var n = new Notice(`something went wrong in fetching ${item.Title} data`)
n.noticeEl.addClass("notice_error")
return;
}

async createNote(item : MovieData, type : 'movie' | 'series', path : string, tFile : TFile | null=null) {

new Notice(`Creating Note for: ${item.Title} (${item.Year})`);

// add and clean up data
itemData.Title = itemData.Title.replace(/[/\\?%*:|"<>]/g, ''); // clean Movie Title to avoid frontmatter issues
itemData.Runtime = itemData.Runtime ? itemData.Runtime.split(" ")[0] : '';
item.Title = item.Title.replace(/[/\\?%*:|"<>]/g, ''); // clean Movie Title to avoid frontmatter issues
item.Runtime = item.Runtime ? item.Runtime.split(" ")[0] : '';
if (this.settings.YouTube_API_Key != '') {
itemData.YoutubeEmbed = await this.getTrailerEmbed(itemData.Title, itemData.Year);
item.YoutubeEmbed = await this.getTrailerEmbed(item.Title, item.Year);
}

// get and fill template
Expand All @@ -260,7 +264,7 @@ export default class Moviegrabber extends Plugin {
if (template == null) {
return;
}
var content = await this.FillTemplate(template, itemData);
var content = await this.FillTemplate(template, item);

/* var content =
`---\n`+
Expand Down Expand Up @@ -442,124 +446,4 @@ export default class Moviegrabber extends Plugin {
}
}

class MoviegrabberSettingTab extends PluginSettingTab {
plugin: Moviegrabber;

constructor(app: App, plugin: Moviegrabber) {
super(app, plugin);
this.plugin = plugin;
}

display(): void {
const {containerEl} = this;

containerEl.empty();

new Setting(containerEl)
.setName('Movie folder')
.setDesc('Folder in which to save the generated notes for series')
.addSearch((cb) => {
new FolderSuggest(cb.inputEl, this.plugin.app);
cb.setPlaceholder("Example: folder1/folder2")
.setValue(this.plugin.settings.MovieDirectory)
.onChange(async (newFolder) => {
this.plugin.settings.MovieDirectory = newFolder;
await this.plugin.saveSettings();
});
});


new Setting(containerEl)
.setName('Series folder')
.setDesc('Folder in which to save the generated notes for series')
.addSearch((cb) => {
new FolderSuggest(cb.inputEl, this.plugin.app);
cb.setPlaceholder("Example: folder1/folder2")
.setValue(this.plugin.settings.SeriesDirectory)
.onChange(async (newFolder) => {
this.plugin.settings.SeriesDirectory = newFolder;
await this.plugin.saveSettings();
});
});

new Setting(containerEl)
.setName('OMDb API key')
.setDesc('Your API key for OMDb')
.addText(text => text
.setPlaceholder('')
.setValue(this.plugin.settings.OMDb_API_Key)
.onChange(async (value) => {
this.plugin.settings.OMDb_API_Key = value;
await this.plugin.saveSettings();
}));

new Setting(containerEl)
.setName('Youtube API key')
.setDesc('Your API key for Youtube (optional)')
.addText(text => text
.setPlaceholder('')
.setValue(this.plugin.settings.YouTube_API_Key)
.onChange(async (value) => {
this.plugin.settings.YouTube_API_Key = value;
await this.plugin.saveSettings();
}));

new Setting(containerEl)
.setName('Plot length')
.setDesc('choose the plot length option for Omdb.')
.addDropdown(dropDown => dropDown
.addOption('short', 'short')
.addOption('full', 'full')
.setValue(this.plugin.settings.PlotLength)
.onChange(async (value) => {
this.plugin.settings.PlotLength = value;
await this.plugin.saveSettings();
}))

new Setting(containerEl)
.setName('Switch to generated notes')
.setDesc('Automatically switch to the current workspace to the newly created note')
.addToggle(toggle => toggle
.setValue(this.plugin.settings.SwitchToCreatedNote)
.onChange(async (value) => {
this.plugin.settings.SwitchToCreatedNote = value;
await this.plugin.saveSettings();
}));

containerEl.createEl('h1', { text : "Templates"})
new Setting(containerEl)
.setName('Movie template file path')
.setDesc('Path to the template file that is used to create notes for movies')
.addSearch((cb) => {
new FileSuggest(cb.inputEl, this.plugin.app);
cb.setPlaceholder("Example: folder1/folder2")
.setValue(this.plugin.settings.MovieTemplatePath)
.onChange(async (newFile) => {
this.plugin.settings.MovieTemplatePath = newFile;
await this.plugin.saveSettings();
});
});

new Setting(containerEl)
.setName('Series template file path')
.setDesc('Path to the template file that is used to create notes for series')
.addSearch((cb) => {
new FileSuggest(cb.inputEl, this.plugin.app);
cb.setPlaceholder("Example: folder1/folder2")
.setValue(this.plugin.settings.SeriesTemplatePath)
.onChange(async (newFile) => {
this.plugin.settings.SeriesTemplatePath = newFile;
await this.plugin.saveSettings();
});
});

new Setting(containerEl)
.setName('Create example template file')
.setDesc('Creates an example template file to expand and use.\nThe file is called `/Moviegrabber-example-template`')
.addButton(btn => btn
.setButtonText("Create")
.onClick((event) => {
this.plugin.CreateDefaultTemplateFile();
}));
}
}
2 changes: 1 addition & 1 deletion manifest.json
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"id": "moviegrabber",
"name": "Moviegrabber",
"version": "1.1.11",
"version": "1.1.12",
"minAppVersion": "0.15.0",
"description": "Grab movie data from public APIs and transform it into notes that can be used with dataview and properties",
"author": "Superschnizel",
Expand Down
144 changes: 142 additions & 2 deletions src/MoviegrabberSettings.ts
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
import Moviegrabber from "main";
import { PluginSettingTab, App, Setting } from "obsidian";
import { FileSuggest } from "./interface/FileSuggester";
import { FolderSuggest } from "./interface/FolderSuggester";

export interface MoviegrabberSettings {
MovieDirectory: string;
SeriesDirectory: string;
Expand All @@ -9,6 +14,7 @@ export interface MoviegrabberSettings {
SeriesTemplatePath: string;

PlotLength: string;
FilenameTemplate: string;
}

export const DEFAULT_SETTINGS: MoviegrabberSettings = {
Expand All @@ -19,7 +25,8 @@ export const DEFAULT_SETTINGS: MoviegrabberSettings = {
SwitchToCreatedNote: true,
MovieTemplatePath: '',
SeriesTemplatePath: '',
PlotLength: 'short'
PlotLength: 'short',
FilenameTemplate: '{{Title}}'
}

export const DEFAULT_TEMPLATE: string = "---\n"+
Expand All @@ -38,4 +45,137 @@ export const DEFAULT_TEMPLATE: string = "---\n"+
`poster: "{{Poster}}"\n`+
`availability:\n`+
`---\n`+
`{{Plot}}`
`{{Plot}}`;

export class MoviegrabberSettingTab extends PluginSettingTab {
plugin: Moviegrabber;

constructor(app: App, plugin: Moviegrabber) {
super(app, plugin);
this.plugin = plugin;
}

display(): void {
const {containerEl} = this;

containerEl.empty();

new Setting(containerEl)
.setName('Movie folder')
.setDesc('Folder in which to save the generated notes for series')
.addSearch((cb) => {
new FolderSuggest(cb.inputEl, this.plugin.app);
cb.setPlaceholder("Example: folder1/folder2")
.setValue(this.plugin.settings.MovieDirectory)
.onChange(async (newFolder) => {
this.plugin.settings.MovieDirectory = newFolder;
await this.plugin.saveSettings();
});
});


new Setting(containerEl)
.setName('Series folder')
.setDesc('Folder in which to save the generated notes for series')
.addSearch((cb) => {
new FolderSuggest(cb.inputEl, this.plugin.app);
cb.setPlaceholder("Example: folder1/folder2")
.setValue(this.plugin.settings.SeriesDirectory)
.onChange(async (newFolder) => {
this.plugin.settings.SeriesDirectory = newFolder;
await this.plugin.saveSettings();
});
});

new Setting(containerEl)
.setName('OMDb API key')
.setDesc('Your API key for OMDb')
.addText(text => text
.setPlaceholder('')
.setValue(this.plugin.settings.OMDb_API_Key)
.onChange(async (value) => {
this.plugin.settings.OMDb_API_Key = value;
await this.plugin.saveSettings();
}));

new Setting(containerEl)
.setName('Youtube API key')
.setDesc('Your API key for Youtube (optional)')
.addText(text => text
.setPlaceholder('')
.setValue(this.plugin.settings.YouTube_API_Key)
.onChange(async (value) => {
this.plugin.settings.YouTube_API_Key = value;
await this.plugin.saveSettings();
}));

new Setting(containerEl)
.setName('Plot length')
.setDesc('choose the plot length option for Omdb.')
.addDropdown(dropDown => dropDown
.addOption('short', 'short')
.addOption('full', 'full')
.setValue(this.plugin.settings.PlotLength)
.onChange(async (value) => {
this.plugin.settings.PlotLength = value;
await this.plugin.saveSettings();
}))

new Setting(containerEl)
.setName('Switch to generated notes')
.setDesc('Automatically switch to the current workspace to the newly created note')
.addToggle(toggle => toggle
.setValue(this.plugin.settings.SwitchToCreatedNote)
.onChange(async (value) => {
this.plugin.settings.SwitchToCreatedNote = value;
await this.plugin.saveSettings();
}));

containerEl.createEl('h1', { text : "Templates"})
new Setting(containerEl)
.setName('Movie template file path')
.setDesc('Path to the template file that is used to create notes for movies')
.addSearch((cb) => {
new FileSuggest(cb.inputEl, this.plugin.app);
cb.setPlaceholder("Example: folder1/folder2")
.setValue(this.plugin.settings.MovieTemplatePath)
.onChange(async (newFile) => {
this.plugin.settings.MovieTemplatePath = newFile;
await this.plugin.saveSettings();
});
});

new Setting(containerEl)
.setName('Series template file path')
.setDesc('Path to the template file that is used to create notes for series')
.addSearch((cb) => {
new FileSuggest(cb.inputEl, this.plugin.app);
cb.setPlaceholder("Example: folder1/folder2")
.setValue(this.plugin.settings.SeriesTemplatePath)
.onChange(async (newFile) => {
this.plugin.settings.SeriesTemplatePath = newFile;
await this.plugin.saveSettings();
});
});

new Setting(containerEl)
.setName('Create example template file')
.setDesc('Creates an example template file to expand and use.\nThe file is called `/Moviegrabber-example-template`')
.addButton(btn => btn
.setButtonText("Create")
.onClick((event) => {
this.plugin.CreateDefaultTemplateFile();
}));

new Setting(containerEl)
.setName('Filename Template')
.setDesc('Template used for the filename of Movienotes. Used same template tags as other files.')
.addText(text => text
.setPlaceholder('')
.setValue(this.plugin.settings.FilenameTemplate)
.onChange(async (value) => {
this.plugin.settings.FilenameTemplate = value;
await this.plugin.saveSettings();
}));
}
}

0 comments on commit b822041

Please sign in to comment.