import LanguageDetector from "i18next-browser-languagedetector"; import { useCallback, useContext, useEffect, useRef, useState } from "react"; import { trackEvent } from "../analytics"; import { getDefaultAppState } from "../appState"; import { ErrorDialog } from "../components/ErrorDialog"; import { TopErrorBoundary } from "../components/TopErrorBoundary"; import { APP_NAME, EVENT, TITLE_TIMEOUT, URL_HASH_KEYS, VERSION_TIMEOUT, } from "../constants"; import { loadFromBlob } from "../data/blob"; import { ImportedDataState } from "../data/types"; import { ExcalidrawElement, FileId, NonDeletedExcalidrawElement, } from "../element/types"; import { useCallbackRefState } from "../hooks/useCallbackRefState"; import { Language, t } from "../i18n"; import Excalidraw, { defaultLang, languages, } from "../packages/excalidraw/index"; import { AppState, LibraryItems, ExcalidrawImperativeAPI, BinaryFiles, } from "../types"; import { debounce, getVersion, getFrame, isTestEnv, preventUnload, ResolvablePromise, resolvablePromise, } from "../utils"; import { FIREBASE_STORAGE_PREFIXES, STORAGE_KEYS, SYNC_BROWSER_TABS_TIMEOUT, } from "./app_constants"; import CollabWrapper, { CollabAPI, CollabContext, CollabContextConsumer, } from "./collab/CollabWrapper"; import { LanguageList } from "./components/LanguageList"; import { exportToBackend, getCollaborationLinkData, loadScene } from "./data"; import { getLibraryItemsFromStorage, importFromLocalStorage, importUsernameFromLocalStorage, } from "./data/localStorage"; import CustomStats from "./CustomStats"; import { restoreAppState, RestoredDataState } from "../data/restore"; import { Tooltip } from "../components/Tooltip"; import { shield } from "../components/icons"; import "./index.scss"; import { ExportToExcalidrawPlus } from "./components/ExportToExcalidrawPlus"; import { updateStaleImageStatuses } from "./data/FileManager"; import { newElementWith } from "../element/mutateElement"; import { isInitializedImageElement } from "../element/typeChecks"; import { loadFilesFromFirebase } from "./data/firebase"; import { LocalData } from "./data/LocalData"; import { isBrowserStorageStateNewer } from "./data/tabSync"; import clsx from "clsx"; const languageDetector = new LanguageDetector(); languageDetector.init({ languageUtils: { formatLanguageCode: (langCode: Language["code"]) => langCode, isWhitelisted: () => true, }, checkWhitelist: false, }); const initializeScene = async (opts: { collabAPI: CollabAPI; }): Promise< { scene: ImportedDataState | null } & ( | { isExternalScene: true; id: string; key: string } | { isExternalScene: false; id?: null; key?: null } ) > => { const searchParams = new URLSearchParams(window.location.search); const id = searchParams.get("id"); const jsonBackendMatch = window.location.hash.match( /^#json=([a-zA-Z0-9_-]+),([a-zA-Z0-9_-]+)$/, ); const externalUrlMatch = window.location.hash.match(/^#url=(.*)$/); const localDataState = importFromLocalStorage(); let scene: RestoredDataState & { scrollToContent?: boolean; } = await loadScene(null, null, localDataState); let roomLinkData = getCollaborationLinkData(window.location.href); const isExternalScene = !!(id || jsonBackendMatch || roomLinkData); if (isExternalScene) { if ( // don't prompt if scene is empty !scene.elements.length || // don't prompt for collab scenes because we don't override local storage roomLinkData || // otherwise, prompt whether user wants to override current scene window.confirm(t("alerts.loadSceneOverridePrompt")) ) { if (jsonBackendMatch) { scene = await loadScene( jsonBackendMatch[1], jsonBackendMatch[2], localDataState, ); } scene.scrollToContent = true; if (!roomLinkData) { window.history.replaceState({}, APP_NAME, window.location.origin); } } else { // https://github.com/excalidraw/excalidraw/issues/1919 if (document.hidden) { return new Promise((resolve, reject) => { window.addEventListener( "focus", () => initializeScene(opts).then(resolve).catch(reject), { once: true, }, ); }); } roomLinkData = null; window.history.replaceState({}, APP_NAME, window.location.origin); } } else if (externalUrlMatch) { window.history.replaceState({}, APP_NAME, window.location.origin); const url = externalUrlMatch[1]; try { const request = await fetch(window.decodeURIComponent(url)); const data = await loadFromBlob(await request.blob(), null, null); if ( !scene.elements.length || window.confirm(t("alerts.loadSceneOverridePrompt")) ) { return { scene: data, isExternalScene }; } } catch (error: any) { return { scene: { appState: { errorMessage: t("alerts.invalidSceneUrl"), }, }, isExternalScene, }; } } if (roomLinkData) { return { scene: await opts.collabAPI.initializeSocketClient(roomLinkData), isExternalScene: true, id: roomLinkData.roomId, key: roomLinkData.roomKey, }; } else if (scene) { return isExternalScene && jsonBackendMatch ? { scene, isExternalScene, id: jsonBackendMatch[1], key: jsonBackendMatch[2], } : { scene, isExternalScene: false }; } return { scene: null, isExternalScene: false }; }; const PlusLinkJSX = (

Introducing Excalidraw+
Try out now!

); const ExcalidrawWrapper = () => { const [errorMessage, setErrorMessage] = useState(""); let currentLangCode = languageDetector.detect() || defaultLang.code; if (Array.isArray(currentLangCode)) { currentLangCode = currentLangCode[0]; } const [langCode, setLangCode] = useState(currentLangCode); // initial state // --------------------------------------------------------------------------- const initialStatePromiseRef = useRef<{ promise: ResolvablePromise; }>({ promise: null! }); if (!initialStatePromiseRef.current.promise) { initialStatePromiseRef.current.promise = resolvablePromise(); } useEffect(() => { trackEvent("load", "frame", getFrame()); // Delayed so that the app has a time to load the latest SW setTimeout(() => { trackEvent("load", "version", getVersion()); }, VERSION_TIMEOUT); }, []); const [excalidrawAPI, excalidrawRefCallback] = useCallbackRefState(); const collabAPI = useContext(CollabContext)?.api; useEffect(() => { if (!collabAPI || !excalidrawAPI) { return; } const loadImages = ( data: ResolutionType, isInitialLoad = false, ) => { if (!data.scene) { return; } if (collabAPI.isCollaborating()) { if (data.scene.elements) { collabAPI .fetchImageFilesFromFirebase({ elements: data.scene.elements, }) .then(({ loadedFiles, erroredFiles }) => { excalidrawAPI.addFiles(loadedFiles); updateStaleImageStatuses({ excalidrawAPI, erroredFiles, elements: excalidrawAPI.getSceneElementsIncludingDeleted(), }); }); } } else { const fileIds = data.scene.elements?.reduce((acc, element) => { if (isInitializedImageElement(element)) { return acc.concat(element.fileId); } return acc; }, [] as FileId[]) || []; if (data.isExternalScene) { loadFilesFromFirebase( `${FIREBASE_STORAGE_PREFIXES.shareLinkFiles}/${data.id}`, data.key, fileIds, ).then(({ loadedFiles, erroredFiles }) => { excalidrawAPI.addFiles(loadedFiles); updateStaleImageStatuses({ excalidrawAPI, erroredFiles, elements: excalidrawAPI.getSceneElementsIncludingDeleted(), }); }); } else if (isInitialLoad) { if (fileIds.length) { LocalData.fileStorage .getFiles(fileIds) .then(({ loadedFiles, erroredFiles }) => { if (loadedFiles.length) { excalidrawAPI.addFiles(loadedFiles); } updateStaleImageStatuses({ excalidrawAPI, erroredFiles, elements: excalidrawAPI.getSceneElementsIncludingDeleted(), }); }); } // on fresh load, clear unused files from IDB (from previous // session) LocalData.fileStorage.clearObsoleteFiles({ currentFileIds: fileIds }); } } data.scene.libraryItems = getLibraryItemsFromStorage(); }; initializeScene({ collabAPI }).then((data) => { loadImages(data, /* isInitialLoad */ true); initialStatePromiseRef.current.promise.resolve(data.scene); }); const onHashChange = (event: HashChangeEvent) => { event.preventDefault(); const hash = new URLSearchParams(window.location.hash.slice(1)); const libraryUrl = hash.get(URL_HASH_KEYS.addLibrary); if (libraryUrl) { // If hash changed and it contains library url, import it and replace // the url to its previous state (important in case of collaboration // and similar). // Using history API won't trigger another hashchange. window.history.replaceState({}, "", event.oldURL); excalidrawAPI.importLibrary(libraryUrl, hash.get("token")); } else { initializeScene({ collabAPI }).then((data) => { loadImages(data); if (data.scene) { excalidrawAPI.updateScene({ ...data.scene, appState: restoreAppState(data.scene.appState, null), }); } }); } }; const titleTimeout = setTimeout( () => (document.title = APP_NAME), TITLE_TIMEOUT, ); const syncData = debounce(() => { if (isTestEnv()) { return; } if (!document.hidden && !collabAPI.isCollaborating()) { // don't sync if local state is newer or identical to browser state if (isBrowserStorageStateNewer(STORAGE_KEYS.VERSION_DATA_STATE)) { const localDataState = importFromLocalStorage(); const username = importUsernameFromLocalStorage(); let langCode = languageDetector.detect() || defaultLang.code; if (Array.isArray(langCode)) { langCode = langCode[0]; } setLangCode(langCode); excalidrawAPI.updateScene({ ...localDataState, libraryItems: getLibraryItemsFromStorage(), }); collabAPI.setUsername(username || ""); } if (isBrowserStorageStateNewer(STORAGE_KEYS.VERSION_FILES)) { const elements = excalidrawAPI.getSceneElementsIncludingDeleted(); const currFiles = excalidrawAPI.getFiles(); const fileIds = elements?.reduce((acc, element) => { if ( isInitializedImageElement(element) && // only load and update images that aren't already loaded !currFiles[element.fileId] ) { return acc.concat(element.fileId); } return acc; }, [] as FileId[]) || []; if (fileIds.length) { LocalData.fileStorage .getFiles(fileIds) .then(({ loadedFiles, erroredFiles }) => { if (loadedFiles.length) { excalidrawAPI.addFiles(loadedFiles); } updateStaleImageStatuses({ excalidrawAPI, erroredFiles, elements: excalidrawAPI.getSceneElementsIncludingDeleted(), }); }); } } } }, SYNC_BROWSER_TABS_TIMEOUT); const onUnload = () => { LocalData.flushSave(); }; const visibilityChange = (event: FocusEvent | Event) => { if (event.type === EVENT.BLUR || document.hidden) { LocalData.flushSave(); } if ( event.type === EVENT.VISIBILITY_CHANGE || event.type === EVENT.FOCUS ) { syncData(); } }; window.addEventListener(EVENT.HASHCHANGE, onHashChange, false); window.addEventListener(EVENT.UNLOAD, onUnload, false); window.addEventListener(EVENT.BLUR, visibilityChange, false); document.addEventListener(EVENT.VISIBILITY_CHANGE, visibilityChange, false); window.addEventListener(EVENT.FOCUS, visibilityChange, false); return () => { window.removeEventListener(EVENT.HASHCHANGE, onHashChange, false); window.removeEventListener(EVENT.UNLOAD, onUnload, false); window.removeEventListener(EVENT.BLUR, visibilityChange, false); window.removeEventListener(EVENT.FOCUS, visibilityChange, false); document.removeEventListener( EVENT.VISIBILITY_CHANGE, visibilityChange, false, ); clearTimeout(titleTimeout); }; }, [collabAPI, excalidrawAPI]); useEffect(() => { const unloadHandler = (event: BeforeUnloadEvent) => { LocalData.flushSave(); if ( excalidrawAPI && LocalData.fileStorage.shouldPreventUnload( excalidrawAPI.getSceneElements(), ) ) { preventUnload(event); } }; window.addEventListener(EVENT.BEFORE_UNLOAD, unloadHandler); return () => { window.removeEventListener(EVENT.BEFORE_UNLOAD, unloadHandler); }; }, [excalidrawAPI]); useEffect(() => { languageDetector.cacheUserLanguage(langCode); }, [langCode]); const onChange = ( elements: readonly ExcalidrawElement[], appState: AppState, files: BinaryFiles, ) => { if (collabAPI?.isCollaborating()) { collabAPI.broadcastElements(elements); } // this check is redundant, but since this is a hot path, it's best // not to evaludate the nested expression every time if (!LocalData.isSavePaused()) { LocalData.save(elements, appState, files, () => { if (excalidrawAPI) { let didChange = false; let pendingImageElement = appState.pendingImageElement; const elements = excalidrawAPI .getSceneElementsIncludingDeleted() .map((element) => { if ( LocalData.fileStorage.shouldUpdateImageElementStatus(element) ) { didChange = true; const newEl = newElementWith(element, { status: "saved" }); if (pendingImageElement === element) { pendingImageElement = newEl; } return newEl; } return element; }); if (didChange) { excalidrawAPI.updateScene({ elements, appState: { pendingImageElement, }, }); } } }); } }; const onExportToBackend = async ( exportedElements: readonly NonDeletedExcalidrawElement[], appState: AppState, files: BinaryFiles, canvas: HTMLCanvasElement | null, ) => { if (exportedElements.length === 0) { return window.alert(t("alerts.cannotExportEmptyCanvas")); } if (canvas) { try { await exportToBackend( exportedElements, { ...appState, viewBackgroundColor: appState.exportBackground ? appState.viewBackgroundColor : getDefaultAppState().viewBackgroundColor, }, files, ); } catch (error: any) { if (error.name !== "AbortError") { const { width, height } = canvas; console.error(error, { width, height }); setErrorMessage(error.message); } } } }; const renderTopRightUI = useCallback( (isMobile: boolean, appState: AppState) => { if (isMobile) { return null; } return (
{/* */} {/* FIXME remove after 2021-05-20 */} {PlusLinkJSX}
); }, [], ); const renderFooter = useCallback( (isMobile: boolean) => { const renderEncryptedIcon = () => ( {shield} ); const renderLanguageList = () => ( setLangCode(langCode)} languages={languages} currentLangCode={langCode} /> ); if (isMobile) { const isTinyDevice = window.innerWidth < 362; return (
{t("labels.language")} {renderLanguageList()}
{/* FIXME remove after 2021-05-20 */}
{PlusLinkJSX}
); } return ( <> {renderEncryptedIcon()} {renderLanguageList()} ); }, [langCode], ); const renderCustomStats = () => { return ( excalidrawAPI!.setToastMessage(message)} /> ); }; const onLibraryChange = async (items: LibraryItems) => { if (!items.length) { localStorage.removeItem(STORAGE_KEYS.LOCAL_STORAGE_LIBRARY); return; } const serializedItems = JSON.stringify(items); localStorage.setItem(STORAGE_KEYS.LOCAL_STORAGE_LIBRARY, serializedItems); }; const onRoomClose = useCallback(() => { LocalData.fileStorage.reset(); }, []); return (
{ return ( { excalidrawAPI?.updateScene({ appState: { errorMessage: error.message, }, }); }} /> ); }, }, }, }} renderTopRightUI={renderTopRightUI} renderFooter={renderFooter} langCode={langCode} renderCustomStats={renderCustomStats} detectScroll={false} handleKeyboardGlobally={true} onLibraryChange={onLibraryChange} autoFocus={true} /> {excalidrawAPI && ( )} {errorMessage && ( setErrorMessage("")} /> )}
); }; const ExcalidrawApp = () => { return ( ); }; export default ExcalidrawApp;