diff options
| author | Oleg Pudeyev <oleg@bsdpower.com> | 2010-04-17 06:32:15 -0400 |
|---|---|---|
| committer | Oleg Pudeyev <oleg@bsdpower.com> | 2011-02-12 22:05:49 -0500 |
| commit | 0cfbdcc7449f1cc17b819ffe49aec88c274dd090 (patch) | |
| tree | f154c14e3b56a96e20427676c3ae40cf656be11a /phpBB/includes/cron | |
| parent | 0f9b3bcc27e7daf7d605a7a38310a8f62b9a76e8 (diff) | |
| download | forums-0cfbdcc7449f1cc17b819ffe49aec88c274dd090.tar forums-0cfbdcc7449f1cc17b819ffe49aec88c274dd090.tar.gz forums-0cfbdcc7449f1cc17b819ffe49aec88c274dd090.tar.bz2 forums-0cfbdcc7449f1cc17b819ffe49aec88c274dd090.tar.xz forums-0cfbdcc7449f1cc17b819ffe49aec88c274dd090.zip | |
[feature/system-cron] Reorganized cron task parametrization.
PHPBB3-9596
Diffstat (limited to 'phpBB/includes/cron')
| -rw-r--r-- | phpBB/includes/cron/cron_task.php | 26 | ||||
| -rw-r--r-- | phpBB/includes/cron/cron_task_wrapper.php | 32 | ||||
| -rw-r--r-- | phpBB/includes/cron/tasks/core/prune_forum.php | 59 |
3 files changed, 93 insertions, 24 deletions
diff --git a/phpBB/includes/cron/cron_task.php b/phpBB/includes/cron/cron_task.php index 8b9ffacae6..46eacff517 100644 --- a/phpBB/includes/cron/cron_task.php +++ b/phpBB/includes/cron/cron_task.php @@ -48,13 +48,33 @@ interface cron_task } /** -* Parametrized cron task interface +* 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 parametrized_cron_task extends cron_task { /** - * Returns parameters of this cron task as a query string. + * 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 get_url_query_string(); + public function parse_parameters($params); } diff --git a/phpBB/includes/cron/cron_task_wrapper.php b/phpBB/includes/cron/cron_task_wrapper.php index 3919e4f049..0e63000846 100644 --- a/phpBB/includes/cron/cron_task_wrapper.php +++ b/phpBB/includes/cron/cron_task_wrapper.php @@ -24,12 +24,26 @@ if (!defined('IN_PHPBB')) */ class cron_task_wrapper { + /** + * Wraps a task $task, which must implement cron_task interface. + */ public function __construct($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 parametrized_cron_task; + } + + /** * Returns whether the wrapped task is ready to run. * * A task is ready to run when it is runnable according to current configuration @@ -49,12 +63,28 @@ class cron_task_wrapper return preg_replace('/^cron_task_/', '', $class); } + /** + * 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(); - $url = append_sid($phpbb_root_path . 'cron.' . $phpEx, 'cron_type=' . $name); + if ($this->is_parametrized()) + { + $params = $this->task->get_parameters(); + $extra = ''; + foreach ($params as $key => $value) + { + $extra .= '&' . $key . '=' . urlencode($value); + } + } + else + { + $extra = ''; + } + $url = append_sid($phpbb_root_path . 'cron.' . $phpEx, 'cron_type=' . $name . $extra); return $url; } diff --git a/phpBB/includes/cron/tasks/core/prune_forum.php b/phpBB/includes/cron/tasks/core/prune_forum.php index 4925447162..f9fea7a5b8 100644 --- a/phpBB/includes/cron/tasks/core/prune_forum.php +++ b/phpBB/includes/cron/tasks/core/prune_forum.php @@ -27,6 +27,8 @@ if (!defined('IN_PHPBB')) */ class cron_task_core_prune_forum extends cron_task_base implements parametrized_cron_task { + private $forum_data; + /** * Constructor. * @@ -46,22 +48,7 @@ class cron_task_core_prune_forum extends cron_task_base implements parametrized_ } else { - $forum_id = request_var('f', 0); - - $sql = 'SELECT forum_id, prune_next, enable_prune, prune_days, prune_viewed, forum_flags, prune_freq - FROM ' . FORUMS_TABLE . " - WHERE forum_id = $forum_id"; - $result = $db->sql_query($sql); - $row = $db->sql_fetchrow($result); - $db->sql_freeresult($result); - - if (!$row) - { - // FIXME what to do? - break; - } - - $this->forum_data = $row; + $this->forum_data = null; } } @@ -90,7 +77,7 @@ class cron_task_core_prune_forum extends cron_task_base implements parametrized_ public function is_runnable() { global $config; - return !$config['use_system_cron']; + return !$config['use_system_cron'] && $this->forum_data; } /** @@ -103,10 +90,42 @@ class cron_task_core_prune_forum extends cron_task_base implements parametrized_ } /** - * Returns parameters of this cron task as a query string. + * Returns parameters of this cron task as an array. + * + * The array has one key, f, whose value is id of the forum to be pruned. + */ + public function get_parameters() + { + return array('f' => $this->forum_data['forum_id']); + } + + /** + * Parses parameters found in $params, which is an array. + * + * $params may contain user input and is not trusted. + * + * $params is expected to have a key f whose value is id of the forum to be pruned. */ - public function get_url_query_string() + public function parse_parameters($params) { - return 'f=' . $this->forum_data['forum_id']; + global $db; + + $this->forum_data = null; + if (isset($params['f'])) + { + $forum_id = int($params['f']); + + $sql = 'SELECT forum_id, prune_next, enable_prune, prune_days, prune_viewed, forum_flags, prune_freq + FROM ' . FORUMS_TABLE . " + WHERE forum_id = $forum_id"; + $result = $db->sql_query($sql); + $row = $db->sql_fetchrow($result); + $db->sql_freeresult($result); + + if ($row) + { + $this->forum_data = $row; + } + } } } |