Issues (1061)

Sources/Subs-Db-mysql.php (2 issues)

1
<?php
2
3
/**
4
 * This file has all the main functions in it that relate to the database.
5
 *
6
 * Simple Machines Forum (SMF)
7
 *
8
 * @package SMF
9
 * @author Simple Machines https://www.simplemachines.org
10
 * @copyright 2020 Simple Machines and individual contributors
11
 * @license https://www.simplemachines.org/about/smf/license.php BSD
12
 *
13
 * @version 2.1 RC2
14
 */
15
16
if (!defined('SMF'))
17
	die('No direct access...');
18
19
/**
20
 *  Maps the implementations in this file (smf_db_function_name)
21
 *  to the $smcFunc['db_function_name'] variable.
22
 *
23
 * @param string $db_server The database server
24
 * @param string $db_name The name of the database
25
 * @param string $db_user The database username
26
 * @param string $db_passwd The database password
27
 * @param string $db_prefix The table prefix
28
 * @param array $db_options An array of database options
29
 * @return null|resource Returns null on failure if $db_options['non_fatal'] is true or a MySQL connection resource handle if the connection was successful.
30
 */
31
function smf_db_initiate($db_server, $db_name, $db_user, $db_passwd, $db_prefix, $db_options = array())
32
{
33
	global $smcFunc;
34
35
	// Map some database specific functions, only do this once.
36
	if (!isset($smcFunc['db_fetch_assoc']))
37
		$smcFunc += array(
38
			'db_query'                  => 'smf_db_query',
39
			'db_quote'                  => 'smf_db_quote',
40
			'db_fetch_assoc'            => 'mysqli_fetch_assoc',
41
			'db_fetch_row'              => 'mysqli_fetch_row',
42
			'db_free_result'            => 'mysqli_free_result',
43
			'db_insert'                 => 'smf_db_insert',
44
			'db_insert_id'              => 'smf_db_insert_id',
45
			'db_num_rows'               => 'mysqli_num_rows',
46
			'db_data_seek'              => 'mysqli_data_seek',
47
			'db_num_fields'             => 'mysqli_num_fields',
48
			'db_escape_string'          => 'smf_db_escape_string',
49
			'db_unescape_string'        => 'stripslashes',
50
			'db_server_info'            => 'smf_db_get_server_info',
51
			'db_affected_rows'          => 'smf_db_affected_rows',
52
			'db_transaction'            => 'smf_db_transaction',
53
			'db_error'                  => 'mysqli_error',
54
			'db_select_db'              => 'smf_db_select',
55
			'db_title'                  => MYSQL_TITLE,
56
			'db_sybase'                 => false,
57
			'db_case_sensitive'         => false,
58
			'db_escape_wildcard_string' => 'smf_db_escape_wildcard_string',
59
			'db_is_resource'            => 'smf_is_resource',
60
			'db_mb4'                    => false,
61
			'db_ping'                   => 'mysqli_ping',
62
			'db_fetch_all'              => 'smf_db_fetch_all',
63
			'db_error_insert'			=> 'smf_db_error_insert',
64
			'db_custom_order'			=> 'smf_db_custom_order',
65
			'db_native_replace'			=> 'smf_db_native_replace',
66
			'db_cte_support'			=> 'smf_db_cte_support',
67
		);
68
69
	if (!empty($db_options['persist']))
70
		$db_server = 'p:' . $db_server;
71
72
	// We are not going to make it very far without these.
73
	if (!function_exists('mysqli_init') || !function_exists('mysqli_real_connect'))
74
		display_db_error();
75
76
	$connection = mysqli_init();
77
78
	$flags = 2; // MYSQLI_CLIENT_FOUND_ROWS = 2
79
80
	$success = false;
81
82
	if ($connection)
83
	{
84
		if (!empty($db_options['port']))
85
			$success = @mysqli_real_connect($connection, $db_server, $db_user, $db_passwd, null, $db_options['port'], null, $flags);
86
		else
87
			$success = @mysqli_real_connect($connection, $db_server, $db_user, $db_passwd, null, 0, null, $flags);
88
	}
89
90
	// Something's wrong, show an error if its fatal (which we assume it is)
91
	if ($success === false)
92
	{
93
		if (!empty($db_options['non_fatal']))
94
			return null;
95
		else
96
			display_db_error();
97
	}
98
99
	// Select the database, unless told not to
100
	if (empty($db_options['dont_select_db']) && !@mysqli_select_db($connection, $db_name) && empty($db_options['non_fatal']))
101
		display_db_error();
102
103
	mysqli_query($connection, 'SET SESSION sql_mode = \'ONLY_FULL_GROUP_BY,STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION\'');
104
105
	if (!empty($db_options['db_mb4']))
106
		$smcFunc['db_mb4'] = (bool) $db_options['db_mb4'];
107
108
	return $connection;
109
}
110
111
/**
112
 * Extend the database functionality. It calls the respective file's init
113
 * to add the implementations in that file to $smcFunc array.
114
 *
115
 * @param string $type Indicates which additional file to load. ('extra', 'packages')
116
 */
117
function db_extend($type = 'extra')
118
{
119
	global $sourcedir;
120
121
	// we force the MySQL files as nothing syntactically changes with MySQLi
122
	require_once($sourcedir . '/Db' . strtoupper($type[0]) . substr($type, 1) . '-mysql.php');
123
	$initFunc = 'db_' . $type . '_init';
124
	$initFunc();
125
}
126
127
/**
128
 * Fix up the prefix so it doesn't require the database to be selected.
129
 *
130
 * @param string &$db_prefix The table prefix
131
 * @param string $db_name The database name
132
 */
133
function db_fix_prefix(&$db_prefix, $db_name)
134
{
135
	$db_prefix = is_numeric(substr($db_prefix, 0, 1)) ? $db_name . '.' . $db_prefix : '`' . $db_name . '`.' . $db_prefix;
136
}
137
138
/**
139
 * Wrap mysqli_select_db so the connection does not need to be specified
140
 *
141
 * @param string &$database The database
142
 * @param object $connection The connection object (if null, $db_connection is used)
143
 * @return bool Whether the database was selected
144
 */
145
function smf_db_select($database, $connection = null)
146
{
147
	global $db_connection;
148
	return mysqli_select_db($connection === null ? $db_connection : $connection, $database);
149
}
150
151
/**
152
 * Wrap mysqli_get_server_info so the connection does not need to be specified
153
 *
154
 * @param object $connection The connection to use (if null, $db_connection is used)
155
 * @return string The server info
156
 */
157
function smf_db_get_server_info($connection = null)
158
{
159
	global $db_connection;
160
	return mysqli_get_server_info($connection === null ? $db_connection : $connection);
161
}
162
163
/**
164
 * Callback for preg_replace_callback on the query.
165
 * It allows to replace on the fly a few pre-defined strings, for convenience ('query_see_board', 'query_wanna_see_board', etc), with
166
 * their current values from $user_info.
167
 * In addition, it performs checks and sanitization on the values sent to the database.
168
 *
169
 * @param array $matches The matches from preg_replace_callback
170
 * @return string The appropriate string depending on $matches[1]
171
 */
172
function smf_db_replacement__callback($matches)
173
{
174
	global $db_callback, $user_info, $db_prefix, $smcFunc;
175
176
	list ($values, $connection) = $db_callback;
177
	if (!is_object($connection))
178
		display_db_error();
179
180
	if ($matches[1] === 'db_prefix')
181
		return $db_prefix;
182
183
	if (isset($user_info[$matches[1]]) && strpos($matches[1], 'query_') !== false)
184
		return $user_info[$matches[1]];
185
186
	if ($matches[1] === 'empty')
187
		return '\'\'';
188
189
	if (!isset($matches[2]))
190
		smf_db_error_backtrace('Invalid value inserted or no type specified.', '', E_USER_ERROR, __FILE__, __LINE__);
191
192
	if ($matches[1] === 'literal')
193
		return '\'' . mysqli_real_escape_string($connection, $matches[2]) . '\'';
194
195
	if (!isset($values[$matches[2]]))
196
		smf_db_error_backtrace('The database value you\'re trying to insert does not exist: ' . (isset($smcFunc['htmlspecialchars']) ? $smcFunc['htmlspecialchars']($matches[2]) : htmlspecialchars($matches[2])), '', E_USER_ERROR, __FILE__, __LINE__);
197
198
	$replacement = $values[$matches[2]];
199
200
	switch ($matches[1])
201
	{
202
		case 'int':
203
			if (!is_numeric($replacement) || (string) $replacement !== (string) (int) $replacement)
204
				smf_db_error_backtrace('Wrong value type sent to the database. Integer expected. (' . $matches[2] . ')', '', E_USER_ERROR, __FILE__, __LINE__);
205
			return (string) (int) $replacement;
206
			break;
0 ignored issues
show
break is not strictly necessary here and could be removed.

The break statement is not necessary if it is preceded for example by a return statement:

switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

If you would like to keep this construct to be consistent with other case statements, you can safely mark this issue as a false-positive.

Loading history...
207
208
		case 'string':
209
		case 'text':
210
			return sprintf('\'%1$s\'', mysqli_real_escape_string($connection, $replacement));
211
			break;
212
213
		case 'array_int':
214
			if (is_array($replacement))
215
			{
216
				if (empty($replacement))
217
					smf_db_error_backtrace('Database error, given array of integer values is empty. (' . $matches[2] . ')', '', E_USER_ERROR, __FILE__, __LINE__);
218
219
				foreach ($replacement as $key => $value)
220
				{
221
					if (!is_numeric($value) || (string) $value !== (string) (int) $value)
222
						smf_db_error_backtrace('Wrong value type sent to the database. Array of integers expected. (' . $matches[2] . ')', '', E_USER_ERROR, __FILE__, __LINE__);
223
224
					$replacement[$key] = (string) (int) $value;
225
				}
226
227
				return implode(', ', $replacement);
228
			}
229
			else
230
				smf_db_error_backtrace('Wrong value type sent to the database. Array of integers expected. (' . $matches[2] . ')', '', E_USER_ERROR, __FILE__, __LINE__);
231
232
			break;
233
234
		case 'array_string':
235
			if (is_array($replacement))
236
			{
237
				if (empty($replacement))
238
					smf_db_error_backtrace('Database error, given array of string values is empty. (' . $matches[2] . ')', '', E_USER_ERROR, __FILE__, __LINE__);
239
240
				foreach ($replacement as $key => $value)
241
					$replacement[$key] = sprintf('\'%1$s\'', mysqli_real_escape_string($connection, $value));
242
243
				return implode(', ', $replacement);
244
			}
245
			else
246
				smf_db_error_backtrace('Wrong value type sent to the database. Array of strings expected. (' . $matches[2] . ')', '', E_USER_ERROR, __FILE__, __LINE__);
247
			break;
248
249
		case 'date':
250
			if (preg_match('~^(\d{4})-([0-1]?\d)-([0-3]?\d)$~', $replacement, $date_matches) === 1)
251
				return sprintf('\'%04d-%02d-%02d\'', $date_matches[1], $date_matches[2], $date_matches[3]);
252
			else
253
				smf_db_error_backtrace('Wrong value type sent to the database. Date expected. (' . $matches[2] . ')', '', E_USER_ERROR, __FILE__, __LINE__);
254
			break;
255
256
		case 'time':
257
			if (preg_match('~^([0-1]?\d|2[0-3]):([0-5]\d):([0-5]\d)$~', $replacement, $time_matches) === 1)
258
				return sprintf('\'%02d:%02d:%02d\'', $time_matches[1], $time_matches[2], $time_matches[3]);
259
			else
260
				smf_db_error_backtrace('Wrong value type sent to the database. Time expected. (' . $matches[2] . ')', '', E_USER_ERROR, __FILE__, __LINE__);
261
			break;
262
263
		case 'datetime':
264
			if (preg_match('~^(\d{4})-([0-1]?\d)-([0-3]?\d) ([0-1]?\d|2[0-3]):([0-5]\d):([0-5]\d)$~', $replacement, $datetime_matches) === 1)
265
				return 'str_to_date(' .
266
					sprintf('\'%04d-%02d-%02d %02d:%02d:%02d\'', $datetime_matches[1], $datetime_matches[2], $datetime_matches[3], $datetime_matches[4], $datetime_matches[5], $datetime_matches[6]) .
267
					',\'%Y-%m-%d %h:%i:%s\')';
268
			else
269
				smf_db_error_backtrace('Wrong value type sent to the database. Datetime expected. (' . $matches[2] . ')', '', E_USER_ERROR, __FILE__, __LINE__);
270
			break;
271
272
		case 'float':
273
			if (!is_numeric($replacement))
274
				smf_db_error_backtrace('Wrong value type sent to the database. Floating point number expected. (' . $matches[2] . ')', '', E_USER_ERROR, __FILE__, __LINE__);
275
			return (string) (float) $replacement;
276
			break;
277
278
		case 'identifier':
279
			// Backticks inside identifiers are supported as of MySQL 4.1. We don't need them for SMF.
280
			return '`' . strtr($replacement, array('`' => '', '.' => '`.`')) . '`';
281
			break;
282
283
		case 'raw':
284
			return $replacement;
285
			break;
286
287
		case 'inet':
288
			if ($replacement == 'null' || $replacement == '')
289
				return 'null';
290
			if (!isValidIP($replacement))
291
				smf_db_error_backtrace('Wrong value type sent to the database. IPv4 or IPv6 expected.(' . $matches[2] . ')', '', E_USER_ERROR, __FILE__, __LINE__);
292
			//we don't use the native support of mysql > 5.6.2
293
			return sprintf('unhex(\'%1$s\')', bin2hex(inet_pton($replacement)));
294
295
		case 'array_inet':
296
			if (is_array($replacement))
297
			{
298
				if (empty($replacement))
299
					smf_db_error_backtrace('Database error, given array of IPv4 or IPv6 values is empty. (' . $matches[2] . ')', '', E_USER_ERROR, __FILE__, __LINE__);
300
301
				foreach ($replacement as $key => $value)
302
				{
303
					if ($replacement == 'null' || $replacement == '')
304
						$replacement[$key] = 'null';
305
					if (!isValidIP($value))
306
						smf_db_error_backtrace('Wrong value type sent to the database. IPv4 or IPv6 expected.(' . $matches[2] . ')', '', E_USER_ERROR, __FILE__, __LINE__);
307
					$replacement[$key] = sprintf('unhex(\'%1$s\')', bin2hex(inet_pton($value)));
308
				}
309
310
				return implode(', ', $replacement);
311
			}
312
			else
313
				smf_db_error_backtrace('Wrong value type sent to the database. Array of IPv4 or IPv6 expected. (' . $matches[2] . ')', '', E_USER_ERROR, __FILE__, __LINE__);
314
			break;
315
316
		default:
317
			smf_db_error_backtrace('Undefined type used in the database query. (' . $matches[1] . ':' . $matches[2] . ')', '', false, __FILE__, __LINE__);
318
			break;
319
	}
320
}
321
322
/**
323
 * Just like the db_query, escape and quote a string, but not executing the query.
324
 *
325
 * @param string $db_string The database string
326
 * @param array $db_values An array of values to be injected into the string
327
 * @param resource $connection = null The connection to use (null to use $db_connection)
328
 * @return string The string with the values inserted
329
 */
330
function smf_db_quote($db_string, $db_values, $connection = null)
331
{
332
	global $db_callback, $db_connection;
333
334
	// Only bother if there's something to replace.
335
	if (strpos($db_string, '{') !== false)
336
	{
337
		// This is needed by the callback function.
338
		$db_callback = array($db_values, $connection === null ? $db_connection : $connection);
339
340
		// Do the quoting and escaping
341
		$db_string = preg_replace_callback('~{([a-z_]+)(?::([a-zA-Z0-9_-]+))?}~', 'smf_db_replacement__callback', $db_string);
342
343
		// Clear this global variable.
344
		$db_callback = array();
345
	}
346
347
	return $db_string;
348
}
349
350
/**
351
 * Do a query.  Takes care of errors too.
352
 *
353
 * @param string $identifier An identifier. Only used in Postgres when we need to do things differently...
354
 * @param string $db_string The database string
355
 * @param array $db_values = array() The values to be inserted into the string
356
 * @param resource $connection = null The connection to use (null to use $db_connection)
357
 * @return resource|bool Returns a MySQL result resource (for SELECT queries), true (for UPDATE queries) or false if the query failed
358
 */
359
function smf_db_query($identifier, $db_string, $db_values = array(), $connection = null)
360
{
361
	global $db_cache, $db_count, $db_connection, $db_show_debug;
362
	global $db_unbuffered, $db_callback, $modSettings;
363
364
	// Comments that are allowed in a query are preg_removed.
365
	static $allowed_comments_from = array(
366
		'~\s+~s',
367
		'~/\*!40001 SQL_NO_CACHE \*/~',
368
		'~/\*!40000 USE INDEX \([A-Za-z\_]+?\) \*/~',
369
		'~/\*!40100 ON DUPLICATE KEY UPDATE id_msg = \d+ \*/~',
370
	);
371
	static $allowed_comments_to = array(
372
		' ',
373
		'',
374
		'',
375
		'',
376
	);
377
378
	// Decide which connection to use.
379
	$connection = $connection === null ? $db_connection : $connection;
380
381
	// One more query....
382
	$db_count = !isset($db_count) ? 1 : $db_count + 1;
383
384
	if (empty($modSettings['disableQueryCheck']) && strpos($db_string, '\'') !== false && empty($db_values['security_override']))
385
		smf_db_error_backtrace('Hacking attempt...', 'Illegal character (\') used in query...', true, __FILE__, __LINE__);
386
387
	// Use "ORDER BY null" to prevent Mysql doing filesorts for Group By clauses without an Order By
388
	if (strpos($db_string, 'GROUP BY') !== false && strpos($db_string, 'ORDER BY') === false && preg_match('~^\s+SELECT~i', $db_string))
389
	{
390
		// Add before LIMIT
391
		if ($pos = strpos($db_string, 'LIMIT '))
392
			$db_string = substr($db_string, 0, $pos) . "\t\t\tORDER BY null\n" . substr($db_string, $pos, strlen($db_string));
393
		else
394
			// Append it.
395
			$db_string .= "\n\t\t\tORDER BY null";
396
	}
397
398
	if (empty($db_values['security_override']) && (!empty($db_values) || strpos($db_string, '{db_prefix}') !== false))
399
	{
400
		// Pass some values to the global space for use in the callback function.
401
		$db_callback = array($db_values, $connection);
402
403
		// Inject the values passed to this function.
404
		$db_string = preg_replace_callback('~{([a-z_]+)(?::([a-zA-Z0-9_-]+))?}~', 'smf_db_replacement__callback', $db_string);
405
406
		// This shouldn't be residing in global space any longer.
407
		$db_callback = array();
408
	}
409
410
	// First, we clean strings out of the query, reduce whitespace, lowercase, and trim - so we can check it over.
411
	if (empty($modSettings['disableQueryCheck']))
412
	{
413
		$clean = '';
414
		$old_pos = 0;
415
		$pos = -1;
416
		// Remove the string escape for better runtime
417
		$db_string_1 = str_replace('\\\'', '', $db_string);
418
		while (true)
419
		{
420
			$pos = strpos($db_string_1, '\'', $pos + 1);
421
			if ($pos === false)
422
				break;
423
			$clean .= substr($db_string_1, $old_pos, $pos - $old_pos);
424
425
			while (true)
426
			{
427
				$pos1 = strpos($db_string_1, '\'', $pos + 1);
428
				$pos2 = strpos($db_string_1, '\\', $pos + 1);
429
				if ($pos1 === false)
430
					break;
431
				elseif ($pos2 === false || $pos2 > $pos1)
432
				{
433
					$pos = $pos1;
434
					break;
435
				}
436
437
				$pos = $pos2 + 1;
438
			}
439
			$clean .= ' %s ';
440
441
			$old_pos = $pos + 1;
442
		}
443
		$clean .= substr($db_string_1, $old_pos);
444
		$clean = trim(strtolower(preg_replace($allowed_comments_from, $allowed_comments_to, $clean)));
445
446
		// Comments?  We don't use comments in our queries, we leave 'em outside!
447
		if (strpos($clean, '/*') > 2 || strpos($clean, '--') !== false || strpos($clean, ';') !== false)
448
			$fail = true;
449
		// Trying to change passwords, slow us down, or something?
450
		elseif (strpos($clean, 'sleep') !== false && preg_match('~(^|[^a-z])sleep($|[^[_a-z])~s', $clean) != 0)
451
			$fail = true;
452
		elseif (strpos($clean, 'benchmark') !== false && preg_match('~(^|[^a-z])benchmark($|[^[a-z])~s', $clean) != 0)
453
			$fail = true;
454
455
		if (!empty($fail) && function_exists('log_error'))
456
			smf_db_error_backtrace('Hacking attempt...', 'Hacking attempt...' . "\n" . $db_string, E_USER_ERROR, __FILE__, __LINE__);
457
	}
458
459
	// Debugging.
460
	if (isset($db_show_debug) && $db_show_debug === true)
461
	{
462
		// Get the file and line number this function was called.
463
		list ($file, $line) = smf_db_error_backtrace('', '', 'return', __FILE__, __LINE__);
464
465
		// Initialize $db_cache if not already initialized.
466
		if (!isset($db_cache))
467
			$db_cache = array();
468
469
		if (!empty($_SESSION['debug_redirect']))
470
		{
471
			$db_cache = array_merge($_SESSION['debug_redirect'], $db_cache);
472
			$db_count = count($db_cache) + 1;
473
			$_SESSION['debug_redirect'] = array();
474
		}
475
476
		// Don't overload it.
477
		$db_cache[$db_count]['q'] = $db_count < 50 ? $db_string : '...';
478
		$db_cache[$db_count]['f'] = $file;
479
		$db_cache[$db_count]['l'] = $line;
480
		$db_cache[$db_count]['s'] = ($st = microtime(true)) - TIME_START;
481
	}
482
483
	if (empty($db_unbuffered))
484
		$ret = @mysqli_query($connection, $db_string);
485
	else
486
		$ret = @mysqli_query($connection, $db_string, MYSQLI_USE_RESULT);
487
488
	if ($ret === false && empty($db_values['db_error_skip']))
489
		$ret = smf_db_error($db_string, $connection);
490
491
	// Debugging.
492
	if (isset($db_show_debug) && $db_show_debug === true)
493
		$db_cache[$db_count]['t'] = microtime(true) - $st;
494
495
	return $ret;
496
}
497
498
/**
499
 * affected_rows
500
 *
501
 * @param resource $connection A connection to use (if null, $db_connection is used)
502
 * @return int The number of rows affected by the last query
503
 */
504
function smf_db_affected_rows($connection = null)
505
{
506
	global $db_connection;
507
508
	return mysqli_affected_rows($connection === null ? $db_connection : $connection);
509
}
510
511
/**
512
 * Gets the ID of the most recently inserted row.
513
 *
514
 * @param string $table The table (only used for Postgres)
515
 * @param string $field = null The specific field (not used here)
516
 * @param resource $connection = null The connection (if null, $db_connection is used)
517
 * @return int The ID of the most recently inserted row
518
 */
519
function smf_db_insert_id($table, $field = null, $connection = null)
520
{
521
	global $db_connection;
522
523
	// MySQL doesn't need the table or field information.
524
	return mysqli_insert_id($connection === null ? $db_connection : $connection);
525
}
526
527
/**
528
 * Do a transaction.
529
 *
530
 * @param string $type The step to perform (i.e. 'begin', 'commit', 'rollback')
531
 * @param resource $connection The connection to use (if null, $db_connection is used)
532
 * @return bool True if successful, false otherwise
533
 */
534
function smf_db_transaction($type = 'commit', $connection = null)
535
{
536
	global $db_connection;
537
538
	// Decide which connection to use
539
	$connection = $connection === null ? $db_connection : $connection;
540
541
	if ($type == 'begin')
542
		return @mysqli_query($connection, 'BEGIN');
543
	elseif ($type == 'rollback')
544
		return @mysqli_query($connection, 'ROLLBACK');
545
	elseif ($type == 'commit')
546
		return @mysqli_query($connection, 'COMMIT');
547
548
	return false;
549
}
550
551
/**
552
 * Database error!
553
 * Backtrace, log, try to fix.
554
 *
555
 * @param string $db_string The DB string
556
 * @param object $connection The connection to use (if null, $db_connection is used)
557
 */
558
function smf_db_error($db_string, $connection = null)
559
{
560
	global $txt, $context, $sourcedir, $webmaster_email, $modSettings;
561
	global $db_connection, $db_last_error, $db_persist, $cache_enable;
562
	global $db_server, $db_user, $db_passwd, $db_name, $db_show_debug, $ssi_db_user, $ssi_db_passwd;
563
	global $smcFunc;
564
565
	// Get the file and line numbers.
566
	list ($file, $line) = smf_db_error_backtrace('', '', 'return', __FILE__, __LINE__);
567
568
	// Decide which connection to use
569
	$connection = $connection === null ? $db_connection : $connection;
570
571
	// This is the error message...
572
	$query_error = mysqli_error($connection);
573
	$query_errno = mysqli_errno($connection);
574
575
	// Error numbers:
576
	//    1016: Can't open file '....MYI'
577
	//    1030: Got error ??? from table handler.
578
	//    1034: Incorrect key file for table.
579
	//    1035: Old key file for table.
580
	//    1205: Lock wait timeout exceeded.
581
	//    1213: Deadlock found.
582
583
	// Log the error.
584
	if ($query_errno != 1213 && $query_errno != 1205 && function_exists('log_error'))
585
		log_error($txt['database_error'] . ': ' . $query_error . (!empty($modSettings['enableErrorQueryLogging']) ? "\n\n$db_string" : ''), 'database', $file, $line);
586
587
	// Database error auto fixing ;).
588
	if (function_exists('cache_get_data') && (!isset($modSettings['autoFixDatabase']) || $modSettings['autoFixDatabase'] == '1'))
589
	{
590
		// Force caching on, just for the error checking.
591
		$old_cache = @$cache_enable;
592
		$cache_enable = '1';
593
594
		if (($temp = cache_get_data('db_last_error', 600)) !== null)
595
			$db_last_error = max(@$db_last_error, $temp);
596
597
		if (@$db_last_error < time() - 3600 * 24 * 3)
598
		{
599
			// We know there's a problem... but what?  Try to auto detect.
600
			if ($query_errno == 1030 && strpos($query_error, ' 127 ') !== false)
601
			{
602
				preg_match_all('~(?:[\n\r]|^)[^\']+?(?:FROM|JOIN|UPDATE|TABLE) ((?:[^\n\r(]+?(?:, )?)*)~s', $db_string, $matches);
603
604
				$fix_tables = array();
605
				foreach ($matches[1] as $tables)
606
				{
607
					$tables = array_unique(explode(',', $tables));
608
					foreach ($tables as $table)
609
					{
610
						// Now, it's still theoretically possible this could be an injection.  So backtick it!
611
						if (trim($table) != '')
612
							$fix_tables[] = '`' . strtr(trim($table), array('`' => '')) . '`';
613
					}
614
				}
615
616
				$fix_tables = array_unique($fix_tables);
617
			}
618
			// Table crashed.  Let's try to fix it.
619
			elseif ($query_errno == 1016)
620
			{
621
				if (preg_match('~\'([^\.\']+)~', $query_error, $match) != 0)
622
					$fix_tables = array('`' . $match[1] . '`');
623
			}
624
			// Indexes crashed.  Should be easy to fix!
625
			elseif ($query_errno == 1034 || $query_errno == 1035)
626
			{
627
				preg_match('~\'([^\']+?)\'~', $query_error, $match);
628
				$fix_tables = array('`' . $match[1] . '`');
629
			}
630
		}
631
632
		// Check for errors like 145... only fix it once every three days, and send an email. (can't use empty because it might not be set yet...)
633
		if (!empty($fix_tables))
634
		{
635
			// Subs-Admin.php for updateSettingsFile(), Subs-Post.php for sendmail().
636
			require_once($sourcedir . '/Subs-Admin.php');
637
			require_once($sourcedir . '/Subs-Post.php');
638
639
			// Make a note of the REPAIR...
640
			cache_put_data('db_last_error', time(), 600);
641
			if (($temp = cache_get_data('db_last_error', 600)) === null)
0 ignored issues
show
The assignment to $temp is dead and can be removed.
Loading history...
642
				updateSettingsFile(array('db_last_error' => time()));
643
644
			// Attempt to find and repair the broken table.
645
			foreach ($fix_tables as $table)
646
				$smcFunc['db_query']('', "
647
					REPAIR TABLE $table", false, false);
648
649
			// And send off an email!
650
			sendmail($webmaster_email, $txt['database_error'], $txt['tried_to_repair'], null, 'dberror');
651
652
			$cache_enable = $old_cache;
653
654
			// Try the query again...?
655
			$ret = $smcFunc['db_query']('', $db_string, false, false);
656
			if ($ret !== false)
657
				return $ret;
658
		}
659
		else
660
			$cache_enable = $old_cache;
661
662
		// Check for the "lost connection" or "deadlock found" errors - and try it just one more time.
663
		if (in_array($query_errno, array(1205, 1213)))
664
		{
665
			if ($db_connection)
666
			{
667
				// Try a deadlock more than once more.
668
				for ($n = 0; $n < 4; $n++)
669
				{
670
					$ret = $smcFunc['db_query']('', $db_string, false, false);
671
672
					$new_errno = mysqli_errno($db_connection);
673
					if ($ret !== false || in_array($new_errno, array(1205, 1213)))
674
						break;
675
				}
676
677
				// If it failed again, shucks to be you... we're not trying it over and over.
678
				if ($ret !== false)
679
					return $ret;
680
			}
681
		}
682
		// Are they out of space, perhaps?
683
		elseif ($query_errno == 1030 && (strpos($query_error, ' -1 ') !== false || strpos($query_error, ' 28 ') !== false || strpos($query_error, ' 12 ') !== false))
684
		{
685
			if (!isset($txt))
686
				$query_error .= ' - check database storage space.';
687
			else
688
			{
689
				if (!isset($txt['mysql_error_space']))
690
					loadLanguage('Errors');
691
692
				$query_error .= !isset($txt['mysql_error_space']) ? ' - check database storage space.' : $txt['mysql_error_space'];
693
			}
694
		}
695
	}
696
697
	// Nothing's defined yet... just die with it.
698
	if (empty($context) || empty($txt))
699
		die($query_error);
700
701
	// Show an error message, if possible.
702
	$context['error_title'] = $txt['database_error'];
703
	if (allowedTo('admin_forum'))
704
		$context['error_message'] = nl2br($query_error) . '<br>' . $txt['file'] . ': ' . $file . '<br>' . $txt['line'] . ': ' . $line;
705
	else
706
		$context['error_message'] = $txt['try_again'];
707
708
	if (allowedTo('admin_forum') && isset($db_show_debug) && $db_show_debug === true)
709
	{
710
		$context['error_message'] .= '<br><br>' . nl2br($db_string);
711
	}
712
713
	// It's already been logged... don't log it again.
714
	fatal_error($context['error_message'], false);
715
}
716
717
/**
718
 * Inserts data into a table
719
 *
720
 * @param string $method The insert method - can be 'replace', 'ignore' or 'insert'
721
 * @param string $table The table we're inserting the data into
722
 * @param array $columns An array of the columns we're inserting the data into. Should contain 'column' => 'datatype' pairs
723
 * @param array $data The data to insert
724
 * @param array $keys The keys for the table, needs to be not empty on replace mode
725
 * @param int returnmode 0 = nothing(default), 1 = last row id, 2 = all rows id as array
726
 * @param object $connection The connection to use (if null, $db_connection is used)
727
 * @return mixed value of the first key, behavior based on returnmode. null if no data.
728
 */
729
function smf_db_insert($method = 'replace', $table, $columns, $data, $keys, $returnmode = 0, $connection = null)
730
{
731
	global $smcFunc, $db_connection, $db_prefix;
732
733
	$connection = $connection === null ? $db_connection : $connection;
734
735
	$return_var = null;
736
737
	// With nothing to insert, simply return.
738
	if (empty($data))
739
		return;
740
741
	// Replace the prefix holder with the actual prefix.
742
	$table = str_replace('{db_prefix}', $db_prefix, $table);
743
744
	$with_returning = false;
745
746
	if (!empty($keys) && (count($keys) > 0) && $returnmode > 0)
747
	{
748
		$with_returning = true;
749
		if ($returnmode == 2)
750
			$return_var = array();
751
	}
752
753
	// Inserting data as a single row can be done as a single array.
754
	if (!is_array($data[array_rand($data)]))
755
		$data = array($data);
756
757
	// Create the mold for a single row insert.
758
	$insertData = '(';
759
	foreach ($columns as $columnName => $type)
760
	{
761
		// Are we restricting the length?
762
		if (strpos($type, 'string-') !== false)
763
			$insertData .= sprintf('SUBSTRING({string:%1$s}, 1, ' . substr($type, 7) . '), ', $columnName);
764
		else
765
			$insertData .= sprintf('{%1$s:%2$s}, ', $type, $columnName);
766
	}
767
	$insertData = substr($insertData, 0, -2) . ')';
768
769
	// Create an array consisting of only the columns.
770
	$indexed_columns = array_keys($columns);
771
772
	// Here's where the variables are injected to the query.
773
	$insertRows = array();
774
	foreach ($data as $dataRow)
775
		$insertRows[] = smf_db_quote($insertData, array_combine($indexed_columns, $dataRow), $connection);
776
777
	// Determine the method of insertion.
778
	$queryTitle = $method == 'replace' ? 'REPLACE' : ($method == 'ignore' ? 'INSERT IGNORE' : 'INSERT');
779
780
	// Sanity check for replace is key part of the columns array
781
	if ($method == 'replace')
782
	{
783
		if (empty($keys))
784
			smf_db_error_backtrace('When using the replace mode, the key column is a required entry.',
785
				'Change the method of db insert to insert or add the pk field to the key array', E_USER_ERROR, __FILE__, __LINE__);
786
		if (count(array_intersect_key($columns, array_flip($keys))) !== count($keys))
787
			smf_db_error_backtrace('Primary Key field missing in insert call',
788
				'Change the method of db insert to insert or add the pk field to the columns array', E_USER_ERROR, __FILE__, __LINE__);
789
	}
790
791
	if (!$with_returning || $method != 'ignore')
792
	{
793
		// Do the insert.
794
		$smcFunc['db_query']('', '
795
			' . $queryTitle . ' INTO ' . $table . '(`' . implode('`, `', $indexed_columns) . '`)
796
			VALUES
797
				' . implode(',
798
				', $insertRows),
799
			array(
800
				'security_override' => true,
801
				'db_error_skip' => $table === $db_prefix . 'log_errors',
802
			),
803
			$connection
804
		);
805
	}
806
	// Special way for ignore method with returning
807
	else
808
	{
809
		$count = count($insertRows);
810
		$ai = 0;
811
		for ($i = 0; $i < $count; $i++)
812
		{
813
			$old_id = $smcFunc['db_insert_id']($table);
814
815
			$smcFunc['db_query']('', '
816
				' . $queryTitle . ' INTO ' . $table . '(`' . implode('`, `', $indexed_columns) . '`)
817
				VALUES
818
					' . $insertRows[$i],
819
				array(
820
					'security_override' => true,
821
					'db_error_skip' => $table === $db_prefix . 'log_errors',
822
				),
823
				$connection
824
			);
825
			$new_id = $smcFunc['db_insert_id']($table);
826
827
			// the inserted value was new
828
			if ($old_id != $new_id)
829
			{
830
				$ai = $new_id;
831
			}
832
			// the inserted value already exists we need to find the pk
833
			else
834
			{
835
				$where_string = '';
836
				$count2 = count($keys);
837
				for ($x = 0; $x < $count2; $x++)
838
				{
839
					$keyPos = array_search($keys[$x], array_keys($columns));
840
					$where_string .= $keys[$x] . ' = ' . $data[$i][$keyPos];
841
					if (($x + 1) < $count2)
842
						$where_string .= ' AND ';
843
				}
844
845
				$request = $smcFunc['db_query']('', '
846
					SELECT `' . $keys[0] . '` FROM ' . $table . '
847
					WHERE ' . $where_string . ' LIMIT 1',
848
					array()
849
				);
850
851
				if ($request !== false && $smcFunc['db_num_rows']($request) == 1)
852
				{
853
					$row = $smcFunc['db_fetch_assoc']($request);
854
					$ai = $row[$keys[0]];
855
				}
856
			}
857
858
			if ($returnmode == 1)
859
				$return_var = $ai;
860
			elseif ($returnmode == 2)
861
				$return_var[] = $ai;
862
		}
863
	}
864
865
	if ($with_returning)
866
	{
867
		if ($returnmode == 1 && empty($return_var))
868
			$return_var = smf_db_insert_id($table, $keys[0]) + count($insertRows) - 1;
869
		elseif ($returnmode == 2 && empty($return_var))
870
		{
871
			$return_var = array();
872
			$count = count($insertRows);
873
			$start = smf_db_insert_id($table, $keys[0]);
874
			for ($i = 0; $i < $count; $i++)
875
				$return_var[] = $start + $i;
876
		}
877
		return $return_var;
878
	}
879
}
880
881
/**
882
 * This function tries to work out additional error information from a back trace.
883
 *
884
 * @param string $error_message The error message
885
 * @param string $log_message The message to log
886
 * @param string|bool $error_type What type of error this is
887
 * @param string $file The file the error occurred in
888
 * @param int $line What line of $file the code which generated the error is on
889
 * @return void|array Returns an array with the file and line if $error_type is 'return'
890
 */
891
function smf_db_error_backtrace($error_message, $log_message = '', $error_type = false, $file = null, $line = null)
892
{
893
	if (empty($log_message))
894
		$log_message = $error_message;
895
896
	foreach (debug_backtrace() as $step)
897
	{
898
		// Found it?
899
		if (strpos($step['function'], 'query') === false && !in_array(substr($step['function'], 0, 7), array('smf_db_', 'preg_re', 'db_erro', 'call_us')) && strpos($step['function'], '__') !== 0)
900
		{
901
			$log_message .= '<br>Function: ' . $step['function'];
902
			break;
903
		}
904
905
		if (isset($step['line']))
906
		{
907
			$file = $step['file'];
908
			$line = $step['line'];
909
		}
910
	}
911
912
	// A special case - we want the file and line numbers for debugging.
913
	if ($error_type == 'return')
914
		return array($file, $line);
915
916
	// Is always a critical error.
917
	if (function_exists('log_error'))
918
		log_error($log_message, 'critical', $file, $line);
919
920
	if (function_exists('fatal_error'))
921
	{
922
		fatal_error($error_message, false);
923
924
		// Cannot continue...
925
		exit;
926
	}
927
	elseif ($error_type)
928
		trigger_error($error_message . ($line !== null ? '<em>(' . basename($file) . '-' . $line . ')</em>' : ''), $error_type);
929
	else
930
		trigger_error($error_message . ($line !== null ? '<em>(' . basename($file) . '-' . $line . ')</em>' : ''));
931
}
932
933
/**
934
 * Escape the LIKE wildcards so that they match the character and not the wildcard.
935
 *
936
 * @param string $string The string to escape
937
 * @param bool $translate_human_wildcards If true, turns human readable wildcards into SQL wildcards.
938
 * @return string The escaped string
939
 */
940
function smf_db_escape_wildcard_string($string, $translate_human_wildcards = false)
941
{
942
	$replacements = array(
943
		'%' => '\%',
944
		'_' => '\_',
945
		'\\' => '\\\\',
946
	);
947
948
	if ($translate_human_wildcards)
949
		$replacements += array(
950
			'*' => '%',
951
		);
952
953
	return strtr($string, $replacements);
954
}
955
956
/**
957
 * Validates whether the resource is a valid mysqli instance.
958
 * Mysqli uses objects rather than resource. https://bugs.php.net/bug.php?id=42797
959
 *
960
 * @param mixed $result The string to test
961
 * @return bool True if it is, false otherwise
962
 */
963
function smf_is_resource($result)
964
{
965
	if ($result instanceof mysqli_result)
966
		return true;
967
968
	return false;
969
}
970
971
/**
972
 * Fetches all rows from a result as an array
973
 *
974
 * @param resource $request A MySQL result resource
975
 * @return array An array that contains all rows (records) in the result resource
976
 */
977
function smf_db_fetch_all($request)
978
{
979
	// Return the right row.
980
	if (function_exists('mysqli_fetch_all'))
981
		$return = mysqli_fetch_all($request, MYSQLI_ASSOC);
982
	else
983
	{
984
		$return = array();
985
		while($row = mysqli_fetch_assoc($request))
986
			$return[] = $row;
987
	}
988
	return !empty($return) ? $return : array();
989
}
990
991
/**
992
 * Function to save errors in database in a safe way
993
 *
994
 * @param array with keys in this order id_member, log_time, ip, url, message, session, error_type, file, line
995
 * @return void
996
 */
997
function smf_db_error_insert($error_array)
998
{
999
	global $db_prefix, $db_connection;
1000
	static $mysql_error_data_prep;
1001
1002
	// without database we can't do anything
1003
	if (empty($db_connection))
1004
		return;
1005
1006
	if (empty($mysql_error_data_prep))
1007
		$mysql_error_data_prep = mysqli_prepare($db_connection,
1008
			'INSERT INTO ' . $db_prefix . 'log_errors
1009
				(id_member, log_time, ip, url, message, session, error_type, file, line, backtrace)
1010
			VALUES( ?, ?, unhex(?), ?, ?, ?, ?, ?, ?, ?)'
1011
		);
1012
1013
	if (filter_var($error_array[2], FILTER_VALIDATE_IP) !== false)
1014
		$error_array[2] = bin2hex(inet_pton($error_array[2]));
1015
	else
1016
		$error_array[2] = null;
1017
	mysqli_stmt_bind_param($mysql_error_data_prep, 'iissssssis',
1018
		$error_array[0], $error_array[1], $error_array[2], $error_array[3], $error_array[4], $error_array[5], $error_array[6],
1019
		$error_array[7], $error_array[8], $error_array[9]);
1020
	mysqli_stmt_execute($mysql_error_data_prep);
1021
}
1022
1023
/**
1024
 * Function which constructs an optimize custom order string
1025
 * as an improved alternative to find_in_set()
1026
 *
1027
 * @param string $field name
1028
 * @param array $array_values Field values sequenced in array via order priority. Must cast to int.
1029
 * @param boolean $desc default false
1030
 * @return string case field when ... then ... end
1031
 */
1032
function smf_db_custom_order($field, $array_values, $desc = false)
1033
{
1034
	$return = 'CASE ' . $field . ' ';
1035
	$count = count($array_values);
1036
	$then = ($desc ? ' THEN -' : ' THEN ');
1037
1038
	for ($i = 0; $i < $count; $i++)
1039
		$return .= 'WHEN ' . (int) $array_values[$i] . $then . $i . ' ';
1040
1041
	$return .= 'END';
1042
	return $return;
1043
}
1044
1045
/**
1046
 * Function which return the information if the database supports native replace inserts
1047
 *
1048
 * @return boolean true or false
1049
 */
1050
function smf_db_native_replace()
1051
{
1052
	return true;
1053
}
1054
1055
/**
1056
 * Function which return the information if the database supports cte with recursive
1057
 *
1058
 * @return boolean true or false
1059
 */
1060
function smf_db_cte_support()
1061
{
1062
	global $smcFunc;
1063
	static $return;
1064
1065
	if (isset($return))
1066
		return $return;
1067
1068
	db_extend('extra');
1069
1070
	$version = $smcFunc['db_get_version']();
1071
1072
	if (strpos(strtolower($version), 'mariadb') !== false)
1073
		$return = version_compare($version, '10.2.2', '>=');
1074
	else //mysql
1075
		$return = version_compare($version, '8.0.1', '>=');
1076
1077
	return $return;
1078
}
1079
1080
/**
1081
 * Function which return the escaped string
1082
 *
1083
 * @param string the unescaped text
1084
 * @param resource $connection = null The connection to use (null to use $db_connection)
1085
 * @return string escaped string
1086
 */
1087
function smf_db_escape_string($string, $connection = null)
1088
{
1089
	global $db_connection;
1090
1091
	return mysqli_real_escape_string($connection === null ? $db_connection : $connection, $string);
1092
}
1093
1094
?>