Trilium/src/services/special_notes.js

const attributeService = require("./attributes");
const dateNoteService = require("./date_notes");
const becca = require("../becca/becca");
const noteService = require("./notes");
const cls = require("./cls");
const dateUtils = require("./date_utils");

const LBTPL_ROOT = "lbtpl_root";
const LBTPL_BASE = "lbtpl_base";
const LBTPL_COMMAND = "lbtpl_command";
const LBTPL_NOTE_LAUNCHER = "lbtpl_notelauncher";
const LBTPL_SCRIPT = "lbtpl_script";
const LBTPL_BUILTIN_WIDGET = "lbtpl_builtinwidget";
const LBTPL_SPACER = "lbtpl_spacer";
const LBTPL_CUSTOM_WIDGET = "lbtpl_customwidget";

function getInboxNote(date) {
    const hoistedNote = getHoistedNote();

    let inbox;

    if (!hoistedNote.isRoot()) {
        inbox = hoistedNote.searchNoteInSubtree('#hoistedInbox');

        if (!inbox) {
            inbox = hoistedNote.searchNoteInSubtree('#inbox');
        }

        if (!inbox) {
            inbox = hoistedNote;
        }
    }
    else {
        inbox = attributeService.getNoteWithLabel('inbox')
            || dateNoteService.getDayNote(date);
    }

    return inbox;
}

function getHiddenRoot() {
    let hidden = becca.getNote('hidden');

    if (!hidden) {
        hidden = noteService.createNewNote({
            branchId: 'hidden',
            noteId: 'hidden',
            title: 'hidden',
            type: 'doc',
            content: '',
            parentNoteId: 'root'
        }).note;

        // isInheritable: false means that this notePath is automatically not preffered but at the same time
        // the flag is not inherited to the children
        hidden.addLabel('archived', "", false);
        hidden.addLabel('excludeFromNoteMap', "", true);
        hidden.addLabel('iconClass', "bx bx-chip", false);
    }

    if (!hidden.hasOwnedLabel("docName")) {
        hidden.addLabel("docName", "hidden");
    }

    const MAX_POS = 999_999_999;

    const branch = hidden.getBranches()[0];
    if (branch.notePosition !== MAX_POS) {
        // we want to keep the hidden subtree always last, otherwise there will be problems with e.g. keyboard navigation
        // over tree when it's in the middle
        branch.notePosition = MAX_POS;
        branch.save();
    }

    return hidden;
}

function getSearchRoot() {
    let searchRoot = becca.getNote('search');

    if (!searchRoot) {
        searchRoot = noteService.createNewNote({
            branchId: 'search',
            noteId: 'search',
            title: 'search',
            type: 'doc',
            content: '',
            parentNoteId: getHiddenRoot().noteId
        }).note;
    }

    return searchRoot;
}

function getGlobalNoteMap() {
    let globalNoteMap = becca.getNote('globalnotemap');

    if (!globalNoteMap) {
        globalNoteMap = noteService.createNewNote({
            branchId: 'globalnotemap',
            noteId: 'globalnotemap',
            title: 'Global Note Map',
            type: 'note-map',
            content: '',
            parentNoteId: getHiddenRoot().noteId
        }).note;

        globalNoteMap.addLabel('mapRootNoteId', 'hoisted');
    }

    return globalNoteMap;
}

function getSqlConsoleRoot() {
    let sqlConsoleRoot = becca.getNote('sqlconsole');

    if (!sqlConsoleRoot) {
        sqlConsoleRoot = noteService.createNewNote({
            branchId: 'sqlconsole',
            noteId: 'sqlconsole',
            title: 'SQL Console',
            type: 'doc',
            content: '',
            parentNoteId: getHiddenRoot().noteId
        }).note;

        sqlConsoleRoot.addLabel('iconClass', 'bx bx-data');
    }

    return sqlConsoleRoot;
}

function createSqlConsole() {
    const {note} = noteService.createNewNote({
        parentNoteId: getSqlConsoleRoot().noteId,
        title: 'SQL Console',
        content: "SELECT title, isDeleted, isProtected FROM notes WHERE noteId = ''\n\n\n\n",
        type: 'code',
        mime: 'text/x-sqlite;schema=trilium'
    });

    note.setLabel("sqlConsole", dateUtils.localNowDate());
    note.setLabel('iconClass', 'bx bx-data');

    return note;
}

function saveSqlConsole(sqlConsoleNoteId) {
    const sqlConsoleNote = becca.getNote(sqlConsoleNoteId);
    const today = dateUtils.localNowDate();

    const sqlConsoleHome =
        attributeService.getNoteWithLabel('sqlConsoleHome')
        || dateNoteService.getDayNote(today);

    const result = sqlConsoleNote.cloneTo(sqlConsoleHome.noteId);

    for (const parentBranch of sqlConsoleNote.getParentBranches()) {
        if (parentBranch.parentNote.hasAncestor("hidden")) {
            parentBranch.markAsDeleted();
        }
    }

    return result;
}

function createSearchNote(searchString, ancestorNoteId) {
    const {note} = noteService.createNewNote({
        parentNoteId: getSearchRoot().noteId,
        title: 'Search: ' + searchString,
        content: "",
        type: 'search',
        mime: 'application/json'
    });

    note.setLabel('searchString', searchString);

    if (ancestorNoteId) {
        note.setRelation('ancestor', ancestorNoteId);
    }

    return note;
}

function getSearchHome() {
    const hoistedNote = getHoistedNote();

    if (!hoistedNote.isRoot()) {
        return hoistedNote.searchNoteInSubtree('#hoistedSearchHome')
            || hoistedNote.searchNoteInSubtree('#searchHome')
            || hoistedNote;
    } else {
        const today = dateUtils.localNowDate();

        return hoistedNote.searchNoteInSubtree('#searchHome')
            || dateNoteService.getDayNote(today);
    }
}

function saveSearchNote(searchNoteId) {
    const searchNote = becca.getNote(searchNoteId);
    const searchHome = getSearchHome();

    const result = searchNote.cloneTo(searchHome.noteId);

    for (const parentBranch of searchNote.getParentBranches()) {
        if (parentBranch.parentNote.hasAncestor("hidden")) {
            parentBranch.markAsDeleted();
        }
    }

    return result;
}

function getHoistedNote() {
    return becca.getNote(cls.getHoistedNoteId());
}

function getShareRoot() {
    let shareRoot = becca.getNote('share');

    if (!shareRoot) {
        const hiddenRoot = getHiddenRoot();

        shareRoot = noteService.createNewNote({
            branchId: 'share',
            noteId: 'share',
            title: 'Shared notes',
            type: 'doc',
            content: '',
            parentNoteId: hiddenRoot.noteId
        }).note;
    }

    if (!shareRoot.hasOwnedLabel("docName")) {
        shareRoot.addLabel("docName", "share");
    }

    return shareRoot;
}

function getBulkActionNote() {
    let bulkActionNote = becca.getNote('bulkaction');

    if (!bulkActionNote) {
        bulkActionNote = noteService.createNewNote({
            branchId: 'bulkaction',
            noteId: 'bulkaction',
            title: 'Bulk action',
            type: 'text',
            content: '',
            parentNoteId: getHiddenRoot().noteId
        }).note;
    }

    return bulkActionNote;
}

function getLaunchBarRoot() {
    let note = becca.getNote('lb_root');

    if (!note) {
        note = noteService.createNewNote({
            branchId: 'lb_root',
            noteId: 'lb_root',
            title: 'Launch bar',
            type: 'doc',
            content: '',
            parentNoteId: getHiddenRoot().noteId
        }).note;

        note.addLabel("iconClass", "bx bx-sidebar");
        note.addLabel("docName", "launchbar_intro");
    }

    return note;
}

function getLaunchBarAvailableLaunchersRoot() {
    let note = becca.getNote('lb_availablelaunchers');

    if (!note) {
        note = noteService.createNewNote({
            branchId: 'lb_availablelaunchers',
            noteId: 'lb_availablelaunchers',
            title: 'Available launchers',
            type: 'doc',
            content: '',
            parentNoteId: getLaunchBarRoot().noteId,
            ignoreForbiddenParents: true
        }).note;

        note.addLabel("iconClass", "bx bx-hide");
        note.addLabel("docName", "launchbar_intro");
    }

    const branch = becca.getBranch('lb_availablelaunchers');
    if (!branch.isExpanded) {
        branch.isExpanded = true;
        branch.save();
    }

    return note;
}

function getLaunchBarVisibleLaunchersRoot() {
    let note = becca.getNote('lb_visiblelaunchers');

    if (!note) {
        note = noteService.createNewNote({
            branchId: 'lb_visiblelaunchers',
            noteId: 'lb_visiblelaunchers',
            title: 'Visible launchers',
            type: 'doc',
            content: '',
            parentNoteId: getLaunchBarRoot().noteId,
            ignoreForbiddenParents: true
        }).note;

        note.addLabel("iconClass", "bx bx-show");
        note.addLabel("docName", "launchbar_intro");
    }

    const branch = becca.getBranch('lb_visiblelaunchers');
    if (!branch.isExpanded) {
        branch.isExpanded = true;
        branch.save();
    }

    return note;
}

const launchers = [
    // visible launchers:
    { id: 'lb_newnote', command: 'createNoteIntoInbox', title: 'New note', icon: 'bx bx-file-blank', isVisible: true },
    { id: 'lb_search', command: 'searchNotes', title: 'Search notes', icon: 'bx bx-search', isVisible: true },
    { id: 'lb_jumpto', command: 'jumpToNote', title: 'Jump to note', icon: 'bx bx-send', isVisible: true },
    { id: 'lb_notemap', targetNoteId: 'globalnotemap', title: 'Note map', icon: 'bx bx-map-alt', isVisible: true },
    { id: 'lb_calendar', builtinWidget: 'calendar', title: 'Calendar', icon: 'bx bx-calendar', isVisible: true },
    { id: 'lb_spacer1', builtinWidget: 'spacer', title: 'Spacer', isVisible: true, baseSize: 50, growthFactor: 0 },
    { id: 'lb_bookmarks', builtinWidget: 'bookmarks', title: 'Bookmarks', icon: 'bx bx-bookmark', isVisible: true },
    { id: 'lb_spacer2', builtinWidget: 'spacer', title: 'Spacer', isVisible: true, baseSize: 0, growthFactor: 1 },
    { id: 'lb_protectedsession', builtinWidget: 'protectedSession', title: 'Protected session', icon: 'bx bx bx-shield-quarter', isVisible: true },
    { id: 'lb_syncstatus', builtinWidget: 'syncStatus', title: 'Sync status', icon: 'bx bx-wifi', isVisible: true },

    // available launchers:
    { id: 'lb_recentchanges', command: 'showRecentChanges', title: 'Recent changes', icon: 'bx bx-history', isVisible: false },
    { id: 'lb_backinhistory', builtinWidget: 'backInHistoryButton', title: 'Back in history', icon: 'bx bxs-left-arrow-square', isVisible: false },
    { id: 'lb_forwardinhistory', builtinWidget: 'forwardInHistoryButton', title: 'Forward in history', icon: 'bx bxs-right-arrow-square', isVisible: false },
];

function createMissingSpecialNotes() {
    getSqlConsoleRoot();
    getGlobalNoteMap();
    getBulkActionNote();
    createLauncherTemplates();
    getLaunchBarRoot();
    getLaunchBarAvailableLaunchersRoot();
    getLaunchBarVisibleLaunchersRoot();
    getShareRoot();

    for (const launcher of launchers) {
        let note = becca.getNote(launcher.id);

        if (note) {
            continue;
        }

        const parentNoteId = launcher.isVisible
            ? getLaunchBarVisibleLaunchersRoot().noteId
            : getLaunchBarAvailableLaunchersRoot().noteId;

        note = noteService.createNewNote({
            noteId: launcher.id,
            title: launcher.title,
            type: 'launcher',
            content: '',
            parentNoteId: parentNoteId
        }).note;

        if (launcher.icon) {
            note.addLabel('iconClass', launcher.icon);
        }

        if (launcher.command) {
            note.addRelation('template', LBTPL_COMMAND);
            note.addLabel('command', launcher.command);
        } else if (launcher.builtinWidget) {
            if (launcher.builtinWidget === 'spacer') {
                note.addRelation('template', LBTPL_SPACER);
                note.addLabel("baseSize", launcher.baseSize);
                note.addLabel("growthFactor", launcher.growthFactor);
            } else {
                note.addRelation('template', LBTPL_BUILTIN_WIDGET);
            }

            note.addLabel('builtinWidget', launcher.builtinWidget);
        } else if (launcher.targetNoteId) {
            note.addRelation('template', LBTPL_NOTE_LAUNCHER);
            note.addRelation('targetNote', launcher.targetNoteId);
        } else {
            throw new Error(`No action defined for launcher ${JSON.stringify(launcher)}`);
        }
    }

    // share root is not automatically created since it's visible in the tree and many won't need it/use it

    const hidden = getHiddenRoot();

    if (!hidden.hasOwnedLabel('excludeFromNoteMap')) {
        hidden.addLabel('excludeFromNoteMap', "", true);
    }
}

function createLauncher(parentNoteId, launcherType) {
    let note;

    if (launcherType === 'note') {
        note = noteService.createNewNote({
            title: "Note launcher",
            type: 'launcher',
            content: '',
            parentNoteId: parentNoteId
        }).note;

        note.addRelation('template', LBTPL_NOTE_LAUNCHER);
    } else if (launcherType === 'script') {
        note = noteService.createNewNote({
            title: "Script launcher",
            type: 'launcher',
            content: '',
            parentNoteId: parentNoteId
        }).note;

        note.addRelation('template', LBTPL_SCRIPT);
    } else if (launcherType === 'customWidget') {
        note = noteService.createNewNote({
            title: "Widget launcher",
            type: 'launcher',
            content: '',
            parentNoteId: parentNoteId
        }).note;

        note.addRelation('template', LBTPL_CUSTOM_WIDGET);
    } else if (launcherType === 'spacer') {
        note = noteService.createNewNote({
            title: "Spacer",
            type: 'launcher',
            content: '',
            parentNoteId: parentNoteId
        }).note;

        note.addRelation('template', LBTPL_SPACER);
    } else {
        throw new Error(`Unrecognized launcher type ${launcherType}`);
    }

    return {
        success: true,
        note
    };
}

function createLauncherTemplates() {
    if (!(LBTPL_ROOT in becca.notes)) {
        noteService.createNewNote({
            branchId: LBTPL_ROOT,
            noteId: LBTPL_ROOT,
            title: 'Launch bar templates',
            type: 'doc',
            content: '',
            parentNoteId: getHiddenRoot().noteId
        });
    }

    if (!(LBTPL_BASE in becca.notes)) {
        const tpl = noteService.createNewNote({
            branchId: LBTPL_BASE,
            noteId: LBTPL_BASE,
            title: 'Launch bar base launcher',
            type: 'doc',
            content: '',
            parentNoteId: getHiddenRoot().noteId
        }).note;

        tpl.addLabel('label:keyboardLauncher', 'promoted,text');
    }

    if (!(LBTPL_COMMAND in becca.notes)) {
        const tpl = noteService.createNewNote({
            branchId: LBTPL_COMMAND,
            noteId: LBTPL_COMMAND,
            title: 'Command launcher',
            type: 'doc',
            content: '',
            parentNoteId: LBTPL_ROOT
        }).note;

        tpl.addRelation('template', LBTPL_BASE);
        tpl.addLabel('launcherType', 'command');
    }

    if (!(LBTPL_NOTE_LAUNCHER in becca.notes)) {
        const tpl = noteService.createNewNote({
            branchId: LBTPL_NOTE_LAUNCHER,
            noteId: LBTPL_NOTE_LAUNCHER,
            title: 'Note launcher',
            type: 'doc',
            content: '',
            parentNoteId: LBTPL_ROOT
        }).note;

        tpl.addRelation('template', LBTPL_BASE);
        tpl.addLabel('launcherType', 'note');
        tpl.addLabel('relation:targetNote', 'promoted');
        tpl.addLabel('docName', 'launchbar_note_launcher');
    }

    if (!(LBTPL_SCRIPT in becca.notes)) {
        const tpl = noteService.createNewNote({
            branchId: LBTPL_SCRIPT,
            noteId: LBTPL_SCRIPT,
            title: 'Script',
            type: 'doc',
            content: '',
            parentNoteId: LBTPL_ROOT
        }).note;

        tpl.addRelation('template', LBTPL_BASE);
        tpl.addLabel('launcherType', 'script');
        tpl.addLabel('relation:script', 'promoted');
        tpl.addLabel('docName', 'launchbar_script_launcher');
    }

    if (!(LBTPL_BUILTIN_WIDGET in becca.notes)) {
        const tpl = noteService.createNewNote({
            branchId: LBTPL_BUILTIN_WIDGET,
            noteId: LBTPL_BUILTIN_WIDGET,
            title: 'Builtin widget',
            type: 'doc',
            content: '',
            parentNoteId: LBTPL_ROOT
        }).note;

        tpl.addRelation('template', LBTPL_BASE);
        tpl.addLabel('launcherType', 'builtinWidget');
    }

    if (!(LBTPL_SPACER in becca.notes)) {
        const tpl = noteService.createNewNote({
            branchId: LBTPL_SPACER,
            noteId: LBTPL_SPACER,
            title: 'Spacer',
            type: 'doc',
            content: '',
            parentNoteId: LBTPL_ROOT
        }).note;

        tpl.addRelation('template', LBTPL_BUILTIN_WIDGET);
        tpl.addLabel('builtinWidget', 'spacer');
        tpl.addLabel('iconClass', 'bx bx-move-vertical');
        tpl.addLabel('label:baseSize', 'promoted,number');
        tpl.addLabel('label:growthFactor', 'promoted,number');
        tpl.addLabel('docName', 'launchbar_spacer');
    }

    if (!(LBTPL_CUSTOM_WIDGET in becca.notes)) {
        const tpl = noteService.createNewNote({
            branchId: LBTPL_CUSTOM_WIDGET,
            noteId: LBTPL_CUSTOM_WIDGET,
            title: 'Custom widget',
            type: 'doc',
            content: '',
            parentNoteId: LBTPL_ROOT
        }).note;

        tpl.addRelation('template', LBTPL_BASE);
        tpl.addLabel('launcherType', 'customWidget');
        tpl.addLabel('relation:widget', 'promoted');
        tpl.addLabel('docName', 'launchbar_widget_launcher');
    }
}

function resetLauncher(noteId) {
    if (noteId.startsWith('lb_')) {
        const note = becca.getNote(noteId);

        if (note) {
            if (noteId === 'lb_root') {
                // deleting hoisted notes are not allowed, so we just reset the children
                for (const childNote of note.getChildNotes()) {
                    childNote.deleteNote();
                }
            } else {
                note.deleteNote();
            }
        } else {
            log.info(`Note ${noteId} has not been found and cannot be reset.`);
        }
    } else {
        log.info(`Note ${noteId} is not a resettable launcher note.`);
    }

    createMissingSpecialNotes();
}

module.exports = {
    getInboxNote,
    createSqlConsole,
    saveSqlConsole,
    createSearchNote,
    saveSearchNote,
    createMissingSpecialNotes,
    getShareRoot,
    getHiddenRoot,
    getBulkActionNote,
    createLauncher,
    resetLauncher
};