- md5
- db3ff8db32d86cbc8c9ffcd94173627b
- sha1
- e5a1636661b43ba167c1a31cd039ee872c0d8837
- sha256
- 31f78246480af7e4ea525632825d4289595f15f4b87a8128d7dc53ef486ec805
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
<?php
/**
* @package Joomla.Plugins
* @subpackage Task.sessiongc
*
* @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\Plugin\Task\SessionGC\Extension;
use Joomla\CMS\Plugin\CMSPlugin;
use Joomla\CMS\Session\MetadataManager;
use Joomla\Component\Scheduler\Administrator\Event\ExecuteTaskEvent;
use Joomla\Component\Scheduler\Administrator\Task\Status;
use Joomla\Component\Scheduler\Administrator\Traits\TaskPluginTrait;
use Joomla\Event\SubscriberInterface;
// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* A task plugin. Session data purge task.
* {@see ExecuteTaskEvent}.
*
* @since 5.0.0
*/
final class SessionGC extends CMSPlugin implements SubscriberInterface
{
use TaskPluginTrait;
/**
* The meta data manager
*
* @var MetadataManager
*
* @since 4.4.0
*/
private $metadataManager;
/**
* @var string[]
* @since 5.0.0
*/
private const TASKS_MAP = [
'session.gc' => [
'langConstPrefix' => 'PLG_TASK_SESSIONGC',
'method' => 'sessionGC',
'form' => 'sessionGCForm',
],
];
/**
* @var boolean
* @since 5.0.0
*/
protected $autoloadLanguage = true;
/**
* Constructor.
*
* @param array $config An optional associative array of configuration settings
* @param MetadataManager $metadataManager The user factory
*
* @since 4.4.0
*/
public function __construct(array $config, MetadataManager $metadataManager)
{
parent::__construct($config);
$this->metadataManager = $metadataManager;
}
/**
* @inheritDoc
*
* @return string[]
*
* @since 5.0.0
*/
public static function getSubscribedEvents(): array
{
return [
'onTaskOptionsList' => 'advertiseRoutines',
'onExecuteTask' => 'standardRoutineHandler',
'onContentPrepareForm' => 'enhanceTaskItemForm',
];
}
/**
* @param ExecuteTaskEvent $event The `onExecuteTask` event.
*
* @return integer The routine exit code.
*
* @since 5.0.0
* @throws \Exception
*/
private function sessionGC(ExecuteTaskEvent $event): int
{
$enableGC = (int) $event->getArgument('params')->enable_session_gc ?? 1;
if ($enableGC) {
$this->getApplication()->getSession()->gc();
}
$enableMetadata = (int) $event->getArgument('params')->enable_session_metadata_gc ?? 1;
if ($this->getApplication()->get('session_handler', 'none') !== 'database' && $enableMetadata) {
$this->metadataManager->deletePriorTo(time() - $this->getApplication()->getSession()->getExpire());
}
$this->logTask('SessionGC end');
return Status::OK;
}
}
The same content is in 11 releases, Joomla 5.4.0-beta2 to 6.0.0. See them all, or every version of this file.