Completed
Pull Request — release-2.1 (#4446)
by Mathias
12:43
created

cron.php (10 issues)

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

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 http://www.simplemachines.org
17
 * @copyright 2018 Simple Machines and individual contributors
18
 * @license http://www.simplemachines.org/about/smf/license.php BSD
19
 *
20
 * @version 2.1 Beta 4
21
 */
22
23
define('SMF', 'BACKGROUND');
24
define('FROM_CLI', empty($_SERVER['REQUEST_METHOD']));
25
26
// This one setting is worth bearing in mind. If you are running this from proper cron, make sure you
27
// don't run this file any more frequently than indicated here. It might turn ugly if you do.
28
// But on proper cron you can always increase this value provided you don't go beyond max_limit.
29
define('MAX_CRON_TIME', 10);
30
// If a task fails for whatever reason it will still be marked as claimed. This is the threshold
31
// by which if a task has not completed in this time, the task should become available again.
32
define('MAX_CLAIM_THRESHOLD', 300);
33
34
// We're going to want a few globals... these are all set later.
35
global $time_start, $maintenance, $msubject, $mmessage, $mbname, $language;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

    public function myFunction() {
        // Do something
    }
}
Loading history...
36
global $boardurl, $boarddir, $sourcedir, $webmaster_email;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

    public function myFunction() {
        // Do something
    }
}
Loading history...
37
global $db_server, $db_name, $db_user, $db_prefix, $db_persist, $db_error_send, $db_last_error;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

    public function myFunction() {
        // Do something
    }
}
Loading history...
38
global $db_connection, $modSettings, $context, $sc, $user_info, $txt;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

    public function myFunction() {
        // Do something
    }
}
Loading history...
39
global $smcFunc, $ssi_db_user, $scripturl, $db_passwd, $cachedir;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

    public function myFunction() {
        // Do something
    }
}
Loading history...
40
41
define('TIME_START', microtime(true));
42
43
// Just being safe...
44 View Code Duplication
foreach (array('db_character_set', 'cachedir') as $variable)
45
	if (isset($GLOBALS[$variable]))
46
		unset($GLOBALS[$variable]);
47
48
// Get the forum's settings for database and file paths.
49
require_once(dirname(__FILE__) . '/Settings.php');
50
51
// Make absolutely sure the cache directory is defined.
52 View Code Duplication
if ((empty($cachedir) || !file_exists($cachedir)) && file_exists($boarddir . '/cache'))
53
	$cachedir = $boarddir . '/cache';
54
55
// Don't do john didley if the forum's been shut down competely.
56
if ($maintenance == 2)
57
	die($mmessage);
58
59
// Fix for using the current directory as a path.
60 View Code Duplication
if (substr($sourcedir, 0, 1) == '.' && substr($sourcedir, 1, 1) != '.')
61
	$sourcedir = dirname(__FILE__) . substr($sourcedir, 1);
62
63
// Have we already turned this off? If so, exist gracefully.
64
if (file_exists($cachedir . '/cron.lock'))
65
	obExit_cron();
66
67
// Before we go any further, if this is not a CLI request, we need to do some checking.
68
if (!FROM_CLI)
69
{
70
	// We will clean up $_GET shortly. But we want to this ASAP.
71
	$ts = isset($_GET['ts']) ? (int) $_GET['ts'] : 0;
72
	if ($ts <= 0 || $ts % 15 != 0 || time() - $ts < 0 || time() - $ts > 20)
73
		obExit_cron();
74
}
75
76
// Load the most important includes. In general, a background should be loading its own dependencies.
77
require_once($sourcedir . '/Errors.php');
78
require_once($sourcedir . '/Load.php');
79
require_once($sourcedir . '/Subs.php');
80
81
// Create a variable to store some SMF specific functions in.
82
$smcFunc = array();
83
84
// This is our general bootstrap, a la SSI.php but with a few differences.
85
unset ($db_show_debug);
86
loadDatabase();
87
reloadSettings();
88
89
// Just in case there's a problem...
90
set_error_handler('smf_error_handler_cron');
91
$sc = '';
92
$_SERVER['QUERY_STRING'] = '';
93
$_SERVER['REQUEST_URL'] = FROM_CLI ? 'CLI cron.php' : $boardurl . '/cron.php';
94
95
// Now 'clean the request' (or more accurately, ignore everything we're not going to use)
96
cleanRequest_cron();
97
98
// At this point we could reseed the RNG but I don't think we need to risk it being seeded *even more*.
99
// Meanwhile, time we got on with the real business here.
100
while ($task_details = fetch_task())
101
{
102
	$result = perform_task($task_details);
0 ignored issues
show
It seems like $task_details defined by fetch_task() on line 100 can also be of type boolean; however, perform_task() does only seem to accept array, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
103
	if ($result)
104
	{
105
		$smcFunc['db_query']('', '
106
			DELETE FROM {db_prefix}background_tasks
107
			WHERE id_task = {int:task}',
108
			array(
109
				'task' => $task_details['id_task'],
110
			)
111
		);
112
	}
113
}
114
obExit_cron();
115
exit;
116
117
/**
118
 * The heart of this cron handler...
119
 * @return bool|array False if there's nothing to do or an array of info about the task
120
 */
121
function fetch_task()
122
{
123
	global $smcFunc;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

    public function myFunction() {
        // Do something
    }
}
Loading history...
124
125
	// Check we haven't run over our time limit.
126
	if (microtime(true) - TIME_START > MAX_CRON_TIME)
127
		return false;
128
129
	// Try to find a task. Specifically, try to find one that hasn't been claimed previously, or failing that,
130
	// a task that was claimed but failed for whatever reason and failed long enough ago. We should not care
131
	// what task it is, merely that it is one in the queue, the order is irrelevant.
132
	$request = $smcFunc['db_query']('', '
133
		SELECT id_task, task_file, task_class, task_data, claimed_time
134
		FROM {db_prefix}background_tasks
135
		WHERE claimed_time < {int:claim_limit}
136
		LIMIT 1',
137
		array(
138
			'claim_limit' => time() - MAX_CLAIM_THRESHOLD,
139
		)
140
	);
141
	if ($row = $smcFunc['db_fetch_assoc']($request))
142
	{
143
		// We found one. Let's try and claim it immediately.
144
		$smcFunc['db_free_result']($request);
145
		$smcFunc['db_query']('', '
146
			UPDATE {db_prefix}background_tasks
147
			SET claimed_time = {int:new_claimed}
148
			WHERE id_task = {int:task}
149
				AND claimed_time = {int:old_claimed}',
150
			array(
151
				'new_claimed' => time(),
152
				'task' => $row['id_task'],
153
				'old_claimed' => $row['claimed_time'],
154
			)
155
		);
156
		// Could we claim it? If so, return it back.
157
		if ($smcFunc['db_affected_rows']() != 0)
158
		{
159
			// Update the time and go back.
160
			$row['claimed_time'] = time();
161
			return $row;
162
		}
163
		else
164
		{
165
			// Uh oh, we just missed it. Try to claim another one, and let it fall through if there aren't any.
166
			return fetch_task();
167
		}
168
	}
169
	else
170
	{
171
		// No dice. Clean up and go home.
172
		$smcFunc['db_free_result']($request);
173
		return false;
174
	}
175
}
176
177
/**
178
 * This actually handles the task
179
 * @param array $task_details An array of info about the task
180
 * @return bool|void True if the task is invalid; otherwise calls the function to execute the task
181
 */
182
function perform_task($task_details)
183
{
184
	global $smcFunc, $sourcedir, $boarddir;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

    public function myFunction() {
        // Do something
    }
}
Loading history...
185
186
	// This indicates the file to load.
187
	if (!empty($task_details['task_file']))
188
	{
189
		$include = strtr(trim($task_details['task_file']), array('$boarddir' => $boarddir, '$sourcedir' => $sourcedir));
190
		if (file_exists($include))
191
			require_once($include);
192
	}
193
194
	if (empty($task_details['task_class']))
195
	{
196
		// This would be nice to translate but the language files aren't loaded for any specific language.
197
		log_error('Invalid background task specified (no class, ' . (empty($task_details['task_file']) ? ' no file' : ' to load ' . $task_details['task_file']) . ')');
198
		return true; // So we clear it from the queue.
199
	}
200
201
	// All background tasks need to be classes.
202
	elseif (class_exists($task_details['task_class']) && is_subclass_of($task_details['task_class'], 'SMF_BackgroundTask'))
203
	{
204
		$details = empty($task_details['task_data']) ? array() : $smcFunc['json_decode']($task_details['task_data'], true);
205
		$bgtask = new $task_details['task_class']($details);
206
		return $bgtask->execute();
207
	}
208
	else
209
	{
210
		log_error('Invalid background task specified: (class: ' . $task_details['task_class'] . ', ' . (empty($task_details['task_file']) ? ' no file' : ' to load ' . $task_details['task_file']) . ')');
211
		return true; // So we clear it from the queue.
212
	}
213
}
214
215
// These are all our helper functions that resemble their big brother counterparts. These are not so important.
216
/**
217
 * Cleans up the request variables
218
 * @return void
219
 */
220
function cleanRequest_cron()
221
{
222
	global $scripturl, $boardurl;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

    public function myFunction() {
        // Do something
    }
}
Loading history...
223
224
	$scripturl = $boardurl . '/index.php';
225
226
	// These keys shouldn't be set...ever.
227
	if (isset($_REQUEST['GLOBALS']) || isset($_COOKIE['GLOBALS']))
228
		die('Invalid request variable.');
229
230
	// Save some memory.. (since we don't use these anyway.)
231
	unset($GLOBALS['HTTP_POST_VARS'], $GLOBALS['HTTP_POST_VARS']);
232
	unset($GLOBALS['HTTP_POST_FILES'], $GLOBALS['HTTP_POST_FILES']);
233
	unset($GLOBALS['_GET'], $GLOBALS['_POST'], $GLOBALS['_REQUEST'], $GLOBALS['_COOKIE'], $GLOBALS['_FILES']);
234
}
235
236
/**
237
 * The error handling function
238
 * @param int $error_level One of the PHP error level constants (see )
239
 * @param string $error_string The error message
240
 * @param string $file The file where the error occurred
241
 * @param int $line What line of the specified file the error occurred on
242
 * @return void
243
 */
244
function smf_error_handler_cron($error_level, $error_string, $file, $line)
245
{
246
	global $modSettings;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

    public function myFunction() {
        // Do something
    }
}
Loading history...
247
248
	// Ignore errors if we're ignoring them or they are strict notices from PHP 5
249
	if (error_reporting() == 0)
250
		return;
251
252
	$error_type = 'cron';
253
254
	log_error($error_level . ': ' . $error_string, $error_type, $file, $line);
255
256
	// If this is an E_ERROR or E_USER_ERROR.... die.  Violently so.
257
	if ($error_level % 255 == E_ERROR)
258
		die('No direct access...');
259
}
260
261
/**
262
 * The exit function
263
 */
264
function obExit_cron()
265
{
266
	if (FROM_CLI)
267
		die(0);
268
	else
269
	{
270
		header('Content-Type: image/gif');
271
		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");
272
	}
273
}
274
275
// We would like this to be defined, but we don't want to have to load more stuff than necessary.
276
// Thus we declare it here, and any legitimate background task must implement this.
277
/**
278
 * Class SMF_BackgroundTask
279
 */
280
abstract class SMF_BackgroundTask
281
{
282
283
	/**
284
	 * @var array Holds the details for the task
285
	 */
286
	protected $_details;
287
288
	/**
289
	 * The constructor.
290
	 * @param array $details The details for the task
291
	 */
292
	public function __construct($details)
293
	{
294
		$this->_details = $details;
295
	}
296
297
	/**
298
	 * The function to actually execute a task
299
	 * @return mixed
300
	 */
301
	abstract public function execute();
302
}
303
304
?>