_search.page.tsx 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184
  1. import type { ReactNode } from 'react';
  2. import type { IUser } from '@growi/core';
  3. import type { GetServerSideProps, GetServerSidePropsContext } from 'next';
  4. import { useTranslation } from 'next-i18next';
  5. import { serverSideTranslations } from 'next-i18next/serverSideTranslations';
  6. import Head from 'next/head';
  7. import SearchResultLayout from '~/components/Layout/SearchResultLayout';
  8. import { DrawioViewerScript } from '~/components/Script/DrawioViewerScript';
  9. import type { CrowiRequest } from '~/interfaces/crowi-request';
  10. import type { RendererConfig } from '~/interfaces/services/renderer';
  11. import {
  12. useCsrfToken, useCurrentUser, useIsContainerFluid, useIsSearchPage, useIsSearchScopeChildrenAsDefault,
  13. useIsSearchServiceConfigured, useIsSearchServiceReachable, useRendererConfig, useShowPageLimitationL, useGrowiCloudUri, useCurrentPathname,
  14. } from '~/stores/context';
  15. import { useCurrentPageId, useSWRxCurrentPage } from '~/stores/page';
  16. import { SearchPage } from '../components/SearchPage';
  17. import type { NextPageWithLayout } from './_app.page';
  18. import type { CommonProps } from './utils/commons';
  19. import {
  20. getNextI18NextConfig, getServerSideCommonProps, generateCustomTitle, useInitSidebarConfig,
  21. } from './utils/commons';
  22. type Props = CommonProps & {
  23. currentUser: IUser,
  24. isSearchServiceConfigured: boolean,
  25. isSearchServiceReachable: boolean,
  26. isSearchScopeChildrenAsDefault: boolean,
  27. // Render config
  28. rendererConfig: RendererConfig,
  29. // search limit
  30. showPageLimitationL: number
  31. isContainerFluid: boolean,
  32. };
  33. const SearchResultPage: NextPageWithLayout<Props> = (props: Props) => {
  34. const { t } = useTranslation();
  35. // commons
  36. useCsrfToken(props.csrfToken);
  37. useGrowiCloudUri(props.growiCloudUri);
  38. useCurrentUser(props.currentUser ?? null);
  39. // clear the cache for the current page
  40. const { mutate } = useSWRxCurrentPage();
  41. mutate(undefined, { revalidate: false });
  42. useCurrentPageId(null);
  43. useCurrentPathname('/_search');
  44. // Search
  45. useIsSearchPage(true);
  46. useIsSearchServiceConfigured(props.isSearchServiceConfigured);
  47. useIsSearchServiceReachable(props.isSearchServiceReachable);
  48. useIsSearchScopeChildrenAsDefault(props.isSearchScopeChildrenAsDefault);
  49. // init sidebar config with UserUISettings and sidebarConfig
  50. useInitSidebarConfig(props.sidebarConfig, props.userUISettings);
  51. // render config
  52. useRendererConfig(props.rendererConfig);
  53. useShowPageLimitationL(props.showPageLimitationL);
  54. useIsContainerFluid(props.isContainerFluid);
  55. const title = generateCustomTitle(props, t('search_result.title'));
  56. return (
  57. <>
  58. <Head>
  59. <title>{title}</title>
  60. </Head>
  61. <SearchPage />
  62. </>
  63. );
  64. };
  65. type LayoutProps = Props & {
  66. children?: ReactNode
  67. }
  68. const Layout = ({ children, ...props }: LayoutProps): JSX.Element => {
  69. // init sidebar config with UserUISettings and sidebarConfig
  70. useInitSidebarConfig(props.sidebarConfig, props.userUISettings);
  71. return (
  72. <SearchResultLayout>
  73. {children}
  74. </SearchResultLayout>
  75. );
  76. };
  77. SearchResultPage.getLayout = function getLayout(page) {
  78. return (
  79. <>
  80. <DrawioViewerScript />
  81. <Layout {...page.props}>{page}</Layout>
  82. </>
  83. );
  84. };
  85. function injectServerConfigurations(context: GetServerSidePropsContext, props: Props): void {
  86. const req: CrowiRequest = context.req as CrowiRequest;
  87. const { crowi } = req;
  88. const { configManager, searchService } = crowi;
  89. props.isSearchServiceConfigured = searchService.isConfigured;
  90. props.isSearchServiceReachable = searchService.isReachable;
  91. props.isSearchScopeChildrenAsDefault = configManager.getConfig('crowi', 'customize:isSearchScopeChildrenAsDefault');
  92. props.isContainerFluid = configManager.getConfig('crowi', 'customize:isContainerFluid');
  93. props.sidebarConfig = {
  94. isSidebarCollapsedMode: configManager.getConfig('crowi', 'customize:isSidebarCollapsedMode'),
  95. };
  96. props.rendererConfig = {
  97. isEnabledLinebreaks: configManager.getConfig('markdown', 'markdown:isEnabledLinebreaks'),
  98. isEnabledLinebreaksInComments: configManager.getConfig('markdown', 'markdown:isEnabledLinebreaksInComments'),
  99. isEnabledMarp: configManager.getConfig('crowi', 'customize:isEnabledMarp'),
  100. adminPreferredIndentSize: configManager.getConfig('markdown', 'markdown:adminPreferredIndentSize'),
  101. isIndentSizeForced: configManager.getConfig('markdown', 'markdown:isIndentSizeForced'),
  102. drawioUri: configManager.getConfig('crowi', 'app:drawioUri'),
  103. plantumlUri: configManager.getConfig('crowi', 'app:plantumlUri'),
  104. // XSS Options
  105. isEnabledXssPrevention: configManager.getConfig('markdown', 'markdown:rehypeSanitize:isEnabledPrevention'),
  106. xssOption: configManager.getConfig('markdown', 'markdown:rehypeSanitize:option'),
  107. attrWhitelist: JSON.parse(crowi.configManager.getConfig('markdown', 'markdown:rehypeSanitize:attributes')),
  108. tagWhitelist: crowi.configManager.getConfig('markdown', 'markdown:rehypeSanitize:tagNames'),
  109. highlightJsStyleBorder: crowi.configManager.getConfig('crowi', 'customize:highlightJsStyleBorder'),
  110. };
  111. props.showPageLimitationL = configManager.getConfig('crowi', 'customize:showPageLimitationL');
  112. }
  113. /**
  114. * for Server Side Translations
  115. * @param context
  116. * @param props
  117. * @param namespacesRequired
  118. */
  119. async function injectNextI18NextConfigurations(context: GetServerSidePropsContext, props: Props, namespacesRequired?: string[] | undefined): Promise<void> {
  120. const nextI18NextConfig = await getNextI18NextConfig(serverSideTranslations, context, namespacesRequired);
  121. props._nextI18Next = nextI18NextConfig._nextI18Next;
  122. }
  123. export const getServerSideProps: GetServerSideProps = async(context: GetServerSidePropsContext) => {
  124. const req = context.req as CrowiRequest;
  125. const { user } = req;
  126. const result = await getServerSideCommonProps(context);
  127. // check for presence
  128. // see: https://github.com/vercel/next.js/issues/19271#issuecomment-730006862
  129. if (!('props' in result)) {
  130. throw new Error('invalid getSSP result');
  131. }
  132. const props: Props = result.props as Props;
  133. if (user != null) {
  134. props.currentUser = user.toObject();
  135. }
  136. injectServerConfigurations(context, props);
  137. await injectNextI18NextConfigurations(context, props, ['translation']);
  138. return {
  139. props,
  140. };
  141. };
  142. export default SearchResultPage;