PageItemControl.tsx 13 KB

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