LoginForm.tsx 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595
  1. import React, {
  2. useState, useEffect, useCallback,
  3. } from 'react';
  4. import { useTranslation } from 'next-i18next';
  5. import { useRouter } from 'next/router';
  6. import ReactCardFlip from 'react-card-flip';
  7. import { apiv3Post } from '~/client/util/apiv3-client';
  8. import type { IExternalAccountLoginError } from '~/interfaces/errors/external-account-login-error';
  9. import { LoginErrorCode } from '~/interfaces/errors/login-error';
  10. import type { IErrorV3 } from '~/interfaces/errors/v3-error';
  11. import { RegistrationMode } from '~/interfaces/registration-mode';
  12. import { toArrayIfNot } from '~/utils/array-utils';
  13. import { CompleteUserRegistration } from './CompleteUserRegistration';
  14. import styles from './LoginForm.module.scss';
  15. type LoginFormProps = {
  16. username?: string,
  17. name?: string,
  18. email?: string,
  19. isEmailAuthenticationEnabled: boolean,
  20. registrationMode: RegistrationMode,
  21. registrationWhitelist: string[],
  22. isPasswordResetEnabled: boolean,
  23. isLocalStrategySetup: boolean,
  24. isLdapStrategySetup: boolean,
  25. isLdapSetupFailed: boolean,
  26. objOfIsExternalAuthEnableds?: any,
  27. isMailerSetup?: boolean,
  28. externalAccountLoginError?: IExternalAccountLoginError,
  29. }
  30. export const LoginForm = (props: LoginFormProps): JSX.Element => {
  31. const { t } = useTranslation();
  32. const router = useRouter();
  33. const {
  34. isLocalStrategySetup, isLdapStrategySetup, isLdapSetupFailed, isPasswordResetEnabled,
  35. isEmailAuthenticationEnabled, registrationMode, registrationWhitelist, isMailerSetup, objOfIsExternalAuthEnableds,
  36. } = props;
  37. const isLocalOrLdapStrategiesEnabled = isLocalStrategySetup || isLdapStrategySetup;
  38. const isSomeExternalAuthEnabled = Object.values(objOfIsExternalAuthEnableds).some(elem => elem);
  39. // states
  40. const [isRegistering, setIsRegistering] = useState(false);
  41. const [isLoading, setIsLoading] = useState(false);
  42. // For Login
  43. const [usernameForLogin, setUsernameForLogin] = useState('');
  44. const [passwordForLogin, setPasswordForLogin] = useState('');
  45. const [loginErrors, setLoginErrors] = useState<IErrorV3[]>([]);
  46. // For Register
  47. const [usernameForRegister, setUsernameForRegister] = useState('');
  48. const [nameForRegister, setNameForRegister] = useState('');
  49. const [emailForRegister, setEmailForRegister] = useState('');
  50. const [passwordForRegister, setPasswordForRegister] = useState('');
  51. const [registerErrors, setRegisterErrors] = useState<IErrorV3[]>([]);
  52. // For UserActivation
  53. const [emailForRegistrationOrder, setEmailForRegistrationOrder] = useState('');
  54. const [isSuccessToRagistration, setIsSuccessToRagistration] = useState(false);
  55. const isRegistrationEnabled = isLocalStrategySetup && registrationMode !== RegistrationMode.CLOSED;
  56. useEffect(() => {
  57. const { hash } = window.location;
  58. if (hash === '#register') {
  59. setIsRegistering(true);
  60. }
  61. }, []);
  62. const tWithOpt = useCallback((key: string, opt?: any): string => {
  63. if (typeof opt === 'object') {
  64. return t(key, opt as object);
  65. }
  66. return t(key);
  67. }, [t]);
  68. const handleLoginWithExternalAuth = useCallback((e) => {
  69. const auth = e.currentTarget.id;
  70. window.location.href = `/passport/${auth}`;
  71. }, []);
  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. {/* Import font-awesome to prevent MongoStore.js "Unable to find the session to touch" error */}
  152. <div className="visually-hidden">
  153. {/* Unsettled 11.17 meiri-k */}
  154. <i className="fa fa-spinner fa-pulse" />
  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. <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="input-group-text">
  168. <span className="material-symbols-outlined">person</span>
  169. </span>
  170. <input
  171. type="text"
  172. className="form-control rounded-0"
  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="input-group-text text-success">
  180. <span className="material-symbols-outlined">select_check_box</span>LDAP
  181. </small>
  182. )}
  183. </div>
  184. <div className="input-group">
  185. <span className="input-group-text">
  186. <span className="material-symbols-outlined">lock</span>
  187. </span>
  188. <input
  189. type="password"
  190. className="form-control rounded-0"
  191. data-testid="tiPasswordForLogin"
  192. placeholder="Password"
  193. onChange={(e) => { setPasswordForLogin(e.target.value) }}
  194. name="passwordForLogin"
  195. />
  196. </div>
  197. <div className="input-group my-4">
  198. <button
  199. type="submit"
  200. id="login"
  201. className="btn btn-fill rounded-0 login mx-auto"
  202. data-testid="btnSubmitForLogin"
  203. disabled={isLoading}
  204. >
  205. <div className="eff"></div>
  206. <span className="btn-label">
  207. {/* spinner.Tentative decision meiri-k 11.17 */}
  208. <span className="material-symbols-outlined">{isLoading ? 'hoge' : 'login'}</span>
  209. </span>
  210. <span className="btn-label-text">{t('Sign in')}</span>
  211. </button>
  212. </div>
  213. </form>
  214. </>
  215. );
  216. }, [
  217. props,
  218. separateErrorsBasedOnErrorCode,
  219. loginErrors,
  220. generateDangerouslySetErrors,
  221. generateSafelySetErrors,
  222. isLdapSetupFailed,
  223. t,
  224. handleLoginWithLocalSubmit,
  225. isLoading,
  226. ]);
  227. const renderExternalAuthInput = useCallback((auth) => {
  228. const authIconNames = {
  229. google: 'google',
  230. github: 'github',
  231. facebook: 'facebook',
  232. oidc: 'openid',
  233. saml: 'key',
  234. };
  235. return (
  236. <div key={auth} className="col-6 my-2">
  237. <button type="button" className="btn btn-fill rounded-0" id={auth} onClick={handleLoginWithExternalAuth}>
  238. <div className="eff"></div>
  239. <span className="btn-label">
  240. <i className={`fa fa-${authIconNames[auth]}`}></i>
  241. </span>
  242. <span className="btn-label-text">{t('Sign in')}</span>
  243. </button>
  244. <div className="small text-end">by {auth} Account</div>
  245. </div>
  246. );
  247. }, [handleLoginWithExternalAuth, t]);
  248. const renderExternalAuthLoginForm = useCallback(() => {
  249. const { isLocalStrategySetup, isLdapStrategySetup, objOfIsExternalAuthEnableds } = props;
  250. const isExternalAuthCollapsible = isLocalStrategySetup || isLdapStrategySetup;
  251. const collapsibleClass = isExternalAuthCollapsible ? 'collapse collapse-external-auth' : '';
  252. return (
  253. <>
  254. <div className="grw-external-auth-form border-top border-bottom">
  255. <div id="external-auth" className={`external-auth ${collapsibleClass}`}>
  256. <div className="row mt-2">
  257. {Object.keys(objOfIsExternalAuthEnableds).map((auth) => {
  258. if (!objOfIsExternalAuthEnableds[auth]) {
  259. return;
  260. }
  261. return renderExternalAuthInput(auth);
  262. })}
  263. </div>
  264. </div>
  265. </div>
  266. <div className="text-center">
  267. <button
  268. type="button"
  269. className="btn btn-secondary btn-external-auth-tab btn-sm rounded-0 mb-3"
  270. data-bs-toggle={isExternalAuthCollapsible ? 'collapse' : ''}
  271. data-bs-target="#external-auth"
  272. aria-expanded="false"
  273. aria-controls="external-auth"
  274. >
  275. External Auth
  276. </button>
  277. </div>
  278. </>
  279. );
  280. }, [props, renderExternalAuthInput]);
  281. const resetRegisterErrors = useCallback(() => {
  282. if (registerErrors.length === 0) return;
  283. setRegisterErrors([]);
  284. }, [registerErrors.length]);
  285. const handleRegisterFormSubmit = useCallback(async(e, requestPath) => {
  286. e.preventDefault();
  287. setEmailForRegistrationOrder('');
  288. setIsSuccessToRagistration(false);
  289. setIsLoading(true);
  290. const registerForm = {
  291. username: usernameForRegister,
  292. name: nameForRegister,
  293. email: emailForRegister,
  294. password: passwordForRegister,
  295. };
  296. try {
  297. const res = await apiv3Post(requestPath, { registerForm });
  298. setIsSuccessToRagistration(true);
  299. resetRegisterErrors();
  300. const { redirectTo } = res.data;
  301. if (redirectTo != null) {
  302. router.push(redirectTo);
  303. }
  304. if (isEmailAuthenticationEnabled) {
  305. setEmailForRegistrationOrder(emailForRegister);
  306. return;
  307. }
  308. }
  309. catch (err) {
  310. // Execute if error exists
  311. if (err != null || err.length > 0) {
  312. setRegisterErrors(err);
  313. }
  314. setIsLoading(false);
  315. }
  316. return;
  317. }, [usernameForRegister, nameForRegister, emailForRegister, passwordForRegister, resetRegisterErrors, router, isEmailAuthenticationEnabled]);
  318. const switchForm = useCallback(() => {
  319. setIsRegistering(!isRegistering);
  320. resetLoginErrors();
  321. resetRegisterErrors();
  322. }, [isRegistering, resetLoginErrors, resetRegisterErrors]);
  323. const renderRegisterForm = useCallback(() => {
  324. let registerAction = '/register';
  325. let submitText = t('Sign up');
  326. if (isEmailAuthenticationEnabled) {
  327. registerAction = '/user-activation/register';
  328. submitText = t('page_register.send_email');
  329. }
  330. return (
  331. <React.Fragment>
  332. {registrationMode === RegistrationMode.RESTRICTED && (
  333. <p className="alert alert-warning">
  334. {t('page_register.notice.restricted')}
  335. <br />
  336. {t('page_register.notice.restricted_defail')}
  337. </p>
  338. )}
  339. { (!isMailerSetup && isEmailAuthenticationEnabled) && (
  340. <p className="alert alert-danger">
  341. <span>{t('commons:alert.please_enable_mailer')}</span>
  342. </p>
  343. )}
  344. {
  345. registerErrors != null && registerErrors.length > 0 && (
  346. <p className="alert alert-danger">
  347. {registerErrors.map(err => (
  348. <span>
  349. {t(err.message)}<br />
  350. </span>
  351. ))}
  352. </p>
  353. )
  354. }
  355. {
  356. (isEmailAuthenticationEnabled && isSuccessToRagistration) && (
  357. <p className="alert alert-success">
  358. <span>{t('message.successfully_send_email_auth', { email: emailForRegistrationOrder })}</span>
  359. </p>
  360. )
  361. }
  362. <form role="form" onSubmit={e => handleRegisterFormSubmit(e, registerAction)} id="register-form">
  363. {!isEmailAuthenticationEnabled && (
  364. <div>
  365. <div className="input-group" id="input-group-username">
  366. <span className="input-group-text">
  367. <span className="material-symbols-outlined">person</span>
  368. </span>
  369. {/* username */}
  370. <input
  371. type="text"
  372. className="form-control rounded-0"
  373. onChange={(e) => { setUsernameForRegister(e.target.value) }}
  374. placeholder={t('User ID')}
  375. name="username"
  376. defaultValue={props.username}
  377. required
  378. />
  379. </div>
  380. <p className="form-text text-danger">
  381. <span id="help-block-username"></span>
  382. </p>
  383. <div className="input-group">
  384. <span className="input-group-text">
  385. <span className="material-symbols-outlined">sell</span>
  386. </span>
  387. {/* name */}
  388. <input
  389. type="text"
  390. className="form-control rounded-0"
  391. onChange={(e) => { setNameForRegister(e.target.value) }}
  392. placeholder={t('Name')}
  393. name="name"
  394. defaultValue={props.name}
  395. required
  396. />
  397. </div>
  398. </div>
  399. )}
  400. <div className="input-group">
  401. <span className="input-group-text">
  402. <span className="material-symbols-outlined">mail</span>
  403. </span>
  404. {/* email */}
  405. <input
  406. type="email"
  407. disabled={!isMailerSetup && isEmailAuthenticationEnabled}
  408. className="form-control rounded-0"
  409. onChange={(e) => { setEmailForRegister(e.target.value) }}
  410. placeholder={t('Email')}
  411. name="email"
  412. defaultValue={props.email}
  413. required
  414. />
  415. </div>
  416. {registrationWhitelist.length > 0 && (
  417. <>
  418. <p className="form-text">{t('page_register.form_help.email')}</p>
  419. <ul>
  420. {registrationWhitelist.map((elem) => {
  421. return (
  422. <li key={elem}>
  423. <code>{elem}</code>
  424. </li>
  425. );
  426. })}
  427. </ul>
  428. </>
  429. )}
  430. {!isEmailAuthenticationEnabled && (
  431. <div>
  432. <div className="input-group">
  433. <span className="input-group-text">
  434. <span className="material-symbols-outlined">lock</span>
  435. </span>
  436. {/* Password */}
  437. <input
  438. type="password"
  439. className="form-control rounded-0"
  440. onChange={(e) => { setPasswordForRegister(e.target.value) }}
  441. placeholder={t('Password')}
  442. name="password"
  443. required
  444. />
  445. </div>
  446. </div>
  447. )}
  448. {/* Sign up button (submit) */}
  449. <div className="input-group justify-content-center my-4">
  450. <button
  451. type="submit"
  452. className="btn btn-fill rounded-0"
  453. id="register"
  454. disabled={(!isMailerSetup && isEmailAuthenticationEnabled) || isLoading}
  455. >
  456. <div className="eff"></div>
  457. <span className="btn-label">
  458. {/* spinner.Tentative decision meiri-k 11.17 */}
  459. <span className="material-symbols-outlined">{isLoading ? 'hoge' : 'login'}</span>
  460. </span>
  461. <span className="btn-label-text">{submitText}</span>
  462. </button>
  463. </div>
  464. </form>
  465. <div className="border-bottom"></div>
  466. <div className="row">
  467. <div className="text-end col-12 mt-2 py-2">
  468. <a
  469. href="#login"
  470. id="login"
  471. className="link-switch"
  472. style={{ pointerEvents: isLoading ? 'none' : 'auto' }}
  473. onClick={switchForm}
  474. >
  475. <span className="material-symbols-outlined">login</span>{t('Sign in is here')}
  476. </a>
  477. </div>
  478. </div>
  479. </React.Fragment>
  480. );
  481. }, [
  482. t, isEmailAuthenticationEnabled, registrationMode, isMailerSetup, registerErrors, isSuccessToRagistration,
  483. emailForRegistrationOrder, props.username, props.name, props.email, registrationWhitelist, switchForm, handleRegisterFormSubmit, isLoading,
  484. ]);
  485. if (registrationMode === RegistrationMode.RESTRICTED && isSuccessToRagistration && !isEmailAuthenticationEnabled) {
  486. return <CompleteUserRegistration />;
  487. }
  488. return (
  489. <div className={`login-form ${styles['login-form']}`}>
  490. <div className="nologin-dialog mx-auto" id="nologin-dialog" data-testid="login-form">
  491. <div className="row mx-0">
  492. <div className="col-12">
  493. <ReactCardFlip isFlipped={isRegistering} flipDirection="horizontal" cardZIndex="3">
  494. <div className="front">
  495. {isLocalOrLdapStrategiesEnabled && renderLocalOrLdapLoginForm()}
  496. {isSomeExternalAuthEnabled && renderExternalAuthLoginForm()}
  497. {isLocalOrLdapStrategiesEnabled && isPasswordResetEnabled && (
  498. <div className="text-end mb-2">
  499. <a href="/forgot-password" className="d-block link-switch">
  500. <span className="material-symbols-outlined">vpn_key</span>{t('forgot_password.forgot_password')}
  501. </a>
  502. </div>
  503. )}
  504. {/* Sign up link */}
  505. {isRegistrationEnabled && (
  506. <div className="text-end mb-2">
  507. <a
  508. href="#register"
  509. id="register"
  510. className="link-switch"
  511. style={{ pointerEvents: isLoading ? 'none' : 'auto' }}
  512. onClick={switchForm}
  513. >
  514. <span className="material-symbols-outlined">check_box</span> {t('Sign up is here')}
  515. </a>
  516. </div>
  517. )}
  518. </div>
  519. <div className="back">
  520. {/* Register form for /login#register */}
  521. {isRegistrationEnabled && renderRegisterForm()}
  522. </div>
  523. </ReactCardFlip>
  524. </div>
  525. </div>
  526. <a href="https://growi.org" className="link-growi-org ps-3">
  527. <span className="growi">GROWI</span>.<span className="org">org</span>
  528. </a>
  529. </div>
  530. </div>
  531. );
  532. };