PageItemControl.tsx 13 KB

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