LoginForm.tsx 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565
  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. <span className="text-white opacity-75 d-flex align-items-center">
  168. <span className="material-symbols-outlined">person</span>
  169. </span>
  170. <input
  171. type="text"
  172. className={`form-control rounded ms-2 ${isLdapStrategySetup ? 'ldap-space' : ''}`}
  173. data-testid="tiUsernameForLogin"
  174. placeholder="Username or E-mail"
  175. onChange={(e) => { setUsernameForLogin(e.target.value) }}
  176. name="usernameForLogin"
  177. />
  178. {isLdapStrategySetup && (
  179. <small className="badge text-bg-success input-ldap d-flex align-items-center">
  180. <span className="material-symbols-outlined">network_node</span>
  181. <span className="">LDAP</span>
  182. </small>
  183. )}
  184. </div>
  185. <div className="input-group">
  186. <span className="text-white opacity-75 d-flex align-items-center">
  187. <span className="material-symbols-outlined">lock</span>
  188. </span>
  189. <input
  190. type="password"
  191. className="form-control rounded ms-2"
  192. data-testid="tiPasswordForLogin"
  193. placeholder="Password"
  194. onChange={(e) => { setPasswordForLogin(e.target.value) }}
  195. name="passwordForLogin"
  196. />
  197. </div>
  198. <div className="input-group my-4">
  199. <button
  200. type="submit"
  201. className="btn btn-secondary btn-login col-7 mx-auto d-flex"
  202. data-testid="btnSubmitForLogin"
  203. disabled={isLoading}
  204. >
  205. <span>
  206. {isLoading ? (
  207. <LoadingSpinner />
  208. ) : (
  209. <span className="material-symbols-outlined">login</span>
  210. )}
  211. </span>
  212. <span className="flex-grow-1">{t('Sign in')}</span>
  213. </button>
  214. </div>
  215. </form>
  216. </>
  217. );
  218. }, [
  219. props,
  220. separateErrorsBasedOnErrorCode,
  221. loginErrors,
  222. generateDangerouslySetErrors,
  223. generateSafelySetErrors,
  224. isLdapSetupFailed,
  225. t,
  226. handleLoginWithLocalSubmit,
  227. isLoading,
  228. ]);
  229. const renderExternalAuthLoginForm = useCallback(() => {
  230. const { enabledExternalAuthType } = props;
  231. if (enabledExternalAuthType == null) {
  232. return <></>;
  233. }
  234. return (
  235. <>
  236. <div className="mt-2">
  237. { enabledExternalAuthType.map(authType => <ExternalAuthButton authType={authType} />) }
  238. </div>
  239. </>
  240. );
  241. }, [props]);
  242. const resetRegisterErrors = useCallback(() => {
  243. if (registerErrors.length === 0) return;
  244. setRegisterErrors([]);
  245. }, [registerErrors.length]);
  246. const handleRegisterFormSubmit = useCallback(async(e, requestPath) => {
  247. e.preventDefault();
  248. setEmailForRegistrationOrder('');
  249. setIsSuccessToRagistration(false);
  250. setIsLoading(true);
  251. const registerForm = {
  252. username: usernameForRegister,
  253. name: nameForRegister,
  254. email: emailForRegister,
  255. password: passwordForRegister,
  256. };
  257. try {
  258. const res = await apiv3Post(requestPath, { registerForm });
  259. setIsSuccessToRagistration(true);
  260. resetRegisterErrors();
  261. const { redirectTo } = res.data;
  262. if (redirectTo != null) {
  263. router.push(redirectTo);
  264. }
  265. if (isEmailAuthenticationEnabled) {
  266. setEmailForRegistrationOrder(emailForRegister);
  267. return;
  268. }
  269. }
  270. catch (err) {
  271. // Execute if error exists
  272. if (err != null || err.length > 0) {
  273. setRegisterErrors(err);
  274. }
  275. setIsLoading(false);
  276. }
  277. return;
  278. }, [usernameForRegister, nameForRegister, emailForRegister, passwordForRegister, resetRegisterErrors, router, isEmailAuthenticationEnabled]);
  279. const switchForm = useCallback(() => {
  280. setIsRegistering(!isRegistering);
  281. resetLoginErrors();
  282. resetRegisterErrors();
  283. }, [isRegistering, resetLoginErrors, resetRegisterErrors]);
  284. const renderRegisterForm = useCallback(() => {
  285. let registerAction = '/register';
  286. let submitText = t('Sign up');
  287. if (isEmailAuthenticationEnabled) {
  288. registerAction = '/user-activation/register';
  289. submitText = t('page_register.send_email');
  290. }
  291. return (
  292. <React.Fragment>
  293. {registrationMode === RegistrationMode.RESTRICTED && (
  294. <p className="alert alert-warning">
  295. {t('page_register.notice.restricted')}
  296. <br />
  297. {t('page_register.notice.restricted_defail')}
  298. </p>
  299. )}
  300. { (!isMailerSetup && isEmailAuthenticationEnabled) && (
  301. <p className="alert alert-danger">
  302. <span>{t('commons:alert.please_enable_mailer')}</span>
  303. </p>
  304. )}
  305. {
  306. registerErrors != null && registerErrors.length > 0 && (
  307. <p className="alert alert-danger">
  308. {registerErrors.map(err => (
  309. <span>
  310. {t(err.message)}<br />
  311. </span>
  312. ))}
  313. </p>
  314. )
  315. }
  316. {
  317. (isEmailAuthenticationEnabled && isSuccessToRagistration) && (
  318. <p className="alert alert-success">
  319. <span>{t('message.successfully_send_email_auth', { email: emailForRegistrationOrder })}</span>
  320. </p>
  321. )
  322. }
  323. <form role="form" onSubmit={e => handleRegisterFormSubmit(e, registerAction)} id="register-form">
  324. {!isEmailAuthenticationEnabled && (
  325. <div>
  326. <div className="input-group" id="input-group-username">
  327. <span className="text-white opacity-75 d-flex align-items-center">
  328. <span className="material-symbols-outlined">person</span>
  329. </span>
  330. {/* username */}
  331. <input
  332. type="text"
  333. className="form-control rounded ms-2"
  334. onChange={(e) => { setUsernameForRegister(e.target.value) }}
  335. placeholder={t('User ID')}
  336. name="username"
  337. defaultValue={props.username}
  338. required
  339. />
  340. </div>
  341. <p className="form-text text-danger">
  342. <span id="help-block-username"></span>
  343. </p>
  344. <div className="input-group">
  345. <span className="text-white opacity-75 d-flex align-items-center">
  346. <span className="material-symbols-outlined">sell</span>
  347. </span>
  348. {/* name */}
  349. <input
  350. type="text"
  351. className="form-control rounded ms-2"
  352. onChange={(e) => { setNameForRegister(e.target.value) }}
  353. placeholder={t('Name')}
  354. name="name"
  355. defaultValue={props.name}
  356. required
  357. />
  358. </div>
  359. </div>
  360. )}
  361. <div className="input-group">
  362. <span className="text-white opacity-75 d-flex align-items-center">
  363. <span className="material-symbols-outlined">mail</span>
  364. </span>
  365. {/* email */}
  366. <input
  367. type="email"
  368. disabled={!isMailerSetup && isEmailAuthenticationEnabled}
  369. className="form-control rounded ms-2"
  370. onChange={(e) => { setEmailForRegister(e.target.value) }}
  371. placeholder={t('Email')}
  372. name="email"
  373. defaultValue={props.email}
  374. required
  375. />
  376. </div>
  377. {registrationWhitelist.length > 0 && (
  378. <>
  379. <p className="form-text">{t('page_register.form_help.email')}</p>
  380. <ul>
  381. {registrationWhitelist.map((elem) => {
  382. return (
  383. <li key={elem}>
  384. <code>{elem}</code>
  385. </li>
  386. );
  387. })}
  388. </ul>
  389. </>
  390. )}
  391. {!isEmailAuthenticationEnabled && (
  392. <div>
  393. <div className="input-group">
  394. <span className="text-white opacity-75 d-flex align-items-center">
  395. <span className="material-symbols-outlined">lock</span>
  396. </span>
  397. {/* Password */}
  398. <input
  399. type="password"
  400. className="form-control rounded ms-2"
  401. onChange={(e) => { setPasswordForRegister(e.target.value) }}
  402. placeholder={t('Password')}
  403. name="password"
  404. required
  405. />
  406. </div>
  407. </div>
  408. )}
  409. {/* Sign up button (submit) */}
  410. <div className="input-group justify-content-center my-4">
  411. <button
  412. type="submit"
  413. className="btn btn-secondary btn-register d-flex col-7"
  414. disabled={(!isMailerSetup && isEmailAuthenticationEnabled) || isLoading}
  415. >
  416. <span>
  417. {isLoading ? (
  418. <LoadingSpinner />
  419. ) : (
  420. <span className="material-symbols-outlined">person_add</span>
  421. )}
  422. </span>
  423. <span className="flex-grow-1">{submitText}</span>
  424. </button>
  425. </div>
  426. </form>
  427. <div className="row">
  428. <div className="text-end col-12 mb-5">
  429. <a
  430. href="#login"
  431. className="btn btn-sm btn-secondary btn-function col-10 col-sm-9 mx-auto py-1 d-flex"
  432. style={{ pointerEvents: isLoading ? 'none' : undefined }}
  433. onClick={switchForm}
  434. >
  435. <span className="material-symbols-outlined fs-5">login</span>
  436. <span className="flex-grow-1">{t('Sign in is here')}</span>
  437. </a>
  438. </div>
  439. </div>
  440. </React.Fragment>
  441. );
  442. }, [
  443. t, isEmailAuthenticationEnabled, registrationMode, isMailerSetup, registerErrors, isSuccessToRagistration,
  444. emailForRegistrationOrder, props.username, props.name, props.email, registrationWhitelist, switchForm, handleRegisterFormSubmit, isLoading,
  445. ]);
  446. if (registrationMode === RegistrationMode.RESTRICTED && isSuccessToRagistration && !isEmailAuthenticationEnabled) {
  447. return <CompleteUserRegistration />;
  448. }
  449. return (
  450. <div className={moduleClass}>
  451. <div className="nologin-dialog mx-auto rounded-4 rounded-top-0" id="nologin-dialog" data-testid="login-form">
  452. <div className="row mx-0">
  453. <div className="col-12 px-md-4 pb-5">
  454. <ReactCardFlip isFlipped={isRegistering} flipDirection="horizontal" cardZIndex="3">
  455. <div className="front">
  456. {isLocalOrLdapStrategiesEnabled && renderLocalOrLdapLoginForm()}
  457. {isLocalOrLdapStrategiesEnabled && isSomeExternalAuthEnabled && (
  458. <div className="text-center text-line d-flex align-items-center mb-3">
  459. <p className="text-white mb-0">{t('or')}</p>
  460. </div>
  461. )}
  462. {isSomeExternalAuthEnabled && renderExternalAuthLoginForm()}
  463. {isLocalOrLdapStrategiesEnabled && isPasswordResetEnabled && (
  464. <div className="mt-4">
  465. <a
  466. href="/forgot-password"
  467. className="btn btn-sm btn-secondary btn-function col-10 col-sm-9 mx-auto py-1 d-flex"
  468. style={{ pointerEvents: isLoading ? 'none' : 'auto' }}
  469. >
  470. <span className="material-symbols-outlined">vpn_key</span>
  471. <span className="flex-grow-1">{t('forgot_password.forgot_password')}</span>
  472. </a>
  473. </div>
  474. )}
  475. {/* Sign up link */}
  476. {isRegistrationEnabled && (
  477. <div className="mt-2">
  478. <a
  479. href="#register"
  480. className="btn btn-sm btn-secondary btn-function col-10 col-sm-9 mx-auto py-1 d-flex"
  481. style={{ pointerEvents: isLoading ? 'none' : 'auto' }}
  482. onClick={switchForm}
  483. >
  484. <span className="material-symbols-outlined">person_add</span>
  485. <span className="flex-grow-1">{t('Sign up is here')}</span>
  486. </a>
  487. </div>
  488. )}
  489. </div>
  490. <div className="back">
  491. {/* Register form for /login#register */}
  492. {isRegistrationEnabled && renderRegisterForm()}
  493. </div>
  494. </ReactCardFlip>
  495. </div>
  496. </div>
  497. <a href="https://growi.org" className="link-growi-org ps-3">
  498. <span className="growi">GROWI</span><span className="org">.org</span>
  499. </a>
  500. </div>
  501. </div>
  502. );
  503. };