LoginForm.tsx 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566
  1. import React, {
  2. useState, useEffect, useCallback, type JSX,
  3. } from 'react';
  4. import { LoadingSpinner } from '@growi/ui/dist/components';
  5. import { useTranslation } from 'next-i18next';
  6. import { useRouter } from 'next/router';
  7. import ReactCardFlip from 'react-card-flip';
  8. import { apiv3Post } from '~/client/util/apiv3-client';
  9. import { useTWithOpt } from '~/client/util/t-with-opt';
  10. import type { IExternalAccountLoginError } from '~/interfaces/errors/external-account-login-error';
  11. import { LoginErrorCode } from '~/interfaces/errors/login-error';
  12. import type { IErrorV3 } from '~/interfaces/errors/v3-error';
  13. import type { IExternalAuthProviderType } from '~/interfaces/external-auth-provider';
  14. import { RegistrationMode } from '~/interfaces/registration-mode';
  15. import { toArrayIfNot } from '~/utils/array-utils';
  16. import { CompleteUserRegistration } from '../CompleteUserRegistration';
  17. import { ExternalAuthButton } from './ExternalAuthButton';
  18. import styles from './LoginForm.module.scss';
  19. const moduleClass = styles['login-form'];
  20. type LoginFormProps = {
  21. username?: string,
  22. name?: string,
  23. email?: string,
  24. isEmailAuthenticationEnabled: boolean,
  25. registrationMode: RegistrationMode,
  26. registrationWhitelist: string[],
  27. isPasswordResetEnabled: boolean,
  28. isLocalStrategySetup: boolean,
  29. isLdapStrategySetup: boolean,
  30. isLdapSetupFailed: boolean,
  31. enabledExternalAuthType?: IExternalAuthProviderType[],
  32. isMailerSetup?: boolean,
  33. externalAccountLoginError?: IExternalAccountLoginError,
  34. minPasswordLength: number,
  35. }
  36. export const LoginForm = (props: LoginFormProps): JSX.Element => {
  37. const { t } = useTranslation();
  38. const router = useRouter();
  39. const {
  40. isLocalStrategySetup, isLdapStrategySetup, isLdapSetupFailed, isPasswordResetEnabled,
  41. isEmailAuthenticationEnabled, registrationMode, registrationWhitelist, isMailerSetup, enabledExternalAuthType, minPasswordLength,
  42. } = props;
  43. const isLocalOrLdapStrategiesEnabled = isLocalStrategySetup || isLdapStrategySetup;
  44. const isSomeExternalAuthEnabled = enabledExternalAuthType != null && enabledExternalAuthType.length > 0;
  45. // states
  46. const [isRegistering, setIsRegistering] = useState(false);
  47. const [isLoading, setIsLoading] = useState(false);
  48. // For Login
  49. const [usernameForLogin, setUsernameForLogin] = useState('');
  50. const [passwordForLogin, setPasswordForLogin] = useState('');
  51. const [loginErrors, setLoginErrors] = useState<IErrorV3[]>([]);
  52. // For Register
  53. const [usernameForRegister, setUsernameForRegister] = useState('');
  54. const [nameForRegister, setNameForRegister] = useState('');
  55. const [emailForRegister, setEmailForRegister] = useState('');
  56. const [passwordForRegister, setPasswordForRegister] = useState('');
  57. const [registerErrors, setRegisterErrors] = useState<IErrorV3[]>([]);
  58. // For UserActivation
  59. const [emailForRegistrationOrder, setEmailForRegistrationOrder] = useState('');
  60. const [isSuccessToRagistration, setIsSuccessToRagistration] = useState(false);
  61. const isRegistrationEnabled = isLocalStrategySetup && registrationMode !== RegistrationMode.CLOSED;
  62. const tWithOpt = useTWithOpt();
  63. useEffect(() => {
  64. const { hash } = window.location;
  65. if (hash === '#register') {
  66. setIsRegistering(true);
  67. }
  68. }, []);
  69. const resetLoginErrors = useCallback(() => {
  70. if (loginErrors.length === 0) return;
  71. setLoginErrors([]);
  72. }, [loginErrors.length]);
  73. const handleLoginWithLocalSubmit = useCallback(async(e) => {
  74. e.preventDefault();
  75. resetLoginErrors();
  76. setIsLoading(true);
  77. const loginForm = {
  78. username: usernameForLogin,
  79. password: passwordForLogin,
  80. };
  81. try {
  82. const res = await apiv3Post('/login', { loginForm });
  83. const { redirectTo } = res.data;
  84. if (redirectTo != null) {
  85. return router.push(redirectTo);
  86. }
  87. return router.push('/');
  88. }
  89. catch (err) {
  90. const errs = toArrayIfNot(err);
  91. setLoginErrors(errs);
  92. setIsLoading(false);
  93. }
  94. return;
  95. }, [passwordForLogin, resetLoginErrors, router, usernameForLogin]);
  96. // separate errors based on error code
  97. const separateErrorsBasedOnErrorCode = useCallback((errors: IErrorV3[]) => {
  98. const loginErrorListForDangerouslySetInnerHTML: IErrorV3[] = [];
  99. const loginErrorList: IErrorV3[] = [];
  100. errors.forEach((err) => {
  101. if (err.code === LoginErrorCode.PROVIDER_DUPLICATED_USERNAME_EXCEPTION) {
  102. loginErrorListForDangerouslySetInnerHTML.push(err);
  103. }
  104. else {
  105. loginErrorList.push(err);
  106. }
  107. });
  108. return [loginErrorListForDangerouslySetInnerHTML, loginErrorList];
  109. }, []);
  110. // wrap error elements which use dangerouslySetInnerHtml
  111. const generateDangerouslySetErrors = useCallback((errors: IErrorV3[]): JSX.Element => {
  112. if (errors == null || errors.length === 0) return <></>;
  113. return (
  114. <div className="alert alert-danger">
  115. {errors.map((err) => {
  116. // eslint-disable-next-line react/no-danger
  117. return <small dangerouslySetInnerHTML={{ __html: tWithOpt(err.message, err.args) }}></small>;
  118. })}
  119. </div>
  120. );
  121. }, [tWithOpt]);
  122. // wrap error elements which do not use dangerouslySetInnerHtml
  123. const generateSafelySetErrors = useCallback((errors: (IErrorV3 | IExternalAccountLoginError)[]): JSX.Element => {
  124. if (errors == null || errors.length === 0) return <></>;
  125. return (
  126. <ul className="alert alert-danger">
  127. {errors.map((err, index) => (
  128. <small className={index > 0 ? 'mt-1' : ''}>
  129. {tWithOpt(err.message, err.args)}
  130. </small>
  131. ))}
  132. </ul>
  133. );
  134. }, [tWithOpt]);
  135. const renderLocalOrLdapLoginForm = useCallback(() => {
  136. const { isLdapStrategySetup } = props;
  137. return (
  138. <>
  139. {/* !! - DO NOT DELETE HIDDEN ELEMENT - !! -- 7.12 ryoji-s */}
  140. {/* https://github.com/growilabs/growi/pull/7873 */}
  141. <div className="visually-hidden">
  142. <LoadingSpinner />
  143. </div>
  144. {/* !! - END OF HIDDEN ELEMENT - !! */}
  145. {isLdapSetupFailed && (
  146. <div className="alert alert-warning small">
  147. <strong><span className="material-symbols-outlined">info</span>{t('login.enabled_ldap_has_configuration_problem')}</strong><br />
  148. {/* eslint-disable-next-line react/no-danger */}
  149. <span dangerouslySetInnerHTML={{ __html: t('login.set_env_var_for_logs') }}></span>
  150. </div>
  151. )}
  152. <form role="form" onSubmit={handleLoginWithLocalSubmit} id="login-form">
  153. <div className="input-group">
  154. <label className="text-white opacity-75 d-flex align-items-center" htmlFor="tiUsernameForLogin">
  155. <span className="material-symbols-outlined" aria-label="Username or E-mail">person</span>
  156. </label>
  157. <input
  158. id="tiUsernameForLogin"
  159. type="text"
  160. className={`form-control rounded ms-2 ${isLdapStrategySetup ? 'ldap-space' : ''}`}
  161. data-testid="tiUsernameForLogin"
  162. placeholder="Username or E-mail"
  163. onChange={(e) => { setUsernameForLogin(e.target.value) }}
  164. name="usernameForLogin"
  165. />
  166. {isLdapStrategySetup && (
  167. <small className="badge text-bg-success input-ldap d-flex align-items-center">
  168. <span className="material-symbols-outlined">network_node</span>
  169. <span className="">LDAP</span>
  170. </small>
  171. )}
  172. </div>
  173. <div className="input-group">
  174. <label className="text-white opacity-75 d-flex align-items-center" htmlFor="tiPasswordForLogin">
  175. <span className="material-symbols-outlined" aria-label="Password">lock</span>
  176. </label>
  177. <input
  178. id="tiPasswordForLogin"
  179. type="password"
  180. className="form-control rounded ms-2"
  181. data-testid="tiPasswordForLogin"
  182. placeholder="Password"
  183. onChange={(e) => { setPasswordForLogin(e.target.value) }}
  184. name="passwordForLogin"
  185. />
  186. </div>
  187. <div className="input-group my-4">
  188. <button
  189. type="submit"
  190. className="btn btn-secondary btn-login col-7 mx-auto d-flex"
  191. data-testid="btnSubmitForLogin"
  192. disabled={isLoading}
  193. >
  194. <span>
  195. {isLoading ? (
  196. <LoadingSpinner />
  197. ) : (
  198. <span className="material-symbols-outlined" aria-label="Login">login</span>
  199. )}
  200. </span>
  201. <span className="flex-grow-1">{t('Sign in')}</span>
  202. </button>
  203. </div>
  204. </form>
  205. </>
  206. );
  207. }, [
  208. props, isLdapSetupFailed, t, handleLoginWithLocalSubmit, isLoading,
  209. ]);
  210. const renderExternalAuthLoginForm = useCallback(() => {
  211. const { enabledExternalAuthType } = props;
  212. if (enabledExternalAuthType == null) {
  213. return <></>;
  214. }
  215. return (
  216. <>
  217. <div className="mt-2">
  218. {enabledExternalAuthType.map(authType => <ExternalAuthButton authType={authType} />)}
  219. </div>
  220. </>
  221. );
  222. }, [props]);
  223. const resetRegisterErrors = useCallback(() => {
  224. if (registerErrors.length === 0) return;
  225. setRegisterErrors([]);
  226. }, [registerErrors.length]);
  227. const handleRegisterFormSubmit = useCallback(async(e, requestPath) => {
  228. e.preventDefault();
  229. setEmailForRegistrationOrder('');
  230. setIsSuccessToRagistration(false);
  231. setIsLoading(true);
  232. const registerForm = {
  233. username: usernameForRegister,
  234. name: nameForRegister,
  235. email: emailForRegister,
  236. password: passwordForRegister,
  237. };
  238. try {
  239. const res = await apiv3Post(requestPath, { registerForm });
  240. setIsSuccessToRagistration(true);
  241. resetRegisterErrors();
  242. const { redirectTo } = res.data;
  243. if (redirectTo != null) {
  244. router.push(redirectTo);
  245. }
  246. if (isEmailAuthenticationEnabled) {
  247. setEmailForRegistrationOrder(emailForRegister);
  248. return;
  249. }
  250. }
  251. catch (err) {
  252. // Execute if error exists
  253. if (err != null || err.length > 0) {
  254. setRegisterErrors(err);
  255. }
  256. setIsLoading(false);
  257. }
  258. return;
  259. }, [usernameForRegister, nameForRegister, emailForRegister, passwordForRegister, resetRegisterErrors, router, isEmailAuthenticationEnabled]);
  260. const switchForm = useCallback(() => {
  261. setIsRegistering(!isRegistering);
  262. resetLoginErrors();
  263. resetRegisterErrors();
  264. }, [isRegistering, resetLoginErrors, resetRegisterErrors]);
  265. const renderRegisterForm = useCallback(() => {
  266. let registerAction = '/register';
  267. let submitText = t('Sign up');
  268. if (isEmailAuthenticationEnabled) {
  269. registerAction = '/user-activation/register';
  270. submitText = t('page_register.send_email');
  271. }
  272. return (
  273. <React.Fragment>
  274. {registrationMode === RegistrationMode.RESTRICTED && (
  275. <p className="alert alert-warning">
  276. {t('page_register.notice.restricted')}
  277. <br />
  278. {t('page_register.notice.restricted_defail')}
  279. </p>
  280. )}
  281. {(!isMailerSetup && isEmailAuthenticationEnabled) && (
  282. <p className="alert alert-danger">
  283. <span>{t('commons:alert.please_enable_mailer')}</span>
  284. </p>
  285. )}
  286. {
  287. registerErrors != null && registerErrors.length > 0 && (
  288. <p className="alert alert-danger">
  289. {registerErrors.map(err => (
  290. <span>
  291. {tWithOpt(err.message, err.args)}<br />
  292. </span>
  293. ))}
  294. </p>
  295. )
  296. }
  297. {
  298. (isEmailAuthenticationEnabled && isSuccessToRagistration) && (
  299. <p className="alert alert-success">
  300. <span>{t('message.successfully_send_email_auth', { email: emailForRegistrationOrder })}</span>
  301. </p>
  302. )
  303. }
  304. <form role="form" onSubmit={e => handleRegisterFormSubmit(e, registerAction)} id="register-form">
  305. {!isEmailAuthenticationEnabled && (
  306. <div>
  307. <div className="input-group" id="input-group-username">
  308. <span className="text-white opacity-75 d-flex align-items-center">
  309. <span className="material-symbols-outlined">person</span>
  310. </span>
  311. {/* username */}
  312. <input
  313. type="text"
  314. className="form-control rounded ms-2"
  315. onChange={(e) => { setUsernameForRegister(e.target.value) }}
  316. placeholder={t('User ID')}
  317. name="username"
  318. defaultValue={props.username}
  319. required
  320. />
  321. </div>
  322. <p className="form-text text-danger">
  323. <span id="help-block-username"></span>
  324. </p>
  325. <div className="input-group">
  326. <span className="text-white opacity-75 d-flex align-items-center">
  327. <span className="material-symbols-outlined">sell</span>
  328. </span>
  329. {/* name */}
  330. <input
  331. type="text"
  332. className="form-control rounded ms-2"
  333. onChange={(e) => { setNameForRegister(e.target.value) }}
  334. placeholder={t('Name')}
  335. name="name"
  336. defaultValue={props.name}
  337. required
  338. />
  339. </div>
  340. </div>
  341. )}
  342. <div className="input-group">
  343. <span className="text-white opacity-75 d-flex align-items-center">
  344. <span className="material-symbols-outlined">mail</span>
  345. </span>
  346. {/* email */}
  347. <input
  348. type="email"
  349. disabled={!isMailerSetup && isEmailAuthenticationEnabled}
  350. className="form-control rounded ms-2"
  351. onChange={(e) => { setEmailForRegister(e.target.value) }}
  352. placeholder={t('Email')}
  353. name="email"
  354. defaultValue={props.email}
  355. required
  356. />
  357. </div>
  358. {registrationWhitelist.length > 0 && (
  359. <>
  360. <p className="form-text">{t('page_register.form_help.email')}</p>
  361. <ul>
  362. {registrationWhitelist.map((elem) => {
  363. return (
  364. <li key={elem}>
  365. <code>{elem}</code>
  366. </li>
  367. );
  368. })}
  369. </ul>
  370. </>
  371. )}
  372. {!isEmailAuthenticationEnabled && (
  373. <div>
  374. <div className="input-group">
  375. <span className="text-white opacity-75 d-flex align-items-center">
  376. <span className="material-symbols-outlined">lock</span>
  377. </span>
  378. {/* Password */}
  379. <input
  380. type="password"
  381. className="form-control rounded ms-2"
  382. onChange={(e) => { setPasswordForRegister(e.target.value) }}
  383. placeholder={t('Password')}
  384. name="password"
  385. required
  386. minLength={minPasswordLength}
  387. />
  388. </div>
  389. </div>
  390. )}
  391. {/* Sign up button (submit) */}
  392. <div className="input-group justify-content-center my-4">
  393. <button
  394. type="submit"
  395. className="btn btn-secondary btn-register d-flex col-7"
  396. disabled={(!isMailerSetup && isEmailAuthenticationEnabled) || isLoading}
  397. >
  398. <span>
  399. {isLoading ? (
  400. <LoadingSpinner />
  401. ) : (
  402. <span className="material-symbols-outlined">person_add</span>
  403. )}
  404. </span>
  405. <span className="flex-grow-1">{submitText}</span>
  406. </button>
  407. </div>
  408. </form>
  409. <div className="row">
  410. <div className="text-end col-12 mb-5">
  411. <a
  412. href="#login"
  413. className="btn btn-sm btn-secondary btn-function col-10 col-sm-9 mx-auto py-1 d-flex"
  414. style={{ pointerEvents: isLoading ? 'none' : undefined }}
  415. onClick={switchForm}
  416. >
  417. <span className="material-symbols-outlined fs-5">login</span>
  418. <span className="flex-grow-1">{t('Sign in is here')}</span>
  419. </a>
  420. </div>
  421. </div>
  422. </React.Fragment>
  423. );
  424. }, [
  425. t, isEmailAuthenticationEnabled, registrationMode, isMailerSetup, registerErrors, isSuccessToRagistration, emailForRegistrationOrder,
  426. props.username, props.name, props.email, registrationWhitelist, minPasswordLength, isLoading, switchForm, tWithOpt, handleRegisterFormSubmit,
  427. ]);
  428. if (registrationMode === RegistrationMode.RESTRICTED && isSuccessToRagistration && !isEmailAuthenticationEnabled) {
  429. return <CompleteUserRegistration />;
  430. }
  431. return (
  432. <div className={moduleClass}>
  433. <div className="nologin-dialog mx-auto rounded-4 rounded-top-0" id="nologin-dialog" data-testid="login-form">
  434. <div className="row mx-0">
  435. <div className="col-12 px-md-4 pb-5">
  436. <ReactCardFlip isFlipped={isRegistering} flipDirection="horizontal" cardZIndex="3">
  437. <div className="front">
  438. {/* Error display section - always shown regardless of login method configuration */}
  439. {(() => {
  440. // separate login errors into two arrays based on error code
  441. const [loginErrorListForDangerouslySetInnerHTML, loginErrorList] = separateErrorsBasedOnErrorCode(loginErrors);
  442. // Generate login error elements using dangerouslySetInnerHTML
  443. const loginErrorElementWithDangerouslySetInnerHTML = generateDangerouslySetErrors(loginErrorListForDangerouslySetInnerHTML);
  444. // Generate login error elements - prioritize loginErrorList, fallback to externalAccountLoginError
  445. const loginErrorElement = (loginErrorList ?? []).length > 0
  446. ? generateSafelySetErrors(loginErrorList)
  447. : generateSafelySetErrors(props.externalAccountLoginError != null ? [props.externalAccountLoginError] : []);
  448. return (
  449. <>
  450. {loginErrorElementWithDangerouslySetInnerHTML}
  451. {loginErrorElement}
  452. </>
  453. );
  454. })()}
  455. {isLocalOrLdapStrategiesEnabled && renderLocalOrLdapLoginForm()}
  456. {isLocalOrLdapStrategiesEnabled && isSomeExternalAuthEnabled && (
  457. <div className="text-center text-line d-flex align-items-center mb-3">
  458. <p className="text-white mb-0">{t('or')}</p>
  459. </div>
  460. )}
  461. {isSomeExternalAuthEnabled && renderExternalAuthLoginForm()}
  462. {isLocalOrLdapStrategiesEnabled && isPasswordResetEnabled && (
  463. <div className="mt-4">
  464. <a
  465. href="/forgot-password"
  466. className="btn btn-sm btn-secondary btn-function col-10 col-sm-9 mx-auto py-1 d-flex"
  467. style={{ pointerEvents: isLoading ? 'none' : 'auto' }}
  468. >
  469. <span className="material-symbols-outlined">vpn_key</span>
  470. <span className="flex-grow-1">{t('forgot_password.forgot_password')}</span>
  471. </a>
  472. </div>
  473. )}
  474. {/* Sign up link */}
  475. {isRegistrationEnabled && (
  476. <div className="mt-2">
  477. <a
  478. href="#register"
  479. className="btn btn-sm btn-secondary btn-function col-10 col-sm-9 mx-auto py-1 d-flex"
  480. style={{ pointerEvents: isLoading ? 'none' : 'auto' }}
  481. onClick={switchForm}
  482. >
  483. <span className="material-symbols-outlined">person_add</span>
  484. <span className="flex-grow-1">{t('Sign up is here')}</span>
  485. </a>
  486. </div>
  487. )}
  488. </div>
  489. <div className="back">
  490. {/* Register form for /login#register */}
  491. {isRegistrationEnabled && renderRegisterForm()}
  492. </div>
  493. </ReactCardFlip>
  494. </div>
  495. </div>
  496. <a href="https://growi.org" className="link-growi-org ps-3">
  497. <span className="growi">GROWI</span><span className="org">.org</span>
  498. </a>
  499. </div>
  500. </div>
  501. );
  502. };