Skip to content

An open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间,让人与智能体在此协作

20.3 KB
Raw Blame
/// #if !BROWSER
import {escapeHtml} from "../../util/escape";
import * as path from "path";
/// #endif
import {hideMessage, showMessage} from "../../dialog/message";
import {fetchPost, fetchSyncPost} from "../../util/fetch";
import {renderExportJSEmbeds} from "./jsEmbed";
import {ContractFormData} from "../../util/contractFormData";
import {Dialog} from "../../dialog";
import {addScript} from "../util/addScript";
import {isMobile} from "../../util/functions";
import {Constants} from "../../constants";
import {highlightRender, lineNumberRender} from "../render/highlightRender";
import {processRender} from "../util/processCode";
import {renderChartsForImage} from "../render/chartRender";
import {isInAndroid, isIPad, isIPhone, isSafari, saveExportFile, setStorageVal} from "../util/compatibility";
import {useShell} from "../../util/pathName";
import {getHostCapabilities, sanitizeKernelHTML} from "../../util/hostCapabilities";
import {copyPNGByLink, writePNGBlob} from "../../menus/util";
import {getExportImageSize, isExportImageSizeSupported, observeExportImageLayout, updateExportImageLayout} from "./imageLayout";
import {getExportImageFontCSS, getExportImageLocalFontCSS} from "./imageFonts";

const IMAGE_PLACEHOLDER = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=";

export const afterExport = (exportPath: string, msgId: string) => {
    /// #if !BROWSER
    showMessage(`${window.siyuan.languages.exported} ${escapeHtml(exportPath)}
<div class="fn__space"></div>
<button class="b3-button b3-button--white">${window.siyuan.languages.showInFolder}</button>`, 6000, "info", msgId);
    document.querySelector(`#message [data-id="${msgId}"] button`).addEventListener("click", () => {
        useShell("showItemInFolder", path.join(exportPath));
        hideMessage(msgId);
    });
    /// #endif
};

export const exportImage = (id: string, copyOnly = false) => {
    if (!getHostCapabilities().documentImportExport) {
        return;
    }
    let stopObservingLayout: () => void;
    const exportDialog = new Dialog({
        disableAnimation: true,
        destroyCallback() {
            stopObservingLayout?.();
        },
        title: copyOnly ? window.siyuan.languages.copyAsPNG : window.siyuan.languages.exportAsImage,
        content: `<div class="b3-dialog__content" style="${isMobile() ? "padding:8px;" : ""};background-color: var(--b3-theme-background)">
    <div style="${isMobile() ? "margin: 8px 0" : "padding: 48px;margin: 8px 0"}" class="export-img">
        <div ${isMobile() ? 'style="padding:8px"' : ""} class="protyle-wysiwyg${window.siyuan.config.editor.displayBookmarkIcon ? " protyle-wysiwyg--attr" : ""}"></div>
        <div class="export-img__watermark"></div>
    </div>
</div>
<div class="b3-dialog__action export-img__options${copyOnly ? " fn__none" : ""}">
    <label class="fn__flex fn__flex-center">
        ${window.siyuan.languages.export17}
        <span class="fn__space"></span>
        <input id="addTitle" class="b3-switch fn__flex-center" type="checkbox" ${window.siyuan.config.export.addTitle ? "checked" : ""}>
    </label>
    <input aria-label="${window.siyuan.languages.title}" id="customTitle" class="b3-text-field fn__flex-1 fn__flex-center" placeholder="${window.siyuan.languages.title}" ${window.siyuan.config.export.addTitle ? "" : "disabled"}>
    <label class="fn__flex fn__flex-center">
        ${window.siyuan.languages.exportTitleImage}
        <span class="fn__space"></span>
        <input id="titleImage" class="b3-switch fn__flex-center" type="checkbox" ${window.siyuan.storage[Constants.LOCAL_EXPORTIMG].titleImage !== false ? "checked" : ""}>
    </label>
</div>
<div class="b3-dialog__action">
    <label class="fn__flex${copyOnly ? " fn__none" : ""}">
        ${window.siyuan.languages.exportPDF5}
        <span class="fn__space"></span>
        <input id="keepFold" class="b3-switch fn__flex-center" type="checkbox" ${!copyOnly && window.siyuan.storage[Constants.LOCAL_EXPORTIMG].keepFold ? "checked" : ""}>
    </label>
    <label class="fn__flex${copyOnly ? " fn__none" : ""}" style="margin-left: 24px">
        ${window.siyuan.languages.export30}
        <span class="fn__space"></span>
        <input id="watermark" class="b3-switch fn__flex-center" type="checkbox" ${window.siyuan.storage[Constants.LOCAL_EXPORTIMG].watermark ? "checked" : ""}>
    </label>
    <span class="fn__flex-1 export-img__space"></span>
    <button data-type="cancel" class="b3-button b3-button--cancel">${window.siyuan.languages.cancel}</button><div class="fn__space"></div>
    <button data-type="copy" disabled class="b3-button b3-button--text${copyOnly ? " fn__none" : ""}">${window.siyuan.languages.copyAsPNG}</button><div class="fn__space${copyOnly ? " fn__none" : ""}"></div>
    <button data-type="export" disabled class="b3-button b3-button--text${copyOnly ? " fn__none" : ""}">${window.siyuan.languages.exportFile}</button>
</div>
 <div class="fn__loading"><span class="b3-loading b3-loading--large" aria-hidden="true"></span></div>`,
        width: isMobile() ? "92vw" : "990px",
        height: "70vh",
        resizeCallback() {
            updateExportImageLayout(exportDialog.element.querySelector(".export-img"));
            previewElement.querySelectorAll(".code-block .protyle-linenumber__rows").forEach((item: HTMLElement) => {
                if ((item.nextElementSibling as HTMLElement).style.wordBreak === "break-word") {
                    lineNumberRender(item.parentElement);
                }
            });
        }
    });
    exportDialog.element.setAttribute("data-key", Constants.DIALOG_EXPORTIMAGE);
    const cancelButton = exportDialog.element.querySelector('[data-type="cancel"]') as HTMLButtonElement;
    const copyButton = exportDialog.element.querySelector('[data-type="copy"]') as HTMLButtonElement;
    const exportButton = exportDialog.element.querySelector('[data-type="export"]') as HTMLButtonElement;
    const previewElement = exportDialog.element.querySelector(".protyle-wysiwyg") as HTMLElement;
    const foldElement = exportDialog.element.querySelector("#keepFold") as HTMLInputElement;
    const watermarkElement = exportDialog.element.querySelector("#watermark") as HTMLInputElement;
    const addTitleElement = exportDialog.element.querySelector("#addTitle") as HTMLInputElement;
    const titleImageElement = exportDialog.element.querySelector("#titleImage") as HTMLInputElement;
    const customTitleElement = exportDialog.element.querySelector("#customTitle") as HTMLInputElement;
    let imageName = "image.png";
    let outputting = false;
    let titleRefreshTimer: number;
    let titleComposing = false;
    let previewRevision = 0;

    const setActionDisabled = (disabled: boolean) => {
        cancelButton.disabled = disabled && outputting;
        copyButton.disabled = disabled;
        exportButton.disabled = disabled;
    };
    const uploadImageBlob = (blob: Blob) => {
        const formData = new ContractFormData({file: new File([blob], imageName, {type: blob.type}), type: "image/png"});
        return new Promise<IWebSocketData>((resolve, reject) => {
            let received = false;
            fetchPost("/api/export/exportAsFile", formData, (response) => {
                received = true;
                resolve(response);
            }).finally(() => {
                if (!received) {
                    reject(new Error(window.siyuan.languages.exportFileSaveFailed));
                }
            });
        });
    };
    const renderImageBlob = async () => {
        const plantumlElements = previewElement.querySelectorAll("[data-subtype='plantuml']");
        for (let i = 0; i < plantumlElements.length; i++) {
            const objectElement = plantumlElements[i].querySelector("object");
            if (objectElement) {
                const res = await fetch(objectElement.getAttribute("data"));
                const response = await res.text();
                objectElement.insertAdjacentHTML("beforebegin", sanitizeKernelHTML(response));
                objectElement.remove();
            }
        }
        previewElement.querySelectorAll(".protyle-linenumber__rows").forEach((rowsElement) => {
            // 每个代码块的行号都需要从 1 开始计数,不能跨代码块累加
            rowsElement.querySelectorAll("span").forEach((item, index) => {
                item.textContent = (index + 1).toString();
            });
        });
        await new Promise((resolve) => {
            setTimeout(resolve, Constants.TIMEOUT_LOAD);
        });
        await document.fonts.ready;
        await Promise.all(Array.from(previewElement.querySelectorAll("img")).map(item => {
            item.loading = "eager";
            return item.decode().catch(() => {});
        }));
        updateExportImageLayout(exportDialog.element.querySelector(".export-img"));
        const contentElement = exportDialog.element.querySelector<HTMLElement>(".b3-dialog__content");
        const size = getExportImageSize(contentElement);
        const pixelRatio = window.devicePixelRatio || 1;
        if (!isExportImageSizeSupported(size, pixelRatio)) {
            throw new Error(window.siyuan.languages.exportImageTooLarge);
        }
        // 截图克隆完整内容区,预览窗口保持原有宽度和滚动位置。
        const style = {boxSizing: "border-box", overflow: "hidden"};
        if (isIPhone() || isIPad() || isSafari()) {
            // modern-screenshot 通过缓存默认样式提高 WebKit/WKWebView 环境下的导出性能。
            await addScript(`${Constants.PROTYLE_CDN}/js/modern-screenshot.min.js?v=4.7.0`, "protyleModernScreenshot");
            const localFontCSS = getExportImageLocalFontCSS(contentElement.ownerDocument);
            return window.modernScreenshot.domToBlob(
                contentElement, {
                    ...size,
                    style,
                    type: "image/png",
                    scale: pixelRatio,
                    onCreateForeignObjectSvg: (svgElement: SVGSVGElement) => {
                        if (localFontCSS) {
                            const fontStyle = document.createElementNS(svgElement.namespaceURI, "style");
                            fontStyle.textContent = localFontCSS;
                            svgElement.insertBefore(fontStyle, svgElement.firstChild);
                        }
                    },
                    fetch: {placeholderImage: IMAGE_PLACEHOLDER}
                });
        }
        await addScript(`${Constants.PROTYLE_CDN}/js/html-to-image.min.js?v=1.11.13`, "protyleHtml2image");
        return window.htmlToImage.toBlob(
            contentElement, {
                ...size,
                style,
                pixelRatio,
                fontEmbedCSS: await getExportImageFontCSS(contentElement),
                imagePlaceholder: IMAGE_PLACEHOLDER,
                onImageErrorHandler: (event: Event) => {
                    (event.target as HTMLImageElement).src = IMAGE_PLACEHOLDER;
                }
            });
    };
    const outputImage = async (type: "copy" | "export") => {
        if (outputting) {
            return;
        }
        outputting = true;
        setActionDisabled(true);
        const msgId = showMessage(window.siyuan.languages.exporting, 0);
        if (!copyOnly) {
            setStorageVal(Constants.LOCAL_EXPORTIMG, window.siyuan.storage[Constants.LOCAL_EXPORTIMG]);
        }
        try {
            const blob = await renderImageBlob();
            if (!blob) {
                throw new Error(window.siyuan.languages.exportFileSaveFailed);
            }
            if (type === "copy") {
                let copied: boolean;
                if (isInAndroid()) {
                    const response = await uploadImageBlob(blob);
                    copied = response.code === 0;
                    if (copied) {
                        copyPNGByLink(response.data.file);
                    }
                } else {
                    copied = await writePNGBlob(blob);
                }
                hideMessage(msgId);
                if (!copied) {
                    return;
                }
                showMessage(window.siyuan.languages.copied);
            } else {
                const response = await uploadImageBlob(blob);
                if (response.code !== 0) {
                    throw new Error(response.msg);
                }
                await saveExportFile(response.data.file, msgId);
            }
            exportDialog.destroy();
        } catch (e) {
            hideMessage(msgId);
            console.error("Export image error:", e);
            showMessage(e instanceof Error ? e.message : window.siyuan.languages.exportFileSaveFailed, 7000, "error");
        } finally {
            outputting = false;
            if (document.body.contains(exportDialog.element)) {
                setActionDisabled(false);
            }
        }
    };

    cancelButton.addEventListener("click", () => {
        exportDialog.destroy();
    });
    copyButton.addEventListener("click", () => {
        outputImage("copy");
    });
    exportButton.addEventListener("click", () => {
        outputImage("export");
    });
    const refreshExportPreview = () => {
        const revision = ++previewRevision;
        setActionDisabled(true);
        if (!exportDialog.element.querySelector(".fn__loading")) {
            exportButton.parentElement.insertAdjacentHTML("afterend", '<div class="fn__loading"><span class="b3-loading b3-loading--large" aria-hidden="true"></span></div>');
        }
        requestPreview(revision);
    };
    addTitleElement.addEventListener("change", () => {
        customTitleElement.disabled = !addTitleElement.checked;
        refreshExportPreview();
    });
    titleImageElement.addEventListener("change", () => {
        window.siyuan.storage[Constants.LOCAL_EXPORTIMG].titleImage = titleImageElement.checked;
        setStorageVal(Constants.LOCAL_EXPORTIMG, window.siyuan.storage[Constants.LOCAL_EXPORTIMG]);
        refreshExportPreview();
    });
    const scheduleTitleRefresh = () => {
        window.clearTimeout(titleRefreshTimer);
        titleRefreshTimer = window.setTimeout(refreshExportPreview, 300);
    };
    customTitleElement.addEventListener("compositionstart", () => {
        titleComposing = true;
        window.clearTimeout(titleRefreshTimer);
    });
    customTitleElement.addEventListener("compositionend", () => {
        titleComposing = false;
        scheduleTitleRefresh();
    });
    customTitleElement.addEventListener("input", () => {
        if (!titleComposing) {
            scheduleTitleRefresh();
        }
    });
    foldElement.addEventListener("change", () => {
        window.siyuan.storage[Constants.LOCAL_EXPORTIMG].keepFold = foldElement.checked;
        refreshExportPreview();
    });
    watermarkElement.addEventListener("change", () => {
        window.siyuan.storage[Constants.LOCAL_EXPORTIMG].watermark = watermarkElement.checked;
        updateWatermark();
    });
    const updateWatermark = async () => {
        const watermarkPreviewElement = exportDialog.element.querySelector(".export-img__watermark") as HTMLElement;
        watermarkPreviewElement.innerHTML = "";
        if (watermarkElement.checked) {
            if (window.siyuan.config.export.imageWatermarkDesc) {
                watermarkPreviewElement.innerHTML = sanitizeKernelHTML(window.siyuan.config.export.imageWatermarkDesc);
            } else if (window.siyuan.config.export.imageWatermarkStr) {
                if (window.siyuan.config.export.imageWatermarkStr.startsWith("http")) {
                    watermarkPreviewElement.setAttribute("style", `background-image: url(${window.siyuan.config.export.imageWatermarkStr});background-repeat: repeat;position: absolute;top: 0;left: 0;width: 100%;height: 100%;border-radius: var(--b3-border-radius-b);`);
                } else {
                    await addScript(`${Constants.PROTYLE_CDN}/js/html-to-image.min.js?v=1.11.13`, "protyleHtml2image");
                    const imageElement = exportDialog.element.querySelector(".export-img");
                    const contentElement = exportDialog.element.querySelector(".b3-dialog__content");
                    const width = Math.max(Math.min(imageElement.clientWidth, contentElement.clientWidth) / 3, 150);
                    watermarkPreviewElement.setAttribute("style", `width: ${width}px;height: ${width}px;display: flex;justify-content: center;align-items: center;color: var(--b3-border-color);font-size: 14px;`);
                    watermarkPreviewElement.innerHTML = sanitizeKernelHTML(`<div style="transform: rotate(-45deg)">${window.siyuan.config.export.imageWatermarkStr}</div>`);
                    const canvas = await window.htmlToImage.toCanvas(watermarkPreviewElement, {
                        fontEmbedCSS: await getExportImageFontCSS(watermarkPreviewElement),
                    });
                    watermarkPreviewElement.innerHTML = "";
                    watermarkPreviewElement.setAttribute("style", `background-image: url(${canvas.toDataURL("image/png")});background-repeat: repeat;position: absolute;top: 0;left: 0;width: 100%;height: 100%;border-radius: var(--b3-border-radius-b);`);
                }
            }
        } else {
            watermarkPreviewElement.removeAttribute("style");
        }
    };
    const refreshPreview = async (response: IWebSocketData, revision: number) => {
        if (revision !== previewRevision || !document.body.contains(exportDialog.element)) {
            return;
        }
        previewElement.innerHTML = sanitizeKernelHTML(response.data.content);
        previewElement.setAttribute("data-doc-type", response.data.type || "NodeDocument");
        Object.keys(response.data.attrs).forEach(key => {
            if (getHostCapabilities().remoteKernel && !key.startsWith("custom-") && key !== "style") {
                return;
            }
            previewElement.setAttribute(key, response.data.attrs[key]);
        });
        await renderExportJSEmbeds(previewElement, {
            disabled: window.siyuan.config.system.safeMode || getHostCapabilities().remoteKernel,
            disabledTip: window.siyuan.languages.safeModeJSTip,
            rootID: id,
            headingMode: window.siyuan.config.editor.headingEmbedMode,
        }, fetchSyncPost);
        if (revision !== previewRevision || !document.body.contains(exportDialog.element)) {
            return;
        }
        previewElement.querySelectorAll(".code-block").forEach(item => {
            item.setAttribute("linewrap", "true");
        });
        await renderChartsForImage(previewElement);
        if (revision !== previewRevision || !document.body.contains(exportDialog.element)) {
            return;
        }
        processRender(previewElement);
        highlightRender(previewElement);
        stopObservingLayout?.();
        stopObservingLayout = observeExportImageLayout(exportDialog.element.querySelector(".export-img"));

        await updateWatermark();
        if (revision !== previewRevision || !document.body.contains(exportDialog.element)) {
            return;
        }
        exportDialog.element.querySelector(".fn__loading")?.remove();
        if (copyOnly) {
            await outputImage("copy");
        } else {
            setActionDisabled(false);
        }
    };
    const requestPreview = (revision: number) => {
        let rendering: Promise<void>;
        fetchPost("/api/export/exportPreviewHTML", {
            id,
            keepJSEmbed: true,
            keepFold: foldElement.checked,
            image: true,
            excludeTitleImage: !titleImageElement.checked,
            addTitle: addTitleElement.checked,
            customTitle: customTitleElement.value,
        }, (response) => {
            if (revision !== previewRevision || !document.body.contains(exportDialog.element)) {
                return;
            }
            imageName = response.data.name + ".png";
            rendering = refreshPreview(response, revision);
        }).finally(async () => {
            try {
                await rendering;
            } catch (error) {
                console.error("Export preview error:", error);
                showMessage(error instanceof Error ? error.message : window.siyuan.languages.exportFileSaveFailed, 7000, "error");
            } finally {
                if (revision === previewRevision && document.body.contains(exportDialog.element)) {
                    exportDialog.element.querySelector(".fn__loading")?.remove();
                    cancelButton.disabled = false;
                }
            }
        });
    };
    requestPreview(0);
};