Trilium/src/services/options_init.ts

import optionService from "./options.js";
import type { OptionMap, OptionNames } from "./options_interface.js";
import appInfo from "./app_info.js";
import { randomSecureToken, isWindows } from "./utils.js";
import log from "./log.js";
import dateUtils from "./date_utils.js";
import keyboardActions from "./keyboard_actions.js";
import type { KeyboardShortcutWithRequiredActionName } from "./keyboard_actions_interface.js";

function initDocumentOptions() {
    optionService.createOption("documentId", randomSecureToken(16), false);
    optionService.createOption("documentSecret", randomSecureToken(16), false);
}

/**
 * Contains additional options to be initialized for a new database, containing the information entered by the user.
 */
interface NotSyncedOpts {
    syncServerHost?: string;
    syncProxy?: string;
}

/**
 * Represents a correspondence between an option and its default value, to be initialized when the database is missing that particular option (after a migration from an older version, or when creating a new database).
 */
interface DefaultOption {
    name: OptionNames;
    /**
     * The value to initialize the option with, if the option is not already present in the database.
     *
     * If a function is passed Gin instead, the function is called if the option does not exist (with access to the current options) and the return value is used instead. Useful to migrate a new option with a value depending on some other option that might be initialized.
     */
    value: string | ((options: OptionMap) => string);
    isSynced: boolean;
}

/**
 * Initializes the default options for new databases only.
 *
 * @param initialized `true` if the database has been fully initialized (i.e. a new database was created), or `false` if the database is created for sync.
 * @param opts additional options to be initialized, for example the sync configuration.
 */
async function initNotSyncedOptions(initialized: boolean, opts: NotSyncedOpts = {}) {
    optionService.createOption(
        "openNoteContexts",
        JSON.stringify([
            {
                notePath: "root",
                active: true
            }
        ]),
        false
    );

    optionService.createOption("lastDailyBackupDate", dateUtils.utcNowDateTime(), false);
    optionService.createOption("lastWeeklyBackupDate", dateUtils.utcNowDateTime(), false);
    optionService.createOption("lastMonthlyBackupDate", dateUtils.utcNowDateTime(), false);
    optionService.createOption("dbVersion", appInfo.dbVersion.toString(), false);

    optionService.createOption("initialized", initialized ? "true" : "false", false);

    optionService.createOption("lastSyncedPull", "0", false);
    optionService.createOption("lastSyncedPush", "0", false);

    optionService.createOption("theme", "next", false);
    optionService.createOption("textNoteEditorType", "ckeditor-classic", true);

    optionService.createOption("syncServerHost", opts.syncServerHost || "", false);
    optionService.createOption("syncServerTimeout", "120000", false);
    optionService.createOption("syncProxy", opts.syncProxy || "", false);
}

/**
 * Contains all the default options that must be initialized on new and existing databases (at startup). The value can also be determined based on other options, provided they have already been initialized.
 */
const defaultOptions: DefaultOption[] = [
    { name: "revisionSnapshotTimeInterval", value: "600", isSynced: true },
    { name: "revisionSnapshotNumberLimit", value: "-1", isSynced: true },
    { name: "protectedSessionTimeout", value: "600", isSynced: true },
    { name: "zoomFactor", value: isWindows ? "0.9" : "1.0", isSynced: false },
    { name: "overrideThemeFonts", value: "false", isSynced: false },
    { name: "mainFontFamily", value: "theme", isSynced: false },
    { name: "mainFontSize", value: "100", isSynced: false },
    { name: "treeFontFamily", value: "theme", isSynced: false },
    { name: "treeFontSize", value: "100", isSynced: false },
    { name: "detailFontFamily", value: "theme", isSynced: false },
    { name: "detailFontSize", value: "110", isSynced: false },
    { name: "monospaceFontFamily", value: "theme", isSynced: false },
    { name: "monospaceFontSize", value: "110", isSynced: false },
    { name: "spellCheckEnabled", value: "true", isSynced: false },
    { name: "spellCheckLanguageCode", value: "en-US", isSynced: false },
    { name: "imageMaxWidthHeight", value: "2000", isSynced: true },
    { name: "imageJpegQuality", value: "75", isSynced: true },
    { name: "autoFixConsistencyIssues", value: "true", isSynced: false },
    { name: "vimKeymapEnabled", value: "false", isSynced: false },
    { name: "codeLineWrapEnabled", value: "true", isSynced: false },
    {
        name: "codeNotesMimeTypes",
        value: '["text/x-csrc","text/x-c++src","text/x-csharp","text/css","text/x-go","text/x-groovy","text/x-haskell","text/html","message/http","text/x-java","application/javascript;env=frontend","application/javascript;env=backend","application/json","text/x-kotlin","text/x-markdown","text/x-perl","text/x-php","text/x-python","text/x-ruby",null,"text/x-sql","text/x-sqlite;schema=trilium","text/x-swift","text/xml","text/x-yaml","text/x-sh"]',
        isSynced: true
    },
    { name: "leftPaneWidth", value: "25", isSynced: false },
    { name: "leftPaneVisible", value: "true", isSynced: false },
    { name: "rightPaneWidth", value: "25", isSynced: false },
    { name: "rightPaneVisible", value: "true", isSynced: false },
    { name: "nativeTitleBarVisible", value: "false", isSynced: false },
    { name: "eraseEntitiesAfterTimeInSeconds", value: "604800", isSynced: true }, // default is 7 days
    { name: "eraseEntitiesAfterTimeScale", value: "86400", isSynced: true }, // default 86400 seconds = Day
    { name: "hideArchivedNotes_main", value: "false", isSynced: false },
    { name: "debugModeEnabled", value: "false", isSynced: false },
    { name: "headingStyle", value: "underline", isSynced: true },
    { name: "autoCollapseNoteTree", value: "true", isSynced: true },
    { name: "autoReadonlySizeText", value: "10000", isSynced: false },
    { name: "autoReadonlySizeCode", value: "30000", isSynced: false },
    { name: "dailyBackupEnabled", value: "true", isSynced: false },
    { name: "weeklyBackupEnabled", value: "true", isSynced: false },
    { name: "monthlyBackupEnabled", value: "true", isSynced: false },
    { name: "maxContentWidth", value: "1200", isSynced: false },
    { name: "compressImages", value: "true", isSynced: true },
    { name: "downloadImagesAutomatically", value: "true", isSynced: true },
    { name: "minTocHeadings", value: "5", isSynced: true },
    { name: "highlightsList", value: '["bold","italic","underline","color","bgColor"]', isSynced: true },
    { name: "checkForUpdates", value: "true", isSynced: true },
    { name: "disableTray", value: "false", isSynced: false },
    { name: "eraseUnusedAttachmentsAfterSeconds", value: "2592000", isSynced: true },
    { name: "customSearchEngineName", value: "DuckDuckGo", isSynced: true },
    { name: "customSearchEngineUrl", value: "https://duckduckgo.com/?q={keyword}", isSynced: true },
    { name: "promotedAttributesOpenInRibbon", value: "true", isSynced: true },
    { name: "editedNotesOpenInRibbon", value: "true", isSynced: true },

    // Internationalization
    { name: "locale", value: "en", isSynced: true },
    { name: "firstDayOfWeek", value: "1", isSynced: true },

    // Code block configuration
    {
        name: "codeBlockTheme",
        value: (optionsMap) => {
            if (optionsMap.theme === "light") {
                return "default:stackoverflow-light";
            } else {
                return "default:stackoverflow-dark";
            }
        },
        isSynced: false
    },
    { name: "codeBlockWordWrap", value: "false", isSynced: true },

    // Text note configuration
    { name: "textNoteEditorType", value: "ckeditor-balloon", isSynced: true },
    { name: "textNoteEditorMultilineToolbar", value: "false", isSynced: true },

    // HTML import configuration
    { name: "layoutOrientation", value: "vertical", isSynced: false },
    { name: "backgroundEffects", value: "false", isSynced: false },
    {
        name: "allowedHtmlTags",
        value: JSON.stringify([
            "h1",
            "h2",
            "h3",
            "h4",
            "h5",
            "h6",
            "blockquote",
            "p",
            "a",
            "ul",
            "ol",
            "li",
            "b",
            "i",
            "strong",
            "em",
            "strike",
            "s",
            "del",
            "abbr",
            "code",
            "hr",
            "br",
            "div",
            "table",
            "thead",
            "caption",
            "tbody",
            "tfoot",
            "tr",
            "th",
            "td",
            "pre",
            "section",
            "img",
            "figure",
            "figcaption",
            "span",
            "label",
            "input",
            "details",
            "summary",
            "address",
            "aside",
            "footer",
            "header",
            "hgroup",
            "main",
            "nav",
            "dl",
            "dt",
            "menu",
            "bdi",
            "bdo",
            "dfn",
            "kbd",
            "mark",
            "q",
            "time",
            "var",
            "wbr",
            "area",
            "map",
            "track",
            "video",
            "audio",
            "picture",
            "del",
            "ins",
            "en-media",
            "acronym",
            "article",
            "big",
            "button",
            "cite",
            "col",
            "colgroup",
            "data",
            "dd",
            "fieldset",
            "form",
            "legend",
            "meter",
            "noscript",
            "option",
            "progress",
            "rp",
            "samp",
            "small",
            "sub",
            "sup",
            "template",
            "textarea",
            "tt"
        ]),
        isSynced: true
    },

    // Share settings
    { name: 'redirectBareDomain', value: 'false', isSynced: true },
    { name: 'showLoginInShareTheme', value: 'false', isSynced: true }
];

/**
 * Initializes the options, by checking which options from {@link #allDefaultOptions()} are missing and registering them. It will also check some environment variables such as safe mode, to make any necessary adjustments.
 *
 * This method is called regardless of whether a new database is created, or an existing database is used.
 */
function initStartupOptions() {
    const optionsMap = optionService.getOptionMap();

    const allDefaultOptions = defaultOptions.concat(getKeyboardDefaultOptions());

    for (const { name, value, isSynced } of allDefaultOptions) {
        if (!(name in optionsMap)) {
            let resolvedValue;
            if (typeof value === "function") {
                resolvedValue = value(optionsMap);
            } else {
                resolvedValue = value;
            }

            optionService.createOption(name, resolvedValue, isSynced);
            log.info(`Created option "${name}" with default value "${resolvedValue}"`);
        }
    }

    if (process.env.TRILIUM_START_NOTE_ID || process.env.TRILIUM_SAFE_MODE) {
        optionService.setOption(
            "openNoteContexts",
            JSON.stringify([
                {
                    notePath: process.env.TRILIUM_START_NOTE_ID || "root",
                    active: true
                }
            ])
        );
    }
}

function getKeyboardDefaultOptions() {
    return (keyboardActions.getDefaultKeyboardActions().filter((ka) => !!ka.actionName) as KeyboardShortcutWithRequiredActionName[]).map((ka) => ({
        name: `keyboardShortcuts${ka.actionName.charAt(0).toUpperCase()}${ka.actionName.slice(1)}`,
        value: JSON.stringify(ka.defaultShortcuts),
        isSynced: false
    })) as DefaultOption[];
}

export default {
    initDocumentOptions,
    initNotSyncedOptions,
    initStartupOptions
};