LoginForm.tsx 20 KB

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