Passed
Push — release-2.1 ( 7401ba...5d05c6 )
by Mathias
08:16 queued 14s
created

obExit_cron()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 8
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 2
eloc 5
c 0
b 0
f 0
nop 0
dl 0
loc 8
rs 10
nc 2
1
<?php
2
3
/**
4
 * This is a slightly strange file. It is not designed to ever be run directly from within SMF's
5
 * conventional running, but called externally to facilitate background tasks. It can be called
6
 * either directly or via cron, and in either case will completely ignore anything supplied
7
 * via command line, or $_GET, $_POST, $_COOKIE etc. because those things should never affect the
8
 * running of this script.
9
 *
10
 * Because of the way this runs, etc. we do need some of SMF but not everything to try to keep this
11
 * running a little bit faster.
12
 *
13
 * Simple Machines Forum (SMF)
14
 *
15
 * @package SMF
16
 * @author Simple Machines https://www.simplemachines.org
17
 * @copyright 2023 Simple Machines and individual contributors
18
 * @license https://www.simplemachines.org/about/smf/license.php BSD
19
 *
20
 * @version 2.1.4
21
 */
22
23
define('SMF', 'BACKGROUND');
24
define('SMF_VERSION', '2.1.4');
25
define('SMF_FULL_VERSION', 'SMF ' . SMF_VERSION);
26
define('SMF_SOFTWARE_YEAR', '2023');
27
define('FROM_CLI', empty($_SERVER['REQUEST_METHOD']));
28
29
define('JQUERY_VERSION', '3.6.3');
30
define('POSTGRE_TITLE', 'PostgreSQL');
31
define('MYSQL_TITLE', 'MySQL');
32
define('SMF_USER_AGENT', 'Mozilla/5.0 (' . php_uname('s') . ' ' . php_uname('m') . ') AppleWebKit/605.1.15 (KHTML, like Gecko)  SMF/' . strtr(SMF_VERSION, ' ', '.'));
33
34
// This one setting is worth bearing in mind. If you are running this from proper cron, make sure you
35
// don't run this file any more frequently than indicated here. It might turn ugly if you do.
36
// But on proper cron you can always increase this value provided you don't go beyond max_limit.
37
define('MAX_CRON_TIME', 10);
38
// If a task fails for whatever reason it will still be marked as claimed. This is the threshold
39
// by which if a task has not completed in this time, the task should become available again.
40
define('MAX_CLAIM_THRESHOLD', 300);
41
42
// We're going to want a few globals... these are all set later.
43
global $maintenance, $msubject, $mmessage, $mbname, $language;
44
global $boardurl, $boarddir, $sourcedir, $webmaster_email;
45
global $db_server, $db_name, $db_user, $db_prefix, $db_persist, $db_error_send, $db_last_error;
46
global $db_connection, $modSettings, $context, $sc, $user_info, $txt;
47
global $smcFunc, $ssi_db_user, $scripturl, $db_passwd, $cachedir;
48
49
if (!defined('TIME_START'))
50
	define('TIME_START', microtime(true));
51
52
// Just being safe...
53
foreach (array('db_character_set', 'cachedir') as $variable)
54
	if (isset($GLOBALS[$variable]))
55
		unset($GLOBALS[$variable]);
56
57
// Get the forum's settings for database and file paths.
58
require_once(dirname(__FILE__) . '/Settings.php');
59
60
// Make absolutely sure the cache directory is defined and writable.
61
if (empty($cachedir) || !is_dir($cachedir) || !is_writable($cachedir))
62
{
63
	if (is_dir($boarddir . '/cache') && is_writable($boarddir . '/cache'))
64
		$cachedir = $boarddir . '/cache';
65
	else
66
	{
67
		$cachedir = sys_get_temp_dir() . '/smf_cache_' . md5($boarddir);
68
		@mkdir($cachedir, 0750);
69
	}
70
}
71
72
// Don't do john didley if the forum's been shut down completely.
73
if ($maintenance == 2)
74
	die($mmessage);
75
76
// Fix for using the current directory as a path.
77
if (substr($sourcedir, 0, 1) == '.' && substr($sourcedir, 1, 1) != '.')
78
	$sourcedir = dirname(__FILE__) . substr($sourcedir, 1);
79
80
// Have we already turned this off? If so, exist gracefully.
81
if (file_exists($cachedir . '/cron.lock'))
82
	obExit_cron();
83
84
// Before we go any further, if this is not a CLI request, we need to do some checking.
85
if (!FROM_CLI)
86
{
87
	// When using sub-domains with SSI and ssi_themes set, browsers will receive a "Access-Control-Allow-Origin" error.
88
	// * is not ideal but the best method to preventing this from occurring.
89
	header('Access-Control-Allow-Origin: *');
90
91
	// We will clean up $_GET shortly. But we want to this ASAP.
92
	$ts = isset($_GET['ts']) ? (int) $_GET['ts'] : 0;
93
	if ($ts <= 0 || $ts % 15 != 0 || time() - $ts < 0 || time() - $ts > 20)
94
		obExit_cron();
95
}
96
97
else
98
	$_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
99
100
// Load the most important includes. In general, a background should be loading its own dependencies.
101
require_once($sourcedir . '/Errors.php');
102
require_once($sourcedir . '/Load.php');
103
require_once($sourcedir . '/Security.php');
104
require_once($sourcedir . '/Subs.php');
105
106
// Ensure we don't trip over disabled internal functions
107
if (version_compare(PHP_VERSION, '8.0.0', '>='))
108
	require_once($sourcedir . '/Subs-Compat.php');
109
110
// Create a variable to store some SMF specific functions in.
111
$smcFunc = array();
112
113
// This is our general bootstrap, a la SSI.php but with a few differences.
114
unset ($db_show_debug);
115
loadDatabase();
116
reloadSettings();
117
118
// Just in case there's a problem...
119
set_error_handler('smf_error_handler_cron');
120
$sc = '';
121
$_SERVER['QUERY_STRING'] = '';
122
$_SERVER['REQUEST_URL'] = FROM_CLI ? 'CLI cron.php' : $boardurl . '/cron.php';
123
124
// Now 'clean the request' (or more accurately, ignore everything we're not going to use)
125
cleanRequest_cron();
126
127
// At this point we could reseed the RNG but I don't think we need to risk it being seeded *even more*.
128
// Meanwhile, time we got on with the real business here.
129
while ($task_details = fetch_task())
130
{
131
	$result = perform_task($task_details);
132
	if ($result)
133
	{
134
		$smcFunc['db_query']('', '
135
			DELETE FROM {db_prefix}background_tasks
136
			WHERE id_task = {int:task}',
137
			array(
138
				'task' => $task_details['id_task'],
139
			)
140
		);
141
	}
142
}
143
144
// If we have time, check the scheduled tasks.
145
if (time() - TIME_START < ceil(MAX_CRON_TIME / 2))
146
{
147
	require_once($sourcedir . '/ScheduledTasks.php');
148
149
	if (empty($modSettings['next_task_time']) || $modSettings['next_task_time'] < time())
150
		AutoTask();
151
	elseif (!empty($modSettings['mail_next_send']) && $modSettings['mail_next_send'] < time())
152
		ReduceMailQueue();
153
}
154
155
obExit_cron();
156
exit;
157
158
/**
159
 * The heart of this cron handler...
160
 *
161
 * @return bool|array False if there's nothing to do or an array of info about the task
162
 */
163
function fetch_task()
164
{
165
	global $smcFunc;
166
167
	// Check we haven't run over our time limit.
168
	if (microtime(true) - TIME_START > MAX_CRON_TIME)
169
		return false;
170
171
	// Try to find a task. Specifically, try to find one that hasn't been claimed previously, or failing that,
172
	// a task that was claimed but failed for whatever reason and failed long enough ago. We should not care
173
	// what task it is, merely that it is one in the queue, the order is irrelevant.
174
	$request = $smcFunc['db_query']('', '
175
		SELECT id_task, task_file, task_class, task_data, claimed_time
176
		FROM {db_prefix}background_tasks
177
		WHERE claimed_time < {int:claim_limit}
178
		LIMIT 1',
179
		array(
180
			'claim_limit' => time() - MAX_CLAIM_THRESHOLD,
181
		)
182
	);
183
	if ($row = $smcFunc['db_fetch_assoc']($request))
184
	{
185
		// We found one. Let's try and claim it immediately.
186
		$smcFunc['db_free_result']($request);
187
		$smcFunc['db_query']('', '
188
			UPDATE {db_prefix}background_tasks
189
			SET claimed_time = {int:new_claimed}
190
			WHERE id_task = {int:task}
191
				AND claimed_time = {int:old_claimed}',
192
			array(
193
				'new_claimed' => time(),
194
				'task' => $row['id_task'],
195
				'old_claimed' => $row['claimed_time'],
196
			)
197
		);
198
		// Could we claim it? If so, return it back.
199
		if ($smcFunc['db_affected_rows']() != 0)
200
		{
201
			// Update the time and go back.
202
			$row['claimed_time'] = time();
203
			return $row;
204
		}
205
		else
206
		{
207
			// Uh oh, we just missed it. Try to claim another one, and let it fall through if there aren't any.
208
			return fetch_task();
209
		}
210
	}
211
	else
212
	{
213
		// No dice. Clean up and go home.
214
		$smcFunc['db_free_result']($request);
215
		return false;
216
	}
217
}
218
219
/**
220
 * This actually handles the task
221
 *
222
 * @param array $task_details An array of info about the task
223
 * @return bool|void True if the task is invalid; otherwise calls the function to execute the task
224
 */
225
function perform_task($task_details)
226
{
227
	global $smcFunc, $sourcedir, $boarddir;
228
229
	// This indicates the file to load.
230
	if (!empty($task_details['task_file']))
231
	{
232
		$include = strtr(trim($task_details['task_file']), array('$boarddir' => $boarddir, '$sourcedir' => $sourcedir));
233
		if (file_exists($include))
234
			require_once($include);
235
	}
236
237
	if (empty($task_details['task_class']))
238
	{
239
		// This would be nice to translate but the language files aren't loaded for any specific language.
240
		log_error('Invalid background task specified (no class, ' . (empty($task_details['task_file']) ? ' no file' : ' to load ' . $task_details['task_file']) . ')');
241
		return true; // So we clear it from the queue.
242
	}
243
244
	// All background tasks need to be classes.
245
	elseif (class_exists($task_details['task_class']) && is_subclass_of($task_details['task_class'], 'SMF_BackgroundTask'))
246
	{
247
		$details = empty($task_details['task_data']) ? array() : $smcFunc['json_decode']($task_details['task_data'], true);
248
		$bgtask = new $task_details['task_class']($details);
249
		return $bgtask->execute();
250
	}
251
	else
252
	{
253
		log_error('Invalid background task specified: (class: ' . $task_details['task_class'] . ', ' . (empty($task_details['task_file']) ? ' no file' : ' to load ' . $task_details['task_file']) . ')');
254
		return true; // So we clear it from the queue.
255
	}
256
}
257
258
// These are all our helper functions that resemble their big brother counterparts. These are not so important.
259
/**
260
 * Cleans up the request variables
261
 *
262
 * @return void
263
 */
264
function cleanRequest_cron()
265
{
266
	global $scripturl, $boardurl;
267
268
	$scripturl = $boardurl . '/index.php';
269
270
	// These keys shouldn't be set...ever.
271
	if (isset($_REQUEST['GLOBALS']) || isset($_COOKIE['GLOBALS']))
272
		die('Invalid request variable.');
0 ignored issues
show
Best Practice introduced by
Using exit here is not recommended.

In general, usage of exit should be done with care and only when running in a scripting context like a CLI script.

Loading history...
273
274
	// Save some memory.. (since we don't use these anyway.)
275
	unset($GLOBALS['HTTP_POST_VARS'], $GLOBALS['HTTP_POST_VARS']);
276
	unset($GLOBALS['HTTP_POST_FILES'], $GLOBALS['HTTP_POST_FILES']);
277
	unset($GLOBALS['_GET'], $GLOBALS['_POST'], $GLOBALS['_REQUEST'], $GLOBALS['_COOKIE'], $GLOBALS['_FILES']);
278
}
279
280
/**
281
 * The error handling function
282
 *
283
 * @param int $error_level One of the PHP error level constants (see )
284
 * @param string $error_string The error message
285
 * @param string $file The file where the error occurred
286
 * @param int $line What line of the specified file the error occurred on
287
 * @return void
288
 */
289
function smf_error_handler_cron($error_level, $error_string, $file, $line)
290
{
291
	global $modSettings;
292
293
	// Ignore errors that should not be logged.
294
	if (error_reporting() == 0)
295
		return;
296
297
	$error_type = 'cron';
298
299
	log_error($error_level . ': ' . $error_string, $error_type, $file, $line);
300
301
	// If this is an E_ERROR or E_USER_ERROR.... die.  Violently so.
302
	if ($error_level % 255 == E_ERROR)
303
		die('No direct access...');
0 ignored issues
show
Best Practice introduced by
Using exit here is not recommended.

In general, usage of exit should be done with care and only when running in a scripting context like a CLI script.

Loading history...
304
}
305
306
/**
307
 * The exit function
308
 */
309
function obExit_cron()
310
{
311
	if (FROM_CLI)
312
		die(0);
0 ignored issues
show
Best Practice introduced by
Using exit here is not recommended.

In general, usage of exit should be done with care and only when running in a scripting context like a CLI script.

Loading history...
313
	else
314
	{
315
		header('content-type: image/gif');
316
		die("\x47\x49\x46\x38\x39\x61\x01\x00\x01\x00\x80\x00\x00\x00\x00\x00\x00\x00\x00\x21\xF9\x04\x01\x00\x00\x00\x00\x2C\x00\x00\x00\x00\x01\x00\x01\x00\x00\x02\x02\x44\x01\x00\x3B");
317
	}
318
}
319
320
// We would like this to be defined, but we don't want to have to load more stuff than necessary.
321
// Thus we declare it here, and any legitimate background task must implement this.
322
/**
323
 * Class SMF_BackgroundTask
324
 */
325
abstract class SMF_BackgroundTask
326
{
327
	/**
328
	 * Constants for notification types.
329
	*/
330
	const RECEIVE_NOTIFY_EMAIL = 0x02;
331
	const RECEIVE_NOTIFY_ALERT = 0x01;
332
333
	/**
334
	 * @var array Holds the details for the task
335
	 */
336
	protected $_details;
337
338
	/**
339
	 * @var array Temp property to hold the current user info while tasks make use of $user_info
340
	 */
341
	private $current_user_info = array();
342
343
	/**
344
	 * The constructor.
345
	 *
346
	 * @param array $details The details for the task
347
	 */
348
	public function __construct($details)
349
	{
350
		global $user_info;
351
352
		$this->_details = $details;
353
354
		$this->current_user_info = $user_info;
355
	}
356
357
	/**
358
	 * The function to actually execute a task
359
	 *
360
	 * @return mixed
361
	 */
362
	abstract public function execute();
363
364
	/**
365
	 * Loads minimal info for the previously loaded user ids
366
	 *
367
	 * @param array $user_ids
368
	 * @return array
369
	 * @throws Exception
370
	 */
371
	public function getMinUserInfo($user_ids = array())
372
	{
373
		return loadMinUserInfo($user_ids);
374
	}
375
376
	public function __destruct()
377
	{
378
		global $user_info;
379
380
		$user_info = $this->current_user_info;
381
	}
382
}
383
384
?>