LoginForm.tsx 21 KB

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