-
-
Notifications
You must be signed in to change notification settings - Fork 407
/
functions_task.php
385 lines (357 loc) · 9.01 KB
/
functions_task.php
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
<?php
/**
* MyBB 1.8
* Copyright 2014 MyBB Group, All Rights Reserved
*
* Website: http://www.mybb.com
* License: http://www.mybb.com/about/license
*
*/
/**
* Execute a scheduled task.
*
* @param int $tid The task ID. If none specified, the next task due to be ran is executed
* @return boolean True if successful, false on failure
*/
function run_task($tid=0)
{
global $db, $mybb, $cache, $plugins, $task, $lang;
// Run a specific task
if($tid > 0)
{
$query = $db->simple_select("tasks", "*", "tid='{$tid}'");
$task = $db->fetch_array($query);
}
// Run the next task due to be run
else
{
$query = $db->simple_select("tasks", "*", "enabled=1 AND nextrun<='".TIME_NOW."'", array("order_by" => "nextrun", "order_dir" => "asc", "limit" => 1));
$task = $db->fetch_array($query);
}
// No task? Return
if(!$task)
{
$cache->update_tasks();
return false;
}
// Is this task still running and locked less than 5 minutes ago? Well don't run it now - clearly it isn't broken!
if($task['locked'] != 0 && $task['locked'] > TIME_NOW-300)
{
$cache->update_tasks();
return false;
}
// Lock it! It' mine, all mine!
else
{
$db->update_query("tasks", array("locked" => TIME_NOW), "tid='{$task['tid']}'");
}
$file = basename($task['file'], '.php');
// The task file does not exist
if(!file_exists(MYBB_ROOT."inc/tasks/{$file}.php"))
{
if($task['logging'] == 1)
{
add_task_log($task, $lang->missing_task);
}
// If task file does not exist, disable task and inform the administrator
$updated_task = array(
"enabled" => 0,
"locked" => 0
);
$db->update_query("tasks", $updated_task, "tid='{$task['tid']}'");
$subject = $lang->sprintf($lang->email_broken_task_subject, $mybb->settings['bbname']);
$message = $lang->sprintf($lang->email_broken_task, $mybb->settings['bbname'], $mybb->settings['bburl'], $task['title']);
my_mail($mybb->settings['adminemail'], $subject, $message, $mybb->settings['adminemail']);
$cache->update_tasks();
return false;
}
// Run the task
else
{
// Update the nextrun time now, so if the task causes a fatal error, it doesn't get stuck first in the queue
$nextrun = fetch_next_run($task);
$db->update_query("tasks", array("nextrun" => $nextrun), "tid='{$task['tid']}'");
include_once MYBB_ROOT."inc/tasks/{$file}.php";
$function = "task_{$task['file']}";
if(function_exists($function))
{
$function($task);
}
}
$updated_task = array(
"lastrun" => TIME_NOW,
"locked" => 0
);
$db->update_query("tasks", $updated_task, "tid='{$task['tid']}'");
$cache->update_tasks();
return true;
}
/**
* Adds information to the scheduled task log.
*
* @param int $task The task array to create the log entry for
* @param string $message The message to log
*/
function add_task_log($task, $message)
{
global $db;
if(!$task['logging'])
{
return;
}
$log_entry = array(
"tid" => (int)$task['tid'],
"dateline" => TIME_NOW,
"data" => $db->escape_string($message)
);
$db->insert_query("tasklog", $log_entry);
}
/**
* Generate the next run time for a particular task.
*
* @param array $task The task array as fetched from the database.
* @return int The next run time as a UNIX timestamp
*/
function fetch_next_run($task)
{
$time = TIME_NOW;
$next_minute = $current_minute = date("i", $time);
$next_hour = $current_hour = date("H", $time);
$next_day = $current_day = date("d", $time);
$next_weekday = $current_weekday = date("w", $time);
$next_month = $current_month = date("m", $time);
$next_year = $current_year = date("Y", $time);
$reset_day = $reset_hour = $reset_month = $reset_year = 0;
if($task['minute'] == "*")
{
++$next_minute;
if($next_minute > 59)
{
$reset_hour = 1;
$next_minute = 0;
}
}
else
{
if(build_next_run_bit($task['minute'], $current_minute) != false)
{
$next_minute = build_next_run_bit($task['minute'], $current_minute);
}
else
{
$next_minute = fetch_first_run_time($task['minute']);
}
if($next_minute <= $current_minute)
{
$reset_hour = 1;
}
}
if($reset_hour || !run_time_exists($task['hour'], $current_hour))
{
if($task['hour'] == "*")
{
++$next_hour;
if($next_hour > 23)
{
$reset_day = 1;
$next_hour = 0;
}
}
else
{
if(build_next_run_bit($task['hour'], $current_hour) != false)
{
$next_hour = build_next_run_bit($task['hour'], $current_hour);
}
else
{
$next_hour = fetch_first_run_time($task['hour']);
$reset_day = 1;
}
if($next_hour < $current_hour)
{
$reset_day = 1;
}
}
$next_minute = fetch_first_run_time($task['minute']);
}
if($reset_day || ($task['weekday'] == "*" && !run_time_exists($task['day'], $current_day) || $task['day'] == "*" && !run_time_exists($task['weekday'], $current_weekday)))
{
if($task['weekday'] == "*")
{
if($task['day'] == "*")
{
++$next_day;
if($next_day > date("t", $time))
{
$reset_month = 1;
$next_day = 1;
}
}
else
{
if(build_next_run_bit($task['day'], $current_day) != false)
{
$next_day = build_next_run_bit($task['day'], $current_day);
}
else
{
$next_day = fetch_first_run_time($task['day']);
$reset_month = 1;
}
if($next_day < $current_day)
{
$reset_month = 1;
}
}
}
else
{
if(build_next_run_bit($task['weekday'], $current_weekday) != false)
{
$next_weekday = build_next_run_bit($task['weekday'], $current_weekday);
}
else
{
$next_weekday = fetch_first_run_time($task['weekday']);
}
$next_day = $current_day + ($next_weekday-$current_weekday);
if($next_day <= $current_day)
{
$next_day += 7;
}
if($next_day > date("t", $time))
{
$reset_month = 1;
}
}
$next_minute = fetch_first_run_time($task['minute']);
$next_hour = fetch_first_run_time($task['hour']);
if($next_day == $current_day && $next_hour < $current_hour)
{
$reset_month = 1;
}
}
if($reset_month || !run_time_exists($task['month'], $current_month))
{
if($task['month'] == "*")
{
$next_month++;
if($next_month > 12)
{
$reset_year = 1;
$next_month = 1;
}
}
else
{
if(build_next_run_bit($task['month'], $current_month) != false)
{
$next_month = build_next_run_bit($task['month'], $current_month);
}
else
{
$next_month = fetch_first_run_time($task['month']);
$reset_year = 1;
}
if($next_month < $current_month)
{
$reset_year = 1;
}
}
$next_minute = fetch_first_run_time($task['minute']);
$next_hour = fetch_first_run_time($task['hour']);
if($task['weekday'] == "*")
{
$next_day = fetch_first_run_time($task['day']);
if($next_day == 0) $next_day = 1;
}
else
{
$next_weekday = fetch_first_run_time($task['weekday']);
$new_weekday = date("w", mktime($next_hour, $next_minute, 0, $next_month, 1, $next_year));
$next_day = 1 + ($next_weekday-$new_weekday);
if($next_weekday < $new_weekday)
{
$next_day += 7;
}
}
if($next_month == $current_month && $next_day == $current_day && $next_hour < $current_hour)
{
$reset_year = 1;
}
}
if($reset_year)
{
$next_year++;
$next_minute = fetch_first_run_time($task['minute']);
$next_hour = fetch_first_run_time($task['hour']);
$next_month = fetch_first_run_time($task['month']);
if($next_month == 0) $next_month = 1;
if($task['weekday'] == "*")
{
$next_day = fetch_first_run_time($task['day']);
if($next_day == 0) $next_day = 1;
}
else
{
$next_weekday = fetch_first_run_time($task['weekday']);
$new_weekday = date("w", mktime($next_hour, $next_minute, 0, $next_month, 1, $next_year));
$next_day = 1 + ($next_weekday-$new_weekday);
if($next_weekday < $new_weekday)
{
$next_day += 7;
}
}
}
return mktime($next_hour, $next_minute, 0, $next_month, $next_day, $next_year);
}
/**
* Builds the next run time bit for a particular item (day, hour, month etc). Used by fetch_next_run().
*
* @param string $data A string containing the run times for this particular item
* @param int $bit The current value (be it current day etc)
* @return int|bool The new or found value or boolean if nothing is found
*/
function build_next_run_bit($data, $bit)
{
if($data == "*") return $bit;
$data = explode(",", $data);
foreach($data as $thing)
{
if($thing > $bit)
{
return $thing;
}
}
return false;
}
/**
* Fetches the fist run bit for a particular item (day, hour, month etc). Used by fetch_next_run().
*
* @param string $data A string containing the run times for this particular item
* @return int The first run time
*/
function fetch_first_run_time($data)
{
if($data == "*") return "0";
$data = explode(",", $data);
return $data[0];
}
/**
* Checks if a specific run time exists for a particular item (day, hour, month etc). Used by fetch_next_run().
*
* @param string $data A string containing the run times for this particular item
* @param int $bit The bit we're checking for
* @return boolean True if it exists, false if it does not
*/
function run_time_exists($data, $bit)
{
if($data == "*") return true;
$data = explode(",", $data);
if(in_array($bit, $data))
{
return true;
}
return false;
}