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 {config as configApi} from "./util/configApi";
import type {OCRConfigData, OCRThresholds, SettingOCR} from "../types/api";
import {fetchSyncPost} from "../util/fetch";
import {escapeAttr, escapeHtml} from "../util/escape";
import {openOCRImportModelsDialog} from "./ocrImport";
import {genConfigItemMainHtml, genSwitchRow} from "./render/fragments";
import {genNumberInputHtml} from "./render/render";
import {showMessage} from "../dialog/message";
import {OCR_CHANGED_EVENT} from "./ocrRuntime";
import {objEquals} from "../util/functions";
import {AI_CONFIG_CHANGED_EVENT} from "./tabs/ai/aiRuntime";
import type {SettingTabBuilder} from "./setting/builder";
import {trackSettingSave} from "./setting/pending";
import {getReasoningEffortOptions} from "../ai/reasoningEffort";
const mounts = new WeakMap<HTMLElement, () => void>();
export const unmountOCRTab = (root: HTMLElement) => {
mounts.get(root)?.();
mounts.delete(root);
};
export const mountOCRTab = (root: HTMLElement) => {
unmountOCRTab(root);
mounts.set(root, mountOCRSettings(root));
};
/** 按提供商和搜索状态标记每组最后一个可见条目 */
export const updateOCRTabBorders = (root: HTMLElement) => {
root.querySelectorAll<HTMLElement>("[data-config-group-id]").forEach(group => {
const items = Array.from(group.querySelectorAll<HTMLElement>(".config-item"));
items.forEach(item => item.classList.remove("b3-label--noborder"));
items.filter(item => !item.classList.contains("fn__none") && !item.classList.contains("config-search-hidden"))
.at(-1)?.classList.add("b3-label--noborder");
});
};
const selectRow = (id: string, title: string, desc: string) =>
`<label class="fn__flex b3-label config-item">${genConfigItemMainHtml(title, desc)}
<span class="fn__space"></span><select id="${id}" class="b3-select fn__flex-center fn__size200" disabled></select></label>`;
const getThresholdFields = () => [
{key: "detection", title: window.siyuan.languages.ocrDetectionThreshold, placeholder: window.siyuan.languages.ocrModelDefault},
{key: "box", title: window.siyuan.languages.ocrBoxThreshold, placeholder: window.siyuan.languages.ocrModelDefault},
{key: "recognition", title: window.siyuan.languages.ocrRecognitionThreshold, placeholder: "0.5"},
] as const;
const getTooltipFields = () => [
{key: "showText", title: window.siyuan.languages.ocrShowText, tip: window.siyuan.languages.ocrShowTextTip, default: true},
{key: "showEmpty", title: window.siyuan.languages.ocrShowEmpty, tip: window.siyuan.languages.ocrShowEmptyTip, default: false},
{key: "showError", title: window.siyuan.languages.ocrShowError, tip: window.siyuan.languages.ocrShowErrorTip, default: false},
] as const;
export const registerOCRTab = (tab: SettingTabBuilder) => {
const languages = window.siyuan.languages;
tab.group("general", languages.configGroupOCREngine).slot({
key: "ocrAuto",
keywords: [languages.ocrAuto, languages.ocrAutoTip],
html: () => genSwitchRow("ocrAuto", languages.ocrAuto, languages.ocrAutoTip, false),
}).slot({
key: "ocrProvider",
keywords: ["Tesseract", "PaddleOCR", "AI", languages.ocrProvider, languages.ocrProviderTip],
html: () => selectRow("ocrProvider", languages.ocrProvider, languages.ocrProviderTip),
}).slot({
key: "ocrModel",
keywords: ["PaddleOCR", "Tiny", languages.ocrModel, languages.ocrModelTip],
html: () => selectRow("ocrModel", languages.ocrModel, languages.ocrModelTip),
}).button({
id: "ocrImport",
title: languages.ocrImportModelsTitle,
desc: languages.ocrImportModelsTip,
label: languages.import,
icon: "iconUpload",
keywords: ["ONNX", "YAML", "Tiny", languages.ocrDetector, languages.ocrRecognizer],
}).slot({
key: "ocrAIModel",
keywords: ["AI", languages.ocrAIModel, languages.ocrAIModelTip],
html: () => selectRow("ocrAIModel", languages.ocrAIModel, languages.ocrAIModelTip),
}).slot({
key: "ocrReasoningEffort",
keywords: [languages.reasoningEffortTooltip, languages.ocrReasoningEffortTip],
html: () => selectRow("ocrReasoningEffort", languages.reasoningEffortTooltip, languages.ocrReasoningEffortTip),
});
const thresholds = tab.group("advanced", languages.ocrThresholdSettings);
getThresholdFields().forEach(field => {
thresholds.slot({
key: `ocrThreshold_${field.key}`,
keywords: [field.title, languages.ocrThresholdsTip],
html: () => `<div class="fn__flex b3-label config-item">${genConfigItemMainHtml(`<label for="ocrThreshold_${field.key}">${field.title}</label>`, field.key === "detection" ? languages.ocrThresholdsTip : undefined)}
<span class="fn__space"></span>${genNumberInputHtml(`ocrThreshold_${field.key}`, "", 0, 1, "any")}</div>`,
});
});
const tooltip = tab.group("tooltip", languages.ocrTooltipSettings);
getTooltipFields().forEach(field => {
tooltip.slot({
key: `ocr_${field.key}`,
keywords: [field.title, field.tip],
html: () => genSwitchRow(`ocr_${field.key}`, field.title, field.tip, field.default),
});
});
};
export const mountOCRSettings = (root: HTMLElement): (() => void) => {
const controller = new AbortController();
let closed = false;
let data: OCRConfigData;
const busy = false;
let pendingSaves = 0;
let saveQueue = Promise.resolve(false);
let refreshPending = false;
let refreshTask: Promise<void>;
let writeRevision = 0;
let importDialog: ReturnType<typeof openOCRImportModelsDialog> | undefined;
const languages = window.siyuan.languages;
const thresholdFields = getThresholdFields();
const tooltipFields = getTooltipFields();
const updateTooltipInputs = () => {
tooltipFields.forEach(field => {
root.querySelector<HTMLInputElement>(`#ocr_${field.key}`).checked = data.config[field.key] ?? field.default;
});
};
const dirtyThresholds = new Set<keyof OCRThresholds>();
let thresholdValues: OCRThresholds;
const updateThresholdInputs = () => {
thresholdValues = {
detection: data.config.thresholds?.detection ?? null,
box: data.config.thresholds?.box ?? null,
recognition: data.config.thresholds?.recognition ?? null,
};
thresholdFields.forEach(field => {
if (!dirtyThresholds.has(field.key)) {
const input = root.querySelector<HTMLInputElement>(`#ocrThreshold_${field.key}`);
input.value = `${thresholdValues[field.key] ?? ""}`;
input.setCustomValidity("");
}
});
};
const updateControls = () => {
// 提供商取自启动配置,首次渲染和切换后都由配置刷新,不依赖下拉框在配置返回时才有值
const provider = window.siyuan.config.ocr.provider;
const isPaddleOCR = provider === "paddleocr";
const isAI = provider === "ai";
["ocrModel", "ocrImport"].forEach(id => {
root.querySelector(`#${id}`).closest(".config-item").classList.toggle("fn__none", !isPaddleOCR);
});
root.querySelector("#ocrAIModel").closest(".config-item").classList.toggle("fn__none", !isAI);
root.querySelector("#ocrReasoningEffort").closest(".config-item").classList.toggle("fn__none", !isAI);
root.querySelector('[data-config-group-id="advanced"]')?.classList.toggle("fn__none", !isPaddleOCR);
root.querySelectorAll<HTMLInputElement | HTMLSelectElement | HTMLButtonElement>("input, select, .config-item button").forEach(element => {
element.disabled = busy || (element.tagName === "BUTTON" && pendingSaves > 0);
});
root.querySelector<HTMLSelectElement>("#ocrModel").disabled = busy || !isPaddleOCR;
root.querySelector<HTMLSelectElement>("#ocrAIModel").disabled = busy || !isAI;
root.querySelector<HTMLSelectElement>("#ocrReasoningEffort").disabled = busy || !isAI;
thresholdFields.forEach(field => {
root.querySelector<HTMLInputElement>(`#ocrThreshold_${field.key}`).disabled = busy || !isPaddleOCR;
});
root.querySelector<HTMLButtonElement>("#ocrImport").disabled = busy || pendingSaves > 0 || !isPaddleOCR;
updateOCRTabBorders(root);
};
const providerOptions = () => {
const providers = [...data.providers].sort((left, right) => Number(right.id === "paddleocr") - Number(left.id === "paddleocr"));
return providers.map(provider => `<option value="${escapeAttr(provider.id)}" ${data.config.provider === provider.id ? "selected" : ""}>${provider.id === "paddleocr" ? "PaddleOCR" : provider.id === "ai" ? "AI" : "Tesseract"}${provider.available ? "" : ` (${escapeHtml(languages.ocrUnavailable)})`}</option>`).join("");
};
const modelOptions = () => {
let html = data.models.map(model => `<option value="${escapeAttr(model.id)}" ${model.id === data.config.model ? "selected" : ""}>${escapeHtml(model.name)}${model.builtIn ? ` (${escapeHtml(languages.builtIn)})` : ""}</option>`).join("");
if (!data.models.some(model => model.id === data.config.model)) {
html += `<option value="${escapeAttr(data.config.model)}" disabled>${escapeHtml(languages.ocrUnavailable)}</option>`;
}
return html;
};
const aiModelOptions = () => {
const models = data.aiModels || [];
const selected = data.config.aiModelId || "";
let html = selected ? "" : `<option value="" disabled>${escapeHtml(languages.noModelConfigured)}</option>`;
if (selected && !models.some(model => model.id === selected)) {
html += `<option value="${escapeAttr(selected)}" disabled>${escapeHtml(languages.ocrUnavailable)}</option>`;
}
const groups = new Map<string, typeof models>();
models.forEach(model => {
const group = groups.get(model.provider) || [];
group.push(model);
groups.set(model.provider, group);
});
groups.forEach((models, provider) => {
html += `<optgroup label="${escapeAttr(provider)}">${models.map(model =>
`<option value="${escapeAttr(model.id)}">${escapeHtml(model.name)}</option>`).join("")}</optgroup>`;
});
return html;
};
const updateForm = (previous: OCRConfigData) => {
const provider = root.querySelector<HTMLSelectElement>("#ocrProvider");
const model = root.querySelector<HTMLSelectElement>("#ocrModel");
if (!objEquals(previous.providers, data.providers)) provider.innerHTML = providerOptions();
if (!objEquals(previous.models, data.models) || previous.config.model !== data.config.model) model.innerHTML = modelOptions();
if (!objEquals(previous.aiModels, data.aiModels) || previous.config.aiModelId !== data.config.aiModelId) {
root.querySelector<HTMLSelectElement>("#ocrAIModel").innerHTML = aiModelOptions();
}
provider.value = data.config.provider;
model.value = data.config.model;
root.querySelector<HTMLSelectElement>("#ocrAIModel").value = data.config.aiModelId || "";
root.querySelector<HTMLSelectElement>("#ocrReasoningEffort").value = data.config.reasoningEffort || "";
root.querySelector<HTMLInputElement>("#ocrAuto").checked = data.config.auto;
updateTooltipInputs();
updateThresholdInputs();
updateControls();
};
const render = () => {
root.querySelector<HTMLSelectElement>("#ocrProvider").innerHTML = providerOptions();
root.querySelector<HTMLSelectElement>("#ocrModel").innerHTML = modelOptions();
root.querySelector<HTMLSelectElement>("#ocrAIModel").innerHTML = aiModelOptions();
root.querySelector<HTMLSelectElement>("#ocrReasoningEffort").innerHTML = getReasoningEffortOptions(languages)
.map(option => `<option value="${option.value}">${escapeHtml(option.label)}</option>`).join("");
updateForm(data);
};
const load = (): Promise<void> => {
refreshPending = true;
if (refreshTask || closed || busy || pendingSaves > 0) {
return refreshTask || Promise.resolve();
}
// 合并通知,写入期间延后读取,避免旧响应覆盖正在保存的选择。
refreshTask = (async () => {
while (refreshPending && !closed && !busy && pendingSaves === 0) {
refreshPending = false;
const readRevision = writeRevision;
const response = await fetchSyncPost("/api/asset/getOCRConfig", {}, undefined, true, controller.signal);
if (closed) return;
if (readRevision !== writeRevision || busy || pendingSaves > 0 || refreshPending) {
refreshPending = true;
continue;
}
if (response.code !== 0) {
if (!data) showMessage(response.msg);
return;
}
const previous = data;
data = response.data;
window.siyuan.config.ocr = data.config;
if (previous) updateForm(previous);
else render();
}
})().finally(() => {
refreshTask = undefined;
if (refreshPending && !closed && !busy && pendingSaves === 0) {
void load().catch(handleError);
}
});
return refreshTask;
};
const handleError = (error: Error) => {
if (!closed && error.name !== "AbortError") {
showMessage(error.message);
}
};
thresholdFields.forEach(field => {
root.querySelector<HTMLInputElement>(`#ocrThreshold_${field.key}`).placeholder = field.placeholder;
});
// 首次响应到达前先按已加载配置设定可见性,随后统一禁用,等配置读取完成再启用
updateControls();
root.querySelectorAll<HTMLInputElement | HTMLSelectElement | HTMLButtonElement>("input, select, button").forEach(element => {
element.disabled = true;
});
window.addEventListener(OCR_CHANGED_EVENT, () => { void load().catch(handleError); }, {signal: controller.signal});
window.addEventListener(AI_CONFIG_CHANGED_EVENT, () => { void load().catch(handleError); }, {signal: controller.signal});
const saveConfig = async (thresholds?: OCRThresholds): Promise<boolean> => {
if (closed || busy || !data) {
return false;
}
const config: SettingOCR = {
provider: root.querySelector<HTMLSelectElement>("#ocrProvider").value,
model: root.querySelector<HTMLSelectElement>("#ocrModel").value,
auto: root.querySelector<HTMLInputElement>("#ocrAuto").checked,
showText: root.querySelector<HTMLInputElement>("#ocr_showText").checked,
showEmpty: root.querySelector<HTMLInputElement>("#ocr_showEmpty").checked,
showError: root.querySelector<HTMLInputElement>("#ocr_showError").checked,
aiModelId: root.querySelector<HTMLSelectElement>("#ocrAIModel").value,
reasoningEffort: root.querySelector<HTMLSelectElement>("#ocrReasoningEffort").value,
thresholds,
};
writeRevision++;
pendingSaves++;
updateControls();
// 串行保存每次选择,保留控件焦点和文件选择,最后一次完成后再校正界面状态。
const save = async () => {
let saved = false;
try {
if (closed) {
return false;
}
await configApi.set("ocr", config, next => {
if (!closed) {
data.config = next as SettingOCR;
saved = true;
}
});
} catch (error) {
handleError(error);
} finally {
pendingSaves--;
if (!closed && pendingSaves === 0) {
root.querySelector<HTMLSelectElement>("#ocrProvider").value = data.config.provider;
root.querySelector<HTMLSelectElement>("#ocrModel").value = data.config.model;
root.querySelector<HTMLInputElement>("#ocrAuto").checked = data.config.auto;
updateTooltipInputs();
root.querySelector<HTMLSelectElement>("#ocrAIModel").innerHTML = aiModelOptions();
root.querySelector<HTMLSelectElement>("#ocrAIModel").value = data.config.aiModelId || "";
root.querySelector<HTMLSelectElement>("#ocrReasoningEffort").value = data.config.reasoningEffort || "";
updateThresholdInputs();
updateControls();
if (refreshPending) void load().catch(handleError);
}
}
return saved;
};
saveQueue = saveQueue.then(save, save);
return trackSettingSave(saveQueue);
};
root.addEventListener("input", event => {
const input = event.target as HTMLInputElement;
const field = thresholdFields.find(field => input.id === `ocrThreshold_${field.key}`);
if (field) {
if (input.validity.badInput || input.value !== `${thresholdValues?.[field.key] ?? ""}`) {
dirtyThresholds.add(field.key);
} else {
dirtyThresholds.delete(field.key);
}
input.setCustomValidity("");
}
}, {signal: controller.signal});
root.addEventListener("change", async event => {
event.stopPropagation();
const target = event.target as HTMLInputElement | HTMLSelectElement;
if (!data) return;
const field = thresholdFields.find(field => target.id === `ocrThreshold_${field.key}`);
if (field) {
const input = target as HTMLInputElement;
const value = input.value === "" ? null : Number(input.value);
const invalid = input.validity.badInput || value !== null && (!Number.isFinite(value) ||
(field.key === "recognition" ? value < 0 || value > 1 : value <= 0 || value >= 1));
input.setCustomValidity(invalid ? languages.ocrThresholdRange : "");
if (!input.reportValidity()) {
dirtyThresholds.add(field.key);
return;
}
dirtyThresholds.delete(field.key);
thresholdValues = {...thresholdValues, [field.key]: value};
await saveConfig({...thresholdValues});
return;
}
if (target.id === "ocrProvider" && target.value === "ai" && data.config.provider !== "ai") {
root.querySelector<HTMLInputElement>("#ocrAuto").checked = false;
if (!data.config.aiModelId && data.aiModels?.length) {
root.querySelector<HTMLSelectElement>("#ocrAIModel").value = data.aiModels[0].id;
}
}
updateControls();
await saveConfig();
}, {signal: controller.signal});
root.addEventListener("click", event => {
event.stopPropagation();
const button = (event.target as HTMLElement).closest("button");
if (!button || busy || pendingSaves > 0 || !data || button.id !== "ocrImport" || importDialog) {
return;
}
// 标记写入版本,避免导入期间到达的旧配置响应覆盖导入后的模型列表。
writeRevision++;
importDialog = openOCRImportModelsDialog({
signal: controller.signal,
onImported: () => {
if (!closed) {
void load().catch(handleError);
}
},
onClosed: () => {
importDialog = undefined;
},
});
}, {signal: controller.signal});
void load().catch(error => {
handleError(error);
});
return () => {
closed = true;
controller.abort();
importDialog?.destroy();
};
};