- md5
- 2dc260c0c2bc5993a6e544554643268c
- sha1
- 201e635b7e1fd0246060fedc835febbcb87b680b
- sha256
- a24b0c0ce1df83d85e764e185dbae0f146597ee8491454d173c2049a6b63d907
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172
<?php
/**
* @package Joomla.Plugins
* @subpackage Task.DemoTasks
*
* @copyright (C) 2021 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
// Restrict direct access
defined('_JEXEC') or die;
use Joomla\CMS\Plugin\CMSPlugin;
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;
/**
* A demo task plugin. Offers 3 task routines and demonstrates the use of {@see TaskPluginTrait},
* {@see ExecuteTaskEvent}.
*
* @since __DEPLOY__VERSION__
*/
class PlgTaskDemotasks extends CMSPlugin implements SubscriberInterface
{
use TaskPluginTrait;
/**
* @var string[]
* @since 4.1.0
*/
private const TASKS_MAP = [
'demoTask_r1.sleep' => [
'langConstPrefix' => 'PLG_TASK_DEMO_TASKS_TASK_SLEEP',
'method' => 'sleep',
'form' => 'testTaskForm',
],
'demoTask_r2.memoryStressTest' => [
'langConstPrefix' => 'PLG_TASK_DEMO_TASKS_STRESS_MEMORY',
'method' => 'stressMemory',
],
'demoTask_r3.memoryStressTestOverride' => [
'langConstPrefix' => 'PLG_TASK_DEMO_TASKS_STRESS_MEMORY_OVERRIDE',
'method' => 'stressMemoryRemoveLimit',
],
];
/**
* @var boolean
* @since 4.1.0
*/
protected $autoloadLanguage = true;
/**
* @inheritDoc
*
* @return string[]
*
* @since 4.1.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 4.1.0
* @throws Exception
*/
private function sleep(ExecuteTaskEvent $event): int
{
$timeout = (int) $event->getArgument('params')->timeout ?? 1;
$this->logTask(sprintf('Starting %d timeout', $timeout));
sleep($timeout);
$this->logTask(sprintf('%d timeout over!', $timeout));
return Status::OK;
}
/**
* Standard routine method for the memory test routine.
*
* @param ExecuteTaskEvent $event The `onExecuteTask` event.
*
* @return integer The routine exit code.
*
* @since 4.1.0
* @throws Exception
*/
private function stressMemory(ExecuteTaskEvent $event): int
{
$mLimit = $this->getMemoryLimit();
$this->logTask(sprintf('Memory Limit: %d KB', $mLimit));
$iMem = $cMem = memory_get_usage();
$i = 0;
while ($cMem + ($cMem - $iMem) / ++$i <= $mLimit)
{
$this->logTask(sprintf('Current memory usage: %d KB', $cMem));
${"array" . $i} = array_fill(0, 100000, 1);
}
return Status::OK;
}
/**
* Standard routine method for the memory test routine, also attempts to override the memory limit set by the PHP
* INI.
*
* @param ExecuteTaskEvent $event The `onExecuteTask` event.
*
* @return integer The routine exit code.
*
* @since 4.1.0
* @throws Exception
*/
private function stressMemoryRemoveLimit(ExecuteTaskEvent $event): int
{
$success = false;
if (function_exists('ini_set'))
{
$success = ini_set('memory_limit', -1) !== false;
}
$this->logTask('Memory limit override ' . $success ? 'successful' : 'failed');
return $this->stressMemory($event);
}
/**
* Processes the PHP ini memory_limit setting, returning the memory limit in KB
*
* @return float
*
* @since 4.1.0
*/
private function getMemoryLimit(): float
{
$memoryLimit = ini_get('memory_limit');
if (preg_match('/^(\d+)(.)$/', $memoryLimit, $matches))
{
if ($matches[2] == 'M')
{
// * nnnM -> nnn MB
$memoryLimit = $matches[1] * 1024 * 1024;
}
else
{
if ($matches[2] == 'K')
{
// * nnnK -> nnn KB
$memoryLimit = $matches[1] * 1024;
}
}
}
return (float) $memoryLimit;
}
}
The same content is in 3 releases, Joomla 4.1.0-beta1 to 4.1.0-beta3. See them all, or every version of this file.