LoginForm.tsx 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601
  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. {/* Unsettled 11.17 meiri-k */}
  155. <i className="fa fa-spinner fa-pulse" />
  156. </div>
  157. {/* !! - END OF HIDDEN ELEMENT - !! */}
  158. {isLdapSetupFailed && (
  159. <div className="alert alert-warning small">
  160. <strong><span className="material-symbols-outlined">info</span>{t('login.enabled_ldap_has_configuration_problem')}</strong><br />
  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. <span className="input-group-text">
  169. <span className="material-symbols-outlined">person</span>
  170. </span>
  171. <input
  172. type="text"
  173. className="form-control rounded-0"
  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="input-group-text text-success">
  181. <span className="material-symbols-outlined">select_check_box</span>LDAP
  182. </small>
  183. )}
  184. </div>
  185. <div className="input-group">
  186. <span className="input-group-text">
  187. <span className="material-symbols-outlined">lock</span>
  188. </span>
  189. <input
  190. type="password"
  191. className="form-control rounded-0"
  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. id="login"
  202. className="btn btn-fill rounded-0 login mx-auto"
  203. data-testid="btnSubmitForLogin"
  204. disabled={isLoading}
  205. >
  206. <div className="eff"></div>
  207. <span className="btn-label">
  208. {isLoading ? (
  209. <LoadingSpinner />
  210. ) : (
  211. <span className="material-symbols-outlined">login</span>
  212. )}
  213. </span>
  214. <span className="btn-label-text">{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 renderExternalAuthInput = useCallback((auth) => {
  232. const authIconNames = {
  233. google: 'google',
  234. github: 'github',
  235. facebook: 'facebook',
  236. oidc: 'openid',
  237. saml: 'key',
  238. };
  239. return (
  240. <div key={auth} className="col-6 my-2">
  241. <button type="button" className="btn btn-fill rounded-0" id={auth} onClick={handleLoginWithExternalAuth}>
  242. <div className="eff"></div>
  243. <span className="btn-label">
  244. <i className={`fa fa-${authIconNames[auth]}`}></i>
  245. </span>
  246. <span className="btn-label-text">{t('Sign in')}</span>
  247. </button>
  248. <div className="small text-end">by {auth} Account</div>
  249. </div>
  250. );
  251. }, [handleLoginWithExternalAuth, t]);
  252. const renderExternalAuthLoginForm = useCallback(() => {
  253. const { isLocalStrategySetup, isLdapStrategySetup, objOfIsExternalAuthEnableds } = props;
  254. const isExternalAuthCollapsible = isLocalStrategySetup || isLdapStrategySetup;
  255. const collapsibleClass = isExternalAuthCollapsible ? 'collapse collapse-external-auth' : '';
  256. return (
  257. <>
  258. <div className="grw-external-auth-form border-top border-bottom">
  259. <div id="external-auth" className={`external-auth ${collapsibleClass}`}>
  260. <div className="row mt-2">
  261. {Object.keys(objOfIsExternalAuthEnableds).map((auth) => {
  262. if (!objOfIsExternalAuthEnableds[auth]) {
  263. return;
  264. }
  265. return renderExternalAuthInput(auth);
  266. })}
  267. </div>
  268. </div>
  269. </div>
  270. <div className="text-center">
  271. <button
  272. type="button"
  273. className="btn btn-secondary btn-external-auth-tab btn-sm rounded-0 mb-3"
  274. data-bs-toggle={isExternalAuthCollapsible ? 'collapse' : ''}
  275. data-bs-target="#external-auth"
  276. aria-expanded="false"
  277. aria-controls="external-auth"
  278. >
  279. External Auth
  280. </button>
  281. </div>
  282. </>
  283. );
  284. }, [props, renderExternalAuthInput]);
  285. const resetRegisterErrors = useCallback(() => {
  286. if (registerErrors.length === 0) return;
  287. setRegisterErrors([]);
  288. }, [registerErrors.length]);
  289. const handleRegisterFormSubmit = useCallback(async(e, requestPath) => {
  290. e.preventDefault();
  291. setEmailForRegistrationOrder('');
  292. setIsSuccessToRagistration(false);
  293. setIsLoading(true);
  294. const registerForm = {
  295. username: usernameForRegister,
  296. name: nameForRegister,
  297. email: emailForRegister,
  298. password: passwordForRegister,
  299. };
  300. try {
  301. const res = await apiv3Post(requestPath, { registerForm });
  302. setIsSuccessToRagistration(true);
  303. resetRegisterErrors();
  304. const { redirectTo } = res.data;
  305. if (redirectTo != null) {
  306. router.push(redirectTo);
  307. }
  308. if (isEmailAuthenticationEnabled) {
  309. setEmailForRegistrationOrder(emailForRegister);
  310. return;
  311. }
  312. }
  313. catch (err) {
  314. // Execute if error exists
  315. if (err != null || err.length > 0) {
  316. setRegisterErrors(err);
  317. }
  318. setIsLoading(false);
  319. }
  320. return;
  321. }, [usernameForRegister, nameForRegister, emailForRegister, passwordForRegister, resetRegisterErrors, router, isEmailAuthenticationEnabled]);
  322. const switchForm = useCallback(() => {
  323. setIsRegistering(!isRegistering);
  324. resetLoginErrors();
  325. resetRegisterErrors();
  326. }, [isRegistering, resetLoginErrors, resetRegisterErrors]);
  327. const renderRegisterForm = useCallback(() => {
  328. let registerAction = '/register';
  329. let submitText = t('Sign up');
  330. if (isEmailAuthenticationEnabled) {
  331. registerAction = '/user-activation/register';
  332. submitText = t('page_register.send_email');
  333. }
  334. return (
  335. <React.Fragment>
  336. {registrationMode === RegistrationMode.RESTRICTED && (
  337. <p className="alert alert-warning">
  338. {t('page_register.notice.restricted')}
  339. <br />
  340. {t('page_register.notice.restricted_defail')}
  341. </p>
  342. )}
  343. { (!isMailerSetup && isEmailAuthenticationEnabled) && (
  344. <p className="alert alert-danger">
  345. <span>{t('commons:alert.please_enable_mailer')}</span>
  346. </p>
  347. )}
  348. {
  349. registerErrors != null && registerErrors.length > 0 && (
  350. <p className="alert alert-danger">
  351. {registerErrors.map(err => (
  352. <span>
  353. {t(err.message)}<br />
  354. </span>
  355. ))}
  356. </p>
  357. )
  358. }
  359. {
  360. (isEmailAuthenticationEnabled && isSuccessToRagistration) && (
  361. <p className="alert alert-success">
  362. <span>{t('message.successfully_send_email_auth', { email: emailForRegistrationOrder })}</span>
  363. </p>
  364. )
  365. }
  366. <form role="form" onSubmit={e => handleRegisterFormSubmit(e, registerAction)} id="register-form">
  367. {!isEmailAuthenticationEnabled && (
  368. <div>
  369. <div className="input-group" id="input-group-username">
  370. <span className="input-group-text">
  371. <span className="material-symbols-outlined">person</span>
  372. </span>
  373. {/* username */}
  374. <input
  375. type="text"
  376. className="form-control rounded-0"
  377. onChange={(e) => { setUsernameForRegister(e.target.value) }}
  378. placeholder={t('User ID')}
  379. name="username"
  380. defaultValue={props.username}
  381. required
  382. />
  383. </div>
  384. <p className="form-text text-danger">
  385. <span id="help-block-username"></span>
  386. </p>
  387. <div className="input-group">
  388. <span className="input-group-text">
  389. <span className="material-symbols-outlined">sell</span>
  390. </span>
  391. {/* name */}
  392. <input
  393. type="text"
  394. className="form-control rounded-0"
  395. onChange={(e) => { setNameForRegister(e.target.value) }}
  396. placeholder={t('Name')}
  397. name="name"
  398. defaultValue={props.name}
  399. required
  400. />
  401. </div>
  402. </div>
  403. )}
  404. <div className="input-group">
  405. <span className="input-group-text">
  406. <span className="material-symbols-outlined">mail</span>
  407. </span>
  408. {/* email */}
  409. <input
  410. type="email"
  411. disabled={!isMailerSetup && isEmailAuthenticationEnabled}
  412. className="form-control rounded-0"
  413. onChange={(e) => { setEmailForRegister(e.target.value) }}
  414. placeholder={t('Email')}
  415. name="email"
  416. defaultValue={props.email}
  417. required
  418. />
  419. </div>
  420. {registrationWhitelist.length > 0 && (
  421. <>
  422. <p className="form-text">{t('page_register.form_help.email')}</p>
  423. <ul>
  424. {registrationWhitelist.map((elem) => {
  425. return (
  426. <li key={elem}>
  427. <code>{elem}</code>
  428. </li>
  429. );
  430. })}
  431. </ul>
  432. </>
  433. )}
  434. {!isEmailAuthenticationEnabled && (
  435. <div>
  436. <div className="input-group">
  437. <span className="input-group-text">
  438. <span className="material-symbols-outlined">lock</span>
  439. </span>
  440. {/* Password */}
  441. <input
  442. type="password"
  443. className="form-control rounded-0"
  444. onChange={(e) => { setPasswordForRegister(e.target.value) }}
  445. placeholder={t('Password')}
  446. name="password"
  447. required
  448. />
  449. </div>
  450. </div>
  451. )}
  452. {/* Sign up button (submit) */}
  453. <div className="input-group justify-content-center my-4">
  454. <button
  455. type="submit"
  456. className="btn btn-fill rounded-0"
  457. id="register"
  458. disabled={(!isMailerSetup && isEmailAuthenticationEnabled) || isLoading}
  459. >
  460. <div className="eff"></div>
  461. <span className="btn-label">
  462. {isLoading ? (
  463. <LoadingSpinner />
  464. ) : (
  465. <span className="material-symbols-outlined">login</span>
  466. )}
  467. </span>
  468. <span className="btn-label-text">{submitText}</span>
  469. </button>
  470. </div>
  471. </form>
  472. <div className="border-bottom"></div>
  473. <div className="row">
  474. <div className="text-end col-12 mt-2 py-2">
  475. <a
  476. href="#login"
  477. id="login"
  478. className="link-switch"
  479. style={{ pointerEvents: isLoading ? 'none' : 'auto' }}
  480. onClick={switchForm}
  481. >
  482. <span className="material-symbols-outlined">login</span>{t('Sign in is here')}
  483. </a>
  484. </div>
  485. </div>
  486. </React.Fragment>
  487. );
  488. }, [
  489. t, isEmailAuthenticationEnabled, registrationMode, isMailerSetup, registerErrors, isSuccessToRagistration,
  490. emailForRegistrationOrder, props.username, props.name, props.email, registrationWhitelist, switchForm, handleRegisterFormSubmit, isLoading,
  491. ]);
  492. if (registrationMode === RegistrationMode.RESTRICTED && isSuccessToRagistration && !isEmailAuthenticationEnabled) {
  493. return <CompleteUserRegistration />;
  494. }
  495. return (
  496. <div className={`login-form ${styles['login-form']}`}>
  497. <div className="nologin-dialog mx-auto" id="nologin-dialog" data-testid="login-form">
  498. <div className="row mx-0">
  499. <div className="col-12">
  500. <ReactCardFlip isFlipped={isRegistering} flipDirection="horizontal" cardZIndex="3">
  501. <div className="front">
  502. {isLocalOrLdapStrategiesEnabled && renderLocalOrLdapLoginForm()}
  503. {isSomeExternalAuthEnabled && renderExternalAuthLoginForm()}
  504. {isLocalOrLdapStrategiesEnabled && isPasswordResetEnabled && (
  505. <div className="text-end mb-2">
  506. <a href="/forgot-password" className="d-block link-switch">
  507. <span className="material-symbols-outlined">vpn_key</span>{t('forgot_password.forgot_password')}
  508. </a>
  509. </div>
  510. )}
  511. {/* Sign up link */}
  512. {isRegistrationEnabled && (
  513. <div className="text-end mb-2">
  514. <a
  515. href="#register"
  516. id="register"
  517. className="link-switch"
  518. style={{ pointerEvents: isLoading ? 'none' : 'auto' }}
  519. onClick={switchForm}
  520. >
  521. <span className="material-symbols-outlined">check_box</span> {t('Sign up is here')}
  522. </a>
  523. </div>
  524. )}
  525. </div>
  526. <div className="back">
  527. {/* Register form for /login#register */}
  528. {isRegistrationEnabled && renderRegisterForm()}
  529. </div>
  530. </ReactCardFlip>
  531. </div>
  532. </div>
  533. <a href="https://growi.org" className="link-growi-org ps-3">
  534. <span className="growi">GROWI</span>.<span className="org">org</span>
  535. </a>
  536. </div>
  537. </div>
  538. );
  539. };