login.php 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987
  1. <?php
  2. /**
  3. * @package Grav\Plugin\Login
  4. *
  5. * @copyright Copyright (C) 2014 - 2017 RocketTheme, LLC. All rights reserved.
  6. * @license MIT License; see LICENSE file for details.
  7. */
  8. namespace Grav\Plugin;
  9. use Grav\Common\Grav;
  10. use Grav\Common\Language\Language;
  11. use Grav\Common\Page\Page;
  12. use Grav\Common\Page\Pages;
  13. use Grav\Common\Plugin;
  14. use Grav\Common\Twig\Twig;
  15. use Grav\Common\User\User;
  16. use Grav\Common\Utils;
  17. use Grav\Common\Uri;
  18. use Grav\Plugin\Login\Events\UserLoginEvent;
  19. use Grav\Plugin\Login\Login;
  20. use Grav\Plugin\Login\Controller;
  21. use Grav\Plugin\Login\RememberMe\RememberMe;
  22. use RocketTheme\Toolbox\Event\Event;
  23. use RocketTheme\Toolbox\Session\Message;
  24. /**
  25. * Class LoginPlugin
  26. * @package Grav\Plugin\Login
  27. */
  28. class LoginPlugin extends Plugin
  29. {
  30. const TMP_COOKIE_NAME = 'tmp-message';
  31. /** @var string */
  32. protected $route;
  33. /** @var string */
  34. protected $route_register;
  35. /** @var string */
  36. protected $route_forgot;
  37. /** @var bool */
  38. protected $authenticated = true;
  39. /** @var Login */
  40. protected $login;
  41. protected $redirect_to_login;
  42. /**
  43. * @return array
  44. */
  45. public static function getSubscribedEvents()
  46. {
  47. return [
  48. 'onPluginsInitialized' => [['initializeSession', 10000], ['initializeLogin', 1000]],
  49. 'onTask.login.login' => ['loginController', 0],
  50. 'onTask.login.twofa' => ['loginController', 0],
  51. 'onTask.login.forgot' => ['loginController', 0],
  52. 'onTask.login.logout' => ['loginController', 0],
  53. 'onTask.login.reset' => ['loginController', 0],
  54. 'onPagesInitialized' => [['storeReferrerPage', 0], ['pageVisibility', 0]],
  55. 'onPageInitialized' => ['authorizePage', 0],
  56. 'onPageFallBackUrl' => ['authorizeFallBackUrl', 0],
  57. 'onTwigTemplatePaths' => ['onTwigTemplatePaths', 0],
  58. 'onTwigSiteVariables' => ['onTwigSiteVariables', -100000],
  59. 'onFormProcessed' => ['onFormProcessed', 0],
  60. 'onUserLoginAuthenticate' => [['userLoginAuthenticateByRegistration', 10002], ['userLoginAuthenticateByRememberMe', 10001], ['userLoginAuthenticateByEmail', 10000], ['userLoginAuthenticate', 0]],
  61. 'onUserLoginAuthorize' => ['userLoginAuthorize', 0],
  62. 'onUserLoginFailure' => ['userLoginFailure', 0],
  63. 'onUserLogin' => ['userLogin', 0],
  64. 'onUserLogout' => ['userLogout', 0],
  65. ];
  66. }
  67. /**
  68. * [onPluginsInitialized] Initialize login plugin if path matches.
  69. * @throws \RuntimeException
  70. */
  71. public function initializeSession()
  72. {
  73. // Check to ensure sessions are enabled.
  74. if (!$this->config->get('system.session.enabled')) {
  75. throw new \RuntimeException('The Login plugin requires "system.session" to be enabled');
  76. }
  77. // Autoload classes
  78. $autoload = __DIR__ . '/vendor/autoload.php';
  79. if (!is_file($autoload)) {
  80. throw new \RuntimeException('Login Plugin failed to load. Composer dependencies not met.');
  81. }
  82. require_once $autoload;
  83. // Define login service.
  84. $this->grav['login'] = function (Grav $c) {
  85. return new Login($c);
  86. };
  87. // Define current user service.
  88. $this->grav['user'] = function (Grav $c) {
  89. $session = $c['session'];
  90. if (empty($session->user)) {
  91. $session->user = $c['login']->login(['username' => ''], ['remember_me' => true, 'remember_me_login' => true]);
  92. }
  93. return $session->user;
  94. };
  95. }
  96. /**
  97. * [onPluginsInitialized] Initialize login plugin if path matches.
  98. * @throws \RuntimeException
  99. */
  100. public function initializeLogin()
  101. {
  102. $this->login = $this->grav['login'];
  103. /** @var Uri $uri */
  104. $uri = $this->grav['uri'];
  105. // Admin has its own login; make sure we're not in admin.
  106. if (!isset($this->grav['admin'])) {
  107. $this->route = $this->config->get('plugins.login.route');
  108. }
  109. $path = $uri->path();
  110. $this->redirect_to_login = $this->config->get('plugins.login.redirect_to_login');
  111. // Register route to login page if it has been set.
  112. if ($this->route && $this->route === $path) {
  113. $this->enable([
  114. 'onPagesInitialized' => ['addLoginPage', 0],
  115. ]);
  116. return;
  117. }
  118. if ($path === $this->config->get('plugins.login.route_forgot')) {
  119. $this->enable([
  120. 'onPagesInitialized' => ['addForgotPage', 0],
  121. ]);
  122. return;
  123. }
  124. if ($path === $this->config->get('plugins.login.route_reset')) {
  125. $this->enable([
  126. 'onPagesInitialized' => ['addResetPage', 0],
  127. ]);
  128. return;
  129. }
  130. if ($path === $this->config->get('plugins.login.route_register')) {
  131. if ($this->config->get('plugins.login.user_registration.enabled')) {
  132. $this->enable([
  133. 'onPagesInitialized' => ['addRegisterPage', 0],
  134. ]);
  135. } else {
  136. throw new \RuntimeException($this->grav['language']->translate('PLUGIN_LOGIN.REGISTRATION_DISABLED'), 404);
  137. }
  138. return;
  139. }
  140. if ($path === $this->config->get('plugins.login.route_activate')) {
  141. $this->enable([
  142. 'onPagesInitialized' => ['handleUserActivation', 0],
  143. ]);
  144. return;
  145. }
  146. if ($path === $this->config->get('plugins.login.route_profile')) {
  147. $this->enable([
  148. 'onPagesInitialized' => ['addProfilePage', 0],
  149. ]);
  150. return;
  151. }
  152. }
  153. /**
  154. * Optional ability to dynamically set visibility based on page access and page header
  155. * that states `login.visibility_requires_access: true`
  156. *
  157. * Note that this setting may be slow on large sites as it loads all pages into memory for each page load!
  158. *
  159. * @param Event $e
  160. */
  161. public function pageVisibility(Event $e)
  162. {
  163. if ($this->config->get('plugins.login.dynamic_page_visibility')) {
  164. /** @var Pages $pages */
  165. $pages = $e['pages'];
  166. $user = $this->grav['user'];
  167. foreach ($pages->instances() as $page) {
  168. $header = $page->header();
  169. if (isset($header->login['visibility_requires_access'])) {
  170. $config = $this->mergeConfig($page);
  171. $access = $this->login->isUserAuthorizedForPage($user, $page, $config);
  172. if ($access === false) {
  173. $page->visible(false);
  174. }
  175. }
  176. }
  177. }
  178. }
  179. /**
  180. * [onPagesInitialized]
  181. */
  182. public function storeReferrerPage()
  183. {
  184. $invalid_redirect_routes = [
  185. $this->config->get('plugins.login.route') ?: '/login',
  186. $this->config->get('plugins.login.route_register') ?: '/register',
  187. $this->config->get('plugins.login.route_activate') ?: '/activate_user',
  188. $this->config->get('plugins.login.route_forgot') ?: '/forgot_password',
  189. $this->config->get('plugins.login.route_reset') ?: '/reset_password',
  190. ];
  191. /** @var Uri $uri */
  192. $uri = $this->grav['uri'];
  193. $current_route = $uri->route();
  194. if (!in_array($current_route, $invalid_redirect_routes, true)) {
  195. $allowed = true;
  196. /** @var Page $page */
  197. $page = $this->grav['pages']->dispatch($current_route);
  198. if ($page) {
  199. $header = $page->header();
  200. if (isset($header->login_redirect_here) && $header->login_redirect_here === false) {
  201. $allowed = false;
  202. }
  203. if ($allowed && $page->routable()) {
  204. $this->grav['session']->redirect_after_login = $page->route() . ($uri->params() ?: '');
  205. }
  206. }
  207. }
  208. }
  209. /**
  210. * Add Login page
  211. * @throws \Exception
  212. */
  213. public function addLoginPage()
  214. {
  215. /** @var Pages $pages */
  216. $pages = $this->grav['pages'];
  217. $page = $pages->dispatch($this->route);
  218. if (!$page) {
  219. // Only add login page if it hasn't already been defined.
  220. $page = new Page;
  221. $page->init(new \SplFileInfo(__DIR__ . '/pages/login.md'));
  222. $page->slug(basename($this->route));
  223. $pages->addPage($page, $this->route);
  224. }
  225. }
  226. /**
  227. * Add Login page
  228. * @throws \Exception
  229. */
  230. public function addForgotPage()
  231. {
  232. $route = $this->config->get('plugins.login.route_forgot');
  233. /** @var Pages $pages */
  234. $pages = $this->grav['pages'];
  235. $page = $pages->dispatch($route);
  236. if (!$page) {
  237. // Only add forgot page if it hasn't already been defined.
  238. $page = new Page;
  239. $page->init(new \SplFileInfo(__DIR__ . '/pages/forgot.md'));
  240. $page->slug(basename($route));
  241. $pages->addPage($page, $route);
  242. }
  243. }
  244. /**
  245. * Add Reset page
  246. * @throws \Exception
  247. */
  248. public function addResetPage()
  249. {
  250. $route = $this->config->get('plugins.login.route_reset');
  251. $uri = $this->grav['uri'];
  252. $token = $uri->param('token');
  253. $user = $uri->param('user');
  254. if (!$user || !$token) {
  255. return;
  256. }
  257. /** @var Pages $pages */
  258. $pages = $this->grav['pages'];
  259. $page = $pages->dispatch($route);
  260. if (!$page) {
  261. // Only add login page if it hasn't already been defined.
  262. $page = new Page;
  263. $page->init(new \SplFileInfo(__DIR__ . '/pages/reset.md'));
  264. $page->slug(basename($route));
  265. $pages->addPage($page, $route);
  266. }
  267. }
  268. /**
  269. * Add Register page
  270. * @throws \Exception
  271. */
  272. public function addRegisterPage()
  273. {
  274. $route = $this->config->get('plugins.login.route_register');
  275. /** @var Pages $pages */
  276. $pages = $this->grav['pages'];
  277. $page = $pages->dispatch($route);
  278. if (!$page) {
  279. $page = new Page;
  280. $page->init(new \SplFileInfo(__DIR__ . '/pages/register.md'));
  281. $page->template('form');
  282. $page->slug(basename($route));
  283. $pages->addPage($page, $route);
  284. }
  285. }
  286. /**
  287. * Handle user activation
  288. * @throws \RuntimeException
  289. */
  290. public function handleUserActivation()
  291. {
  292. /** @var Uri $uri */
  293. $uri = $this->grav['uri'];
  294. /** @var Message $messages */
  295. $messages = $this->grav['messages'];
  296. $username = $uri->param('username');
  297. $token = $uri->param('token');
  298. $user = User::load($username);
  299. if (empty($user->activation_token)) {
  300. $message = $this->grav['language']->translate('PLUGIN_LOGIN.INVALID_REQUEST');
  301. $messages->add($message, 'error');
  302. } else {
  303. list($good_token, $expire) = explode('::', $user->activation_token, 2);
  304. if ($good_token === $token) {
  305. if (time() > $expire) {
  306. $message = $this->grav['language']->translate('PLUGIN_LOGIN.ACTIVATION_LINK_EXPIRED');
  307. $messages->add($message, 'error');
  308. } else {
  309. $user['state'] = 'enabled';
  310. unset($user['activation_token']);
  311. $user->save();
  312. $message = $this->grav['language']->translate('PLUGIN_LOGIN.USER_ACTIVATED_SUCCESSFULLY');
  313. $messages->add($message, 'info');
  314. if ($this->config->get('plugins.login.user_registration.options.send_welcome_email', false)) {
  315. $this->login->sendWelcomeEmail($user);
  316. }
  317. if ($this->config->get('plugins.login.user_registration.options.send_notification_email', false)) {
  318. $this->login->sendNotificationEmail($user);
  319. }
  320. if ($this->config->get('plugins.login.user_registration.options.login_after_registration', false)) {
  321. $this->login->login(['username' => $username], ['after_registration' => true]);
  322. }
  323. }
  324. } else {
  325. $message = $this->grav['language']->translate('PLUGIN_LOGIN.INVALID_REQUEST');
  326. $messages->add($message, 'error');
  327. }
  328. }
  329. $redirect_route = $this->config->get('plugins.login.user_registration.redirect_after_activation', '/');
  330. $this->grav->redirect($redirect_route);
  331. }
  332. /**
  333. * Add Profile page
  334. */
  335. public function addProfilePage()
  336. {
  337. $route = $this->config->get('plugins.login.route_profile');
  338. /** @var Pages $pages */
  339. $pages = $this->grav['pages'];
  340. $page = $pages->dispatch($route);
  341. if (!$page) {
  342. // Only add forgot page if it hasn't already been defined.
  343. $page = new Page;
  344. $page->init(new \SplFileInfo(__DIR__ . "/pages/profile.md"));
  345. $page->slug(basename($route));
  346. $pages->addPage($page, $route);
  347. }
  348. $this->storeReferrerPage();
  349. }
  350. /**
  351. * Set Unauthorized page
  352. * @throws \Exception
  353. */
  354. public function setUnauthorizedPage()
  355. {
  356. $route = $this->config->get('plugins.login.route_unauthorized');
  357. /** @var Pages $pages */
  358. $pages = $this->grav['pages'];
  359. $page = $pages->dispatch($route);
  360. if (!$page) {
  361. $page = new Page;
  362. $page->init(new \SplFileInfo(__DIR__ . '/pages/unauthorized.md'));
  363. $page->template('default');
  364. $page->slug(basename($route));
  365. $pages->addPage($page, $route);
  366. }
  367. unset($this->grav['page']);
  368. $this->grav['page'] = $page;
  369. }
  370. /**
  371. * Initialize login controller
  372. */
  373. public function loginController()
  374. {
  375. /** @var Uri $uri */
  376. $uri = $this->grav['uri'];
  377. $task = !empty($_POST['task']) ? $_POST['task'] : $uri->param('task');
  378. $task = substr($task, strlen('login.'));
  379. $post = !empty($_POST) ? $_POST : [];
  380. switch ($task) {
  381. case 'login':
  382. if (!isset($post['login-form-nonce']) || !Utils::verifyNonce($post['login-form-nonce'], 'login-form')) {
  383. $this->grav['messages']->add($this->grav['language']->translate('PLUGIN_LOGIN.ACCESS_DENIED'),
  384. 'info');
  385. $twig = $this->grav['twig'];
  386. $twig->twig_vars['notAuthorized'] = true;
  387. return;
  388. }
  389. break;
  390. case 'forgot':
  391. if (!isset($post['forgot-form-nonce']) || !Utils::verifyNonce($post['forgot-form-nonce'], 'forgot-form')) {
  392. $this->grav['messages']->add($this->grav['language']->translate('PLUGIN_LOGIN.ACCESS_DENIED'),'info');
  393. return;
  394. }
  395. break;
  396. }
  397. $controller = new Controller($this->grav, $task, $post);
  398. $controller->execute();
  399. $controller->redirect();
  400. }
  401. /**
  402. * Authorize the Page fallback url (page media accessed through the page route)
  403. */
  404. public function authorizeFallBackUrl()
  405. {
  406. if ($this->config->get('plugins.login.protect_protected_page_media', false)) {
  407. $page_url = dirname($this->grav['uri']->path());
  408. $page = $this->grav['pages']->find($page_url);
  409. unset($this->grav['page']);
  410. $this->grav['page'] = $page;
  411. $this->authorizePage();
  412. }
  413. }
  414. /**
  415. * [onPageInitialized] Authorize Page
  416. */
  417. public function authorizePage()
  418. {
  419. if (!$this->authenticated) {
  420. return;
  421. }
  422. /** @var User $user */
  423. $user = $this->grav['user'];
  424. /** @var Page $page */
  425. $page = $this->grav['page'];
  426. if (!$page || $this->grav['login']->isUserAuthorizedForPage($user, $page, $this->mergeConfig($page))) {
  427. return;
  428. }
  429. // If this is not an HTML page request, simply throw a 403 error
  430. $uri_extension = $this->grav['uri']->extension('html');
  431. $supported_types = $this->config->get('media.types');
  432. if ($uri_extension !== 'html' && array_key_exists($uri_extension, $supported_types)) {
  433. header('HTTP/1.0 403 Forbidden');
  434. exit;
  435. }
  436. $authorized = $user->authenticated && $user->authorized;
  437. // User is not logged in; redirect to login page.
  438. if ($this->redirect_to_login && $this->route && !$authorized) {
  439. $this->grav->redirect($this->route, 302);
  440. }
  441. /** @var Twig $twig */
  442. $twig = $this->grav['twig'];
  443. // Reset page with login page.
  444. if (!$authorized) {
  445. if ($this->route) {
  446. $page = $this->grav['pages']->dispatch($this->route);
  447. } else {
  448. $page = new Page;
  449. // $this->grav['session']->redirect_after_login = $this->grav['uri']->path() . ($this->grav['uri']->params() ?: '');
  450. // Get the admin Login page is needed, else teh default
  451. if ($this->isAdmin()) {
  452. $login_file = $this->grav['locator']->findResource('plugins://admin/pages/admin/login.md');
  453. $page->init(new \SplFileInfo($login_file));
  454. } else {
  455. $page->init(new \SplFileInfo(__DIR__ . '/pages/login.md'));
  456. }
  457. $page->slug(basename($this->route));
  458. /** @var Pages $pages */
  459. $pages = $this->grav['pages'];
  460. $pages->addPage($page, $this->route);
  461. }
  462. $this->authenticated = false;
  463. unset($this->grav['page']);
  464. $this->grav['page'] = $page;
  465. $twig->twig_vars['form'] = new Form($page);
  466. } else {
  467. /** @var Language $l */
  468. $l = $this->grav['language'];
  469. $this->grav['messages']->add($l->translate('PLUGIN_LOGIN.ACCESS_DENIED'), 'error');
  470. $twig->twig_vars['notAuthorized'] = true;
  471. $this->setUnauthorizedPage();
  472. }
  473. }
  474. /**
  475. * [onTwigTemplatePaths] Add twig paths to plugin templates.
  476. */
  477. public function onTwigTemplatePaths()
  478. {
  479. $twig = $this->grav['twig'];
  480. $twig->twig_paths[] = __DIR__ . '/templates';
  481. }
  482. /**
  483. * [onTwigSiteVariables] Set all twig variables for generating output.
  484. */
  485. public function onTwigSiteVariables()
  486. {
  487. /** @var Twig $twig */
  488. $twig = $this->grav['twig'];
  489. $this->grav->fireEvent('onLoginPage');
  490. $extension = $this->grav['uri']->extension();
  491. $extension = $extension ?: 'html';
  492. if (!$this->authenticated) {
  493. $twig->template = "login.{$extension}.twig";
  494. }
  495. // add CSS for frontend if required
  496. if (!$this->isAdmin() && $this->config->get('plugins.login.built_in_css')) {
  497. $this->grav['assets']->add('plugin://login/css/login.css');
  498. }
  499. $task = $this->grav['uri']->param('task') ?: (isset($_POST['task']) ? $_POST['task'] : '');
  500. $task = substr($task, strlen('login.'));
  501. if ($task === 'reset') {
  502. $username = $this->grav['uri']->param('user');
  503. $token = $this->grav['uri']->param('token');
  504. if (!empty($username) && !empty($token)) {
  505. $twig->twig_vars['username'] = $username;
  506. $twig->twig_vars['token'] = $token;
  507. }
  508. } elseif ($task === 'login') {
  509. $twig->twig_vars['username'] = isset($_POST['username']) ? $_POST['username'] : '';
  510. }
  511. $flashData = $this->grav['session']->getFlashCookieObject(self::TMP_COOKIE_NAME);
  512. if (isset($flashData->message)) {
  513. $this->grav['messages']->add($flashData->message, $flashData->status);
  514. }
  515. }
  516. /**
  517. * Process the user registration, triggered by a registration form
  518. *
  519. * @param Form $form
  520. * @throws \RuntimeException
  521. */
  522. private function processUserRegistration($form, Event $event)
  523. {
  524. $language = $this->grav['language'];
  525. $messages = $this->grav['messages'];
  526. if (!$this->config->get('plugins.login.enabled')) {
  527. throw new \RuntimeException($language->translate('PLUGIN_LOGIN.PLUGIN_LOGIN_DISABLED'));
  528. }
  529. if (!$this->config->get('plugins.login.user_registration.enabled')) {
  530. throw new \RuntimeException($language->translate('PLUGIN_LOGIN.USER_REGISTRATION_DISABLED'));
  531. }
  532. // Check for existing username
  533. $username = $form->value('username');
  534. $existing_username = User::find($username,['username']);
  535. if ($existing_username->exists()) {
  536. $this->grav->fireEvent('onFormValidationError', new Event([
  537. 'form' => $form,
  538. 'message' => $language->translate([
  539. 'PLUGIN_LOGIN.USERNAME_NOT_AVAILABLE',
  540. $username
  541. ])
  542. ]));
  543. $event->stopPropagation();
  544. return;
  545. }
  546. // Check for existing email
  547. $email = $form->value('email');
  548. $existing_email = User::find($email,['email']);
  549. if ($existing_email->exists()) {
  550. $this->grav->fireEvent('onFormValidationError', new Event([
  551. 'form' => $form,
  552. 'message' => $language->translate([
  553. 'PLUGIN_LOGIN.EMAIL_NOT_AVAILABLE',
  554. $email
  555. ])
  556. ]));
  557. $event->stopPropagation();
  558. return;
  559. }
  560. $data = [];
  561. $data['username'] = $username;
  562. // if multiple password fields, check they match and set password field from it
  563. if ($this->config->get('plugins.login.user_registration.options.validate_password1_and_password2',
  564. false)
  565. ) {
  566. if ($form->value('password1') !== $form->value('password2')) {
  567. $this->grav->fireEvent('onFormValidationError', new Event([
  568. 'form' => $form,
  569. 'message' => $language->translate('PLUGIN_LOGIN.PASSWORDS_DO_NOT_MATCH')
  570. ]));
  571. $event->stopPropagation();
  572. return;
  573. }
  574. $data['password'] = $form->value('password1');
  575. }
  576. $fields = (array)$this->config->get('plugins.login.user_registration.fields', []);
  577. foreach ($fields as $field) {
  578. // Process value of field if set in the page process.register_user
  579. $default_values = (array)$this->config->get('plugins.login.user_registration.default_values');
  580. if ($default_values) {
  581. foreach ($default_values as $key => $param) {
  582. if ($key === $field) {
  583. if (is_array($param)) {
  584. $values = explode(',', $param);
  585. } else {
  586. $values = $param;
  587. }
  588. $data[$field] = $values;
  589. }
  590. }
  591. }
  592. if (!isset($data[$field]) && $form->value($field)) {
  593. $data[$field] = $form->value($field);
  594. }
  595. }
  596. if ($this->config->get('plugins.login.user_registration.options.set_user_disabled', false)) {
  597. $data['state'] = 'disabled';
  598. } else {
  599. $data['state'] = 'enabled';
  600. }
  601. $this->grav->fireEvent('onUserLoginRegisterData', new Event(['data' => &$data]));
  602. $user = $this->login->register($data);
  603. $fullname = $user->fullname ?: $user->username;
  604. if ($this->config->get('plugins.login.user_registration.options.send_activation_email', false)) {
  605. $this->login->sendActivationEmail($user);
  606. $message = $language->translate(['PLUGIN_LOGIN.ACTIVATION_NOTICE_MSG', $fullname]);
  607. $messages->add($message, 'info');
  608. } else {
  609. if ($this->config->get('plugins.login.user_registration.options.send_welcome_email', false)) {
  610. $this->login->sendWelcomeEmail($user);
  611. }
  612. if ($this->config->get('plugins.login.user_registration.options.send_notification_email', false)) {
  613. $this->login->sendNotificationEmail($user);
  614. }
  615. $message = $language->translate(['PLUGIN_LOGIN.WELCOME_NOTICE_MSG', $fullname]);
  616. $messages->add($message, 'info');
  617. }
  618. $this->grav->fireEvent('onUserLoginRegistered', new Event(['user' => $user]));
  619. if (isset($data['state']) && $data['state'] === 'enabled' && $this->config->get('plugins.login.user_registration.options.login_after_registration', false)) {
  620. $this->login->login(['username' => $username], ['after_registration' => true], ['user' => $user]);
  621. }
  622. $redirect = $this->config->get('plugins.login.user_registration.redirect_after_registration', false);
  623. if ($redirect) {
  624. $this->grav->redirect($redirect);
  625. }
  626. }
  627. /**
  628. * Save user profile information
  629. *
  630. * @param Form $form
  631. * @param Event $event
  632. * @return bool
  633. */
  634. private function processUserProfile($form, Event $event)
  635. {
  636. /** @var User $user */
  637. $user = $this->grav['user'];
  638. $language = $this->grav['language'];
  639. // Don't save if user doesn't exist
  640. if (!$user->exists()) {
  641. $this->grav->fireEvent('onFormValidationError', new Event([
  642. 'form' => $form,
  643. 'message' => $language->translate('PLUGIN_LOGIN.USER_IS_REMOTE_ONLY')
  644. ]));
  645. $event->stopPropagation();
  646. return;
  647. }
  648. // Stop overloading of username
  649. $username = $form->value('username');
  650. if (isset($username)) {
  651. $this->grav->fireEvent('onFormValidationError', new Event([
  652. 'form' => $form,
  653. 'message' => $language->translate([
  654. 'PLUGIN_LOGIN.USERNAME_NOT_AVAILABLE',
  655. $username
  656. ])
  657. ]));
  658. $event->stopPropagation();
  659. return;
  660. }
  661. // Check for existing email
  662. $email = $form->value('email');
  663. $existing_email = User::find($email,['email']);
  664. if ($user->username != $existing_email->username && $existing_email->exists()) {
  665. $this->grav->fireEvent('onFormValidationError', new Event([
  666. 'form' => $form,
  667. 'message' => $language->translate([
  668. 'PLUGIN_LOGIN.EMAIL_NOT_AVAILABLE',
  669. $email
  670. ])
  671. ]));
  672. $event->stopPropagation();
  673. return;
  674. }
  675. $user->merge($form->getData()->toArray());
  676. try {
  677. $user->save();
  678. } catch (\Exception $e) {
  679. $form->setMessage($e->getMessage(), 'error');
  680. return false;
  681. }
  682. return true;
  683. }
  684. /**
  685. * [onFormProcessed] Process a registration form. Handles the following actions:
  686. *
  687. * - register_user: registers a user
  688. * - update_user: updates user profile
  689. *
  690. * @param Event $event
  691. * @throws \RuntimeException
  692. */
  693. public function onFormProcessed(Event $event)
  694. {
  695. $form = $event['form'];
  696. $action = $event['action'];
  697. switch ($action) {
  698. case 'register_user':
  699. $this->processUserRegistration($form, $event);
  700. break;
  701. case 'update_user':
  702. $this->processUserProfile($form, $event);
  703. break;
  704. }
  705. }
  706. /**
  707. * @param UserLoginEvent $event
  708. * @throws \RuntimeException
  709. */
  710. public function userLoginAuthenticateByRegistration(UserLoginEvent $event)
  711. {
  712. // Check that we're logging in after registration.
  713. if (!$event->getOption('after_registration') || $this->isAdmin()) {
  714. return;
  715. }
  716. $event->setStatus($event::AUTHENTICATION_SUCCESS);
  717. $event->stopPropagation();
  718. }
  719. /**
  720. * @param UserLoginEvent $event
  721. * @throws \RuntimeException
  722. */
  723. public function userLoginAuthenticateByRememberMe(UserLoginEvent $event)
  724. {
  725. // Check that we're logging in with remember me.
  726. if (!$event->getOption('remember_me_login') || !$event->getOption('remember_me') || $this->isAdmin()) {
  727. return;
  728. }
  729. // Only use remember me if user isn't set and feature is enabled.
  730. if ($this->grav['config']->get('plugins.login.rememberme.enabled') && !$event->getUser()->exists()) {
  731. /** @var RememberMe $rememberMe */
  732. $rememberMe = $this->grav['login']->rememberMe();
  733. $username = $rememberMe->login();
  734. if ($rememberMe->loginTokenWasInvalid()) {
  735. // Token was invalid. We will display error page as this was likely an attack.
  736. throw new \RuntimeException($this->grav['language']->translate('PLUGIN_LOGIN.REMEMBER_ME_STOLEN_COOKIE'), 403);
  737. }
  738. if ($username === false) {
  739. // User has not been remembered, there is no point of continuing.
  740. $event->setStatus($event::AUTHENTICATION_FAILURE);
  741. $event->stopPropagation();
  742. return;
  743. }
  744. // Allow remember me to work with different login methods.
  745. $event->setCredential('username', $username);
  746. $event->setUser(User::load($username, false));
  747. }
  748. }
  749. public function userLoginAuthenticateByEmail(UserLoginEvent $event)
  750. {
  751. if (($username = $event->getCredential('username')) && !$event->getUser()->exists()) {
  752. $event->setUser(User::find($username));
  753. }
  754. }
  755. public function userLoginAuthenticate(UserLoginEvent $event)
  756. {
  757. $user = $event->getUser();
  758. $credentials = $event->getCredentials();
  759. if (!$user->exists()) {
  760. // Never let non-existing users to pass the authentication.
  761. // Higher level plugins may override this behavior by stopping propagation.
  762. $event->setStatus($event::AUTHENTICATION_FAILURE);
  763. $event->stopPropagation();
  764. return;
  765. }
  766. // Never let empty password to pass the authentication.
  767. // Higher level plugins may override this behavior by stopping propagation.
  768. if (empty($credentials['password'])) {
  769. $event->setStatus($event::AUTHENTICATION_FAILURE);
  770. $event->stopPropagation();
  771. return;
  772. }
  773. // Try default user authentication. Stop propagation if authentication succeeds.
  774. if ($user->authenticate($credentials['password'])) {
  775. $event->setStatus($event::AUTHENTICATION_SUCCESS);
  776. $event->stopPropagation();
  777. return;
  778. }
  779. // If authentication status is undefined, lower level event handlers may still be able to authenticate user.
  780. }
  781. public function userLoginAuthorize(UserLoginEvent $event)
  782. {
  783. // Always block access if authorize defaulting to site.login fails.
  784. $user = $event->getUser();
  785. foreach ($event->getAuthorize() as $authorize) {
  786. if (!$user->authorize($authorize)) {
  787. $event->setStatus($event::AUTHORIZATION_DENIED);
  788. $event->stopPropagation();
  789. return;
  790. }
  791. }
  792. if ($event->getOption('twofa') && $user->twofa_enabled && $user->twofa_secret) {
  793. $event->setStatus($event::AUTHORIZATION_DELAYED);
  794. }
  795. }
  796. public function userLoginFailure(UserLoginEvent $event)
  797. {
  798. $this->grav['session']->user = User::load('', false);
  799. }
  800. public function userLogin(UserLoginEvent $event)
  801. {
  802. $session = $this->grav['session'];
  803. $session->user = $event->getUser();
  804. if ($event->getOption('remember_me')) {
  805. /** @var Login $login */
  806. $login = $this->grav['login'];
  807. $session->remember_me = (bool)$event->getOption('remember_me_login');
  808. // If the user wants to be remembered, create Rememberme cookie.
  809. $username = $event->getUser()->get('username');
  810. if ($event->getCredential('rememberme')) {
  811. $login->rememberMe()->createCookie($username);
  812. } else {
  813. $login->rememberMe()->getStorage()->cleanAllTriplets($username);
  814. $login->rememberMe()->clearCookie();
  815. }
  816. }
  817. }
  818. public function userLogout(UserLoginEvent $event)
  819. {
  820. if ($event->getOption('remember_me')) {
  821. /** @var Login $login */
  822. $login = $this->grav['login'];
  823. if (!$login->rememberMe()->login()) {
  824. $login->rememberMe()->getStorage()->cleanAllTriplets($event->getUser()->get('username'));
  825. }
  826. $login->rememberMe()->clearCookie();
  827. }
  828. $this->grav['session']->invalidate()->start();
  829. }
  830. }