1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
<?php
/**
*
* @package phpBB3
* @copyright (c) 2010 phpBB Group
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
*/
/**
* @ignore
*/
if (!defined('IN_PHPBB'))
{
exit;
}
/**
* Cron manager class.
*
* Finds installed cron tasks, stores task objects, provides task selection.
*
* @package phpBB3
*/
class phpbb_cron_manager
{
/**
* Set of phpbb_cron_task_wrapper objects.
* Array holding all tasks that have been found.
*
* @var array
*/
private $tasks = array();
/**
* Constructor. Loads all available tasks.
*
* @return void
*/
public function __construct()
{
$task_names = $this->find_cron_task_names();
$this->load_tasks($task_names);
}
/**
* Finds cron task names.
*
* A cron task file must follow the naming convention:
* includes/cron/task/$mod/$name.php.
* $mod is core for tasks that are part of phpbb.
* Modifications should use their name as $mod.
* $name is the name of the cron task.
* Cron task is expected to be a class named phpbb_cron_task_${mod}_${name}.
*
* Todo: consider caching found task file list in global cache.
*
* @return array Array of strings
*/
public function find_cron_task_names()
{
global $phpbb_root_path, $phpEx;
$tasks_root_path = $phpbb_root_path . 'includes/cron/task/';
$task_names = array();
$ext = '.' . $phpEx;
$ext_length = strlen($ext);
$dh = opendir($tasks_root_path);
while (($mod = readdir($dh)) !== false)
{
// ignore ., .. and dot directories
// todo: change is_dir to account for symlinks
if ($mod[0] == '.' || !is_dir($tasks_root_path . $mod))
{
continue;
}
$dh2 = opendir($tasks_root_path . $mod);
while (($file = readdir($dh2)) !== false)
{
$task_name = substr($file, 0, -$ext_length);
if (substr($file, -$ext_length) == $ext && $this->is_valid_name($mod) && $this->is_valid_name($task_name))
{
$full_task_name = $mod . '_' . $task_name;
$task_names[] = $full_task_name;
}
}
closedir($dh2);
}
closedir($dh);
return $task_names;
}
/**
* Checks whether $name is a valid identifier, and
* therefore part of valid cron task class name.
*
* @param string $name Name to check
*
* @return bool
*/
public function is_valid_name($name)
{
return (bool) preg_match('/^[a-zA-Z][a-zA-Z0-9_]*$/', $name);
}
/**
* Loads tasks given by name, wraps them
* and puts them into $this->tasks.
*
* @param array $task_names Array of strings
*
* @return void
*/
public function load_tasks($task_names)
{
foreach ($task_names as $task_name)
{
$class = "phpbb_cron_task_$task_name";
$task = new $class();
$wrapper = new phpbb_cron_task_wrapper($task);
$this->tasks[] = $wrapper;
}
}
/**
* Finds a task that is ready to run.
* If several tasks are ready, any one of them could be returned.
*
* @return phpbb_cron_task_wrapper|null
*/
public function find_one_ready_task()
{
foreach ($this->tasks as $task)
{
if ($task->is_ready())
{
return $task;
}
}
return null;
}
/**
* Finds all tasks that are ready to run.
*
* @return array Array of 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.
* Web runner uses this method to resolve names to tasks.
*
* @return array|null Array of phpbb_cron_task_wrapper
*/
public function find_task($name)
{
foreach ($this->tasks as $task)
{
if ($task->get_name() == $name)
{
return $task;
}
}
return null;
}
/**
* Creates an instance of parametrized cron task $name with args $args.
* The constructed task is wrapped with cron task wrapper before being returned.
*
* @param string $name The task name, which is the same as cron task class name.
* @param array $args Will be passed to the task class's constructor.
*
* @return phpbb_cron_task_wrapper|null
*/
public function instantiate_task($name, $args)
{
$task = $this->find_task($name);
if ($task)
{
// task here is actually an instance of cron task wrapper
$class = $task->get_name();
$task = new $class($args);
// need to wrap the new task too
$task = new phpbb_cron_task_wrapper($task);
}
return $task;
}
}
|
