import React, { useCallback, useRef, useState, useEffect, useMemo, } from 'react'; import EventEmitter from 'events'; import { pathUtils } from '@growi/core'; import Link from 'next/link'; import { useRouter } from 'next/router'; import { useTranslation } from 'react-i18next'; import urljoin from 'url-join'; import { useUpdateStateAfterSave, useSaveOrUpdate } from '~/client/services/page-operation'; import { apiPost } from '~/client/util/apiv1-client'; import { toastError, toastSuccess } from '~/client/util/toastr'; import { IResHackmdIntegrated, IResHackmdDiscard } from '~/interfaces/hackmd'; import { OptionsToSave } from '~/interfaces/page-operation'; import { useCurrentPathname, useHackmdUri, } from '~/stores/context'; import { useIsSlackEnabled, usePageTagsForEditors, useIsEnabledUnsavedWarning, useWaitingSaveProcessing, } from '~/stores/editor'; import { usePageIdOnHackmd, useHasDraftOnHackmd, useRevisionIdHackmdSynced, useIsHackmdDraftUpdatingInRealtime, } from '~/stores/hackmd'; import { useCurrentPagePath, useSWRMUTxCurrentPage, useSWRxCurrentPage, useSWRxTagsInfo, useCurrentPageId, useIsNotFound, } from '~/stores/page'; import { mutatePageTree } from '~/stores/page-listing'; import { useRemoteRevisionId } from '~/stores/remote-latest-page'; import { EditorMode, useEditorMode, useSelectedGrant, } from '~/stores/ui'; import loggerFactory from '~/utils/logger'; import HackmdEditor from './PageEditorByHackmd/HackmdEditor'; const logger = loggerFactory('growi:PageEditorByHackmd'); declare global { // eslint-disable-next-line vars-on-top, no-var var globalEmitter: EventEmitter; } type HackEditorRef = { getValue: () => Promise }; export const PageEditorByHackmd = (): JSX.Element => { const { t } = useTranslation(); const router = useRouter(); const { data: isNotFound } = useIsNotFound(); const { mutate: mutateWaitingSaveProcessing } = useWaitingSaveProcessing(); const { data: editorMode, mutate: mutateEditorMode } = useEditorMode(); const { data: currentPagePath } = useCurrentPagePath(); const { data: currentPathname } = useCurrentPathname(); const { data: isSlackEnabled } = useIsSlackEnabled(); const { data: pageId } = useCurrentPageId(); const { data: pageTags } = usePageTagsForEditors(pageId); const { mutate: mutateTagsInfo } = useSWRxTagsInfo(pageId); const { data: grantData } = useSelectedGrant(); const { data: hackmdUri } = useHackmdUri(); const saveOrUpdate = useSaveOrUpdate(); const { returnPathForURL } = pathUtils; // pageData const { data: pageData } = useSWRxCurrentPage(); const { trigger: mutatePageData } = useSWRMUTxCurrentPage(); const revision = pageData?.revision; const [isInitialized, setIsInitialized] = useState(false); const [isInitializing, setIsInitializing] = useState(false); // for error const [hasError, setHasError] = useState(false); const [errorMessage, setErrorMessage] = useState(''); const [errorReason, setErrorReason] = useState(''); // state from pageContainer const { data: pageIdOnHackmd, mutate: mutatePageIdOnHackmd } = usePageIdOnHackmd(); const { data: hasDraftOnHackmd, mutate: mutateHasDraftOnHackmd } = useHasDraftOnHackmd(); const { data: revisionIdHackmdSynced, mutate: mutateRevisionIdHackmdSynced } = useRevisionIdHackmdSynced(); const { mutate: mutateIsEnabledUnsavedWarning } = useIsEnabledUnsavedWarning(); const { data: isHackmdDraftUpdatingInRealtime, mutate: mutateIsHackmdDraftUpdatingInRealtime } = useIsHackmdDraftUpdatingInRealtime(); const { data: remoteRevisionId, mutate: mutateRemoteRevisionId } = useRemoteRevisionId(); const updateStateAfterSave = useUpdateStateAfterSave(pageId); const hackmdEditorRef = useRef(null); const optionsToSave = useMemo((): OptionsToSave | undefined => { if (grantData == null) { return; } const optionsToSave = { isSlackEnabled: isSlackEnabled ?? false, slackChannels: '', // set in save method by opts in SavePageControlls.tsx grant: grantData.grant, pageTags: pageTags ?? [], grantUserGroupId: grantData.grantedGroup?.id, grantUserGroupName: grantData.grantedGroup?.name, }; return optionsToSave; }, [grantData, isSlackEnabled, pageTags]); const saveAndReturnToViewHandler = useCallback(async(opts?: {overwriteScopesOfDescendants: boolean}) => { if (editorMode !== EditorMode.HackMD) { return } try { if (currentPathname == null || revision == null || hackmdEditorRef.current == null || revisionIdHackmdSynced == null || optionsToSave == null) { throw new Error('Some materials to save are invalid'); } mutateWaitingSaveProcessing(true); const options = Object.assign(optionsToSave, opts, { isSyncRevisionToHackmd: true }); const markdown = await hackmdEditorRef.current.getValue(); const { page } = await saveOrUpdate(markdown, { pageId, path: currentPagePath || currentPathname, revisionId: revisionIdHackmdSynced }, options); if (page == null) { return; } if (isNotFound) { await router.push(`/${page._id}`); } else { updateStateAfterSave?.(); mutateIsHackmdDraftUpdatingInRealtime(false); // to sync revision id with page tree: https://github.com/weseek/growi/pull/7227 mutatePageTree(); } setIsInitialized(false); mutateEditorMode(EditorMode.View); } catch (error) { logger.error('failed to save', error); toastError(error.message); } finally { mutateWaitingSaveProcessing(false); } // eslint-disable-next-line max-len }, [ pageId, currentPagePath, isNotFound, router, editorMode, currentPathname, revision, revisionIdHackmdSynced, optionsToSave, saveOrUpdate, mutateEditorMode, updateStateAfterSave, mutateIsHackmdDraftUpdatingInRealtime, mutateWaitingSaveProcessing, ]); // set handler to save and reload Page useEffect(() => { globalEmitter.on('saveAndReturnToView', saveAndReturnToViewHandler); return function cleanup() { globalEmitter.removeListener('saveAndReturnToView', saveAndReturnToViewHandler); }; }, [saveAndReturnToViewHandler]); const resetInitializedStatusHandler = useCallback(() => { setIsInitialized(false); }, []); // set handler to save and reload Page useEffect(() => { globalEmitter.on('resetInitializedHackMdStatus', resetInitializedStatusHandler); return function cleanup() { globalEmitter.removeListener('resetInitializedHackMdStatus', resetInitializedStatusHandler); }; }, [resetInitializedStatusHandler]); useEffect(() => { // for page translation: https://github.com/weseek/growi/pull/7100 setIsInitialized(false); }, [pageId]); const isResume = useCallback(() => { const isPageExistsOnHackmd = (pageIdOnHackmd != null); return (isPageExistsOnHackmd && hasDraftOnHackmd) || isHackmdDraftUpdatingInRealtime; }, [hasDraftOnHackmd, isHackmdDraftUpdatingInRealtime, pageIdOnHackmd]); const startToEdit = useCallback(async() => { if (hackmdUri == null) { // do nothing return; } setIsInitialized(false); setIsInitializing(true); try { const res = await apiPost('/hackmd.integrate', { pageId }); if (!res.ok) { throw new Error(res.error); } mutatePageIdOnHackmd(res.pageIdOnHackmd); mutateRevisionIdHackmdSynced(res.revisionIdHackmdSynced); } catch (err) { toastError(err.message); setHasError(true); setErrorMessage('GROWI server failed to connect to HackMD.'); setErrorReason(err.toString()); } setIsInitialized(true); setIsInitializing(false); }, [pageId, hackmdUri, mutatePageIdOnHackmd, mutateRevisionIdHackmdSynced]); /** * Start to edit w/o any api request */ const resumeToEdit = useCallback(() => { setIsInitialized(true); }, []); const discardChanges = useCallback(async() => { if (pageId == null) { return } try { const res = await apiPost('/hackmd.discard', { pageId }); if (!res.ok) { throw new Error(res.error); } mutateIsHackmdDraftUpdatingInRealtime(false); mutateHasDraftOnHackmd(false); mutatePageIdOnHackmd(res.pageIdOnHackmd); mutateRemoteRevisionId(res.revisionIdHackmdSynced); mutateRevisionIdHackmdSynced(res.revisionIdHackmdSynced); } catch (err) { logger.error(err); toastError(err.message); } }, [mutateIsHackmdDraftUpdatingInRealtime, mutateHasDraftOnHackmd, mutatePageIdOnHackmd, mutateRevisionIdHackmdSynced, mutateRemoteRevisionId, pageId]); /** * save and update state of containers * @param {string} markdown */ const onSaveWithShortcut = useCallback(async(markdown) => { try { mutateWaitingSaveProcessing(true); const currentPagePathOrPathname = currentPagePath || currentPathname; if ( pageId == null || revisionIdHackmdSynced == null || currentPagePathOrPathname == null || optionsToSave == null ) { throw new Error('Some materials to save are invalid') } const options = Object.assign(optionsToSave, { isSyncRevisionToHackmd: true }); const res = await saveOrUpdate(markdown, { pageId, path: currentPagePathOrPathname, revisionId: revisionIdHackmdSynced }, options); // update pageData mutatePageData(res); // set updated data updateStateAfterSave?.(); mutateTagsInfo(); // to sync revision id with page tree: https://github.com/weseek/growi/pull/7227 mutatePageTree(); mutateIsEnabledUnsavedWarning(false); logger.debug('success to save'); toastSuccess(t('successfully_saved_the_page')); } catch (error) { logger.error('failed to save', error); toastError(error.message); } finally { mutateWaitingSaveProcessing(false); } // eslint-disable-next-line max-len }, [ currentPagePath, currentPathname, pageId, revisionIdHackmdSynced, optionsToSave, saveOrUpdate, mutateWaitingSaveProcessing, mutatePageData, updateStateAfterSave, mutateTagsInfo, mutateIsEnabledUnsavedWarning, t, ]); /** * onChange event of HackmdEditor handler */ const hackmdEditorChangeHandler = useCallback(async(body) => { if (hackmdUri == null || pageId == null) { // do nothing return; } if (revision?.body === body) { return; } mutateIsEnabledUnsavedWarning(true); try { await apiPost('/hackmd.saveOnHackmd', { pageId }); } catch (err) { logger.error(err); } }, [hackmdUri, pageId, revision?.body, mutateIsEnabledUnsavedWarning]); const penpalErrorOccuredHandler = useCallback((error) => { toastError(error.message); setHasError(true); setErrorMessage(t('hackmd.fail_to_connect')); setErrorReason(error.toString()); }, [t]); const renderPreInitContent = useCallback(() => { const isPageNotFound = pageId == null; let content; /* * HackMD is not setup */ if (hackmdUri == null) { content = (

{ t('hackmd.not_set_up')}

{/* eslint-disable-next-line react/no-danger */}

); } /* * used HackMD from NotFound Page */ else if (isPageNotFound) { content = (

{ t('hackmd.used_for_not_found') }

{/* eslint-disable-next-line react/no-danger */}

); } /* * Resume to edit or discard changes */ else if (isResume()) { const isHackmdDocumentOutdated = revisionIdHackmdSynced !== remoteRevisionId; content = (

HackMD is READY!

{t('hackmd.unsaved_draft')}

{ isHackmdDocumentOutdated && (
{t('hackmd.draft_outdated')}
{t('hackmd.based_on_revision')}  { pageData != null && ( {revisionIdHackmdSynced?.substr(-8)} )}
) } { !isHackmdDocumentOutdated && (
) }
); } /* * Start to edit */ else { const isRevisionOutdated = revision?._id !== remoteRevisionId; content = (

HackMD is READY!

{t('hackmd.clone_page_content')}

); } return (
{content}
); // eslint-disable-next-line max-len }, [pageId, hackmdUri, isResume, t, revisionIdHackmdSynced, remoteRevisionId, pageData, returnPathForURL, isInitializing, resumeToEdit, discardChanges, revision?._id, startToEdit]); if (editorMode == null || revision == null) { return <>; } let content; // TODO: typescriptize // using any because ref cann't used between FC and class conponent with type safe const AnyEditor = HackmdEditor as any; if (isInitialized && hackmdUri != null) { content = ( { onSaveWithShortcut(document); }} onPenpalErrorOccured={penpalErrorOccuredHandler} > ); } else { content = renderPreInitContent(); } return (
{content} { hasError && (

{t('hackmd.integration_failed')}

{errorMessage}

{errorReason}

{/* eslint-disable-next-line react/no-danger */}

) }
); };