LoginForm.tsx 20 KB

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