PageItemControl.tsx 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396
  1. import React, {
  2. useState, useCallback, useEffect,
  3. } from 'react';
  4. import { getCustomModifiers } from '@growi/ui/dist/utils';
  5. import { useTranslation } from 'next-i18next';
  6. import {
  7. Dropdown, DropdownMenu, DropdownToggle, DropdownItem,
  8. } from 'reactstrap';
  9. import { NotAvailableForGuest } from '~/components/NotAvailableForGuest';
  10. import {
  11. IPageInfoAll, isIPageInfoForOperation,
  12. } from '~/interfaces/page';
  13. import { IPageOperationProcessData } from '~/interfaces/page-operation';
  14. import { useSWRxPageInfo } from '~/stores/page';
  15. import loggerFactory from '~/utils/logger';
  16. import { shouldRecoverPagePaths } from '~/utils/page-operation';
  17. const logger = loggerFactory('growi:cli:PageItemControl');
  18. export const MenuItemType = {
  19. BOOKMARK: 'bookmark',
  20. RENAME: 'rename',
  21. DUPLICATE: 'duplicate',
  22. DELETE: 'delete',
  23. REVERT: 'revert',
  24. PATH_RECOVERY: 'pathRecovery',
  25. SWITCH_CONTENT_WIDTH: 'switch_content_width',
  26. } as const;
  27. export type MenuItemType = typeof MenuItemType[keyof typeof MenuItemType];
  28. export type ForceHideMenuItems = MenuItemType[];
  29. export type AdditionalMenuItemsRendererProps = { pageInfo: IPageInfoAll };
  30. type CommonProps = {
  31. pageInfo?: IPageInfoAll,
  32. isEnableActions?: boolean,
  33. forceHideMenuItems?: ForceHideMenuItems,
  34. onClickBookmarkMenuItem?: (pageId: string, newValue?: boolean) => Promise<void>,
  35. onClickRenameMenuItem?: (pageId: string, pageInfo: IPageInfoAll | undefined) => Promise<void> | void,
  36. onClickDuplicateMenuItem?: (pageId: string) => Promise<void> | void,
  37. onClickDeleteMenuItem?: (pageId: string, pageInfo: IPageInfoAll | undefined) => Promise<void> | void,
  38. onClickRevertMenuItem?: (pageId: string) => Promise<void> | void,
  39. onClickPathRecoveryMenuItem?: (pageId: string) => Promise<void> | void,
  40. additionalMenuItemOnTopRenderer?: React.FunctionComponent<AdditionalMenuItemsRendererProps>,
  41. additionalMenuItemRenderer?: React.FunctionComponent<AdditionalMenuItemsRendererProps>,
  42. isInstantRename?: boolean,
  43. alignRight?: boolean,
  44. }
  45. type DropdownMenuProps = CommonProps & {
  46. pageId: string,
  47. isLoading?: boolean,
  48. operationProcessData?: IPageOperationProcessData,
  49. }
  50. const PageItemControlDropdownMenu = React.memo((props: DropdownMenuProps): JSX.Element => {
  51. const { t } = useTranslation('');
  52. const {
  53. pageId, isLoading, pageInfo, isEnableActions, forceHideMenuItems, operationProcessData,
  54. onClickBookmarkMenuItem, onClickRenameMenuItem, onClickDuplicateMenuItem, onClickDeleteMenuItem,
  55. onClickRevertMenuItem, onClickPathRecoveryMenuItem,
  56. additionalMenuItemOnTopRenderer: AdditionalMenuItemsOnTop,
  57. additionalMenuItemRenderer: AdditionalMenuItems,
  58. isInstantRename, alignRight,
  59. } = props;
  60. // eslint-disable-next-line react-hooks/rules-of-hooks
  61. const bookmarkItemClickedHandler = useCallback(async() => {
  62. if (!isIPageInfoForOperation(pageInfo) || onClickBookmarkMenuItem == null) {
  63. return;
  64. }
  65. await onClickBookmarkMenuItem(pageId, !pageInfo.isBookmarked);
  66. }, [onClickBookmarkMenuItem, pageId, pageInfo]);
  67. // eslint-disable-next-line react-hooks/rules-of-hooks
  68. const renameItemClickedHandler = useCallback(async() => {
  69. if (onClickRenameMenuItem == null) {
  70. return;
  71. }
  72. if (!pageInfo?.isMovable) {
  73. logger.warn('This page could not be renamed.');
  74. return;
  75. }
  76. await onClickRenameMenuItem(pageId, pageInfo);
  77. }, [onClickRenameMenuItem, pageId, pageInfo]);
  78. // eslint-disable-next-line react-hooks/rules-of-hooks
  79. const duplicateItemClickedHandler = useCallback(async() => {
  80. if (onClickDuplicateMenuItem == null) {
  81. return;
  82. }
  83. await onClickDuplicateMenuItem(pageId);
  84. }, [onClickDuplicateMenuItem, pageId]);
  85. const revertItemClickedHandler = useCallback(async() => {
  86. if (onClickRevertMenuItem == null) {
  87. return;
  88. }
  89. await onClickRevertMenuItem(pageId);
  90. }, [onClickRevertMenuItem, pageId]);
  91. // eslint-disable-next-line react-hooks/rules-of-hooks
  92. const deleteItemClickedHandler = useCallback(async() => {
  93. if (pageInfo == null || onClickDeleteMenuItem == null) {
  94. return;
  95. }
  96. if (!pageInfo.isDeletable) {
  97. logger.warn('This page could not be deleted.');
  98. return;
  99. }
  100. await onClickDeleteMenuItem(pageId, pageInfo);
  101. }, [onClickDeleteMenuItem, pageId, pageInfo]);
  102. // eslint-disable-next-line react-hooks/rules-of-hooks
  103. const pathRecoveryItemClickedHandler = useCallback(async() => {
  104. if (onClickPathRecoveryMenuItem == null) {
  105. return;
  106. }
  107. await onClickPathRecoveryMenuItem(pageId);
  108. }, [onClickPathRecoveryMenuItem, pageId]);
  109. let contents = <></>;
  110. if (isLoading) {
  111. contents = (
  112. <div className="text-muted text-center my-2">
  113. <i className="fa fa-spinner fa-pulse"></i>
  114. </div>
  115. );
  116. }
  117. else if (pageId != null && pageInfo != null) {
  118. const showDeviderBeforeAdditionalMenuItems = (forceHideMenuItems?.length ?? 0) < 3;
  119. const showDeviderBeforeDelete = AdditionalMenuItems != null || showDeviderBeforeAdditionalMenuItems;
  120. // PathRecovery
  121. // Todo: It is wanted to find a better way to pass operationProcessData to PageItemControl
  122. const shouldShowPathRecoveryButton = operationProcessData != null ? shouldRecoverPagePaths(operationProcessData) : false;
  123. contents = (
  124. <>
  125. { !isEnableActions && (
  126. <DropdownItem>
  127. <p>
  128. {t('search_result.currently_not_implemented')}
  129. </p>
  130. </DropdownItem>
  131. ) }
  132. { AdditionalMenuItemsOnTop && (
  133. <>
  134. <AdditionalMenuItemsOnTop pageInfo={pageInfo} />
  135. <DropdownItem divider />
  136. </>
  137. ) }
  138. {/* Bookmark */}
  139. { !forceHideMenuItems?.includes(MenuItemType.BOOKMARK) && isEnableActions && isIPageInfoForOperation(pageInfo) && (
  140. <DropdownItem
  141. onClick={bookmarkItemClickedHandler}
  142. className="grw-page-control-dropdown-item"
  143. data-testid="add-remove-bookmark-btn"
  144. >
  145. <i className="fa fa-fw fa-bookmark-o grw-page-control-dropdown-icon"></i>
  146. { pageInfo.isBookmarked ? t('remove_bookmark') : t('add_bookmark') }
  147. </DropdownItem>
  148. ) }
  149. {/* Move/Rename */}
  150. { !forceHideMenuItems?.includes(MenuItemType.RENAME) && isEnableActions && pageInfo.isMovable && (
  151. <DropdownItem
  152. onClick={renameItemClickedHandler}
  153. data-testid="open-page-move-rename-modal-btn"
  154. className="grw-page-control-dropdown-item"
  155. >
  156. <i className="icon-fw icon-action-redo grw-page-control-dropdown-icon"></i>
  157. {t(isInstantRename ? 'Rename' : 'Move/Rename')}
  158. </DropdownItem>
  159. ) }
  160. {/* Duplicate */}
  161. { !forceHideMenuItems?.includes(MenuItemType.DUPLICATE) && isEnableActions && (
  162. <DropdownItem
  163. onClick={duplicateItemClickedHandler}
  164. data-testid="open-page-duplicate-modal-btn"
  165. className="grw-page-control-dropdown-item"
  166. >
  167. <i className="icon-fw icon-docs grw-page-control-dropdown-icon"></i>
  168. {t('Duplicate')}
  169. </DropdownItem>
  170. ) }
  171. {/* Revert */}
  172. { !forceHideMenuItems?.includes(MenuItemType.REVERT) && isEnableActions && pageInfo.isRevertible && (
  173. <DropdownItem
  174. onClick={revertItemClickedHandler}
  175. className="grw-page-control-dropdown-item"
  176. >
  177. <i className="icon-fw icon-action-undo grw-page-control-dropdown-icon"></i>
  178. {t('modal_putback.label.Put Back Page')}
  179. </DropdownItem>
  180. ) }
  181. { AdditionalMenuItems && (
  182. <>
  183. { showDeviderBeforeAdditionalMenuItems && <DropdownItem divider /> }
  184. <AdditionalMenuItems pageInfo={pageInfo} />
  185. </>
  186. ) }
  187. {/* PathRecovery */}
  188. { !forceHideMenuItems?.includes(MenuItemType.PATH_RECOVERY) && isEnableActions && shouldShowPathRecoveryButton && (
  189. <DropdownItem
  190. onClick={pathRecoveryItemClickedHandler}
  191. className="grw-page-control-dropdown-item"
  192. >
  193. <i className="icon-fw icon-wrench grw-page-control-dropdown-icon"></i>
  194. {t('PathRecovery')}
  195. </DropdownItem>
  196. ) }
  197. {/* divider */}
  198. {/* Delete */}
  199. { !forceHideMenuItems?.includes(MenuItemType.DELETE) && isEnableActions && pageInfo.isMovable && (
  200. <>
  201. { showDeviderBeforeDelete && <DropdownItem divider /> }
  202. <DropdownItem
  203. className={`pt-2 grw-page-control-dropdown-item ${pageInfo.isDeletable ? 'text-danger' : ''}`}
  204. disabled={!pageInfo.isDeletable}
  205. onClick={deleteItemClickedHandler}
  206. data-testid="open-page-delete-modal-btn"
  207. >
  208. <i className="icon-fw icon-trash grw-page-control-dropdown-icon"></i>
  209. {t('Delete')}
  210. </DropdownItem>
  211. </>
  212. )}
  213. </>
  214. );
  215. }
  216. return (
  217. <DropdownMenu
  218. data-testid="page-item-control-menu"
  219. right={alignRight}
  220. modifiers={getCustomModifiers(alignRight)}
  221. container="body"
  222. persist={!!alignRight}
  223. style={{ zIndex: 1055 }} /* make it larger than $zindex-modal of bootstrap */
  224. >
  225. {contents}
  226. </DropdownMenu>
  227. );
  228. });
  229. PageItemControlDropdownMenu.displayName = 'PageItemControl';
  230. type PageItemControlSubstanceProps = CommonProps & {
  231. pageId: string,
  232. fetchOnInit?: boolean,
  233. children?: React.ReactNode,
  234. operationProcessData?: IPageOperationProcessData,
  235. }
  236. export const PageItemControlSubstance = (props: PageItemControlSubstanceProps): JSX.Element => {
  237. const {
  238. pageId, pageInfo: presetPageInfo, fetchOnInit, children, onClickBookmarkMenuItem, onClickRenameMenuItem,
  239. onClickDuplicateMenuItem, onClickDeleteMenuItem, onClickPathRecoveryMenuItem,
  240. } = props;
  241. const [isOpen, setIsOpen] = useState(false);
  242. const [shouldFetch, setShouldFetch] = useState(fetchOnInit ?? false);
  243. const { data: fetchedPageInfo, mutate: mutatePageInfo } = useSWRxPageInfo(shouldFetch ? pageId : null);
  244. // update shouldFetch (and will never be false)
  245. useEffect(() => {
  246. if (shouldFetch) {
  247. return;
  248. }
  249. if (!isIPageInfoForOperation(presetPageInfo) && isOpen) {
  250. setShouldFetch(true);
  251. }
  252. }, [isOpen, presetPageInfo, shouldFetch]);
  253. // mutate after handle event
  254. const bookmarkMenuItemClickHandler = useCallback(async(_pageId: string, _newValue: boolean) => {
  255. if (onClickBookmarkMenuItem != null) {
  256. await onClickBookmarkMenuItem(_pageId, _newValue);
  257. }
  258. if (shouldFetch) {
  259. mutatePageInfo();
  260. }
  261. }, [mutatePageInfo, onClickBookmarkMenuItem, shouldFetch]);
  262. const isLoading = shouldFetch && fetchedPageInfo == null;
  263. const renameMenuItemClickHandler = useCallback(async() => {
  264. if (onClickRenameMenuItem == null) {
  265. return;
  266. }
  267. await onClickRenameMenuItem(pageId, fetchedPageInfo ?? presetPageInfo);
  268. }, [onClickRenameMenuItem, pageId, fetchedPageInfo, presetPageInfo]);
  269. const duplicateMenuItemClickHandler = useCallback(async() => {
  270. if (onClickDuplicateMenuItem == null) {
  271. return;
  272. }
  273. await onClickDuplicateMenuItem(pageId);
  274. }, [onClickDuplicateMenuItem, pageId]);
  275. const deleteMenuItemClickHandler = useCallback(async() => {
  276. if (onClickDeleteMenuItem == null) {
  277. return;
  278. }
  279. await onClickDeleteMenuItem(pageId, fetchedPageInfo ?? presetPageInfo);
  280. }, [onClickDeleteMenuItem, pageId, fetchedPageInfo, presetPageInfo]);
  281. const pathRecoveryMenuItemClickHandler = useCallback(async() => {
  282. if (onClickPathRecoveryMenuItem == null) {
  283. return;
  284. }
  285. await onClickPathRecoveryMenuItem(pageId);
  286. }, [onClickPathRecoveryMenuItem, pageId]);
  287. return (
  288. <NotAvailableForGuest>
  289. <Dropdown isOpen={isOpen} toggle={() => setIsOpen(!isOpen)} data-testid="open-page-item-control-btn">
  290. { children ?? (
  291. <DropdownToggle color="transparent" className="border-0 rounded btn-page-item-control d-flex align-items-center justify-content-center">
  292. <i className="icon-options"></i>
  293. </DropdownToggle>
  294. ) }
  295. <PageItemControlDropdownMenu
  296. {...props}
  297. isLoading={isLoading}
  298. pageInfo={fetchedPageInfo ?? presetPageInfo}
  299. onClickBookmarkMenuItem={bookmarkMenuItemClickHandler}
  300. onClickRenameMenuItem={renameMenuItemClickHandler}
  301. onClickDuplicateMenuItem={duplicateMenuItemClickHandler}
  302. onClickDeleteMenuItem={deleteMenuItemClickHandler}
  303. onClickPathRecoveryMenuItem={pathRecoveryMenuItemClickHandler}
  304. />
  305. </Dropdown>
  306. </NotAvailableForGuest>
  307. );
  308. };
  309. export type PageItemControlProps = CommonProps & {
  310. pageId?: string,
  311. children?: React.ReactNode,
  312. operationProcessData?: IPageOperationProcessData,
  313. }
  314. export const PageItemControl = (props: PageItemControlProps): JSX.Element => {
  315. const { pageId } = props;
  316. if (pageId == null) {
  317. return <></>;
  318. }
  319. return <PageItemControlSubstance pageId={pageId} {...props} />;
  320. };
  321. type AsyncPageItemControlProps = Omit<CommonProps, 'pageInfo'> & {
  322. pageId?: string,
  323. children?: React.ReactNode,
  324. }
  325. export const AsyncPageItemControl = (props: AsyncPageItemControlProps): JSX.Element => {
  326. const { pageId } = props;
  327. if (pageId == null) {
  328. return <></>;
  329. }
  330. return <PageItemControlSubstance pageId={pageId} fetchOnInit {...props} />;
  331. };