Passed
Pull Request — release-2.1 (#6754)
by Jon
07:43
created

fetch_web_data()   F

Complexity

Conditions 48
Paths 465

Size

Total Lines 171
Code Lines 95

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 48
eloc 95
nc 465
nop 4
dl 0
loc 171
rs 0.743
c 0
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
3
/**
4
 * This file has all the main functions in it that relate to, well, everything.
5
 *
6
 * Simple Machines Forum (SMF)
7
 *
8
 * @package SMF
9
 * @author Simple Machines https://www.simplemachines.org
10
 * @copyright 2021 Simple Machines and individual contributors
11
 * @license https://www.simplemachines.org/about/smf/license.php BSD
12
 *
13
 * @version 2.1 RC3
14
 */
15
16
if (!defined('SMF'))
17
	die('No direct access...');
18
19
/**
20
 * Update some basic statistics.
21
 *
22
 * 'member' statistic updates the latest member, the total member
23
 *  count, and the number of unapproved members.
24
 * 'member' also only counts approved members when approval is on, but
25
 *  is much more efficient with it off.
26
 *
27
 * 'message' changes the total number of messages, and the
28
 *  highest message id by id_msg - which can be parameters 1 and 2,
29
 *  respectively.
30
 *
31
 * 'topic' updates the total number of topics, or if parameter1 is true
32
 *  simply increments them.
33
 *
34
 * 'subject' updates the log_search_subjects in the event of a topic being
35
 *  moved, removed or split.  parameter1 is the topicid, parameter2 is the new subject
36
 *
37
 * 'postgroups' case updates those members who match condition's
38
 *  post-based membergroups in the database (restricted by parameter1).
39
 *
40
 * @param string $type Stat type - can be 'member', 'message', 'topic', 'subject' or 'postgroups'
41
 * @param mixed $parameter1 A parameter for updating the stats
42
 * @param mixed $parameter2 A 2nd parameter for updating the stats
43
 */
44
function updateStats($type, $parameter1 = null, $parameter2 = null)
45
{
46
	global $modSettings, $smcFunc, $txt;
47
48
	switch ($type)
49
	{
50
		case 'member':
51
			$changes = array(
52
				'memberlist_updated' => time(),
53
			);
54
55
			// #1 latest member ID, #2 the real name for a new registration.
56
			if (is_numeric($parameter1))
57
			{
58
				$changes['latestMember'] = $parameter1;
59
				$changes['latestRealName'] = $parameter2;
60
61
				updateSettings(array('totalMembers' => true), true);
62
			}
63
64
			// We need to calculate the totals.
65
			else
66
			{
67
				// Update the latest activated member (highest id_member) and count.
68
				$result = $smcFunc['db_query']('', '
69
					SELECT COUNT(*), MAX(id_member)
70
					FROM {db_prefix}members
71
					WHERE is_activated = {int:is_activated}',
72
					array(
73
						'is_activated' => 1,
74
					)
75
				);
76
				list ($changes['totalMembers'], $changes['latestMember']) = $smcFunc['db_fetch_row']($result);
77
				$smcFunc['db_free_result']($result);
78
79
				// Get the latest activated member's display name.
80
				$result = $smcFunc['db_query']('', '
81
					SELECT real_name
82
					FROM {db_prefix}members
83
					WHERE id_member = {int:id_member}
84
					LIMIT 1',
85
					array(
86
						'id_member' => (int) $changes['latestMember'],
87
					)
88
				);
89
				list ($changes['latestRealName']) = $smcFunc['db_fetch_row']($result);
90
				$smcFunc['db_free_result']($result);
91
92
				// Update the amount of members awaiting approval
93
				$result = $smcFunc['db_query']('', '
94
					SELECT COUNT(*)
95
					FROM {db_prefix}members
96
					WHERE is_activated IN ({array_int:activation_status})',
97
					array(
98
						'activation_status' => array(3, 4, 5),
99
					)
100
				);
101
102
				list ($changes['unapprovedMembers']) = $smcFunc['db_fetch_row']($result);
103
				$smcFunc['db_free_result']($result);
104
			}
105
			updateSettings($changes);
106
			break;
107
108
		case 'message':
109
			if ($parameter1 === true && $parameter2 !== null)
110
				updateSettings(array('totalMessages' => true, 'maxMsgID' => $parameter2), true);
111
			else
112
			{
113
				// SUM and MAX on a smaller table is better for InnoDB tables.
114
				$result = $smcFunc['db_query']('', '
115
					SELECT SUM(num_posts + unapproved_posts) AS total_messages, MAX(id_last_msg) AS max_msg_id
116
					FROM {db_prefix}boards
117
					WHERE redirect = {string:blank_redirect}' . (!empty($modSettings['recycle_enable']) && $modSettings['recycle_board'] > 0 ? '
118
						AND id_board != {int:recycle_board}' : ''),
119
					array(
120
						'recycle_board' => isset($modSettings['recycle_board']) ? $modSettings['recycle_board'] : 0,
121
						'blank_redirect' => '',
122
					)
123
				);
124
				$row = $smcFunc['db_fetch_assoc']($result);
125
				$smcFunc['db_free_result']($result);
126
127
				updateSettings(array(
128
					'totalMessages' => $row['total_messages'] === null ? 0 : $row['total_messages'],
129
					'maxMsgID' => $row['max_msg_id'] === null ? 0 : $row['max_msg_id']
130
				));
131
			}
132
			break;
133
134
		case 'subject':
135
			// Remove the previous subject (if any).
136
			$smcFunc['db_query']('', '
137
				DELETE FROM {db_prefix}log_search_subjects
138
				WHERE id_topic = {int:id_topic}',
139
				array(
140
					'id_topic' => (int) $parameter1,
141
				)
142
			);
143
144
			// Insert the new subject.
145
			if ($parameter2 !== null)
146
			{
147
				$parameter1 = (int) $parameter1;
148
				$parameter2 = text2words($parameter2);
149
150
				$inserts = array();
151
				foreach ($parameter2 as $word)
152
					$inserts[] = array($word, $parameter1);
153
154
				if (!empty($inserts))
155
					$smcFunc['db_insert']('ignore',
156
						'{db_prefix}log_search_subjects',
157
						array('word' => 'string', 'id_topic' => 'int'),
158
						$inserts,
159
						array('word', 'id_topic')
160
					);
161
			}
162
			break;
163
164
		case 'topic':
165
			if ($parameter1 === true)
166
				updateSettings(array('totalTopics' => true), true);
167
168
			else
169
			{
170
				// Get the number of topics - a SUM is better for InnoDB tables.
171
				// We also ignore the recycle bin here because there will probably be a bunch of one-post topics there.
172
				$result = $smcFunc['db_query']('', '
173
					SELECT SUM(num_topics + unapproved_topics) AS total_topics
174
					FROM {db_prefix}boards' . (!empty($modSettings['recycle_enable']) && $modSettings['recycle_board'] > 0 ? '
175
					WHERE id_board != {int:recycle_board}' : ''),
176
					array(
177
						'recycle_board' => !empty($modSettings['recycle_board']) ? $modSettings['recycle_board'] : 0,
178
					)
179
				);
180
				$row = $smcFunc['db_fetch_assoc']($result);
181
				$smcFunc['db_free_result']($result);
182
183
				updateSettings(array('totalTopics' => $row['total_topics'] === null ? 0 : $row['total_topics']));
184
			}
185
			break;
186
187
		case 'postgroups':
188
			// Parameter two is the updated columns: we should check to see if we base groups off any of these.
189
			if ($parameter2 !== null && !in_array('posts', $parameter2))
190
				return;
191
192
			$postgroups = cache_get_data('updateStats:postgroups', 360);
193
			if ($postgroups == null || $parameter1 == null)
194
			{
195
				// Fetch the postgroups!
196
				$request = $smcFunc['db_query']('', '
197
					SELECT id_group, min_posts
198
					FROM {db_prefix}membergroups
199
					WHERE min_posts != {int:min_posts}',
200
					array(
201
						'min_posts' => -1,
202
					)
203
				);
204
				$postgroups = array();
205
				while ($row = $smcFunc['db_fetch_assoc']($request))
206
					$postgroups[$row['id_group']] = $row['min_posts'];
207
208
				$smcFunc['db_free_result']($request);
209
210
				// Sort them this way because if it's done with MySQL it causes a filesort :(.
211
				arsort($postgroups);
212
213
				cache_put_data('updateStats:postgroups', $postgroups, 360);
214
			}
215
216
			// Oh great, they've screwed their post groups.
217
			if (empty($postgroups))
218
				return;
219
220
			// Set all membergroups from most posts to least posts.
221
			$conditions = '';
222
			$lastMin = 0;
223
			foreach ($postgroups as $id => $min_posts)
224
			{
225
				$conditions .= '
226
					WHEN posts >= ' . $min_posts . (!empty($lastMin) ? ' AND posts <= ' . $lastMin : '') . ' THEN ' . $id;
227
228
				$lastMin = $min_posts;
229
			}
230
231
			// A big fat CASE WHEN... END is faster than a zillion UPDATE's ;).
232
			$smcFunc['db_query']('', '
233
				UPDATE {db_prefix}members
234
				SET id_post_group = CASE ' . $conditions . '
235
				ELSE 0
236
				END' . ($parameter1 != null ? '
237
				WHERE ' . (is_array($parameter1) ? 'id_member IN ({array_int:members})' : 'id_member = {int:members}') : ''),
238
				array(
239
					'members' => $parameter1,
240
				)
241
			);
242
			break;
243
244
		default:
245
			loadLanguage('Errors');
246
			trigger_error(sprintf($txt['invalid_statistic_type'], $type), E_USER_NOTICE);
247
	}
248
}
249
250
/**
251
 * Updates the columns in the members table.
252
 * Assumes the data has been htmlspecialchar'd.
253
 * this function should be used whenever member data needs to be
254
 * updated in place of an UPDATE query.
255
 *
256
 * id_member is either an int or an array of ints to be updated.
257
 *
258
 * data is an associative array of the columns to be updated and their respective values.
259
 * any string values updated should be quoted and slashed.
260
 *
261
 * the value of any column can be '+' or '-', which mean 'increment'
262
 * and decrement, respectively.
263
 *
264
 * if the member's post number is updated, updates their post groups.
265
 *
266
 * @param mixed $members An array of member IDs, the ID of a single member, or null to update this for all members
267
 * @param array $data The info to update for the members
268
 */
269
function updateMemberData($members, $data)
270
{
271
	global $modSettings, $user_info, $smcFunc, $sourcedir, $cache_enable;
272
273
	// An empty array means there's nobody to update.
274
	if ($members === array())
275
		return;
276
277
	$parameters = array();
278
	if (is_array($members))
279
	{
280
		$condition = 'id_member IN ({array_int:members})';
281
		$parameters['members'] = $members;
282
	}
283
284
	elseif ($members === null)
285
		$condition = '1=1';
286
287
	else
288
	{
289
		$condition = 'id_member = {int:member}';
290
		$parameters['member'] = $members;
291
	}
292
293
	// Everything is assumed to be a string unless it's in the below.
294
	$knownInts = array(
295
		'date_registered', 'posts', 'id_group', 'last_login', 'instant_messages', 'unread_messages',
296
		'new_pm', 'pm_prefs', 'gender', 'show_online', 'pm_receive_from', 'alerts',
297
		'id_theme', 'is_activated', 'id_msg_last_visit', 'id_post_group', 'total_time_logged_in', 'warning',
298
	);
299
	$knownFloats = array(
300
		'time_offset',
301
	);
302
303
	if (!empty($modSettings['integrate_change_member_data']))
304
	{
305
		// Only a few member variables are really interesting for integration.
306
		$integration_vars = array(
307
			'member_name',
308
			'real_name',
309
			'email_address',
310
			'id_group',
311
			'gender',
312
			'birthdate',
313
			'website_title',
314
			'website_url',
315
			'location',
316
			'time_format',
317
			'time_offset',
318
			'avatar',
319
			'lngfile',
320
		);
321
		$vars_to_integrate = array_intersect($integration_vars, array_keys($data));
322
323
		// Only proceed if there are any variables left to call the integration function.
324
		if (count($vars_to_integrate) != 0)
325
		{
326
			// Fetch a list of member_names if necessary
327
			if ((!is_array($members) && $members === $user_info['id']) || (is_array($members) && count($members) == 1 && in_array($user_info['id'], $members)))
328
				$member_names = array($user_info['username']);
329
			else
330
			{
331
				$member_names = array();
332
				$request = $smcFunc['db_query']('', '
333
					SELECT member_name
334
					FROM {db_prefix}members
335
					WHERE ' . $condition,
336
					$parameters
337
				);
338
				while ($row = $smcFunc['db_fetch_assoc']($request))
339
					$member_names[] = $row['member_name'];
340
				$smcFunc['db_free_result']($request);
341
			}
342
343
			if (!empty($member_names))
344
				foreach ($vars_to_integrate as $var)
345
					call_integration_hook('integrate_change_member_data', array($member_names, $var, &$data[$var], &$knownInts, &$knownFloats));
346
		}
347
	}
348
349
	$setString = '';
350
	foreach ($data as $var => $val)
351
	{
352
		switch ($var)
353
		{
354
			case  'birthdate':
355
				$type = 'date';
356
				break;
357
358
			case 'member_ip':
359
			case 'member_ip2':
360
				$type = 'inet';
361
				break;
362
363
			default:
364
				$type = 'string';
365
		}
366
367
		if (in_array($var, $knownInts))
368
			$type = 'int';
369
370
		elseif (in_array($var, $knownFloats))
371
			$type = 'float';
372
373
		// Doing an increment?
374
		if ($var == 'alerts' && ($val === '+' || $val === '-'))
375
		{
376
			include_once($sourcedir . '/Profile-Modify.php');
377
			if (is_array($members))
378
			{
379
				$val = 'CASE ';
380
				foreach ($members as $k => $v)
381
					$val .= 'WHEN id_member = ' . $v . ' THEN '. alert_count($v, true) . ' ';
382
383
				$val = $val . ' END';
384
				$type = 'raw';
385
			}
386
387
			else
388
				$val = alert_count($members, true);
389
		}
390
391
		elseif ($type == 'int' && ($val === '+' || $val === '-'))
392
		{
393
			$val = $var . ' ' . $val . ' 1';
394
			$type = 'raw';
395
		}
396
397
		// Ensure posts, instant_messages, and unread_messages don't overflow or underflow.
398
		if (in_array($var, array('posts', 'instant_messages', 'unread_messages')))
399
		{
400
			if (preg_match('~^' . $var . ' (\+ |- |\+ -)([\d]+)~', $val, $match))
401
			{
402
				if ($match[1] != '+ ')
403
					$val = 'CASE WHEN ' . $var . ' <= ' . abs($match[2]) . ' THEN 0 ELSE ' . $val . ' END';
404
405
				$type = 'raw';
406
			}
407
		}
408
409
		$setString .= ' ' . $var . ' = {' . $type . ':p_' . $var . '},';
410
		$parameters['p_' . $var] = $val;
411
	}
412
413
	$smcFunc['db_query']('', '
414
		UPDATE {db_prefix}members
415
		SET' . substr($setString, 0, -1) . '
416
		WHERE ' . $condition,
417
		$parameters
418
	);
419
420
	updateStats('postgroups', $members, array_keys($data));
421
422
	// Clear any caching?
423
	if (!empty($cache_enable) && $cache_enable >= 2 && !empty($members))
424
	{
425
		if (!is_array($members))
426
			$members = array($members);
427
428
		foreach ($members as $member)
429
		{
430
			if ($cache_enable >= 3)
431
			{
432
				cache_put_data('member_data-profile-' . $member, null, 120);
433
				cache_put_data('member_data-normal-' . $member, null, 120);
434
				cache_put_data('member_data-minimal-' . $member, null, 120);
435
			}
436
			cache_put_data('user_settings-' . $member, null, 60);
437
		}
438
	}
439
}
440
441
/**
442
 * Updates the settings table as well as $modSettings... only does one at a time if $update is true.
443
 *
444
 * - updates both the settings table and $modSettings array.
445
 * - all of changeArray's indexes and values are assumed to have escaped apostrophes (')!
446
 * - if a variable is already set to what you want to change it to, that
447
 *   variable will be skipped over; it would be unnecessary to reset.
448
 * - When use_update is true, UPDATEs will be used instead of REPLACE.
449
 * - when use_update is true, the value can be true or false to increment
450
 *  or decrement it, respectively.
451
 *
452
 * @param array $changeArray An array of info about what we're changing in 'setting' => 'value' format
453
 * @param bool $update Whether to use an UPDATE query instead of a REPLACE query
454
 */
455
function updateSettings($changeArray, $update = false)
456
{
457
	global $modSettings, $smcFunc;
458
459
	if (empty($changeArray) || !is_array($changeArray))
460
		return;
461
462
	$toRemove = array();
463
464
	// Go check if there is any setting to be removed.
465
	foreach ($changeArray as $k => $v)
466
		if ($v === null)
467
		{
468
			// Found some, remove them from the original array and add them to ours.
469
			unset($changeArray[$k]);
470
			$toRemove[] = $k;
471
		}
472
473
	// Proceed with the deletion.
474
	if (!empty($toRemove))
475
		$smcFunc['db_query']('', '
476
			DELETE FROM {db_prefix}settings
477
			WHERE variable IN ({array_string:remove})',
478
			array(
479
				'remove' => $toRemove,
480
			)
481
		);
482
483
	// In some cases, this may be better and faster, but for large sets we don't want so many UPDATEs.
484
	if ($update)
485
	{
486
		foreach ($changeArray as $variable => $value)
487
		{
488
			$smcFunc['db_query']('', '
489
				UPDATE {db_prefix}settings
490
				SET value = {' . ($value === false || $value === true ? 'raw' : 'string') . ':value}
491
				WHERE variable = {string:variable}',
492
				array(
493
					'value' => $value === true ? 'value + 1' : ($value === false ? 'value - 1' : $value),
494
					'variable' => $variable,
495
				)
496
			);
497
			$modSettings[$variable] = $value === true ? $modSettings[$variable] + 1 : ($value === false ? $modSettings[$variable] - 1 : $value);
498
		}
499
500
		// Clean out the cache and make sure the cobwebs are gone too.
501
		cache_put_data('modSettings', null, 90);
502
503
		return;
504
	}
505
506
	$replaceArray = array();
507
	foreach ($changeArray as $variable => $value)
508
	{
509
		// Don't bother if it's already like that ;).
510
		if (isset($modSettings[$variable]) && $modSettings[$variable] == $value)
511
			continue;
512
		// If the variable isn't set, but would only be set to nothing'ness, then don't bother setting it.
513
		elseif (!isset($modSettings[$variable]) && empty($value))
514
			continue;
515
516
		$replaceArray[] = array($variable, $value);
517
518
		$modSettings[$variable] = $value;
519
	}
520
521
	if (empty($replaceArray))
522
		return;
523
524
	$smcFunc['db_insert']('replace',
525
		'{db_prefix}settings',
526
		array('variable' => 'string-255', 'value' => 'string-65534'),
527
		$replaceArray,
528
		array('variable')
529
	);
530
531
	// Kill the cache - it needs redoing now, but we won't bother ourselves with that here.
532
	cache_put_data('modSettings', null, 90);
533
}
534
535
/**
536
 * Constructs a page list.
537
 *
538
 * - builds the page list, e.g. 1 ... 6 7 [8] 9 10 ... 15.
539
 * - flexible_start causes it to use "url.page" instead of "url;start=page".
540
 * - very importantly, cleans up the start value passed, and forces it to
541
 *   be a multiple of num_per_page.
542
 * - checks that start is not more than max_value.
543
 * - base_url should be the URL without any start parameter on it.
544
 * - uses the compactTopicPagesEnable and compactTopicPagesContiguous
545
 *   settings to decide how to display the menu.
546
 *
547
 * an example is available near the function definition.
548
 * $pageindex = constructPageIndex($scripturl . '?board=' . $board, $_REQUEST['start'], $num_messages, $maxindex, true);
549
 *
550
 * @param string $base_url The basic URL to be used for each link.
551
 * @param int &$start The start position, by reference. If this is not a multiple of the number of items per page, it is sanitized to be so and the value will persist upon the function's return.
552
 * @param int $max_value The total number of items you are paginating for.
553
 * @param int $num_per_page The number of items to be displayed on a given page. $start will be forced to be a multiple of this value.
554
 * @param bool $flexible_start Whether a ;start=x component should be introduced into the URL automatically (see above)
555
 * @param bool $show_prevnext Whether the Previous and Next links should be shown (should be on only when navigating the list)
556
 *
557
 * @return string The complete HTML of the page index that was requested, formatted by the template.
558
 */
559
function constructPageIndex($base_url, &$start, $max_value, $num_per_page, $flexible_start = false, $show_prevnext = true)
560
{
561
	global $modSettings, $context, $smcFunc, $settings, $txt;
562
563
	// Save whether $start was less than 0 or not.
564
	$start = (int) $start;
565
	$start_invalid = $start < 0;
566
567
	// Make sure $start is a proper variable - not less than 0.
568
	if ($start_invalid)
569
		$start = 0;
570
	// Not greater than the upper bound.
571
	elseif ($start >= $max_value)
572
		$start = max(0, (int) $max_value - (((int) $max_value % (int) $num_per_page) == 0 ? $num_per_page : ((int) $max_value % (int) $num_per_page)));
573
	// And it has to be a multiple of $num_per_page!
574
	else
575
		$start = max(0, (int) $start - ((int) $start % (int) $num_per_page));
576
577
	$context['current_page'] = $start / $num_per_page;
578
579
	// Define some default page index settings if we don't already have it...
580
	if (!isset($settings['page_index']))
581
	{
582
		// This defines the formatting for the page indexes used throughout the forum.
583
		$settings['page_index'] = array(
584
			'extra_before' => '<span class="pages">' . $txt['pages'] . '</span>',
585
			'previous_page' => '<span class="main_icons previous_page"></span>',
586
			'current_page' => '<span class="current_page">%1$d</span> ',
587
			'page' => '<a class="nav_page" href="{URL}">%2$s</a> ',
588
			'expand_pages' => '<span class="expand_pages" onclick="expandPages(this, {LINK}, {FIRST_PAGE}, {LAST_PAGE}, {PER_PAGE});"> ... </span>',
589
			'next_page' => '<span class="main_icons next_page"></span>',
590
			'extra_after' => '',
591
		);
592
	}
593
594
	$base_link = strtr($settings['page_index']['page'], array('{URL}' => $flexible_start ? $base_url : strtr($base_url, array('%' => '%%')) . ';start=%1$d'));
595
	$pageindex = $settings['page_index']['extra_before'];
596
597
	// Compact pages is off or on?
598
	if (empty($modSettings['compactTopicPagesEnable']))
599
	{
600
		// Show the left arrow.
601
		$pageindex .= $start == 0 ? ' ' : sprintf($base_link, $start - $num_per_page, $settings['page_index']['previous_page']);
602
603
		// Show all the pages.
604
		$display_page = 1;
605
		for ($counter = 0; $counter < $max_value; $counter += $num_per_page)
606
			$pageindex .= $start == $counter && !$start_invalid ? sprintf($settings['page_index']['current_page'], $display_page++) : sprintf($base_link, $counter, $display_page++);
607
608
		// Show the right arrow.
609
		$display_page = ($start + $num_per_page) > $max_value ? $max_value : ($start + $num_per_page);
610
		if ($start != $counter - $max_value && !$start_invalid)
611
			$pageindex .= $display_page > $counter - $num_per_page ? ' ' : sprintf($base_link, $display_page, $settings['page_index']['next_page']);
612
	}
613
	else
614
	{
615
		// If they didn't enter an odd value, pretend they did.
616
		$PageContiguous = (int) ($modSettings['compactTopicPagesContiguous'] - ($modSettings['compactTopicPagesContiguous'] % 2)) / 2;
617
618
		// Show the "prev page" link. (>prev page< 1 ... 6 7 [8] 9 10 ... 15 next page)
619
		if (!empty($start) && $show_prevnext)
620
			$pageindex .= sprintf($base_link, $start - $num_per_page, $settings['page_index']['previous_page']);
621
		else
622
			$pageindex .= '';
623
624
		// Show the first page. (prev page >1< ... 6 7 [8] 9 10 ... 15)
625
		if ($start > $num_per_page * $PageContiguous)
626
			$pageindex .= sprintf($base_link, 0, '1');
627
628
		// Show the ... after the first page.  (prev page 1 >...< 6 7 [8] 9 10 ... 15 next page)
629
		if ($start > $num_per_page * ($PageContiguous + 1))
630
			$pageindex .= strtr($settings['page_index']['expand_pages'], array(
631
				'{LINK}' => JavaScriptEscape($smcFunc['htmlspecialchars']($base_link)),
632
				'{FIRST_PAGE}' => $num_per_page,
633
				'{LAST_PAGE}' => $start - $num_per_page * $PageContiguous,
634
				'{PER_PAGE}' => $num_per_page,
635
			));
636
637
		// Show the pages before the current one. (prev page 1 ... >6 7< [8] 9 10 ... 15 next page)
638
		for ($nCont = $PageContiguous; $nCont >= 1; $nCont--)
639
			if ($start >= $num_per_page * $nCont)
640
			{
641
				$tmpStart = $start - $num_per_page * $nCont;
642
				$pageindex .= sprintf($base_link, $tmpStart, $tmpStart / $num_per_page + 1);
643
			}
644
645
		// Show the current page. (prev page 1 ... 6 7 >[8]< 9 10 ... 15 next page)
646
		if (!$start_invalid)
647
			$pageindex .= sprintf($settings['page_index']['current_page'], $start / $num_per_page + 1);
648
		else
649
			$pageindex .= sprintf($base_link, $start, $start / $num_per_page + 1);
650
651
		// Show the pages after the current one... (prev page 1 ... 6 7 [8] >9 10< ... 15 next page)
652
		$tmpMaxPages = (int) (($max_value - 1) / $num_per_page) * $num_per_page;
653
		for ($nCont = 1; $nCont <= $PageContiguous; $nCont++)
654
			if ($start + $num_per_page * $nCont <= $tmpMaxPages)
655
			{
656
				$tmpStart = $start + $num_per_page * $nCont;
657
				$pageindex .= sprintf($base_link, $tmpStart, $tmpStart / $num_per_page + 1);
658
			}
659
660
		// Show the '...' part near the end. (prev page 1 ... 6 7 [8] 9 10 >...< 15 next page)
661
		if ($start + $num_per_page * ($PageContiguous + 1) < $tmpMaxPages)
662
			$pageindex .= strtr($settings['page_index']['expand_pages'], array(
663
				'{LINK}' => JavaScriptEscape($smcFunc['htmlspecialchars']($base_link)),
664
				'{FIRST_PAGE}' => $start + $num_per_page * ($PageContiguous + 1),
665
				'{LAST_PAGE}' => $tmpMaxPages,
666
				'{PER_PAGE}' => $num_per_page,
667
			));
668
669
		// Show the last number in the list. (prev page 1 ... 6 7 [8] 9 10 ... >15<  next page)
670
		if ($start + $num_per_page * $PageContiguous < $tmpMaxPages)
671
			$pageindex .= sprintf($base_link, $tmpMaxPages, $tmpMaxPages / $num_per_page + 1);
672
673
		// Show the "next page" link. (prev page 1 ... 6 7 [8] 9 10 ... 15 >next page<)
674
		if ($start != $tmpMaxPages && $show_prevnext)
675
			$pageindex .= sprintf($base_link, $start + $num_per_page, $settings['page_index']['next_page']);
676
	}
677
	$pageindex .= $settings['page_index']['extra_after'];
678
679
	return $pageindex;
680
}
681
682
/**
683
 * - Formats a number.
684
 * - uses the format of number_format to decide how to format the number.
685
 *   for example, it might display "1 234,50".
686
 * - caches the formatting data from the setting for optimization.
687
 *
688
 * @param float $number A number
689
 * @param bool|int $override_decimal_count If set, will use the specified number of decimal places. Otherwise it's automatically determined
690
 * @return string A formatted number
691
 */
692
function comma_format($number, $override_decimal_count = false)
693
{
694
	global $txt;
695
	static $thousands_separator = null, $decimal_separator = null, $decimal_count = null;
696
697
	// Cache these values...
698
	if ($decimal_separator === null)
699
	{
700
		// Not set for whatever reason?
701
		if (empty($txt['number_format']) || preg_match('~^1([^\d]*)?234([^\d]*)(0*?)$~', $txt['number_format'], $matches) != 1)
702
			return $number;
703
704
		// Cache these each load...
705
		$thousands_separator = $matches[1];
706
		$decimal_separator = $matches[2];
707
		$decimal_count = strlen($matches[3]);
708
	}
709
710
	// Format the string with our friend, number_format.
711
	return number_format($number, (float) $number === $number ? ($override_decimal_count === false ? $decimal_count : $override_decimal_count) : 0, $decimal_separator, $thousands_separator);
0 ignored issues
show
Bug introduced by
It seems like (double)$number === $num...rride_decimal_count : 0 can also be of type true; however, parameter $decimals of number_format() does only seem to accept integer, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

711
	return number_format($number, /** @scrutinizer ignore-type */ (float) $number === $number ? ($override_decimal_count === false ? $decimal_count : $override_decimal_count) : 0, $decimal_separator, $thousands_separator);
Loading history...
712
}
713
714
/**
715
 * Format a time to make it look purdy.
716
 *
717
 * - returns a pretty formatted version of time based on the user's format in $user_info['time_format'].
718
 * - applies all necessary time offsets to the timestamp, unless offset_type is set.
719
 * - if todayMod is set and show_today was not not specified or true, an
720
 *   alternate format string is used to show the date with something to show it is "today" or "yesterday".
721
 * - performs localization (more than just strftime would do alone.)
722
 *
723
 * @param int $log_time A timestamp
724
 * @param bool|string $show_today Whether to show "Today"/"Yesterday" or just a date. If a string is specified, that is used to temporarily override the date format.
725
 * @param bool|string $offset_type If false, uses both user time offset and forum offset. If 'forum', uses only the forum offset. Otherwise no offset is applied.
726
 * @param bool $process_safe Activate setlocale check for changes at runtime. Slower, but safer.
727
 * @return string A formatted timestamp
728
 */
729
function timeformat($log_time, $show_today = true, $offset_type = false, $process_safe = false)
730
{
731
	global $context, $user_info, $txt, $modSettings;
732
	static $non_twelve_hour, $locale, $now;
733
	static $unsupportedFormats, $finalizedFormats;
734
735
	$unsupportedFormatsWindows = array('z', 'Z');
736
737
	// Ensure required values are set
738
	$user_info['time_format'] = !empty($user_info['time_format']) ? $user_info['time_format'] : (!empty($modSettings['time_format']) ? $modSettings['time_format'] : '%F %H:%M');
739
740
	// Offset the time.
741
	if (!$offset_type)
742
		$log_time = forum_time(true, $log_time);
743
	// Just the forum offset?
744
	elseif ($offset_type == 'forum')
745
		$log_time = forum_time(false, $log_time);
746
747
	// We can't have a negative date (on Windows, at least.)
748
	if ($log_time < 0)
749
		$log_time = 0;
750
751
	// Today and Yesterday?
752
	$prefix = '';
753
	if ($modSettings['todayMod'] >= 1 && $show_today === true)
754
	{
755
		$now_time = forum_time();
756
757
		if ($now_time - $log_time < (86400 * $modSettings['todayMod']))
758
		{
759
			$then = @getdate($log_time);
760
			$now = (!empty($now) ? $now : @getdate($now_time));
761
762
			// Same day of the year, same year.... Today!
763
			if ($then['yday'] == $now['yday'] && $then['year'] == $now['year'])
764
			{
765
				$prefix = $txt['today'];
766
			}
767
			// Day-of-year is one less and same year, or it's the first of the year and that's the last of the year...
768
			elseif ($modSettings['todayMod'] == '2' && (($then['yday'] == $now['yday'] - 1 && $then['year'] == $now['year']) || ($now['yday'] == 0 && $then['year'] == $now['year'] - 1) && $then['mon'] == 12 && $then['mday'] == 31))
769
			{
770
				$prefix = $txt['yesterday'];
771
			}
772
		}
773
	}
774
775
	// If $show_today is not a bool, use it as the date format & don't use $user_info. Allows for temp override of the format.
776
	$str = !is_bool($show_today) ? $show_today : $user_info['time_format'];
777
778
	// Use the cached formats if available
779
	if (is_null($finalizedFormats))
780
		$finalizedFormats = (array) cache_get_data('timeformatstrings', 86400);
781
782
	if (!isset($finalizedFormats[$str]) || !is_array($finalizedFormats[$str]))
783
		$finalizedFormats[$str] = array();
784
785
	// Make a supported version for this format if we don't already have one
786
	$format_type = !empty($prefix) ? 'time_only' : 'normal';
787
	if (empty($finalizedFormats[$str][$format_type]))
788
	{
789
		$timeformat = $format_type == 'time_only' ? get_date_or_time_format('time', $str) : $str;
790
791
		// Not all systems support all formats, and Windows fails altogether if unsupported ones are
792
		// used, so let's prevent that. Some substitutions go to the nearest reasonable fallback, some
793
		// turn into static strings, some (i.e. %a, %A, %b, %B, %p) have special handling below.
794
		$strftimeFormatSubstitutions = array(
795
			// Day
796
			'a' => '#txt_days_short_%w#', 'A' => '#txt_days_%w#', 'e' => '%d', 'd' => '&#37;d', 'j' => '&#37;j', 'u' => '%w', 'w' => '&#37;w',
797
			// Week
798
			'U' => '&#37;U', 'V' => '%U', 'W' => '%U',
799
			// Month
800
			'b' => '#txt_months_short_%m#', 'B' => '#txt_months_%m#', 'h' => '%b', 'm' => '&#37;m',
801
			// Year
802
			'C' => '&#37;C', 'g' => '%y', 'G' => '%Y', 'y' => '&#37;y', 'Y' => '&#37;Y',
803
			// Time
804
			'H' => '&#37;H', 'k' => '%H', 'I' => '%H', 'l' => '%I', 'M' => '&#37;M', 'p' => '&#37;p', 'P' => '%p',
805
			'r' => '%I:%M:%S %p', 'R' => '%H:%M', 'S' => '&#37;S', 'T' => '%H:%M:%S', 'X' => '%T', 'z' => '&#37;z', 'Z' => '&#37;Z',
806
			// Time and Date Stamps
807
			'c' => '%F %T', 'D' => '%m/%d/%y', 'F' => '%Y-%m-%d', 's' => '&#37;s', 'x' => '%F',
808
			// Miscellaneous
809
			'n' => "\n", 't' => "\t", '%' => '&#37;',
810
		);
811
812
		// No need to do this part again if we already did it once
813
		if (is_null($unsupportedFormats))
814
			$unsupportedFormats = (array) cache_get_data('unsupportedtimeformats', 86400);
815
		if (empty($unsupportedFormats))
816
		{
817
			foreach ($strftimeFormatSubstitutions as $format => $substitution)
818
			{
819
				// Avoid a crashing bug with PHP 7 on certain versions of Windows
820
				if ($context['server']['is_windows'] && in_array($format, $unsupportedFormatsWindows))
821
				{
822
					$unsupportedFormats[] = $format;
823
					continue;
824
				}
825
826
				$value = @strftime('%' . $format);
827
828
				// Windows will return false for unsupported formats
829
				// Other operating systems return the format string as a literal
830
				if ($value === false || $value === $format)
831
					$unsupportedFormats[] = $format;
832
			}
833
			cache_put_data('unsupportedtimeformats', $unsupportedFormats, 86400);
834
		}
835
836
		// Windows needs extra help if $timeformat contains something completely invalid, e.g. '%Q'
837
		if (DIRECTORY_SEPARATOR === '\\')
838
			$timeformat = preg_replace('~%(?!' . implode('|', array_keys($strftimeFormatSubstitutions)) . ')~', '&#37;', $timeformat);
839
840
		// Substitute unsupported formats with supported ones
841
		if (!empty($unsupportedFormats))
842
			while (preg_match('~%(' . implode('|', $unsupportedFormats) . ')~', $timeformat, $matches))
843
				$timeformat = str_replace($matches[0], $strftimeFormatSubstitutions[$matches[1]], $timeformat);
844
845
		// Remember this so we don't need to do it again
846
		$finalizedFormats[$str][$format_type] = $timeformat;
847
		cache_put_data('timeformatstrings', $finalizedFormats, 86400);
848
	}
849
850
	$timeformat = $finalizedFormats[$str][$format_type];
851
852
	// Make sure we are using the correct locale.
853
	if (!isset($locale) || ($process_safe === true && setlocale(LC_TIME, '0') != $locale))
854
		$locale = setlocale(LC_TIME, array($txt['lang_locale'] . '.' . $modSettings['global_character_set'], $txt['lang_locale'] . '.' . $txt['lang_character_set'], $txt['lang_locale']));
855
856
	// If the current locale is unsupported, we'll have to localize the hard way.
857
	if ($locale === false)
858
	{
859
		$timeformat = strtr($timeformat, array(
860
			'%a' => '#txt_days_short_%w#',
861
			'%A' => '#txt_days_%w#',
862
			'%b' => '#txt_months_short_%m#',
863
			'%B' => '#txt_months_%m#',
864
			'%p' => '&#37;p',
865
			'%P' => '&#37;p'
866
		));
867
	}
868
	// Just in case the locale doesn't support '%p' properly.
869
	// @todo Is this even necessary?
870
	else
871
	{
872
		if (!isset($non_twelve_hour) && strpos($timeformat, '%p') !== false)
873
			$non_twelve_hour = trim(strftime('%p')) === '';
874
875
		if (!empty($non_twelve_hour))
876
			$timeformat = strtr($timeformat, array(
877
				'%p' => '&#37;p',
878
				'%P' => '&#37;p'
879
			));
880
	}
881
882
	// And now, the moment we've all be waiting for...
883
	$timestring = strftime($timeformat, $log_time);
884
885
	// Do-it-yourself time localization.  Fun.
886
	if (strpos($timestring, '&#37;p') !== false)
887
		$timestring = str_replace('&#37;p', (strftime('%H', $log_time) < 12 ? $txt['time_am'] : $txt['time_pm']), $timestring);
888
	if (strpos($timestring, '#txt_') !== false)
889
	{
890
		if (strpos($timestring, '#txt_days_short_') !== false)
891
			$timestring = strtr($timestring, array(
892
				'#txt_days_short_0#' => $txt['days_short'][0],
893
				'#txt_days_short_1#' => $txt['days_short'][1],
894
				'#txt_days_short_2#' => $txt['days_short'][2],
895
				'#txt_days_short_3#' => $txt['days_short'][3],
896
				'#txt_days_short_4#' => $txt['days_short'][4],
897
				'#txt_days_short_5#' => $txt['days_short'][5],
898
				'#txt_days_short_6#' => $txt['days_short'][6],
899
			));
900
901
		if (strpos($timestring, '#txt_days_') !== false)
902
			$timestring = strtr($timestring, array(
903
				'#txt_days_0#' => $txt['days'][0],
904
				'#txt_days_1#' => $txt['days'][1],
905
				'#txt_days_2#' => $txt['days'][2],
906
				'#txt_days_3#' => $txt['days'][3],
907
				'#txt_days_4#' => $txt['days'][4],
908
				'#txt_days_5#' => $txt['days'][5],
909
				'#txt_days_6#' => $txt['days'][6],
910
			));
911
912
		if (strpos($timestring, '#txt_months_short_') !== false)
913
			$timestring = strtr($timestring, array(
914
				'#txt_months_short_01#' => $txt['months_short'][1],
915
				'#txt_months_short_02#' => $txt['months_short'][2],
916
				'#txt_months_short_03#' => $txt['months_short'][3],
917
				'#txt_months_short_04#' => $txt['months_short'][4],
918
				'#txt_months_short_05#' => $txt['months_short'][5],
919
				'#txt_months_short_06#' => $txt['months_short'][6],
920
				'#txt_months_short_07#' => $txt['months_short'][7],
921
				'#txt_months_short_08#' => $txt['months_short'][8],
922
				'#txt_months_short_09#' => $txt['months_short'][9],
923
				'#txt_months_short_10#' => $txt['months_short'][10],
924
				'#txt_months_short_11#' => $txt['months_short'][11],
925
				'#txt_months_short_12#' => $txt['months_short'][12],
926
			));
927
928
		if (strpos($timestring, '#txt_months_') !== false)
929
			$timestring = strtr($timestring, array(
930
				'#txt_months_01#' => $txt['months'][1],
931
				'#txt_months_02#' => $txt['months'][2],
932
				'#txt_months_03#' => $txt['months'][3],
933
				'#txt_months_04#' => $txt['months'][4],
934
				'#txt_months_05#' => $txt['months'][5],
935
				'#txt_months_06#' => $txt['months'][6],
936
				'#txt_months_07#' => $txt['months'][7],
937
				'#txt_months_08#' => $txt['months'][8],
938
				'#txt_months_09#' => $txt['months'][9],
939
				'#txt_months_10#' => $txt['months'][10],
940
				'#txt_months_11#' => $txt['months'][11],
941
				'#txt_months_12#' => $txt['months'][12],
942
			));
943
	}
944
945
	// Restore any literal percent characters, add the prefix, and we're done.
946
	return $prefix . str_replace('&#37;', '%', $timestring);
947
}
948
949
/**
950
 * Gets a version of a strftime() format that only shows the date or time components
951
 *
952
 * @param string $type Either 'date' or 'time'.
953
 * @param string $format A strftime() format to process. Defaults to $user_info['time_format'].
954
 * @return string A strftime() format string
955
 */
956
function get_date_or_time_format($type = '', $format = '')
957
{
958
	global $user_info, $modSettings;
959
	static $formats;
960
961
	// If the format is invalid, fall back to defaults.
962
	if (strpos($format, '%') === false)
963
		$format = !empty($user_info['time_format']) ? $user_info['time_format'] : (!empty($modSettings['time_format']) ? $modSettings['time_format'] : '%F %k:%M');
964
965
	$orig_format = $format;
966
967
	// Have we already done this?
968
	if (isset($formats[$orig_format][$type]))
969
		return $formats[$orig_format][$type];
970
971
	if ($type === 'date')
972
	{
973
		$specifications = array(
974
			// Day
975
			'%a' => '%a', '%A' => '%A', '%e' => '%e', '%d' => '%d', '%j' => '%j', '%u' => '%u', '%w' => '%w',
976
			// Week
977
			'%U' => '%U', '%V' => '%V', '%W' => '%W',
978
			// Month
979
			'%b' => '%b', '%B' => '%B', '%h' => '%h', '%m' => '%m',
980
			// Year
981
			'%C' => '%C', '%g' => '%g', '%G' => '%G', '%y' => '%y', '%Y' => '%Y',
982
			// Time
983
			'%H' => '', '%k' => '', '%I' => '', '%l' => '', '%M' => '', '%p' => '', '%P' => '',
984
			'%r' => '', '%R' => '', '%S' => '', '%T' => '', '%X' => '', '%z' => '', '%Z' => '',
985
			// Time and Date Stamps
986
			'%c' => '%x', '%D' => '%D', '%F' => '%F', '%s' => '%s', '%x' => '%x',
987
			// Miscellaneous
988
			'%n' => '', '%t' => '', '%%' => '%%',
989
		);
990
991
		$default_format = '%F';
992
	}
993
	elseif ($type === 'time')
994
	{
995
		$specifications = array(
996
			// Day
997
			'%a' => '', '%A' => '', '%e' => '', '%d' => '', '%j' => '', '%u' => '', '%w' => '',
998
			// Week
999
			'%U' => '', '%V' => '', '%W' => '',
1000
			// Month
1001
			'%b' => '', '%B' => '', '%h' => '', '%m' => '',
1002
			// Year
1003
			'%C' => '', '%g' => '', '%G' => '', '%y' => '', '%Y' => '',
1004
			// Time
1005
			'%H' => '%H', '%k' => '%k', '%I' => '%I', '%l' => '%l', '%M' => '%M', '%p' => '%p', '%P' => '%P',
1006
			'%r' => '%r', '%R' => '%R', '%S' => '%S', '%T' => '%T', '%X' => '%X', '%z' => '%z', '%Z' => '%Z',
1007
			// Time and Date Stamps
1008
			'%c' => '%X', '%D' => '', '%F' => '', '%s' => '%s', '%x' => '',
1009
			// Miscellaneous
1010
			'%n' => '', '%t' => '', '%%' => '%%',
1011
		);
1012
1013
		$default_format = '%k:%M';
1014
	}
1015
	// Invalid type requests just get the full format string.
1016
	else
1017
		return $format;
1018
1019
	// Separate the specifications we want from the ones we don't.
1020
	$wanted = array_filter($specifications);
1021
	$unwanted = array_diff(array_keys($specifications), $wanted);
1022
1023
	// First, make any necessary substitutions in the format.
1024
	$format = strtr($format, $wanted);
1025
1026
	// Next, strip out any specifications and literal text that we don't want.
1027
	$format_parts = preg_split('~%[' . (strtr(implode('', $unwanted), array('%' => ''))) . ']~u', $format);
1028
1029
	foreach ($format_parts as $p => $f)
1030
	{
1031
		if (strpos($f, '%') === false)
1032
			unset($format_parts[$p]);
1033
	}
1034
1035
	$format = implode('', $format_parts);
1036
1037
	// Finally, strip out any unwanted leftovers.
1038
	// For info on the charcter classes used here, see https://www.php.net/manual/en/regexp.reference.unicode.php and https://www.regular-expressions.info/unicode.html
1039
	$format = preg_replace(
1040
		array(
1041
			// Anything that isn't a specification, punctuation mark, or whitespace.
1042
			'~(?<!%)\p{L}|[^\p{L}\p{P}\s]~u',
1043
			// A series of punctuation marks (except %), possibly separated by whitespace.
1044
			'~([^%\P{P}])(\s*)(?'.'>(\1|[^%\P{Po}])\s*(?!$))*~u',
1045
			// Unwanted trailing punctuation and whitespace.
1046
			'~(?'.'>([\p{Pd}\p{Ps}\p{Pi}\p{Pc}]|[^%\P{Po}])\s*)*$~u',
1047
			// Unwanted opening punctuation and whitespace.
1048
			'~^\s*(?'.'>([\p{Pd}\p{Pe}\p{Pf}\p{Pc}]|[^%\P{Po}])\s*)*~u',
1049
		),
1050
		array(
1051
			'',
1052
			'$1$2',
1053
			'',
1054
			'',
1055
		),
1056
		$format
1057
	);
1058
1059
	// Gotta have something...
1060
	if (empty($format))
1061
		$format = $default_format;
1062
1063
	// Remember what we've done.
1064
	$formats[$orig_format][$type] = trim($format);
1065
1066
	return $formats[$orig_format][$type];
1067
}
1068
1069
/**
1070
 * Replaces special entities in strings with the real characters.
1071
 *
1072
 * Functionally equivalent to htmlspecialchars_decode(), except that this also
1073
 * replaces '&nbsp;' with a simple space character.
1074
 *
1075
 * @param string $string A string
1076
 * @return string The string without entities
1077
 */
1078
function un_htmlspecialchars($string)
1079
{
1080
	global $context;
1081
	static $translation = array();
1082
1083
	// Determine the character set... Default to UTF-8
1084
	if (empty($context['character_set']))
1085
		$charset = 'UTF-8';
1086
	// Use ISO-8859-1 in place of non-supported ISO-8859 charsets...
1087
	elseif (strpos($context['character_set'], 'ISO-8859-') !== false && !in_array($context['character_set'], array('ISO-8859-5', 'ISO-8859-15')))
1088
		$charset = 'ISO-8859-1';
1089
	else
1090
		$charset = $context['character_set'];
1091
1092
	if (empty($translation))
1093
		$translation = array_flip(get_html_translation_table(HTML_SPECIALCHARS, ENT_QUOTES, $charset)) + array('&#039;' => '\'', '&#39;' => '\'', '&nbsp;' => ' ');
1094
1095
	return strtr($string, $translation);
1096
}
1097
1098
/**
1099
 * Shorten a subject + internationalization concerns.
1100
 *
1101
 * - shortens a subject so that it is either shorter than length, or that length plus an ellipsis.
1102
 * - respects internationalization characters and entities as one character.
1103
 * - avoids trailing entities.
1104
 * - returns the shortened string.
1105
 *
1106
 * @param string $subject The subject
1107
 * @param int $len How many characters to limit it to
1108
 * @return string The shortened subject - either the entire subject (if it's <= $len) or the subject shortened to $len characters with "..." appended
1109
 */
1110
function shorten_subject($subject, $len)
1111
{
1112
	global $smcFunc;
1113
1114
	// It was already short enough!
1115
	if ($smcFunc['strlen']($subject) <= $len)
1116
		return $subject;
1117
1118
	// Shorten it by the length it was too long, and strip off junk from the end.
1119
	return $smcFunc['substr']($subject, 0, $len) . '...';
1120
}
1121
1122
/**
1123
 * Gets the current time with offset.
1124
 *
1125
 * - always applies the offset in the time_offset setting.
1126
 *
1127
 * @param bool $use_user_offset Whether to apply the user's offset as well
1128
 * @param int $timestamp A timestamp (null to use current time)
1129
 * @return int Seconds since the unix epoch, with forum time offset and (optionally) user time offset applied
1130
 */
1131
function forum_time($use_user_offset = true, $timestamp = null)
1132
{
1133
	global $user_info, $modSettings;
1134
1135
	// Ensure required values are set
1136
	$modSettings['time_offset'] = !empty($modSettings['time_offset']) ? $modSettings['time_offset'] : 0;
1137
	$user_info['time_offset'] = !empty($user_info['time_offset']) ? $user_info['time_offset'] : 0;
1138
1139
	if ($timestamp === null)
1140
		$timestamp = time();
1141
	elseif ($timestamp == 0)
1142
		return 0;
1143
1144
	return $timestamp + ($modSettings['time_offset'] + ($use_user_offset ? $user_info['time_offset'] : 0)) * 3600;
1145
}
1146
1147
/**
1148
 * Calculates all the possible permutations (orders) of array.
1149
 * should not be called on huge arrays (bigger than like 10 elements.)
1150
 * returns an array containing each permutation.
1151
 *
1152
 * @deprecated since 2.1
1153
 * @param array $array An array
1154
 * @return array An array containing each permutation
1155
 */
1156
function permute($array)
1157
{
1158
	$orders = array($array);
1159
1160
	$n = count($array);
1161
	$p = range(0, $n);
1162
	for ($i = 1; $i < $n; null)
1163
	{
1164
		$p[$i]--;
1165
		$j = $i % 2 != 0 ? $p[$i] : 0;
1166
1167
		$temp = $array[$i];
1168
		$array[$i] = $array[$j];
1169
		$array[$j] = $temp;
1170
1171
		for ($i = 1; $p[$i] == 0; $i++)
1172
			$p[$i] = 1;
1173
1174
		$orders[] = $array;
1175
	}
1176
1177
	return $orders;
1178
}
1179
1180
/**
1181
 * Parse bulletin board code in a string, as well as smileys optionally.
1182
 *
1183
 * - only parses bbc tags which are not disabled in disabledBBC.
1184
 * - handles basic HTML, if enablePostHTML is on.
1185
 * - caches the from/to replace regular expressions so as not to reload them every time a string is parsed.
1186
 * - only parses smileys if smileys is true.
1187
 * - does nothing if the enableBBC setting is off.
1188
 * - uses the cache_id as a unique identifier to facilitate any caching it may do.
1189
 * - returns the modified message.
1190
 *
1191
 * @param string|bool $message The message.
1192
 *		When a empty string, nothing is done.
1193
 *		When false we provide a list of BBC codes available.
1194
 *		When a string, the message is parsed and bbc handled.
1195
 * @param bool $smileys Whether to parse smileys as well
1196
 * @param string $cache_id The cache ID
1197
 * @param array $parse_tags If set, only parses these tags rather than all of them
1198
 * @return string The parsed message
1199
 */
1200
function parse_bbc($message, $smileys = true, $cache_id = '', $parse_tags = array())
1201
{
1202
	global $smcFunc, $txt, $scripturl, $context, $modSettings, $user_info, $sourcedir, $cache_enable;
1203
	static $bbc_lang_locales = array(), $itemcodes = array(), $no_autolink_tags = array();
1204
	static $disabled, $alltags_regex = '', $param_regexes = array(), $url_regex = '';
1205
1206
	// Don't waste cycles
1207
	if ($message === '')
1208
		return '';
1209
1210
	// Just in case it wasn't determined yet whether UTF-8 is enabled.
1211
	if (!isset($context['utf8']))
1212
		$context['utf8'] = (empty($modSettings['global_character_set']) ? $txt['lang_character_set'] : $modSettings['global_character_set']) === 'UTF-8';
1213
1214
	// Clean up any cut/paste issues we may have
1215
	$message = sanitizeMSCutPaste($message);
1216
1217
	// If the load average is too high, don't parse the BBC.
1218
	if (!empty($context['load_average']) && !empty($modSettings['bbc']) && $context['load_average'] >= $modSettings['bbc'])
1219
	{
1220
		$context['disabled_parse_bbc'] = true;
1221
		return $message;
1222
	}
1223
1224
	if ($smileys !== null && ($smileys == '1' || $smileys == '0'))
1225
		$smileys = (bool) $smileys;
1226
1227
	if (empty($modSettings['enableBBC']) && $message !== false)
1228
	{
1229
		if ($smileys === true)
1230
			parsesmileys($message);
1231
1232
		return $message;
1233
	}
1234
1235
	// If we already have a version of the BBCodes for the current language, use that. Otherwise, make one.
1236
	if (!empty($bbc_lang_locales[$txt['lang_locale']]))
1237
		$bbc_codes = $bbc_lang_locales[$txt['lang_locale']];
1238
	else
1239
		$bbc_codes = array();
1240
1241
	// If we are not doing every tag then we don't cache this run.
1242
	if (!empty($parse_tags))
1243
		$bbc_codes = array();
1244
1245
	// Ensure $modSettings['tld_regex'] contains a valid regex for the autolinker
1246
	if (!empty($modSettings['autoLinkUrls']))
1247
		set_tld_regex();
1248
1249
	// Allow mods access before entering the main parse_bbc loop
1250
	call_integration_hook('integrate_pre_parsebbc', array(&$message, &$smileys, &$cache_id, &$parse_tags));
1251
1252
	// Sift out the bbc for a performance improvement.
1253
	if (empty($bbc_codes) || $message === false || !empty($parse_tags))
1254
	{
1255
		if (!empty($modSettings['disabledBBC']))
1256
		{
1257
			$disabled = array();
1258
1259
			$temp = explode(',', strtolower($modSettings['disabledBBC']));
1260
1261
			foreach ($temp as $tag)
1262
				$disabled[trim($tag)] = true;
1263
1264
			if (in_array('color', $disabled))
1265
				$disabled = array_merge($disabled, array(
1266
					'black' => true,
1267
					'white' => true,
1268
					'red' => true,
1269
					'green' => true,
1270
					'blue' => true,
1271
					)
1272
				);
1273
		}
1274
1275
		// The YouTube bbc needs this for its origin parameter
1276
		$scripturl_parts = parse_url($scripturl);
1277
		$hosturl = $scripturl_parts['scheme'] . '://' . $scripturl_parts['host'];
1278
1279
		/* The following bbc are formatted as an array, with keys as follows:
1280
1281
			tag: the tag's name - should be lowercase!
1282
1283
			type: one of...
1284
				- (missing): [tag]parsed content[/tag]
1285
				- unparsed_equals: [tag=xyz]parsed content[/tag]
1286
				- parsed_equals: [tag=parsed data]parsed content[/tag]
1287
				- unparsed_content: [tag]unparsed content[/tag]
1288
				- closed: [tag], [tag/], [tag /]
1289
				- unparsed_commas: [tag=1,2,3]parsed content[/tag]
1290
				- unparsed_commas_content: [tag=1,2,3]unparsed content[/tag]
1291
				- unparsed_equals_content: [tag=...]unparsed content[/tag]
1292
1293
			parameters: an optional array of parameters, for the form
1294
			  [tag abc=123]content[/tag].  The array is an associative array
1295
			  where the keys are the parameter names, and the values are an
1296
			  array which may contain the following:
1297
				- match: a regular expression to validate and match the value.
1298
				- quoted: true if the value should be quoted.
1299
				- validate: callback to evaluate on the data, which is $data.
1300
				- value: a string in which to replace $1 with the data.
1301
					Either value or validate may be used, not both.
1302
				- optional: true if the parameter is optional.
1303
				- default: a default value for missing optional parameters.
1304
1305
			test: a regular expression to test immediately after the tag's
1306
			  '=', ' ' or ']'.  Typically, should have a \] at the end.
1307
			  Optional.
1308
1309
			content: only available for unparsed_content, closed,
1310
			  unparsed_commas_content, and unparsed_equals_content.
1311
			  $1 is replaced with the content of the tag.  Parameters
1312
			  are replaced in the form {param}.  For unparsed_commas_content,
1313
			  $2, $3, ..., $n are replaced.
1314
1315
			before: only when content is not used, to go before any
1316
			  content.  For unparsed_equals, $1 is replaced with the value.
1317
			  For unparsed_commas, $1, $2, ..., $n are replaced.
1318
1319
			after: similar to before in every way, except that it is used
1320
			  when the tag is closed.
1321
1322
			disabled_content: used in place of content when the tag is
1323
			  disabled.  For closed, default is '', otherwise it is '$1' if
1324
			  block_level is false, '<div>$1</div>' elsewise.
1325
1326
			disabled_before: used in place of before when disabled.  Defaults
1327
			  to '<div>' if block_level, '' if not.
1328
1329
			disabled_after: used in place of after when disabled.  Defaults
1330
			  to '</div>' if block_level, '' if not.
1331
1332
			block_level: set to true the tag is a "block level" tag, similar
1333
			  to HTML.  Block level tags cannot be nested inside tags that are
1334
			  not block level, and will not be implicitly closed as easily.
1335
			  One break following a block level tag may also be removed.
1336
1337
			trim: if set, and 'inside' whitespace after the begin tag will be
1338
			  removed.  If set to 'outside', whitespace after the end tag will
1339
			  meet the same fate.
1340
1341
			validate: except when type is missing or 'closed', a callback to
1342
			  validate the data as $data.  Depending on the tag's type, $data
1343
			  may be a string or an array of strings (corresponding to the
1344
			  replacement.)
1345
1346
			quoted: when type is 'unparsed_equals' or 'parsed_equals' only,
1347
			  may be not set, 'optional', or 'required' corresponding to if
1348
			  the content may be quoted.  This allows the parser to read
1349
			  [tag="abc]def[esdf]"] properly.
1350
1351
			require_parents: an array of tag names, or not set.  If set, the
1352
			  enclosing tag *must* be one of the listed tags, or parsing won't
1353
			  occur.
1354
1355
			require_children: similar to require_parents, if set children
1356
			  won't be parsed if they are not in the list.
1357
1358
			disallow_children: similar to, but very different from,
1359
			  require_children, if it is set the listed tags will not be
1360
			  parsed inside the tag.
1361
1362
			parsed_tags_allowed: an array restricting what BBC can be in the
1363
			  parsed_equals parameter, if desired.
1364
		*/
1365
1366
		$codes = array(
1367
			array(
1368
				'tag' => 'abbr',
1369
				'type' => 'unparsed_equals',
1370
				'before' => '<abbr title="$1">',
1371
				'after' => '</abbr>',
1372
				'quoted' => 'optional',
1373
				'disabled_after' => ' ($1)',
1374
			),
1375
			// Legacy (and just an alias for [abbr] even when enabled)
1376
			array(
1377
				'tag' => 'acronym',
1378
				'type' => 'unparsed_equals',
1379
				'before' => '<abbr title="$1">',
1380
				'after' => '</abbr>',
1381
				'quoted' => 'optional',
1382
				'disabled_after' => ' ($1)',
1383
			),
1384
			array(
1385
				'tag' => 'anchor',
1386
				'type' => 'unparsed_equals',
1387
				'test' => '[#]?([A-Za-z][A-Za-z0-9_\-]*)\]',
1388
				'before' => '<span id="post_$1">',
1389
				'after' => '</span>',
1390
			),
1391
			array(
1392
				'tag' => 'attach',
1393
				'type' => 'unparsed_content',
1394
				'parameters' => array(
1395
					'id' => array('match' => '(\d+)'),
1396
					'alt' => array('optional' => true),
1397
					'width' => array('optional' => true, 'match' => '(\d+)'),
1398
					'height' => array('optional' => true, 'match' => '(\d+)'),
1399
					'display' => array('optional' => true, 'match' => '(link|embed)'),
1400
				),
1401
				'content' => '$1',
1402
				'validate' => function(&$tag, &$data, $disabled, $params) use ($modSettings, $context, $sourcedir, $txt, $smcFunc)
0 ignored issues
show
Unused Code introduced by
The import $context is not used and could be removed.

This check looks for imports that have been defined, but are not used in the scope.

Loading history...
1403
				{
1404
					$returnContext = '';
1405
1406
					// BBC or the entire attachments feature is disabled
1407
					if (empty($modSettings['attachmentEnable']) || !empty($disabled['attach']))
1408
						return $data;
1409
1410
					// Save the attach ID.
1411
					$attachID = $params['{id}'];
1412
1413
					// Kinda need this.
1414
					require_once($sourcedir . '/Subs-Attachments.php');
1415
1416
					$currentAttachment = parseAttachBBC($attachID);
1417
1418
					// parseAttachBBC will return a string ($txt key) rather than dying with a fatal_error. Up to you to decide what to do.
1419
					if (is_string($currentAttachment))
1420
						return $data = !empty($txt[$currentAttachment]) ? $txt[$currentAttachment] : $currentAttachment;
1421
1422
					// We need a display mode.
1423
					if (empty($params['{display}']))
1424
					{
1425
						// Images, video, and audio are embedded by default.
1426
						if (!empty($currentAttachment['is_image']) || strpos($currentAttachment['mime_type'], 'video/') === 0 || strpos($currentAttachment['mime_type'], 'audio/') === 0)
1427
							$params['{display}'] = 'embed';
1428
						// Anything else shows a link by default.
1429
						else
1430
							$params['{display}'] = 'link';
1431
					}
1432
1433
					// Embedded file.
1434
					if ($params['{display}'] == 'embed')
1435
					{
1436
						$alt = ' alt="' . (!empty($params['{alt}']) ? $params['{alt}'] : $currentAttachment['name']) . '"';
1437
						$title = !empty($data) ? ' title="' . $smcFunc['htmlspecialchars']($data) . '"' : '';
1438
1439
						// Image.
1440
						if (!empty($currentAttachment['is_image']))
1441
						{
1442
							if (empty($params['{width}']) && empty($params['{height}']))
1443
								$returnContext .= '<img src="' . $currentAttachment['href'] . '"' . $alt . $title . ' class="bbc_img"></a>';
1444
							else
1445
							{
1446
								$width = !empty($params['{width}']) ? ' width="' . $params['{width}'] . '"': '';
1447
								$height = !empty($params['{height}']) ? 'height="' . $params['{height}'] . '"' : '';
1448
								$returnContext .= '<img src="' . $currentAttachment['href'] . ';image"' . $alt . $title . $width . $height . ' class="bbc_img resized"/>';
1449
							}
1450
						}
1451
						// Video.
1452
						elseif (strpos($currentAttachment['mime_type'], 'video/') === 0)
1453
						{
1454
							$width = !empty($width) ? ' width="' . $width . '"' : '';
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable $width seems to never exist and therefore empty should always be true.
Loading history...
1455
							$height = !empty($height) ? ' height="' . $height . '"' : '';
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable $height seems to never exist and therefore empty should always be true.
Loading history...
1456
1457
							$returnContext .= '<div class="videocontainer"><video controls preload="metadata" src="'. $currentAttachment['href'] . '" playsinline' . $width . $height . '><a href="' . $currentAttachment['href'] . '" class="bbc_link">' . $smcFunc['htmlspecialchars'](!empty($data) ? $data : $currentAttachment['name']) . '</a></video></div>' . (!empty($data) && $data != $currentAttachment['name'] ? '<div class="smalltext">' . $data . '</div>' : '');
1458
						}
1459
						// Audio.
1460
						elseif (strpos($currentAttachment['mime_type'], 'audio/') === 0)
1461
						{
1462
							$width = 'max-width:100%; width: ' . (!empty($width) ? $width : '400') . 'px;';
1463
							$height = !empty($height) ? 'height: ' . $height . 'px;' : '';
1464
1465
							$returnContext .= (!empty($data) && $data != $currentAttachment['name'] ? $data . ' ' : '') . '<audio controls preload="none" src="'. $currentAttachment['href'] . '" class="bbc_audio" style="vertical-align:middle;' . $width . $height . '"><a href="' . $currentAttachment['href'] . '" class="bbc_link">' . $smcFunc['htmlspecialchars'](!empty($data) ? $data : $currentAttachment['name']) . '</a></audio>';
1466
						}
1467
						// Anything else.
1468
						else
1469
						{
1470
							$width = !empty($width) ? ' width="' . $width . '"' : '';
1471
							$height = !empty($height) ? ' height="' . $height . '"' : '';
1472
1473
							$returnContext .= '<object type="' . $currentAttachment['mime_type'] . '" data="' . $currentAttachment['href'] . '"' . $width . $height . ' typemustmatch><a href="' . $currentAttachment['href'] . '" class="bbc_link">' . $smcFunc['htmlspecialchars'](!empty($data) ? $data : $currentAttachment['name']) . '</a></object>';
1474
						}
1475
					}
1476
1477
					// No image. Show a link.
1478
					else
1479
						$returnContext .= '<a href="' . $currentAttachment['href'] . '" class="bbc_link">' . $smcFunc['htmlspecialchars'](!empty($data) ? $data : $currentAttachment['name']) . '</a>';
1480
1481
					// Use this hook to adjust the HTML output of the attach BBCode.
1482
					// If you want to work with the attachment data itself, use one of these:
1483
					// - integrate_pre_parseAttachBBC
1484
					// - integrate_post_parseAttachBBC
1485
					call_integration_hook('integrate_attach_bbc_validate', array(&$returnContext, $currentAttachment, $tag, $data, $disabled, $params));
1486
1487
					// Gotta append what we just did.
1488
					$data = $returnContext;
1489
				},
1490
			),
1491
			array(
1492
				'tag' => 'b',
1493
				'before' => '<b>',
1494
				'after' => '</b>',
1495
			),
1496
			// Legacy (equivalent to [ltr] or [rtl])
1497
			array(
1498
				'tag' => 'bdo',
1499
				'type' => 'unparsed_equals',
1500
				'before' => '<bdo dir="$1">',
1501
				'after' => '</bdo>',
1502
				'test' => '(rtl|ltr)\]',
1503
				'block_level' => true,
1504
			),
1505
			// Legacy (alias of [color=black])
1506
			array(
1507
				'tag' => 'black',
1508
				'before' => '<span style="color: black;" class="bbc_color">',
1509
				'after' => '</span>',
1510
			),
1511
			// Legacy (alias of [color=blue])
1512
			array(
1513
				'tag' => 'blue',
1514
				'before' => '<span style="color: blue;" class="bbc_color">',
1515
				'after' => '</span>',
1516
			),
1517
			array(
1518
				'tag' => 'br',
1519
				'type' => 'closed',
1520
				'content' => '<br>',
1521
			),
1522
			array(
1523
				'tag' => 'center',
1524
				'before' => '<div class="centertext">',
1525
				'after' => '</div>',
1526
				'block_level' => true,
1527
			),
1528
			array(
1529
				'tag' => 'code',
1530
				'type' => 'unparsed_content',
1531
				'content' => '<div class="codeheader"><span class="code floatleft">' . $txt['code'] . '</span> <a class="codeoperation smf_select_text">' . $txt['code_select'] . '</a> <a class="codeoperation smf_expand_code hidden" data-shrink-txt="' . $txt['code_shrink'] . '" data-expand-txt="' . $txt['code_expand'] . '">' . $txt['code_expand'] . '</a></div><code class="bbc_code">$1</code>',
1532
				// @todo Maybe this can be simplified?
1533
				'validate' => isset($disabled['code']) ? null : function(&$tag, &$data, $disabled) use ($context)
1534
				{
1535
					if (!isset($disabled['code']))
1536
					{
1537
						$php_parts = preg_split('~(&lt;\?php|\?&gt;)~', $data, -1, PREG_SPLIT_DELIM_CAPTURE);
1538
1539
						for ($php_i = 0, $php_n = count($php_parts); $php_i < $php_n; $php_i++)
1540
						{
1541
							// Do PHP code coloring?
1542
							if ($php_parts[$php_i] != '&lt;?php')
1543
								continue;
1544
1545
							$php_string = '';
1546
							while ($php_i + 1 < count($php_parts) && $php_parts[$php_i] != '?&gt;')
1547
							{
1548
								$php_string .= $php_parts[$php_i];
1549
								$php_parts[$php_i++] = '';
1550
							}
1551
							$php_parts[$php_i] = highlight_php_code($php_string . $php_parts[$php_i]);
1552
						}
1553
1554
						// Fix the PHP code stuff...
1555
						$data = str_replace("<pre style=\"display: inline;\">\t</pre>", "\t", implode('', $php_parts));
1556
						$data = str_replace("\t", "<span style=\"white-space: pre;\">\t</span>", $data);
1557
1558
						// Recent Opera bug requiring temporary fix. &nsbp; is needed before </code> to avoid broken selection.
1559
						if (!empty($context['browser']['is_opera']))
1560
							$data .= '&nbsp;';
1561
					}
1562
				},
1563
				'block_level' => true,
1564
			),
1565
			array(
1566
				'tag' => 'code',
1567
				'type' => 'unparsed_equals_content',
1568
				'content' => '<div class="codeheader"><span class="code floatleft">' . $txt['code'] . '</span> ($2) <a class="codeoperation smf_select_text">' . $txt['code_select'] . '</a> <a class="codeoperation smf_expand_code hidden" data-shrink-txt="' . $txt['code_shrink'] . '" data-expand-txt="' . $txt['code_expand'] . '">' . $txt['code_expand'] . '</a></div><code class="bbc_code">$1</code>',
1569
				// @todo Maybe this can be simplified?
1570
				'validate' => isset($disabled['code']) ? null : function(&$tag, &$data, $disabled) use ($context)
1571
				{
1572
					if (!isset($disabled['code']))
1573
					{
1574
						$php_parts = preg_split('~(&lt;\?php|\?&gt;)~', $data[0], -1, PREG_SPLIT_DELIM_CAPTURE);
1575
1576
						for ($php_i = 0, $php_n = count($php_parts); $php_i < $php_n; $php_i++)
1577
						{
1578
							// Do PHP code coloring?
1579
							if ($php_parts[$php_i] != '&lt;?php')
1580
								continue;
1581
1582
							$php_string = '';
1583
							while ($php_i + 1 < count($php_parts) && $php_parts[$php_i] != '?&gt;')
1584
							{
1585
								$php_string .= $php_parts[$php_i];
1586
								$php_parts[$php_i++] = '';
1587
							}
1588
							$php_parts[$php_i] = highlight_php_code($php_string . $php_parts[$php_i]);
1589
						}
1590
1591
						// Fix the PHP code stuff...
1592
						$data[0] = str_replace("<pre style=\"display: inline;\">\t</pre>", "\t", implode('', $php_parts));
1593
						$data[0] = str_replace("\t", "<span style=\"white-space: pre;\">\t</span>", $data[0]);
1594
1595
						// Recent Opera bug requiring temporary fix. &nsbp; is needed before </code> to avoid broken selection.
1596
						if (!empty($context['browser']['is_opera']))
1597
							$data[0] .= '&nbsp;';
1598
					}
1599
				},
1600
				'block_level' => true,
1601
			),
1602
			array(
1603
				'tag' => 'color',
1604
				'type' => 'unparsed_equals',
1605
				'test' => '(#[\da-fA-F]{3}|#[\da-fA-F]{6}|[A-Za-z]{1,20}|rgb\((?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\s?,\s?){2}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\))\]',
1606
				'before' => '<span style="color: $1;" class="bbc_color">',
1607
				'after' => '</span>',
1608
			),
1609
			array(
1610
				'tag' => 'email',
1611
				'type' => 'unparsed_content',
1612
				'content' => '<a href="mailto:$1" class="bbc_email">$1</a>',
1613
				// @todo Should this respect guest_hideContacts?
1614
				'validate' => function(&$tag, &$data, $disabled)
1615
				{
1616
					$data = strtr($data, array('<br>' => ''));
1617
				},
1618
			),
1619
			array(
1620
				'tag' => 'email',
1621
				'type' => 'unparsed_equals',
1622
				'before' => '<a href="mailto:$1" class="bbc_email">',
1623
				'after' => '</a>',
1624
				// @todo Should this respect guest_hideContacts?
1625
				'disallow_children' => array('email', 'ftp', 'url', 'iurl'),
1626
				'disabled_after' => ' ($1)',
1627
			),
1628
			// Legacy (and just a link even when not disabled)
1629
			array(
1630
				'tag' => 'flash',
1631
				'type' => 'unparsed_commas_content',
1632
				'test' => '\d+,\d+\]',
1633
				'content' => '<a href="$1" target="_blank" rel="noopener">$1</a>',
1634
				'validate' => function (&$tag, &$data, $disabled)
1635
				{
1636
					$scheme = parse_url($data[0], PHP_URL_SCHEME);
1637
					if (empty($scheme))
1638
						$data[0] = '//' . ltrim($data[0], ':/');
1639
				},
1640
			),
1641
			array(
1642
				'tag' => 'float',
1643
				'type' => 'unparsed_equals',
1644
				'test' => '(left|right)(\s+max=\d+(?:%|px|em|rem|ex|pt|pc|ch|vw|vh|vmin|vmax|cm|mm|in)?)?\]',
1645
				'before' => '<div $1>',
1646
				'after' => '</div>',
1647
				'validate' => function(&$tag, &$data, $disabled)
1648
				{
1649
					$class = 'class="bbc_float float' . (strpos($data, 'left') === 0 ? 'left' : 'right') . '"';
1650
1651
					if (preg_match('~\bmax=(\d+(?:%|px|em|rem|ex|pt|pc|ch|vw|vh|vmin|vmax|cm|mm|in)?)~', $data, $matches))
1652
						$css = ' style="max-width:' . $matches[1] . (is_numeric($matches[1]) ? 'px' : '') . '"';
1653
					else
1654
						$css = '';
1655
1656
					$data = $class . $css;
1657
				},
1658
				'trim' => 'outside',
1659
				'block_level' => true,
1660
			),
1661
			// Legacy (alias of [url] with an FTP URL)
1662
			array(
1663
				'tag' => 'ftp',
1664
				'type' => 'unparsed_content',
1665
				'content' => '<a href="$1" class="bbc_link" target="_blank" rel="noopener">$1</a>',
1666
				'validate' => function(&$tag, &$data, $disabled)
1667
				{
1668
					$data = strtr($data, array('<br>' => ''));
1669
					$scheme = parse_url($data, PHP_URL_SCHEME);
1670
					if (empty($scheme))
1671
						$data = 'ftp://' . ltrim($data, ':/');
1672
				},
1673
			),
1674
			// Legacy (alias of [url] with an FTP URL)
1675
			array(
1676
				'tag' => 'ftp',
1677
				'type' => 'unparsed_equals',
1678
				'before' => '<a href="$1" class="bbc_link" target="_blank" rel="noopener">',
1679
				'after' => '</a>',
1680
				'validate' => function(&$tag, &$data, $disabled)
1681
				{
1682
					$scheme = parse_url($data, PHP_URL_SCHEME);
1683
					if (empty($scheme))
1684
						$data = 'ftp://' . ltrim($data, ':/');
1685
				},
1686
				'disallow_children' => array('email', 'ftp', 'url', 'iurl'),
1687
				'disabled_after' => ' ($1)',
1688
			),
1689
			array(
1690
				'tag' => 'font',
1691
				'type' => 'unparsed_equals',
1692
				'test' => '[A-Za-z0-9_,\-\s]+?\]',
1693
				'before' => '<span style="font-family: $1;" class="bbc_font">',
1694
				'after' => '</span>',
1695
			),
1696
			// Legacy (one of those things that should not be done)
1697
			array(
1698
				'tag' => 'glow',
1699
				'type' => 'unparsed_commas',
1700
				'test' => '[#0-9a-zA-Z\-]{3,12},([012]\d{1,2}|\d{1,2})(,[^]]+)?\]',
1701
				'before' => '<span style="text-shadow: $1 1px 1px 1px">',
1702
				'after' => '</span>',
1703
			),
1704
			// Legacy (alias of [color=green])
1705
			array(
1706
				'tag' => 'green',
1707
				'before' => '<span style="color: green;" class="bbc_color">',
1708
				'after' => '</span>',
1709
			),
1710
			array(
1711
				'tag' => 'html',
1712
				'type' => 'unparsed_content',
1713
				'content' => '<div>$1</div>',
1714
				'block_level' => true,
1715
				'disabled_content' => '$1',
1716
			),
1717
			array(
1718
				'tag' => 'hr',
1719
				'type' => 'closed',
1720
				'content' => '<hr>',
1721
				'block_level' => true,
1722
			),
1723
			array(
1724
				'tag' => 'i',
1725
				'before' => '<i>',
1726
				'after' => '</i>',
1727
			),
1728
			array(
1729
				'tag' => 'img',
1730
				'type' => 'unparsed_content',
1731
				'parameters' => array(
1732
					'alt' => array('optional' => true),
1733
					'title' => array('optional' => true),
1734
				),
1735
				'content' => '<img src="$1" alt="{alt}" title="{title}" class="bbc_img" loading="lazy">',
1736
				'validate' => function(&$tag, &$data, $disabled)
1737
				{
1738
					$data = strtr($data, array('<br>' => ''));
1739
1740
					if (parse_url($data, PHP_URL_SCHEME) === null)
1741
						$data = '//' . ltrim($data, ':/');
1742
					else
1743
						$data = get_proxied_url($data);
1744
				},
1745
				'disabled_content' => '($1)',
1746
			),
1747
			array(
1748
				'tag' => 'img',
1749
				'type' => 'unparsed_content',
1750
				'parameters' => array(
1751
					'alt' => array('optional' => true),
1752
					'title' => array('optional' => true),
1753
					'width' => array('optional' => true, 'value' => ' width="$1"', 'match' => '(\d+)'),
1754
					'height' => array('optional' => true, 'value' => ' height="$1"', 'match' => '(\d+)'),
1755
				),
1756
				'content' => '<img src="$1" alt="{alt}" title="{title}"{width}{height} class="bbc_img resized" loading="lazy">',
1757
				'validate' => function(&$tag, &$data, $disabled)
1758
				{
1759
					$data = strtr($data, array('<br>' => ''));
1760
1761
					if (parse_url($data, PHP_URL_SCHEME) === null)
1762
						$data = '//' . ltrim($data, ':/');
1763
					else
1764
						$data = get_proxied_url($data);
1765
				},
1766
				'disabled_content' => '($1)',
1767
			),
1768
			array(
1769
				'tag' => 'iurl',
1770
				'type' => 'unparsed_content',
1771
				'content' => '<a href="$1" class="bbc_link">$1</a>',
1772
				'validate' => function(&$tag, &$data, $disabled)
1773
				{
1774
					$data = strtr($data, array('<br>' => ''));
1775
					$scheme = parse_url($data, PHP_URL_SCHEME);
1776
					if (empty($scheme))
1777
						$data = '//' . ltrim($data, ':/');
1778
				},
1779
			),
1780
			array(
1781
				'tag' => 'iurl',
1782
				'type' => 'unparsed_equals',
1783
				'quoted' => 'optional',
1784
				'before' => '<a href="$1" class="bbc_link">',
1785
				'after' => '</a>',
1786
				'validate' => function(&$tag, &$data, $disabled)
1787
				{
1788
					if (substr($data, 0, 1) == '#')
1789
						$data = '#post_' . substr($data, 1);
1790
					else
1791
					{
1792
						$scheme = parse_url($data, PHP_URL_SCHEME);
1793
						if (empty($scheme))
1794
							$data = '//' . ltrim($data, ':/');
1795
					}
1796
				},
1797
				'disallow_children' => array('email', 'ftp', 'url', 'iurl'),
1798
				'disabled_after' => ' ($1)',
1799
			),
1800
			array(
1801
				'tag' => 'justify',
1802
				'before' => '<div class="justifytext">',
1803
				'after' => '</div>',
1804
				'block_level' => true,
1805
			),
1806
			array(
1807
				'tag' => 'left',
1808
				'before' => '<div class="lefttext">',
1809
				'after' => '</div>',
1810
				'block_level' => true,
1811
			),
1812
			array(
1813
				'tag' => 'li',
1814
				'before' => '<li>',
1815
				'after' => '</li>',
1816
				'trim' => 'outside',
1817
				'require_parents' => array('list'),
1818
				'block_level' => true,
1819
				'disabled_before' => '',
1820
				'disabled_after' => '<br>',
1821
			),
1822
			array(
1823
				'tag' => 'list',
1824
				'before' => '<ul class="bbc_list">',
1825
				'after' => '</ul>',
1826
				'trim' => 'inside',
1827
				'require_children' => array('li', 'list'),
1828
				'block_level' => true,
1829
			),
1830
			array(
1831
				'tag' => 'list',
1832
				'parameters' => array(
1833
					'type' => array('match' => '(none|disc|circle|square|decimal|decimal-leading-zero|lower-roman|upper-roman|lower-alpha|upper-alpha|lower-greek|upper-greek|lower-latin|upper-latin|hebrew|armenian|georgian|cjk-ideographic|hiragana|katakana|hiragana-iroha|katakana-iroha)'),
1834
				),
1835
				'before' => '<ul class="bbc_list" style="list-style-type: {type};">',
1836
				'after' => '</ul>',
1837
				'trim' => 'inside',
1838
				'require_children' => array('li'),
1839
				'block_level' => true,
1840
			),
1841
			array(
1842
				'tag' => 'ltr',
1843
				'before' => '<bdo dir="ltr">',
1844
				'after' => '</bdo>',
1845
				'block_level' => true,
1846
			),
1847
			array(
1848
				'tag' => 'me',
1849
				'type' => 'unparsed_equals',
1850
				'before' => '<div class="meaction">* $1 ',
1851
				'after' => '</div>',
1852
				'quoted' => 'optional',
1853
				'block_level' => true,
1854
				'disabled_before' => '/me ',
1855
				'disabled_after' => '<br>',
1856
			),
1857
			array(
1858
				'tag' => 'member',
1859
				'type' => 'unparsed_equals',
1860
				'before' => '<a href="' . $scripturl . '?action=profile;u=$1" class="mention" data-mention="$1">@',
1861
				'after' => '</a>',
1862
			),
1863
			// Legacy (horrible memories of the 1990s)
1864
			array(
1865
				'tag' => 'move',
1866
				'before' => '<marquee>',
1867
				'after' => '</marquee>',
1868
				'block_level' => true,
1869
				'disallow_children' => array('move'),
1870
			),
1871
			array(
1872
				'tag' => 'nobbc',
1873
				'type' => 'unparsed_content',
1874
				'content' => '$1',
1875
			),
1876
			array(
1877
				'tag' => 'php',
1878
				'type' => 'unparsed_content',
1879
				'content' => '<span class="phpcode">$1</span>',
1880
				'validate' => isset($disabled['php']) ? null : function(&$tag, &$data, $disabled)
1881
				{
1882
					if (!isset($disabled['php']))
1883
					{
1884
						$add_begin = substr(trim($data), 0, 5) != '&lt;?';
1885
						$data = highlight_php_code($add_begin ? '&lt;?php ' . $data . '?&gt;' : $data);
1886
						if ($add_begin)
1887
							$data = preg_replace(array('~^(.+?)&lt;\?.{0,40}?php(?:&nbsp;|\s)~', '~\?&gt;((?:</(font|span)>)*)$~'), '$1', $data, 2);
1888
					}
1889
				},
1890
				'block_level' => false,
1891
				'disabled_content' => '$1',
1892
			),
1893
			array(
1894
				'tag' => 'pre',
1895
				'before' => '<pre>',
1896
				'after' => '</pre>',
1897
			),
1898
			array(
1899
				'tag' => 'quote',
1900
				'before' => '<blockquote><cite>' . $txt['quote'] . '</cite>',
1901
				'after' => '</blockquote>',
1902
				'trim' => 'both',
1903
				'block_level' => true,
1904
			),
1905
			array(
1906
				'tag' => 'quote',
1907
				'parameters' => array(
1908
					'author' => array('match' => '(.{1,192}?)', 'quoted' => true),
1909
				),
1910
				'before' => '<blockquote><cite>' . $txt['quote_from'] . ': {author}</cite>',
1911
				'after' => '</blockquote>',
1912
				'trim' => 'both',
1913
				'block_level' => true,
1914
			),
1915
			array(
1916
				'tag' => 'quote',
1917
				'type' => 'parsed_equals',
1918
				'before' => '<blockquote><cite>' . $txt['quote_from'] . ': $1</cite>',
1919
				'after' => '</blockquote>',
1920
				'trim' => 'both',
1921
				'quoted' => 'optional',
1922
				// Don't allow everything to be embedded with the author name.
1923
				'parsed_tags_allowed' => array('url', 'iurl', 'ftp'),
1924
				'block_level' => true,
1925
			),
1926
			array(
1927
				'tag' => 'quote',
1928
				'parameters' => array(
1929
					'author' => array('match' => '([^<>]{1,192}?)'),
1930
					'link' => array('match' => '(?:board=\d+;)?((?:topic|threadid)=[\dmsg#\./]{1,40}(?:;start=[\dmsg#\./]{1,40})?|msg=\d+?|action=profile;u=\d+)'),
1931
					'date' => array('match' => '(\d+)', 'validate' => 'timeformat'),
1932
				),
1933
				'before' => '<blockquote><cite><a href="' . $scripturl . '?{link}">' . $txt['quote_from'] . ': {author} ' . $txt['search_on'] . ' {date}</a></cite>',
1934
				'after' => '</blockquote>',
1935
				'trim' => 'both',
1936
				'block_level' => true,
1937
			),
1938
			array(
1939
				'tag' => 'quote',
1940
				'parameters' => array(
1941
					'author' => array('match' => '(.{1,192}?)'),
1942
				),
1943
				'before' => '<blockquote><cite>' . $txt['quote_from'] . ': {author}</cite>',
1944
				'after' => '</blockquote>',
1945
				'trim' => 'both',
1946
				'block_level' => true,
1947
			),
1948
			// Legacy (alias of [color=red])
1949
			array(
1950
				'tag' => 'red',
1951
				'before' => '<span style="color: red;" class="bbc_color">',
1952
				'after' => '</span>',
1953
			),
1954
			array(
1955
				'tag' => 'right',
1956
				'before' => '<div class="righttext">',
1957
				'after' => '</div>',
1958
				'block_level' => true,
1959
			),
1960
			array(
1961
				'tag' => 'rtl',
1962
				'before' => '<bdo dir="rtl">',
1963
				'after' => '</bdo>',
1964
				'block_level' => true,
1965
			),
1966
			array(
1967
				'tag' => 's',
1968
				'before' => '<s>',
1969
				'after' => '</s>',
1970
			),
1971
			// Legacy (never a good idea)
1972
			array(
1973
				'tag' => 'shadow',
1974
				'type' => 'unparsed_commas',
1975
				'test' => '[#0-9a-zA-Z\-]{3,12},(left|right|top|bottom|[0123]\d{0,2})\]',
1976
				'before' => '<span style="text-shadow: $1 $2">',
1977
				'after' => '</span>',
1978
				'validate' => function(&$tag, &$data, $disabled)
1979
				{
1980
1981
					if ($data[1] == 'top' || (is_numeric($data[1]) && $data[1] < 50))
1982
						$data[1] = '0 -2px 1px';
1983
1984
					elseif ($data[1] == 'right' || (is_numeric($data[1]) && $data[1] < 100))
1985
						$data[1] = '2px 0 1px';
1986
1987
					elseif ($data[1] == 'bottom' || (is_numeric($data[1]) && $data[1] < 190))
1988
						$data[1] = '0 2px 1px';
1989
1990
					elseif ($data[1] == 'left' || (is_numeric($data[1]) && $data[1] < 280))
1991
						$data[1] = '-2px 0 1px';
1992
1993
					else
1994
						$data[1] = '1px 1px 1px';
1995
				},
1996
			),
1997
			array(
1998
				'tag' => 'size',
1999
				'type' => 'unparsed_equals',
2000
				'test' => '([1-9][\d]?p[xt]|small(?:er)?|large[r]?|x[x]?-(?:small|large)|medium|(0\.[1-9]|[1-9](\.[\d][\d]?)?)?em)\]',
2001
				'before' => '<span style="font-size: $1;" class="bbc_size">',
2002
				'after' => '</span>',
2003
			),
2004
			array(
2005
				'tag' => 'size',
2006
				'type' => 'unparsed_equals',
2007
				'test' => '[1-7]\]',
2008
				'before' => '<span style="font-size: $1;" class="bbc_size">',
2009
				'after' => '</span>',
2010
				'validate' => function(&$tag, &$data, $disabled)
2011
				{
2012
					$sizes = array(1 => 0.7, 2 => 1.0, 3 => 1.35, 4 => 1.45, 5 => 2.0, 6 => 2.65, 7 => 3.95);
2013
					$data = $sizes[$data] . 'em';
2014
				},
2015
			),
2016
			array(
2017
				'tag' => 'sub',
2018
				'before' => '<sub>',
2019
				'after' => '</sub>',
2020
			),
2021
			array(
2022
				'tag' => 'sup',
2023
				'before' => '<sup>',
2024
				'after' => '</sup>',
2025
			),
2026
			array(
2027
				'tag' => 'table',
2028
				'before' => '<table class="bbc_table">',
2029
				'after' => '</table>',
2030
				'trim' => 'inside',
2031
				'require_children' => array('tr'),
2032
				'block_level' => true,
2033
			),
2034
			array(
2035
				'tag' => 'td',
2036
				'before' => '<td>',
2037
				'after' => '</td>',
2038
				'require_parents' => array('tr'),
2039
				'trim' => 'outside',
2040
				'block_level' => true,
2041
				'disabled_before' => '',
2042
				'disabled_after' => '',
2043
			),
2044
			array(
2045
				'tag' => 'time',
2046
				'type' => 'unparsed_content',
2047
				'content' => '$1',
2048
				'validate' => function(&$tag, &$data, $disabled)
2049
				{
2050
					if (is_numeric($data))
2051
						$data = timeformat($data);
2052
2053
					$tag['content'] = '<span class="bbc_time">$1</span>';
2054
				},
2055
			),
2056
			array(
2057
				'tag' => 'tr',
2058
				'before' => '<tr>',
2059
				'after' => '</tr>',
2060
				'require_parents' => array('table'),
2061
				'require_children' => array('td'),
2062
				'trim' => 'both',
2063
				'block_level' => true,
2064
				'disabled_before' => '',
2065
				'disabled_after' => '',
2066
			),
2067
			// Legacy (the <tt> element is dead)
2068
			array(
2069
				'tag' => 'tt',
2070
				'before' => '<span class="monospace">',
2071
				'after' => '</span>',
2072
			),
2073
			array(
2074
				'tag' => 'u',
2075
				'before' => '<u>',
2076
				'after' => '</u>',
2077
			),
2078
			array(
2079
				'tag' => 'url',
2080
				'type' => 'unparsed_content',
2081
				'content' => '<a href="$1" class="bbc_link" target="_blank" rel="noopener">$1</a>',
2082
				'validate' => function(&$tag, &$data, $disabled)
2083
				{
2084
					$data = strtr($data, array('<br>' => ''));
2085
					$scheme = parse_url($data, PHP_URL_SCHEME);
2086
					if (empty($scheme))
2087
						$data = '//' . ltrim($data, ':/');
2088
				},
2089
			),
2090
			array(
2091
				'tag' => 'url',
2092
				'type' => 'unparsed_equals',
2093
				'quoted' => 'optional',
2094
				'before' => '<a href="$1" class="bbc_link" target="_blank" rel="noopener">',
2095
				'after' => '</a>',
2096
				'validate' => function(&$tag, &$data, $disabled)
2097
				{
2098
					$scheme = parse_url($data, PHP_URL_SCHEME);
2099
					if (empty($scheme))
2100
						$data = '//' . ltrim($data, ':/');
2101
				},
2102
				'disallow_children' => array('email', 'ftp', 'url', 'iurl'),
2103
				'disabled_after' => ' ($1)',
2104
			),
2105
			// Legacy (alias of [color=white])
2106
			array(
2107
				'tag' => 'white',
2108
				'before' => '<span style="color: white;" class="bbc_color">',
2109
				'after' => '</span>',
2110
			),
2111
			array(
2112
				'tag' => 'youtube',
2113
				'type' => 'unparsed_content',
2114
				'content' => '<div class="videocontainer"><div><iframe frameborder="0" src="https://www.youtube.com/embed/$1?origin=' . $hosturl . '&wmode=opaque" data-youtube-id="$1" allowfullscreen loading="lazy"></iframe></div></div>',
2115
				'disabled_content' => '<a href="https://www.youtube.com/watch?v=$1" target="_blank" rel="noopener">https://www.youtube.com/watch?v=$1</a>',
2116
				'block_level' => true,
2117
			),
2118
		);
2119
2120
		// Inside these tags autolink is not recommendable.
2121
		$no_autolink_tags = array(
2122
			'url',
2123
			'iurl',
2124
			'email',
2125
			'img',
2126
			'html',
2127
		);
2128
2129
		// Let mods add new BBC without hassle.
2130
		call_integration_hook('integrate_bbc_codes', array(&$codes, &$no_autolink_tags));
2131
2132
		// This is mainly for the bbc manager, so it's easy to add tags above.  Custom BBC should be added above this line.
2133
		if ($message === false)
0 ignored issues
show
introduced by
The condition $message === false is always false.
Loading history...
2134
		{
2135
			usort($codes, function($a, $b)
2136
			{
2137
				return strcmp($a['tag'], $b['tag']);
2138
			});
2139
			return $codes;
2140
		}
2141
2142
		// So the parser won't skip them.
2143
		$itemcodes = array(
2144
			'*' => 'disc',
2145
			'@' => 'disc',
2146
			'+' => 'square',
2147
			'x' => 'square',
2148
			'#' => 'square',
2149
			'o' => 'circle',
2150
			'O' => 'circle',
2151
			'0' => 'circle',
2152
		);
2153
		if (!isset($disabled['li']) && !isset($disabled['list']))
2154
		{
2155
			foreach ($itemcodes as $c => $dummy)
2156
				$bbc_codes[$c] = array();
2157
		}
2158
2159
		// Shhhh!
2160
		if (!isset($disabled['color']))
2161
		{
2162
			$codes[] = array(
2163
				'tag' => 'chrissy',
2164
				'before' => '<span style="color: #cc0099;">',
2165
				'after' => ' :-*</span>',
2166
			);
2167
			$codes[] = array(
2168
				'tag' => 'kissy',
2169
				'before' => '<span style="color: #cc0099;">',
2170
				'after' => ' :-*</span>',
2171
			);
2172
		}
2173
		$codes[] = array(
2174
			'tag' => 'cowsay',
2175
			'parameters' => array(
2176
				'e' => array('optional' => true, 'quoted' => true, 'match' => '(.*?)', 'default' => 'oo', 'validate' => function ($eyes) use ($smcFunc)
2177
					{
2178
						return $smcFunc['substr']($eyes . 'oo', 0, 2);
2179
					},
2180
				),
2181
				't' => array('optional' => true, 'quoted' => true, 'match' => '(.*?)', 'default' => '  ', 'validate' => function ($tongue) use ($smcFunc)
2182
					{
2183
						return $smcFunc['substr']($tongue . '  ', 0, 2);
2184
					},
2185
				),
2186
			),
2187
			'before' => '<pre data-e="{e}" data-t="{t}"><div>',
2188
			'after' => '</div><script>' . '$("head").append("<style>" + ' . JavaScriptEscape(base64_decode('cHJlW2RhdGEtZV1bZGF0YS10XXt3aGl0ZS1zcGFjZTpwcmUtd3JhcDtsaW5lLWhlaWdodDppbml0aWFsO31wcmVbZGF0YS1lXVtkYXRhLXRdID4gZGl2e2Rpc3BsYXk6dGFibGU7Ym9yZGVyOjFweCBzb2xpZDtib3JkZXItcmFkaXVzOjAuNWVtO3BhZGRpbmc6MWNoO21heC13aWR0aDo4MGNoO21pbi13aWR0aDoxMmNoO31wcmVbZGF0YS1lXVtkYXRhLXRdOjphZnRlcntkaXNwbGF5OmlubGluZS1ibG9jazttYXJnaW4tbGVmdDo4Y2g7bWluLXdpZHRoOjIwY2g7ZGlyZWN0aW9uOmx0cjtjb250ZW50OidcNUMgJycgJycgXl9fXlxBICcnIFw1QyAnJyAoJyBhdHRyKGRhdGEtZSkgJylcNUNfX19fX19fXEEgJycgJycgJycgKF9fKVw1QyAnJyAnJyAnJyAnJyAnJyAnJyAnJyApXDVDL1w1Q1xBICcnICcnICcnICcnICcgYXR0cihkYXRhLXQpICcgfHwtLS0tdyB8XEEgJycgJycgJycgJycgJycgJycgJycgfHwgJycgJycgJycgJycgfHwnO30=')) . ' + "</style>");' . '</script></pre>',
2189
			'block_level' => true,
2190
		);
2191
2192
		foreach ($codes as $code)
2193
		{
2194
			// Make it easier to process parameters later
2195
			if (!empty($code['parameters']))
2196
				ksort($code['parameters'], SORT_STRING);
2197
2198
			// If we are not doing every tag only do ones we are interested in.
2199
			if (empty($parse_tags) || in_array($code['tag'], $parse_tags))
2200
				$bbc_codes[substr($code['tag'], 0, 1)][] = $code;
2201
		}
2202
		$codes = null;
0 ignored issues
show
Unused Code introduced by
The assignment to $codes is dead and can be removed.
Loading history...
2203
	}
2204
2205
	// Shall we take the time to cache this?
2206
	if ($cache_id != '' && !empty($cache_enable) && (($cache_enable >= 2 && isset($message[1000])) || isset($message[2400])) && empty($parse_tags))
2207
	{
2208
		// It's likely this will change if the message is modified.
2209
		$cache_key = 'parse:' . $cache_id . '-' . md5(md5($message) . '-' . $smileys . (empty($disabled) ? '' : implode(',', array_keys($disabled))) . $smcFunc['json_encode']($context['browser']) . $txt['lang_locale'] . $user_info['time_offset'] . $user_info['time_format']);
2210
2211
		if (($temp = cache_get_data($cache_key, 240)) != null)
2212
			return $temp;
2213
2214
		$cache_t = microtime(true);
2215
	}
2216
2217
	if ($smileys === 'print')
0 ignored issues
show
introduced by
The condition $smileys === 'print' is always false.
Loading history...
2218
	{
2219
		// [glow], [shadow], and [move] can't really be printed.
2220
		$disabled['glow'] = true;
2221
		$disabled['shadow'] = true;
2222
		$disabled['move'] = true;
2223
2224
		// Colors can't well be displayed... supposed to be black and white.
2225
		$disabled['color'] = true;
2226
		$disabled['black'] = true;
2227
		$disabled['blue'] = true;
2228
		$disabled['white'] = true;
2229
		$disabled['red'] = true;
2230
		$disabled['green'] = true;
2231
		$disabled['me'] = true;
2232
2233
		// Color coding doesn't make sense.
2234
		$disabled['php'] = true;
2235
2236
		// Links are useless on paper... just show the link.
2237
		$disabled['ftp'] = true;
2238
		$disabled['url'] = true;
2239
		$disabled['iurl'] = true;
2240
		$disabled['email'] = true;
2241
		$disabled['flash'] = true;
2242
2243
		// @todo Change maybe?
2244
		if (!isset($_GET['images']))
2245
		{
2246
			$disabled['img'] = true;
2247
			$disabled['attach'] = true;
2248
		}
2249
2250
		// Maybe some custom BBC need to be disabled for printing.
2251
		call_integration_hook('integrate_bbc_print', array(&$disabled));
2252
	}
2253
2254
	$open_tags = array();
2255
	$message = strtr($message, array("\n" => '<br>'));
2256
2257
	if (!empty($parse_tags))
2258
	{
2259
		$real_alltags_regex = $alltags_regex;
2260
		$alltags_regex = '';
2261
	}
2262
	if (empty($alltags_regex))
2263
	{
2264
		$alltags = array();
2265
		foreach ($bbc_codes as $section)
2266
		{
2267
			foreach ($section as $code)
2268
				$alltags[] = $code['tag'];
2269
		}
2270
		$alltags_regex = '(?' . '>\b' . build_regex(array_unique($alltags)) . '\b|' . build_regex(array_keys($itemcodes)) . ')';
0 ignored issues
show
Bug introduced by
Are you sure build_regex(array_unique($alltags)) of type array|string can be used in concatenation? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

2270
		$alltags_regex = '(?' . '>\b' . /** @scrutinizer ignore-type */ build_regex(array_unique($alltags)) . '\b|' . build_regex(array_keys($itemcodes)) . ')';
Loading history...
Bug introduced by
Are you sure build_regex(array_keys($itemcodes)) of type array|string can be used in concatenation? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

2270
		$alltags_regex = '(?' . '>\b' . build_regex(array_unique($alltags)) . '\b|' . /** @scrutinizer ignore-type */ build_regex(array_keys($itemcodes)) . ')';
Loading history...
2271
	}
2272
2273
	$pos = -1;
2274
	while ($pos !== false)
2275
	{
2276
		$last_pos = isset($last_pos) ? max($pos, $last_pos) : $pos;
2277
		preg_match('~\[/?(?=' . $alltags_regex . ')~i', $message, $matches, PREG_OFFSET_CAPTURE, $pos + 1);
2278
		$pos = isset($matches[0][1]) ? $matches[0][1] : false;
2279
2280
		// Failsafe.
2281
		if ($pos === false || $last_pos > $pos)
2282
			$pos = strlen($message) + 1;
2283
2284
		// Can't have a one letter smiley, URL, or email! (Sorry.)
2285
		if ($last_pos < $pos - 1)
2286
		{
2287
			// Make sure the $last_pos is not negative.
2288
			$last_pos = max($last_pos, 0);
2289
2290
			// Pick a block of data to do some raw fixing on.
2291
			$data = substr($message, $last_pos, $pos - $last_pos);
2292
2293
			$placeholders = array();
2294
			$placeholders_counter = 0;
2295
			// Wrap in "private use" Unicode characters to ensure there will be no conflicts.
2296
			$placeholder_template = html_entity_decode('&#xE03C;') . '%1$s' . html_entity_decode('&#xE03E;');
2297
2298
			// Take care of some HTML!
2299
			if (!empty($modSettings['enablePostHTML']) && strpos($data, '&lt;') !== false)
2300
			{
2301
				$data = preg_replace('~&lt;a\s+href=((?:&quot;)?)((?:https?://|ftps?://|mailto:|tel:)\S+?)\\1&gt;(.*?)&lt;/a&gt;~i', '[url=&quot;$2&quot;]$3[/url]', $data);
2302
2303
				// <br> should be empty.
2304
				$empty_tags = array('br', 'hr');
2305
				foreach ($empty_tags as $tag)
2306
					$data = str_replace(array('&lt;' . $tag . '&gt;', '&lt;' . $tag . '/&gt;', '&lt;' . $tag . ' /&gt;'), '<' . $tag . '>', $data);
2307
2308
				// b, u, i, s, pre... basic tags.
2309
				$closable_tags = array('b', 'u', 'i', 's', 'em', 'ins', 'del', 'pre', 'blockquote', 'strong');
2310
				foreach ($closable_tags as $tag)
2311
				{
2312
					$diff = substr_count($data, '&lt;' . $tag . '&gt;') - substr_count($data, '&lt;/' . $tag . '&gt;');
2313
					$data = strtr($data, array('&lt;' . $tag . '&gt;' => '<' . $tag . '>', '&lt;/' . $tag . '&gt;' => '</' . $tag . '>'));
2314
2315
					if ($diff > 0)
2316
						$data = substr($data, 0, -1) . str_repeat('</' . $tag . '>', $diff) . substr($data, -1);
2317
				}
2318
2319
				// Do <img ...> - with security... action= -> action-.
2320
				preg_match_all('~&lt;img\s+src=((?:&quot;)?)((?:https?://|ftps?://)\S+?)\\1(?:\s+alt=(&quot;.*?&quot;|\S*?))?(?:\s?/)?&gt;~i', $data, $matches, PREG_PATTERN_ORDER);
2321
				if (!empty($matches[0]))
2322
				{
2323
					$replaces = array();
2324
					foreach ($matches[2] as $match => $imgtag)
2325
					{
2326
						$alt = empty($matches[3][$match]) ? '' : ' alt=' . preg_replace('~^&quot;|&quot;$~', '', $matches[3][$match]);
2327
2328
						// Remove action= from the URL - no funny business, now.
2329
						// @todo Testing this preg_match seems pointless
2330
						if (preg_match('~action(=|%3d)(?!dlattach)~i', $imgtag) != 0)
2331
							$imgtag = preg_replace('~action(?:=|%3d)(?!dlattach)~i', 'action-', $imgtag);
2332
2333
						$placeholder = sprintf($placeholder_template, ++$placeholders_counter);
2334
						$placeholders[$placeholder] = '[img' . $alt . ']' . $imgtag . '[/img]';
2335
2336
						$replaces[$matches[0][$match]] = $placeholder;
2337
					}
2338
2339
					$data = strtr($data, $replaces);
2340
				}
2341
			}
2342
2343
			if (!empty($modSettings['autoLinkUrls']))
2344
			{
2345
				// Are we inside tags that should be auto linked?
2346
				$no_autolink_area = false;
2347
				if (!empty($open_tags))
2348
				{
2349
					foreach ($open_tags as $open_tag)
2350
						if (in_array($open_tag['tag'], $no_autolink_tags))
2351
							$no_autolink_area = true;
2352
				}
2353
2354
				// Don't go backwards.
2355
				// @todo Don't think is the real solution....
2356
				$lastAutoPos = isset($lastAutoPos) ? $lastAutoPos : 0;
2357
				if ($pos < $lastAutoPos)
2358
					$no_autolink_area = true;
2359
				$lastAutoPos = $pos;
2360
2361
				if (!$no_autolink_area)
2362
				{
2363
					// An &nbsp; right after a URL can break the autolinker
2364
					if (strpos($data, '&nbsp;') !== false)
2365
					{
2366
						$placeholders[sprintf($placeholder_template, 'nbsp')] = '&nbsp;';
2367
						$data = strtr($data, array('&nbsp;' => sprintf($placeholder_template, 'nbsp')));
2368
					}
2369
2370
					// Parse any URLs
2371
					if (!isset($disabled['url']) && strpos($data, '[url') === false)
2372
					{
2373
						// Some reusable character classes
2374
						$space_chars = ($context['utf8'] ? '\p{Z}' : '\s');
2375
						$excluded_trailing_chars = '!;:.,?';
2376
						$domain_label_chars = '0-9A-Za-z\-' . ($context['utf8'] ? implode('', array(
2377
							'\x{A0}-\x{D7FF}', '\x{F900}-\x{FDCF}', '\x{FDF0}-\x{FFEF}',
2378
							'\x{10000}-\x{1FFFD}', '\x{20000}-\x{2FFFD}', '\x{30000}-\x{3FFFD}',
2379
							'\x{40000}-\x{4FFFD}', '\x{50000}-\x{5FFFD}', '\x{60000}-\x{6FFFD}',
2380
							'\x{70000}-\x{7FFFD}', '\x{80000}-\x{8FFFD}', '\x{90000}-\x{9FFFD}',
2381
							'\x{A0000}-\x{AFFFD}', '\x{B0000}-\x{BFFFD}', '\x{C0000}-\x{CFFFD}',
2382
							'\x{D0000}-\x{DFFFD}', '\x{E1000}-\x{EFFFD}',
2383
						)) : '');
2384
2385
						// Don't repeat this unnecessarily.
2386
						if (empty($url_regex))
2387
						{
2388
							// URI schemes that require some sort of special handling.
2389
							$schemes = array(
2390
								// Schemes whose URI definitions require a domain name in the
2391
								// authority (or whatever the next part of the URI is).
2392
								'need_domain' => array(
2393
									'aaa', 'aaas', 'acap', 'acct', 'afp', 'cap', 'cid', 'coap',
2394
									'coap+tcp', 'coap+ws', 'coaps', 'coaps+tcp', 'coaps+ws', 'crid',
2395
									'cvs', 'dict', 'dns', 'feed', 'fish', 'ftp', 'git', 'go',
2396
									'gopher', 'h323', 'http', 'https', 'iax', 'icap', 'im', 'imap',
2397
									'ipp', 'ipps', 'irc', 'irc6', 'ircs', 'ldap', 'ldaps', 'mailto',
2398
									'mid', 'mupdate', 'nfs', 'nntp', 'pop', 'pres', 'reload',
2399
									'rsync', 'rtsp', 'sftp', 'sieve', 'sip', 'sips', 'smb', 'snmp',
2400
									'soap.beep', 'soap.beeps', 'ssh', 'svn', 'stun', 'stuns',
2401
									'telnet', 'tftp', 'tip', 'tn3270', 'turn', 'turns', 'tv', 'udp',
2402
									'vemmi', 'vnc', 'webcal', 'ws', 'wss', 'xmlrpc.beep',
2403
									'xmlrpc.beeps', 'xmpp', 'z39.50', 'z39.50r', 'z39.50s',
2404
								),
2405
								// Schemes that allow an empty authority ("://" followed by "/")
2406
								'empty_authority' => array(
2407
									'file', 'ni', 'nih',
2408
								),
2409
								// Schemes that do not use an authority but still have a reasonable
2410
								// chance of working as clickable links.
2411
								'no_authority' => array(
2412
									'about', 'callto', 'geo', 'gg', 'leaptofrogans', 'magnet',
2413
									'mailto', 'maps', 'news', 'ni', 'nih', 'service', 'skype',
2414
									'sms', 'tel', 'tv',
2415
								),
2416
							);
2417
2418
							// In case a mod wants to control behaviour for a special URI scheme.
2419
							call_integration_hook('integrate_autolinker_schemes', array(&$schemes));
2420
2421
							// PCRE subroutines for efficiency.
2422
							$pcre_subroutines = array(
2423
								'tlds' => $modSettings['tld_regex'],
2424
								'pct' => '%[0-9A-Fa-f]{2}',
2425
								'domain_label_char' => '[' . $domain_label_chars . ']',
2426
								'not_domain_label_char' => '[^' . $domain_label_chars . ']',
2427
								'domain' => '(?:(?P>domain_label_char)+\.)+(?P>tlds)',
2428
								'no_domain' => '(?:(?P>domain_label_char)|[._\~!$&\'()*+,;=:@]|(?P>pct))+',
2429
								'scheme_need_domain' => build_regex($schemes['need_domain'], '~'),
2430
								'scheme_empty_authority' => build_regex($schemes['empty_authority'], '~'),
2431
								'scheme_no_authority' => build_regex($schemes['no_authority'], '~'),
2432
								'scheme_any' => '[A-Za-z][0-9A-Za-z+\-.]*',
2433
								'user_info' => '(?:(?P>domain_label_char)|[._\~!$&\'()*+,;=:]|(?P>pct))+',
2434
								'dec_octet' => '(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)',
2435
								'h16' => '[0-9A-Fa-f]{1,4}',
2436
								'ipv4' => '(?:\b(?:(?P>dec_octet)\.){3}(?P>dec_octet)\b)',
2437
								'ipv6' => '\[(?:' . implode('|', array(
2438
									'(?:(?P>h16):){7}(?P>h16)',
2439
									'(?:(?P>h16):){1,7}:',
2440
									'(?:(?P>h16):){1,6}(?::(?P>h16))',
2441
									'(?:(?P>h16):){1,5}(?::(?P>h16)){1,2}',
2442
									'(?:(?P>h16):){1,4}(?::(?P>h16)){1,3}',
2443
									'(?:(?P>h16):){1,3}(?::(?P>h16)){1,4}',
2444
									'(?:(?P>h16):){1,2}(?::(?P>h16)){1,5}',
2445
									'(?P>h16):(?::(?P>h16)){1,6}',
2446
									':(?:(?::(?P>h16)){1,7}|:)',
2447
									'fe80:(?::(?P>h16)){0,4}%[0-9A-Za-z]+',
2448
									'::(ffff(:0{1,4})?:)?(?P>ipv4)',
2449
									'(?:(?P>h16):){1,4}:(?P>ipv4)',
2450
								)) . ')\]',
2451
								'host' => '(?:' . implode('|', array(
2452
									'localhost',
2453
									'(?P>domain)',
2454
									'(?P>ipv4)',
2455
									'(?P>ipv6)',
2456
								)) . ')',
2457
								'authority' => '(?:(?P>user_info)@)?(?P>host)(?::\d+)?',
2458
							);
2459
2460
							// Brackets and quotation marks are problematic at the end of an IRI.
2461
							// E.g.: `http://foo.com/baz(qux)` vs. `(http://foo.com/baz_qux)`
2462
							// In the first case, the user probably intended the `)` as part of the
2463
							// IRI, but not in the second case. To account for this, we test for
2464
							// balanced pairs within the IRI.
2465
							$balanced_pairs = array(
2466
								// Brackets and parentheses
2467
								'(' => ')', '[' => ']', '{' => '}',
2468
								// Double quotation marks
2469
								'"' => '"',
2470
								html_entity_decode('&#x201C;') => html_entity_decode('&#x201D;'),
2471
								html_entity_decode('&#x201E;') => html_entity_decode('&#x201D;'),
2472
								html_entity_decode('&#x201F;') => html_entity_decode('&#x201D;'),
2473
								html_entity_decode('&#x00AB;') => html_entity_decode('&#x00BB;'),
2474
								// Single quotation marks
2475
								'\'' => '\'',
2476
								html_entity_decode('&#x2018;') => html_entity_decode('&#x2019;'),
2477
								html_entity_decode('&#x201A;') => html_entity_decode('&#x2019;'),
2478
								html_entity_decode('&#x201B;') => html_entity_decode('&#x2019;'),
2479
								html_entity_decode('&#x2039;') => html_entity_decode('&#x203A;'),
2480
							);
2481
							foreach ($balanced_pairs as $pair_opener => $pair_closer)
2482
								$balanced_pairs[$smcFunc['htmlspecialchars']($pair_opener)] = $smcFunc['htmlspecialchars']($pair_closer);
2483
2484
							$bracket_quote_chars = '';
2485
							$bracket_quote_entities = array();
2486
							foreach ($balanced_pairs as $pair_opener => $pair_closer)
2487
							{
2488
								if ($pair_opener == $pair_closer)
2489
									$pair_closer = '';
2490
2491
								foreach (array($pair_opener, $pair_closer) as $bracket_quote)
2492
								{
2493
									if (strpos($bracket_quote, '&') === false)
2494
										$bracket_quote_chars .= $bracket_quote;
2495
									else
2496
										$bracket_quote_entities[] = substr($bracket_quote, 1);
2497
								}
2498
							}
2499
							$bracket_quote_chars = str_replace(array('[', ']'), array('\[', '\]'), $bracket_quote_chars);
2500
2501
							$pcre_subroutines['bracket_quote'] = '[' . $bracket_quote_chars . ']|&' . build_regex($bracket_quote_entities, '~');
0 ignored issues
show
Bug introduced by
Are you sure build_regex($bracket_quote_entities, '~') of type array|string can be used in concatenation? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

2501
							$pcre_subroutines['bracket_quote'] = '[' . $bracket_quote_chars . ']|&' . /** @scrutinizer ignore-type */ build_regex($bracket_quote_entities, '~');
Loading history...
2502
							$pcre_subroutines['allowed_entities'] = '&(?!' . build_regex(array_merge($bracket_quote_entities, array('lt;', 'gt;')), '~') . ')';
0 ignored issues
show
Bug introduced by
Are you sure build_regex(array_merge(...ay('lt;', 'gt;')), '~') of type array|string can be used in concatenation? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

2502
							$pcre_subroutines['allowed_entities'] = '&(?!' . /** @scrutinizer ignore-type */ build_regex(array_merge($bracket_quote_entities, array('lt;', 'gt;')), '~') . ')';
Loading history...
2503
							$pcre_subroutines['excluded_lookahead'] = '(?![' . $excluded_trailing_chars . ']*(?>' . $space_chars . '|$))';
2504
2505
							foreach (array('path', 'query', 'fragment') as $part)
2506
							{
2507
								switch ($part) {
2508
									case 'path':
2509
										$part_disallowed_chars = '<>' . $bracket_quote_chars . $space_chars . $excluded_trailing_chars . '/#&';
2510
										$part_excluded_trailing_chars = str_replace('?', '', $excluded_trailing_chars);
2511
										break;
2512
2513
									case 'query':
2514
										$part_disallowed_chars = '<>' . $bracket_quote_chars . $space_chars . $excluded_trailing_chars . '#&';
2515
										$part_excluded_trailing_chars = $excluded_trailing_chars;
2516
										break;
2517
2518
									default:
2519
										$part_disallowed_chars = '<>' . $bracket_quote_chars . $space_chars . $excluded_trailing_chars . '&';
2520
										$part_excluded_trailing_chars = $excluded_trailing_chars;
2521
										break;
2522
								}
2523
								$pcre_subroutines[$part . '_allowed'] = '[^' . $part_disallowed_chars . ']|(?P>allowed_entities)|[' . $part_excluded_trailing_chars . '](?P>excluded_lookahead)';
2524
2525
								$balanced_construct_regex = array();
2526
2527
								foreach ($balanced_pairs as $pair_opener => $pair_closer)
2528
									$balanced_construct_regex[] = preg_quote($pair_opener) . '(?P>' . $part . '_recursive)*+' . preg_quote($pair_closer);
2529
2530
								$pcre_subroutines[$part . '_balanced'] = '(?:' . implode('|', $balanced_construct_regex) . ')(?P>' . $part . '_allowed)*+';
2531
								$pcre_subroutines[$part . '_recursive'] = '(?' . '>(?P>' . $part . '_allowed)|(?P>' . $part . '_balanced))';
2532
2533
								$pcre_subroutines[$part . '_segment'] =
2534
									// Allowed characters besides brackets and quotation marks
2535
									'(?P>' . $part . '_allowed)*+' .
2536
									// Brackets and quotation marks that are either...
2537
									'(?:' .
2538
										// part of a balanced construct
2539
										'(?P>' . $part . '_balanced)' .
2540
										// or
2541
										'|' .
2542
										// unpaired but not at the end
2543
										'(?P>bracket_quote)(?=(?P>' . $part . '_allowed))' .
2544
									')*+';
2545
							}
2546
2547
							// Time to build this monster!
2548
							// First, define the PCRE subroutines.
2549
							$url_regex = '(?(DEFINE)';
2550
2551
							foreach ($pcre_subroutines as $name => $subroutine)
2552
								$url_regex .= '(?<' . $name . '>' . $subroutine . ')';
0 ignored issues
show
Bug introduced by
Are you sure $subroutine of type array|mixed|string can be used in concatenation? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

2552
								$url_regex .= '(?<' . $name . '>' . /** @scrutinizer ignore-type */ $subroutine . ')';
Loading history...
2553
2554
							$url_regex .= ')';
2555
2556
							// Now build the rest of the regex
2557
							$url_regex .=
2558
							// 1. IRI scheme and domain components
2559
							'(?:' .
2560
								// 1a. IRIs with a scheme, or at least an opening "//"
2561
								'(?:' .
2562
2563
									// URI scheme (or lack thereof for schemeless URLs)
2564
									'(?:' .
2565
										// URI scheme and colon
2566
										'\b' .
2567
										'(?:' .
2568
											// Either a scheme that need a domain in the authority
2569
											// (Remember for later that we need a domain)
2570
											'(?P<need_domain>(?P>scheme_need_domain)):' .
2571
											// or
2572
											'|' .
2573
											// a scheme that allows an empty authority
2574
											// (Remember for later that the authority can be empty)
2575
											'(?P<empty_authority>(?P>scheme_empty_authority)):' .
2576
											// or
2577
											'|' .
2578
											// a scheme that uses no authority
2579
											'(?P>scheme_no_authority):(?!//)' .
2580
											// or
2581
											'|' .
2582
											// another scheme, but only if it is followed by "://"
2583
											'(?P>scheme_any):(?=//)' .
2584
										')' .
2585
2586
										// or
2587
										'|' .
2588
2589
										// An empty string followed by "//" for schemeless URLs
2590
										'(?P<schemeless>(?=//))' .
2591
									')' .
2592
2593
									// IRI authority chunk (maybe)
2594
									'(?:' .
2595
										// (Keep track of whether we find a valid authority or not)
2596
										'(?P<has_authority>' .
2597
											// 2 slashes before the authority itself
2598
											'//' .
2599
											'(?:' .
2600
												// If there was no scheme...
2601
												'(?(<schemeless>)' .
2602
													// require an authority that contains a domain.
2603
													'(?P>authority)' .
2604
2605
													// Else if a domain is needed...
2606
													'|(?(<need_domain>)' .
2607
														// require an authority with a domain.
2608
														'(?P>authority)' .
2609
2610
														// Else if an empty authority is allowed...
2611
														'|(?(<empty_authority>)' .
2612
															// then require either
2613
															'(?:' .
2614
																// empty string, followed by a "/"
2615
																'(?=/)' .
2616
																// or
2617
																'|' .
2618
																// an authority with a domain.
2619
																'(?P>authority)' .
2620
															')' .
2621
2622
															// Else just a run of IRI characters.
2623
															'|(?P>no_domain)' .
2624
														')' .
2625
													')' .
2626
												')' .
2627
											')' .
2628
											// Followed by a non-domain character or end of line
2629
											'(?=(?P>not_domain_label_char)|$)' .
2630
										')' .
2631
2632
										// or, if there is a scheme but no authority
2633
										// (e.g. "mailto:" URLs)...
2634
										'|' .
2635
2636
										// A run of IRI characters
2637
										'(?P>no_domain)' .
2638
										// If scheme needs a domain, require a dot and a TLD
2639
										'(?(<need_domain>)\.(?P>tlds))' .
2640
										// Followed by a non-domain character or end of line
2641
										'(?=(?P>not_domain_label_char)|$)' .
2642
									')' .
2643
								')' .
2644
2645
								// Or, if there is neither a scheme nor an authority...
2646
								'|' .
2647
2648
								// 1b. Naked domains
2649
								// (e.g. "example.com" in "Go to example.com for an example.")
2650
								'(?P<naked_domain>' .
2651
									// Preceded by start of line or a space
2652
									'(?<=^|<br>|[' . $space_chars . '])' .
2653
									// A domain name
2654
									'(?P>domain)' .
2655
									// Followed by a non-domain character or end of line
2656
									'(?=(?P>not_domain_label_char)|$)' .
2657
								')' .
2658
							')' .
2659
2660
							// 2. IRI path, query, and fragment components (if present)
2661
							'(?:' .
2662
								// If the IRI has an authority or is a naked domain and any of these
2663
								// components exist, the path must start with a single "/".
2664
								// Note: technically, it is valid to append a query or fragment
2665
								// directly to the authority chunk without a "/", but supporting
2666
								// that in the autolinker would produce a lot of false positives,
2667
								// so we don't.
2668
								'(?=' .
2669
									// If we found an authority above...
2670
									'(?(<has_authority>)' .
2671
										// require a "/"
2672
										'/' .
2673
										// Else if we found a naked domain above...
2674
										'|(?(<naked_domain>)' .
2675
											// require a "/"
2676
											'/' .
2677
										')' .
2678
									')' .
2679
								')' .
2680
2681
								// 2.a. Path component, if any.
2682
								'(?:' .
2683
									// Can have one or more segments
2684
									'(?:' .
2685
										// Not preceded by a "/", except in the special case of an
2686
										// empty authority immediately before the path.
2687
										'(?(<empty_authority>)' .
2688
											'(?:(?<=://)|(?<!/))' .
2689
											'|' .
2690
											'(?<!/)' .
2691
										')' .
2692
										// Initial "/"
2693
										'/' .
2694
										// Then a run of allowed path segement characters
2695
										'(?P>path_segment)*+' .
2696
									')*+' .
2697
								')' .
2698
2699
								// 2.b. Query component, if any.
2700
								'(?:' .
2701
									// Initial "?" that is not last character.
2702
									'\?' . '(?=(?P>bracket_quote)*(?P>query_allowed))' .
2703
									// Then a run of allowed query characters
2704
									'(?P>query_segment)*+' .
2705
								')?' .
2706
2707
								// 2.c. Fragment component, if any.
2708
								'(?:' .
2709
									// Initial "#" that is not last character.
2710
									'#' . '(?=(?P>bracket_quote)*(?P>fragment_allowed))' .
2711
									// Then a run of allowed fragment characters
2712
									'(?P>fragment_segment)*+' .
2713
								')?' .
2714
							')?+';
2715
						}
2716
2717
						$tmp_data = preg_replace_callback('~' . $url_regex . '~i' . ($context['utf8'] ? 'u' : ''), function($matches)
2718
						{
2719
							$url = array_shift($matches);
2720
2721
							// If this isn't a clean URL, bail out
2722
							if ($url != sanitize_iri($url))
2723
								return $url;
2724
2725
							$parsedurl = parse_url($url);
2726
2727
							if (!empty($parsedurl['scheme']) && $parsedurl['scheme'] == 'mailto')
2728
							{
2729
								$email_address = str_replace('mailto:', '', $url);
2730
								if (!isset($disabled['email']) && filter_var($parsedurl['path'], FILTER_VALIDATE_EMAIL, FILTER_FLAG_EMAIL_UNICODE) !== false)
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable $disabled seems to never exist and therefore isset should always be false.
Loading history...
2731
									return '[email=' . $email_address . ']' . $url . '[/email]';
2732
								else
2733
									return $url;
2734
							}
2735
2736
							// Are we linking a schemeless URL or naked domain name (e.g. "example.com")?
2737
							if (empty($parsedurl['scheme']))
2738
								$fullUrl = '//' . ltrim($url, ':/');
2739
							else
2740
								$fullUrl = $url;
2741
2742
							// Make sure that $fullUrl really is valid
2743
							if (validate_iri((strpos($fullUrl, '//') === 0 ? 'http:' : '') . $fullUrl) === false)
2744
								return $url;
2745
2746
							return '[url=&quot;' . str_replace(array('[', ']'), array('&#91;', '&#93;'), $fullUrl) . '&quot;]' . $url . '[/url]';
2747
						}, $data);
2748
2749
						if (!is_null($tmp_data))
2750
							$data = $tmp_data;
2751
					}
2752
2753
					// Next, emails...  Must be careful not to step on enablePostHTML logic above...
2754
					if (!isset($disabled['email']) && strpos($data, '@') !== false && strpos($data, '[email') === false && stripos($data, 'mailto:') === false)
2755
					{
2756
						// Preceded by a space or start of line
2757
						$email_regex = '(?<=^|<br>|[' . $space_chars . '])' .
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable $space_chars does not seem to be defined for all execution paths leading up to this point.
Loading history...
2758
2759
						// An email address
2760
						'[' . $domain_label_chars . '_.]{1,80}' .
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable $domain_label_chars does not seem to be defined for all execution paths leading up to this point.
Loading history...
2761
						'@' .
2762
						'[' . $domain_label_chars . '.]+' .
2763
						'\.' . $modSettings['tld_regex'] .
2764
2765
						// Followed by a non-domain character or end of line
2766
						'(?=[^' . $domain_label_chars . ']|$)';
2767
2768
						$tmp_data = preg_replace('~' . $email_regex . '~i' . ($context['utf8'] ? 'u' : ''), '[email]$0[/email]', $data);
2769
2770
						if (!is_null($tmp_data))
2771
							$data = $tmp_data;
2772
					}
2773
2774
					// Save a little memory.
2775
					unset($tmp_data);
2776
				}
2777
			}
2778
2779
			// Restore any placeholders
2780
			$data = strtr($data, $placeholders);
2781
2782
			$data = strtr($data, array("\t" => '&nbsp;&nbsp;&nbsp;'));
2783
2784
			// If it wasn't changed, no copying or other boring stuff has to happen!
2785
			if ($data != substr($message, $last_pos, $pos - $last_pos))
2786
			{
2787
				$message = substr($message, 0, $last_pos) . $data . substr($message, $pos);
2788
2789
				// Since we changed it, look again in case we added or removed a tag.  But we don't want to skip any.
2790
				$old_pos = strlen($data) + $last_pos;
2791
				$pos = strpos($message, '[', $last_pos);
2792
				$pos = $pos === false ? $old_pos : min($pos, $old_pos);
2793
			}
2794
		}
2795
2796
		// Are we there yet?  Are we there yet?
2797
		if ($pos >= strlen($message) - 1)
2798
			break;
2799
2800
		$tag_character = strtolower($message[$pos + 1]);
2801
2802
		if ($tag_character == '/' && !empty($open_tags))
2803
		{
2804
			$pos2 = strpos($message, ']', $pos + 1);
2805
			if ($pos2 == $pos + 2)
2806
				continue;
2807
2808
			$look_for = strtolower(substr($message, $pos + 2, $pos2 - $pos - 2));
2809
2810
			// A closing tag that doesn't match any open tags? Skip it.
2811
			if (!in_array($look_for, array_map(function($code)
2812
			{
2813
				return $code['tag'];
2814
			}, $open_tags)))
2815
				continue;
2816
2817
			$to_close = array();
2818
			$block_level = null;
2819
2820
			do
2821
			{
2822
				$tag = array_pop($open_tags);
2823
				if (!$tag)
2824
					break;
2825
2826
				if (!empty($tag['block_level']))
2827
				{
2828
					// Only find out if we need to.
2829
					if ($block_level === false)
2830
					{
2831
						array_push($open_tags, $tag);
2832
						break;
2833
					}
2834
2835
					// The idea is, if we are LOOKING for a block level tag, we can close them on the way.
2836
					if (strlen($look_for) > 0 && isset($bbc_codes[$look_for[0]]))
2837
					{
2838
						foreach ($bbc_codes[$look_for[0]] as $temp)
2839
							if ($temp['tag'] == $look_for)
2840
							{
2841
								$block_level = !empty($temp['block_level']);
2842
								break;
2843
							}
2844
					}
2845
2846
					if ($block_level !== true)
2847
					{
2848
						$block_level = false;
2849
						array_push($open_tags, $tag);
2850
						break;
2851
					}
2852
				}
2853
2854
				$to_close[] = $tag;
2855
			}
2856
			while ($tag['tag'] != $look_for);
2857
2858
			// Did we just eat through everything and not find it?
2859
			if ((empty($open_tags) && (empty($tag) || $tag['tag'] != $look_for)))
2860
			{
2861
				$open_tags = $to_close;
2862
				continue;
2863
			}
2864
			elseif (!empty($to_close) && $tag['tag'] != $look_for)
2865
			{
2866
				if ($block_level === null && isset($look_for[0], $bbc_codes[$look_for[0]]))
2867
				{
2868
					foreach ($bbc_codes[$look_for[0]] as $temp)
2869
						if ($temp['tag'] == $look_for)
2870
						{
2871
							$block_level = !empty($temp['block_level']);
2872
							break;
2873
						}
2874
				}
2875
2876
				// We're not looking for a block level tag (or maybe even a tag that exists...)
2877
				if (!$block_level)
0 ignored issues
show
Bug Best Practice introduced by
The expression $block_level of type boolean|null is loosely compared to false; this is ambiguous if the boolean can be false. You might want to explicitly use !== null instead.

If an expression can have both false, and null as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values.

$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
Loading history...
2878
				{
2879
					foreach ($to_close as $tag)
2880
						array_push($open_tags, $tag);
2881
					continue;
2882
				}
2883
			}
2884
2885
			foreach ($to_close as $tag)
2886
			{
2887
				$message = substr($message, 0, $pos) . "\n" . $tag['after'] . "\n" . substr($message, $pos2 + 1);
2888
				$pos += strlen($tag['after']) + 2;
2889
				$pos2 = $pos - 1;
2890
2891
				// See the comment at the end of the big loop - just eating whitespace ;).
2892
				$whitespace_regex = '';
2893
				if (!empty($tag['block_level']))
2894
					$whitespace_regex .= '(&nbsp;|\s)*(<br\s*/?' . '>)?';
2895
				// Trim one line of whitespace after unnested tags, but all of it after nested ones
2896
				if (!empty($tag['trim']) && $tag['trim'] != 'inside')
2897
					$whitespace_regex .= empty($tag['require_parents']) ? '(&nbsp;|\s)*' : '(<br>|&nbsp;|\s)*';
2898
2899
				if (!empty($whitespace_regex) && preg_match('~' . $whitespace_regex . '~', substr($message, $pos), $matches) != 0)
2900
					$message = substr($message, 0, $pos) . substr($message, $pos + strlen($matches[0]));
2901
			}
2902
2903
			if (!empty($to_close))
2904
			{
2905
				$to_close = array();
0 ignored issues
show
Unused Code introduced by
The assignment to $to_close is dead and can be removed.
Loading history...
2906
				$pos--;
2907
			}
2908
2909
			continue;
2910
		}
2911
2912
		// No tags for this character, so just keep going (fastest possible course.)
2913
		if (!isset($bbc_codes[$tag_character]))
2914
			continue;
2915
2916
		$inside = empty($open_tags) ? null : $open_tags[count($open_tags) - 1];
2917
		$tag = null;
2918
		foreach ($bbc_codes[$tag_character] as $possible)
2919
		{
2920
			$pt_strlen = strlen($possible['tag']);
2921
2922
			// Not a match?
2923
			if (strtolower(substr($message, $pos + 1, $pt_strlen)) != $possible['tag'])
2924
				continue;
2925
2926
			$next_c = isset($message[$pos + 1 + $pt_strlen]) ? $message[$pos + 1 + $pt_strlen] : '';
2927
2928
			// A tag is the last char maybe
2929
			if ($next_c == '')
2930
				break;
2931
2932
			// A test validation?
2933
			if (isset($possible['test']) && preg_match('~^' . $possible['test'] . '~', substr($message, $pos + 1 + $pt_strlen + 1)) === 0)
2934
				continue;
2935
			// Do we want parameters?
2936
			elseif (!empty($possible['parameters']))
2937
			{
2938
				// Are all the parameters optional?
2939
				$param_required = false;
2940
				foreach ($possible['parameters'] as $param)
2941
				{
2942
					if (empty($param['optional']))
2943
					{
2944
						$param_required = true;
2945
						break;
2946
					}
2947
				}
2948
2949
				if ($param_required && $next_c != ' ')
2950
					continue;
2951
			}
2952
			elseif (isset($possible['type']))
2953
			{
2954
				// Do we need an equal sign?
2955
				if (in_array($possible['type'], array('unparsed_equals', 'unparsed_commas', 'unparsed_commas_content', 'unparsed_equals_content', 'parsed_equals')) && $next_c != '=')
2956
					continue;
2957
				// Maybe we just want a /...
2958
				if ($possible['type'] == 'closed' && $next_c != ']' && substr($message, $pos + 1 + $pt_strlen, 2) != '/]' && substr($message, $pos + 1 + $pt_strlen, 3) != ' /]')
2959
					continue;
2960
				// An immediate ]?
2961
				if ($possible['type'] == 'unparsed_content' && $next_c != ']')
2962
					continue;
2963
			}
2964
			// No type means 'parsed_content', which demands an immediate ] without parameters!
2965
			elseif ($next_c != ']')
2966
				continue;
2967
2968
			// Check allowed tree?
2969
			if (isset($possible['require_parents']) && ($inside === null || !in_array($inside['tag'], $possible['require_parents'])))
2970
				continue;
2971
			elseif (isset($inside['require_children']) && !in_array($possible['tag'], $inside['require_children']))
2972
				continue;
2973
			// If this is in the list of disallowed child tags, don't parse it.
2974
			elseif (isset($inside['disallow_children']) && in_array($possible['tag'], $inside['disallow_children']))
2975
				continue;
2976
2977
			$pos1 = $pos + 1 + $pt_strlen + 1;
2978
2979
			// Quotes can have alternate styling, we do this php-side due to all the permutations of quotes.
2980
			if ($possible['tag'] == 'quote')
2981
			{
2982
				// Start with standard
2983
				$quote_alt = false;
2984
				foreach ($open_tags as $open_quote)
2985
				{
2986
					// Every parent quote this quote has flips the styling
2987
					if ($open_quote['tag'] == 'quote')
2988
						$quote_alt = !$quote_alt;
0 ignored issues
show
introduced by
The condition $quote_alt is always false.
Loading history...
2989
				}
2990
				// Add a class to the quote to style alternating blockquotes
2991
				$possible['before'] = strtr($possible['before'], array('<blockquote>' => '<blockquote class="bbc_' . ($quote_alt ? 'alternate' : 'standard') . '_quote">'));
2992
			}
2993
2994
			// This is long, but it makes things much easier and cleaner.
2995
			if (!empty($possible['parameters']))
2996
			{
2997
				// Build a regular expression for each parameter for the current tag.
2998
				$regex_key = $smcFunc['json_encode']($possible['parameters']);
2999
				if (!isset($params_regexes[$regex_key]))
3000
				{
3001
					$params_regexes[$regex_key] = '';
3002
3003
					foreach ($possible['parameters'] as $p => $info)
3004
						$params_regexes[$regex_key] .= '(\s+' . $p . '=' . (empty($info['quoted']) ? '' : '&quot;') . (isset($info['match']) ? $info['match'] : '(.+?)') . (empty($info['quoted']) ? '' : '&quot;') . '\s*)' . (empty($info['optional']) ? '' : '?');
3005
				}
3006
3007
				// Extract the string that potentially holds our parameters.
3008
				$blob = preg_split('~\[/?(?:' . $alltags_regex . ')~i', substr($message, $pos));
3009
				$blobs = preg_split('~\]~i', $blob[1]);
3010
3011
				$splitters = implode('=|', array_keys($possible['parameters'])) . '=';
3012
3013
				// Progressively append more blobs until we find our parameters or run out of blobs
3014
				$blob_counter = 1;
3015
				while ($blob_counter <= count($blobs))
3016
				{
3017
					$given_param_string = implode(']', array_slice($blobs, 0, $blob_counter++));
3018
3019
					$given_params = preg_split('~\s(?=(' . $splitters . '))~i', $given_param_string);
3020
					sort($given_params, SORT_STRING);
3021
3022
					$match = preg_match('~^' . $params_regexes[$regex_key] . '$~i', implode(' ', $given_params), $matches) !== 0;
3023
3024
					if ($match)
3025
						break;
3026
				}
3027
3028
				// Didn't match our parameter list, try the next possible.
3029
				if (!$match)
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable $match does not seem to be defined for all execution paths leading up to this point.
Loading history...
3030
					continue;
3031
3032
				$params = array();
3033
				for ($i = 1, $n = count($matches); $i < $n; $i += 2)
3034
				{
3035
					$key = strtok(ltrim($matches[$i]), '=');
3036
					if ($key === false)
3037
						continue;
3038
					elseif (isset($possible['parameters'][$key]['value']))
3039
						$params['{' . $key . '}'] = strtr($possible['parameters'][$key]['value'], array('$1' => $matches[$i + 1]));
3040
					elseif (isset($possible['parameters'][$key]['validate']))
3041
						$params['{' . $key . '}'] = $possible['parameters'][$key]['validate']($matches[$i + 1]);
3042
					else
3043
						$params['{' . $key . '}'] = $matches[$i + 1];
3044
3045
					// Just to make sure: replace any $ or { so they can't interpolate wrongly.
3046
					$params['{' . $key . '}'] = strtr($params['{' . $key . '}'], array('$' => '&#036;', '{' => '&#123;'));
3047
				}
3048
3049
				foreach ($possible['parameters'] as $p => $info)
3050
				{
3051
					if (!isset($params['{' . $p . '}']))
3052
					{
3053
						if (!isset($info['default']))
3054
							$params['{' . $p . '}'] = '';
3055
						elseif (isset($possible['parameters'][$p]['value']))
3056
							$params['{' . $p . '}'] = strtr($possible['parameters'][$p]['value'], array('$1' => $info['default']));
3057
						elseif (isset($possible['parameters'][$p]['validate']))
3058
							$params['{' . $p . '}'] = $possible['parameters'][$p]['validate']($info['default']);
3059
						else
3060
							$params['{' . $p . '}'] = $info['default'];
3061
					}
3062
				}
3063
3064
				$tag = $possible;
3065
3066
				// Put the parameters into the string.
3067
				if (isset($tag['before']))
3068
					$tag['before'] = strtr($tag['before'], $params);
3069
				if (isset($tag['after']))
3070
					$tag['after'] = strtr($tag['after'], $params);
3071
				if (isset($tag['content']))
3072
					$tag['content'] = strtr($tag['content'], $params);
3073
3074
				$pos1 += strlen($given_param_string);
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable $given_param_string does not seem to be defined for all execution paths leading up to this point.
Loading history...
3075
			}
3076
			else
3077
			{
3078
				$tag = $possible;
3079
				$params = array();
3080
			}
3081
			break;
3082
		}
3083
3084
		// Item codes are complicated buggers... they are implicit [li]s and can make [list]s!
3085
		if ($smileys !== false && $tag === null && isset($itemcodes[$message[$pos + 1]]) && $message[$pos + 2] == ']' && !isset($disabled['list']) && !isset($disabled['li']))
3086
		{
3087
			if ($message[$pos + 1] == '0' && !in_array($message[$pos - 1], array(';', ' ', "\t", "\n", '>')))
3088
				continue;
3089
3090
			$tag = $itemcodes[$message[$pos + 1]];
3091
3092
			// First let's set up the tree: it needs to be in a list, or after an li.
3093
			if ($inside === null || ($inside['tag'] != 'list' && $inside['tag'] != 'li'))
3094
			{
3095
				$open_tags[] = array(
3096
					'tag' => 'list',
3097
					'after' => '</ul>',
3098
					'block_level' => true,
3099
					'require_children' => array('li'),
3100
					'disallow_children' => isset($inside['disallow_children']) ? $inside['disallow_children'] : null,
3101
				);
3102
				$code = '<ul class="bbc_list">';
3103
			}
3104
			// We're in a list item already: another itemcode?  Close it first.
3105
			elseif ($inside['tag'] == 'li')
3106
			{
3107
				array_pop($open_tags);
3108
				$code = '</li>';
3109
			}
3110
			else
3111
				$code = '';
3112
3113
			// Now we open a new tag.
3114
			$open_tags[] = array(
3115
				'tag' => 'li',
3116
				'after' => '</li>',
3117
				'trim' => 'outside',
3118
				'block_level' => true,
3119
				'disallow_children' => isset($inside['disallow_children']) ? $inside['disallow_children'] : null,
3120
			);
3121
3122
			// First, open the tag...
3123
			$code .= '<li' . ($tag == '' ? '' : ' type="' . $tag . '"') . '>';
3124
			$message = substr($message, 0, $pos) . "\n" . $code . "\n" . substr($message, $pos + 3);
3125
			$pos += strlen($code) - 1 + 2;
3126
3127
			// Next, find the next break (if any.)  If there's more itemcode after it, keep it going - otherwise close!
3128
			$pos2 = strpos($message, '<br>', $pos);
3129
			$pos3 = strpos($message, '[/', $pos);
3130
			if ($pos2 !== false && ($pos2 <= $pos3 || $pos3 === false))
3131
			{
3132
				preg_match('~^(<br>|&nbsp;|\s|\[)+~', substr($message, $pos2 + 4), $matches);
3133
				$message = substr($message, 0, $pos2) . (!empty($matches[0]) && substr($matches[0], -1) == '[' ? '[/li]' : '[/li][/list]') . substr($message, $pos2);
3134
3135
				$open_tags[count($open_tags) - 2]['after'] = '</ul>';
3136
			}
3137
			// Tell the [list] that it needs to close specially.
3138
			else
3139
			{
3140
				// Move the li over, because we're not sure what we'll hit.
3141
				$open_tags[count($open_tags) - 1]['after'] = '';
3142
				$open_tags[count($open_tags) - 2]['after'] = '</li></ul>';
3143
			}
3144
3145
			continue;
3146
		}
3147
3148
		// Implicitly close lists and tables if something other than what's required is in them.  This is needed for itemcode.
3149
		if ($tag === null && $inside !== null && !empty($inside['require_children']))
3150
		{
3151
			array_pop($open_tags);
3152
3153
			$message = substr($message, 0, $pos) . "\n" . $inside['after'] . "\n" . substr($message, $pos);
3154
			$pos += strlen($inside['after']) - 1 + 2;
3155
		}
3156
3157
		// No tag?  Keep looking, then.  Silly people using brackets without actual tags.
3158
		if ($tag === null)
3159
			continue;
3160
3161
		// Propagate the list to the child (so wrapping the disallowed tag won't work either.)
3162
		if (isset($inside['disallow_children']))
3163
			$tag['disallow_children'] = isset($tag['disallow_children']) ? array_unique(array_merge($tag['disallow_children'], $inside['disallow_children'])) : $inside['disallow_children'];
3164
3165
		// Is this tag disabled?
3166
		if (isset($disabled[$tag['tag']]))
3167
		{
3168
			if (!isset($tag['disabled_before']) && !isset($tag['disabled_after']) && !isset($tag['disabled_content']))
3169
			{
3170
				$tag['before'] = !empty($tag['block_level']) ? '<div>' : '';
3171
				$tag['after'] = !empty($tag['block_level']) ? '</div>' : '';
3172
				$tag['content'] = isset($tag['type']) && $tag['type'] == 'closed' ? '' : (!empty($tag['block_level']) ? '<div>$1</div>' : '$1');
3173
			}
3174
			elseif (isset($tag['disabled_before']) || isset($tag['disabled_after']))
3175
			{
3176
				$tag['before'] = isset($tag['disabled_before']) ? $tag['disabled_before'] : (!empty($tag['block_level']) ? '<div>' : '');
3177
				$tag['after'] = isset($tag['disabled_after']) ? $tag['disabled_after'] : (!empty($tag['block_level']) ? '</div>' : '');
3178
			}
3179
			else
3180
				$tag['content'] = $tag['disabled_content'];
3181
		}
3182
3183
		// we use this a lot
3184
		$tag_strlen = strlen($tag['tag']);
3185
3186
		// The only special case is 'html', which doesn't need to close things.
3187
		if (!empty($tag['block_level']) && $tag['tag'] != 'html' && empty($inside['block_level']))
3188
		{
3189
			$n = count($open_tags) - 1;
3190
			while (empty($open_tags[$n]['block_level']) && $n >= 0)
3191
				$n--;
3192
3193
			// Close all the non block level tags so this tag isn't surrounded by them.
3194
			for ($i = count($open_tags) - 1; $i > $n; $i--)
3195
			{
3196
				$message = substr($message, 0, $pos) . "\n" . $open_tags[$i]['after'] . "\n" . substr($message, $pos);
3197
				$ot_strlen = strlen($open_tags[$i]['after']);
3198
				$pos += $ot_strlen + 2;
3199
				$pos1 += $ot_strlen + 2;
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable $pos1 does not seem to be defined for all execution paths leading up to this point.
Loading history...
3200
3201
				// Trim or eat trailing stuff... see comment at the end of the big loop.
3202
				$whitespace_regex = '';
3203
				if (!empty($tag['block_level']))
3204
					$whitespace_regex .= '(&nbsp;|\s)*(<br>)?';
3205
				if (!empty($tag['trim']) && $tag['trim'] != 'inside')
3206
					$whitespace_regex .= empty($tag['require_parents']) ? '(&nbsp;|\s)*' : '(<br>|&nbsp;|\s)*';
3207
				if (!empty($whitespace_regex) && preg_match('~' . $whitespace_regex . '~', substr($message, $pos), $matches) != 0)
3208
					$message = substr($message, 0, $pos) . substr($message, $pos + strlen($matches[0]));
3209
3210
				array_pop($open_tags);
3211
			}
3212
		}
3213
3214
		// Can't read past the end of the message
3215
		$pos1 = min(strlen($message), $pos1);
3216
3217
		// No type means 'parsed_content'.
3218
		if (!isset($tag['type']))
3219
		{
3220
			$open_tags[] = $tag;
3221
			$message = substr($message, 0, $pos) . "\n" . $tag['before'] . "\n" . substr($message, $pos1);
3222
			$pos += strlen($tag['before']) - 1 + 2;
3223
		}
3224
		// Don't parse the content, just skip it.
3225
		elseif ($tag['type'] == 'unparsed_content')
3226
		{
3227
			$pos2 = stripos($message, '[/' . substr($message, $pos + 1, $tag_strlen) . ']', $pos1);
3228
			if ($pos2 === false)
3229
				continue;
3230
3231
			$data = substr($message, $pos1, $pos2 - $pos1);
3232
3233
			if (!empty($tag['block_level']) && substr($data, 0, 4) == '<br>')
3234
				$data = substr($data, 4);
3235
3236
			if (isset($tag['validate']))
3237
				$tag['validate']($tag, $data, $disabled, $params);
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable $params does not seem to be defined for all execution paths leading up to this point.
Loading history...
3238
3239
			$code = strtr($tag['content'], array('$1' => $data));
3240
			$message = substr($message, 0, $pos) . "\n" . $code . "\n" . substr($message, $pos2 + 3 + $tag_strlen);
3241
3242
			$pos += strlen($code) - 1 + 2;
3243
			$last_pos = $pos + 1;
3244
		}
3245
		// Don't parse the content, just skip it.
3246
		elseif ($tag['type'] == 'unparsed_equals_content')
3247
		{
3248
			// The value may be quoted for some tags - check.
3249
			if (isset($tag['quoted']))
3250
			{
3251
				$quoted = substr($message, $pos1, 6) == '&quot;';
3252
				if ($tag['quoted'] != 'optional' && !$quoted)
3253
					continue;
3254
3255
				if ($quoted)
3256
					$pos1 += 6;
3257
			}
3258
			else
3259
				$quoted = false;
3260
3261
			$pos2 = strpos($message, $quoted == false ? ']' : '&quot;]', $pos1);
0 ignored issues
show
Coding Style Best Practice introduced by
It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

When comparing two booleans, it is generally considered safer to use the strict comparison operator.

Loading history...
3262
			if ($pos2 === false)
3263
				continue;
3264
3265
			$pos3 = stripos($message, '[/' . substr($message, $pos + 1, $tag_strlen) . ']', $pos2);
3266
			if ($pos3 === false)
3267
				continue;
3268
3269
			$data = array(
3270
				substr($message, $pos2 + ($quoted == false ? 1 : 7), $pos3 - ($pos2 + ($quoted == false ? 1 : 7))),
0 ignored issues
show
Coding Style Best Practice introduced by
It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

When comparing two booleans, it is generally considered safer to use the strict comparison operator.

Loading history...
3271
				substr($message, $pos1, $pos2 - $pos1)
3272
			);
3273
3274
			if (!empty($tag['block_level']) && substr($data[0], 0, 4) == '<br>')
3275
				$data[0] = substr($data[0], 4);
3276
3277
			// Validation for my parking, please!
3278
			if (isset($tag['validate']))
3279
				$tag['validate']($tag, $data, $disabled, $params);
3280
3281
			$code = strtr($tag['content'], array('$1' => $data[0], '$2' => $data[1]));
3282
			$message = substr($message, 0, $pos) . "\n" . $code . "\n" . substr($message, $pos3 + 3 + $tag_strlen);
3283
			$pos += strlen($code) - 1 + 2;
3284
		}
3285
		// A closed tag, with no content or value.
3286
		elseif ($tag['type'] == 'closed')
3287
		{
3288
			$pos2 = strpos($message, ']', $pos);
3289
			$message = substr($message, 0, $pos) . "\n" . $tag['content'] . "\n" . substr($message, $pos2 + 1);
3290
			$pos += strlen($tag['content']) - 1 + 2;
3291
		}
3292
		// This one is sorta ugly... :/.  Unfortunately, it's needed for flash.
3293
		elseif ($tag['type'] == 'unparsed_commas_content')
3294
		{
3295
			$pos2 = strpos($message, ']', $pos1);
3296
			if ($pos2 === false)
3297
				continue;
3298
3299
			$pos3 = stripos($message, '[/' . substr($message, $pos + 1, $tag_strlen) . ']', $pos2);
3300
			if ($pos3 === false)
3301
				continue;
3302
3303
			// We want $1 to be the content, and the rest to be csv.
3304
			$data = explode(',', ',' . substr($message, $pos1, $pos2 - $pos1));
3305
			$data[0] = substr($message, $pos2 + 1, $pos3 - $pos2 - 1);
3306
3307
			if (isset($tag['validate']))
3308
				$tag['validate']($tag, $data, $disabled, $params);
3309
3310
			$code = $tag['content'];
3311
			foreach ($data as $k => $d)
3312
				$code = strtr($code, array('$' . ($k + 1) => trim($d)));
3313
			$message = substr($message, 0, $pos) . "\n" . $code . "\n" . substr($message, $pos3 + 3 + $tag_strlen);
3314
			$pos += strlen($code) - 1 + 2;
3315
		}
3316
		// This has parsed content, and a csv value which is unparsed.
3317
		elseif ($tag['type'] == 'unparsed_commas')
3318
		{
3319
			$pos2 = strpos($message, ']', $pos1);
3320
			if ($pos2 === false)
3321
				continue;
3322
3323
			$data = explode(',', substr($message, $pos1, $pos2 - $pos1));
3324
3325
			if (isset($tag['validate']))
3326
				$tag['validate']($tag, $data, $disabled, $params);
3327
3328
			// Fix after, for disabled code mainly.
3329
			foreach ($data as $k => $d)
3330
				$tag['after'] = strtr($tag['after'], array('$' . ($k + 1) => trim($d)));
3331
3332
			$open_tags[] = $tag;
3333
3334
			// Replace them out, $1, $2, $3, $4, etc.
3335
			$code = $tag['before'];
3336
			foreach ($data as $k => $d)
3337
				$code = strtr($code, array('$' . ($k + 1) => trim($d)));
3338
			$message = substr($message, 0, $pos) . "\n" . $code . "\n" . substr($message, $pos2 + 1);
3339
			$pos += strlen($code) - 1 + 2;
3340
		}
3341
		// A tag set to a value, parsed or not.
3342
		elseif ($tag['type'] == 'unparsed_equals' || $tag['type'] == 'parsed_equals')
3343
		{
3344
			// The value may be quoted for some tags - check.
3345
			if (isset($tag['quoted']))
3346
			{
3347
				$quoted = substr($message, $pos1, 6) == '&quot;';
3348
				if ($tag['quoted'] != 'optional' && !$quoted)
3349
					continue;
3350
3351
				if ($quoted)
3352
					$pos1 += 6;
3353
			}
3354
			else
3355
				$quoted = false;
3356
3357
			if ($quoted)
3358
			{
3359
				$end_of_value = strpos($message, '&quot;]', $pos1);
3360
				$nested_tag = strpos($message, '=&quot;', $pos1);
3361
				if ($nested_tag && $nested_tag < $end_of_value)
3362
					// Nested tag with quoted value detected, use next end tag
3363
					$nested_tag_pos = strpos($message, $quoted == false ? ']' : '&quot;]', $pos1) + 6;
0 ignored issues
show
Coding Style Best Practice introduced by
It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

When comparing two booleans, it is generally considered safer to use the strict comparison operator.

Loading history...
3364
			}
3365
3366
			$pos2 = strpos($message, $quoted == false ? ']' : '&quot;]', isset($nested_tag_pos) ? $nested_tag_pos : $pos1);
0 ignored issues
show
Coding Style Best Practice introduced by
It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

When comparing two booleans, it is generally considered safer to use the strict comparison operator.

Loading history...
3367
			if ($pos2 === false)
3368
				continue;
3369
3370
			$data = substr($message, $pos1, $pos2 - $pos1);
3371
3372
			// Validation for my parking, please!
3373
			if (isset($tag['validate']))
3374
				$tag['validate']($tag, $data, $disabled, $params);
3375
3376
			// For parsed content, we must recurse to avoid security problems.
3377
			if ($tag['type'] != 'unparsed_equals')
3378
				$data = parse_bbc($data, !empty($tag['parsed_tags_allowed']) ? false : true, '', !empty($tag['parsed_tags_allowed']) ? $tag['parsed_tags_allowed'] : array());
3379
3380
			$tag['after'] = strtr($tag['after'], array('$1' => $data));
3381
3382
			$open_tags[] = $tag;
3383
3384
			$code = strtr($tag['before'], array('$1' => $data));
3385
			$message = substr($message, 0, $pos) . "\n" . $code . "\n" . substr($message, $pos2 + ($quoted == false ? 1 : 7));
0 ignored issues
show
Coding Style Best Practice introduced by
It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

When comparing two booleans, it is generally considered safer to use the strict comparison operator.

Loading history...
3386
			$pos += strlen($code) - 1 + 2;
3387
		}
3388
3389
		// If this is block level, eat any breaks after it.
3390
		if (!empty($tag['block_level']) && substr($message, $pos + 1, 4) == '<br>')
3391
			$message = substr($message, 0, $pos + 1) . substr($message, $pos + 5);
3392
3393
		// Are we trimming outside this tag?
3394
		if (!empty($tag['trim']) && $tag['trim'] != 'outside' && preg_match('~(<br>|&nbsp;|\s)*~', substr($message, $pos + 1), $matches) != 0)
3395
			$message = substr($message, 0, $pos + 1) . substr($message, $pos + 1 + strlen($matches[0]));
3396
	}
3397
3398
	// Close any remaining tags.
3399
	while ($tag = array_pop($open_tags))
3400
		$message .= "\n" . $tag['after'] . "\n";
3401
3402
	// Parse the smileys within the parts where it can be done safely.
3403
	if ($smileys === true)
3404
	{
3405
		$message_parts = explode("\n", $message);
3406
		for ($i = 0, $n = count($message_parts); $i < $n; $i += 2)
3407
			parsesmileys($message_parts[$i]);
3408
3409
		$message = implode('', $message_parts);
3410
	}
3411
3412
	// No smileys, just get rid of the markers.
3413
	else
3414
		$message = strtr($message, array("\n" => ''));
3415
3416
	if ($message !== '' && $message[0] === ' ')
3417
		$message = '&nbsp;' . substr($message, 1);
3418
3419
	// Cleanup whitespace.
3420
	$message = strtr($message, array('  ' => ' &nbsp;', "\r" => '', "\n" => '<br>', '<br> ' => '<br>&nbsp;', '&#13;' => "\n"));
3421
3422
	// Allow mods access to what parse_bbc created
3423
	call_integration_hook('integrate_post_parsebbc', array(&$message, &$smileys, &$cache_id, &$parse_tags));
3424
3425
	// Cache the output if it took some time...
3426
	if (isset($cache_key, $cache_t) && microtime(true) - $cache_t > 0.05)
3427
		cache_put_data($cache_key, $message, 240);
3428
3429
	// If this was a force parse revert if needed.
3430
	if (!empty($parse_tags))
3431
	{
3432
		$alltags_regex = empty($real_alltags_regex) ? '' : $real_alltags_regex;
3433
		unset($real_alltags_regex);
3434
	}
3435
	elseif (!empty($bbc_codes))
3436
		$bbc_lang_locales[$txt['lang_locale']] = $bbc_codes;
3437
3438
	return $message;
3439
}
3440
3441
/**
3442
 * Parse smileys in the passed message.
3443
 *
3444
 * The smiley parsing function which makes pretty faces appear :).
3445
 * If custom smiley sets are turned off by smiley_enable, the default set of smileys will be used.
3446
 * These are specifically not parsed in code tags [url=mailto:[email protected]]
3447
 * Caches the smileys from the database or array in memory.
3448
 * Doesn't return anything, but rather modifies message directly.
3449
 *
3450
 * @param string &$message The message to parse smileys in
3451
 */
3452
function parsesmileys(&$message)
3453
{
3454
	global $modSettings, $txt, $user_info, $context, $smcFunc;
3455
	static $smileyPregSearch = null, $smileyPregReplacements = array();
3456
3457
	// No smiley set at all?!
3458
	if ($user_info['smiley_set'] == 'none' || trim($message) == '')
3459
		return;
3460
3461
	// Maybe a mod wants to implement an alternative method (e.g. emojis instead of images)
3462
	call_integration_hook('integrate_smileys', array(&$smileyPregSearch, &$smileyPregReplacements));
3463
3464
	// If smileyPregSearch hasn't been set, do it now.
3465
	if (empty($smileyPregSearch))
3466
	{
3467
		// Cache for longer when customized smiley codes aren't enabled
3468
		$cache_time = empty($modSettings['smiley_enable']) ? 7200 : 480;
3469
3470
		// Load the smileys in reverse order by length so they don't get parsed incorrectly.
3471
		if (($temp = cache_get_data('parsing_smileys_' . $user_info['smiley_set'], $cache_time)) == null)
3472
		{
3473
			$result = $smcFunc['db_query']('', '
3474
				SELECT s.code, f.filename, s.description
3475
				FROM {db_prefix}smileys AS s
3476
					JOIN {db_prefix}smiley_files AS f ON (s.id_smiley = f.id_smiley)
3477
				WHERE f.smiley_set = {string:smiley_set}' . (empty($modSettings['smiley_enable']) ? '
3478
					AND s.code IN ({array_string:default_codes})' : '') . '
3479
				ORDER BY LENGTH(s.code) DESC',
3480
				array(
3481
					'default_codes' => array('>:D', ':D', '::)', '>:(', ':))', ':)', ';)', ';D', ':(', ':o', '8)', ':P', '???', ':-[', ':-X', ':-*', ':\'(', ':-\\', '^-^', 'O0', 'C:-)', 'O:-)'),
3482
					'smiley_set' => $user_info['smiley_set'],
3483
				)
3484
			);
3485
			$smileysfrom = array();
3486
			$smileysto = array();
3487
			$smileysdescs = array();
3488
			while ($row = $smcFunc['db_fetch_assoc']($result))
3489
			{
3490
				$smileysfrom[] = $row['code'];
3491
				$smileysto[] = $smcFunc['htmlspecialchars']($row['filename']);
3492
				$smileysdescs[] = !empty($txt['icon_' . strtolower($row['description'])]) ? $txt['icon_' . strtolower($row['description'])] : $row['description'];
3493
			}
3494
			$smcFunc['db_free_result']($result);
3495
3496
			cache_put_data('parsing_smileys_' . $user_info['smiley_set'], array($smileysfrom, $smileysto, $smileysdescs), $cache_time);
3497
		}
3498
		else
3499
			list ($smileysfrom, $smileysto, $smileysdescs) = $temp;
3500
3501
		// The non-breaking-space is a complex thing...
3502
		$non_breaking_space = $context['utf8'] ? '\x{A0}' : '\xA0';
3503
3504
		// This smiley regex makes sure it doesn't parse smileys within code tags (so [url=mailto:[email protected]] doesn't parse the :D smiley)
3505
		$smileyPregReplacements = array();
3506
		$searchParts = array();
3507
		$smileys_path = $smcFunc['htmlspecialchars']($modSettings['smileys_url'] . '/' . $user_info['smiley_set'] . '/');
3508
3509
		for ($i = 0, $n = count($smileysfrom); $i < $n; $i++)
3510
		{
3511
			$specialChars = $smcFunc['htmlspecialchars']($smileysfrom[$i], ENT_QUOTES);
3512
			$smileyCode = '<img src="' . $smileys_path . $smileysto[$i] . '" alt="' . strtr($specialChars, array(':' => '&#58;', '(' => '&#40;', ')' => '&#41;', '$' => '&#36;', '[' => '&#091;')) . '" title="' . strtr($smcFunc['htmlspecialchars']($smileysdescs[$i]), array(':' => '&#58;', '(' => '&#40;', ')' => '&#41;', '$' => '&#36;', '[' => '&#091;')) . '" class="smiley">';
3513
3514
			$smileyPregReplacements[$smileysfrom[$i]] = $smileyCode;
3515
3516
			$searchParts[] = $smileysfrom[$i];
3517
			if ($smileysfrom[$i] != $specialChars)
3518
			{
3519
				$smileyPregReplacements[$specialChars] = $smileyCode;
3520
				$searchParts[] = $specialChars;
3521
3522
				// Some 2.0 hex htmlchars are in there as 3 digits; allow for finding leading 0 or not
3523
				$specialChars2 = preg_replace('/&#(\d{2});/', '&#0$1;', $specialChars);
3524
				if ($specialChars2 != $specialChars)
3525
				{
3526
					$smileyPregReplacements[$specialChars2] = $smileyCode;
3527
					$searchParts[] = $specialChars2;
3528
				}
3529
			}
3530
		}
3531
3532
		$smileyPregSearch = '~(?<=[>:\?\.\s' . $non_breaking_space . '[\]()*\\\;]|(?<![a-zA-Z0-9])\(|^)(' . build_regex($searchParts, '~') . ')(?=[^[:alpha:]0-9]|$)~' . ($context['utf8'] ? 'u' : '');
0 ignored issues
show
Bug introduced by
Are you sure build_regex($searchParts, '~') of type array|string can be used in concatenation? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

3532
		$smileyPregSearch = '~(?<=[>:\?\.\s' . $non_breaking_space . '[\]()*\\\;]|(?<![a-zA-Z0-9])\(|^)(' . /** @scrutinizer ignore-type */ build_regex($searchParts, '~') . ')(?=[^[:alpha:]0-9]|$)~' . ($context['utf8'] ? 'u' : '');
Loading history...
3533
	}
3534
3535
	// Replace away!
3536
	$message = preg_replace_callback($smileyPregSearch, function($matches) use ($smileyPregReplacements)
3537
		{
3538
			return $smileyPregReplacements[$matches[1]];
3539
		}, $message);
3540
}
3541
3542
/**
3543
 * Highlight any code.
3544
 *
3545
 * Uses PHP's highlight_string() to highlight PHP syntax
3546
 * does special handling to keep the tabs in the code available.
3547
 * used to parse PHP code from inside [code] and [php] tags.
3548
 *
3549
 * @param string $code The code
3550
 * @return string The code with highlighted HTML.
3551
 */
3552
function highlight_php_code($code)
3553
{
3554
	// Remove special characters.
3555
	$code = un_htmlspecialchars(strtr($code, array('<br />' => "\n", '<br>' => "\n", "\t" => 'SMF_TAB();', '&#91;' => '[')));
3556
3557
	$oldlevel = error_reporting(0);
3558
3559
	$buffer = str_replace(array("\n", "\r"), '', @highlight_string($code, true));
3560
3561
	error_reporting($oldlevel);
3562
3563
	// Yes, I know this is kludging it, but this is the best way to preserve tabs from PHP :P.
3564
	$buffer = preg_replace('~SMF_TAB(?:</(?:font|span)><(?:font color|span style)="[^"]*?">)?\\(\\);~', '<pre style="display: inline;">' . "\t" . '</pre>', $buffer);
3565
3566
	return strtr($buffer, array('\'' => '&#039;', '<code>' => '', '</code>' => ''));
3567
}
3568
3569
/**
3570
 * Gets the appropriate URL to use for images (or whatever) when using SSL
3571
 *
3572
 * The returned URL may or may not be a proxied URL, depending on the situation.
3573
 * Mods can implement alternative proxies using the 'integrate_proxy' hook.
3574
 *
3575
 * @param string $url The original URL of the requested resource
3576
 * @return string The URL to use
3577
 */
3578
function get_proxied_url($url)
3579
{
3580
	global $boardurl, $image_proxy_enabled, $image_proxy_secret, $user_info;
3581
3582
	// Only use the proxy if enabled, and never for robots
3583
	if (empty($image_proxy_enabled) || !empty($user_info['possibly_robot']))
3584
		return $url;
3585
3586
	$parsedurl = parse_url($url);
3587
3588
	// Don't bother with HTTPS URLs, schemeless URLs, or obviously invalid URLs
3589
	if (empty($parsedurl['scheme']) || empty($parsedurl['host']) || empty($parsedurl['path']) || $parsedurl['scheme'] === 'https')
3590
		return $url;
3591
3592
	// We don't need to proxy our own resources
3593
	if ($parsedurl['host'] === parse_url($boardurl, PHP_URL_HOST))
3594
		return strtr($url, array('http://' => 'https://'));
3595
3596
	// By default, use SMF's own image proxy script
3597
	$proxied_url = strtr($boardurl, array('http://' => 'https://')) . '/proxy.php?request=' . urlencode($url) . '&hash=' . hash_hmac('sha1', $url, $image_proxy_secret);
3598
3599
	// Allow mods to easily implement an alternative proxy
3600
	// MOD AUTHORS: To add settings UI for your proxy, use the integrate_general_settings hook.
3601
	call_integration_hook('integrate_proxy', array($url, &$proxied_url));
3602
3603
	return $proxied_url;
3604
}
3605
3606
/**
3607
 * Make sure the browser doesn't come back and repost the form data.
3608
 * Should be used whenever anything is posted.
3609
 *
3610
 * @param string $setLocation The URL to redirect them to
3611
 * @param bool $refresh Whether to use a meta refresh instead
3612
 * @param bool $permanent Whether to send a 301 Moved Permanently instead of a 302 Moved Temporarily
3613
 */
3614
function redirectexit($setLocation = '', $refresh = false, $permanent = false)
3615
{
3616
	global $scripturl, $context, $modSettings, $db_show_debug, $db_cache;
3617
3618
	// In case we have mail to send, better do that - as obExit doesn't always quite make it...
3619
	if (!empty($context['flush_mail']))
3620
		// @todo this relies on 'flush_mail' being only set in AddMailQueue itself... :\
3621
		AddMailQueue(true);
3622
3623
	$add = preg_match('~^(ftp|http)[s]?://~', $setLocation) == 0 && substr($setLocation, 0, 6) != 'about:';
3624
3625
	if ($add)
3626
		$setLocation = $scripturl . ($setLocation != '' ? '?' . $setLocation : '');
3627
3628
	// Put the session ID in.
3629
	if (defined('SID') && SID != '')
3630
		$setLocation = preg_replace('/^' . preg_quote($scripturl, '/') . '(?!\?' . preg_quote(SID, '/') . ')\\??/', $scripturl . '?' . SID . ';', $setLocation);
3631
	// Keep that debug in their for template debugging!
3632
	elseif (isset($_GET['debug']))
3633
		$setLocation = preg_replace('/^' . preg_quote($scripturl, '/') . '\\??/', $scripturl . '?debug;', $setLocation);
3634
3635
	if (!empty($modSettings['queryless_urls']) && (empty($context['server']['is_cgi']) || ini_get('cgi.fix_pathinfo') == 1 || @get_cfg_var('cgi.fix_pathinfo') == 1) && (!empty($context['server']['is_apache']) || !empty($context['server']['is_lighttpd']) || !empty($context['server']['is_litespeed'])))
3636
	{
3637
		if (defined('SID') && SID != '')
3638
			$setLocation = preg_replace_callback('~^' . preg_quote($scripturl, '~') . '\?(?:' . SID . '(?:;|&|&amp;))((?:board|topic)=[^#]+?)(#[^"]*?)?$~',
3639
				function($m) use ($scripturl)
3640
				{
3641
					return $scripturl . '/' . strtr("$m[1]", '&;=', '//,') . '.html?' . SID . (isset($m[2]) ? "$m[2]" : "");
3642
				}, $setLocation);
3643
		else
3644
			$setLocation = preg_replace_callback('~^' . preg_quote($scripturl, '~') . '\?((?:board|topic)=[^#"]+?)(#[^"]*?)?$~',
3645
				function($m) use ($scripturl)
3646
				{
3647
					return $scripturl . '/' . strtr("$m[1]", '&;=', '//,') . '.html' . (isset($m[2]) ? "$m[2]" : "");
3648
				}, $setLocation);
3649
	}
3650
3651
	// Maybe integrations want to change where we are heading?
3652
	call_integration_hook('integrate_redirect', array(&$setLocation, &$refresh, &$permanent));
3653
3654
	// Set the header.
3655
	header('location: ' . str_replace(' ', '%20', $setLocation), true, $permanent ? 301 : 302);
3656
3657
	// Debugging.
3658
	if (isset($db_show_debug) && $db_show_debug === true)
3659
		$_SESSION['debug_redirect'] = $db_cache;
3660
3661
	obExit(false);
3662
}
3663
3664
/**
3665
 * Ends execution.  Takes care of template loading and remembering the previous URL.
3666
 *
3667
 * @param bool $header Whether to do the header
3668
 * @param bool $do_footer Whether to do the footer
3669
 * @param bool $from_index Whether we're coming from the board index
3670
 * @param bool $from_fatal_error Whether we're coming from a fatal error
3671
 */
3672
function obExit($header = null, $do_footer = null, $from_index = false, $from_fatal_error = false)
3673
{
3674
	global $context, $settings, $modSettings, $txt, $smcFunc, $should_log;
3675
	static $header_done = false, $footer_done = false, $level = 0, $has_fatal_error = false;
3676
3677
	// Attempt to prevent a recursive loop.
3678
	++$level;
3679
	if ($level > 1 && !$from_fatal_error && !$has_fatal_error)
3680
		exit;
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...
3681
	if ($from_fatal_error)
3682
		$has_fatal_error = true;
3683
3684
	// Clear out the stat cache.
3685
	if (function_exists('trackStats'))
3686
		trackStats();
3687
3688
	// If we have mail to send, send it.
3689
	if (function_exists('AddMailQueue') && !empty($context['flush_mail']))
3690
		// @todo this relies on 'flush_mail' being only set in AddMailQueue itself... :\
3691
		AddMailQueue(true);
3692
3693
	$do_header = $header === null ? !$header_done : $header;
3694
	if ($do_footer === null)
3695
		$do_footer = $do_header;
3696
3697
	// Has the template/header been done yet?
3698
	if ($do_header)
3699
	{
3700
		// Was the page title set last minute? Also update the HTML safe one.
3701
		if (!empty($context['page_title']) && empty($context['page_title_html_safe']))
3702
			$context['page_title_html_safe'] = $smcFunc['htmlspecialchars'](un_htmlspecialchars($context['page_title'])) . (!empty($context['current_page']) ? ' - ' . $txt['page'] . ' ' . ($context['current_page'] + 1) : '');
3703
3704
		// Start up the session URL fixer.
3705
		ob_start('ob_sessrewrite');
3706
3707
		if (!empty($settings['output_buffers']) && is_string($settings['output_buffers']))
3708
			$buffers = explode(',', $settings['output_buffers']);
3709
		elseif (!empty($settings['output_buffers']))
3710
			$buffers = $settings['output_buffers'];
3711
		else
3712
			$buffers = array();
3713
3714
		if (isset($modSettings['integrate_buffer']))
3715
			$buffers = array_merge(explode(',', $modSettings['integrate_buffer']), $buffers);
3716
3717
		if (!empty($buffers))
3718
			foreach ($buffers as $function)
3719
			{
3720
				$call = call_helper($function, true);
3721
3722
				// Is it valid?
3723
				if (!empty($call))
3724
					ob_start($call);
0 ignored issues
show
Bug introduced by
It seems like $call can also be of type boolean; however, parameter $callback of ob_start() does only seem to accept callable, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

3724
					ob_start(/** @scrutinizer ignore-type */ $call);
Loading history...
3725
			}
3726
3727
		// Display the screen in the logical order.
3728
		template_header();
3729
		$header_done = true;
3730
	}
3731
	if ($do_footer)
3732
	{
3733
		loadSubTemplate(isset($context['sub_template']) ? $context['sub_template'] : 'main');
3734
3735
		// Anything special to put out?
3736
		if (!empty($context['insert_after_template']) && !isset($_REQUEST['xml']))
3737
			echo $context['insert_after_template'];
3738
3739
		// Just so we don't get caught in an endless loop of errors from the footer...
3740
		if (!$footer_done)
3741
		{
3742
			$footer_done = true;
3743
			template_footer();
3744
3745
			// (since this is just debugging... it's okay that it's after </html>.)
3746
			if (!isset($_REQUEST['xml']))
3747
				displayDebug();
3748
		}
3749
	}
3750
3751
	// Remember this URL in case someone doesn't like sending HTTP_REFERER.
3752
	if ($should_log)
3753
		$_SESSION['old_url'] = $_SERVER['REQUEST_URL'];
3754
3755
	// For session check verification.... don't switch browsers...
3756
	$_SESSION['USER_AGENT'] = empty($_SERVER['HTTP_USER_AGENT']) ? '' : $_SERVER['HTTP_USER_AGENT'];
3757
3758
	// Hand off the output to the portal, etc. we're integrated with.
3759
	call_integration_hook('integrate_exit', array($do_footer));
3760
3761
	// Don't exit if we're coming from index.php; that will pass through normally.
3762
	if (!$from_index)
3763
		exit;
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...
3764
}
3765
3766
/**
3767
 * Get the size of a specified image with better error handling.
3768
 *
3769
 * @todo see if it's better in Subs-Graphics, but one step at the time.
3770
 * Uses getimagesize() to determine the size of a file.
3771
 * Attempts to connect to the server first so it won't time out.
3772
 *
3773
 * @param string $url The URL of the image
3774
 * @return array|false The image size as array (width, height), or false on failure
3775
 */
3776
function url_image_size($url)
3777
{
3778
	global $sourcedir;
3779
3780
	// Make sure it is a proper URL.
3781
	$url = str_replace(' ', '%20', $url);
3782
3783
	// Can we pull this from the cache... please please?
3784
	if (($temp = cache_get_data('url_image_size-' . md5($url), 240)) !== null)
3785
		return $temp;
3786
	$t = microtime(true);
3787
3788
	// Get the host to pester...
3789
	preg_match('~^\w+://(.+?)/(.*)$~', $url, $match);
3790
3791
	// Can't figure it out, just try the image size.
3792
	if ($url == '' || $url == 'http://' || $url == 'https://')
3793
	{
3794
		return false;
3795
	}
3796
	elseif (!isset($match[1]))
3797
	{
3798
		$size = @getimagesize($url);
3799
	}
3800
	else
3801
	{
3802
		// Try to connect to the server... give it half a second.
3803
		$temp = 0;
3804
		$fp = @fsockopen($match[1], 80, $temp, $temp, 0.5);
3805
3806
		// Successful?  Continue...
3807
		if ($fp != false)
3808
		{
3809
			// Send the HEAD request (since we don't have to worry about chunked, HTTP/1.1 is fine here.)
3810
			fwrite($fp, 'HEAD /' . $match[2] . ' HTTP/1.1' . "\r\n" . 'Host: ' . $match[1] . "\r\n" . 'user-agent: '. SMF_USER_AGENT . "\r\n" . 'Connection: close' . "\r\n\r\n");
3811
3812
			// Read in the HTTP/1.1 or whatever.
3813
			$test = substr(fgets($fp, 11), -1);
3814
			fclose($fp);
3815
3816
			// See if it returned a 404/403 or something.
3817
			if ($test < 4)
3818
			{
3819
				$size = @getimagesize($url);
3820
3821
				// This probably means allow_url_fopen is off, let's try GD.
3822
				if ($size === false && function_exists('imagecreatefromstring'))
3823
				{
3824
					// It's going to hate us for doing this, but another request...
3825
					$image = @imagecreatefromstring(fetch_web_data($url));
0 ignored issues
show
Bug introduced by
It seems like fetch_web_data($url) can also be of type false; however, parameter $image of imagecreatefromstring() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

3825
					$image = @imagecreatefromstring(/** @scrutinizer ignore-type */ fetch_web_data($url));
Loading history...
3826
					if ($image !== false)
3827
					{
3828
						$size = array(imagesx($image), imagesy($image));
3829
						imagedestroy($image);
3830
					}
3831
				}
3832
			}
3833
		}
3834
	}
3835
3836
	// If we didn't get it, we failed.
3837
	if (!isset($size))
3838
		$size = false;
3839
3840
	// If this took a long time, we may never have to do it again, but then again we might...
3841
	if (microtime(true) - $t > 0.8)
3842
		cache_put_data('url_image_size-' . md5($url), $size, 240);
3843
3844
	// Didn't work.
3845
	return $size;
3846
}
3847
3848
/**
3849
 * Sets up the basic theme context stuff.
3850
 *
3851
 * @param bool $forceload Whether to load the theme even if it's already loaded
3852
 */
3853
function setupThemeContext($forceload = false)
3854
{
3855
	global $modSettings, $user_info, $scripturl, $context, $settings, $options, $txt, $maintenance;
3856
	global $smcFunc;
3857
	static $loaded = false;
3858
3859
	// Under SSI this function can be called more then once.  That can cause some problems.
3860
	//   So only run the function once unless we are forced to run it again.
3861
	if ($loaded && !$forceload)
3862
		return;
3863
3864
	$loaded = true;
3865
3866
	$context['in_maintenance'] = !empty($maintenance);
3867
	$context['current_time'] = timeformat(time(), false);
3868
	$context['current_action'] = isset($_GET['action']) ? $smcFunc['htmlspecialchars']($_GET['action']) : '';
3869
	$context['random_news_line'] = array();
3870
3871
	// Get some news...
3872
	$context['news_lines'] = array_filter(explode("\n", str_replace("\r", '', trim(addslashes($modSettings['news'])))));
3873
	for ($i = 0, $n = count($context['news_lines']); $i < $n; $i++)
3874
	{
3875
		if (trim($context['news_lines'][$i]) == '')
3876
			continue;
3877
3878
		// Clean it up for presentation ;).
3879
		$context['news_lines'][$i] = parse_bbc(stripslashes(trim($context['news_lines'][$i])), true, 'news' . $i);
3880
	}
3881
3882
	if (!empty($context['news_lines']) && (!empty($modSettings['allow_guestAccess']) || $context['user']['is_logged']))
3883
		$context['random_news_line'] = $context['news_lines'][mt_rand(0, count($context['news_lines']) - 1)];
3884
3885
	if (!$user_info['is_guest'])
3886
	{
3887
		$context['user']['messages'] = &$user_info['messages'];
3888
		$context['user']['unread_messages'] = &$user_info['unread_messages'];
3889
		$context['user']['alerts'] = &$user_info['alerts'];
3890
3891
		// Personal message popup...
3892
		if ($user_info['unread_messages'] > (isset($_SESSION['unread_messages']) ? $_SESSION['unread_messages'] : 0))
3893
			$context['user']['popup_messages'] = true;
3894
		else
3895
			$context['user']['popup_messages'] = false;
3896
		$_SESSION['unread_messages'] = $user_info['unread_messages'];
3897
3898
		if (allowedTo('moderate_forum'))
3899
			$context['unapproved_members'] = !empty($modSettings['unapprovedMembers']) ? $modSettings['unapprovedMembers'] : 0;
3900
3901
		$context['user']['avatar'] = array();
3902
3903
		// Check for gravatar first since we might be forcing them...
3904
		if (!empty($modSettings['gravatarEnabled']) && (substr($user_info['avatar']['url'], 0, 11) == 'gravatar://' || !empty($modSettings['gravatarOverride'])))
3905
		{
3906
			if (!empty($modSettings['gravatarAllowExtraEmail']) && stristr($user_info['avatar']['url'], 'gravatar://') && strlen($user_info['avatar']['url']) > 11)
3907
				$context['user']['avatar']['href'] = get_gravatar_url($smcFunc['substr']($user_info['avatar']['url'], 11));
3908
			else
3909
				$context['user']['avatar']['href'] = get_gravatar_url($user_info['email']);
3910
		}
3911
		// Uploaded?
3912
		elseif ($user_info['avatar']['url'] == '' && !empty($user_info['avatar']['id_attach']))
3913
			$context['user']['avatar']['href'] = $user_info['avatar']['custom_dir'] ? $modSettings['custom_avatar_url'] . '/' . $user_info['avatar']['filename'] : $scripturl . '?action=dlattach;attach=' . $user_info['avatar']['id_attach'] . ';type=avatar';
3914
		// Full URL?
3915
		elseif (strpos($user_info['avatar']['url'], 'http://') === 0 || strpos($user_info['avatar']['url'], 'https://') === 0)
3916
			$context['user']['avatar']['href'] = $user_info['avatar']['url'];
3917
		// Otherwise we assume it's server stored.
3918
		elseif ($user_info['avatar']['url'] != '')
3919
			$context['user']['avatar']['href'] = $modSettings['avatar_url'] . '/' . $smcFunc['htmlspecialchars']($user_info['avatar']['url']);
3920
		// No avatar at all? Fine, we have a big fat default avatar ;)
3921
		else
3922
			$context['user']['avatar']['href'] = $modSettings['avatar_url'] . '/default.png';
3923
3924
		if (!empty($context['user']['avatar']))
3925
			$context['user']['avatar']['image'] = '<img src="' . $context['user']['avatar']['href'] . '" alt="" class="avatar">';
3926
3927
		// Figure out how long they've been logged in.
3928
		$context['user']['total_time_logged_in'] = array(
3929
			'days' => floor($user_info['total_time_logged_in'] / 86400),
3930
			'hours' => floor(($user_info['total_time_logged_in'] % 86400) / 3600),
3931
			'minutes' => floor(($user_info['total_time_logged_in'] % 3600) / 60)
3932
		);
3933
	}
3934
	else
3935
	{
3936
		$context['user']['messages'] = 0;
3937
		$context['user']['unread_messages'] = 0;
3938
		$context['user']['avatar'] = array();
3939
		$context['user']['total_time_logged_in'] = array('days' => 0, 'hours' => 0, 'minutes' => 0);
3940
		$context['user']['popup_messages'] = false;
3941
3942
		// If we've upgraded recently, go easy on the passwords.
3943
		if (!empty($modSettings['disableHashTime']) && ($modSettings['disableHashTime'] == 1 || time() < $modSettings['disableHashTime']))
3944
			$context['disable_login_hashing'] = true;
3945
	}
3946
3947
	// Setup the main menu items.
3948
	setupMenuContext();
3949
3950
	// This is here because old index templates might still use it.
3951
	$context['show_news'] = !empty($settings['enable_news']);
3952
3953
	// This is done to allow theme authors to customize it as they want.
3954
	$context['show_pm_popup'] = $context['user']['popup_messages'] && !empty($options['popup_messages']) && (!isset($_REQUEST['action']) || $_REQUEST['action'] != 'pm');
3955
3956
	// 2.1+: Add the PM popup here instead. Theme authors can still override it simply by editing/removing the 'fPmPopup' in the array.
3957
	if ($context['show_pm_popup'])
3958
		addInlineJavaScript('
3959
		jQuery(document).ready(function($) {
3960
			new smc_Popup({
3961
				heading: ' . JavaScriptEscape($txt['show_personal_messages_heading']) . ',
3962
				content: ' . JavaScriptEscape(sprintf($txt['show_personal_messages'], $context['user']['unread_messages'], $scripturl . '?action=pm')) . ',
3963
				icon_class: \'main_icons mail_new\'
3964
			});
3965
		});');
3966
3967
	// Add a generic "Are you sure?" confirmation message.
3968
	addInlineJavaScript('
3969
	var smf_you_sure =' . JavaScriptEscape($txt['quickmod_confirm']) . ';');
3970
3971
	// Now add the capping code for avatars.
3972
	if (!empty($modSettings['avatar_max_width_external']) && !empty($modSettings['avatar_max_height_external']) && !empty($modSettings['avatar_action_too_large']) && $modSettings['avatar_action_too_large'] == 'option_css_resize')
3973
		addInlineCss('
3974
	img.avatar { max-width: ' . $modSettings['avatar_max_width_external'] . 'px; max-height: ' . $modSettings['avatar_max_height_external'] . 'px; }');
3975
3976
	// Add max image limits
3977
	if (!empty($modSettings['max_image_width']))
3978
		addInlineCss('
3979
	.postarea .bbc_img, .list_posts .bbc_img, .post .inner .bbc_img, form#reported_posts .bbc_img, #preview_body .bbc_img { max-width: ' . $modSettings['max_image_width'] . 'px; }');
3980
3981
	if (!empty($modSettings['max_image_height']))
3982
		addInlineCss('
3983
	.postarea .bbc_img, .list_posts .bbc_img, .post .inner .bbc_img, form#reported_posts .bbc_img, #preview_body .bbc_img { max-height: ' . $modSettings['max_image_height'] . 'px; }');
3984
3985
	// This looks weird, but it's because BoardIndex.php references the variable.
3986
	$context['common_stats']['latest_member'] = array(
3987
		'id' => $modSettings['latestMember'],
3988
		'name' => $modSettings['latestRealName'],
3989
		'href' => $scripturl . '?action=profile;u=' . $modSettings['latestMember'],
3990
		'link' => '<a href="' . $scripturl . '?action=profile;u=' . $modSettings['latestMember'] . '">' . $modSettings['latestRealName'] . '</a>',
3991
	);
3992
	$context['common_stats'] = array(
3993
		'total_posts' => comma_format($modSettings['totalMessages']),
3994
		'total_topics' => comma_format($modSettings['totalTopics']),
3995
		'total_members' => comma_format($modSettings['totalMembers']),
3996
		'latest_member' => $context['common_stats']['latest_member'],
3997
	);
3998
	$context['common_stats']['boardindex_total_posts'] = sprintf($txt['boardindex_total_posts'], $context['common_stats']['total_posts'], $context['common_stats']['total_topics'], $context['common_stats']['total_members']);
3999
4000
	if (empty($settings['theme_version']))
4001
		addJavaScriptVar('smf_scripturl', $scripturl);
4002
4003
	if (!isset($context['page_title']))
4004
		$context['page_title'] = '';
4005
4006
	// Set some specific vars.
4007
	$context['page_title_html_safe'] = $smcFunc['htmlspecialchars'](un_htmlspecialchars($context['page_title'])) . (!empty($context['current_page']) ? ' - ' . $txt['page'] . ' ' . ($context['current_page'] + 1) : '');
4008
	$context['meta_keywords'] = !empty($modSettings['meta_keywords']) ? $smcFunc['htmlspecialchars']($modSettings['meta_keywords']) : '';
4009
4010
	// Content related meta tags, including Open Graph
4011
	$context['meta_tags'][] = array('property' => 'og:site_name', 'content' => $context['forum_name']);
4012
	$context['meta_tags'][] = array('property' => 'og:title', 'content' => $context['page_title_html_safe']);
4013
4014
	if (!empty($context['meta_keywords']))
4015
		$context['meta_tags'][] = array('name' => 'keywords', 'content' => $context['meta_keywords']);
4016
4017
	if (!empty($context['canonical_url']))
4018
		$context['meta_tags'][] = array('property' => 'og:url', 'content' => $context['canonical_url']);
4019
4020
	if (!empty($settings['og_image']))
4021
		$context['meta_tags'][] = array('property' => 'og:image', 'content' => $settings['og_image']);
4022
4023
	if (!empty($context['meta_description']))
4024
	{
4025
		$context['meta_tags'][] = array('property' => 'og:description', 'content' => $context['meta_description']);
4026
		$context['meta_tags'][] = array('name' => 'description', 'content' => $context['meta_description']);
4027
	}
4028
	else
4029
	{
4030
		$context['meta_tags'][] = array('property' => 'og:description', 'content' => $context['page_title_html_safe']);
4031
		$context['meta_tags'][] = array('name' => 'description', 'content' => $context['page_title_html_safe']);
4032
	}
4033
4034
	call_integration_hook('integrate_theme_context');
4035
}
4036
4037
/**
4038
 * Helper function to set the system memory to a needed value
4039
 * - If the needed memory is greater than current, will attempt to get more
4040
 * - if in_use is set to true, will also try to take the current memory usage in to account
4041
 *
4042
 * @param string $needed The amount of memory to request, if needed, like 256M
4043
 * @param bool $in_use Set to true to account for current memory usage of the script
4044
 * @return boolean True if we have at least the needed memory
4045
 */
4046
function setMemoryLimit($needed, $in_use = false)
4047
{
4048
	// everything in bytes
4049
	$memory_current = memoryReturnBytes(ini_get('memory_limit'));
4050
	$memory_needed = memoryReturnBytes($needed);
4051
4052
	// should we account for how much is currently being used?
4053
	if ($in_use)
4054
		$memory_needed += function_exists('memory_get_usage') ? memory_get_usage() : (2 * 1048576);
4055
4056
	// if more is needed, request it
4057
	if ($memory_current < $memory_needed)
4058
	{
4059
		@ini_set('memory_limit', ceil($memory_needed / 1048576) . 'M');
4060
		$memory_current = memoryReturnBytes(ini_get('memory_limit'));
4061
	}
4062
4063
	$memory_current = max($memory_current, memoryReturnBytes(get_cfg_var('memory_limit')));
0 ignored issues
show
Bug introduced by
It seems like get_cfg_var('memory_limit') can also be of type array; however, parameter $val of memoryReturnBytes() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

4063
	$memory_current = max($memory_current, memoryReturnBytes(/** @scrutinizer ignore-type */ get_cfg_var('memory_limit')));
Loading history...
4064
4065
	// return success or not
4066
	return (bool) ($memory_current >= $memory_needed);
4067
}
4068
4069
/**
4070
 * Helper function to convert memory string settings to bytes
4071
 *
4072
 * @param string $val The byte string, like 256M or 1G
4073
 * @return integer The string converted to a proper integer in bytes
4074
 */
4075
function memoryReturnBytes($val)
4076
{
4077
	if (is_integer($val))
0 ignored issues
show
introduced by
The condition is_integer($val) is always false.
Loading history...
4078
		return $val;
4079
4080
	// Separate the number from the designator
4081
	$val = trim($val);
4082
	$num = intval(substr($val, 0, strlen($val) - 1));
4083
	$last = strtolower(substr($val, -1));
4084
4085
	// convert to bytes
4086
	switch ($last)
4087
	{
4088
		case 'g':
4089
			$num *= 1024;
0 ignored issues
show
Coding Style Comprehensibility introduced by
Consider adding a comment if this fall-through is intended.
Loading history...
4090
		case 'm':
4091
			$num *= 1024;
0 ignored issues
show
Coding Style Comprehensibility introduced by
Consider adding a comment if this fall-through is intended.
Loading history...
4092
		case 'k':
4093
			$num *= 1024;
4094
	}
4095
	return $num;
4096
}
4097
4098
/**
4099
 * The header template
4100
 */
4101
function template_header()
4102
{
4103
	global $txt, $modSettings, $context, $user_info, $boarddir, $cachedir, $cache_enable, $language;
4104
4105
	setupThemeContext();
4106
4107
	// Print stuff to prevent caching of pages (except on attachment errors, etc.)
4108
	if (empty($context['no_last_modified']))
4109
	{
4110
		header('expires: Mon, 26 Jul 1997 05:00:00 GMT');
4111
		header('last-modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
4112
4113
		// Are we debugging the template/html content?
4114
		if (!isset($_REQUEST['xml']) && isset($_GET['debug']) && !isBrowser('ie'))
4115
			header('content-type: application/xhtml+xml');
4116
		elseif (!isset($_REQUEST['xml']))
4117
			header('content-type: text/html; charset=' . (empty($context['character_set']) ? 'ISO-8859-1' : $context['character_set']));
4118
	}
4119
4120
	header('content-type: text/' . (isset($_REQUEST['xml']) ? 'xml' : 'html') . '; charset=' . (empty($context['character_set']) ? 'ISO-8859-1' : $context['character_set']));
4121
4122
	// We need to splice this in after the body layer, or after the main layer for older stuff.
4123
	if ($context['in_maintenance'] && $context['user']['is_admin'])
4124
	{
4125
		$position = array_search('body', $context['template_layers']);
4126
		if ($position === false)
4127
			$position = array_search('main', $context['template_layers']);
4128
4129
		if ($position !== false)
4130
		{
4131
			$before = array_slice($context['template_layers'], 0, $position + 1);
4132
			$after = array_slice($context['template_layers'], $position + 1);
4133
			$context['template_layers'] = array_merge($before, array('maint_warning'), $after);
4134
		}
4135
	}
4136
4137
	$checked_securityFiles = false;
4138
	$showed_banned = false;
4139
	foreach ($context['template_layers'] as $layer)
4140
	{
4141
		loadSubTemplate($layer . '_above', true);
4142
4143
		// May seem contrived, but this is done in case the body and main layer aren't there...
4144
		if (in_array($layer, array('body', 'main')) && allowedTo('admin_forum') && !$user_info['is_guest'] && !$checked_securityFiles)
4145
		{
4146
			$checked_securityFiles = true;
4147
4148
			$securityFiles = array('install.php', 'upgrade.php', 'convert.php', 'repair_paths.php', 'repair_settings.php', 'Settings.php~', 'Settings_bak.php~');
4149
4150
			// Add your own files.
4151
			call_integration_hook('integrate_security_files', array(&$securityFiles));
4152
4153
			foreach ($securityFiles as $i => $securityFile)
4154
			{
4155
				if (!file_exists($boarddir . '/' . $securityFile))
4156
					unset($securityFiles[$i]);
4157
			}
4158
4159
			// We are already checking so many files...just few more doesn't make any difference! :P
4160
			if (!empty($modSettings['currentAttachmentUploadDir']))
4161
				$path = $modSettings['attachmentUploadDir'][$modSettings['currentAttachmentUploadDir']];
4162
4163
			else
4164
				$path = $modSettings['attachmentUploadDir'];
4165
4166
			secureDirectory($path, true);
4167
			secureDirectory($cachedir);
4168
4169
			// If agreement is enabled, at least the english version shall exist
4170
			if (!empty($modSettings['requireAgreement']))
4171
				$agreement = !file_exists($boarddir . '/agreement.txt');
4172
4173
			// If privacy policy is enabled, at least the default language version shall exist
4174
			if (!empty($modSettings['requirePolicyAgreement']))
4175
				$policy_agreement = empty($modSettings['policy_' . $language]);
4176
4177
			if (!empty($securityFiles) ||
4178
				(!empty($cache_enable) && !is_writable($cachedir)) ||
4179
				!empty($agreement) ||
4180
				!empty($policy_agreement) ||
4181
				!empty($context['auth_secret_missing']))
4182
			{
4183
				echo '
4184
		<div class="errorbox">
4185
			<p class="alert">!!</p>
4186
			<h3>', empty($securityFiles) && empty($context['auth_secret_missing']) ? $txt['generic_warning'] : $txt['security_risk'], '</h3>
4187
			<p>';
4188
4189
				foreach ($securityFiles as $securityFile)
4190
				{
4191
					echo '
4192
				', $txt['not_removed'], '<strong>', $securityFile, '</strong>!<br>';
4193
4194
					if ($securityFile == 'Settings.php~' || $securityFile == 'Settings_bak.php~')
4195
						echo '
4196
				', sprintf($txt['not_removed_extra'], $securityFile, substr($securityFile, 0, -1)), '<br>';
4197
				}
4198
4199
				if (!empty($cache_enable) && !is_writable($cachedir))
4200
					echo '
4201
				<strong>', $txt['cache_writable'], '</strong><br>';
4202
4203
				if (!empty($agreement))
4204
					echo '
4205
				<strong>', $txt['agreement_missing'], '</strong><br>';
4206
4207
				if (!empty($policy_agreement))
4208
					echo '
4209
				<strong>', $txt['policy_agreement_missing'], '</strong><br>';
4210
4211
				if (!empty($context['auth_secret_missing']))
4212
					echo '
4213
				<strong>', $txt['auth_secret_missing'], '</strong><br>';
4214
4215
				echo '
4216
			</p>
4217
		</div>';
4218
			}
4219
		}
4220
		// If the user is banned from posting inform them of it.
4221
		elseif (in_array($layer, array('main', 'body')) && isset($_SESSION['ban']['cannot_post']) && !$showed_banned)
4222
		{
4223
			$showed_banned = true;
4224
			echo '
4225
				<div class="windowbg alert" style="margin: 2ex; padding: 2ex; border: 2px dashed red;">
4226
					', sprintf($txt['you_are_post_banned'], $user_info['is_guest'] ? $txt['guest_title'] : $user_info['name']);
4227
4228
			if (!empty($_SESSION['ban']['cannot_post']['reason']))
4229
				echo '
4230
					<div style="padding-left: 4ex; padding-top: 1ex;">', $_SESSION['ban']['cannot_post']['reason'], '</div>';
4231
4232
			if (!empty($_SESSION['ban']['expire_time']))
4233
				echo '
4234
					<div>', sprintf($txt['your_ban_expires'], timeformat($_SESSION['ban']['expire_time'], false)), '</div>';
4235
			else
4236
				echo '
4237
					<div>', $txt['your_ban_expires_never'], '</div>';
4238
4239
			echo '
4240
				</div>';
4241
		}
4242
	}
4243
}
4244
4245
/**
4246
 * Show the copyright.
4247
 */
4248
function theme_copyright()
4249
{
4250
	global $forum_copyright, $scripturl;
4251
4252
	// Don't display copyright for things like SSI.
4253
	if (SMF !== 1)
0 ignored issues
show
introduced by
The condition SMF !== 1 is always true.
Loading history...
4254
		return;
4255
4256
	// Put in the version...
4257
	printf($forum_copyright, SMF_FULL_VERSION, SMF_SOFTWARE_YEAR, $scripturl);
4258
}
4259
4260
/**
4261
 * The template footer
4262
 */
4263
function template_footer()
4264
{
4265
	global $context, $modSettings, $db_count;
4266
4267
	// Show the load time?  (only makes sense for the footer.)
4268
	$context['show_load_time'] = !empty($modSettings['timeLoadPageEnable']);
4269
	$context['load_time'] = round(microtime(true) - TIME_START, 3);
4270
	$context['load_queries'] = $db_count;
4271
4272
	if (!empty($context['template_layers']) && is_array($context['template_layers']))
4273
		foreach (array_reverse($context['template_layers']) as $layer)
4274
			loadSubTemplate($layer . '_below', true);
4275
}
4276
4277
/**
4278
 * Output the Javascript files
4279
 * 	- tabbing in this function is to make the HTML source look good and proper
4280
 *  - if deferred is set function will output all JS set to load at page end
4281
 *
4282
 * @param bool $do_deferred If true will only output the deferred JS (the stuff that goes right before the closing body tag)
4283
 */
4284
function template_javascript($do_deferred = false)
4285
{
4286
	global $context, $modSettings, $settings;
4287
4288
	// Use this hook to minify/optimize Javascript files and vars
4289
	call_integration_hook('integrate_pre_javascript_output', array(&$do_deferred));
4290
4291
	$toMinify = array(
4292
		'standard' => array(),
4293
		'defer' => array(),
4294
		'async' => array(),
4295
	);
4296
4297
	// Ouput the declared Javascript variables.
4298
	if (!empty($context['javascript_vars']) && !$do_deferred)
4299
	{
4300
		echo '
4301
	<script>';
4302
4303
		foreach ($context['javascript_vars'] as $key => $value)
4304
		{
4305
			if (empty($value))
4306
			{
4307
				echo '
4308
		var ', $key, ';';
4309
			}
4310
			else
4311
			{
4312
				echo '
4313
		var ', $key, ' = ', $value, ';';
4314
			}
4315
		}
4316
4317
		echo '
4318
	</script>';
4319
	}
4320
4321
	// In the dark days before HTML5, deferred JS files needed to be loaded at the end of the body.
4322
	// Now we load them in the head and use 'async' and/or 'defer' attributes. Much better performance.
4323
	if (!$do_deferred)
4324
	{
4325
		// While we have JavaScript files to place in the template.
4326
		foreach ($context['javascript_files'] as $id => $js_file)
4327
		{
4328
			// Last minute call! allow theme authors to disable single files.
4329
			if (!empty($settings['disable_files']) && in_array($id, $settings['disable_files']))
4330
				continue;
4331
4332
			// By default files don't get minimized unless the file explicitly says so!
4333
			if (!empty($js_file['options']['minimize']) && !empty($modSettings['minimize_files']))
4334
			{
4335
				if (!empty($js_file['options']['async']))
4336
					$toMinify['async'][] = $js_file;
4337
4338
				elseif (!empty($js_file['options']['defer']))
4339
					$toMinify['defer'][] = $js_file;
4340
4341
				else
4342
					$toMinify['standard'][] = $js_file;
4343
4344
				// Grab a random seed.
4345
				if (!isset($minSeed) && isset($js_file['options']['seed']))
4346
					$minSeed = $js_file['options']['seed'];
4347
			}
4348
4349
			else
4350
			{
4351
				echo '
4352
	<script src="', $js_file['fileUrl'], isset($js_file['options']['seed']) ? $js_file['options']['seed'] : '', '"', !empty($js_file['options']['async']) ? ' async' : '', !empty($js_file['options']['defer']) ? ' defer' : '';
4353
4354
				if (!empty($js_file['options']['attributes']))
4355
					foreach ($js_file['options']['attributes'] as $key => $value)
4356
					{
4357
						if (is_bool($value))
4358
							echo !empty($value) ? ' ' . $key : '';
4359
4360
						else
4361
							echo ' ', $key, '="', $value, '"';
4362
					}
4363
4364
				echo '></script>';
4365
			}
4366
		}
4367
4368
		foreach ($toMinify as $js_files)
4369
		{
4370
			if (!empty($js_files))
4371
			{
4372
				$result = custMinify($js_files, 'js');
4373
4374
				$minSuccessful = array_keys($result) === array('smf_minified');
4375
4376
				foreach ($result as $minFile)
4377
					echo '
4378
	<script src="', $minFile['fileUrl'], $minSuccessful && isset($minSeed) ? $minSeed : '', '"', !empty($minFile['options']['async']) ? ' async' : '', !empty($minFile['options']['defer']) ? ' defer' : '', '></script>';
4379
			}
4380
		}
4381
	}
4382
4383
	// Inline JavaScript - Actually useful some times!
4384
	if (!empty($context['javascript_inline']))
4385
	{
4386
		if (!empty($context['javascript_inline']['defer']) && $do_deferred)
4387
		{
4388
			echo '
4389
<script>
4390
window.addEventListener("DOMContentLoaded", function() {';
4391
4392
			foreach ($context['javascript_inline']['defer'] as $js_code)
4393
				echo $js_code;
4394
4395
			echo '
4396
});
4397
</script>';
4398
		}
4399
4400
		if (!empty($context['javascript_inline']['standard']) && !$do_deferred)
4401
		{
4402
			echo '
4403
	<script>';
4404
4405
			foreach ($context['javascript_inline']['standard'] as $js_code)
4406
				echo $js_code;
4407
4408
			echo '
4409
	</script>';
4410
		}
4411
	}
4412
}
4413
4414
/**
4415
 * Output the CSS files
4416
 */
4417
function template_css()
4418
{
4419
	global $context, $db_show_debug, $boardurl, $settings, $modSettings;
4420
4421
	// Use this hook to minify/optimize CSS files
4422
	call_integration_hook('integrate_pre_css_output');
4423
4424
	$toMinify = array();
4425
	$normal = array();
4426
4427
	uasort($context['css_files'], function ($a, $b)
4428
	{
4429
		return $a['options']['order_pos'] < $b['options']['order_pos'] ? -1 : ($a['options']['order_pos'] > $b['options']['order_pos'] ? 1 : 0);
4430
	});
4431
	foreach ($context['css_files'] as $id => $file)
4432
	{
4433
		// Last minute call! allow theme authors to disable single files.
4434
		if (!empty($settings['disable_files']) && in_array($id, $settings['disable_files']))
4435
			continue;
4436
4437
		// Files are minimized unless they explicitly opt out.
4438
		if (!isset($file['options']['minimize']))
4439
			$file['options']['minimize'] = true;
4440
4441
		if (!empty($file['options']['minimize']) && !empty($modSettings['minimize_files']) && !isset($_REQUEST['normalcss']))
4442
		{
4443
			$toMinify[] = $file;
4444
4445
			// Grab a random seed.
4446
			if (!isset($minSeed) && isset($file['options']['seed']))
4447
				$minSeed = $file['options']['seed'];
4448
		}
4449
		else
4450
			$normal[] = array(
4451
				'url' => $file['fileUrl'] . (isset($file['options']['seed']) ? $file['options']['seed'] : ''),
4452
				'attributes' => !empty($file['options']['attributes']) ? $file['options']['attributes'] : array()
4453
			);
4454
	}
4455
4456
	if (!empty($toMinify))
4457
	{
4458
		$result = custMinify($toMinify, 'css');
4459
4460
		$minSuccessful = array_keys($result) === array('smf_minified');
4461
4462
		foreach ($result as $minFile)
4463
			echo '
4464
	<link rel="stylesheet" href="', $minFile['fileUrl'], $minSuccessful && isset($minSeed) ? $minSeed : '', '">';
4465
	}
4466
4467
	// Print the rest after the minified files.
4468
	if (!empty($normal))
4469
		foreach ($normal as $nf)
4470
		{
4471
			echo '
4472
	<link rel="stylesheet" href="', $nf['url'], '"';
4473
4474
			if (!empty($nf['attributes']))
4475
				foreach ($nf['attributes'] as $key => $value)
4476
				{
4477
					if (is_bool($value))
4478
						echo !empty($value) ? ' ' . $key : '';
4479
					else
4480
						echo ' ', $key, '="', $value, '"';
4481
				}
4482
4483
			echo '>';
4484
		}
4485
4486
	if ($db_show_debug === true)
4487
	{
4488
		// Try to keep only what's useful.
4489
		$repl = array($boardurl . '/Themes/' => '', $boardurl . '/' => '');
4490
		foreach ($context['css_files'] as $file)
4491
			$context['debug']['sheets'][] = strtr($file['fileName'], $repl);
4492
	}
4493
4494
	if (!empty($context['css_header']))
4495
	{
4496
		echo '
4497
	<style>';
4498
4499
		foreach ($context['css_header'] as $css)
4500
			echo $css . '
4501
	';
4502
4503
		echo '
4504
	</style>';
4505
	}
4506
}
4507
4508
/**
4509
 * Get an array of previously defined files and adds them to our main minified files.
4510
 * Sets a one day cache to avoid re-creating a file on every request.
4511
 *
4512
 * @param array $data The files to minify.
4513
 * @param string $type either css or js.
4514
 * @return array Info about the minified file, or about the original files if the minify process failed.
4515
 */
4516
function custMinify($data, $type)
4517
{
4518
	global $settings, $txt;
4519
4520
	$types = array('css', 'js');
4521
	$type = !empty($type) && in_array($type, $types) ? $type : false;
4522
	$data = is_array($data) ? $data : array();
0 ignored issues
show
introduced by
The condition is_array($data) is always true.
Loading history...
4523
4524
	if (empty($type) || empty($data))
4525
		return $data;
4526
4527
	// Different pages include different files, so we use a hash to label the different combinations
4528
	$hash = md5(implode(' ', array_map(function($file)
4529
	{
4530
		return $file['filePath'] . '-' . $file['mtime'];
4531
	}, $data)));
4532
4533
	// Is this a deferred or asynchronous JavaScript file?
4534
	$async = $type === 'js';
4535
	$defer = $type === 'js';
4536
	if ($type === 'js')
4537
	{
4538
		foreach ($data as $id => $file)
4539
		{
4540
			// A minified script should only be loaded asynchronously if all its components wanted to be.
4541
			if (empty($file['options']['async']))
4542
				$async = false;
4543
4544
			// A minified script should only be deferred if all its components wanted to be.
4545
			if (empty($file['options']['defer']))
4546
				$defer = false;
4547
		}
4548
	}
4549
4550
	// Did we already do this?
4551
	$minified_file = $settings['theme_dir'] . '/' . ($type == 'css' ? 'css' : 'scripts') . '/minified_' . $hash . '.' . $type;
4552
	$already_exists = file_exists($minified_file);
4553
4554
	// Already done?
4555
	if ($already_exists)
4556
	{
4557
		return array('smf_minified' => array(
4558
			'fileUrl' => $settings['theme_url'] . '/' . ($type == 'css' ? 'css' : 'scripts') . '/' . basename($minified_file),
4559
			'filePath' => $minified_file,
4560
			'fileName' => basename($minified_file),
4561
			'options' => array('async' => !empty($async), 'defer' => !empty($defer)),
4562
		));
4563
	}
4564
	// File has to exist. If it doesn't, try to create it.
4565
	elseif (@fopen($minified_file, 'w') === false || !smf_chmod($minified_file))
4566
	{
4567
		loadLanguage('Errors');
4568
		log_error(sprintf($txt['file_not_created'], $minified_file), 'general');
4569
4570
		// The process failed, so roll back to print each individual file.
4571
		return $data;
4572
	}
4573
4574
	// No namespaces, sorry!
4575
	$classType = 'MatthiasMullie\\Minify\\' . strtoupper($type);
4576
4577
	$minifier = new $classType();
4578
4579
	foreach ($data as $id => $file)
4580
	{
4581
		$toAdd = !empty($file['filePath']) && file_exists($file['filePath']) ? $file['filePath'] : false;
4582
4583
		// The file couldn't be located so it won't be added. Log this error.
4584
		if (empty($toAdd))
4585
		{
4586
			loadLanguage('Errors');
4587
			log_error(sprintf($txt['file_minimize_fail'], !empty($file['fileName']) ? $file['fileName'] : $id), 'general');
4588
			continue;
4589
		}
4590
4591
		// Add this file to the list.
4592
		$minifier->add($toAdd);
4593
	}
4594
4595
	// Create the file.
4596
	$minifier->minify($minified_file);
4597
	unset($minifier);
4598
	clearstatcache();
4599
4600
	// Minify process failed.
4601
	if (!filesize($minified_file))
4602
	{
4603
		loadLanguage('Errors');
4604
		log_error(sprintf($txt['file_not_created'], $minified_file), 'general');
4605
4606
		// The process failed so roll back to print each individual file.
4607
		return $data;
4608
	}
4609
4610
	return array('smf_minified' => array(
4611
		'fileUrl' => $settings['theme_url'] . '/' . ($type == 'css' ? 'css' : 'scripts') . '/' . basename($minified_file),
4612
		'filePath' => $minified_file,
4613
		'fileName' => basename($minified_file),
4614
		'options' => array('async' => $async, 'defer' => $defer),
4615
	));
4616
}
4617
4618
/**
4619
 * Clears out old minimized CSS and JavaScript files and ensures $modSettings['browser_cache'] is up to date
4620
 */
4621
function deleteAllMinified()
4622
{
4623
	global $smcFunc, $txt, $modSettings;
4624
4625
	$not_deleted = array();
4626
	$most_recent = 0;
4627
4628
	// Kinda sucks that we need to do another query to get all the theme dirs, but c'est la vie.
4629
	$request = $smcFunc['db_query']('', '
4630
		SELECT id_theme AS id, value AS dir
4631
		FROM {db_prefix}themes
4632
		WHERE variable = {string:var}',
4633
		array(
4634
			'var' => 'theme_dir',
4635
		)
4636
	);
4637
	while ($theme = $smcFunc['db_fetch_assoc']($request))
4638
	{
4639
		foreach (array('css', 'js') as $type)
4640
		{
4641
			foreach (glob(rtrim($theme['dir'], '/') . '/' . ($type == 'css' ? 'css' : 'scripts') . '/*.' . $type) as $filename)
4642
			{
4643
				// We want to find the most recent mtime of non-minified files
4644
				if (strpos(pathinfo($filename, PATHINFO_BASENAME), 'minified') === false)
0 ignored issues
show
Bug introduced by
It seems like pathinfo($filename, PATHINFO_BASENAME) can also be of type array; however, parameter $haystack of strpos() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

4644
				if (strpos(/** @scrutinizer ignore-type */ pathinfo($filename, PATHINFO_BASENAME), 'minified') === false)
Loading history...
4645
					$most_recent = max($modSettings['browser_cache'], (int) @filemtime($filename));
4646
4647
				// Try to delete minified files. Add them to our error list if that fails.
4648
				elseif (!@unlink($filename))
4649
					$not_deleted[] = $filename;
4650
			}
4651
		}
4652
	}
4653
	$smcFunc['db_free_result']($request);
4654
4655
	// This setting tracks the most recent modification time of any of our CSS and JS files
4656
	if ($most_recent > $modSettings['browser_cache'])
4657
		updateSettings(array('browser_cache' => $most_recent));
4658
4659
	// If any of the files could not be deleted, log an error about it.
4660
	if (!empty($not_deleted))
4661
	{
4662
		loadLanguage('Errors');
4663
		log_error(sprintf($txt['unlink_minimized_fail'], implode('<br>', $not_deleted)), 'general');
4664
	}
4665
}
4666
4667
/**
4668
 * Get an attachment's encrypted filename. If $new is true, won't check for file existence.
4669
 *
4670
 * @todo this currently returns the hash if new, and the full filename otherwise.
4671
 * Something messy like that.
4672
 * @todo and of course everything relies on this behavior and work around it. :P.
4673
 * Converters included.
4674
 *
4675
 * @param string $filename The name of the file
4676
 * @param int $attachment_id The ID of the attachment
4677
 * @param string|null $dir Which directory it should be in (null to use current one)
4678
 * @param bool $new Whether this is a new attachment
4679
 * @param string $file_hash The file hash
4680
 * @return string The path to the file
4681
 */
4682
function getAttachmentFilename($filename, $attachment_id, $dir = null, $new = false, $file_hash = '')
4683
{
4684
	global $modSettings, $smcFunc;
4685
4686
	// Just make up a nice hash...
4687
	if ($new)
4688
		return sha1(md5($filename . time()) . mt_rand());
4689
4690
	// Just make sure that attachment id is only a int
4691
	$attachment_id = (int) $attachment_id;
4692
4693
	// Grab the file hash if it wasn't added.
4694
	// Left this for legacy.
4695
	if ($file_hash === '')
4696
	{
4697
		$request = $smcFunc['db_query']('', '
4698
			SELECT file_hash
4699
			FROM {db_prefix}attachments
4700
			WHERE id_attach = {int:id_attach}',
4701
			array(
4702
				'id_attach' => $attachment_id,
4703
			)
4704
		);
4705
4706
		if ($smcFunc['db_num_rows']($request) === 0)
4707
			return false;
4708
4709
		list ($file_hash) = $smcFunc['db_fetch_row']($request);
4710
		$smcFunc['db_free_result']($request);
4711
	}
4712
4713
	// Still no hash? mmm...
4714
	if (empty($file_hash))
4715
		$file_hash = sha1(md5($filename . time()) . mt_rand());
4716
4717
	// Are we using multiple directories?
4718
	if (is_array($modSettings['attachmentUploadDir']))
4719
		$path = $modSettings['attachmentUploadDir'][$dir];
4720
4721
	else
4722
		$path = $modSettings['attachmentUploadDir'];
4723
4724
	return $path . '/' . $attachment_id . '_' . $file_hash . '.dat';
4725
}
4726
4727
/**
4728
 * Convert a single IP to a ranged IP.
4729
 * internal function used to convert a user-readable format to a format suitable for the database.
4730
 *
4731
 * @param string $fullip The full IP
4732
 * @return array An array of IP parts
4733
 */
4734
function ip2range($fullip)
4735
{
4736
	// Pretend that 'unknown' is 255.255.255.255. (since that can't be an IP anyway.)
4737
	if ($fullip == 'unknown')
4738
		$fullip = '255.255.255.255';
4739
4740
	$ip_parts = explode('-', $fullip);
4741
	$ip_array = array();
4742
4743
	// if ip 22.12.31.21
4744
	if (count($ip_parts) == 1 && isValidIP($fullip))
4745
	{
4746
		$ip_array['low'] = $fullip;
4747
		$ip_array['high'] = $fullip;
4748
		return $ip_array;
4749
	} // if ip 22.12.* -> 22.12.* - 22.12.*
4750
	elseif (count($ip_parts) == 1)
4751
	{
4752
		$ip_parts[0] = $fullip;
4753
		$ip_parts[1] = $fullip;
4754
	}
4755
4756
	// if ip 22.12.31.21-12.21.31.21
4757
	if (count($ip_parts) == 2 && isValidIP($ip_parts[0]) && isValidIP($ip_parts[1]))
4758
	{
4759
		$ip_array['low'] = $ip_parts[0];
4760
		$ip_array['high'] = $ip_parts[1];
4761
		return $ip_array;
4762
	}
4763
	elseif (count($ip_parts) == 2) // if ip 22.22.*-22.22.*
4764
	{
4765
		$valid_low = isValidIP($ip_parts[0]);
4766
		$valid_high = isValidIP($ip_parts[1]);
4767
		$count = 0;
4768
		$mode = (preg_match('/:/', $ip_parts[0]) > 0 ? ':' : '.');
4769
		$max = ($mode == ':' ? 'ffff' : '255');
4770
		$min = 0;
4771
		if (!$valid_low)
4772
		{
4773
			$ip_parts[0] = preg_replace('/\*/', '0', $ip_parts[0]);
4774
			$valid_low = isValidIP($ip_parts[0]);
4775
			while (!$valid_low)
4776
			{
4777
				$ip_parts[0] .= $mode . $min;
4778
				$valid_low = isValidIP($ip_parts[0]);
4779
				$count++;
4780
				if ($count > 9) break;
4781
			}
4782
		}
4783
4784
		$count = 0;
4785
		if (!$valid_high)
4786
		{
4787
			$ip_parts[1] = preg_replace('/\*/', $max, $ip_parts[1]);
4788
			$valid_high = isValidIP($ip_parts[1]);
4789
			while (!$valid_high)
4790
			{
4791
				$ip_parts[1] .= $mode . $max;
4792
				$valid_high = isValidIP($ip_parts[1]);
4793
				$count++;
4794
				if ($count > 9) break;
4795
			}
4796
		}
4797
4798
		if ($valid_high && $valid_low)
4799
		{
4800
			$ip_array['low'] = $ip_parts[0];
4801
			$ip_array['high'] = $ip_parts[1];
4802
		}
4803
	}
4804
4805
	return $ip_array;
4806
}
4807
4808
/**
4809
 * Lookup an IP; try shell_exec first because we can do a timeout on it.
4810
 *
4811
 * @param string $ip The IP to get the hostname from
4812
 * @return string The hostname
4813
 */
4814
function host_from_ip($ip)
4815
{
4816
	global $modSettings;
4817
4818
	if (($host = cache_get_data('hostlookup-' . $ip, 600)) !== null)
4819
		return $host;
4820
	$t = microtime(true);
4821
4822
	// Try the Linux host command, perhaps?
4823
	if (!isset($host) && (strpos(strtolower(PHP_OS), 'win') === false || strpos(strtolower(PHP_OS), 'darwin') !== false) && mt_rand(0, 1) == 1)
4824
	{
4825
		if (!isset($modSettings['host_to_dis']))
4826
			$test = @shell_exec('host -W 1 ' . @escapeshellarg($ip));
4827
		else
4828
			$test = @shell_exec('host ' . @escapeshellarg($ip));
4829
4830
		// Did host say it didn't find anything?
4831
		if (strpos($test, 'not found') !== false)
0 ignored issues
show
Bug introduced by
It seems like $test can also be of type false; however, parameter $haystack of strpos() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

4831
		if (strpos(/** @scrutinizer ignore-type */ $test, 'not found') !== false)
Loading history...
4832
			$host = '';
4833
		// Invalid server option?
4834
		elseif ((strpos($test, 'invalid option') || strpos($test, 'Invalid query name 1')) && !isset($modSettings['host_to_dis']))
4835
			updateSettings(array('host_to_dis' => 1));
4836
		// Maybe it found something, after all?
4837
		elseif (preg_match('~\s([^\s]+?)\.\s~', $test, $match) == 1)
0 ignored issues
show
Bug introduced by
It seems like $test can also be of type false; however, parameter $subject of preg_match() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

4837
		elseif (preg_match('~\s([^\s]+?)\.\s~', /** @scrutinizer ignore-type */ $test, $match) == 1)
Loading history...
4838
			$host = $match[1];
4839
	}
4840
4841
	// This is nslookup; usually only Windows, but possibly some Unix?
4842
	if (!isset($host) && stripos(PHP_OS, 'win') !== false && strpos(strtolower(PHP_OS), 'darwin') === false && mt_rand(0, 1) == 1)
4843
	{
4844
		$test = @shell_exec('nslookup -timeout=1 ' . @escapeshellarg($ip));
4845
		if (strpos($test, 'Non-existent domain') !== false)
4846
			$host = '';
4847
		elseif (preg_match('~Name:\s+([^\s]+)~', $test, $match) == 1)
4848
			$host = $match[1];
4849
	}
4850
4851
	// This is the last try :/.
4852
	if (!isset($host) || $host === false)
4853
		$host = @gethostbyaddr($ip);
4854
4855
	// It took a long time, so let's cache it!
4856
	if (microtime(true) - $t > 0.5)
4857
		cache_put_data('hostlookup-' . $ip, $host, 600);
4858
4859
	return $host;
4860
}
4861
4862
/**
4863
 * Chops a string into words and prepares them to be inserted into (or searched from) the database.
4864
 *
4865
 * @param string $text The text to split into words
4866
 * @param int $max_chars The maximum number of characters per word
4867
 * @param bool $encrypt Whether to encrypt the results
4868
 * @return array An array of ints or words depending on $encrypt
4869
 */
4870
function text2words($text, $max_chars = 20, $encrypt = false)
4871
{
4872
	global $smcFunc, $context;
4873
4874
	// Upgrader may be working on old DBs...
4875
	if (!isset($context['utf8']))
4876
		$context['utf8'] = false;
4877
4878
	// Step 1: Remove entities/things we don't consider words:
4879
	$words = preg_replace('~(?:[\x0B\0' . ($context['utf8'] ? '\x{A0}' : '\xA0') . '\t\r\s\n(){}\\[\\]<>!@$%^*.,:+=`\~\?/\\\\]+|&(?:amp|lt|gt|quot);)+~' . ($context['utf8'] ? 'u' : ''), ' ', strtr($text, array('<br>' => ' ')));
4880
4881
	// Step 2: Entities we left to letters, where applicable, lowercase.
4882
	$words = un_htmlspecialchars($smcFunc['strtolower']($words));
4883
4884
	// Step 3: Ready to split apart and index!
4885
	$words = explode(' ', $words);
4886
4887
	if ($encrypt)
4888
	{
4889
		$possible_chars = array_flip(array_merge(range(46, 57), range(65, 90), range(97, 122)));
4890
		$returned_ints = array();
4891
		foreach ($words as $word)
4892
		{
4893
			if (($word = trim($word, '-_\'')) !== '')
4894
			{
4895
				$encrypted = substr(crypt($word, 'uk'), 2, $max_chars);
4896
				$total = 0;
4897
				for ($i = 0; $i < $max_chars; $i++)
4898
					$total += $possible_chars[ord($encrypted[$i])] * pow(63, $i);
4899
				$returned_ints[] = $max_chars == 4 ? min($total, 16777215) : $total;
4900
			}
4901
		}
4902
		return array_unique($returned_ints);
4903
	}
4904
	else
4905
	{
4906
		// Trim characters before and after and add slashes for database insertion.
4907
		$returned_words = array();
4908
		foreach ($words as $word)
4909
			if (($word = trim($word, '-_\'')) !== '')
4910
				$returned_words[] = $max_chars === null ? $word : substr($word, 0, $max_chars);
4911
4912
		// Filter out all words that occur more than once.
4913
		return array_unique($returned_words);
4914
	}
4915
}
4916
4917
/**
4918
 * Creates an image/text button
4919
 *
4920
 * @deprecated since 2.1
4921
 * @param string $name The name of the button (should be a main_icons class or the name of an image)
4922
 * @param string $alt The alt text
4923
 * @param string $label The $txt string to use as the label
4924
 * @param string $custom Custom text/html to add to the img tag (only when using an actual image)
4925
 * @param boolean $force_use Whether to force use of this when template_create_button is available
4926
 * @return string The HTML to display the button
4927
 */
4928
function create_button($name, $alt, $label = '', $custom = '', $force_use = false)
4929
{
4930
	global $settings, $txt;
4931
4932
	// Does the current loaded theme have this and we are not forcing the usage of this function?
4933
	if (function_exists('template_create_button') && !$force_use)
4934
		return template_create_button($name, $alt, $label = '', $custom = '');
4935
4936
	if (!$settings['use_image_buttons'])
4937
		return $txt[$alt];
4938
	elseif (!empty($settings['use_buttons']))
4939
		return '<span class="main_icons ' . $name . '" alt="' . $txt[$alt] . '"></span>' . ($label != '' ? '&nbsp;<strong>' . $txt[$label] . '</strong>' : '');
4940
	else
4941
		return '<img src="' . $settings['lang_images_url'] . '/' . $name . '" alt="' . $txt[$alt] . '" ' . $custom . '>';
4942
}
4943
4944
/**
4945
 * Sets up all of the top menu buttons
4946
 * Saves them in the cache if it is available and on
4947
 * Places the results in $context
4948
 */
4949
function setupMenuContext()
4950
{
4951
	global $context, $modSettings, $user_info, $txt, $scripturl, $sourcedir, $settings, $smcFunc, $cache_enable;
4952
4953
	// Set up the menu privileges.
4954
	$context['allow_search'] = !empty($modSettings['allow_guestAccess']) ? allowedTo('search_posts') : (!$user_info['is_guest'] && allowedTo('search_posts'));
4955
	$context['allow_admin'] = allowedTo(array('admin_forum', 'manage_boards', 'manage_permissions', 'moderate_forum', 'manage_membergroups', 'manage_bans', 'send_mail', 'edit_news', 'manage_attachments', 'manage_smileys'));
4956
4957
	$context['allow_memberlist'] = allowedTo('view_mlist');
4958
	$context['allow_calendar'] = allowedTo('calendar_view') && !empty($modSettings['cal_enabled']);
4959
	$context['allow_moderation_center'] = $context['user']['can_mod'];
4960
	$context['allow_pm'] = allowedTo('pm_read');
4961
4962
	$cacheTime = $modSettings['lastActive'] * 60;
4963
4964
	// Initial "can you post an event in the calendar" option - but this might have been set in the calendar already.
4965
	if (!isset($context['allow_calendar_event']))
4966
	{
4967
		$context['allow_calendar_event'] = $context['allow_calendar'] && allowedTo('calendar_post');
4968
4969
		// If you don't allow events not linked to posts and you're not an admin, we have more work to do...
4970
		if ($context['allow_calendar'] && $context['allow_calendar_event'] && empty($modSettings['cal_allow_unlinked']) && !$user_info['is_admin'])
4971
		{
4972
			$boards_can_post = boardsAllowedTo('post_new');
4973
			$context['allow_calendar_event'] &= !empty($boards_can_post);
4974
		}
4975
	}
4976
4977
	// There is some menu stuff we need to do if we're coming at this from a non-guest perspective.
4978
	if (!$context['user']['is_guest'])
4979
	{
4980
		addInlineJavaScript('
4981
	var user_menus = new smc_PopupMenu();
4982
	user_menus.add("profile", "' . $scripturl . '?action=profile;area=popup");
4983
	user_menus.add("alerts", "' . $scripturl . '?action=profile;area=alerts_popup;u=' . $context['user']['id'] . '");', true);
4984
		if ($context['allow_pm'])
4985
			addInlineJavaScript('
4986
	user_menus.add("pm", "' . $scripturl . '?action=pm;sa=popup");', true);
4987
4988
		if (!empty($modSettings['enable_ajax_alerts']))
4989
		{
4990
			require_once($sourcedir . '/Subs-Notify.php');
4991
4992
			$timeout = getNotifyPrefs($context['user']['id'], 'alert_timeout', true);
4993
			$timeout = empty($timeout) ? 10000 : $timeout[$context['user']['id']]['alert_timeout'] * 1000;
4994
4995
			addInlineJavaScript('
4996
	var new_alert_title = "' . $context['forum_name_html_safe'] . '";
4997
	var alert_timeout = ' . $timeout . ';');
4998
			loadJavaScriptFile('alerts.js', array('minimize' => true), 'smf_alerts');
4999
		}
5000
	}
5001
5002
	// All the buttons we can possible want and then some, try pulling the final list of buttons from cache first.
5003
	if (($menu_buttons = cache_get_data('menu_buttons-' . implode('_', $user_info['groups']) . '-' . $user_info['language'], $cacheTime)) === null || time() - $cacheTime <= $modSettings['settings_updated'])
5004
	{
5005
		$buttons = array(
5006
			'home' => array(
5007
				'title' => $txt['home'],
5008
				'href' => $scripturl,
5009
				'show' => true,
5010
				'sub_buttons' => array(
5011
				),
5012
				'is_last' => $context['right_to_left'],
5013
			),
5014
			'search' => array(
5015
				'title' => $txt['search'],
5016
				'href' => $scripturl . '?action=search',
5017
				'show' => $context['allow_search'],
5018
				'sub_buttons' => array(
5019
				),
5020
			),
5021
			'admin' => array(
5022
				'title' => $txt['admin'],
5023
				'href' => $scripturl . '?action=admin',
5024
				'show' => $context['allow_admin'],
5025
				'sub_buttons' => array(
5026
					'featuresettings' => array(
5027
						'title' => $txt['modSettings_title'],
5028
						'href' => $scripturl . '?action=admin;area=featuresettings',
5029
						'show' => allowedTo('admin_forum'),
5030
					),
5031
					'packages' => array(
5032
						'title' => $txt['package'],
5033
						'href' => $scripturl . '?action=admin;area=packages',
5034
						'show' => allowedTo('admin_forum'),
5035
					),
5036
					'errorlog' => array(
5037
						'title' => $txt['errorlog'],
5038
						'href' => $scripturl . '?action=admin;area=logs;sa=errorlog;desc',
5039
						'show' => allowedTo('admin_forum') && !empty($modSettings['enableErrorLogging']),
5040
					),
5041
					'permissions' => array(
5042
						'title' => $txt['edit_permissions'],
5043
						'href' => $scripturl . '?action=admin;area=permissions',
5044
						'show' => allowedTo('manage_permissions'),
5045
					),
5046
					'memberapprove' => array(
5047
						'title' => $txt['approve_members_waiting'],
5048
						'href' => $scripturl . '?action=admin;area=viewmembers;sa=browse;type=approve',
5049
						'show' => !empty($context['unapproved_members']),
5050
						'is_last' => true,
5051
					),
5052
				),
5053
			),
5054
			'moderate' => array(
5055
				'title' => $txt['moderate'],
5056
				'href' => $scripturl . '?action=moderate',
5057
				'show' => $context['allow_moderation_center'],
5058
				'sub_buttons' => array(
5059
					'modlog' => array(
5060
						'title' => $txt['modlog_view'],
5061
						'href' => $scripturl . '?action=moderate;area=modlog',
5062
						'show' => !empty($modSettings['modlog_enabled']) && !empty($user_info['mod_cache']) && $user_info['mod_cache']['bq'] != '0=1',
5063
					),
5064
					'poststopics' => array(
5065
						'title' => $txt['mc_unapproved_poststopics'],
5066
						'href' => $scripturl . '?action=moderate;area=postmod;sa=posts',
5067
						'show' => $modSettings['postmod_active'] && !empty($user_info['mod_cache']['ap']),
5068
					),
5069
					'attachments' => array(
5070
						'title' => $txt['mc_unapproved_attachments'],
5071
						'href' => $scripturl . '?action=moderate;area=attachmod;sa=attachments',
5072
						'show' => $modSettings['postmod_active'] && !empty($user_info['mod_cache']['ap']),
5073
					),
5074
					'reports' => array(
5075
						'title' => $txt['mc_reported_posts'],
5076
						'href' => $scripturl . '?action=moderate;area=reportedposts',
5077
						'show' => !empty($user_info['mod_cache']) && $user_info['mod_cache']['bq'] != '0=1',
5078
					),
5079
					'reported_members' => array(
5080
						'title' => $txt['mc_reported_members'],
5081
						'href' => $scripturl . '?action=moderate;area=reportedmembers',
5082
						'show' => allowedTo('moderate_forum'),
5083
						'is_last' => true,
5084
					)
5085
				),
5086
			),
5087
			'calendar' => array(
5088
				'title' => $txt['calendar'],
5089
				'href' => $scripturl . '?action=calendar',
5090
				'show' => $context['allow_calendar'],
5091
				'sub_buttons' => array(
5092
					'view' => array(
5093
						'title' => $txt['calendar_menu'],
5094
						'href' => $scripturl . '?action=calendar',
5095
						'show' => $context['allow_calendar_event'],
5096
					),
5097
					'post' => array(
5098
						'title' => $txt['calendar_post_event'],
5099
						'href' => $scripturl . '?action=calendar;sa=post',
5100
						'show' => $context['allow_calendar_event'],
5101
						'is_last' => true,
5102
					),
5103
				),
5104
			),
5105
			'mlist' => array(
5106
				'title' => $txt['members_title'],
5107
				'href' => $scripturl . '?action=mlist',
5108
				'show' => $context['allow_memberlist'],
5109
				'sub_buttons' => array(
5110
					'mlist_view' => array(
5111
						'title' => $txt['mlist_menu_view'],
5112
						'href' => $scripturl . '?action=mlist',
5113
						'show' => true,
5114
					),
5115
					'mlist_search' => array(
5116
						'title' => $txt['mlist_search'],
5117
						'href' => $scripturl . '?action=mlist;sa=search',
5118
						'show' => true,
5119
						'is_last' => true,
5120
					),
5121
				),
5122
				'is_last' => !$context['right_to_left'] && (!$user_info['is_guest'] || !$context['can_register']),
5123
			),
5124
			'signup' => array(
5125
				'title' => $txt['register'],
5126
				'href' => $scripturl . '?action=signup',
5127
				'show' => $user_info['is_guest'] && $context['can_register'],
5128
				'sub_buttons' => array(
5129
				),
5130
				'is_last' => !$context['right_to_left'],
5131
			),
5132
		);
5133
5134
		// Allow editing menu buttons easily.
5135
		call_integration_hook('integrate_menu_buttons', array(&$buttons));
5136
5137
		// Now we put the buttons in the context so the theme can use them.
5138
		$menu_buttons = array();
5139
		foreach ($buttons as $act => $button)
5140
			if (!empty($button['show']))
5141
			{
5142
				$button['active_button'] = false;
5143
5144
				// This button needs some action.
5145
				if (isset($button['action_hook']))
5146
					$needs_action_hook = true;
5147
5148
				// Make sure the last button truly is the last button.
5149
				if (!empty($button['is_last']))
5150
				{
5151
					if (isset($last_button))
5152
						unset($menu_buttons[$last_button]['is_last']);
5153
					$last_button = $act;
5154
				}
5155
5156
				// Go through the sub buttons if there are any.
5157
				if (!empty($button['sub_buttons']))
5158
					foreach ($button['sub_buttons'] as $key => $subbutton)
5159
					{
5160
						if (empty($subbutton['show']))
5161
							unset($button['sub_buttons'][$key]);
5162
5163
						// 2nd level sub buttons next...
5164
						if (!empty($subbutton['sub_buttons']))
5165
						{
5166
							foreach ($subbutton['sub_buttons'] as $key2 => $sub_button2)
5167
							{
5168
								if (empty($sub_button2['show']))
5169
									unset($button['sub_buttons'][$key]['sub_buttons'][$key2]);
5170
							}
5171
						}
5172
					}
5173
5174
				// Does this button have its own icon?
5175
				if (isset($button['icon']) && file_exists($settings['theme_dir'] . '/images/' . $button['icon']))
5176
					$button['icon'] = '<img src="' . $settings['images_url'] . '/' . $button['icon'] . '" alt="">';
5177
				elseif (isset($button['icon']) && file_exists($settings['default_theme_dir'] . '/images/' . $button['icon']))
5178
					$button['icon'] = '<img src="' . $settings['default_images_url'] . '/' . $button['icon'] . '" alt="">';
5179
				elseif (isset($button['icon']))
5180
					$button['icon'] = '<span class="main_icons ' . $button['icon'] . '"></span>';
5181
				else
5182
					$button['icon'] = '<span class="main_icons ' . $act . '"></span>';
5183
5184
				$menu_buttons[$act] = $button;
5185
			}
5186
5187
		if (!empty($cache_enable) && $cache_enable >= 2)
5188
			cache_put_data('menu_buttons-' . implode('_', $user_info['groups']) . '-' . $user_info['language'], $menu_buttons, $cacheTime);
5189
	}
5190
5191
	$context['menu_buttons'] = $menu_buttons;
5192
5193
	// Logging out requires the session id in the url.
5194
	if (isset($context['menu_buttons']['logout']))
5195
		$context['menu_buttons']['logout']['href'] = sprintf($context['menu_buttons']['logout']['href'], $context['session_var'], $context['session_id']);
5196
5197
	// Figure out which action we are doing so we can set the active tab.
5198
	// Default to home.
5199
	$current_action = 'home';
5200
5201
	if (isset($context['menu_buttons'][$context['current_action']]))
5202
		$current_action = $context['current_action'];
5203
	elseif ($context['current_action'] == 'search2')
5204
		$current_action = 'search';
5205
	elseif ($context['current_action'] == 'theme')
5206
		$current_action = isset($_REQUEST['sa']) && $_REQUEST['sa'] == 'pick' ? 'profile' : 'admin';
5207
	elseif ($context['current_action'] == 'register2')
5208
		$current_action = 'register';
5209
	elseif ($context['current_action'] == 'login2' || ($user_info['is_guest'] && $context['current_action'] == 'reminder'))
5210
		$current_action = 'login';
5211
	elseif ($context['current_action'] == 'groups' && $context['allow_moderation_center'])
5212
		$current_action = 'moderate';
5213
5214
	// There are certain exceptions to the above where we don't want anything on the menu highlighted.
5215
	if ($context['current_action'] == 'profile' && !empty($context['user']['is_owner']))
5216
	{
5217
		$current_action = !empty($_GET['area']) && $_GET['area'] == 'showalerts' ? 'self_alerts' : 'self_profile';
5218
		$context[$current_action] = true;
5219
	}
5220
	elseif ($context['current_action'] == 'pm')
5221
	{
5222
		$current_action = 'self_pm';
5223
		$context['self_pm'] = true;
5224
	}
5225
5226
	$context['total_mod_reports'] = 0;
5227
	$context['total_admin_reports'] = 0;
5228
5229
	if (!empty($user_info['mod_cache']) && $user_info['mod_cache']['bq'] != '0=1' && !empty($context['open_mod_reports']) && !empty($context['menu_buttons']['moderate']['sub_buttons']['reports']))
5230
	{
5231
		$context['total_mod_reports'] = $context['open_mod_reports'];
5232
		$context['menu_buttons']['moderate']['sub_buttons']['reports']['amt'] = $context['open_mod_reports'];
5233
	}
5234
5235
	// Show how many errors there are
5236
	if (!empty($context['menu_buttons']['admin']['sub_buttons']['errorlog']))
5237
	{
5238
		// Get an error count, if necessary
5239
		if (!isset($context['num_errors']))
5240
		{
5241
			$query = $smcFunc['db_query']('', '
5242
				SELECT COUNT(*)
5243
				FROM {db_prefix}log_errors',
5244
				array()
5245
			);
5246
5247
			list($context['num_errors']) = $smcFunc['db_fetch_row']($query);
5248
			$smcFunc['db_free_result']($query);
5249
		}
5250
5251
		if (!empty($context['num_errors']))
5252
		{
5253
			$context['total_admin_reports'] += $context['num_errors'];
5254
			$context['menu_buttons']['admin']['sub_buttons']['errorlog']['amt'] = $context['num_errors'];
5255
		}
5256
	}
5257
5258
	// Show number of reported members
5259
	if (!empty($context['open_member_reports']) && !empty($context['menu_buttons']['moderate']['sub_buttons']['reported_members']))
5260
	{
5261
		$context['total_mod_reports'] += $context['open_member_reports'];
5262
		$context['menu_buttons']['moderate']['sub_buttons']['reported_members']['amt'] = $context['open_member_reports'];
5263
	}
5264
5265
	if (!empty($context['unapproved_members']) && !empty($context['menu_buttons']['admin']))
5266
	{
5267
		$context['menu_buttons']['admin']['sub_buttons']['memberapprove']['amt'] = $context['unapproved_members'];
5268
		$context['total_admin_reports'] += $context['unapproved_members'];
5269
	}
5270
5271
	if ($context['total_admin_reports'] > 0 && !empty($context['menu_buttons']['admin']))
5272
	{
5273
		$context['menu_buttons']['admin']['amt'] = $context['total_admin_reports'];
5274
	}
5275
5276
	// Do we have any open reports?
5277
	if ($context['total_mod_reports'] > 0 && !empty($context['menu_buttons']['moderate']))
5278
	{
5279
		$context['menu_buttons']['moderate']['amt'] = $context['total_mod_reports'];
5280
	}
5281
5282
	// Not all actions are simple.
5283
	if (!empty($needs_action_hook))
5284
		call_integration_hook('integrate_current_action', array(&$current_action));
5285
5286
	if (isset($context['menu_buttons'][$current_action]))
5287
		$context['menu_buttons'][$current_action]['active_button'] = true;
5288
}
5289
5290
/**
5291
 * Generate a random seed and ensure it's stored in settings.
5292
 */
5293
function smf_seed_generator()
5294
{
5295
	updateSettings(array('rand_seed' => microtime(true)));
5296
}
5297
5298
/**
5299
 * Process functions of an integration hook.
5300
 * calls all functions of the given hook.
5301
 * supports static class method calls.
5302
 *
5303
 * @param string $hook The hook name
5304
 * @param array $parameters An array of parameters this hook implements
5305
 * @return array The results of the functions
5306
 */
5307
function call_integration_hook($hook, $parameters = array())
5308
{
5309
	global $modSettings, $settings, $boarddir, $sourcedir, $db_show_debug;
5310
	global $context, $txt;
5311
5312
	if ($db_show_debug === true)
5313
		$context['debug']['hooks'][] = $hook;
5314
5315
	// Need to have some control.
5316
	if (!isset($context['instances']))
5317
		$context['instances'] = array();
5318
5319
	$results = array();
5320
	if (empty($modSettings[$hook]))
5321
		return $results;
5322
5323
	$functions = explode(',', $modSettings[$hook]);
5324
	// Loop through each function.
5325
	foreach ($functions as $function)
5326
	{
5327
		// Hook has been marked as "disabled". Skip it!
5328
		if (strpos($function, '!') !== false)
5329
			continue;
5330
5331
		$call = call_helper($function, true);
5332
5333
		// Is it valid?
5334
		if (!empty($call))
5335
			$results[$function] = call_user_func_array($call, $parameters);
0 ignored issues
show
Bug introduced by
It seems like $call can also be of type boolean; however, parameter $callback of call_user_func_array() does only seem to accept callable, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

5335
			$results[$function] = call_user_func_array(/** @scrutinizer ignore-type */ $call, $parameters);
Loading history...
5336
		// This failed, but we want to do so silently.
5337
		elseif (!empty($function) && !empty($context['ignore_hook_errors']))
5338
			return $results;
5339
		// Whatever it was suppose to call, it failed :(
5340
		elseif (!empty($function))
5341
		{
5342
			loadLanguage('Errors');
5343
5344
			// Get a full path to show on error.
5345
			if (strpos($function, '|') !== false)
5346
			{
5347
				list ($file, $string) = explode('|', $function);
5348
				$absPath = empty($settings['theme_dir']) ? (strtr(trim($file), array('$boarddir' => $boarddir, '$sourcedir' => $sourcedir))) : (strtr(trim($file), array('$boarddir' => $boarddir, '$sourcedir' => $sourcedir, '$themedir' => $settings['theme_dir'])));
5349
				log_error(sprintf($txt['hook_fail_call_to'], $string, $absPath), 'general');
5350
			}
5351
			// "Assume" the file resides on $boarddir somewhere...
5352
			else
5353
				log_error(sprintf($txt['hook_fail_call_to'], $function, $boarddir), 'general');
5354
		}
5355
	}
5356
5357
	return $results;
5358
}
5359
5360
/**
5361
 * Add a function for integration hook.
5362
 * does nothing if the function is already added.
5363
 *
5364
 * @param string $hook The complete hook name.
5365
 * @param string $function The function name. Can be a call to a method via Class::method.
5366
 * @param bool $permanent If true, updates the value in settings table.
5367
 * @param string $file The file. Must include one of the following wildcards: $boarddir, $sourcedir, $themedir, example: $sourcedir/Test.php
5368
 * @param bool $object Indicates if your class will be instantiated when its respective hook is called. If true, your function must be a method.
5369
 */
5370
function add_integration_function($hook, $function, $permanent = true, $file = '', $object = false)
5371
{
5372
	global $smcFunc, $modSettings;
5373
5374
	// Any objects?
5375
	if ($object)
5376
		$function = $function . '#';
5377
5378
	// Any files  to load?
5379
	if (!empty($file) && is_string($file))
5380
		$function = $file . (!empty($function) ? '|' . $function : '');
5381
5382
	// Get the correct string.
5383
	$integration_call = $function;
5384
5385
	// Is it going to be permanent?
5386
	if ($permanent)
5387
	{
5388
		$request = $smcFunc['db_query']('', '
5389
			SELECT value
5390
			FROM {db_prefix}settings
5391
			WHERE variable = {string:variable}',
5392
			array(
5393
				'variable' => $hook,
5394
			)
5395
		);
5396
		list ($current_functions) = $smcFunc['db_fetch_row']($request);
5397
		$smcFunc['db_free_result']($request);
5398
5399
		if (!empty($current_functions))
5400
		{
5401
			$current_functions = explode(',', $current_functions);
5402
			if (in_array($integration_call, $current_functions))
5403
				return;
5404
5405
			$permanent_functions = array_merge($current_functions, array($integration_call));
5406
		}
5407
		else
5408
			$permanent_functions = array($integration_call);
5409
5410
		updateSettings(array($hook => implode(',', $permanent_functions)));
5411
	}
5412
5413
	// Make current function list usable.
5414
	$functions = empty($modSettings[$hook]) ? array() : explode(',', $modSettings[$hook]);
5415
5416
	// Do nothing, if it's already there.
5417
	if (in_array($integration_call, $functions))
5418
		return;
5419
5420
	$functions[] = $integration_call;
5421
	$modSettings[$hook] = implode(',', $functions);
5422
}
5423
5424
/**
5425
 * Remove an integration hook function.
5426
 * Removes the given function from the given hook.
5427
 * Does nothing if the function is not available.
5428
 *
5429
 * @param string $hook The complete hook name.
5430
 * @param string $function The function name. Can be a call to a method via Class::method.
5431
 * @param boolean $permanent Irrelevant for the function itself but need to declare it to match
5432
 * @param string $file The filename. Must include one of the following wildcards: $boarddir, $sourcedir, $themedir, example: $sourcedir/Test.php
5433
 * @param boolean $object Indicates if your class will be instantiated when its respective hook is called. If true, your function must be a method.
5434
 * @see add_integration_function
5435
 */
5436
function remove_integration_function($hook, $function, $permanent = true, $file = '', $object = false)
5437
{
5438
	global $smcFunc, $modSettings;
5439
5440
	// Any objects?
5441
	if ($object)
5442
		$function = $function . '#';
5443
5444
	// Any files  to load?
5445
	if (!empty($file) && is_string($file))
5446
		$function = $file . '|' . $function;
5447
5448
	// Get the correct string.
5449
	$integration_call = $function;
5450
5451
	// Get the permanent functions.
5452
	$request = $smcFunc['db_query']('', '
5453
		SELECT value
5454
		FROM {db_prefix}settings
5455
		WHERE variable = {string:variable}',
5456
		array(
5457
			'variable' => $hook,
5458
		)
5459
	);
5460
	list ($current_functions) = $smcFunc['db_fetch_row']($request);
5461
	$smcFunc['db_free_result']($request);
5462
5463
	if (!empty($current_functions))
5464
	{
5465
		$current_functions = explode(',', $current_functions);
5466
5467
		if (in_array($integration_call, $current_functions))
5468
			updateSettings(array($hook => implode(',', array_diff($current_functions, array($integration_call)))));
5469
	}
5470
5471
	// Turn the function list into something usable.
5472
	$functions = empty($modSettings[$hook]) ? array() : explode(',', $modSettings[$hook]);
5473
5474
	// You can only remove it if it's available.
5475
	if (!in_array($integration_call, $functions))
5476
		return;
5477
5478
	$functions = array_diff($functions, array($integration_call));
5479
	$modSettings[$hook] = implode(',', $functions);
5480
}
5481
5482
/**
5483
 * Receives a string and tries to figure it out if its a method or a function.
5484
 * If a method is found, it looks for a "#" which indicates SMF should create a new instance of the given class.
5485
 * Checks the string/array for is_callable() and return false/fatal_lang_error is the given value results in a non callable string/array.
5486
 * Prepare and returns a callable depending on the type of method/function found.
5487
 *
5488
 * @param mixed $string The string containing a function name or a static call. The function can also accept a closure, object or a callable array (object/class, valid_callable)
5489
 * @param boolean $return If true, the function will not call the function/method but instead will return the formatted string.
5490
 * @return string|array|boolean Either a string or an array that contains a callable function name or an array with a class and method to call. Boolean false if the given string cannot produce a callable var.
5491
 */
5492
function call_helper($string, $return = false)
5493
{
5494
	global $context, $smcFunc, $txt, $db_show_debug;
5495
5496
	// Really?
5497
	if (empty($string))
5498
		return false;
5499
5500
	// An array? should be a "callable" array IE array(object/class, valid_callable).
5501
	// A closure? should be a callable one.
5502
	if (is_array($string) || $string instanceof Closure)
5503
		return $return ? $string : (is_callable($string) ? call_user_func($string) : false);
5504
5505
	// No full objects, sorry! pass a method or a property instead!
5506
	if (is_object($string))
5507
		return false;
5508
5509
	// Stay vitaminized my friends...
5510
	$string = $smcFunc['htmlspecialchars']($smcFunc['htmltrim']($string));
5511
5512
	// Is there a file to load?
5513
	$string = load_file($string);
5514
5515
	// Loaded file failed
5516
	if (empty($string))
5517
		return false;
5518
5519
	// Found a method.
5520
	if (strpos($string, '::') !== false)
0 ignored issues
show
Bug introduced by
It seems like $string can also be of type boolean; however, parameter $haystack of strpos() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

5520
	if (strpos(/** @scrutinizer ignore-type */ $string, '::') !== false)
Loading history...
5521
	{
5522
		list ($class, $method) = explode('::', $string);
0 ignored issues
show
Bug introduced by
It seems like $string can also be of type boolean; however, parameter $string of explode() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

5522
		list ($class, $method) = explode('::', /** @scrutinizer ignore-type */ $string);
Loading history...
5523
5524
		// Check if a new object will be created.
5525
		if (strpos($method, '#') !== false)
5526
		{
5527
			// Need to remove the # thing.
5528
			$method = str_replace('#', '', $method);
5529
5530
			// Don't need to create a new instance for every method.
5531
			if (empty($context['instances'][$class]) || !($context['instances'][$class] instanceof $class))
5532
			{
5533
				$context['instances'][$class] = new $class;
5534
5535
				// Add another one to the list.
5536
				if ($db_show_debug === true)
5537
				{
5538
					if (!isset($context['debug']['instances']))
5539
						$context['debug']['instances'] = array();
5540
5541
					$context['debug']['instances'][$class] = $class;
5542
				}
5543
			}
5544
5545
			$func = array($context['instances'][$class], $method);
5546
		}
5547
5548
		// Right then. This is a call to a static method.
5549
		else
5550
			$func = array($class, $method);
5551
	}
5552
5553
	// Nope! just a plain regular function.
5554
	else
5555
		$func = $string;
5556
5557
	// We can't call this helper, but we want to silently ignore this.
5558
	if (!is_callable($func, false, $callable_name) && !empty($context['ignore_hook_errors']))
5559
		return false;
5560
5561
	// Right, we got what we need, time to do some checks.
5562
	elseif (!is_callable($func, false, $callable_name))
5563
	{
5564
		loadLanguage('Errors');
5565
		log_error(sprintf($txt['sub_action_fail'], $callable_name), 'general');
5566
5567
		// Gotta tell everybody.
5568
		return false;
5569
	}
5570
5571
	// Everything went better than expected.
5572
	else
5573
	{
5574
		// What are we gonna do about it?
5575
		if ($return)
5576
			return $func;
5577
5578
		// If this is a plain function, avoid the heat of calling call_user_func().
5579
		else
5580
		{
5581
			if (is_array($func))
5582
				call_user_func($func);
5583
5584
			else
5585
				$func();
5586
		}
5587
	}
5588
}
5589
5590
/**
5591
 * Receives a string and tries to figure it out if it contains info to load a file.
5592
 * Checks for a | (pipe) symbol and tries to load a file with the info given.
5593
 * The string should be format as follows File.php|. You can use the following wildcards: $boarddir, $sourcedir and if available at the moment of execution, $themedir.
5594
 *
5595
 * @param string $string The string containing a valid format.
5596
 * @return string|boolean The given string with the pipe and file info removed. Boolean false if the file couldn't be loaded.
5597
 */
5598
function load_file($string)
5599
{
5600
	global $sourcedir, $txt, $boarddir, $settings, $context;
5601
5602
	if (empty($string))
5603
		return false;
5604
5605
	if (strpos($string, '|') !== false)
5606
	{
5607
		list ($file, $string) = explode('|', $string);
5608
5609
		// Match the wildcards to their regular vars.
5610
		if (empty($settings['theme_dir']))
5611
			$absPath = strtr(trim($file), array('$boarddir' => $boarddir, '$sourcedir' => $sourcedir));
5612
5613
		else
5614
			$absPath = strtr(trim($file), array('$boarddir' => $boarddir, '$sourcedir' => $sourcedir, '$themedir' => $settings['theme_dir']));
5615
5616
		// Load the file if it can be loaded.
5617
		if (file_exists($absPath))
5618
			require_once($absPath);
5619
5620
		// No? try a fallback to $sourcedir
5621
		else
5622
		{
5623
			$absPath = $sourcedir . '/' . $file;
5624
5625
			if (file_exists($absPath))
5626
				require_once($absPath);
5627
5628
			// Sorry, can't do much for you at this point.
5629
			elseif (empty($context['uninstalling']))
5630
			{
5631
				loadLanguage('Errors');
5632
				log_error(sprintf($txt['hook_fail_loading_file'], $absPath), 'general');
5633
5634
				// File couldn't be loaded.
5635
				return false;
5636
			}
5637
		}
5638
	}
5639
5640
	return $string;
5641
}
5642
5643
/**
5644
 * Get the contents of a URL, irrespective of allow_url_fopen.
5645
 *
5646
 * - reads the contents of an http or ftp address and returns the page in a string
5647
 * - will accept up to 3 page redirections (redirectio_level in the function call is private)
5648
 * - if post_data is supplied, the value and length is posted to the given url as form data
5649
 * - URL must be supplied in lowercase
5650
 *
5651
 * @param string $url The URL
5652
 * @param string $post_data The data to post to the given URL
5653
 * @param bool $keep_alive Whether to send keepalive info
5654
 * @param int $redirection_level How many levels of redirection
5655
 * @return string|false The fetched data or false on failure
5656
 */
5657
function fetch_web_data($url, $post_data = '', $keep_alive = false, $redirection_level = 0)
5658
{
5659
	global $webmaster_email, $sourcedir, $txt;
5660
	static $keep_alive_dom = null, $keep_alive_fp = null;
5661
5662
	preg_match('~^(http|ftp)(s)?://([^/:]+)(:(\d+))?(.+)$~', $url, $match);
5663
5664
	// No scheme? No data for you!
5665
	if (empty($match[1]))
5666
		return false;
5667
5668
	// An FTP url. We should try connecting and RETRieving it...
5669
	elseif ($match[1] == 'ftp')
5670
	{
5671
		// Include the file containing the ftp_connection class.
5672
		require_once($sourcedir . '/Class-Package.php');
5673
5674
		// Establish a connection and attempt to enable passive mode.
5675
		$ftp = new ftp_connection(($match[2] ? 'ssl://' : '') . $match[3], empty($match[5]) ? 21 : $match[5], 'anonymous', $webmaster_email);
5676
		if ($ftp->error !== false || !$ftp->passive())
0 ignored issues
show
introduced by
The condition $ftp->error !== false is always true.
Loading history...
5677
			return false;
5678
5679
		// I want that one *points*!
5680
		fwrite($ftp->connection, 'RETR ' . $match[6] . "\r\n");
5681
5682
		// Since passive mode worked (or we would have returned already!) open the connection.
5683
		$fp = @fsockopen($ftp->pasv['ip'], $ftp->pasv['port'], $err, $err, 5);
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable $err seems to be never defined.
Loading history...
5684
		if (!$fp)
5685
			return false;
5686
5687
		// The server should now say something in acknowledgement.
5688
		$ftp->check_response(150);
5689
5690
		$data = '';
5691
		while (!feof($fp))
5692
			$data .= fread($fp, 4096);
5693
		fclose($fp);
5694
5695
		// All done, right?  Good.
5696
		$ftp->check_response(226);
5697
		$ftp->close();
5698
	}
5699
5700
	// This is more likely; a standard HTTP URL.
5701
	elseif (isset($match[1]) && $match[1] == 'http')
5702
	{
5703
		// First try to use fsockopen, because it is fastest.
5704
		if ($keep_alive && $match[3] == $keep_alive_dom)
5705
			$fp = $keep_alive_fp;
5706
		if (empty($fp))
5707
		{
5708
			// Open the socket on the port we want...
5709
			$fp = @fsockopen(($match[2] ? 'ssl://' : '') . $match[3], empty($match[5]) ? ($match[2] ? 443 : 80) : $match[5], $err, $err, 5);
5710
		}
5711
		if (!empty($fp))
5712
		{
5713
			if ($keep_alive)
5714
			{
5715
				$keep_alive_dom = $match[3];
5716
				$keep_alive_fp = $fp;
5717
			}
5718
5719
			// I want this, from there, and I'm not going to be bothering you for more (probably.)
5720
			if (empty($post_data))
5721
			{
5722
				fwrite($fp, 'GET ' . ($match[6] !== '/' ? str_replace(' ', '%20', $match[6]) : '') . ' HTTP/1.0' . "\r\n");
5723
				fwrite($fp, 'Host: ' . $match[3] . (empty($match[5]) ? ($match[2] ? ':443' : '') : ':' . $match[5]) . "\r\n");
5724
				fwrite($fp, 'user-agent: '. SMF_USER_AGENT . "\r\n");
5725
				if ($keep_alive)
5726
					fwrite($fp, 'connection: Keep-Alive' . "\r\n\r\n");
5727
				else
5728
					fwrite($fp, 'connection: close' . "\r\n\r\n");
5729
			}
5730
			else
5731
			{
5732
				fwrite($fp, 'POST ' . ($match[6] !== '/' ? $match[6] : '') . ' HTTP/1.0' . "\r\n");
5733
				fwrite($fp, 'Host: ' . $match[3] . (empty($match[5]) ? ($match[2] ? ':443' : '') : ':' . $match[5]) . "\r\n");
5734
				fwrite($fp, 'user-agent: '. SMF_USER_AGENT . "\r\n");
5735
				if ($keep_alive)
5736
					fwrite($fp, 'connection: Keep-Alive' . "\r\n");
5737
				else
5738
					fwrite($fp, 'connection: close' . "\r\n");
5739
				fwrite($fp, 'content-type: application/x-www-form-urlencoded' . "\r\n");
5740
				fwrite($fp, 'content-length: ' . strlen($post_data) . "\r\n\r\n");
5741
				fwrite($fp, $post_data);
5742
			}
5743
5744
			$response = fgets($fp, 768);
5745
5746
			// Redirect in case this location is permanently or temporarily moved.
5747
			if ($redirection_level < 3 && preg_match('~^HTTP/\S+\s+30[127]~i', $response) === 1)
5748
			{
5749
				$header = '';
0 ignored issues
show
Unused Code introduced by
The assignment to $header is dead and can be removed.
Loading history...
5750
				$location = '';
5751
				while (!feof($fp) && trim($header = fgets($fp, 4096)) != '')
5752
					if (stripos($header, 'location:') !== false)
5753
						$location = trim(substr($header, strpos($header, ':') + 1));
5754
5755
				if (empty($location))
5756
					return false;
5757
				else
5758
				{
5759
					if (!$keep_alive)
5760
						fclose($fp);
5761
					return fetch_web_data($location, $post_data, $keep_alive, $redirection_level + 1);
5762
				}
5763
			}
5764
5765
			// Make sure we get a 200 OK.
5766
			elseif (preg_match('~^HTTP/\S+\s+20[01]~i', $response) === 0)
5767
				return false;
5768
5769
			// Skip the headers...
5770
			while (!feof($fp) && trim($header = fgets($fp, 4096)) != '')
5771
			{
5772
				if (preg_match('~content-length:\s*(\d+)~i', $header, $match) != 0)
5773
					$content_length = $match[1];
5774
				elseif (preg_match('~connection:\s*close~i', $header) != 0)
5775
				{
5776
					$keep_alive_dom = null;
5777
					$keep_alive = false;
5778
				}
5779
5780
				continue;
5781
			}
5782
5783
			$data = '';
5784
			if (isset($content_length))
5785
			{
5786
				while (!feof($fp) && strlen($data) < $content_length)
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable $content_length does not seem to be defined for all execution paths leading up to this point.
Loading history...
5787
					$data .= fread($fp, $content_length - strlen($data));
5788
			}
5789
			else
5790
			{
5791
				while (!feof($fp))
5792
					$data .= fread($fp, 4096);
5793
			}
5794
5795
			if (!$keep_alive)
5796
				fclose($fp);
5797
		}
5798
5799
		// If using fsockopen didn't work, try to use cURL if available.
5800
		elseif (function_exists('curl_init'))
5801
		{
5802
			// Include the file containing the curl_fetch_web_data class.
5803
			require_once($sourcedir . '/Class-CurlFetchWeb.php');
5804
5805
			$fetch_data = new curl_fetch_web_data();
5806
			$fetch_data->get_url_data($url, $post_data);
0 ignored issues
show
Bug introduced by
$post_data of type string is incompatible with the type array expected by parameter $post_data of curl_fetch_web_data::get_url_data(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

5806
			$fetch_data->get_url_data($url, /** @scrutinizer ignore-type */ $post_data);
Loading history...
5807
5808
			// no errors and a 200 result, then we have a good dataset, well we at least have data. ;)
5809
			if ($fetch_data->result('code') == 200 && !$fetch_data->result('error'))
5810
				$data = $fetch_data->result('body');
5811
			else
5812
				return false;
5813
		}
5814
5815
		// Neither fsockopen nor curl are available. Well, phooey.
5816
		else
5817
			return false;
5818
	}
5819
	else
5820
	{
5821
		// Umm, this shouldn't happen?
5822
		loadLanguage('Errors');
5823
		trigger_error($txt['fetch_web_data_bad_url'], E_USER_NOTICE);
5824
		$data = false;
5825
	}
5826
5827
	return $data;
5828
}
5829
5830
/**
5831
 * Attempts to determine the MIME type of some data or a file.
5832
 *
5833
 * @param string $data The data to check, or the path or URL of a file to check.
5834
 * @param string $is_path If true, $data is a path or URL to a file.
5835
 * @return string|bool A MIME type, or false if we cannot determine it.
5836
 */
5837
function get_mime_type($data, $is_path = false)
5838
{
5839
	global $cachedir;
5840
5841
	$finfo_loaded = extension_loaded('fileinfo');
5842
	$exif_loaded = extension_loaded('exif') && function_exists('image_type_to_mime_type');
5843
5844
	// Oh well. We tried.
5845
	if (!$finfo_loaded && !$exif_loaded)
5846
		return false;
5847
5848
	// Start with the 'empty' MIME type.
5849
	$mime_type = 'application/x-empty';
5850
5851
	if ($finfo_loaded)
5852
	{
5853
		// Just some nice, simple data to analyze.
5854
		if (empty($is_path))
5855
			$mime_type = finfo_buffer(finfo_open(FILEINFO_MIME_TYPE), $data);
5856
5857
		// A file, or maybe a URL?
5858
		else
5859
		{
5860
			// Local file.
5861
			if (file_exists($data))
5862
				$mime_type = mime_content_type($data);
5863
5864
			// URL.
5865
			elseif ($data = fetch_web_data($data))
5866
				$mime_type = finfo_buffer(finfo_open(FILEINFO_MIME_TYPE), $data);
5867
		}
5868
	}
5869
	// Workaround using Exif requires a local file.
5870
	else
5871
	{
5872
		// If $data is a URL to fetch, do so.
5873
		if (!empty($is_path) && !file_exists($data) && url_exists($data))
5874
		{
5875
			$data = fetch_web_data($data);
5876
			$is_path = false;
5877
		}
5878
5879
		// If we don't have a local file, create one and use it.
5880
		if (empty($is_path))
5881
		{
5882
			$temp_file = tempnam($cachedir, md5($data));
0 ignored issues
show
Bug introduced by
It seems like $data can also be of type false; however, parameter $string of md5() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

5882
			$temp_file = tempnam($cachedir, md5(/** @scrutinizer ignore-type */ $data));
Loading history...
5883
			file_put_contents($temp_file, $data);
5884
			$is_path = true;
0 ignored issues
show
Unused Code introduced by
The assignment to $is_path is dead and can be removed.
Loading history...
5885
			$data = $temp_file;
5886
		}
5887
5888
		$imagetype = @exif_imagetype($data);
0 ignored issues
show
Bug introduced by
It seems like $data can also be of type false; however, parameter $filename of exif_imagetype() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

5888
		$imagetype = @exif_imagetype(/** @scrutinizer ignore-type */ $data);
Loading history...
5889
5890
		if (isset($temp_file))
5891
			unlink($temp_file);
5892
5893
		// Unfortunately, this workaround only works for image files.
5894
		if ($imagetype !== false)
5895
			$mime_type = image_type_to_mime_type($imagetype);
5896
	}
5897
5898
	return $mime_type;
5899
}
5900
5901
/**
5902
 * Checks whether a file or data has the expected MIME type.
5903
 *
5904
 * @param string $data The data to check, or the path or URL of a file to check.
5905
 * @param string $type_pattern A regex pattern to match the acceptable MIME types.
5906
 * @param string $is_path If true, $data is a path or URL to a file.
5907
 * @return int 1 if the detected MIME type matches the pattern, 0 if it doesn't, or 2 if we can't check.
5908
 */
5909
function check_mime_type($data, $type_pattern, $is_path = false)
5910
{
5911
	// Get the MIME type.
5912
	$mime_type = get_mime_type($data, $is_path);
0 ignored issues
show
Bug introduced by
It seems like $is_path can also be of type false; however, parameter $is_path of get_mime_type() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

5912
	$mime_type = get_mime_type($data, /** @scrutinizer ignore-type */ $is_path);
Loading history...
5913
5914
	// Couldn't determine it.
5915
	if ($mime_type === false)
5916
		return 2;
5917
5918
	// Check whether the MIME type matches expectations.
5919
	return (int) @preg_match('~' . $type_pattern . '~', $mime_type);
5920
}
5921
5922
/**
5923
 * Prepares an array of "likes" info for the topic specified by $topic
5924
 *
5925
 * @param integer $topic The topic ID to fetch the info from.
5926
 * @return array An array of IDs of messages in the specified topic that the current user likes
5927
 */
5928
function prepareLikesContext($topic)
5929
{
5930
	global $user_info, $smcFunc;
5931
5932
	// Make sure we have something to work with.
5933
	if (empty($topic))
5934
		return array();
5935
5936
	// We already know the number of likes per message, we just want to know whether the current user liked it or not.
5937
	$user = $user_info['id'];
5938
	$cache_key = 'likes_topic_' . $topic . '_' . $user;
5939
	$ttl = 180;
5940
5941
	if (($temp = cache_get_data($cache_key, $ttl)) === null)
5942
	{
5943
		$temp = array();
5944
		$request = $smcFunc['db_query']('', '
5945
			SELECT content_id
5946
			FROM {db_prefix}user_likes AS l
5947
				INNER JOIN {db_prefix}messages AS m ON (l.content_id = m.id_msg)
5948
			WHERE l.id_member = {int:current_user}
5949
				AND l.content_type = {literal:msg}
5950
				AND m.id_topic = {int:topic}',
5951
			array(
5952
				'current_user' => $user,
5953
				'topic' => $topic,
5954
			)
5955
		);
5956
		while ($row = $smcFunc['db_fetch_assoc']($request))
5957
			$temp[] = (int) $row['content_id'];
5958
5959
		cache_put_data($cache_key, $temp, $ttl);
5960
	}
5961
5962
	return $temp;
5963
}
5964
5965
/**
5966
 * Microsoft uses their own character set Code Page 1252 (CP1252), which is a
5967
 * superset of ISO 8859-1, defining several characters between DEC 128 and 159
5968
 * that are not normally displayable.  This converts the popular ones that
5969
 * appear from a cut and paste from windows.
5970
 *
5971
 * @param string $string The string
5972
 * @return string The sanitized string
5973
 */
5974
function sanitizeMSCutPaste($string)
5975
{
5976
	global $context;
5977
5978
	if (empty($string))
5979
		return $string;
5980
5981
	// UTF-8 occurences of MS special characters
5982
	$findchars_utf8 = array(
5983
		"\xe2\x80\x9a",	// single low-9 quotation mark
5984
		"\xe2\x80\x9e",	// double low-9 quotation mark
5985
		"\xe2\x80\xa6",	// horizontal ellipsis
5986
		"\xe2\x80\x98",	// left single curly quote
5987
		"\xe2\x80\x99",	// right single curly quote
5988
		"\xe2\x80\x9c",	// left double curly quote
5989
		"\xe2\x80\x9d",	// right double curly quote
5990
	);
5991
5992
	// windows 1252 / iso equivalents
5993
	$findchars_iso = array(
5994
		chr(130),
5995
		chr(132),
5996
		chr(133),
5997
		chr(145),
5998
		chr(146),
5999
		chr(147),
6000
		chr(148),
6001
	);
6002
6003
	// safe replacements
6004
	$replacechars = array(
6005
		',',	// &sbquo;
6006
		',,',	// &bdquo;
6007
		'...',	// &hellip;
6008
		"'",	// &lsquo;
6009
		"'",	// &rsquo;
6010
		'"',	// &ldquo;
6011
		'"',	// &rdquo;
6012
	);
6013
6014
	if ($context['utf8'])
6015
		$string = str_replace($findchars_utf8, $replacechars, $string);
6016
	else
6017
		$string = str_replace($findchars_iso, $replacechars, $string);
6018
6019
	return $string;
6020
}
6021
6022
/**
6023
 * Decode numeric html entities to their ascii or UTF8 equivalent character.
6024
 *
6025
 * Callback function for preg_replace_callback in subs-members
6026
 * Uses capture group 2 in the supplied array
6027
 * Does basic scan to ensure characters are inside a valid range
6028
 *
6029
 * @param array $matches An array of matches (relevant info should be the 3rd item)
6030
 * @return string A fixed string
6031
 */
6032
function replaceEntities__callback($matches)
6033
{
6034
	global $context;
6035
6036
	if (!isset($matches[2]))
6037
		return '';
6038
6039
	$num = $matches[2][0] === 'x' ? hexdec(substr($matches[2], 1)) : (int) $matches[2];
0 ignored issues
show
Bug introduced by
$matches[2] of type array is incompatible with the type string expected by parameter $string of substr(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

6039
	$num = $matches[2][0] === 'x' ? hexdec(substr(/** @scrutinizer ignore-type */ $matches[2], 1)) : (int) $matches[2];
Loading history...
6040
6041
	// remove left to right / right to left overrides
6042
	if ($num === 0x202D || $num === 0x202E)
6043
		return '';
6044
6045
	// Quote, Ampersand, Apostrophe, Less/Greater Than get html replaced
6046
	if (in_array($num, array(0x22, 0x26, 0x27, 0x3C, 0x3E)))
6047
		return '&#' . $num . ';';
6048
6049
	if (empty($context['utf8']))
6050
	{
6051
		// no control characters
6052
		if ($num < 0x20)
6053
			return '';
6054
		// text is text
6055
		elseif ($num < 0x80)
6056
			return chr($num);
0 ignored issues
show
Bug introduced by
It seems like $num can also be of type double; however, parameter $codepoint of chr() does only seem to accept integer, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

6056
			return chr(/** @scrutinizer ignore-type */ $num);
Loading history...
6057
		// all others get html-ised
6058
		else
6059
			return '&#' . $matches[2] . ';';
0 ignored issues
show
Bug introduced by
Are you sure $matches[2] of type array can be used in concatenation? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

6059
			return '&#' . /** @scrutinizer ignore-type */ $matches[2] . ';';
Loading history...
6060
	}
6061
	else
6062
	{
6063
		// <0x20 are control characters, 0x20 is a space, > 0x10FFFF is past the end of the utf8 character set
6064
		// 0xD800 >= $num <= 0xDFFF are surrogate markers (not valid for utf8 text)
6065
		if ($num < 0x20 || $num > 0x10FFFF || ($num >= 0xD800 && $num <= 0xDFFF))
6066
			return '';
6067
		// <0x80 (or less than 128) are standard ascii characters a-z A-Z 0-9 and punctuation
6068
		elseif ($num < 0x80)
6069
			return chr($num);
6070
		// <0x800 (2048)
6071
		elseif ($num < 0x800)
6072
			return chr(($num >> 6) + 192) . chr(($num & 63) + 128);
6073
		// < 0x10000 (65536)
6074
		elseif ($num < 0x10000)
6075
			return chr(($num >> 12) + 224) . chr((($num >> 6) & 63) + 128) . chr(($num & 63) + 128);
6076
		// <= 0x10FFFF (1114111)
6077
		else
6078
			return chr(($num >> 18) + 240) . chr((($num >> 12) & 63) + 128) . chr((($num >> 6) & 63) + 128) . chr(($num & 63) + 128);
6079
	}
6080
}
6081
6082
/**
6083
 * Converts html entities to utf8 equivalents
6084
 *
6085
 * Callback function for preg_replace_callback
6086
 * Uses capture group 1 in the supplied array
6087
 * Does basic checks to keep characters inside a viewable range.
6088
 *
6089
 * @param array $matches An array of matches (relevant info should be the 2nd item in the array)
6090
 * @return string The fixed string
6091
 */
6092
function fixchar__callback($matches)
6093
{
6094
	if (!isset($matches[1]))
6095
		return '';
6096
6097
	$num = $matches[1][0] === 'x' ? hexdec(substr($matches[1], 1)) : (int) $matches[1];
0 ignored issues
show
Bug introduced by
$matches[1] of type array is incompatible with the type string expected by parameter $string of substr(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

6097
	$num = $matches[1][0] === 'x' ? hexdec(substr(/** @scrutinizer ignore-type */ $matches[1], 1)) : (int) $matches[1];
Loading history...
6098
6099
	// <0x20 are control characters, > 0x10FFFF is past the end of the utf8 character set
6100
	// 0xD800 >= $num <= 0xDFFF are surrogate markers (not valid for utf8 text), 0x202D-E are left to right overrides
6101
	if ($num < 0x20 || $num > 0x10FFFF || ($num >= 0xD800 && $num <= 0xDFFF) || $num === 0x202D || $num === 0x202E)
6102
		return '';
6103
	// <0x80 (or less than 128) are standard ascii characters a-z A-Z 0-9 and punctuation
6104
	elseif ($num < 0x80)
6105
		return chr($num);
0 ignored issues
show
Bug introduced by
It seems like $num can also be of type double; however, parameter $codepoint of chr() does only seem to accept integer, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

6105
		return chr(/** @scrutinizer ignore-type */ $num);
Loading history...
6106
	// <0x800 (2048)
6107
	elseif ($num < 0x800)
6108
		return chr(($num >> 6) + 192) . chr(($num & 63) + 128);
6109
	// < 0x10000 (65536)
6110
	elseif ($num < 0x10000)
6111
		return chr(($num >> 12) + 224) . chr((($num >> 6) & 63) + 128) . chr(($num & 63) + 128);
6112
	// <= 0x10FFFF (1114111)
6113
	else
6114
		return chr(($num >> 18) + 240) . chr((($num >> 12) & 63) + 128) . chr((($num >> 6) & 63) + 128) . chr(($num & 63) + 128);
6115
}
6116
6117
/**
6118
 * Strips out invalid html entities, replaces others with html style &#123; codes
6119
 *
6120
 * Callback function used of preg_replace_callback in smcFunc $ent_checks, for example
6121
 * strpos, strlen, substr etc
6122
 *
6123
 * @param array $matches An array of matches (relevant info should be the 3rd item in the array)
6124
 * @return string The fixed string
6125
 */
6126
function entity_fix__callback($matches)
6127
{
6128
	if (!isset($matches[2]))
6129
		return '';
6130
6131
	$num = $matches[2][0] === 'x' ? hexdec(substr($matches[2], 1)) : (int) $matches[2];
0 ignored issues
show
Bug introduced by
$matches[2] of type array is incompatible with the type string expected by parameter $string of substr(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

6131
	$num = $matches[2][0] === 'x' ? hexdec(substr(/** @scrutinizer ignore-type */ $matches[2], 1)) : (int) $matches[2];
Loading history...
6132
6133
	// we don't allow control characters, characters out of range, byte markers, etc
6134
	if ($num < 0x20 || $num > 0x10FFFF || ($num >= 0xD800 && $num <= 0xDFFF) || $num == 0x202D || $num == 0x202E)
6135
		return '';
6136
	else
6137
		return '&#' . $num . ';';
6138
}
6139
6140
/**
6141
 * Return a Gravatar URL based on
6142
 * - the supplied email address,
6143
 * - the global maximum rating,
6144
 * - the global default fallback,
6145
 * - maximum sizes as set in the admin panel.
6146
 *
6147
 * It is SSL aware, and caches most of the parameters.
6148
 *
6149
 * @param string $email_address The user's email address
6150
 * @return string The gravatar URL
6151
 */
6152
function get_gravatar_url($email_address)
6153
{
6154
	global $modSettings, $smcFunc;
6155
	static $url_params = null;
6156
6157
	if ($url_params === null)
6158
	{
6159
		$ratings = array('G', 'PG', 'R', 'X');
6160
		$defaults = array('mm', 'identicon', 'monsterid', 'wavatar', 'retro', 'blank');
6161
		$url_params = array();
6162
		if (!empty($modSettings['gravatarMaxRating']) && in_array($modSettings['gravatarMaxRating'], $ratings))
6163
			$url_params[] = 'rating=' . $modSettings['gravatarMaxRating'];
6164
		if (!empty($modSettings['gravatarDefault']) && in_array($modSettings['gravatarDefault'], $defaults))
6165
			$url_params[] = 'default=' . $modSettings['gravatarDefault'];
6166
		if (!empty($modSettings['avatar_max_width_external']))
6167
			$size_string = (int) $modSettings['avatar_max_width_external'];
6168
		if (!empty($modSettings['avatar_max_height_external']) && !empty($size_string))
6169
			if ((int) $modSettings['avatar_max_height_external'] < $size_string)
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable $size_string does not seem to be defined for all execution paths leading up to this point.
Loading history...
6170
				$size_string = $modSettings['avatar_max_height_external'];
6171
6172
		if (!empty($size_string))
6173
			$url_params[] = 's=' . $size_string;
6174
	}
6175
	$http_method = !empty($modSettings['force_ssl']) ? 'https://secure' : 'http://www';
6176
6177
	return $http_method . '.gravatar.com/avatar/' . md5($smcFunc['strtolower']($email_address)) . '?' . implode('&', $url_params);
6178
}
6179
6180
/**
6181
 * Get a list of time zones.
6182
 *
6183
 * @param string $when The date/time for which to calculate the time zone values.
6184
 *		May be a Unix timestamp or any string that strtotime() can understand.
6185
 *		Defaults to 'now'.
6186
 * @return array An array of time zone identifiers and label text.
6187
 */
6188
function smf_list_timezones($when = 'now')
6189
{
6190
	global $modSettings, $tztxt, $txt, $context, $cur_profile, $sourcedir;
6191
	static $timezones_when = array();
6192
6193
	require_once($sourcedir . '/Subs-Timezones.php');
6194
6195
	// Parseable datetime string?
6196
	if (is_int($timestamp = strtotime($when)))
0 ignored issues
show
introduced by
The condition is_int($timestamp = strtotime($when)) is always true.
Loading history...
6197
		$when = $timestamp;
6198
6199
	// A Unix timestamp?
6200
	elseif (is_numeric($when))
6201
		$when = intval($when);
6202
6203
	// Invalid value? Just get current Unix timestamp.
6204
	else
6205
		$when = time();
6206
6207
	// No point doing this over if we already did it once
6208
	if (isset($timezones_when[$when]))
6209
		return $timezones_when[$when];
6210
6211
	// We'll need these too
6212
	$date_when = date_create('@' . $when);
6213
	$later = strtotime('@' . $when . ' + 1 year');
6214
6215
	// Load up any custom time zone descriptions we might have
6216
	loadLanguage('Timezones');
6217
6218
	$tzid_metazones = get_tzid_metazones($later);
6219
6220
	// Should we put time zones from certain countries at the top of the list?
6221
	$priority_countries = !empty($modSettings['timezone_priority_countries']) ? explode(',', $modSettings['timezone_priority_countries']) : array();
6222
6223
	$priority_tzids = array();
6224
	foreach ($priority_countries as $country)
6225
	{
6226
		$country_tzids = get_sorted_tzids_for_country($country);
6227
6228
		if (!empty($country_tzids))
6229
			$priority_tzids = array_merge($priority_tzids, $country_tzids);
6230
	}
6231
6232
	// Antarctic research stations should be listed last, unless you're running a penguin forum
6233
	$low_priority_tzids = !in_array('AQ', $priority_countries) ? timezone_identifiers_list(DateTimeZone::ANTARCTICA) : array();
0 ignored issues
show
Bug introduced by
Are you sure the usage of timezone_identifiers_lis...teTimeZone::ANTARCTICA) is correct as it seems to always return null.

This check looks for function or method calls that always return null and whose return value is used.

class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {

The method getObject() can return nothing but null, so it makes no sense to use the return value.

The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes.

Loading history...
6234
6235
	$normal_priority_tzids = array_diff(array_unique(array_merge(array_keys($tzid_metazones), timezone_identifiers_list())), $priority_tzids, $low_priority_tzids);
0 ignored issues
show
Bug introduced by
Are you sure the usage of timezone_identifiers_list() is correct as it seems to always return null.

This check looks for function or method calls that always return null and whose return value is used.

class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {

The method getObject() can return nothing but null, so it makes no sense to use the return value.

The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes.

Loading history...
Bug introduced by
timezone_identifiers_list() of type void is incompatible with the type array expected by parameter $arrays of array_merge(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

6235
	$normal_priority_tzids = array_diff(array_unique(array_merge(array_keys($tzid_metazones), /** @scrutinizer ignore-type */ timezone_identifiers_list())), $priority_tzids, $low_priority_tzids);
Loading history...
6236
6237
	// Process them in order of importance.
6238
	$tzids = array_merge($priority_tzids, $normal_priority_tzids, $low_priority_tzids);
6239
6240
	// Idea here is to get exactly one representative identifier for each and every unique set of time zone rules.
6241
	$dst_types = array();
6242
	$labels = array();
6243
	$offsets = array();
6244
	foreach ($tzids as $tzid)
6245
	{
6246
		// We don't want UTC right now
6247
		if ($tzid == 'UTC')
6248
			continue;
6249
6250
		$tz = @timezone_open($tzid);
6251
6252
		if ($tz == null)
6253
			continue;
6254
6255
		// First, get the set of transition rules for this tzid
6256
		$tzinfo = timezone_transitions_get($tz, $when, $later);
6257
6258
		// Use the entire set of transition rules as the array *key* so we can avoid duplicates
6259
		$tzkey = serialize($tzinfo);
6260
6261
		// ...But make sure to include all explicitly defined meta-zones.
6262
		if (isset($zones[$tzkey]['metazone']) && isset($tzid_metazones[$tzid]))
6263
			$tzkey = serialize(array_merge($tzinfo, array('metazone' => $tzid_metazones[$tzid])));
6264
6265
		// Don't overwrite our preferred tzids
6266
		if (empty($zones[$tzkey]['tzid']))
6267
		{
6268
			$zones[$tzkey]['tzid'] = $tzid;
6269
			$zones[$tzkey]['dst_type'] = count($tzinfo) > 1 ? 1 : ($tzinfo[0]['isdst'] ? 2 : 0);
6270
6271
			foreach ($tzinfo as $transition) {
6272
				$zones[$tzkey]['abbrs'][] = $transition['abbr'];
6273
			}
6274
6275
			if (isset($tzid_metazones[$tzid]))
6276
				$zones[$tzkey]['metazone'] = $tzid_metazones[$tzid];
6277
			else
6278
			{
6279
				$tzgeo = timezone_location_get($tz);
6280
				$country_tzids = get_sorted_tzids_for_country($tzgeo['country_code']);
6281
6282
				if (count($country_tzids) === 1)
6283
					$zones[$tzkey]['metazone'] = $txt['iso3166'][$tzgeo['country_code']];
6284
			}
6285
		}
6286
6287
		// A time zone from a prioritized country?
6288
		if (in_array($tzid, $priority_tzids))
6289
			$priority_zones[$tzkey] = true;
6290
6291
		// Keep track of the location and offset for this tzid
6292
		if (!empty($txt[$tzid]))
6293
			$zones[$tzkey]['locations'][] = $txt[$tzid];
6294
		else
6295
		{
6296
			$tzid_parts = explode('/', $tzid);
6297
			$zones[$tzkey]['locations'][] = str_replace(array('St_', '_'), array('St. ', ' '), array_pop($tzid_parts));
6298
		}
6299
		$offsets[$tzkey] = $tzinfo[0]['offset'];
6300
6301
		// Figure out the "meta-zone" info for the label
6302
		if (empty($zones[$tzkey]['metazone']) && isset($tzid_metazones[$tzid]))
6303
		{
6304
			$zones[$tzkey]['metazone'] = $tzid_metazones[$tzid];
6305
			$zones[$tzkey]['dst_type'] = count($tzinfo) > 1 ? 1 : ($tzinfo[0]['isdst'] ? 2 : 0);
6306
		}
6307
		$dst_types[$tzkey] = count($tzinfo) > 1 ? 'c' : ($tzinfo[0]['isdst'] ? 't' : 'f');
6308
		$labels[$tzkey] = !empty($zones[$tzkey]['metazone']) && !empty($tztxt[$zones[$tzkey]['metazone']]) ? $tztxt[$zones[$tzkey]['metazone']] : '';
6309
6310
		// Remember this for later
6311
		if (isset($cur_profile['timezone']) && $cur_profile['timezone'] == $tzid)
6312
			$member_tzkey = $tzkey;
6313
		if (isset($context['event']['tz']) && $context['event']['tz'] == $tzid)
6314
			$event_tzkey = $tzkey;
6315
	}
6316
6317
	// Sort by offset, then label, then DST type.
6318
	array_multisort($offsets, SORT_ASC, SORT_NUMERIC, $labels, SORT_ASC, $dst_types, SORT_ASC, $zones);
0 ignored issues
show
Bug introduced by
SORT_NUMERIC cannot be passed to array_multisort() as the parameter $rest expects a reference. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

6318
	array_multisort($offsets, SORT_ASC, /** @scrutinizer ignore-type */ SORT_NUMERIC, $labels, SORT_ASC, $dst_types, SORT_ASC, $zones);
Loading history...
Bug introduced by
SORT_ASC cannot be passed to array_multisort() as the parameter $rest expects a reference. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

6318
	array_multisort($offsets, /** @scrutinizer ignore-type */ SORT_ASC, SORT_NUMERIC, $labels, SORT_ASC, $dst_types, SORT_ASC, $zones);
Loading history...
Comprehensibility Best Practice introduced by
The variable $zones does not seem to be defined for all execution paths leading up to this point.
Loading history...
6319
6320
	// Build the final array of formatted values
6321
	$priority_timezones = array();
6322
	$timezones = array();
6323
	foreach ($zones as $tzkey => $tzvalue)
6324
	{
6325
		date_timezone_set($date_when, timezone_open($tzvalue['tzid']));
6326
6327
		// Use the human friendly time zone name, if there is one.
6328
		$desc = '';
6329
		if (!empty($tzvalue['metazone']))
6330
		{
6331
			if (!empty($tztxt[$tzvalue['metazone']]))
6332
				$metazone = $tztxt[$tzvalue['metazone']];
6333
			else
6334
				$metazone = sprintf($tztxt['generic_timezone'], $tzvalue['metazone'], '%1$s');
6335
6336
			switch ($tzvalue['dst_type'])
6337
			{
6338
				case 0:
6339
					$desc = sprintf($metazone, $tztxt['daylight_saving_time_false']);
6340
					break;
6341
6342
				case 1:
6343
					$desc = sprintf($metazone, '');
6344
					break;
6345
6346
				case 2:
6347
					$desc = sprintf($metazone, $tztxt['daylight_saving_time_true']);
6348
					break;
6349
			}
6350
		}
6351
		// Otherwise, use the list of locations (max 5, so things don't get silly)
6352
		else
6353
			$desc = implode(', ', array_slice(array_unique($tzvalue['locations']), 0, 5)) . (count($tzvalue['locations']) > 5 ? ', ' . $txt['etc'] : '');
6354
6355
		// We don't want abbreviations like '+03' or '-11'.
6356
		$abbrs = array_filter($tzvalue['abbrs'], function ($abbr) {
6357
			return !strspn($abbr, '+-');
6358
		});
6359
		$abbrs = count($abbrs) == count($tzvalue['abbrs']) ? array_unique($abbrs) : array();
6360
6361
		// Show the UTC offset and abbreviation(s).
6362
		$desc = '[UTC' . date_format($date_when, 'P') . '] - ' . str_replace('  ', ' ', $desc) . (!empty($abbrs) ? ' (' . implode('/', $abbrs) . ')' : '');
6363
6364
		if (isset($priority_zones[$tzkey]))
6365
			$priority_timezones[$tzvalue['tzid']] = $desc;
6366
		else
6367
			$timezones[$tzvalue['tzid']] = $desc;
6368
6369
		// Automatically fix orphaned time zones.
6370
		if (isset($member_tzkey) && $member_tzkey == $tzkey)
6371
			$cur_profile['timezone'] = $tzvalue['tzid'];
6372
		if (isset($event_tzkey) && $event_tzkey == $tzkey)
6373
			$context['event']['tz'] = $tzvalue['tzid'];
6374
	}
6375
6376
	if (!empty($priority_timezones))
6377
		$priority_timezones[] = '-----';
6378
6379
	$timezones = array_merge(
6380
		$priority_timezones,
6381
		array('UTC' => 'UTC' . (!empty($tztxt['UTC']) ? ' - ' . $tztxt['UTC'] : ''), '-----'),
6382
		$timezones
6383
	);
6384
6385
	$timezones_when[$when] = $timezones;
6386
6387
	return $timezones_when[$when];
6388
}
6389
6390
/**
6391
 * Gets a member's selected time zone identifier
6392
 *
6393
 * @param int $id_member The member id to look up. If not provided, the current user's id will be used.
6394
 * @return string The time zone identifier string for the user's time zone.
6395
 */
6396
function getUserTimezone($id_member = null)
6397
{
6398
	global $smcFunc, $context, $user_info, $modSettings, $user_settings;
6399
	static $member_cache = array();
6400
6401
	if (is_null($id_member) && $user_info['is_guest'] == false)
6402
		$id_member = $context['user']['id'];
6403
6404
	// Did we already look this up?
6405
	if (isset($id_member) && isset($member_cache[$id_member]))
6406
	{
6407
		return $member_cache[$id_member];
6408
	}
6409
6410
	// Check if we already have this in $user_settings.
6411
	if (isset($user_settings['id_member']) && $user_settings['id_member'] == $id_member && !empty($user_settings['timezone']))
6412
	{
6413
		$member_cache[$id_member] = $user_settings['timezone'];
6414
		return $user_settings['timezone'];
6415
	}
6416
6417
	// Look it up in the database.
6418
	if (isset($id_member))
6419
	{
6420
		$request = $smcFunc['db_query']('', '
6421
			SELECT timezone
6422
			FROM {db_prefix}members
6423
			WHERE id_member = {int:id_member}',
6424
			array(
6425
				'id_member' => $id_member,
6426
			)
6427
		);
6428
		list($timezone) = $smcFunc['db_fetch_row']($request);
6429
		$smcFunc['db_free_result']($request);
6430
	}
6431
6432
	// If it is invalid, fall back to the default.
6433
	if (empty($timezone) || !in_array($timezone, timezone_identifiers_list(DateTimeZone::ALL_WITH_BC)))
0 ignored issues
show
Bug introduced by
timezone_identifiers_lis...eTimeZone::ALL_WITH_BC) of type void is incompatible with the type array expected by parameter $haystack of in_array(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

6433
	if (empty($timezone) || !in_array($timezone, /** @scrutinizer ignore-type */ timezone_identifiers_list(DateTimeZone::ALL_WITH_BC)))
Loading history...
Bug introduced by
Are you sure the usage of timezone_identifiers_lis...eTimeZone::ALL_WITH_BC) is correct as it seems to always return null.

This check looks for function or method calls that always return null and whose return value is used.

class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {

The method getObject() can return nothing but null, so it makes no sense to use the return value.

The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes.

Loading history...
6434
		$timezone = isset($modSettings['default_timezone']) ? $modSettings['default_timezone'] : date_default_timezone_get();
6435
6436
	// Save for later.
6437
	if (isset($id_member))
6438
		$member_cache[$id_member] = $timezone;
6439
6440
	return $timezone;
6441
}
6442
6443
/**
6444
 * Converts an IP address into binary
6445
 *
6446
 * @param string $ip_address An IP address in IPv4, IPv6 or decimal notation
6447
 * @return string|false The IP address in binary or false
6448
 */
6449
function inet_ptod($ip_address)
6450
{
6451
	if (!isValidIP($ip_address))
6452
		return $ip_address;
6453
6454
	$bin = inet_pton($ip_address);
6455
	return $bin;
6456
}
6457
6458
/**
6459
 * Converts a binary version of an IP address into a readable format
6460
 *
6461
 * @param string $bin An IP address in IPv4, IPv6 (Either string (postgresql) or binary (other databases))
6462
 * @return string|false The IP address in presentation format or false on error
6463
 */
6464
function inet_dtop($bin)
6465
{
6466
	global $db_type;
6467
6468
	if (empty($bin))
6469
		return '';
6470
	elseif ($db_type == 'postgresql')
6471
		return $bin;
6472
	// Already a String?
6473
	elseif (isValidIP($bin))
6474
		return $bin;
6475
	return inet_ntop($bin);
6476
}
6477
6478
/**
6479
 * Safe serialize() and unserialize() replacements
6480
 *
6481
 * @license Public Domain
6482
 *
6483
 * @author anthon (dot) pang (at) gmail (dot) com
6484
 */
6485
6486
/**
6487
 * Safe serialize() replacement. Recursive
6488
 * - output a strict subset of PHP's native serialized representation
6489
 * - does not serialize objects
6490
 *
6491
 * @param mixed $value
6492
 * @return string
6493
 */
6494
function _safe_serialize($value)
6495
{
6496
	if (is_null($value))
6497
		return 'N;';
6498
6499
	if (is_bool($value))
6500
		return 'b:' . (int) $value . ';';
6501
6502
	if (is_int($value))
6503
		return 'i:' . $value . ';';
6504
6505
	if (is_float($value))
6506
		return 'd:' . str_replace(',', '.', $value) . ';';
6507
6508
	if (is_string($value))
6509
		return 's:' . strlen($value) . ':"' . $value . '";';
6510
6511
	if (is_array($value))
6512
	{
6513
		$out = '';
6514
		foreach ($value as $k => $v)
6515
			$out .= _safe_serialize($k) . _safe_serialize($v);
6516
6517
		return 'a:' . count($value) . ':{' . $out . '}';
6518
	}
6519
6520
	// safe_serialize cannot serialize resources or objects.
6521
	return false;
6522
}
6523
6524
/**
6525
 * Wrapper for _safe_serialize() that handles exceptions and multibyte encoding issues.
6526
 *
6527
 * @param mixed $value
6528
 * @return string
6529
 */
6530
function safe_serialize($value)
6531
{
6532
	// Make sure we use the byte count for strings even when strlen() is overloaded by mb_strlen()
6533
	if (function_exists('mb_internal_encoding') &&
6534
		(((int) ini_get('mbstring.func_overload')) & 2))
6535
	{
6536
		$mbIntEnc = mb_internal_encoding();
6537
		mb_internal_encoding('ASCII');
6538
	}
6539
6540
	$out = _safe_serialize($value);
6541
6542
	if (isset($mbIntEnc))
6543
		mb_internal_encoding($mbIntEnc);
6544
6545
	return $out;
6546
}
6547
6548
/**
6549
 * Safe unserialize() replacement
6550
 * - accepts a strict subset of PHP's native serialized representation
6551
 * - does not unserialize objects
6552
 *
6553
 * @param string $str
6554
 * @return mixed
6555
 * @throw Exception if $str is malformed or contains unsupported types (e.g., resources, objects)
6556
 */
6557
function _safe_unserialize($str)
6558
{
6559
	// Input  is not a string.
6560
	if (empty($str) || !is_string($str))
6561
		return false;
6562
6563
	$stack = array();
6564
	$expected = array();
6565
6566
	/*
6567
	 * states:
6568
	 *   0 - initial state, expecting a single value or array
6569
	 *   1 - terminal state
6570
	 *   2 - in array, expecting end of array or a key
6571
	 *   3 - in array, expecting value or another array
6572
	 */
6573
	$state = 0;
6574
	while ($state != 1)
6575
	{
6576
		$type = isset($str[0]) ? $str[0] : '';
6577
		if ($type == '}')
6578
			$str = substr($str, 1);
6579
6580
		elseif ($type == 'N' && $str[1] == ';')
6581
		{
6582
			$value = null;
6583
			$str = substr($str, 2);
6584
		}
6585
		elseif ($type == 'b' && preg_match('/^b:([01]);/', $str, $matches))
6586
		{
6587
			$value = $matches[1] == '1' ? true : false;
6588
			$str = substr($str, 4);
6589
		}
6590
		elseif ($type == 'i' && preg_match('/^i:(-?[0-9]+);(.*)/s', $str, $matches))
6591
		{
6592
			$value = (int) $matches[1];
6593
			$str = $matches[2];
6594
		}
6595
		elseif ($type == 'd' && preg_match('/^d:(-?[0-9]+\.?[0-9]*(E[+-][0-9]+)?);(.*)/s', $str, $matches))
6596
		{
6597
			$value = (float) $matches[1];
6598
			$str = $matches[3];
6599
		}
6600
		elseif ($type == 's' && preg_match('/^s:([0-9]+):"(.*)/s', $str, $matches) && substr($matches[2], (int) $matches[1], 2) == '";')
6601
		{
6602
			$value = substr($matches[2], 0, (int) $matches[1]);
6603
			$str = substr($matches[2], (int) $matches[1] + 2);
6604
		}
6605
		elseif ($type == 'a' && preg_match('/^a:([0-9]+):{(.*)/s', $str, $matches))
6606
		{
6607
			$expectedLength = (int) $matches[1];
6608
			$str = $matches[2];
6609
		}
6610
6611
		// Object or unknown/malformed type.
6612
		else
6613
			return false;
6614
6615
		switch ($state)
6616
		{
6617
			case 3: // In array, expecting value or another array.
6618
				if ($type == 'a')
6619
				{
6620
					$stack[] = &$list;
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable $list does not seem to be defined for all execution paths leading up to this point.
Loading history...
6621
					$list[$key] = array();
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable $key does not seem to be defined for all execution paths leading up to this point.
Loading history...
6622
					$list = &$list[$key];
6623
					$expected[] = $expectedLength;
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable $expectedLength does not seem to be defined for all execution paths leading up to this point.
Loading history...
6624
					$state = 2;
6625
					break;
6626
				}
6627
				if ($type != '}')
6628
				{
6629
					$list[$key] = $value;
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable $value does not seem to be defined for all execution paths leading up to this point.
Loading history...
6630
					$state = 2;
6631
					break;
6632
				}
6633
6634
				// Missing array value.
6635
				return false;
6636
6637
			case 2: // in array, expecting end of array or a key
6638
				if ($type == '}')
6639
				{
6640
					// Array size is less than expected.
6641
					if (count($list) < end($expected))
6642
						return false;
6643
6644
					unset($list);
6645
					$list = &$stack[count($stack) - 1];
6646
					array_pop($stack);
6647
6648
					// Go to terminal state if we're at the end of the root array.
6649
					array_pop($expected);
6650
6651
					if (count($expected) == 0)
6652
						$state = 1;
6653
6654
					break;
6655
				}
6656
6657
				if ($type == 'i' || $type == 's')
6658
				{
6659
					// Array size exceeds expected length.
6660
					if (count($list) >= end($expected))
6661
						return false;
6662
6663
					$key = $value;
6664
					$state = 3;
6665
					break;
6666
				}
6667
6668
				// Illegal array index type.
6669
				return false;
6670
6671
			// Expecting array or value.
6672
			case 0:
6673
				if ($type == 'a')
6674
				{
6675
					$data = array();
6676
					$list = &$data;
6677
					$expected[] = $expectedLength;
6678
					$state = 2;
6679
					break;
6680
				}
6681
6682
				if ($type != '}')
6683
				{
6684
					$data = $value;
6685
					$state = 1;
6686
					break;
6687
				}
6688
6689
				// Not in array.
6690
				return false;
6691
		}
6692
	}
6693
6694
	// Trailing data in input.
6695
	if (!empty($str))
6696
		return false;
6697
6698
	return $data;
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable $data does not seem to be defined for all execution paths leading up to this point.
Loading history...
6699
}
6700
6701
/**
6702
 * Wrapper for _safe_unserialize() that handles exceptions and multibyte encoding issue
6703
 *
6704
 * @param string $str
6705
 * @return mixed
6706
 */
6707
function safe_unserialize($str)
6708
{
6709
	// Make sure we use the byte count for strings even when strlen() is overloaded by mb_strlen()
6710
	if (function_exists('mb_internal_encoding') &&
6711
		(((int) ini_get('mbstring.func_overload')) & 0x02))
6712
	{
6713
		$mbIntEnc = mb_internal_encoding();
6714
		mb_internal_encoding('ASCII');
6715
	}
6716
6717
	$out = _safe_unserialize($str);
6718
6719
	if (isset($mbIntEnc))
6720
		mb_internal_encoding($mbIntEnc);
6721
6722
	return $out;
6723
}
6724
6725
/**
6726
 * Tries different modes to make file/dirs writable. Wrapper function for chmod()
6727
 *
6728
 * @param string $file The file/dir full path.
6729
 * @param int $value Not needed, added for legacy reasons.
6730
 * @return boolean  true if the file/dir is already writable or the function was able to make it writable, false if the function couldn't make the file/dir writable.
6731
 */
6732
function smf_chmod($file, $value = 0)
6733
{
6734
	// No file? no checks!
6735
	if (empty($file))
6736
		return false;
6737
6738
	// Already writable?
6739
	if (is_writable($file))
6740
		return true;
6741
6742
	// Do we have a file or a dir?
6743
	$isDir = is_dir($file);
6744
	$isWritable = false;
6745
6746
	// Set different modes.
6747
	$chmodValues = $isDir ? array(0750, 0755, 0775, 0777) : array(0644, 0664, 0666);
6748
6749
	foreach ($chmodValues as $val)
6750
	{
6751
		// If it's writable, break out of the loop.
6752
		if (is_writable($file))
6753
		{
6754
			$isWritable = true;
6755
			break;
6756
		}
6757
6758
		else
6759
			@chmod($file, $val);
6760
	}
6761
6762
	return $isWritable;
6763
}
6764
6765
/**
6766
 * Wrapper function for json_decode() with error handling.
6767
 *
6768
 * @param string $json The string to decode.
6769
 * @param bool $returnAsArray To return the decoded string as an array or an object, SMF only uses Arrays but to keep on compatibility with json_decode its set to false as default.
6770
 * @param bool $logIt To specify if the error will be logged if theres any.
6771
 * @return array Either an empty array or the decoded data as an array.
6772
 */
6773
function smf_json_decode($json, $returnAsArray = false, $logIt = true)
6774
{
6775
	global $txt;
6776
6777
	// Come on...
6778
	if (empty($json) || !is_string($json))
6779
		return array();
6780
6781
	$returnArray = @json_decode($json, $returnAsArray);
6782
6783
	// PHP 5.3 so no json_last_error_msg()
6784
	switch (json_last_error())
6785
	{
6786
		case JSON_ERROR_NONE:
6787
			$jsonError = false;
6788
			break;
6789
		case JSON_ERROR_DEPTH:
6790
			$jsonError = 'JSON_ERROR_DEPTH';
6791
			break;
6792
		case JSON_ERROR_STATE_MISMATCH:
6793
			$jsonError = 'JSON_ERROR_STATE_MISMATCH';
6794
			break;
6795
		case JSON_ERROR_CTRL_CHAR:
6796
			$jsonError = 'JSON_ERROR_CTRL_CHAR';
6797
			break;
6798
		case JSON_ERROR_SYNTAX:
6799
			$jsonError = 'JSON_ERROR_SYNTAX';
6800
			break;
6801
		case JSON_ERROR_UTF8:
6802
			$jsonError = 'JSON_ERROR_UTF8';
6803
			break;
6804
		default:
6805
			$jsonError = 'unknown';
6806
			break;
6807
	}
6808
6809
	// Something went wrong!
6810
	if (!empty($jsonError) && $logIt)
6811
	{
6812
		// Being a wrapper means we lost our smf_error_handler() privileges :(
6813
		$jsonDebug = debug_backtrace();
6814
		$jsonDebug = $jsonDebug[0];
6815
		loadLanguage('Errors');
6816
6817
		if (!empty($jsonDebug))
6818
			log_error($txt['json_' . $jsonError], 'critical', $jsonDebug['file'], $jsonDebug['line']);
6819
6820
		else
6821
			log_error($txt['json_' . $jsonError], 'critical');
6822
6823
		// Everyone expects an array.
6824
		return array();
6825
	}
6826
6827
	return $returnArray;
6828
}
6829
6830
/**
6831
 * Check the given String if he is a valid IPv4 or IPv6
6832
 * return true or false
6833
 *
6834
 * @param string $IPString
6835
 *
6836
 * @return bool
6837
 */
6838
function isValidIP($IPString)
6839
{
6840
	return filter_var($IPString, FILTER_VALIDATE_IP) !== false;
6841
}
6842
6843
/**
6844
 * Outputs a response.
6845
 * It assumes the data is already a string.
6846
 *
6847
 * @param string $data The data to print
6848
 * @param string $type The content type. Defaults to Json.
6849
 * @return void
6850
 */
6851
function smf_serverResponse($data = '', $type = 'content-type: application/json')
6852
{
6853
	global $db_show_debug, $modSettings;
6854
6855
	// Defensive programming anyone?
6856
	if (empty($data))
6857
		return false;
6858
6859
	// Don't need extra stuff...
6860
	$db_show_debug = false;
6861
6862
	// Kill anything else.
6863
	ob_end_clean();
6864
6865
	if (!empty($modSettings['CompressedOutput']))
6866
		@ob_start('ob_gzhandler');
6867
6868
	else
6869
		ob_start();
6870
6871
	// Set the header.
6872
	header($type);
6873
6874
	// Echo!
6875
	echo $data;
6876
6877
	// Done.
6878
	obExit(false);
6879
}
6880
6881
/**
6882
 * Creates an optimized regex to match all known top level domains.
6883
 *
6884
 * The optimized regex is stored in $modSettings['tld_regex'].
6885
 *
6886
 * To update the stored version of the regex to use the latest list of valid
6887
 * TLDs from iana.org, set the $update parameter to true. Updating can take some
6888
 * time, based on network connectivity, so it should normally only be done by
6889
 * calling this function from a background or scheduled task.
6890
 *
6891
 * If $update is not true, but the regex is missing or invalid, the regex will
6892
 * be regenerated from a hard-coded list of TLDs. This regenerated regex will be
6893
 * overwritten on the next scheduled update.
6894
 *
6895
 * @param bool $update If true, fetch and process the latest official list of TLDs from iana.org.
6896
 */
6897
function set_tld_regex($update = false)
6898
{
6899
	global $sourcedir, $smcFunc, $modSettings;
6900
	static $done = false;
6901
6902
	// If we don't need to do anything, don't
6903
	if (!$update && $done)
6904
		return;
6905
6906
	// Should we get a new copy of the official list of TLDs?
6907
	if ($update)
6908
	{
6909
		$tlds = fetch_web_data('https://data.iana.org/TLD/tlds-alpha-by-domain.txt');
6910
		$tlds_md5 = fetch_web_data('https://data.iana.org/TLD/tlds-alpha-by-domain.txt.md5');
6911
6912
		/**
6913
		 * If the Internet Assigned Numbers Authority can't be reached, the Internet is GONE!
6914
		 * We're probably running on a server hidden in a bunker deep underground to protect
6915
		 * it from marauding bandits roaming on the surface. We don't want to waste precious
6916
		 * electricity on pointlessly repeating background tasks, so we'll wait until the next
6917
		 * regularly scheduled update to see if civilization has been restored.
6918
		 */
6919
		if ($tlds === false || $tlds_md5 === false)
6920
			$postapocalypticNightmare = true;
6921
6922
		// Make sure nothing went horribly wrong along the way.
6923
		if (md5($tlds) != substr($tlds_md5, 0, 32))
0 ignored issues
show
Bug introduced by
It seems like $tlds can also be of type false; however, parameter $string of md5() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

6923
		if (md5(/** @scrutinizer ignore-type */ $tlds) != substr($tlds_md5, 0, 32))
Loading history...
Bug introduced by
It seems like $tlds_md5 can also be of type false; however, parameter $string of substr() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

6923
		if (md5($tlds) != substr(/** @scrutinizer ignore-type */ $tlds_md5, 0, 32))
Loading history...
6924
			$tlds = array();
6925
	}
6926
	// If we aren't updating and the regex is valid, we're done
6927
	elseif (!empty($modSettings['tld_regex']) && @preg_match('~' . $modSettings['tld_regex'] . '~', null) !== false)
0 ignored issues
show
Bug introduced by
null of type null is incompatible with the type string expected by parameter $subject of preg_match(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

6927
	elseif (!empty($modSettings['tld_regex']) && @preg_match('~' . $modSettings['tld_regex'] . '~', /** @scrutinizer ignore-type */ null) !== false)
Loading history...
6928
	{
6929
		$done = true;
6930
		return;
6931
	}
6932
6933
	// If we successfully got an update, process the list into an array
6934
	if (!empty($tlds))
6935
	{
6936
		// Clean $tlds and convert it to an array
6937
		$tlds = array_filter(explode("\n", strtolower($tlds)), function($line)
6938
		{
6939
			$line = trim($line);
6940
			if (empty($line) || strlen($line) != strspn($line, 'abcdefghijklmnopqrstuvwxyz0123456789-'))
6941
				return false;
6942
			else
6943
				return true;
6944
		});
6945
6946
		// Convert Punycode to Unicode
6947
		require_once($sourcedir . '/Class-Punycode.php');
6948
		$Punycode = new Punycode();
6949
		$tlds = array_map(function($input) use ($Punycode)
6950
		{
6951
			return $Punycode->decode($input);
6952
		}, $tlds);
6953
	}
6954
	// Otherwise, use the 2012 list of gTLDs and ccTLDs for now and schedule a background update
6955
	else
6956
	{
6957
		$tlds = array('com', 'net', 'org', 'edu', 'gov', 'mil', 'aero', 'asia', 'biz',
6958
			'cat', 'coop', 'info', 'int', 'jobs', 'mobi', 'museum', 'name', 'post',
6959
			'pro', 'tel', 'travel', 'xxx', 'ac', 'ad', 'ae', 'af', 'ag', 'ai', 'al',
6960
			'am', 'ao', 'aq', 'ar', 'as', 'at', 'au', 'aw', 'ax', 'az', 'ba', 'bb', 'bd',
6961
			'be', 'bf', 'bg', 'bh', 'bi', 'bj', 'bm', 'bn', 'bo', 'br', 'bs', 'bt', 'bv',
6962
			'bw', 'by', 'bz', 'ca', 'cc', 'cd', 'cf', 'cg', 'ch', 'ci', 'ck', 'cl', 'cm',
6963
			'cn', 'co', 'cr', 'cu', 'cv', 'cx', 'cy', 'cz', 'de', 'dj', 'dk', 'dm', 'do',
6964
			'dz', 'ec', 'ee', 'eg', 'er', 'es', 'et', 'eu', 'fi', 'fj', 'fk', 'fm', 'fo',
6965
			'fr', 'ga', 'gb', 'gd', 'ge', 'gf', 'gg', 'gh', 'gi', 'gl', 'gm', 'gn', 'gp',
6966
			'gq', 'gr', 'gs', 'gt', 'gu', 'gw', 'gy', 'hk', 'hm', 'hn', 'hr', 'ht', 'hu',
6967
			'id', 'ie', 'il', 'im', 'in', 'io', 'iq', 'ir', 'is', 'it', 'je', 'jm', 'jo',
6968
			'jp', 'ke', 'kg', 'kh', 'ki', 'km', 'kn', 'kp', 'kr', 'kw', 'ky', 'kz', 'la',
6969
			'lb', 'lc', 'li', 'lk', 'lr', 'ls', 'lt', 'lu', 'lv', 'ly', 'ma', 'mc', 'md',
6970
			'me', 'mg', 'mh', 'mk', 'ml', 'mm', 'mn', 'mo', 'mp', 'mq', 'mr', 'ms', 'mt',
6971
			'mu', 'mv', 'mw', 'mx', 'my', 'mz', 'na', 'nc', 'ne', 'nf', 'ng', 'ni', 'nl',
6972
			'no', 'np', 'nr', 'nu', 'nz', 'om', 'pa', 'pe', 'pf', 'pg', 'ph', 'pk', 'pl',
6973
			'pm', 'pn', 'pr', 'ps', 'pt', 'pw', 'py', 'qa', 're', 'ro', 'rs', 'ru', 'rw',
6974
			'sa', 'sb', 'sc', 'sd', 'se', 'sg', 'sh', 'si', 'sj', 'sk', 'sl', 'sm', 'sn',
6975
			'so', 'sr', 'ss', 'st', 'su', 'sv', 'sx', 'sy', 'sz', 'tc', 'td', 'tf', 'tg',
6976
			'th', 'tj', 'tk', 'tl', 'tm', 'tn', 'to', 'tr', 'tt', 'tv', 'tw', 'tz', 'ua',
6977
			'ug', 'uk', 'us', 'uy', 'uz', 'va', 'vc', 've', 'vg', 'vi', 'vn', 'vu', 'wf',
6978
			'ws', 'ye', 'yt', 'za', 'zm', 'zw',
6979
		);
6980
6981
		// Schedule a background update, unless civilization has collapsed and/or we are having connectivity issues.
6982
		if (empty($postapocalypticNightmare))
6983
		{
6984
			$smcFunc['db_insert']('insert', '{db_prefix}background_tasks',
6985
				array('task_file' => 'string-255', 'task_class' => 'string-255', 'task_data' => 'string', 'claimed_time' => 'int'),
6986
				array('$sourcedir/tasks/UpdateTldRegex.php', 'Update_TLD_Regex', '', 0), array()
6987
			);
6988
		}
6989
	}
6990
6991
	// Tack on some "special use domain names" that aren't in DNS but may possibly resolve.
6992
	// See https://www.iana.org/assignments/special-use-domain-names/ for more info.
6993
	$tlds = array_merge($tlds, array('local', 'onion', 'test'));
6994
6995
	// Get an optimized regex to match all the TLDs
6996
	$tld_regex = build_regex($tlds);
6997
6998
	// Remember the new regex in $modSettings
6999
	updateSettings(array('tld_regex' => $tld_regex));
7000
7001
	// Redundant repetition is redundant
7002
	$done = true;
7003
}
7004
7005
/**
7006
 * Creates optimized regular expressions from an array of strings.
7007
 *
7008
 * An optimized regex built using this function will be much faster than a
7009
 * simple regex built using `implode('|', $strings)` --- anywhere from several
7010
 * times to several orders of magnitude faster.
7011
 *
7012
 * However, the time required to build the optimized regex is approximately
7013
 * equal to the time it takes to execute the simple regex. Therefore, it is only
7014
 * worth calling this function if the resulting regex will be used more than
7015
 * once.
7016
 *
7017
 * Because PHP places an upper limit on the allowed length of a regex, very
7018
 * large arrays of $strings may not fit in a single regex. Normally, the excess
7019
 * strings will simply be dropped. However, if the $returnArray parameter is set
7020
 * to true, this function will build as many regexes as necessary to accommodate
7021
 * everything in $strings and return them in an array. You will need to iterate
7022
 * through all elements of the returned array in order to test all possible
7023
 * matches.
7024
 *
7025
 * @param array $strings An array of strings to make a regex for.
7026
 * @param string $delim An optional delimiter character to pass to preg_quote().
7027
 * @param bool $returnArray If true, returns an array of regexes.
7028
 * @return string|array One or more regular expressions to match any of the input strings.
7029
 */
7030
function build_regex($strings, $delim = null, $returnArray = false)
7031
{
7032
	global $smcFunc;
7033
	static $regexes = array();
7034
7035
	// If it's not an array, there's not much to do. ;)
7036
	if (!is_array($strings))
0 ignored issues
show
introduced by
The condition is_array($strings) is always true.
Loading history...
7037
		return preg_quote(@strval($strings), $delim);
7038
7039
	$regex_key = md5(json_encode(array($strings, $delim, $returnArray)));
7040
7041
	if (isset($regexes[$regex_key]))
7042
		return $regexes[$regex_key];
7043
7044
	// The mb_* functions are faster than the $smcFunc ones, but may not be available
7045
	if (function_exists('mb_internal_encoding') && function_exists('mb_detect_encoding') && function_exists('mb_strlen') && function_exists('mb_substr'))
7046
	{
7047
		if (($string_encoding = mb_detect_encoding(implode(' ', $strings))) !== false)
7048
		{
7049
			$current_encoding = mb_internal_encoding();
7050
			mb_internal_encoding($string_encoding);
7051
		}
7052
7053
		$strlen = 'mb_strlen';
7054
		$substr = 'mb_substr';
7055
	}
7056
	else
7057
	{
7058
		$strlen = $smcFunc['strlen'];
7059
		$substr = $smcFunc['substr'];
7060
	}
7061
7062
	// This recursive function creates the index array from the strings
7063
	$add_string_to_index = function($string, $index) use (&$strlen, &$substr, &$add_string_to_index)
7064
	{
7065
		static $depth = 0;
7066
		$depth++;
7067
7068
		$first = (string) @$substr($string, 0, 1);
7069
7070
		// No first character? That's no good.
7071
		if ($first === '')
7072
		{
7073
			// A nested array? Really? Ugh. Fine.
7074
			if (is_array($string) && $depth < 20)
7075
			{
7076
				foreach ($string as $str)
7077
					$index = $add_string_to_index($str, $index);
7078
			}
7079
7080
			$depth--;
7081
			return $index;
7082
		}
7083
7084
		if (empty($index[$first]))
7085
			$index[$first] = array();
7086
7087
		if ($strlen($string) > 1)
7088
		{
7089
			// Sanity check on recursion
7090
			if ($depth > 99)
7091
				$index[$first][$substr($string, 1)] = '';
7092
7093
			else
7094
				$index[$first] = $add_string_to_index($substr($string, 1), $index[$first]);
7095
		}
7096
		else
7097
			$index[$first][''] = '';
7098
7099
		$depth--;
7100
		return $index;
7101
	};
7102
7103
	// This recursive function turns the index array into a regular expression
7104
	$index_to_regex = function(&$index, $delim) use (&$strlen, &$index_to_regex)
7105
	{
7106
		static $depth = 0;
7107
		$depth++;
7108
7109
		// Absolute max length for a regex is 32768, but we might need wiggle room
7110
		$max_length = 30000;
7111
7112
		$regex = array();
7113
		$length = 0;
7114
7115
		foreach ($index as $key => $value)
7116
		{
7117
			$key_regex = preg_quote($key, $delim);
7118
			$new_key = $key;
7119
7120
			if (empty($value))
7121
				$sub_regex = '';
7122
			else
7123
			{
7124
				$sub_regex = $index_to_regex($value, $delim);
7125
7126
				if (count(array_keys($value)) == 1)
7127
				{
7128
					$new_key_array = explode('(?' . '>', $sub_regex);
7129
					$new_key .= $new_key_array[0];
7130
				}
7131
				else
7132
					$sub_regex = '(?' . '>' . $sub_regex . ')';
7133
			}
7134
7135
			if ($depth > 1)
7136
				$regex[$new_key] = $key_regex . $sub_regex;
7137
			else
7138
			{
7139
				if (($length += strlen($key_regex) + 1) < $max_length || empty($regex))
7140
				{
7141
					$regex[$new_key] = $key_regex . $sub_regex;
7142
					unset($index[$key]);
7143
				}
7144
				else
7145
					break;
7146
			}
7147
		}
7148
7149
		// Sort by key length and then alphabetically
7150
		uksort($regex, function($k1, $k2) use (&$strlen)
7151
		{
7152
			$l1 = $strlen($k1);
7153
			$l2 = $strlen($k2);
7154
7155
			if ($l1 == $l2)
7156
				return strcmp($k1, $k2) > 0 ? 1 : -1;
7157
			else
7158
				return $l1 > $l2 ? -1 : 1;
7159
		});
7160
7161
		$depth--;
7162
		return implode('|', $regex);
7163
	};
7164
7165
	// Now that the functions are defined, let's do this thing
7166
	$index = array();
7167
	$regex = '';
7168
7169
	foreach ($strings as $string)
7170
		$index = $add_string_to_index($string, $index);
7171
7172
	if ($returnArray === true)
7173
	{
7174
		$regex = array();
7175
		while (!empty($index))
7176
			$regex[] = '(?' . '>' . $index_to_regex($index, $delim) . ')';
7177
	}
7178
	else
7179
		$regex = '(?' . '>' . $index_to_regex($index, $delim) . ')';
7180
7181
	// Restore PHP's internal character encoding to whatever it was originally
7182
	if (!empty($current_encoding))
7183
		mb_internal_encoding($current_encoding);
7184
7185
	$regexes[$regex_key] = $regex;
7186
	return $regex;
7187
}
7188
7189
/**
7190
 * Check if the passed url has an SSL certificate.
7191
 *
7192
 * Returns true if a cert was found & false if not.
7193
 *
7194
 * @param string $url to check, in $boardurl format (no trailing slash).
7195
 */
7196
function ssl_cert_found($url)
7197
{
7198
	// This check won't work without OpenSSL
7199
	if (!extension_loaded('openssl'))
7200
		return true;
7201
7202
	// First, strip the subfolder from the passed url, if any
7203
	$parsedurl = parse_url($url);
7204
	$url = 'ssl://' . $parsedurl['host'] . ':443';
7205
7206
	// Next, check the ssl stream context for certificate info
7207
	if (version_compare(PHP_VERSION, '5.6.0', '<'))
7208
		$ssloptions = array("capture_peer_cert" => true);
7209
	else
7210
		$ssloptions = array("capture_peer_cert" => true, "verify_peer" => true, "allow_self_signed" => true);
7211
7212
	$result = false;
7213
	$context = stream_context_create(array("ssl" => $ssloptions));
7214
	$stream = @stream_socket_client($url, $errno, $errstr, 30, STREAM_CLIENT_CONNECT, $context);
7215
	if ($stream !== false)
7216
	{
7217
		$params = stream_context_get_params($stream);
7218
		$result = isset($params["options"]["ssl"]["peer_certificate"]) ? true : false;
7219
	}
7220
	return $result;
7221
}
7222
7223
/**
7224
 * Check if the passed url has a redirect to https:// by querying headers.
7225
 *
7226
 * Returns true if a redirect was found & false if not.
7227
 * Note that when force_ssl = 2, SMF issues its own redirect...  So if this
7228
 * returns true, it may be caused by SMF, not necessarily an .htaccess redirect.
7229
 *
7230
 * @param string $url to check, in $boardurl format (no trailing slash).
7231
 */
7232
function https_redirect_active($url)
7233
{
7234
	// Ask for the headers for the passed url, but via http...
7235
	// Need to add the trailing slash, or it puts it there & thinks there's a redirect when there isn't...
7236
	$url = str_ireplace('https://', 'http://', $url) . '/';
0 ignored issues
show
Bug introduced by
Are you sure str_ireplace('https://', 'http://', $url) of type array|string can be used in concatenation? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

7236
	$url = /** @scrutinizer ignore-type */ str_ireplace('https://', 'http://', $url) . '/';
Loading history...
7237
	$headers = @get_headers($url);
7238
	if ($headers === false)
7239
		return false;
7240
7241
	// Now to see if it came back https...
7242
	// First check for a redirect status code in first row (301, 302, 307)
7243
	if (strstr($headers[0], '301') === false && strstr($headers[0], '302') === false && strstr($headers[0], '307') === false)
7244
		return false;
7245
7246
	// Search for the location entry to confirm https
7247
	$result = false;
7248
	foreach ($headers as $header)
7249
	{
7250
		if (stristr($header, 'Location: https://') !== false)
7251
		{
7252
			$result = true;
7253
			break;
7254
		}
7255
	}
7256
	return $result;
7257
}
7258
7259
/**
7260
 * Build query_wanna_see_board and query_see_board for a userid
7261
 *
7262
 * Returns array with keys query_wanna_see_board and query_see_board
7263
 *
7264
 * @param int $userid of the user
7265
 */
7266
function build_query_board($userid)
7267
{
7268
	global $user_info, $modSettings, $smcFunc, $db_prefix;
7269
7270
	$query_part = array();
7271
7272
	// If we come from cron, we can't have a $user_info.
7273
	if (isset($user_info['id']) && $user_info['id'] == $userid && SMF != 'BACKGROUND')
7274
	{
7275
		$groups = $user_info['groups'];
7276
		$can_see_all_boards = $user_info['is_admin'] || $user_info['can_manage_boards'];
7277
		$ignoreboards = !empty($user_info['ignoreboards']) ? $user_info['ignoreboards'] : null;
7278
	}
7279
	else
7280
	{
7281
		$request = $smcFunc['db_query']('', '
7282
			SELECT mem.ignore_boards, mem.id_group, mem.additional_groups, mem.id_post_group
7283
			FROM {db_prefix}members AS mem
7284
			WHERE mem.id_member = {int:id_member}
7285
			LIMIT 1',
7286
			array(
7287
				'id_member' => $userid,
7288
			)
7289
		);
7290
7291
		$row = $smcFunc['db_fetch_assoc']($request);
7292
7293
		if (empty($row['additional_groups']))
7294
			$groups = array($row['id_group'], $row['id_post_group']);
7295
		else
7296
			$groups = array_merge(
7297
				array($row['id_group'], $row['id_post_group']),
7298
				explode(',', $row['additional_groups'])
7299
			);
7300
7301
		// Because history has proven that it is possible for groups to go bad - clean up in case.
7302
		foreach ($groups as $k => $v)
7303
			$groups[$k] = (int) $v;
7304
7305
		$can_see_all_boards = in_array(1, $groups) || (!empty($modSettings['board_manager_groups']) && count(array_intersect($groups, explode(',', $modSettings['board_manager_groups']))) > 0);
7306
7307
		$ignoreboards = !empty($row['ignore_boards']) && !empty($modSettings['allow_ignore_boards']) ? explode(',', $row['ignore_boards']) : array();
7308
	}
7309
7310
	// Just build this here, it makes it easier to change/use - administrators can see all boards.
7311
	if ($can_see_all_boards)
7312
		$query_part['query_see_board'] = '1=1';
7313
	// Otherwise just the groups in $user_info['groups'].
7314
	else
7315
	{
7316
		$query_part['query_see_board'] = '
7317
			EXISTS (
7318
				SELECT bpv.id_board
7319
				FROM ' . $db_prefix . 'board_permissions_view AS bpv
7320
				WHERE bpv.id_group IN ('. implode(',', $groups) .')
7321
					AND bpv.deny = 0
7322
					AND bpv.id_board = b.id_board
7323
			)';
7324
7325
		if (!empty($modSettings['deny_boards_access']))
7326
			$query_part['query_see_board'] .= '
7327
			AND NOT EXISTS (
7328
				SELECT bpv.id_board
7329
				FROM ' . $db_prefix . 'board_permissions_view AS bpv
7330
				WHERE bpv.id_group IN ( '. implode(',', $groups) .')
7331
					AND bpv.deny = 1
7332
					AND bpv.id_board = b.id_board
7333
			)';
7334
	}
7335
7336
	$query_part['query_see_message_board'] = str_replace('b.', 'm.', $query_part['query_see_board']);
7337
	$query_part['query_see_topic_board'] = str_replace('b.', 't.', $query_part['query_see_board']);
7338
7339
	// Build the list of boards they WANT to see.
7340
	// This will take the place of query_see_boards in certain spots, so it better include the boards they can see also
7341
7342
	// If they aren't ignoring any boards then they want to see all the boards they can see
7343
	if (empty($ignoreboards))
7344
	{
7345
		$query_part['query_wanna_see_board'] = $query_part['query_see_board'];
7346
		$query_part['query_wanna_see_message_board'] = $query_part['query_see_message_board'];
7347
		$query_part['query_wanna_see_topic_board'] = $query_part['query_see_topic_board'];
7348
	}
7349
	// Ok I guess they don't want to see all the boards
7350
	else
7351
	{
7352
		$query_part['query_wanna_see_board'] = '(' . $query_part['query_see_board'] . ' AND b.id_board NOT IN (' . implode(',', $ignoreboards) . '))';
7353
		$query_part['query_wanna_see_message_board'] = '(' . $query_part['query_see_message_board'] . ' AND m.id_board NOT IN (' . implode(',', $ignoreboards) . '))';
7354
		$query_part['query_wanna_see_topic_board'] = '(' . $query_part['query_see_topic_board'] . ' AND t.id_board NOT IN (' . implode(',', $ignoreboards) . '))';
7355
	}
7356
7357
	return $query_part;
7358
}
7359
7360
/**
7361
 * Check if the connection is using https.
7362
 *
7363
 * @return boolean true if connection used https
7364
 */
7365
function httpsOn()
7366
{
7367
	$secure = false;
7368
7369
	if (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on')
7370
		$secure = true;
7371
	elseif (!empty($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https' || !empty($_SERVER['HTTP_X_FORWARDED_SSL']) && $_SERVER['HTTP_X_FORWARDED_SSL'] == 'on')
0 ignored issues
show
introduced by
Consider adding parentheses for clarity. Current Interpretation: (! empty($_SERVER['HTTP_...FORWARDED_SSL'] == 'on', Probably Intended Meaning: ! empty($_SERVER['HTTP_X...ORWARDED_SSL'] == 'on')
Loading history...
7372
		$secure = true;
7373
7374
	return $secure;
7375
}
7376
7377
/**
7378
 * A wrapper for `filter_var($url, FILTER_VALIDATE_URL)` that can handle URLs
7379
 * with international characters (a.k.a. IRIs)
7380
 *
7381
 * @param string $iri The IRI to test.
7382
 * @param int $flags Optional flags to pass to filter_var()
7383
 * @return string|bool Either the original IRI, or false if the IRI was invalid.
7384
 */
7385
function validate_iri($iri, $flags = null)
7386
{
7387
	$url = iri_to_url($iri);
7388
7389
	if (filter_var($url, FILTER_VALIDATE_URL, $flags) !== false)
0 ignored issues
show
Bug introduced by
It seems like $flags can also be of type null; however, parameter $options of filter_var() does only seem to accept array|integer, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

7389
	if (filter_var($url, FILTER_VALIDATE_URL, /** @scrutinizer ignore-type */ $flags) !== false)
Loading history...
7390
		return $iri;
7391
	else
7392
		return false;
7393
}
7394
7395
/**
7396
 * A wrapper for `filter_var($url, FILTER_SANITIZE_URL)` that can handle URLs
7397
 * with international characters (a.k.a. IRIs)
7398
 *
7399
 * Note: The returned value will still be an IRI, not a URL. To convert to URL,
7400
 * feed the result of this function to iri_to_url()
7401
 *
7402
 * @param string $iri The IRI to sanitize.
7403
 * @return string|bool The sanitized version of the IRI
7404
 */
7405
function sanitize_iri($iri)
7406
{
7407
	// Encode any non-ASCII characters (but not space or control characters of any sort)
7408
	// Also encode '%' in order to preserve anything that is already percent-encoded.
7409
	$iri = preg_replace_callback('~[^\x00-\x7F\pZ\pC]|%~u', function($matches)
7410
	{
7411
		return rawurlencode($matches[0]);
7412
	}, $iri);
7413
7414
	// Perform normal sanitization
7415
	$iri = filter_var($iri, FILTER_SANITIZE_URL);
7416
7417
	// Decode the non-ASCII characters
7418
	$iri = rawurldecode($iri);
7419
7420
	return $iri;
7421
}
7422
7423
/**
7424
 * Converts a URL with international characters (an IRI) into a pure ASCII URL
7425
 *
7426
 * Uses Punycode to encode any non-ASCII characters in the domain name, and uses
7427
 * standard URL encoding on the rest.
7428
 *
7429
 * @param string $iri A IRI that may or may not contain non-ASCII characters.
7430
 * @return string|bool The URL version of the IRI.
7431
 */
7432
function iri_to_url($iri)
7433
{
7434
	global $sourcedir;
7435
7436
	$host = parse_url((strpos($iri, '//') === 0 ? 'http:' : '') . $iri, PHP_URL_HOST);
7437
7438
	if (!empty($host))
7439
	{
7440
		// Convert the host using the Punycode algorithm
7441
		require_once($sourcedir . '/Class-Punycode.php');
7442
		$Punycode = new Punycode();
7443
		$encoded_host = $Punycode->encode($host);
7444
7445
		$pos = strpos($iri, $host);
7446
	}
7447
	else
7448
	{
7449
		$encoded_host = '';
7450
		$pos = 0;
7451
	}
7452
7453
	$before_host = substr($iri, 0, $pos);
7454
	$after_host = substr($iri, $pos + strlen($host));
7455
7456
	// Encode any disallowed characters in the rest of the URL
7457
	$unescaped = array(
7458
		'%21' => '!', '%23' => '#', '%24' => '$', '%26' => '&',
7459
		'%27' => "'", '%28' => '(', '%29' => ')', '%2A' => '*',
7460
		'%2B' => '+', '%2C' => ',', '%2F' => '/', '%3A' => ':',
7461
		'%3B' => ';', '%3D' => '=', '%3F' => '?', '%40' => '@',
7462
		'%25' => '%',
7463
	);
7464
7465
	$before_host = strtr(rawurlencode($before_host), $unescaped);
7466
	$after_host = strtr(rawurlencode($after_host), $unescaped);
7467
7468
	return $before_host . $encoded_host . $after_host;
7469
}
7470
7471
/**
7472
 * Decodes a URL containing encoded international characters to UTF-8
7473
 *
7474
 * Decodes any Punycode encoded characters in the domain name, then uses
7475
 * standard URL decoding on the rest.
7476
 *
7477
 * @param string $url The pure ASCII version of a URL.
7478
 * @return string|bool The UTF-8 version of the URL.
7479
 */
7480
function url_to_iri($url)
7481
{
7482
	global $sourcedir;
7483
7484
	$host = parse_url((strpos($url, '//') === 0 ? 'http:' : '') . $url, PHP_URL_HOST);
7485
7486
	if (!empty($host))
7487
	{
7488
		// Decode the domain from Punycode
7489
		require_once($sourcedir . '/Class-Punycode.php');
7490
		$Punycode = new Punycode();
7491
		$decoded_host = $Punycode->decode($host);
7492
7493
		$pos = strpos($url, $host);
7494
	}
7495
	else
7496
	{
7497
		$decoded_host = '';
7498
		$pos = 0;
7499
	}
7500
7501
	$before_host = substr($url, 0, $pos);
7502
	$after_host = substr($url, $pos + strlen($host));
7503
7504
	// Decode the rest of the URL
7505
	$before_host = rawurldecode($before_host);
7506
	$after_host = rawurldecode($after_host);
7507
7508
	return $before_host . $decoded_host . $after_host;
7509
}
7510
7511
/**
7512
 * Ensures SMF's scheduled tasks are being run as intended
7513
 *
7514
 * If the admin activated the cron_is_real_cron setting, but the cron job is
7515
 * not running things at least once per day, we need to go back to SMF's default
7516
 * behaviour using "web cron" JavaScript calls.
7517
 */
7518
function check_cron()
7519
{
7520
	global $modSettings, $smcFunc, $txt;
7521
7522
	if (!empty($modSettings['cron_is_real_cron']) && time() - @intval($modSettings['cron_last_checked']) > 84600)
7523
	{
7524
		$request = $smcFunc['db_query']('', '
7525
			SELECT COUNT(*)
7526
			FROM {db_prefix}scheduled_tasks
7527
			WHERE disabled = {int:not_disabled}
7528
				AND next_time < {int:yesterday}',
7529
			array(
7530
				'not_disabled' => 0,
7531
				'yesterday' => time() - 84600,
7532
			)
7533
		);
7534
		list($overdue) = $smcFunc['db_fetch_row']($request);
7535
		$smcFunc['db_free_result']($request);
7536
7537
		// If we have tasks more than a day overdue, cron isn't doing its job.
7538
		if (!empty($overdue))
7539
		{
7540
			loadLanguage('ManageScheduledTasks');
7541
			log_error($txt['cron_not_working']);
7542
			updateSettings(array('cron_is_real_cron' => 0));
7543
		}
7544
		else
7545
			updateSettings(array('cron_last_checked' => time()));
7546
	}
7547
}
7548
7549
/**
7550
 * Sends an appropriate HTTP status header based on a given status code
7551
 *
7552
 * @param int $code The status code
7553
 * @param string $status The string for the status. Set automatically if not provided.
7554
 */
7555
function send_http_status($code, $status = '')
7556
{
7557
	$statuses = array(
7558
		206 => 'Partial Content',
7559
		304 => 'Not Modified',
7560
		400 => 'Bad Request',
7561
		403 => 'Forbidden',
7562
		404 => 'Not Found',
7563
		410 => 'Gone',
7564
		500 => 'Internal Server Error',
7565
		503 => 'Service Unavailable',
7566
	);
7567
7568
	$protocol = preg_match('~^\s*(HTTP/[12]\.\d)\s*$~i', $_SERVER['SERVER_PROTOCOL'], $matches) ? $matches[1] : 'HTTP/1.0';
7569
7570
	if (!isset($statuses[$code]) && empty($status))
7571
		header($protocol . ' 500 Internal Server Error');
7572
	else
7573
		header($protocol . ' ' . $code . ' ' . (!empty($status) ? $status : $statuses[$code]));
7574
}
7575
7576
/**
7577
 * Concatenates an array of strings into a grammatically correct sentence list
7578
 *
7579
 * Uses formats defined in the language files to build the list appropropriately
7580
 * for the currently loaded language.
7581
 *
7582
 * @param array $list An array of strings to concatenate.
7583
 * @return string The localized sentence list.
7584
 */
7585
function sentence_list($list)
7586
{
7587
	global $txt;
7588
7589
	// Make sure the bare necessities are defined
7590
	if (empty($txt['sentence_list_format']['n']))
7591
		$txt['sentence_list_format']['n'] = '{series}';
7592
	if (!isset($txt['sentence_list_separator']))
7593
		$txt['sentence_list_separator'] = ', ';
7594
	if (!isset($txt['sentence_list_separator_alt']))
7595
		$txt['sentence_list_separator_alt'] = '; ';
7596
7597
	// Which format should we use?
7598
	if (isset($txt['sentence_list_format'][count($list)]))
7599
		$format = $txt['sentence_list_format'][count($list)];
7600
	else
7601
		$format = $txt['sentence_list_format']['n'];
7602
7603
	// Do we want the normal separator or the alternate?
7604
	$separator = $txt['sentence_list_separator'];
7605
	foreach ($list as $item)
7606
	{
7607
		if (strpos($item, $separator) !== false)
7608
		{
7609
			$separator = $txt['sentence_list_separator_alt'];
7610
			$format = strtr($format, trim($txt['sentence_list_separator']), trim($separator));
7611
			break;
7612
		}
7613
	}
7614
7615
	$replacements = array();
7616
7617
	// Special handling for the last items on the list
7618
	$i = 0;
7619
	while (empty($done))
7620
	{
7621
		if (strpos($format, '{'. --$i . '}') !== false)
7622
			$replacements['{'. $i . '}'] = array_pop($list);
7623
		else
7624
			$done = true;
7625
	}
7626
	unset($done);
7627
7628
	// Special handling for the first items on the list
7629
	$i = 0;
7630
	while (empty($done))
7631
	{
7632
		if (strpos($format, '{'. ++$i . '}') !== false)
7633
			$replacements['{'. $i . '}'] = array_shift($list);
7634
		else
7635
			$done = true;
7636
	}
7637
	unset($done);
7638
7639
	// Whatever is left
7640
	$replacements['{series}'] = implode($separator, $list);
7641
7642
	// Do the deed
7643
	return strtr($format, $replacements);
7644
}
7645
7646
/**
7647
 * Truncate an array to a specified length
7648
 *
7649
 * @param array $array The array to truncate
7650
 * @param int $max_length The upperbound on the length
7651
 * @param int $deep How levels in an multidimensional array should the function take into account.
7652
 * @return array The truncated array
7653
 */
7654
function truncate_array($array, $max_length = 1900, $deep = 3)
7655
{
7656
	$array = (array) $array;
7657
7658
	$curr_length = array_length($array, $deep);
7659
7660
	if ($curr_length <= $max_length)
7661
		return $array;
7662
7663
	else
7664
	{
7665
		// Truncate each element's value to a reasonable length
7666
		$param_max = floor($max_length / count($array));
7667
7668
		$current_deep = $deep - 1;
7669
7670
		foreach ($array as $key => &$value)
7671
		{
7672
			if (is_array($value))
7673
				if ($current_deep > 0)
7674
					$value = truncate_array($value, $current_deep);
7675
7676
			else
7677
				$value = substr($value, 0, $param_max - strlen($key) - 5);
0 ignored issues
show
Bug introduced by
$param_max - strlen($key) - 5 of type double is incompatible with the type integer|null expected by parameter $length of substr(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

7677
				$value = substr($value, 0, /** @scrutinizer ignore-type */ $param_max - strlen($key) - 5);
Loading history...
Bug introduced by
$value of type array is incompatible with the type string expected by parameter $string of substr(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

7677
				$value = substr(/** @scrutinizer ignore-type */ $value, 0, $param_max - strlen($key) - 5);
Loading history...
7678
		}
7679
7680
		return $array;
7681
	}
7682
}
7683
7684
/**
7685
 * array_length Recursive
7686
 * @param array $array
7687
 * @param int $deep How many levels should the function
7688
 * @return int
7689
 */
7690
function array_length($array, $deep = 3)
7691
{
7692
	// Work with arrays
7693
	$array = (array) $array;
7694
	$length = 0;
7695
7696
	$deep_count = $deep - 1;
7697
7698
	foreach ($array as $value)
7699
	{
7700
		// Recursive?
7701
		if (is_array($value))
7702
		{
7703
			// No can't do
7704
			if ($deep_count <= 0)
7705
				continue;
7706
7707
			$length += array_length($value, $deep_count);
7708
		}
7709
		else
7710
			$length += strlen($value);
7711
	}
7712
7713
	return $length;
7714
}
7715
7716
/**
7717
 * Compares existance request variables against an array.
7718
 *
7719
 * The input array is associative, where keys denote accepted values
7720
 * in a request variable denoted by `$req_val`. Values can be:
7721
 *
7722
 * - another associative array where at least one key must be found
7723
 *   in the request and their values are accepted request values.
7724
 * - A scalar value, in which case no furthur checks are done.
7725
 *
7726
 * @param array $array
7727
 * @param string $req_var request variable
7728
 *
7729
 * @return bool whether any of the criteria was satisfied
7730
 */
7731
function is_filtered_request(array $array, $req_var)
7732
{
7733
	$matched = false;
7734
	if (isset($_REQUEST[$req_var], $array[$_REQUEST[$req_var]]))
7735
	{
7736
		if (is_array($array[$_REQUEST[$req_var]]))
7737
		{
7738
			foreach ($array[$_REQUEST[$req_var]] as $subtype => $subnames)
7739
				$matched |= isset($_REQUEST[$subtype]) && in_array($_REQUEST[$subtype], $subnames);
7740
		}
7741
		else
7742
			$matched = true;
7743
	}
7744
7745
	return (bool) $matched;
7746
}
7747
7748
/**
7749
 * Clean up the XML to make sure it doesn't contain invalid characters.
7750
 *
7751
 * See https://www.w3.org/TR/xml/#charsets
7752
 *
7753
 * @param string $string The string to clean
7754
 * @return string The cleaned string
7755
 */
7756
function cleanXml($string)
7757
{
7758
	global $context;
7759
7760
	$illegal_chars = array(
7761
		// Remove all ASCII control characters except \t, \n, and \r.
7762
		"\x00", "\x01", "\x02", "\x03", "\x04", "\x05", "\x06", "\x07", "\x08",
7763
		"\x0B", "\x0C", "\x0E", "\x0F", "\x10", "\x11", "\x12", "\x13", "\x14",
7764
		"\x15", "\x16", "\x17", "\x18", "\x19", "\x1A", "\x1B", "\x1C", "\x1D",
7765
		"\x1E", "\x1F",
7766
		// Remove \xFFFE and \xFFFF
7767
		"\xEF\xBF\xBE", "\xEF\xBF\xBF",
7768
	);
7769
7770
	$string = str_replace($illegal_chars, '', $string);
7771
7772
	// The Unicode surrogate pair code points should never be present in our
7773
	// strings to begin with, but if any snuck in, they need to be removed.
7774
	if (!empty($context['utf8']) && strpos($string, "\xED") !== false)
7775
		$string = preg_replace('/\xED[\xA0-\xBF][\x80-\xBF]/', '', $string);
7776
7777
	return $string;
7778
}
7779
7780
/**
7781
 * Escapes (replaces) characters in strings to make them safe for use in javascript
7782
 *
7783
 * @param string $string The string to escape
7784
 * @return string The escaped string
7785
 */
7786
function JavaScriptEscape($string)
7787
{
7788
	global $scripturl;
7789
7790
	return '\'' . strtr($string, array(
7791
		"\r" => '',
7792
		"\n" => '\\n',
7793
		"\t" => '\\t',
7794
		'\\' => '\\\\',
7795
		'\'' => '\\\'',
7796
		'</' => '<\' + \'/',
7797
		'<script' => '<scri\'+\'pt',
7798
		'<body>' => '<bo\'+\'dy>',
7799
		'<a href' => '<a hr\'+\'ef',
7800
		$scripturl => '\' + smf_scripturl + \'',
7801
	)) . '\'';
7802
}
7803
7804
?>