LoginForm.tsx 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596
  1. import React, {
  2. useState, useEffect, useCallback,
  3. } from 'react';
  4. import { LoadingSpinner } from '@growi/ui/dist/components';
  5. import { useTranslation } from 'next-i18next';
  6. import { useRouter } from 'next/router';
  7. import ReactCardFlip from 'react-card-flip';
  8. import { apiv3Post } from '~/client/util/apiv3-client';
  9. import type { IExternalAccountLoginError } from '~/interfaces/errors/external-account-login-error';
  10. import { LoginErrorCode } from '~/interfaces/errors/login-error';
  11. import type { IErrorV3 } from '~/interfaces/errors/v3-error';
  12. import { RegistrationMode } from '~/interfaces/registration-mode';
  13. import { toArrayIfNot } from '~/utils/array-utils';
  14. import { CompleteUserRegistration } from './CompleteUserRegistration';
  15. import styles from './LoginForm.module.scss';
  16. const moduleClass = styles['login-form'];
  17. type LoginFormProps = {
  18. username?: string,
  19. name?: string,
  20. email?: string,
  21. isEmailAuthenticationEnabled: boolean,
  22. registrationMode: RegistrationMode,
  23. registrationWhitelist: string[],
  24. isPasswordResetEnabled: boolean,
  25. isLocalStrategySetup: boolean,
  26. isLdapStrategySetup: boolean,
  27. isLdapSetupFailed: boolean,
  28. objOfIsExternalAuthEnableds?: any,
  29. isMailerSetup?: boolean,
  30. externalAccountLoginError?: IExternalAccountLoginError,
  31. }
  32. export const LoginForm = (props: LoginFormProps): JSX.Element => {
  33. const { t } = useTranslation();
  34. const router = useRouter();
  35. const {
  36. isLocalStrategySetup, isLdapStrategySetup, isLdapSetupFailed, isPasswordResetEnabled,
  37. isEmailAuthenticationEnabled, registrationMode, registrationWhitelist, isMailerSetup, objOfIsExternalAuthEnableds,
  38. } = props;
  39. const isLocalOrLdapStrategiesEnabled = isLocalStrategySetup || isLdapStrategySetup;
  40. const isSomeExternalAuthEnabled = Object.values(objOfIsExternalAuthEnableds).some(elem => elem);
  41. // states
  42. const [isRegistering, setIsRegistering] = useState(false);
  43. const [isLoading, setIsLoading] = useState(false);
  44. // For Login
  45. const [usernameForLogin, setUsernameForLogin] = useState('');
  46. const [passwordForLogin, setPasswordForLogin] = useState('');
  47. const [loginErrors, setLoginErrors] = useState<IErrorV3[]>([]);
  48. // For Register
  49. const [usernameForRegister, setUsernameForRegister] = useState('');
  50. const [nameForRegister, setNameForRegister] = useState('');
  51. const [emailForRegister, setEmailForRegister] = useState('');
  52. const [passwordForRegister, setPasswordForRegister] = useState('');
  53. const [registerErrors, setRegisterErrors] = useState<IErrorV3[]>([]);
  54. // For UserActivation
  55. const [emailForRegistrationOrder, setEmailForRegistrationOrder] = useState('');
  56. const [isSuccessToRagistration, setIsSuccessToRagistration] = useState(false);
  57. const isRegistrationEnabled = isLocalStrategySetup && registrationMode !== RegistrationMode.CLOSED;
  58. useEffect(() => {
  59. const { hash } = window.location;
  60. if (hash === '#register') {
  61. setIsRegistering(true);
  62. }
  63. }, []);
  64. const tWithOpt = useCallback((key: string, opt?: any) => {
  65. if (typeof opt === 'object') {
  66. return t(key, opt).toString();
  67. }
  68. return t(key);
  69. }, [t]);
  70. const handleLoginWithExternalAuth = useCallback((e) => {
  71. const auth = e.currentTarget.id;
  72. window.location.href = `/passport/${auth}`;
  73. }, []);
  74. const resetLoginErrors = useCallback(() => {
  75. if (loginErrors.length === 0) return;
  76. setLoginErrors([]);
  77. }, [loginErrors.length]);
  78. const handleLoginWithLocalSubmit = useCallback(async(e) => {
  79. e.preventDefault();
  80. resetLoginErrors();
  81. setIsLoading(true);
  82. const loginForm = {
  83. username: usernameForLogin,
  84. password: passwordForLogin,
  85. };
  86. try {
  87. const res = await apiv3Post('/login', { loginForm });
  88. const { redirectTo } = res.data;
  89. if (redirectTo != null) {
  90. return router.push(redirectTo);
  91. }
  92. return router.push('/');
  93. }
  94. catch (err) {
  95. const errs = toArrayIfNot(err);
  96. setLoginErrors(errs);
  97. setIsLoading(false);
  98. }
  99. return;
  100. }, [passwordForLogin, resetLoginErrors, router, usernameForLogin]);
  101. // separate errors based on error code
  102. const separateErrorsBasedOnErrorCode = useCallback((errors: IErrorV3[]) => {
  103. const loginErrorListForDangerouslySetInnerHTML: IErrorV3[] = [];
  104. const loginErrorList: IErrorV3[] = [];
  105. errors.forEach((err) => {
  106. if (err.code === LoginErrorCode.PROVIDER_DUPLICATED_USERNAME_EXCEPTION) {
  107. loginErrorListForDangerouslySetInnerHTML.push(err);
  108. }
  109. else {
  110. loginErrorList.push(err);
  111. }
  112. });
  113. return [loginErrorListForDangerouslySetInnerHTML, loginErrorList];
  114. }, []);
  115. // wrap error elements which use dangerouslySetInnerHtml
  116. const generateDangerouslySetErrors = useCallback((errors: IErrorV3[]): JSX.Element => {
  117. if (errors == null || errors.length === 0) return <></>;
  118. return (
  119. <div className="alert alert-danger">
  120. {errors.map((err) => {
  121. // eslint-disable-next-line react/no-danger
  122. return <small dangerouslySetInnerHTML={{ __html: tWithOpt(err.message, err.args) }}></small>;
  123. })}
  124. </div>
  125. );
  126. }, [tWithOpt]);
  127. // wrap error elements which do not use dangerouslySetInnerHtml
  128. const generateSafelySetErrors = useCallback((errors: (IErrorV3 | IExternalAccountLoginError)[]): JSX.Element => {
  129. if (errors == null || errors.length === 0) return <></>;
  130. return (
  131. <ul className="alert alert-danger">
  132. {errors.map((err, index) => (
  133. <li className={index > 0 ? 'mt-1' : ''}>
  134. {tWithOpt(err.message, err.args)}
  135. </li>
  136. ))}
  137. </ul>
  138. );
  139. }, [tWithOpt]);
  140. const renderLocalOrLdapLoginForm = useCallback(() => {
  141. const { isLdapStrategySetup } = props;
  142. // separate login errors into two arrays based on error code
  143. const [loginErrorListForDangerouslySetInnerHTML, loginErrorList] = separateErrorsBasedOnErrorCode(loginErrors);
  144. // Generate login error elements using dangerouslySetInnerHTML
  145. const loginErrorElementWithDangerouslySetInnerHTML = generateDangerouslySetErrors(loginErrorListForDangerouslySetInnerHTML);
  146. // Generate login error elements using <ul>, <li>
  147. const loginErrorElement = props.externalAccountLoginError != null
  148. ? generateSafelySetErrors([...loginErrorList, props.externalAccountLoginError])
  149. : generateSafelySetErrors(loginErrorList);
  150. return (
  151. <>
  152. {/* !! - DO NOT DELETE HIDDEN ELEMENT - !! -- 7.12 ryoji-s */}
  153. {/* https://github.com/weseek/growi/pull/7873 */}
  154. <div className="visually-hidden">
  155. <LoadingSpinner />
  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. {/* eslint-disable-next-line react/no-danger */}
  162. <span dangerouslySetInnerHTML={{ __html: t('login.set_env_var_for_logs') }}></span>
  163. </div>
  164. )}
  165. {loginErrorElementWithDangerouslySetInnerHTML}
  166. {loginErrorElement}
  167. <form role="form" onSubmit={handleLoginWithLocalSubmit} id="login-form">
  168. <div className="input-group">
  169. <span className="text-white opacity-75 d-flex align-items-center">
  170. <span className="material-symbols-outlined">person</span>
  171. </span>
  172. <input
  173. type="text"
  174. className={`form-control rounded ms-2 ${isLdapStrategySetup ? 'ldap-space' : ''}`}
  175. data-testid="tiUsernameForLogin"
  176. placeholder="Username or E-mail"
  177. onChange={(e) => { setUsernameForLogin(e.target.value) }}
  178. name="usernameForLogin"
  179. />
  180. {isLdapStrategySetup && (
  181. <small className="badge text-bg-success input-ldap d-flex align-items-center">
  182. <span className="material-symbols-outlined">network_node</span>
  183. <span className="">LDAP</span>
  184. </small>
  185. )}
  186. </div>
  187. <div className="input-group">
  188. <span className="text-white opacity-75 d-flex align-items-center">
  189. <span className="material-symbols-outlined">lock</span>
  190. </span>
  191. <input
  192. type="password"
  193. className="form-control rounded ms-2"
  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. className="btn btn-secondary btn-login col-7 mx-auto d-flex"
  204. data-testid="btnSubmitForLogin"
  205. disabled={isLoading}
  206. >
  207. <span>
  208. {isLoading ? (
  209. <LoadingSpinner />
  210. ) : (
  211. <span className="material-symbols-outlined">login</span>
  212. )}
  213. </span>
  214. <span className="flex-grow-1">{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 authIcon = {
  233. google: <span className="growi-custom-icons align-bottom">google</span>,
  234. github: <span className="growi-custom-icons align-bottom">github</span>,
  235. facebook: <span className="growi-custom-icons align-bottom">facebook</span>,
  236. oidc: <span className="growi-custom-icons align-bottom">openid</span>,
  237. saml: <span className="material-symbols-outlined align-bottom">key</span>,
  238. };
  239. const authBtn = `btn-auth-${auth}`;
  240. const signin = {
  241. google: 'Google',
  242. github: 'GitHub',
  243. facebook: 'Facebook',
  244. oidc: 'OIDC',
  245. saml: 'SAML',
  246. };
  247. return (
  248. <button
  249. key={`btn-auth-${auth}`}
  250. type="button"
  251. className={`btn btn-secondary ${authBtn} my-2 col-10 col-sm-7 mx-auto d-flex`}
  252. onClick={handleLoginWithExternalAuth}
  253. >
  254. <span>{authIcon[auth]}</span>
  255. <span className="flex-grow-1">{t('Sign in with External auth', { signin: signin[auth] })}</span>
  256. </button>
  257. );
  258. }, [handleLoginWithExternalAuth, t]);
  259. const renderExternalAuthLoginForm = useCallback(() => {
  260. const { objOfIsExternalAuthEnableds } = props;
  261. return (
  262. <>
  263. <div className="text-center text-line d-flex align-items-center mb-3">
  264. <p className="text-white mb-0">{t('or')}</p>
  265. </div>
  266. <div className="mt-2">
  267. {Object.keys(objOfIsExternalAuthEnableds).map((auth) => {
  268. if (!objOfIsExternalAuthEnableds[auth]) {
  269. return;
  270. }
  271. return renderExternalAuthInput(auth);
  272. })}
  273. </div>
  274. </>
  275. );
  276. }, [props, t, renderExternalAuthInput]);
  277. const resetRegisterErrors = useCallback(() => {
  278. if (registerErrors.length === 0) return;
  279. setRegisterErrors([]);
  280. }, [registerErrors.length]);
  281. const handleRegisterFormSubmit = useCallback(async(e, requestPath) => {
  282. e.preventDefault();
  283. setEmailForRegistrationOrder('');
  284. setIsSuccessToRagistration(false);
  285. setIsLoading(true);
  286. const registerForm = {
  287. username: usernameForRegister,
  288. name: nameForRegister,
  289. email: emailForRegister,
  290. password: passwordForRegister,
  291. };
  292. try {
  293. const res = await apiv3Post(requestPath, { registerForm });
  294. setIsSuccessToRagistration(true);
  295. resetRegisterErrors();
  296. const { redirectTo } = res.data;
  297. if (redirectTo != null) {
  298. router.push(redirectTo);
  299. }
  300. if (isEmailAuthenticationEnabled) {
  301. setEmailForRegistrationOrder(emailForRegister);
  302. return;
  303. }
  304. }
  305. catch (err) {
  306. // Execute if error exists
  307. if (err != null || err.length > 0) {
  308. setRegisterErrors(err);
  309. }
  310. setIsLoading(false);
  311. }
  312. return;
  313. }, [usernameForRegister, nameForRegister, emailForRegister, passwordForRegister, resetRegisterErrors, router, isEmailAuthenticationEnabled]);
  314. const switchForm = useCallback(() => {
  315. setIsRegistering(!isRegistering);
  316. resetLoginErrors();
  317. resetRegisterErrors();
  318. }, [isRegistering, resetLoginErrors, resetRegisterErrors]);
  319. const renderRegisterForm = useCallback(() => {
  320. let registerAction = '/register';
  321. let submitText = t('Sign up');
  322. if (isEmailAuthenticationEnabled) {
  323. registerAction = '/user-activation/register';
  324. submitText = t('page_register.send_email');
  325. }
  326. return (
  327. <React.Fragment>
  328. {registrationMode === RegistrationMode.RESTRICTED && (
  329. <p className="alert alert-warning">
  330. {t('page_register.notice.restricted')}
  331. <br />
  332. {t('page_register.notice.restricted_defail')}
  333. </p>
  334. )}
  335. { (!isMailerSetup && isEmailAuthenticationEnabled) && (
  336. <p className="alert alert-danger">
  337. <span>{t('commons:alert.please_enable_mailer')}</span>
  338. </p>
  339. )}
  340. {
  341. registerErrors != null && registerErrors.length > 0 && (
  342. <p className="alert alert-danger">
  343. {registerErrors.map(err => (
  344. <span>
  345. {t(err.message)}<br />
  346. </span>
  347. ))}
  348. </p>
  349. )
  350. }
  351. {
  352. (isEmailAuthenticationEnabled && isSuccessToRagistration) && (
  353. <p className="alert alert-success">
  354. <span>{t('message.successfully_send_email_auth', { email: emailForRegistrationOrder })}</span>
  355. </p>
  356. )
  357. }
  358. <form role="form" onSubmit={e => handleRegisterFormSubmit(e, registerAction)} id="register-form">
  359. {!isEmailAuthenticationEnabled && (
  360. <div>
  361. <div className="input-group" id="input-group-username">
  362. <span className="text-white opacity-75 d-flex align-items-center">
  363. <span className="material-symbols-outlined">person</span>
  364. </span>
  365. {/* username */}
  366. <input
  367. type="text"
  368. className="form-control rounded ms-2"
  369. onChange={(e) => { setUsernameForRegister(e.target.value) }}
  370. placeholder={t('User ID')}
  371. name="username"
  372. defaultValue={props.username}
  373. required
  374. />
  375. </div>
  376. <p className="form-text text-danger">
  377. <span id="help-block-username"></span>
  378. </p>
  379. <div className="input-group">
  380. <span className="text-white opacity-75 d-flex align-items-center">
  381. <span className="material-symbols-outlined">sell</span>
  382. </span>
  383. {/* name */}
  384. <input
  385. type="text"
  386. className="form-control rounded ms-2"
  387. onChange={(e) => { setNameForRegister(e.target.value) }}
  388. placeholder={t('Name')}
  389. name="name"
  390. defaultValue={props.name}
  391. required
  392. />
  393. </div>
  394. </div>
  395. )}
  396. <div className="input-group">
  397. <span className="text-white opacity-75 d-flex align-items-center">
  398. <span className="material-symbols-outlined">mail</span>
  399. </span>
  400. {/* email */}
  401. <input
  402. type="email"
  403. disabled={!isMailerSetup && isEmailAuthenticationEnabled}
  404. className="form-control rounded ms-2"
  405. onChange={(e) => { setEmailForRegister(e.target.value) }}
  406. placeholder={t('Email')}
  407. name="email"
  408. defaultValue={props.email}
  409. required
  410. />
  411. </div>
  412. {registrationWhitelist.length > 0 && (
  413. <>
  414. <p className="form-text">{t('page_register.form_help.email')}</p>
  415. <ul>
  416. {registrationWhitelist.map((elem) => {
  417. return (
  418. <li key={elem}>
  419. <code>{elem}</code>
  420. </li>
  421. );
  422. })}
  423. </ul>
  424. </>
  425. )}
  426. {!isEmailAuthenticationEnabled && (
  427. <div>
  428. <div className="input-group">
  429. <span className="text-white opacity-75 d-flex align-items-center">
  430. <span className="material-symbols-outlined">lock</span>
  431. </span>
  432. {/* Password */}
  433. <input
  434. type="password"
  435. className="form-control rounded ms-2"
  436. onChange={(e) => { setPasswordForRegister(e.target.value) }}
  437. placeholder={t('Password')}
  438. name="password"
  439. required
  440. />
  441. </div>
  442. </div>
  443. )}
  444. {/* Sign up button (submit) */}
  445. <div className="input-group justify-content-center my-4">
  446. <button
  447. type="submit"
  448. className="btn btn-secondary btn-register d-flex col-7"
  449. disabled={(!isMailerSetup && isEmailAuthenticationEnabled) || isLoading}
  450. >
  451. <span>
  452. {isLoading ? (
  453. <LoadingSpinner />
  454. ) : (
  455. <span className="material-symbols-outlined">person_add</span>
  456. )}
  457. </span>
  458. <span className="flex-grow-1">{submitText}</span>
  459. </button>
  460. </div>
  461. </form>
  462. <div className="row">
  463. <div className="text-end col-12 mb-5">
  464. <a
  465. href="#login"
  466. className="btn btn-sm btn-secondary btn-function col-10 col-sm-9 mx-auto py-1 d-flex"
  467. style={{ pointerEvents: isLoading ? 'none' : undefined }}
  468. onClick={switchForm}
  469. >
  470. <span className="material-symbols-outlined fs-5">login</span>
  471. <span className="flex-grow-1">{t('Sign in is here')}</span>
  472. </a>
  473. </div>
  474. </div>
  475. </React.Fragment>
  476. );
  477. }, [
  478. t, isEmailAuthenticationEnabled, registrationMode, isMailerSetup, registerErrors, isSuccessToRagistration,
  479. emailForRegistrationOrder, props.username, props.name, props.email, registrationWhitelist, switchForm, handleRegisterFormSubmit, isLoading,
  480. ]);
  481. if (registrationMode === RegistrationMode.RESTRICTED && isSuccessToRagistration && !isEmailAuthenticationEnabled) {
  482. return <CompleteUserRegistration />;
  483. }
  484. return (
  485. <div className={moduleClass}>
  486. <div className="nologin-dialog mx-auto rounded-4 rounded-top-0" id="nologin-dialog" data-testid="login-form">
  487. <div className="row mx-0">
  488. <div className="col-12 px-md-4">
  489. <ReactCardFlip isFlipped={isRegistering} flipDirection="horizontal" cardZIndex="3">
  490. <div className="front">
  491. {isLocalOrLdapStrategiesEnabled && renderLocalOrLdapLoginForm()}
  492. {isSomeExternalAuthEnabled && renderExternalAuthLoginForm()}
  493. {isLocalOrLdapStrategiesEnabled && isPasswordResetEnabled && (
  494. <div className="mt-4">
  495. <a
  496. href="/forgot-password"
  497. className="btn btn-sm btn-secondary btn-function col-10 col-sm-9 mx-auto py-1 d-flex"
  498. style={{ pointerEvents: isLoading ? 'none' : 'auto' }}
  499. >
  500. <span className="material-symbols-outlined">vpn_key</span>
  501. <span className="flex-grow-1">{t('forgot_password.forgot_password')}</span>
  502. </a>
  503. </div>
  504. )}
  505. {/* Sign up link */}
  506. {isRegistrationEnabled && (
  507. <div className="mt-2 mb-5">
  508. <a
  509. href="#register"
  510. className="btn btn-sm btn-secondary btn-function col-10 col-sm-9 mx-auto py-1 d-flex"
  511. style={{ pointerEvents: isLoading ? 'none' : 'auto' }}
  512. onClick={switchForm}
  513. >
  514. <span className="material-symbols-outlined">person_add</span>
  515. <span className="flex-grow-1">{t('Sign up is here')}</span>
  516. </a>
  517. </div>
  518. )}
  519. </div>
  520. <div className="back">
  521. {/* Register form for /login#register */}
  522. {isRegistrationEnabled && renderRegisterForm()}
  523. </div>
  524. </ReactCardFlip>
  525. </div>
  526. </div>
  527. <a href="https://growi.org" className="link-growi-org ps-3">
  528. <span className="growi">GROWI</span><span className="org">.org</span>
  529. </a>
  530. </div>
  531. </div>
  532. );
  533. };