diff options
Diffstat (limited to 'phpBB/phpbb/console/command/cron')
| -rw-r--r-- | phpBB/phpbb/console/command/cron/cron_list.php | 111 | ||||
| -rw-r--r-- | phpBB/phpbb/console/command/cron/run.php | 171 | 
2 files changed, 282 insertions, 0 deletions
| diff --git a/phpBB/phpbb/console/command/cron/cron_list.php b/phpBB/phpbb/console/command/cron/cron_list.php new file mode 100644 index 0000000000..c515fd9e80 --- /dev/null +++ b/phpBB/phpbb/console/command/cron/cron_list.php @@ -0,0 +1,111 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ +namespace phpbb\console\command\cron; + +use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Output\OutputInterface; + +class cron_list extends \phpbb\console\command\command +{ +	/** @var \phpbb\cron\manager */ +	protected $cron_manager; + +	/** +	* Constructor +	* +	* @param \phpbb\user			$user			User instance +	* @param \phpbb\cron\manager	$cron_manager	Cron manager +	*/ +	public function __construct(\phpbb\user $user, \phpbb\cron\manager $cron_manager) +	{ +		$this->cron_manager = $cron_manager; +		parent::__construct($user); +	} + +	/** +	* {@inheritdoc} +	*/ +	protected function configure() +	{ +		$this +			->setName('cron:list') +			->setDescription($this->user->lang('CLI_DESCRIPTION_CRON_LIST')) +		; +	} + +	/** +	* Executes the command cron:list. +	* +	* Prints a list of ready and unready cron jobs. +	* +	* @param InputInterface  $input  An InputInterface instance +	* @param OutputInterface $output An OutputInterface instance +	* +	* @return null +	*/ +	protected function execute(InputInterface $input, OutputInterface $output) +	{ +		$tasks = $this->cron_manager->get_tasks(); + +		if (empty($tasks)) +		{ +			$output->writeln($this->user->lang('CRON_NO_TASKS')); +			return; +		} + +		$ready_tasks = array(); +		$not_ready_tasks = array(); +		foreach ($tasks as $task) +		{ +			if ($task->is_ready()) +			{ +				$ready_tasks[] = $task; +			} +			else +			{ +				$not_ready_tasks[] = $task; +			} +		} + +		if (!empty($ready_tasks)) +		{ +			$output->writeln('<info>' . $this->user->lang('TASKS_READY') . '</info>'); +			$this->print_tasks_names($ready_tasks, $output); +		} + +		if (!empty($ready_tasks) && !empty($not_ready_tasks)) +		{ +			$output->writeln(''); +		} + +		if (!empty($not_ready_tasks)) +		{ +			$output->writeln('<info>' . $this->user->lang('TASKS_NOT_READY') . '</info>'); +			$this->print_tasks_names($not_ready_tasks, $output); +		} +	} + +	/** +	* Print a list of cron jobs +	* +	* @param array				$tasks A list of task to display +	* @param OutputInterface	$output An OutputInterface instance +	*/ +	protected function print_tasks_names(array $tasks, OutputInterface $output) +	{ +		foreach ($tasks as $task) +		{ +			$output->writeln($task->get_name()); +		} +	} +} diff --git a/phpBB/phpbb/console/command/cron/run.php b/phpBB/phpbb/console/command/cron/run.php new file mode 100644 index 0000000000..72ad1205ef --- /dev/null +++ b/phpBB/phpbb/console/command/cron/run.php @@ -0,0 +1,171 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\console\command\cron; + +use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Input\InputArgument; +use Symfony\Component\Console\Output\OutputInterface; + +class run extends \phpbb\console\command\command +{ +	/** @var \phpbb\cron\manager */ +	protected $cron_manager; + +	/** @var \phpbb\lock\db */ +	protected $lock_db; + +	/** +	* Construct method +	* +	* @param \phpbb\user $user The user object (used to get language information) +	* @param \phpbb\cron\manager $cron_manager The cron manager containing +	*		the cron tasks to be executed. +	* @param \phpbb\lock\db $lock_db The lock for accessing database. +	*/ +	public function __construct(\phpbb\user $user, \phpbb\cron\manager $cron_manager, \phpbb\lock\db $lock_db) +	{ +		$this->cron_manager = $cron_manager; +		$this->lock_db = $lock_db; +		parent::__construct($user); +	} + +	/** +	* Sets the command name and description +	* +	* @return null +	*/ +	protected function configure() +	{ +		$this +			->setName('cron:run') +			->setDescription($this->user->lang('CLI_DESCRIPTION_CRON_RUN')) +			->addArgument('name', InputArgument::OPTIONAL, $this->user->lang('CLI_DESCRIPTION_CRON_RUN_ARGUMENT_1')) +		; +	} + +	/** +	* Executes the command cron:run. +	* +	* Tries to acquire the cron lock, then if no argument has been given runs all ready cron tasks. +	* If the cron lock can not be obtained, an error message is printed +	*		and the exit status is set to 1. +	* If the verbose option is specified, each start of a task is printed. +	*		Otherwise there is no output. +	* If an argument is given to the command, only the task whose name matches the +	*		argument will be started. If verbose option is specified, +	*		an info message containing the name of the task is printed. +	* If no task matches the argument given, an error message is printed +	*		and the exit status is set to 2. +	* +	* @param InputInterface $input The input stream used to get the argument and verboe option. +	* @param OutputInterface $output The output stream, used for printing verbose-mode and error information. +	* +	* @return int 0 if all is ok, 1 if a lock error occured and 2 if no task matching the argument was found. +	*/ +	protected function execute(InputInterface $input, OutputInterface $output) +	{ +		if ($this->lock_db->acquire()) +		{ +			$task_name = $input->getArgument('name'); +			if ($task_name) +			{ +				$exit_status = $this->run_one($input, $output, $task_name); +			} +			else +			{ +				$exit_status = $this->run_all($input, $output); +			} + +			$this->lock_db->release(); +			return $exit_status; +		} +		else +		{ +			$output->writeln('<error>' . $this->user->lang('CRON_LOCK_ERROR') . '</error>'); +			return 1; +		} +	} + +	/** +	* Executes all ready cron tasks. +	* +	* If verbose mode is set, an info message will be printed if there is no task to +	*		be run, or else for each starting task. +	* +	* @see execute +	* @param InputInterface $input The input stream used to get the argument and verbose option. +	* @param OutputInterface $output The output stream, used for printing verbose-mode and error information. +	* @return int 0 +	*/ +	protected function run_all(InputInterface $input, OutputInterface $output) +	{ +		$run_tasks = $this->cron_manager->find_all_ready_tasks(); + +		if ($run_tasks) +		{ +			foreach ($run_tasks as $task) +			{ +				if ($input->getOption('verbose')) +				{ +					$output->writeln('<info>' . $this->user->lang('RUNNING_TASK', $task->get_name()) . '</info>'); +				} + +				$task->run(); +			} +		} +		else +		{ +			if ($input->getOption('verbose')) +			{ +				$output->writeln('<info>' . $this->user->lang('CRON_NO_TASK') . '</info>'); +			} +		} + +		return 0; +	} + +	/** +	* Executes a given cron task, if it is ready. +	* +	* If there is a task whose name matches $task_name, it is run and 0 is returned. +	*		and if verbose mode is set, print an info message with the name of the task. +	* If there is no task matching $task_name, the function prints an error message +	*		and returns with status 2. +	* +	* @see execute +	* @param string $task_name The name of the task that should be run. +	* @param InputInterface $input The input stream used to get the argument and verbose option. +	* @param OutputInterface $output The output stream, used for printing verbose-mode and error information. +	* @return int 0 if all is well, 2 if no task matches $task_name. +	*/ +	protected function run_one(InputInterface $input, OutputInterface $output, $task_name) +	{ +		$task = $this->cron_manager->find_task($task_name); +		if ($task) +		{ +			if ($input->getOption('verbose')) +			{ +				$output->writeln('<info>' . $this->user->lang('RUNNING_TASK', $task_name) . '</info>'); +			} + +			$task->run(); +			return 0; +		} +		else +		{ +			$output->writeln('<error>' . $this->user->lang('CRON_NO_SUCH_TASK', $task_name) . '</error>'); +			return 2; +		} +	} +} | 
