An open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间,让人与智能体在此协作
TypeScript agentic-aiai-agentknowledge-baselocal-firstmarkdownmcpmindmapnote-takingself-hostedsiyuanworkspace
import {switchWorkspace, importConfiguration} from "../util/resourceConfig";
import {config as configApi} from "../util/configApi";
/// #if !BROWSER
import {ipcRenderer} from "electron";
import * as path from "path";
/// #endif
import type {SettingTabBuilder} from "../setting/builder";
import {confirmResetSettings} from "../setting/reset";
import {Constants} from "../../constants";
import {fetchPost} from "../../util/fetch";
/// #if !MOBILE
import {reloadUI} from "../../layout/util";
/// #endif
import {showMessage} from "../../dialog/message";
import {isMac, saveExportFile} from "../../protyle/util/compatibility";
import {escapeHtmlTextAndAttr} from "../../util/escape";
/// #if MOBILE
import {confirmDialog} from "../../dialog/confirmDialog";
import {Dialog} from "../../dialog";
import {openInputDialog} from "../../dialog/inputDialog";
import {isInMobileApp} from "../../protyle/util/compatibility";
import {pathPosix} from "../../util/pathName";
import {escapeAttr, escapeHtml} from "../../util/escape";
/// #endif
/// #if !BROWSER
import {afterExport} from "../../protyle/export/util";
/// #endif
import {genConfigItemMainHtml, genConfigItemName} from "../render/fragments";
import {sendAppSetting} from "./appRuntime";
import {getHostCapabilities} from "../../util/hostCapabilities";
import {genWorkspaceStorageHtml, mountWorkspaceStorage} from "./workspaceStorage";
import {importDataFile} from "../../menus/importData";
/// #if MOBILE
const registerAppWorkspaceGroup = (tab: SettingTabBuilder) => {
if (!isInMobileApp() || window.siyuan.config.readonly || !getHostCapabilities().workspaces) {
return;
}
const group = tab.group("workspace", window.siyuan.languages.workspaceList);
group.slot({
key: "workspaceList",
keywords: [
window.siyuan.languages.openBy,
window.siyuan.languages.new,
window.siyuan.languages.removeWorkspacePhysically,
],
html: () => `<div class="b3-label config-item">
<button id="openWorkspace" class="b3-button b3-button--outline fn__block">${window.siyuan.languages.openBy}...</button>
<div class="fn__hr--small"></div>
<ul id="workspaceDir" class="b3-list b3-list--background"></ul>
<div class="fn__hr--small"></div>
<button id="creatWorkspace" class="b3-button fn__block">${window.siyuan.languages.new}</button>
</div>`,
afterMount: mountAppWorkspaceSlot,
});
};
const renderWorkspaceList = (workspaceDirElement: Element) => {
fetchPost("/api/system/getWorkspaces", {}, (response) => {
let html = "";
response.data.forEach((item: IWorkspace) => {
html += `<li data-path="${escapeAttr(escapeHtml(item.path))}" class="b3-list-item b3-list-item--narrow${window.siyuan.config.system.workspaceDir === item.path ? " b3-list-item--focus" : ""}">
<span class="b3-list-item__text">${escapeHtml(pathPosix().basename(item.path))}</span>
<span data-type="remove" class="b3-list-item__action">
<svg><use xlink:href="#iconMin"></use></svg>
</span>
</li>`;
});
workspaceDirElement.innerHTML = html;
});
};
const mountAppWorkspaceSlot = (root: HTMLElement) => {
if (!getHostCapabilities().workspaces) {
return;
}
const workspaceDirElement = root.querySelector("#workspaceDir");
if (!workspaceDirElement) {
return;
}
renderWorkspaceList(workspaceDirElement);
root.addEventListener("click", (event) => {
let target = event.target as HTMLElement;
while (target && target !== root) {
if (target.id === "openWorkspace") {
fetchPost("/api/system/getMobileWorkspaces", {}, (response) => {
let selectHTML = "";
response.data.forEach((item: string, index: number) => {
selectHTML += `<option value="${escapeAttr(escapeHtml(item))}"${index === 0 ? " selected" : ""}>${escapeHtml(pathPosix().basename(item))}</option>`;
});
const openWorkspaceDialog = new Dialog({
title: window.siyuan.languages.openBy,
content: `<div class="b3-dialog__content">
<select class="b3-text-field fn__block">${selectHTML}</select>
</div>
<div class="b3-dialog__action">
<button class="b3-button b3-button--cancel">${window.siyuan.languages.cancel}</button><div class="fn__space"></div>
<button class="b3-button b3-button--text">${window.siyuan.languages.confirm}</button>
</div>`,
width: "92vw",
});
openWorkspaceDialog.element.setAttribute("data-key", Constants.SIYUAN_OPEN_WORKSPACE);
const btnsElement = openWorkspaceDialog.element.querySelectorAll(".b3-button");
btnsElement[0].addEventListener("click", () => {
openWorkspaceDialog.destroy();
});
btnsElement[1].addEventListener("click", () => {
const openPath = (openWorkspaceDialog.element.querySelector("select") as HTMLSelectElement).value;
if (openPath === window.siyuan.config.system.workspaceDir) {
openWorkspaceDialog.destroy();
return;
}
confirmDialog(window.siyuan.languages.confirm, `${escapeHtml(pathPosix().basename(window.siyuan.config.system.workspaceDir))} -> ${escapeHtml(pathPosix().basename(openPath))}?`, () => {
switchWorkspace(openPath);
});
});
});
event.preventDefault();
event.stopPropagation();
break;
} else if (target.id === "creatWorkspace") {
const createWorkspaceDialog = openInputDialog({
title: window.siyuan.languages.new,
value: "",
onConfirm: (value, dialog) => {
fetchPost("/api/system/createWorkspaceDir", {
path: pathPosix().join(pathPosix().dirname(window.siyuan.config.system.workspaceDir), value),
}, () => {
renderWorkspaceList(workspaceDirElement);
dialog.destroy();
});
},
});
createWorkspaceDialog.element.setAttribute("data-key", Constants.DIALOG_CREATEWORKSPACE);
event.preventDefault();
event.stopPropagation();
break;
} else if (target.getAttribute("data-type") === "remove") {
const removePath = target.parentElement?.getAttribute("data-path");
if (!removePath) {
break;
}
event.preventDefault();
event.stopPropagation();
if (removePath === window.siyuan.config.system.workspaceDir) {
fetchPost("/api/system/removeWorkspaceDir", {path: removePath});
break;
}
confirmDialog(window.siyuan.languages.deleteOpConfirm, window.siyuan.languages.removeWorkspacePhysically.replace("${x}", () => escapeHtml(removePath)), () => {
fetchPost("/api/system/removeWorkspaceDirPhysically", {path: removePath}, () => {
renderWorkspaceList(workspaceDirElement);
});
}, () => {
fetchPost("/api/system/removeWorkspaceDir", {path: removePath}, () => {
renderWorkspaceList(workspaceDirElement);
});
}, true);
break;
} else if (target.classList.contains("b3-list-item") && !target.classList.contains("b3-list-item--focus")) {
const workspacePath = target.getAttribute("data-path");
if (!workspacePath) {
break;
}
confirmDialog(window.siyuan.languages.confirm, `${escapeHtml(pathPosix().basename(window.siyuan.config.system.workspaceDir))} -> ${escapeHtml(pathPosix().basename(workspacePath))}?`, () => {
switchWorkspace(workspacePath);
});
event.preventDefault();
event.stopPropagation();
break;
}
target = target.parentElement;
}
});
};
/// #endif
const genImportUploadButtonHtml = (inputId: string, label: string): string =>
`<button class="b3-button b3-button--outline fn__flex-center fn__size200" style="position: relative">
<input id="${inputId}" class="b3-form__upload" type="file">
<svg><use xlink:href="#iconUpload"></use></svg>
${label}
</button>`;
const registerAppGeneralGroup = (tab: SettingTabBuilder) => {
const group = tab.group("general", window.siyuan.languages.configGroupGeneral);
/// #if !BROWSER && !MOBILE
group.switch("system.settingsWindow", {
title: window.siyuan.languages.settingsWindowMode,
desc: window.siyuan.languages.settingsWindowModeTip,
save: (value) => sendAppSetting("system.settingsWindow", value),
});
/// #endif
/// #if !BROWSER
if (!window.siyuan.config.system.isMicrosoftStore && window.siyuan.config.system.container === "std" && window.siyuan.config.system.os !== "linux") {
group.select("system.autoLaunch2", {
title: window.siyuan.languages.autoLaunch,
desc: window.siyuan.languages.autoLaunchTip,
options: [
{value: 0, label: window.siyuan.languages.autoLaunchMode0},
{value: 1, label: window.siyuan.languages.autoLaunchMode1},
...(!isMac() ? [{value: 2, label: window.siyuan.languages.autoLaunchMode2}] : []),
],
save: (value) => sendAppSetting("system.autoLaunch2", value),
});
}
/// #endif
group.slot({
key: "networkProxy",
keywords: [
window.siyuan.languages.networkProxy,
window.siyuan.languages.about17,
window.siyuan.languages.directConnection,
window.siyuan.languages.useSystemProxy,
"SOCKS5",
"HTTPS",
"HTTP",
"user:pass@IP",
"Port",
window.siyuan.languages.confirm,
],
html: genNetworkProxyHtml,
afterMount: mountNetworkProxy,
});
/// #if !BROWSER
group.slot({
key: "accessibilitySupport",
keywords: [window.siyuan.languages.accessibilitySupport, window.siyuan.languages.accessibilitySupportTip],
html: () => `<label class="fn__flex b3-label config-item">
<div class="fn__flex-1 config-item__main">
${genConfigItemName(window.siyuan.languages.accessibilitySupport)}
<div class="b3-label__text">${window.siyuan.languages.accessibilitySupportTip}</div>
<div id="accessibilitySupportStatus" class="b3-label__text fn__none" role="status"></div>
</div>
<span class="fn__space"></span>
<input id="accessibilitySupport" class="b3-switch fn__flex-center" type="checkbox" disabled>
</label>`,
afterMount: mountAccessibilitySetting,
});
if (process.platform === "linux") {
group.slot({
key: "linuxInputMethod",
keywords: [window.siyuan.languages.linuxInputMethod, window.siyuan.languages.linuxInputMethodTip],
html: () => `<label class="fn__flex b3-label config-item">
<div class="fn__flex-1 config-item__main">
${genConfigItemName(window.siyuan.languages.linuxInputMethod)}
<div class="b3-label__text">${window.siyuan.languages.linuxInputMethodTip}</div>
<div id="linuxInputMethodStatus" class="b3-label__text fn__none" role="status"></div>
</div>
<span class="fn__space"></span>
<input id="linuxInputMethod" class="b3-switch fn__flex-center" type="checkbox" disabled>
</label>`,
afterMount: mountLinuxInputMethodSetting,
});
}
/// #endif
};
/// #if !BROWSER
const mountAccessibilitySetting = async (root: HTMLElement) => {
const input = root.querySelector<HTMLInputElement>("#accessibilitySupport");
const status = root.querySelector<HTMLElement>("#accessibilitySupportStatus");
let enabled = false;
const showStatus = (text: string) => {
status.textContent = text;
status.classList.toggle("fn__none", !text);
};
try {
const setting: {enabled: boolean; override: boolean | null} = await ipcRenderer.invoke(Constants.SIYUAN_GET, {
cmd: "getAccessibilitySetting",
});
enabled = setting.enabled;
input.checked = setting.override ?? enabled;
if (setting.override !== null) {
showStatus(window.siyuan.languages.accessibilitySupportOverrideTip);
return;
}
input.disabled = false;
} catch (error) {
console.warn("read accessibility setting failed", error);
showStatus(window.siyuan.languages.accessibilitySupportError);
return;
}
input.addEventListener("change", async () => {
input.disabled = true;
showStatus("");
try {
const setting: {enabled: boolean} = await ipcRenderer.invoke(Constants.SIYUAN_GET, {
cmd: "setAccessibilitySetting", enabled: input.checked,
});
enabled = setting.enabled;
} catch (error) {
console.warn("save accessibility setting failed", error);
showStatus(window.siyuan.languages.accessibilitySupportError);
} finally {
input.checked = enabled;
input.disabled = false;
}
});
};
const mountLinuxInputMethodSetting = async (root: HTMLElement) => {
const input = root.querySelector<HTMLInputElement>("#linuxInputMethod");
const status = root.querySelector<HTMLElement>("#linuxInputMethodStatus");
let enabled = false;
const showStatus = (text: string) => {
status.textContent = text;
status.classList.toggle("fn__none", !text);
};
try {
const setting: {enabled: boolean; override: boolean | null} = await ipcRenderer.invoke(Constants.SIYUAN_GET, {
cmd: "getLinuxInputMethodSetting",
});
enabled = setting.enabled;
input.checked = setting.override ?? enabled;
if (setting.override !== null) {
showStatus(window.siyuan.languages.linuxInputMethodOverrideTip);
return;
}
input.disabled = false;
} catch (error) {
console.warn("read Linux input method setting failed", error);
showStatus(window.siyuan.languages.linuxInputMethodError);
return;
}
input.addEventListener("change", async () => {
input.disabled = true;
showStatus("");
try {
const setting: {enabled: boolean} = await ipcRenderer.invoke(Constants.SIYUAN_GET, {
cmd: "setLinuxInputMethodSetting", enabled: input.checked,
});
enabled = setting.enabled;
} catch (error) {
console.warn("save Linux input method setting failed", error);
showStatus(window.siyuan.languages.linuxInputMethodError);
} finally {
input.checked = enabled;
input.disabled = false;
}
});
};
/// #endif
// 直接连接和使用系统代理时不使用主机与端口,由界面自行取值
const isManualProxyScheme = (scheme: string) => "" !== scheme && "system" !== scheme;
const genNetworkProxyHtml = (): string => {
const proxy = window.siyuan.config.system.networkProxy;
const inputClass = `b3-text-field fn__flex-1${isManualProxyScheme(proxy.scheme || "") ? "" : " fn__none"}`;
return `<div class="b3-label config-item">
${genConfigItemName(window.siyuan.languages.networkProxy)}
<div class="b3-label__text">
${window.siyuan.languages.about17}
</div>
<div class="b3-label__text fn__flex" style="overflow: visible !important;">
<select id="networkProxyScheme" class="b3-select">
<option value="" ${proxy.scheme === "" ? "selected" : ""}>${window.siyuan.languages.directConnection}</option>
<option value="system" ${proxy.scheme === "system" ? "selected" : ""}>${window.siyuan.languages.useSystemProxy}</option>
<option value="socks5" ${proxy.scheme === "socks5" ? "selected" : ""}>SOCKS5</option>
<option value="https" ${proxy.scheme === "https" ? "selected" : ""}>HTTPS</option>
<option value="http" ${proxy.scheme === "http" ? "selected" : ""}>HTTP</option>
</select>
<span class="fn__space"></span>
<div id="networkProxyManual" class="fn__flex fn__flex-1">
<input spellcheck="false" id="networkProxyHost" placeholder="user:pass@IP" class="${inputClass}" value="${escapeHtmlTextAndAttr(proxy.host)}"/>
<span class="fn__space"></span>
<input id="networkProxyPort" placeholder="Port" class="${inputClass}" value="${escapeHtmlTextAndAttr(proxy.port)}" type="number"/>
</div>
<span class="fn__space"></span>
<button id="networkProxyConfirm" class="b3-button fn__size200 b3-button--outline">${window.siyuan.languages.confirm}</button>
</div>
</div>`;
};
const mountNetworkProxy = (root: HTMLElement) => {
const schemeElement = root.querySelector("#networkProxyScheme") as HTMLSelectElement;
const hostElement = root.querySelector("#networkProxyHost") as HTMLInputElement;
const portElement = root.querySelector("#networkProxyPort") as HTMLInputElement;
// 容器始终占据剩余空间,隐藏输入框后确定按钮仍保持右对齐
const updateManualVisibility = () => {
const hidden = !isManualProxyScheme(schemeElement.value);
hostElement.classList.toggle("fn__none", hidden);
portElement.classList.toggle("fn__none", hidden);
};
schemeElement.addEventListener("change", updateManualVisibility);
updateManualVisibility();
root.querySelector("#networkProxyConfirm")?.addEventListener("click", () => {
const scheme = schemeElement.value as Config.TSystemNetworkProxyScheme;
const host = hostElement.value;
const port = portElement.value;
configApi.set("system.networkProxy", {scheme, host, port}, async () => {
Object.assign(window.siyuan.config.system.networkProxy, {scheme, host, port});
/// #if !BROWSER
ipcRenderer.invoke(Constants.SIYUAN_GET, {
cmd: "setProxy",
proxyMode: scheme === "system" ? "system" : scheme === "" ? "direct" : "fixed_servers",
proxyURL: scheme === "system" ? "://" : `${scheme}://${host}:${port}`,
}).then(() => {
void reloadUI();
});
/// #endif
});
});
};
const registerAppDataGroup = (tab: SettingTabBuilder) => {
if (!getHostCapabilities().importExport) {
return;
}
const group = tab.group("data", window.siyuan.languages.configGroupData);
group.button({
id: "exportData",
title: `${window.siyuan.languages.export} Data`,
desc: window.siyuan.languages.exportDataTip,
label: window.siyuan.languages.export,
icon: "iconDownload",
afterMount: mountExportData,
});
group.slot({
key: "importData",
keywords: [window.siyuan.languages.import, window.siyuan.languages.importDataTip],
html: () => `<div class="fn__flex b3-label config-item">
${genConfigItemMainHtml(`${window.siyuan.languages.import} Data`, window.siyuan.languages.importDataTip)}
<span class="fn__space"></span>
${genImportUploadButtonHtml("importData", window.siyuan.languages.import)}
</div>`,
afterMount: (root) => {
root.querySelector("#importData")?.addEventListener("change", (event: Event) => {
const target = event.target as HTMLInputElement;
const file = target.files?.[0];
target.value = "";
if (file) {
void importDataFile(file);
}
});
},
});
group.button({
id: "exportConf",
title: window.siyuan.languages.exportConf,
desc: window.siyuan.languages.exportConfTip,
label: window.siyuan.languages.export,
icon: "iconDownload",
afterMount: (root) => {
root.querySelector("#exportConf")?.addEventListener("click", () => {
fetchPost("/api/system/exportConf", {}, (response) => {
void saveExportFile(response.data.zip);
});
});
},
});
group.slot({
key: "importConf",
keywords: [window.siyuan.languages.importConf, window.siyuan.languages.importConfTip],
html: () => `<div class="fn__flex b3-label config-item">
${genConfigItemMainHtml(window.siyuan.languages.importConf, window.siyuan.languages.importConfTip)}
<span class="fn__space"></span>
${genImportUploadButtonHtml("importConf", window.siyuan.languages.import)}
</div>`,
afterMount: (root) => {
root.querySelector("#importConf")?.addEventListener("change", (event: Event) => {
const target = event.target as HTMLInputElement;
void importConfiguration(target.files[0], true);
});
},
});
};
const mountExportData = (root: HTMLElement) => {
if (!getHostCapabilities().importExport) {
return;
}
root.querySelector("#exportData")?.addEventListener("click", async () => {
/// #if BROWSER
fetchPost("/api/export/exportData", {}, (response) => {
if (response.code === 0) {
saveExportFile(response.data.zip);
}
});
/// #else
const result = await ipcRenderer.invoke(Constants.SIYUAN_GET, {
cmd: "showOpenDialog",
title: window.siyuan.languages.export + " " + "Data",
properties: ["createDirectory", "openDirectory"],
});
if (result.canceled || result.filePaths.length === 0) {
return;
}
const msgId = showMessage(window.siyuan.languages.exporting, -1);
fetchPost("/api/export/exportDataInFolder", {
folder: result.filePaths[0],
}, (response) => {
afterExport(path.join(result.filePaths[0], response.data.name), msgId);
});
/// #endif
});
};
const registerAppMaintenanceGroup = (tab: SettingTabBuilder) => {
const group = tab.group("maintenance", window.siyuan.languages.configGroupMaintenance);
group.slot({
key: "workspaceStorage",
keywords: [window.siyuan.languages.workspaceStorage, window.siyuan.languages.workspaceStorageTip,
window.siyuan.languages.assets, "data", "repo", "history", "temp", "conf"],
html: genWorkspaceStorageHtml,
afterMount: mountWorkspaceStorage,
});
group.button({
id: "reloadUI",
title: window.siyuan.languages.reloadUI,
desc: window.siyuan.languages.reloadUITip,
label: window.siyuan.languages.reloadUI,
icon: "iconRefresh",
afterMount: (root) => {
root.querySelector("#reloadUI")?.addEventListener("click", () => {
fetchPost("/api/ui/reloadUI", {});
});
},
});
group.button({
id: "vacuumDataIndex",
title: window.siyuan.languages.vacuumDataIndex,
desc: window.siyuan.languages.vacuumDataIndexTip,
label: window.siyuan.languages.vacuumDataIndex,
icon: "iconRefresh",
afterMount: (root) => {
root.querySelector("#vacuumDataIndex")?.addEventListener("click", () => {
fetchPost("/api/system/vacuumDataIndex", {});
});
},
});
group.button({
id: "rebuildDataIndex",
title: window.siyuan.languages.rebuildDataIndex,
desc: window.siyuan.languages.rebuildDataIndexTip,
label: window.siyuan.languages.rebuildDataIndex,
icon: "iconRefresh",
afterMount: (root) => {
root.querySelector("#rebuildDataIndex")?.addEventListener("click", () => {
fetchPost("/api/system/rebuildDataIndex", {});
});
},
});
group.button({
id: "clearTempFiles",
title: window.siyuan.languages.clearTempFiles,
desc: window.siyuan.languages.clearTempFilesTip,
label: window.siyuan.languages.purge,
icon: "iconTrashcan",
afterMount: (root) => {
root.querySelector("#clearTempFiles")?.addEventListener("click", () => {
fetchPost("/api/system/clearTempFiles", {});
});
},
});
group.button({
id: "resetSettings",
title: window.siyuan.languages.resetSettings,
desc: window.siyuan.languages.resetSettingsTip,
label: window.siyuan.languages.reset,
icon: "iconUndo",
afterMount: root => {
const button = root.querySelector<HTMLButtonElement>("#resetSettings");
if (button) {
button.disabled = window.siyuan.config.readonly || window.siyuan.isPublish;
button.addEventListener("click", confirmResetSettings);
}
},
});
if (getHostCapabilities().importExport) {
group.button({
id: "exportLog",
title: window.siyuan.languages.systemLog,
desc: window.siyuan.languages.systemLogTip,
label: window.siyuan.languages.export,
icon: "iconDownload",
afterMount: (root) => {
root.querySelector("#exportLog")?.addEventListener("click", () => {
fetchPost("/api/system/exportLog", {}, (response) => {
void saveExportFile(response.data.zip);
});
});
},
});
}
};
export const registerAppTab = (tab: SettingTabBuilder) => {
/// #if MOBILE
registerAppWorkspaceGroup(tab);
/// #endif
registerAppGeneralGroup(tab);
if (getHostCapabilities().importExport) {
registerAppDataGroup(tab);
}
registerAppMaintenanceGroup(tab);
};