4 files changed, 253 insertions, 0 deletions
diff --git a/phpBB/includes/cron/task/base.php b/phpBB/includes/cron/task/base.php
new file mode 100644
index 0000000000..ba399c18b1
--- /dev/null
+++ b/phpBB/includes/cron/task/base.php
@@ -0,0 +1,59 @@
+<?php
+/**
+*
+* @package phpBB3
+* @version $Id$
+* @copyright (c) 2010 phpBB Group
+* @license http://opensource.org/licenses/gpl-license.php GNU Public License
+*
+*/
+
+/**
+* @ignore
+*/
+if (!defined('IN_PHPBB'))
+{
+	exit;
+}
+
+/**
+* Cron task base class. Provides sensible defaults for cron tasks
+* and partially implements cron task interface, making writing cron tasks easier.
+*
+* At a minimum, subclasses must override the run() method.
+*
+* Cron tasks need not inherit from this base class. If desired,
+* they may implement cron task interface directly.
+*
+* @package phpBB3
+*/
+abstract class phpbb_cron_task_base implements phpbb_cron_task
+{
+	/**
+	* Returns whether this cron task can run, given current board configuration.
+	*
+	* For example, a cron task that prunes forums can only run when
+	* forum pruning is enabled.
+	*/
+	public function is_runnable()
+	{
+		return true;
+	}
+
+	/**
+	* Returns whether this cron task should run now, because enough time
+	* has passed since it was last run.
+	*/
+	public function should_run()
+	{
+		return true;
+	}
+
+	/**
+	* Returns whether this cron task can be run in shutdown function.
+	*/
+	public function is_shutdown_function_safe()
+	{
+		return true;
+	}
+}
diff --git a/phpBB/includes/cron/task/parametrized.php b/phpBB/includes/cron/task/parametrized.php
new file mode 100644
index 0000000000..d505cc3328
--- /dev/null
+++ b/phpBB/includes/cron/task/parametrized.php
@@ -0,0 +1,49 @@
+<?php
+/**
+*
+* @package phpBB3
+* @version $Id$
+* @copyright (c) 2010 phpBB Group
+* @license http://opensource.org/licenses/gpl-license.php GNU Public License
+*
+*/
+
+/**
+* @ignore
+*/
+if (!defined('IN_PHPBB'))
+{
+	exit;
+}
+
+/**
+* Parametrized cron task interface.
+*
+* Parametrized cron tasks are somewhat of a cross between regular cron tasks and
+* delayed jobs. Whereas regular cron tasks perform some action globally,
+* parametrized cron tasks perform actions on a particular object (or objects).
+* Parametrized cron tasks do not make sense and are not usable without
+* specifying these objects.
+*
+* @package phpBB3
+*/
+interface phpbb_cron_task_parametrized extends phpbb_cron_task
+{
+	/**
+	* Returns parameters of this cron task as an array.
+	*
+	* The array must map string keys to string values.
+	*/
+	public function get_parameters();
+
+	/**
+	* Parses parameters found in $params, which is an array.
+	*
+	* $params contains user input and must not be trusted.
+	* In normal operation $params contains the same data that was returned by
+	* get_parameters method. However, a malicious user can supply arbitrary
+	* data in $params.
+	* Cron task must validate all keys and values in $params before using them.
+	*/
+	public function parse_parameters($params);
+}
+\ No newline at end of file
diff --git a/phpBB/includes/cron/task/task.php b/phpBB/includes/cron/task/task.php
new file mode 100644
index 0000000000..38fb2a6cd1
--- /dev/null
+++ b/phpBB/includes/cron/task/task.php
@@ -0,0 +1,48 @@
+<?php
+/**
+*
+* @package phpBB3
+* @version $Id$
+* @copyright (c) 2010 phpBB Group
+* @license http://opensource.org/licenses/gpl-license.php GNU Public License
+*
+*/
+
+/**
+* @ignore
+*/
+if (!defined('IN_PHPBB'))
+{
+	exit;
+}
+
+/**
+* Cron task interface
+* @package phpBB3
+*/
+interface phpbb_cron_task
+{
+	/**
+	* Runs this cron task.
+	*/
+	public function run();
+
+	/**
+	* Returns whether this cron task can run, given current board configuration.
+	*
+	* For example, a cron task that prunes forums can only run when
+	* forum pruning is enabled.
+	*/
+	public function is_runnable();
+
+	/**
+	* Returns whether this cron task should run now, because enough time
+	* has passed since it was last run.
+	*/
+	public function should_run();
+
+	/**
+	* Returns whether this cron task can be run in shutdown function.
+	*/
+	public function is_shutdown_function_safe();
+}
diff --git a/phpBB/includes/cron/task/wrapper.php b/phpBB/includes/cron/task/wrapper.php
new file mode 100644
index 0000000000..e31f467cc8
--- /dev/null
+++ b/phpBB/includes/cron/task/wrapper.php
@@ -0,0 +1,97 @@
+<?php
+/**
+*
+* @package phpBB3
+* @version $Id$
+* @copyright (c) 2010 phpBB Group
+* @license http://opensource.org/licenses/gpl-license.php GNU Public License
+*
+*/
+
+/**
+* @ignore
+*/
+if (!defined('IN_PHPBB'))
+{
+	exit;
+}
+
+/**
+* Cron task wrapper class.
+* Enhances cron tasks with convenience methods that work identically for all tasks.
+*
+* @package phpBB3
+*/
+class phpbb_cron_task_wrapper
+{
+	/**
+	* Wraps a task $task, which must implement cron_task interface.
+	*/
+	public function __construct(phpbb_cron_task $task)
+	{
+		$this->task = $task;
+	}
+
+	/**
+	* Returns whether this task is parametrized.
+	*
+	* Parametrized tasks accept parameters during initialization and must
+	* normally be scheduled with parameters.
+	*/
+	public function is_parametrized()
+	{
+		return $this->task instanceof phpbb_cron_task_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.
+	*/
+	public function is_ready()
+	{
+		return $this->task->is_runnable() && $this->task->should_run();
+	}
+
+	/**
+	* Returns the name of wrapped task. It is the same as the wrapped class's class name.
+	*/
+	public function get_name()
+	{
+		return get_class($this->task);
+	}
+
+	/**
+	* Returns a url through which this task may be invoked via web.
+	*/
+	public function get_url()
+	{
+		global $phpbb_root_path, $phpEx;
+
+		$name = $this->get_name();
+		if ($this->is_parametrized())
+		{
+			$params = $this->task->get_parameters();
+			$extra = '';
+			foreach ($params as $key => $value)
+			{
+				$extra .= '&amp;' . $key . '=' . urlencode($value);
+			}
+		}
+		else
+		{
+			$extra = '';
+		}
+		$url = append_sid($phpbb_root_path . 'cron.' . $phpEx, 'cron_type=' . $name . $extra);
+		return $url;
+	}
+
+	/**
+	* Forwards all other method calls to the wrapped task implementation.
+	*/
+	public function __call($name, $args)
+	{
+		return call_user_func_array(array($this->task, $name), $args);
+	}
+}