- md5
- d66e88b5cda7453d71c6011f137e5b88
- sha1
- b77fbc61f3d665782dfe48a693b99d67d3bf231c
- sha256
- cabf14f37823f6a3ad472cd61ada822a6c76a813bb2a7bca326bd7021b4ab6e6
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151
<?php
/**
* @package Joomla.Plugin
* @subpackage System.remember
*
* @copyright (C) 2007 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\Plugin\System\Remember\Extension;
use Joomla\CMS\Event\Application\AfterInitialiseEvent;
use Joomla\CMS\Event\User\BeforeSaveEvent;
use Joomla\CMS\Event\User\LogoutEvent;
use Joomla\CMS\Log\Log;
use Joomla\CMS\Plugin\CMSPlugin;
use Joomla\CMS\Plugin\PluginHelper;
use Joomla\CMS\User\UserHelper;
use Joomla\Database\DatabaseAwareTrait;
use Joomla\Event\SubscriberInterface;
// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Joomla! System Remember Me Plugin
*
* @since 1.5
*/
final class Remember extends CMSPlugin implements SubscriberInterface
{
use DatabaseAwareTrait;
/**
* Returns an array of events this subscriber will listen to.
*
* @return array
*
* @since 5.3.0
*/
public static function getSubscribedEvents(): array
{
return [
'onAfterInitialise' => 'onAfterInitialise',
'onUserLogout' => 'onUserLogout',
'onUserBeforeSave' => 'onUserBeforeSave',
];
}
/**
* Remember me method to run onAfterInitialise
* Only purpose is to initialise the login authentication process if a cookie is present
*
* @param AfterInitialiseEvent $event The event instance.
*
* @return void
*
* @since 1.5
*
* @throws \InvalidArgumentException
*/
public function onAfterInitialise(AfterInitialiseEvent $event): void
{
// No remember me for admin.
if (!$this->getApplication()->isClient('site')) {
return;
}
$app = $this->getApplication();
// Check for a cookie if user is not logged in
if ($app->getIdentity()->guest) {
$cookieName = 'joomla_remember_me_' . UserHelper::getShortHashedUserAgent();
// Check for the cookie
if ($app->getInput()->cookie->get($cookieName)) {
$app->login(['username' => ''], ['silent' => true]);
}
}
}
/**
* Imports the authentication plugin on user logout to make sure that the cookie is destroyed.
*
* @param LogoutEvent $event The event instance.
*
* @return void
*/
public function onUserLogout(LogoutEvent $event): void
{
// No remember me for admin
if (!$this->getApplication()->isClient('site')) {
return;
}
$cookieName = 'joomla_remember_me_' . UserHelper::getShortHashedUserAgent();
// Check for the cookie
if ($this->getApplication()->getInput()->cookie->get($cookieName)) {
// Make sure authentication group is loaded to process onUserAfterLogout event
PluginHelper::importPlugin('authentication');
}
}
/**
* Method is called before user data is stored in the database
* Invalidate all existing remember-me cookies after a password change
*
* @param BeforeSaveEvent $event The event instance.
*
* @return boolean
*
* @since 3.8.6
*/
public function onUserBeforeSave(BeforeSaveEvent $event): void
{
$user = $event->getUser();
$isnew = $event->getIsNew();
$data = $event->getData();
// Irrelevant on new users
if ($isnew) {
return;
}
// Irrelevant, because password was not changed by user
if (empty($data['password_clear'])) {
return;
}
// But now, we need to do something - Delete all tokens for this user!
$db = $this->getDatabase();
$query = $db->getQuery(true)
->delete($db->quoteName('#__user_keys'))
->where($db->quoteName('user_id') . ' = :userid')
->bind(':userid', $user['username']);
try {
$db->setQuery($query)->execute();
} catch (\RuntimeException $e) {
// Log an alert for the site admin
Log::add(
\sprintf('Failed to delete cookie token for user %s with the following error: %s', $user['username'], $e->getMessage()),
Log::WARNING,
'security'
);
}
}
}
The same content is in 50 releases, Joomla 5.3.0-beta1 to 6.0.0-beta3. See them all, or every version of this file.