first commit
This commit is contained in:
22
plugins/task/deleteactionlogs/deleteactionlogs.xml
Normal file
22
plugins/task/deleteactionlogs/deleteactionlogs.xml
Normal file
@ -0,0 +1,22 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<extension type="plugin" group="task" method="upgrade">
|
||||
<name>plg_task_deleteactionlogs</name>
|
||||
<author>Joomla! Project</author>
|
||||
<creationDate>2023-07</creationDate>
|
||||
<copyright>(C) 2023 Open Source Matters, Inc.</copyright>
|
||||
<license>GNU General Public License version 2 or later; see LICENSE.txt</license>
|
||||
<authorEmail>admin@joomla.org</authorEmail>
|
||||
<authorUrl>www.joomla.org</authorUrl>
|
||||
<version>5.0.0</version>
|
||||
<description>PLG_TASK_DELETEACTIONLOGS_XML_DESCRIPTION</description>
|
||||
<namespace path="src">Joomla\Plugin\Task\DeleteActionLogs</namespace>
|
||||
<files>
|
||||
<folder>forms</folder>
|
||||
<folder plugin="deleteactionlogs">services</folder>
|
||||
<folder>src</folder>
|
||||
</files>
|
||||
<languages>
|
||||
<language tag="en-GB">language/en-GB/plg_task_deleteactionlogs.ini</language>
|
||||
<language tag="en-GB">language/en-GB/plg_task_deleteactionlogs.sys.ini</language>
|
||||
</languages>
|
||||
</extension>
|
||||
16
plugins/task/deleteactionlogs/forms/deleteForm.xml
Normal file
16
plugins/task/deleteactionlogs/forms/deleteForm.xml
Normal file
@ -0,0 +1,16 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<form>
|
||||
<fields name="params">
|
||||
<fieldset name="task_params">
|
||||
<field
|
||||
name="logDeletePeriod"
|
||||
type="number"
|
||||
label="PLG_TASK_DELETEACTIONLOGS_LOG_DELETE_PERIOD"
|
||||
default="7"
|
||||
min="1"
|
||||
filter="int"
|
||||
validate="number"
|
||||
/>
|
||||
</fieldset>
|
||||
</fields>
|
||||
</form>
|
||||
48
plugins/task/deleteactionlogs/services/provider.php
Normal file
48
plugins/task/deleteactionlogs/services/provider.php
Normal file
@ -0,0 +1,48 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @package Joomla.Plugin
|
||||
* @subpackage Task.deletelogs
|
||||
*
|
||||
* @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org>
|
||||
* @license GNU General Public License version 2 or later; see LICENSE.txt
|
||||
*/
|
||||
|
||||
\defined('_JEXEC') or die;
|
||||
|
||||
use Joomla\CMS\Extension\PluginInterface;
|
||||
use Joomla\CMS\Factory;
|
||||
use Joomla\CMS\Plugin\PluginHelper;
|
||||
use Joomla\Database\DatabaseInterface;
|
||||
use Joomla\DI\Container;
|
||||
use Joomla\DI\ServiceProviderInterface;
|
||||
use Joomla\Event\DispatcherInterface;
|
||||
use Joomla\Plugin\Task\DeleteActionLogs\Extension\DeleteActionLogs;
|
||||
|
||||
return new class () implements ServiceProviderInterface {
|
||||
/**
|
||||
* Registers the service provider with a DI container.
|
||||
*
|
||||
* @param Container $container The DI container.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 5.0.0
|
||||
*/
|
||||
public function register(Container $container)
|
||||
{
|
||||
$container->set(
|
||||
PluginInterface::class,
|
||||
function (Container $container) {
|
||||
$plugin = new DeleteActionLogs(
|
||||
$container->get(DispatcherInterface::class),
|
||||
(array) PluginHelper::getPlugin('task', 'deleteactionlogs')
|
||||
);
|
||||
$plugin->setApplication(Factory::getApplication());
|
||||
$plugin->setDatabase($container->get(DatabaseInterface::class));
|
||||
|
||||
return $plugin;
|
||||
}
|
||||
);
|
||||
}
|
||||
};
|
||||
108
plugins/task/deleteactionlogs/src/Extension/DeleteActionLogs.php
Normal file
108
plugins/task/deleteactionlogs/src/Extension/DeleteActionLogs.php
Normal file
@ -0,0 +1,108 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @package Joomla.Plugin
|
||||
* @subpackage Task.deleteactionlogs
|
||||
*
|
||||
* @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\DeleteActionLogs\Extension;
|
||||
|
||||
use Joomla\CMS\Factory;
|
||||
use Joomla\CMS\Plugin\CMSPlugin;
|
||||
use Joomla\Component\Scheduler\Administrator\Event\ExecuteTaskEvent;
|
||||
use Joomla\Component\Scheduler\Administrator\Task\Status;
|
||||
use Joomla\Component\Scheduler\Administrator\Task\Task;
|
||||
use Joomla\Component\Scheduler\Administrator\Traits\TaskPluginTrait;
|
||||
use Joomla\Database\DatabaseAwareTrait;
|
||||
use Joomla\Event\SubscriberInterface;
|
||||
|
||||
// phpcs:disable PSR1.Files.SideEffects
|
||||
\defined('_JEXEC') or die;
|
||||
// phpcs:enable PSR1.Files.SideEffects
|
||||
|
||||
/**
|
||||
* A task plugin. For Delete Action Logs after x days
|
||||
* {@see ExecuteTaskEvent}.
|
||||
*
|
||||
* @since 5.0.0
|
||||
*/
|
||||
final class DeleteActionLogs extends CMSPlugin implements SubscriberInterface
|
||||
{
|
||||
use DatabaseAwareTrait;
|
||||
use TaskPluginTrait;
|
||||
|
||||
/**
|
||||
* @var string[]
|
||||
* @since 5.0.0
|
||||
*/
|
||||
private const TASKS_MAP = [
|
||||
'delete.actionlogs' => [
|
||||
'langConstPrefix' => 'PLG_TASK_DELETEACTIONLOGS_DELETE',
|
||||
'method' => 'deleteLogs',
|
||||
'form' => 'deleteForm',
|
||||
],
|
||||
];
|
||||
|
||||
/**
|
||||
* @var boolean
|
||||
* @since 5.0.0
|
||||
*/
|
||||
protected $autoloadLanguage = true;
|
||||
|
||||
/**
|
||||
* @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 deleteLogs(ExecuteTaskEvent $event): int
|
||||
{
|
||||
$daysToDeleteAfter = (int) $event->getArgument('params')->logDeletePeriod ?? 0;
|
||||
$this->logTask(sprintf('Delete Logs after %d days', $daysToDeleteAfter));
|
||||
$now = Factory::getDate()->toSql();
|
||||
$db = $this->getDatabase();
|
||||
$query = $db->getQuery(true);
|
||||
|
||||
if ($daysToDeleteAfter > 0) {
|
||||
$days = -1 * $daysToDeleteAfter;
|
||||
|
||||
$query->clear()
|
||||
->delete($db->quoteName('#__action_logs'))
|
||||
->where($db->quoteName('log_date') . ' < ' . $query->dateAdd($db->quote($now), $days, 'DAY'));
|
||||
|
||||
$db->setQuery($query);
|
||||
|
||||
try {
|
||||
$db->execute();
|
||||
} catch (\RuntimeException $e) {
|
||||
// Ignore it
|
||||
return Status::KNOCKOUT;
|
||||
}
|
||||
}
|
||||
|
||||
$this->logTask('Delete Logs end');
|
||||
|
||||
return Status::OK;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user