PageRenameModal.tsx 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357
  1. import React, {
  2. useState, useEffect, useCallback, useMemo,
  3. } from 'react';
  4. import { pagePathUtils } from '@growi/core';
  5. import { useTranslation } from 'react-i18next';
  6. import {
  7. Collapse, Modal, ModalHeader, ModalBody, ModalFooter,
  8. } from 'reactstrap';
  9. import { debounce } from 'throttle-debounce';
  10. import { toastError } from '~/client/util/apiNotification';
  11. import { apiv3Get, apiv3Put } from '~/client/util/apiv3-client';
  12. import { isIPageInfoForEntity } from '~/interfaces/page';
  13. import { useSiteUrl, useIsSearchServiceReachable } from '~/stores/context';
  14. import { usePageRenameModal } from '~/stores/modal';
  15. import { useSWRxPageInfo } from '~/stores/page';
  16. import DuplicatedPathsTable from './DuplicatedPathsTable';
  17. import ApiErrorMessageList from './PageManagement/ApiErrorMessageList';
  18. import PagePathAutoComplete from './PagePathAutoComplete';
  19. const isV5Compatible = (meta: unknown): boolean => {
  20. return isIPageInfoForEntity(meta) ? meta.isV5Compatible : true;
  21. };
  22. const PageRenameModal = (): JSX.Element => {
  23. const { t } = useTranslation();
  24. const { isUsersHomePage } = pagePathUtils;
  25. const { data: siteUrl } = useSiteUrl();
  26. const { data: renameModalData, close: closeRenameModal } = usePageRenameModal();
  27. const { data: isReachable } = useIsSearchServiceReachable();
  28. const isOpened = renameModalData?.isOpened ?? false;
  29. const page = renameModalData?.page;
  30. const shouldFetch = isOpened && page != null && !isIPageInfoForEntity(page.meta);
  31. const { data: pageInfo } = useSWRxPageInfo(shouldFetch ? page?.data._id : null);
  32. if (page != null && pageInfo != null) {
  33. page.meta = pageInfo;
  34. }
  35. const [pageNameInput, setPageNameInput] = useState('');
  36. const [errs, setErrs] = useState(null);
  37. const [subordinatedPages, setSubordinatedPages] = useState([]);
  38. const [existingPaths, setExistingPaths] = useState<string[]>([]);
  39. const [canRename, setCanRename] = useState(false);
  40. const [isRenameRecursively, setIsRenameRecursively] = useState(true);
  41. const [isRenameRedirect, setIsRenameRedirect] = useState(false);
  42. const [isRemainMetadata, setIsRemainMetadata] = useState(false);
  43. const [expandOtherOptions, setExpandOtherOptions] = useState(false);
  44. const [subordinatedError] = useState(null);
  45. const [isMatchedWithUserHomePagePath, setIsMatchedWithUserHomePagePath] = useState(false);
  46. const updateSubordinatedList = useCallback(async() => {
  47. if (page == null) {
  48. return;
  49. }
  50. const { path } = page.data;
  51. try {
  52. const res = await apiv3Get('/pages/subordinated-list', { path });
  53. setSubordinatedPages(res.data.subordinatedPages);
  54. }
  55. catch (err) {
  56. setErrs(err);
  57. toastError(t('modal_rename.label.Failed to get subordinated pages'));
  58. }
  59. }, [page, t]);
  60. useEffect(() => {
  61. if (page != null && isOpened) {
  62. updateSubordinatedList();
  63. setPageNameInput(page.data.path);
  64. }
  65. }, [isOpened, page, updateSubordinatedList]);
  66. const rename = useCallback(async() => {
  67. if (page == null || !canRename) {
  68. return;
  69. }
  70. const _isV5Compatible = isV5Compatible(page.meta);
  71. setErrs(null);
  72. const { _id, path, revision } = page.data;
  73. try {
  74. const response = await apiv3Put('/pages/rename', {
  75. pageId: _id,
  76. revisionId: revision ?? null,
  77. isRecursively: !_isV5Compatible ? isRenameRecursively : undefined,
  78. isRenameRedirect,
  79. updateMetadata: !isRemainMetadata,
  80. newPagePath: pageNameInput,
  81. path,
  82. });
  83. const { page } = response.data;
  84. const url = new URL(page.path, 'https://dummy');
  85. if (isRenameRedirect) {
  86. url.searchParams.append('withRedirect', 'true');
  87. }
  88. const onRenamed = renameModalData?.opts?.onRenamed;
  89. if (onRenamed != null) {
  90. onRenamed(path);
  91. }
  92. closeRenameModal();
  93. }
  94. catch (err) {
  95. setErrs(err);
  96. }
  97. }, [closeRenameModal, canRename, isRemainMetadata, isRenameRecursively, isRenameRedirect, page, pageNameInput, renameModalData?.opts?.onRenamed]);
  98. const checkExistPaths = useCallback(async(fromPath, toPath) => {
  99. if (page == null) {
  100. return;
  101. }
  102. try {
  103. const res = await apiv3Get<{ existPaths: string[]}>('/page/exist-paths', { fromPath, toPath });
  104. const { existPaths } = res.data;
  105. if (existPaths.length === 0) {
  106. setCanRename(true);
  107. }
  108. setExistingPaths(existPaths);
  109. }
  110. catch (err) {
  111. setErrs(err);
  112. toastError(t('modal_rename.label.Failed to get exist path'));
  113. }
  114. }, [page, t]);
  115. const checkExistPathsDebounce = useMemo(() => {
  116. return debounce(1000, checkExistPaths);
  117. }, [checkExistPaths]);
  118. const checkIsUsersHomePageDebounce = useMemo(() => {
  119. const checkIsPagePathRenameable = () => {
  120. setIsMatchedWithUserHomePagePath(isUsersHomePage(pageNameInput));
  121. };
  122. return debounce(1000, checkIsPagePathRenameable);
  123. }, [isUsersHomePage, pageNameInput]);
  124. useEffect(() => {
  125. if (page != null && pageNameInput !== page.data.path) {
  126. checkExistPathsDebounce(page.data.path, pageNameInput);
  127. checkIsUsersHomePageDebounce(pageNameInput);
  128. }
  129. }, [pageNameInput, subordinatedPages, checkExistPathsDebounce, page, checkIsUsersHomePageDebounce]);
  130. useEffect(() => {
  131. setCanRename(false);
  132. }, [pageNameInput]);
  133. function ppacInputChangeHandler(value) {
  134. setErrs(null);
  135. setPageNameInput(value);
  136. }
  137. /**
  138. * change pageNameInput
  139. * @param {string} value
  140. */
  141. function inputChangeHandler(value) {
  142. setErrs(null);
  143. setPageNameInput(value);
  144. }
  145. useEffect(() => {
  146. if (isOpened) {
  147. return;
  148. }
  149. // reset states after the modal closed
  150. setTimeout(() => {
  151. setPageNameInput('');
  152. setErrs(null);
  153. setSubordinatedPages([]);
  154. setExistingPaths([]);
  155. setIsRenameRecursively(true);
  156. setIsRenameRedirect(false);
  157. setIsRemainMetadata(false);
  158. setExpandOtherOptions(false);
  159. }, 1000);
  160. }, [isOpened]);
  161. if (page == null) {
  162. return <></>;
  163. }
  164. const { path } = page.data;
  165. const isTargetPageDuplicate = existingPaths.includes(pageNameInput);
  166. let submitButtonDisabled = false;
  167. if (isMatchedWithUserHomePagePath) {
  168. submitButtonDisabled = true;
  169. }
  170. else if (!canRename) {
  171. submitButtonDisabled = true;
  172. }
  173. else if (isV5Compatible(page.meta)) {
  174. submitButtonDisabled = existingPaths.length !== 0; // v5 data
  175. }
  176. else {
  177. submitButtonDisabled = !isRenameRecursively; // v4 data
  178. }
  179. return (
  180. <Modal size="lg" isOpen={isOpened} toggle={closeRenameModal} data-testid="page-rename-modal" autoFocus={false}>
  181. <ModalHeader tag="h4" toggle={closeRenameModal} className="bg-primary text-light">
  182. { t('modal_rename.label.Move/Rename page') }
  183. </ModalHeader>
  184. <ModalBody>
  185. <div className="form-group">
  186. <label>{ t('modal_rename.label.Current page name') }</label><br />
  187. <code>{ path }</code>
  188. </div>
  189. <div className="form-group">
  190. <label htmlFor="newPageName">{ t('modal_rename.label.New page name') }</label><br />
  191. <div className="input-group">
  192. <div className="input-group-prepend">
  193. <span className="input-group-text">{siteUrl}</span>
  194. </div>
  195. <form className="flex-fill" onSubmit={(e) => { e.preventDefault(); rename() }}>
  196. {isReachable
  197. ? (
  198. <PagePathAutoComplete
  199. initializedPath={path}
  200. onSubmit={rename}
  201. onInputChange={ppacInputChangeHandler}
  202. autoFocus
  203. />
  204. )
  205. : (
  206. <input
  207. type="text"
  208. value={pageNameInput}
  209. className="form-control"
  210. onChange={e => inputChangeHandler(e.target.value)}
  211. required
  212. autoFocus
  213. />
  214. )}
  215. </form>
  216. </div>
  217. </div>
  218. { isTargetPageDuplicate && (
  219. <p className="text-danger">Error: Target path is duplicated.</p>
  220. ) }
  221. { isMatchedWithUserHomePagePath && (
  222. <p className="text-danger">Error: Cannot move to directory under /user page.</p>
  223. ) }
  224. { !isV5Compatible(page.meta) && (
  225. <>
  226. <div className="custom-control custom-radio custom-radio-warning">
  227. <input
  228. className="custom-control-input"
  229. name="recursively"
  230. id="cbRenameThisPageOnly"
  231. type="radio"
  232. checked={!isRenameRecursively}
  233. onChange={() => setIsRenameRecursively(!isRenameRecursively)}
  234. />
  235. <label className="custom-control-label" htmlFor="cbRenameThisPageOnly">
  236. { t('modal_rename.label.Rename this page only') }
  237. </label>
  238. </div>
  239. <div className="custom-control custom-radio custom-radio-warning mt-1">
  240. <input
  241. className="custom-control-input"
  242. name="withoutExistRecursively"
  243. id="cbForceRenameRecursively"
  244. type="radio"
  245. checked={isRenameRecursively}
  246. onChange={() => setIsRenameRecursively(!isRenameRecursively)}
  247. />
  248. <label className="custom-control-label" htmlFor="cbForceRenameRecursively">
  249. { t('modal_rename.label.Force rename all child pages') }
  250. <p className="form-text text-muted mt-0">{ t('modal_rename.help.recursive') }</p>
  251. </label>
  252. {isRenameRecursively && existingPaths.length !== 0 && (
  253. <DuplicatedPathsTable existingPaths={existingPaths} fromPath={path} toPath={pageNameInput} />
  254. ) }
  255. </div>
  256. </>
  257. ) }
  258. <p className="mt-2">
  259. <button type="button" className="btn btn-link mt-2 p-0" aria-expanded="false" onClick={() => setExpandOtherOptions(!expandOtherOptions)}>
  260. <i className={`fa fa-fw fa-arrow-right ${expandOtherOptions ? 'fa-rotate-90' : ''}`}></i>
  261. { t('modal_rename.label.Other options') }
  262. </button>
  263. </p>
  264. <Collapse isOpen={expandOtherOptions}>
  265. <div className="custom-control custom-checkbox custom-checkbox-success">
  266. <input
  267. className="custom-control-input"
  268. name="create_redirect"
  269. id="cbRenameRedirect"
  270. type="checkbox"
  271. checked={isRenameRedirect}
  272. onChange={() => setIsRenameRedirect(!isRenameRedirect)}
  273. />
  274. <label className="custom-control-label" htmlFor="cbRenameRedirect">
  275. { t('modal_rename.label.Redirect') }
  276. <p className="form-text text-muted mt-0">{ t('modal_rename.help.redirect') }</p>
  277. </label>
  278. </div>
  279. <div className="custom-control custom-checkbox custom-checkbox-primary">
  280. <input
  281. className="custom-control-input"
  282. name="remain_metadata"
  283. id="cbRemainMetadata"
  284. type="checkbox"
  285. checked={isRemainMetadata}
  286. onChange={() => setIsRemainMetadata(!isRemainMetadata)}
  287. />
  288. <label className="custom-control-label" htmlFor="cbRemainMetadata">
  289. { t('modal_rename.label.Do not update metadata') }
  290. <p className="form-text text-muted mt-0">{ t('modal_rename.help.metadata') }</p>
  291. </label>
  292. </div>
  293. <div> {subordinatedError} </div>
  294. </Collapse>
  295. </ModalBody>
  296. <ModalFooter>
  297. <ApiErrorMessageList errs={errs} targetPath={pageNameInput} />
  298. <button
  299. type="button"
  300. className="btn btn-primary"
  301. onClick={rename}
  302. disabled={submitButtonDisabled}
  303. >Rename
  304. </button>
  305. </ModalFooter>
  306. </Modal>
  307. );
  308. };
  309. export default PageRenameModal;