Augmentation vers version 3.3.0

install/update/new/phpbb/cron/controller/cron.php

@@ -0,0 +1,40 @@
+<?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\cron\controller;
+
+use Symfony\Component\HttpFoundation\Response;
+
+/**
+ * Controller for running cron jobs
+ */
+class cron
+{
+	/**
+	 * Handles CRON requests
+	 *
+	 * @param string $cron_type
+	 *
+	 * @return Response
+	 */
+	public function handle($cron_type)
+	{
+		$response = new Response();
+		$response->headers->set('Cache-Control', 'no-cache');
+		$response->headers->set('Content-type', 'image/gif');
+		$response->headers->set('Content-length', '43');
+		$response->setContent(base64_decode('R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=='));
+
+		return $response;
+	}
+}

install/update/new/phpbb/cron/event/cron_runner_listener.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.
+ *
+ */
+
+namespace phpbb\cron\event;
+
+use phpbb\cron\manager;
+use phpbb\lock\db;
+use phpbb\request\request_interface;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\KernelEvents;
+use Symfony\Component\HttpKernel\Event\PostResponseEvent;
+
+/**
+ * Event listener that executes cron tasks, after the response was served
+ */
+class cron_runner_listener implements EventSubscriberInterface
+{
+	/**
+	 * @var \phpbb\lock\db
+	 */
+	private $cron_lock;
+
+	/**
+	 * @var \phpbb\cron\manager
+	 */
+	private $cron_manager;
+
+	/**
+	 * @var \phpbb\request\request_interface
+	 */
+	private $request;
+
+	/**
+	 * Constructor
+	 *
+	 * @param db 				$lock
+	 * @param manager			$manager
+	 * @param request_interface	$request
+	 */
+	public function __construct(db $lock, manager $manager, request_interface $request)
+	{
+		$this->cron_lock	= $lock;
+		$this->cron_manager	= $manager;
+		$this->request		= $request;
+	}
+
+	/**
+	 * Runs the cron job after the response was sent
+	 *
+	 * @param PostResponseEvent	$event	The event
+	 */
+	public function on_kernel_terminate(PostResponseEvent $event)
+	{
+		$request = $event->getRequest();
+		$controller_name = $request->get('_route');
+
+		if ($controller_name !== 'phpbb_cron_run')
+		{
+			return;
+		}
+
+		$cron_type = $request->get('cron_type');
+
+		if ($this->cron_lock->acquire())
+		{
+			$task = $this->cron_manager->find_task($cron_type);
+			if ($task)
+			{
+				if ($task->is_parametrized())
+				{
+					$task->parse_parameters($this->request);
+				}
+
+				if ($task->is_ready())
+				{
+					$task->run();
+				}
+
+				$this->cron_lock->release();
+			}
+		}
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	static public function getSubscribedEvents()
+	{
+		return array(
+			KernelEvents::TERMINATE		=> 'on_kernel_terminate',
+		);
+	}
+}

install/update/new/phpbb/cron/manager.php

@@ -0,0 +1,164 @@
+<?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\cron;
+
+use phpbb\cron\task\wrapper;
+use phpbb\routing\helper;
+
+/**
+* Cron manager class.
+*
+* Finds installed cron tasks, stores task objects, provides task selection.
+*/
+class manager
+{
+	/**
+	 * @var helper
+	 */
+	protected $routing_helper;
+
+	/**
+	* Set of \phpbb\cron\task\wrapper objects.
+	* Array holding all tasks that have been found.
+	*
+	* @var array
+	*/
+	protected $tasks = array();
+
+	/**
+	 * @var string
+	 */
+	protected $phpbb_root_path;
+
+	/**
+	 * @var string
+	 */
+	protected $php_ext;
+
+	/**
+	* Constructor. Loads all available tasks.
+	*
+	* @param array|\Traversable $tasks Provides an iterable set of task names
+	* @param helper $routing_helper Routing helper
+	* @param string $phpbb_root_path Relative path to phpBB root
+	* @param string $php_ext PHP file extension
+	*/
+	public function __construct($tasks, helper $routing_helper, $phpbb_root_path, $php_ext)
+	{
+		$this->routing_helper = $routing_helper;
+		$this->phpbb_root_path = $phpbb_root_path;
+		$this->php_ext = $php_ext;
+
+		$this->load_tasks($tasks);
+	}
+
+	/**
+	* Loads tasks given by name, wraps them
+	* and puts them into $this->tasks.
+	*
+	* @param array|\Traversable $tasks		Array of instances of \phpbb\cron\task\task
+	*
+	* @return null
+	*/
+	public function load_tasks($tasks)
+	{
+		foreach ($tasks as $task)
+		{
+			$this->tasks[] = $this->wrap_task($task);
+		}
+	}
+
+	/**
+	* Finds a task that is ready to run.
+	*
+	* If several tasks are ready, any one of them could be returned.
+	*
+	* If no tasks are ready, null is returned.
+	*
+	* @return \phpbb\cron\task\wrapper|null
+	*/
+	public function find_one_ready_task()
+	{
+		shuffle($this->tasks);
+		foreach ($this->tasks as $task)
+		{
+			if ($task->is_ready())
+			{
+				return $task;
+			}
+		}
+		return null;
+	}
+
+	/**
+	* Finds all tasks that are ready to run.
+	*
+	* @return array		List of tasks which are ready to run (wrapped in \phpbb\cron\task\wrapper).
+	*/
+	public function find_all_ready_tasks()
+	{
+		$tasks = array();
+		foreach ($this->tasks as $task)
+		{
+			if ($task->is_ready())
+			{
+				$tasks[] = $task;
+			}
+		}
+		return $tasks;
+	}
+
+	/**
+	* Finds a task by name.
+	*
+	* If there is no task with the specified name, null is returned.
+	*
+	* Web runner uses this method to resolve names to tasks.
+	*
+	* @param string				$name Name of the task to look up.
+	* @return \phpbb\cron\task\wrapper	A wrapped task corresponding to the given name, or null.
+	*/
+	public function find_task($name)
+	{
+		foreach ($this->tasks as $task)
+		{
+			if ($task->get_name() == $name)
+			{
+				return $task;
+			}
+		}
+		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.
+	*
+	* @param  \phpbb\cron\task\task 			$task The task.
+	* @return \phpbb\cron\task\wrapper	The wrapped task.
+	*/
+	public function wrap_task(\phpbb\cron\task\task $task)
+	{
+		return new wrapper($task, $this->routing_helper, $this->phpbb_root_path, $this->php_ext);
+	}
+}

install/update/new/phpbb/cron/task/core/update_hashes.php

@@ -0,0 +1,130 @@
+<?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\cron\task\core;
+
+/**
+ * Update old hashes to the current default hashing algorithm
+ *
+ * It is intended to gradually update all "old" style hashes to the
+ * current default hashing algorithm.
+ */
+class update_hashes extends \phpbb\cron\task\base
+{
+	/** @var \phpbb\config\config */
+	protected $config;
+
+	/** @var \phpbb\db\driver\driver_interface */
+	protected $db;
+
+	/** @var \phpbb\lock\db */
+	protected $update_lock;
+
+	/** @var \phpbb\passwords\manager */
+	protected $passwords_manager;
+
+	/** @var string Default hashing type */
+	protected $default_type;
+
+	/**
+	 * Constructor.
+	 *
+	 * @param \phpbb\config\config $config
+	 * @param \phpbb\db\driver\driver_interface $db
+	 * @param \phpbb\lock\db $update_lock
+	 * @param \phpbb\passwords\manager $passwords_manager
+	 * @param array $hashing_algorithms Hashing driver
+	 *			service collection
+	 * @param array $defaults Default password types
+	 */
+	public function __construct(\phpbb\config\config $config, \phpbb\db\driver\driver_interface $db, \phpbb\lock\db $update_lock, \phpbb\passwords\manager $passwords_manager, $hashing_algorithms, $defaults)
+	{
+		$this->config = $config;
+		$this->db = $db;
+		$this->passwords_manager = $passwords_manager;
+		$this->update_lock = $update_lock;
+
+		foreach ($defaults as $type)
+		{
+			if ($hashing_algorithms[$type]->is_supported() && !$hashing_algorithms[$type] instanceof \phpbb\passwords\driver\base_native)
+			{
+				$this->default_type = $type;
+				break;
+			}
+		}
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function is_runnable()
+	{
+		return !$this->config['use_system_cron'];
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function should_run()
+	{
+		if (!empty($this->config['update_hashes_lock']))
+		{
+			$last_run = explode(' ', $this->config['update_hashes_lock']);
+			if ($last_run[0] + 60 >= time())
+			{
+				return false;
+			}
+		}
+
+		return $this->config['enable_update_hashes'] && $this->config['update_hashes_last_cron'] < (time() - 60);
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function run()
+	{
+		if ($this->update_lock->acquire())
+		{
+			$sql = 'SELECT user_id, user_password
+				FROM ' . USERS_TABLE . '
+				WHERE user_password ' . $this->db->sql_like_expression('$H$' . $this->db->get_any_char()) . '
+				OR user_password ' . $this->db->sql_like_expression('$CP$' . $this->db->get_any_char());
+			$result = $this->db->sql_query_limit($sql, 20);
+
+			$affected_rows = 0;
+
+			while ($row = $this->db->sql_fetchrow($result))
+			{
+				$new_hash = $this->passwords_manager->hash($row['user_password'], array($this->default_type));
+
+				// Increase number so we know that users were selected from the database
+				$affected_rows++;
+
+				$sql = 'UPDATE ' . USERS_TABLE . "
+					SET user_password = '" . $this->db->sql_escape($new_hash) . "'
+					WHERE user_id = " . (int) $row['user_id'];
+				$this->db->sql_query($sql);
+			}
+
+			$this->config->set('update_hashes_last_cron', time());
+			$this->update_lock->release();
+
+			// Stop cron for good once all hashes are converted
+			if ($affected_rows === 0)
+			{
+				$this->config->set('enable_update_hashes', '0');
+			}
+		}
+	}
+}

install/update/new/phpbb/cron/task/wrapper.php

@@ -0,0 +1,117 @@
+<?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\cron\task;
+
+use phpbb\routing\helper;
+
+/**
+* Cron task wrapper class.
+* Enhances cron tasks with convenience methods that work identically for all tasks.
+*/
+class wrapper
+{
+	/**
+	 * @var helper
+	 */
+	protected $routing_helper;
+
+	/**
+	 * @var task
+	 */
+	protected $task;
+
+	/**
+	 * @var string
+	 */
+	protected $phpbb_root_path;
+
+	/**
+	 * @var string
+	 */
+	protected $php_ext;
+
+	/**
+	* Constructor.
+	*
+	* Wraps a task $task, which must implement cron_task interface.
+	*
+	* @param task	$task				The cron task to wrap.
+	* @param helper	$routing_helper		Routing helper for route generation
+	* @param string	$phpbb_root_path	Relative path to phpBB root
+	* @param string	$php_ext			PHP file extension
+	*/
+	public function __construct(task $task, helper $routing_helper, $phpbb_root_path, $php_ext)
+	{
+		$this->task = $task;
+		$this->routing_helper = $routing_helper;
+		$this->phpbb_root_path = $phpbb_root_path;
+		$this->php_ext = $php_ext;
+	}
+
+	/**
+	* Returns whether the wrapped task is parametrised.
+	*
+	* Parametrized tasks accept parameters during initialization and must
+	* normally be scheduled with parameters.
+	*
+	* @return bool		Whether or not this task is parametrized.
+	*/
+	public function is_parametrized()
+	{
+		return $this->task instanceof parametrized;
+	}
+
+	/**
+	* Returns whether the wrapped task is ready to run.
+	*
+	* A task is ready to run when it is runnable according to current configuration
+	* and enough time has passed since it was last run.
+	*
+	* @return bool		Whether the wrapped task is ready to run.
+	*/
+	public function is_ready()
+	{
+		return $this->task->is_runnable() && $this->task->should_run();
+	}
+
+	/**
+	* Returns a url through which this task may be invoked via web.
+	*
+	* When system cron is not in use, running a cron task is accomplished
+	* by outputting an image with the url returned by this function as
+	* source.
+	*
+	* @return string		URL through which this task may be invoked.
+	*/
+	public function get_url()
+	{
+		$params['cron_type'] = $this->get_name();
+		if ($this->is_parametrized())
+		{
+			$params = array_merge($params, $this->task->get_parameters());
+		}
+
+		return $this->routing_helper->route('phpbb_cron_run', $params);
+	}
+
+	/**
+	* Forwards all other method calls to the wrapped task implementation.
+	*
+	* @return mixed
+	*/
+	public function __call($name, $args)
+	{
+		return call_user_func_array(array($this->task, $name), $args);
+	}
+}