Merge pull request #2509 from Stephannos/ticket/12602

[ticket/12602] Add command to print the cron list

* Stephannos/ticket/12602:
  [ticket/12602] Fix language key removal.
  [ticket/12602] Rectify language keys.
  [ticket/12602] Fix test mistake.
  [ticket/12602] Fix language var mistakes.
  [ticket/12602] Add types, change description of cron:list.
  [ticket/12602] Fix internationalisation of cron_list.php
  [ticket/12602] Fix spaces issues.
  [ticket/12602] Coding style correction.
  [ticket/12602] Fix coding style mistakes.
  [ticket/12602] Headers updated.
  [ticket/12602] Changes to respect coding style and to factorize code.
  [ticket/12602] Cleanup tests
  [ticket/12602] Add function get_tasks.
  [ticket/12602] Correction of the output message for the cron list
  [ticket/12602] Add files to print the cron list and test files.

phpBB/config/console.yml

@@ -46,6 +46,14 @@ services:
         tags:
             - { name: console.command }
 
+    console.command.cron.list:
+        class: phpbb\console\command\cron\cron_list
+        arguments:
+            - @cron.manager
+            - @user
+        tags:
+            - { name: console.command }
+
     console.command.cron.run:
         class: phpbb\console\command\cron\run
         arguments:

phpBB/language/en/acp/common.php

@@ -223,6 +223,7 @@ $lang = array_merge($lang, array(
 
 	'BACK'					=> 'Back',
 
+	'CLI_DESCRIPTION_CRON_LIST'				=> 'Prints a list of ready and unready cron jobs.',
 	'CLI_DESCRIPTION_CRON_RUN'				=> 'Runs all ready cron tasks.',
 	'CLI_DESCRIPTION_CRON_RUN_ARGUMENT_1'	=> 'Name of the task to be run',
 
@@ -231,6 +232,7 @@ $lang = array_merge($lang, array(
 	'CRON_LOCK_ERROR'		=> 'Could not obtain cron lock.',
 	'CRON_NO_SUCH_TASK'		=> 'Could not find cron task “%s”.',
 	'CRON_NO_TASK'			=> 'No cron tasks need to be run right now.',
+	'CRON_NO_TASKS'			=> 'No cron tasks could be found.',
 
 	'DEACTIVATE'				=> 'Deactivate',
 	'DIRECTORY_DOES_NOT_EXIST'	=> 'The entered path “%s” does not exist.',
@@ -302,6 +304,8 @@ $lang = array_merge($lang, array(
 
 	'SHOW_ALL_OPERATIONS'	=> 'Show all operations',
 
+	'TASKS_NOT_READY'			=> 'Not ready tasks:',
+	'TASKS_READY'			=> 'Ready tasks:',
 	'TOTAL_SIZE'      		=> 'Total size',
 
 	'UCP'					=> 'User Control Panel',

phpBB/phpbb/console/command/cron/cron_list.php

@@ -0,0 +1,90 @@
+<?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;
+
+	/** @var \phpbb\user */
+	protected $user;
+
+	public function __construct(\phpbb\cron\manager $cron_manager, \phpbb\user $user)
+	{
+		$this->cron_manager = $cron_manager;
+		$this->user = $user;
+		parent::__construct();
+	}
+
+	protected function configure()
+	{
+		$this
+			->setName('cron:list')
+			->setDescription($this->user->lang('CLI_DESCRIPTION_CRON_LIST'))
+		;
+	}
+
+	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);
+		}
+	}
+
+	protected function print_tasks_names(array $tasks, OutputInterface $output)
+	{
+		foreach ($tasks as $task)
+		{
+			$output->writeln($task->get_name());
+		}
+	}
+}

phpBB/phpbb/cron/manager.php

@@ -121,6 +121,16 @@ class manager
 		return null;
 	}
 
+	/**
+	* Find all tasks and return them.
+	*
+	* @return array List of all tasks.
+	*/
+	public function get_tasks()
+	{
+		return $this->tasks;
+	}
+
 	/**
 	* Wraps a task inside an instance of \phpbb\cron\task\wrapper.
 	*

tests/console/cron/cron_list_test.php

@@ -0,0 +1,103 @@
+<?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.
+*
+*/
+
+require_once dirname(__FILE__) . '/tasks/simple_ready.php';
+require_once dirname(__FILE__) . '/tasks/simple_not_ready.php';
+
+use Symfony\Component\Console\Application;
+use Symfony\Component\Console\Tester\CommandTester;
+use phpbb\console\command\cron\cron_list;
+
+class phpbb_console_command_cron_list_test extends phpbb_test_case
+{
+	/** @var \phpbb\cron\manager */
+	protected $cron_manager;
+
+	/** @var \phpbb\user */
+	protected $user;
+
+	protected $command_name;
+
+	protected $command_tester;
+
+	protected function setUp()
+	{
+		$this->user = $this->getMock('\phpbb\user');
+		$this->user->method('lang')->will($this->returnArgument(0));
+	}
+
+	public function test_no_task()
+	{
+		$this->initiate_test(0, 0);
+		$this->assertContains('CRON_NO_TASKS', $this->command_tester->getDisplay());
+	}
+
+	public function test_only_ready()
+	{
+		$this->initiate_test(2, 0);
+		$this->assertContains('TASKS_READY command1 command2', preg_replace('/\s+/', ' ', trim($this->command_tester->getDisplay())));
+	}
+
+	public function test_only_not_ready()
+	{
+		$this->initiate_test(0, 2);
+		$this->assertContains('TASKS_NOT_READY command1 command2', preg_replace('/\s+/', ' ', trim($this->command_tester->getDisplay())));
+	}
+
+	public function test_both_ready()
+	{
+		$this->initiate_test(2, 2);
+		$this->assertSame('TASKS_READY command1 command2 TASKS_NOT_READY command3 command4', preg_replace('/\s+/', ' ', trim($this->command_tester->getDisplay())));
+	}
+
+	public function get_cron_manager(array $tasks)
+	{
+		global $pathEx, $phpbb_root_path;
+		$i = 1;
+		foreach ($tasks as $task)
+		{
+			$task->set_name('command' . $i);
+			$i++;
+		}
+		$this->cron_manager = new \phpbb\cron\manager($tasks, $phpbb_root_path, $pathEx);
+	}
+
+	public function get_command_tester()
+	{
+		$application = new Application();
+		$application->add(new cron_list($this->cron_manager, $this->user));
+
+		$command = $application->find('cron:list');
+		$this->command_name = $command->getName();
+		return new CommandTester($command);
+	}
+
+	public function initiate_test($number_ready, $number_not_ready)
+	{
+		$tasks = array();
+
+		for ($i = 0; $i < $number_ready; $i++)
+		{
+			$tasks[] =  new phpbb_cron_task_simple_ready();
+		}
+
+		for ($i = 0; $i < $number_not_ready; $i++)
+		{
+			$tasks[] = new phpbb_cron_task_simple_not_ready();
+		}
+
+		$this->get_cron_manager($tasks);
+		$this->command_tester = $this->get_command_tester();
+		$this->command_tester->execute(array('command' => $this->command_name, '--no-ansi' => true));
+	}
+}

tests/console/cron/tasks/simple_not_ready.php

@@ -0,0 +1,13 @@
+<?php
+
+class phpbb_cron_task_simple_not_ready extends \phpbb\cron\task\base
+{
+	public function run()
+	{
+	}
+
+	public function should_run()
+	{
+		return false;
+	}
+}

tests/console/cron/tasks/simple_ready.php

@@ -0,0 +1,8 @@
+<?php
+
+class phpbb_cron_task_simple_ready extends \phpbb\cron\task\base
+{
+	public function run()
+	{
+	}
+}