LoginForm.tsx 21 KB

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