PrivateLegacyPages.tsx 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505
  1. import React, {
  2. type JSX,
  3. useCallback,
  4. useEffect,
  5. useMemo,
  6. useRef,
  7. useState,
  8. } from 'react';
  9. import { useGlobalSocket } from '@growi/core/dist/swr';
  10. import { LoadingSpinner } from '@growi/ui/dist/components';
  11. import { useTranslation } from 'next-i18next';
  12. import {
  13. DropdownItem,
  14. DropdownMenu,
  15. DropdownToggle,
  16. Modal,
  17. ModalBody,
  18. ModalFooter,
  19. ModalHeader,
  20. UncontrolledButtonDropdown,
  21. } from 'reactstrap';
  22. import { MenuItemType } from '~/client/components/Common/Dropdown/PageItemControl';
  23. import PaginationWrapper from '~/client/components/PaginationWrapper';
  24. import { PrivateLegacyPagesMigrationModal } from '~/client/components/PrivateLegacyPagesMigrationModal';
  25. import type { ISelectableAll, ISelectableAndIndeterminatable } from '~/client/interfaces/selectable-all';
  26. import { apiv3Post } from '~/client/util/apiv3-client';
  27. import { toastError, toastSuccess } from '~/client/util/toastr';
  28. import { V5ConversionErrCode } from '~/interfaces/errors/v5-conversion-error';
  29. import type { V5MigrationStatus } from '~/interfaces/page-listing-results';
  30. import type { IFormattedSearchResult } from '~/interfaces/search';
  31. import type { PageMigrationErrorData } from '~/interfaces/websocket';
  32. import { SocketEventName } from '~/interfaces/websocket';
  33. import { useIsAdmin } from '~/states/context';
  34. import type { ILegacyPrivatePage } from '~/states/ui/modal/private-legacy-pages-migration';
  35. import { usePrivateLegacyPagesMigrationModalActions } from '~/states/ui/modal/private-legacy-pages-migration';
  36. import {
  37. mutatePageTree,
  38. useSWRxV5MigrationStatus,
  39. } from '~/stores/page-listing';
  40. import { useSWRxSearch } from '~/stores/search';
  41. import { OperateAllControl } from './SearchPage/OperateAllControl';
  42. import SearchControl from './SearchPage/SearchControl';
  43. import { IReturnSelectedPageIds, SearchPageBase, usePageDeleteModalForBulkDeletion } from './SearchPage/SearchPageBase';
  44. // TODO: replace with "customize:showPageLimitationS"
  45. const INITIAL_PAGING_SIZE = 20;
  46. const initQ = '/';
  47. /**
  48. * SearchResultListHead
  49. */
  50. type SearchResultListHeadProps = {
  51. searchResult: IFormattedSearchResult,
  52. offset: number,
  53. pagingSize: number,
  54. onPagingSizeChanged: (size: number) => void,
  55. migrationStatus?: V5MigrationStatus,
  56. }
  57. const SearchResultListHead = React.memo((props: SearchResultListHeadProps): JSX.Element => {
  58. const { t } = useTranslation();
  59. const {
  60. searchResult, offset, pagingSize,
  61. onPagingSizeChanged, migrationStatus,
  62. } = props;
  63. if (migrationStatus == null) {
  64. return (
  65. <div className="mw-0 flex-grow-1 flex-basis-0 m-5 text-muted text-center">
  66. <LoadingSpinner className="me-1 fs-3" />
  67. </div>
  68. );
  69. }
  70. const { took, total, hitsCount } = searchResult.meta;
  71. const leftNum = offset + 1;
  72. const rightNum = offset + hitsCount;
  73. const isSuccess = migrationStatus.migratablePagesCount === 0;
  74. if (isSuccess) {
  75. return (
  76. <div className="card border-success mt-3" data-testid="search-result-private-legacy-pages">
  77. <div className="card-body">
  78. <h2 className="card-title text-success">{t('private_legacy_pages.nopages_title')}</h2>
  79. <p className="card-text">
  80. {t('private_legacy_pages.nopages_desc1')}<br />
  81. {/** biome-ignore lint/security/noDangerouslySetInnerHtml: ignore */}
  82. <span dangerouslySetInnerHTML={{ __html: t('private_legacy_pages.detail_info') }}></span>
  83. </p>
  84. </div>
  85. </div>
  86. );
  87. }
  88. return (
  89. <>
  90. <div className="d-flex align-items-center justify-content-between">
  91. <div className="text-nowrap">
  92. {t('search_result.result_meta')}
  93. <span className="ms-3">{`${leftNum}-${rightNum}`} / {total}</span>
  94. { took != null && (
  95. <span className="ms-3 text-muted">({took}ms)</span>
  96. ) }
  97. </div>
  98. <div className="input-group flex-nowrap search-result-select-group ms-auto d-md-flex d-none">
  99. <div>
  100. <label className="form-label input-group-text text-muted" htmlFor="inputGroupSelect01">{t('search_result.number_of_list_to_display')}</label>
  101. </div>
  102. <select
  103. defaultValue={pagingSize}
  104. className="form-select"
  105. id="inputGroupSelect01"
  106. onChange={e => onPagingSizeChanged(Number(e.target.value))}
  107. >
  108. {[20, 50, 100, 200].map((limit) => {
  109. return <option key={limit} value={limit}>{limit} {t('search_result.page_number_unit')}</option>;
  110. })}
  111. </select>
  112. </div>
  113. </div>
  114. <div className="card border-warning mt-3">
  115. <div className="card-body">
  116. <h2 className="card-title text-warning">{t('private_legacy_pages.alert_title')}</h2>
  117. <p className="card-text">
  118. {t('private_legacy_pages.alert_desc1', { delete_all_selected_page: t('search_result.delete_all_selected_page') })}<br />
  119. {/** biome-ignore lint/security/noDangerouslySetInnerHtml: ignore */}
  120. <span dangerouslySetInnerHTML={{ __html: t('private_legacy_pages.detail_info') }}></span>
  121. </p>
  122. </div>
  123. </div>
  124. </>
  125. );
  126. });
  127. SearchResultListHead.displayName = 'SearchResultListHead';
  128. /*
  129. * ConvertByPathModal
  130. */
  131. type ConvertByPathModalProps = {
  132. isOpen: boolean,
  133. close?: () => void,
  134. onSubmit?: (convertPath: string) => Promise<void> | void,
  135. }
  136. const ConvertByPathModal = React.memo((props: ConvertByPathModalProps): JSX.Element => {
  137. const { t } = useTranslation();
  138. const [currentInput, setInput] = useState<string>('');
  139. const [checked, setChecked] = useState<boolean>(false);
  140. useEffect(() => {
  141. setChecked(false);
  142. }, []);
  143. return (
  144. <Modal size="lg" isOpen={props.isOpen} toggle={props.close}>
  145. <ModalHeader tag="h4" toggle={props.close}>
  146. { t('private_legacy_pages.by_path_modal.title') }
  147. </ModalHeader>
  148. <ModalBody>
  149. <p>{t('private_legacy_pages.by_path_modal.description')}</p>
  150. <input type="text" className="form-control" placeholder="/" value={currentInput} onChange={e => setInput(e.target.value)} />
  151. <div className="alert alert-danger mt-3" role="alert">
  152. { t('private_legacy_pages.by_path_modal.alert') }
  153. </div>
  154. </ModalBody>
  155. <ModalFooter>
  156. <div className="form-check">
  157. <input
  158. className="form-check-input"
  159. type="checkbox"
  160. id="understoodCheckbox"
  161. onChange={e => setChecked(e.target.checked)}
  162. />
  163. <label className="form-label form-check-label" htmlFor="understoodCheckbox">{ t('private_legacy_pages.by_path_modal.checkbox_label') }</label>
  164. </div>
  165. <button
  166. type="button"
  167. className="btn btn-primary"
  168. disabled={!checked}
  169. onClick={() => props.onSubmit?.(currentInput)}
  170. >
  171. <span className="material-symbols-outlined" aria-hidden="true">refresh</span>
  172. { t('private_legacy_pages.by_path_modal.button_label') }
  173. </button>
  174. </ModalFooter>
  175. </Modal>
  176. );
  177. });
  178. ConvertByPathModal.displayName = 'ConvertByPathModal';
  179. /**
  180. * LegacyPage
  181. */
  182. const PrivateLegacyPages = (): JSX.Element => {
  183. const { t } = useTranslation();
  184. const isAdmin = useIsAdmin();
  185. const [keyword, setKeyword] = useState<string>(initQ);
  186. const [offset, setOffset] = useState<number>(0);
  187. const [limit, setLimit] = useState<number>(INITIAL_PAGING_SIZE);
  188. const [isOpenConvertModal, setOpenConvertModal] = useState<boolean>(false);
  189. const [isControlEnabled, setControlEnabled] = useState(false);
  190. const selectAllControlRef = useRef<ISelectableAndIndeterminatable|null>(null);
  191. const searchPageBaseRef = useRef<ISelectableAll & IReturnSelectedPageIds|null>(null);
  192. const { data, conditions, mutate } = useSWRxSearch(keyword, 'PrivateLegacyPages', {
  193. offset,
  194. limit,
  195. includeUserPages: true,
  196. includeTrashPages: false,
  197. });
  198. const { data: migrationStatus, mutate: mutateMigrationStatus } = useSWRxV5MigrationStatus();
  199. const searchInvokedHandler = useCallback((_keyword: string) => {
  200. mutateMigrationStatus();
  201. setKeyword(_keyword);
  202. setOffset(0);
  203. }, [mutateMigrationStatus]);
  204. const { open: openModal, close: closeModal } = usePrivateLegacyPagesMigrationModalActions();
  205. const { data: socket } = useGlobalSocket();
  206. useEffect(() => {
  207. socket?.on(SocketEventName.PageMigrationSuccess, () => {
  208. toastSuccess(t('private_legacy_pages.toaster.page_migration_succeeded'));
  209. });
  210. socket?.on(SocketEventName.PageMigrationError, (data?: PageMigrationErrorData) => {
  211. if (data == null || data.paths.length === 0) {
  212. toastError(t('private_legacy_pages.toaster.page_migration_failed'));
  213. }
  214. else {
  215. const errorPaths = data.paths.length > 3
  216. ? `${data.paths.slice(0, 3).join(', ')}...`
  217. : data.paths.join(', ');
  218. toastError(t('private_legacy_pages.toaster.page_migration_failed_with_paths', { paths: errorPaths }));
  219. }
  220. });
  221. return () => {
  222. socket?.off(SocketEventName.PageMigrationSuccess);
  223. socket?.off(SocketEventName.PageMigrationError);
  224. };
  225. }, [socket, t]);
  226. const selectAllCheckboxChangedHandler = useCallback((isChecked: boolean) => {
  227. const instance = searchPageBaseRef.current;
  228. if (instance == null) {
  229. return;
  230. }
  231. if (isChecked) {
  232. instance.selectAll();
  233. setControlEnabled(true);
  234. }
  235. else {
  236. instance.deselectAll();
  237. setControlEnabled(false);
  238. }
  239. }, []);
  240. const selectedPagesByCheckboxesChangedHandler = useCallback((selectedCount: number, totalCount: number) => {
  241. const instance = selectAllControlRef.current;
  242. if (instance == null) {
  243. return;
  244. }
  245. if (selectedCount === 0) {
  246. instance.deselect();
  247. setControlEnabled(false);
  248. }
  249. else if (selectedCount === totalCount) {
  250. instance.select();
  251. setControlEnabled(true);
  252. }
  253. else {
  254. instance.setIndeterminate();
  255. setControlEnabled(true);
  256. }
  257. }, []);
  258. // for bulk deletion
  259. const deleteAllButtonClickedHandler = usePageDeleteModalForBulkDeletion(data, searchPageBaseRef, () => mutate());
  260. const convertMenuItemClickedHandler = useCallback(() => {
  261. if (data == null) {
  262. return;
  263. }
  264. const instance = searchPageBaseRef.current;
  265. if (instance == null || instance.getSelectedPageIds == null) {
  266. return;
  267. }
  268. const selectedPageIds = instance.getSelectedPageIds();
  269. if (selectedPageIds.size === 0) {
  270. return;
  271. }
  272. const selectedPages = data.data
  273. .filter(pageWithMeta => selectedPageIds.has(pageWithMeta.data._id))
  274. .map(pageWithMeta => ({ pageId: pageWithMeta.data._id, path: pageWithMeta.data.path } as ILegacyPrivatePage));
  275. openModal(
  276. selectedPages,
  277. () => {
  278. toastSuccess(t('Successfully requested'));
  279. closeModal();
  280. mutateMigrationStatus();
  281. mutate();
  282. mutatePageTree();
  283. },
  284. );
  285. }, [data, openModal, t, closeModal, mutateMigrationStatus, mutate]);
  286. const pagingSizeChangedHandler = useCallback((pagingSize: number) => {
  287. setOffset(0);
  288. setLimit(pagingSize);
  289. mutate();
  290. }, [mutate]);
  291. const pagingNumberChangedHandler = useCallback((activePage: number) => {
  292. setOffset((activePage - 1) * limit);
  293. mutate();
  294. }, [limit, mutate]);
  295. const openConvertModalHandler = useCallback(() => {
  296. if (!isAdmin) { return }
  297. setOpenConvertModal(true);
  298. }, [isAdmin]);
  299. const hitsCount = data?.meta.hitsCount;
  300. const renderOpenModalButton = useCallback(() => {
  301. return (
  302. <div className="d-flex ps-md-2">
  303. <button type="button" className="btn btn-light" onClick={() => openConvertModalHandler()}>
  304. {t('private_legacy_pages.input_path_to_convert')}
  305. </button>
  306. </div>
  307. );
  308. }, [t, openConvertModalHandler]);
  309. const extraControls = useMemo(() => {
  310. const isCheckboxDisabled = hitsCount === 0;
  311. return (
  312. <div className="d-flex align-items-center">
  313. <div className="d-flex">
  314. <OperateAllControl
  315. inputClassName="me-2"
  316. ref={selectAllControlRef}
  317. isCheckboxDisabled={isCheckboxDisabled}
  318. onCheckboxChanged={selectAllCheckboxChangedHandler}
  319. >
  320. <UncontrolledButtonDropdown>
  321. <DropdownToggle caret color="outline-primary" disabled={!isControlEnabled}>
  322. {t('private_legacy_pages.bulk_operation')}
  323. </DropdownToggle>
  324. <DropdownMenu>
  325. <DropdownItem onClick={convertMenuItemClickedHandler}>
  326. <span className="material-symbols-outlined">refresh</span>
  327. {t('private_legacy_pages.convert_all_selected_pages')}
  328. </DropdownItem>
  329. <DropdownItem onClick={deleteAllButtonClickedHandler}>
  330. <span className="text-danger">
  331. <span className="material-symbols-outlined">delete</span>
  332. {t('search_result.delete_all_selected_page')}
  333. </span>
  334. </DropdownItem>
  335. </DropdownMenu>
  336. </UncontrolledButtonDropdown>
  337. </OperateAllControl>
  338. </div>
  339. {isAdmin && renderOpenModalButton()}
  340. </div>
  341. );
  342. // eslint-disable-next-line max-len
  343. }, [convertMenuItemClickedHandler, deleteAllButtonClickedHandler, hitsCount, isAdmin, isControlEnabled, renderOpenModalButton, selectAllCheckboxChangedHandler, t]);
  344. const searchControl = useMemo(() => {
  345. return (
  346. <SearchControl
  347. isEnableSort={false}
  348. isEnableFilter={false}
  349. initialSearchConditions={{ keyword: initQ, limit: INITIAL_PAGING_SIZE }}
  350. onSearchInvoked={searchInvokedHandler}
  351. extraControls={extraControls}
  352. />
  353. );
  354. }, [searchInvokedHandler, extraControls]);
  355. const searchResultListHead = useMemo(() => {
  356. if (data == null) {
  357. // biome-ignore lint/complexity/noUselessFragments: ignore
  358. return <></>;
  359. }
  360. return (
  361. <SearchResultListHead
  362. searchResult={data}
  363. offset={offset}
  364. pagingSize={limit}
  365. onPagingSizeChanged={pagingSizeChangedHandler}
  366. migrationStatus={migrationStatus}
  367. />
  368. );
  369. }, [data, limit, offset, pagingSizeChangedHandler, migrationStatus]);
  370. const searchPager = useMemo(() => {
  371. // when pager is not needed
  372. if (data == null || data.meta.hitsCount === data.meta.total) {
  373. // biome-ignore lint/complexity/noUselessFragments: ignore
  374. return <></>;
  375. }
  376. const { total } = data.meta;
  377. const { offset, limit } = conditions;
  378. return (
  379. <PaginationWrapper
  380. activePage={Math.floor(offset / limit) + 1}
  381. totalItemsCount={total}
  382. pagingLimit={limit}
  383. changePage={pagingNumberChangedHandler}
  384. />
  385. );
  386. }, [conditions, data, pagingNumberChangedHandler]);
  387. return (
  388. <>
  389. <SearchPageBase
  390. ref={searchPageBaseRef}
  391. pages={data?.data}
  392. onSelectedPagesByCheckboxesChanged={selectedPagesByCheckboxesChangedHandler}
  393. forceHideMenuItems={[
  394. MenuItemType.BOOKMARK,
  395. MenuItemType.RENAME,
  396. MenuItemType.DUPLICATE,
  397. MenuItemType.REVERT,
  398. MenuItemType.PATH_RECOVERY,
  399. ]}
  400. // Components
  401. searchControl={searchControl}
  402. searchResultListHead={searchResultListHead}
  403. searchPager={searchPager}
  404. />
  405. <PrivateLegacyPagesMigrationModal />
  406. <ConvertByPathModal
  407. isOpen={isOpenConvertModal}
  408. close={() => setOpenConvertModal(false)}
  409. onSubmit={async(convertPath: string) => {
  410. try {
  411. await apiv3Post<void>('/pages/convert-pages-by-path', {
  412. convertPath,
  413. });
  414. toastSuccess(t('private_legacy_pages.by_path_modal.success'));
  415. setOpenConvertModal(false);
  416. mutate();
  417. mutatePageTree();
  418. }
  419. catch (errs) {
  420. if (errs.length === 1) {
  421. switch (errs[0].code) {
  422. case V5ConversionErrCode.GRANT_INVALID:
  423. toastError(t('private_legacy_pages.by_path_modal.error_grant_invalid'));
  424. break;
  425. case V5ConversionErrCode.PAGE_NOT_FOUND:
  426. toastError(t('private_legacy_pages.by_path_modal.error_page_not_found'));
  427. break;
  428. case V5ConversionErrCode.DUPLICATE_PAGES_FOUND:
  429. toastError(t('private_legacy_pages.by_path_modal.error_duplicate_pages_found'));
  430. break;
  431. default:
  432. toastError(t('private_legacy_pages.by_path_modal.error'));
  433. }
  434. }
  435. else {
  436. toastError(t('private_legacy_pages.by_path_modal.error'));
  437. }
  438. }
  439. }}
  440. />
  441. </>
  442. );
  443. };
  444. export default PrivateLegacyPages;