LoginForm.tsx 20 KB

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