LoginForm.tsx 20 KB

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