PrivateLegacyPages.tsx 16 KB

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