Skip to content

fix: validate default template still has template tag before using it #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sh1vam31 wants to merge 1 commit into
base: master
Choose a base branch
from
+55 −12
Open

fix: validate default template still has template tag before using it #134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 27 additions & 7 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import { CommandsPanel } from "./views/commandsPanel";
const DOCUMENTATION_URL = "https://github.com/joplin/plugin-templates#readme";

joplin.plugins.register({
onStart: async function() {
onStart: async function () {
// Register setting section
await PluginSettingsRegistry.registerSettings();

Expand Down Expand Up @@ -199,22 +199,32 @@ joplin.plugins.register({
label: "Create note from default template",
execute: async () => {
let defaultTemplate: Note | null = null;
let defaultTemplateIdWasSet = false;

const defaultTemplatesConfig = await DefaultTemplatesConfigSetting.get();
const currentFolderId = await getSelectedFolder();

if (currentFolderId in defaultTemplatesConfig) {
defaultTemplate = await getTemplateFromId(defaultTemplatesConfig[currentFolderId].defaultNoteTemplateId);
const notebookDefaultId = defaultTemplatesConfig[currentFolderId].defaultNoteTemplateId;
if (notebookDefaultId) defaultTemplateIdWasSet = true;
defaultTemplate = await getTemplateFromId(notebookDefaultId);
}

if (defaultTemplate === null) {
defaultTemplate = await getTemplateFromId(await DefaultNoteTemplateIdSetting.get());
const globalDefaultId = await DefaultNoteTemplateIdSetting.get();
if (globalDefaultId) defaultTemplateIdWasSet = true;
defaultTemplate = await getTemplateFromId(globalDefaultId);
}

if (defaultTemplate) {
return await performActionWithParsedTemplate(TemplateAction.NewNote, defaultTemplate);
}
await joplin.views.dialogs.showMessageBox("No default note template is set.");

if (defaultTemplateIdWasSet) {
await joplin.views.dialogs.showMessageBox("The note set as the default template is no longer a template. Please set a new default template via Tools \u2192 Templates \u2192 Default templates.");
} else {
await joplin.views.dialogs.showMessageBox("No default note template is set.");
}
}
}));

Expand All @@ -223,22 +233,32 @@ joplin.plugins.register({
label: "Create to-do from default template",
execute: async () => {
let defaultTemplate: Note | null = null;
let defaultTemplateIdWasSet = false;

const defaultTemplatesConfig = await DefaultTemplatesConfigSetting.get();
const currentFolderId = await getSelectedFolder();

if (currentFolderId in defaultTemplatesConfig) {
defaultTemplate = await getTemplateFromId(defaultTemplatesConfig[currentFolderId].defaultTodoTemplateId);
const notebookDefaultId = defaultTemplatesConfig[currentFolderId].defaultTodoTemplateId;
if (notebookDefaultId) defaultTemplateIdWasSet = true;
defaultTemplate = await getTemplateFromId(notebookDefaultId);
}

if (defaultTemplate === null) {
defaultTemplate = await getTemplateFromId(await DefaultTodoTemplateIdSetting.get());
const globalDefaultId = await DefaultTodoTemplateIdSetting.get();
if (globalDefaultId) defaultTemplateIdWasSet = true;
defaultTemplate = await getTemplateFromId(globalDefaultId);
}

if (defaultTemplate) {
return await performActionWithParsedTemplate(TemplateAction.NewTodo, defaultTemplate);
}
await joplin.views.dialogs.showMessageBox("No default to-do template is set.");

if (defaultTemplateIdWasSet) {
await joplin.views.dialogs.showMessageBox("The note set as the default template is no longer a template. Please set a new default template via Tools \u2192 Templates \u2192 Default templates.");
} else {
await joplin.views.dialogs.showMessageBox("No default to-do template is set.");
}
}
}));

Expand Down
33 changes: 28 additions & 5 deletions src/utils/templates.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import { TemplatesSourceSetting, TemplatesSource } from "../settings/templatesSo
import { LocaleGlobalSetting } from "../settings/global";
import { encode, decode } from "html-entities";
import { AUTO_FOCUS_SCRIPT } from "./dialogHelpers";
import { fetchAllItems } from "./dataApi";

export interface Note {
id: string;
Expand Down Expand Up @@ -58,7 +59,7 @@ const getAllTemplates = async () => {
export async function getUserTemplateSelection(dialogHandle: string, property?: NoteProperty, promptLabel = "Template:"): Promise<string | null> {
try {
const templates = await getAllTemplates();

if (templates.length === 0) {
await joplin.views.dialogs.showMessageBox("No templates found! Please create a template and try again.");
return null;
Expand Down Expand Up @@ -97,29 +98,51 @@ export async function getUserTemplateSelection(dialogHandle: string, property?:
await joplin.views.dialogs.setFitToContent(dialogHandle, true);

const result = await joplin.views.dialogs.open(dialogHandle);

if (result.id === "cancel") {
return null;
}

// Get the template value and decode HTML entities
const templateValue = result.formData?.["templates-form"]?.template;
const decodedValue = templateValue ? decode(templateValue) : null;

return decodedValue;
} catch (error) {
console.error("Error in getUserTemplateSelection:", error);
return null;
}
}

/**
* Checks whether a given note still has the 'template' tag.
* Returns false if the note has no template tag or if the check fails.
*/
export const isNoteATemplate = async (noteId: string): Promise<boolean> => {
try {
const tags = await fetchAllItems(["notes", noteId, "tags"], { fields: ["id", "title"] });
return tags.some((tag: { title: string }) => tag.title === "template");
} catch (error) {
console.error("Error checking if note is a template", error);
return false;
}
};

export const getTemplateFromId = async (templateId: string | null): Promise<Note | null> => {
if (!templateId) {
return null;
}

try {
return await joplin.data.get([ "notes", templateId ], { fields: ["id", "title", "body"] });
const note = await joplin.data.get(["notes", templateId], { fields: ["id", "title", "body"] });

const stillATemplate = await isNoteATemplate(templateId);
if (!stillATemplate) {
console.warn(`Note "${note.title}" (id: ${templateId}) is set as a default template but no longer has the 'template' tag.`);
return null;
}

return note;
} catch (error) {
console.error("There was an error loading a template from id", error);
return null;
Expand Down