SimpleMachines / SMF2.1

Sources/Logging.php

Doc Comments +1 added lines, -1 removed lines

@@ -19,7 +19,7 @@
 /**
  * Truncate the GET array to a specified length
  * @param array $arr The array to truncate
- * @param max_length $max_length The upperbound on the length
+ * @param integer $max_length The upperbound on the length
  *
  * @return array The truncated array
  */

Spacing +4 added lines, -4 removed lines

@@ -23,7 +23,7 @@ 
  *
  * @return array The truncated array
  */
-function truncateArray($arr, $max_length=1900)
+function truncateArray($arr, $max_length = 1900)
 {
 	$curr_length = array_sum(array_map("strlen", $arr));
 	if ($curr_length <= $max_length)
@@ -31,7 +31,7 @@ 
 	else
 	{
 		// Truncate each element's value to a reasonable length
-		$param_max = floor($max_length/count($arr));
+		$param_max = floor($max_length / count($arr));
 		foreach ($arr as $key => &$value)
 			$value = substr($value, 0, $param_max - strlen($key) - 5);
 		return $arr;
@@ -197,7 +197,7 @@ 
 	if (filemtime($boarddir . '/db_last_error.php') === $last_db_error_change)
 	{
 		// Write the change
-		$write_db_change =  '<' . '?' . "php\n" . '$db_last_error = ' . time() . ';' . "\n" . '?' . '>';
+		$write_db_change = '<' . '?' . "php\n" . '$db_last_error = ' . time() . ';' . "\n" . '?' . '>';
 		$written_bytes = file_put_contents($boarddir . '/db_last_error.php', $write_db_change, LOCK_EX);
 
 		// survey says ...
@@ -270,7 +270,7 @@ 
 	', $txt['debug_language_files'], count($context['debug']['language_files']), ': <em>', implode('</em>, <em>', $context['debug']['language_files']), '</em>.<br>
 	', $txt['debug_stylesheets'], count($context['debug']['sheets']), ': <em>', implode('</em>, <em>', $context['debug']['sheets']), '</em>.<br>
 	', $txt['debug_hooks'], empty($context['debug']['hooks']) ? 0 : count($context['debug']['hooks']) . ' (<a href="javascript:void(0);" onclick="document.getElementById(\'debug_hooks\').style.display = \'inline\'; this.style.display = \'none\'; return false;">', $txt['debug_show'], '</a><span id="debug_hooks" style="display: none;"><em>' . implode('</em>, <em>', $context['debug']['hooks']), '</em></span>)', '<br>
-	',(isset($context['debug']['instances']) ? ($txt['debug_instances'] . (empty($context['debug']['instances']) ? 0 : count($context['debug']['instances'])) . ' (<a href="javascript:void(0);" onclick="document.getElementById(\'debug_instances\').style.display = \'inline\'; this.style.display = \'none\'; return false;">'. $txt['debug_show'] .'</a><span id="debug_instances" style="display: none;"><em>'. implode('</em>, <em>', array_keys($context['debug']['instances'])) .'</em></span>)'. '<br>') : ''),'
+	',(isset($context['debug']['instances']) ? ($txt['debug_instances'] . (empty($context['debug']['instances']) ? 0 : count($context['debug']['instances'])) . ' (<a href="javascript:void(0);" onclick="document.getElementById(\'debug_instances\').style.display = \'inline\'; this.style.display = \'none\'; return false;">' . $txt['debug_show'] . '</a><span id="debug_instances" style="display: none;"><em>' . implode('</em>, <em>', array_keys($context['debug']['instances'])) . '</em></span>)' . '<br>') : ''), '
 	', $txt['debug_files_included'], count($files), ' - ', round($total_size / 1024), $txt['debug_kb'], ' (<a href="javascript:void(0);" onclick="document.getElementById(\'debug_include_info\').style.display = \'inline\'; this.style.display = \'none\'; return false;">', $txt['debug_show'], '</a><span id="debug_include_info" style="display: none;"><em>', implode('</em>, <em>', $files), '</em></span>)<br>';
 
 	if (function_exists('memory_get_peak_usage'))

Braces +140 added lines, -101 removed lines

@@ -13,8 +13,9 @@ 
  * @version 2.1 Beta 3
  */
 
-if (!defined('SMF'))
+if (!defined('SMF')) {
 	die('No direct access...');
+}
 
 /**
  * Truncate the GET array to a specified length
@@ -26,14 +27,15 @@ 
 function truncateArray($arr, $max_length=1900)
 {
 	$curr_length = array_sum(array_map("strlen", $arr));
-	if ($curr_length <= $max_length)
-		return $arr;
-	else
+	if ($curr_length <= $max_length) {
+			return $arr;
+	} else
 	{
 		// Truncate each element's value to a reasonable length
 		$param_max = floor($max_length/count($arr));
-		foreach ($arr as $key => &$value)
-			$value = substr($value, 0, $param_max - strlen($key) - 5);
+		foreach ($arr as $key => &$value) {
+					$value = substr($value, 0, $param_max - strlen($key) - 5);
+		}
 		return $arr;
 	}
 }
@@ -55,8 +57,9 @@ 
 		// Don't update for every page - this isn't wholly accurate but who cares.
 		if ($topic)
 		{
-			if (isset($_SESSION['last_topic_id']) && $_SESSION['last_topic_id'] == $topic)
-				$force = false;
+			if (isset($_SESSION['last_topic_id']) && $_SESSION['last_topic_id'] == $topic) {
+							$force = false;
+			}
 			$_SESSION['last_topic_id'] = $topic;
 		}
 	}
@@ -69,22 +72,24 @@ 
 	}
 
 	// Don't mark them as online more than every so often.
-	if (!empty($_SESSION['log_time']) && $_SESSION['log_time'] >= (time() - 8) && !$force)
-		return;
+	if (!empty($_SESSION['log_time']) && $_SESSION['log_time'] >= (time() - 8) && !$force) {
+			return;
+	}
 
 	if (!empty($modSettings['who_enabled']))
 	{
 		$serialized = truncateArray($_GET) + array('USER_AGENT' => $_SERVER['HTTP_USER_AGENT']);
 
 		// In the case of a dlattach action, session_var may not be set.
-		if (!isset($context['session_var']))
-			$context['session_var'] = $_SESSION['session_var'];
+		if (!isset($context['session_var'])) {
+					$context['session_var'] = $_SESSION['session_var'];
+		}
 
 		unset($serialized['sesc'], $serialized[$context['session_var']]);
 		$serialized = json_encode($serialized);
+	} else {
+			$serialized = '';
 	}
-	else
-		$serialized = '';
 
 	// Guests use 0, members use their session ID.
 	$session_id = $user_info['is_guest'] ? 'ip' . $user_info['ip'] : session_id();
@@ -124,17 +129,18 @@ 
 		);
 
 		// Guess it got deleted.
-		if ($smcFunc['db_affected_rows']() == 0)
+		if ($smcFunc['db_affected_rows']() == 0) {
+					$_SESSION['log_time'] = 0;
+		}
+	} else {
 			$_SESSION['log_time'] = 0;
 	}
-	else
-		$_SESSION['log_time'] = 0;
 
 	// Otherwise, we have to delete and insert.
 	if (empty($_SESSION['log_time']))
 	{
-		if ($do_delete || !empty($user_info['id']))
-			$smcFunc['db_query']('', '
+		if ($do_delete || !empty($user_info['id'])) {
+					$smcFunc['db_query']('', '
 				DELETE FROM {db_prefix}log_online
 				WHERE ' . ($do_delete ? 'log_time < {int:log_time}' : '') . ($do_delete && !empty($user_info['id']) ? ' OR ' : '') . (empty($user_info['id']) ? '' : 'id_member = {int:current_member}'),
 				array(
@@ -142,6 +148,7 @@ 
 					'log_time' => time() - $modSettings['lastActive'] * 60,
 				)
 			);
+		}
 
 		$smcFunc['db_insert']($do_delete ? 'ignore' : 'replace',
 			'{db_prefix}log_online',
@@ -155,21 +162,24 @@ 
 	$_SESSION['log_time'] = time();
 
 	// Well, they are online now.
-	if (empty($_SESSION['timeOnlineUpdated']))
-		$_SESSION['timeOnlineUpdated'] = time();
+	if (empty($_SESSION['timeOnlineUpdated'])) {
+			$_SESSION['timeOnlineUpdated'] = time();
+	}
 
 	// Set their login time, if not already done within the last minute.
 	if (SMF != 'SSI' && !empty($user_info['last_login']) && $user_info['last_login'] < time() - 60 && (!isset($_REQUEST['action']) || !in_array($_REQUEST['action'], array('.xml', 'login2', 'logintfa'))))
 	{
 		// Don't count longer than 15 minutes.
-		if (time() - $_SESSION['timeOnlineUpdated'] > 60 * 15)
-			$_SESSION['timeOnlineUpdated'] = time();
+		if (time() - $_SESSION['timeOnlineUpdated'] > 60 * 15) {
+					$_SESSION['timeOnlineUpdated'] = time();
+		}
 
 		$user_settings['total_time_logged_in'] += time() - $_SESSION['timeOnlineUpdated'];
 		updateMemberData($user_info['id'], array('last_login' => time(), 'member_ip' => $user_info['ip'], 'member_ip2' => $_SERVER['BAN_CHECK_IP'], 'total_time_logged_in' => $user_settings['total_time_logged_in']));
 
-		if (!empty($modSettings['cache_enable']) && $modSettings['cache_enable'] >= 2)
-			cache_put_data('user_settings-' . $user_info['id'], $user_settings, 60);
+		if (!empty($modSettings['cache_enable']) && $modSettings['cache_enable'] >= 2) {
+					cache_put_data('user_settings-' . $user_info['id'], $user_settings, 60);
+		}
 
 		$user_info['total_time_logged_in'] += time() - $_SESSION['timeOnlineUpdated'];
 		$_SESSION['timeOnlineUpdated'] = time();
@@ -206,8 +216,7 @@ 
 			// Oops. maybe we have no more disk space left, or some other troubles, troubles...
 			// Copy the file back and run for your life!
 			@copy($boarddir . '/db_last_error_bak.php', $boarddir . '/db_last_error.php');
-		}
-		else
+		} else
 		{
 			@touch($boarddir . '/' . 'Settings.php');
 			return true;
@@ -227,22 +236,27 @@ 
 	global $db_cache, $db_count, $cache_misses, $cache_count_misses, $db_show_debug, $cache_count, $cache_hits, $smcFunc, $txt;
 
 	// Add to Settings.php if you want to show the debugging information.
-	if (!isset($db_show_debug) || $db_show_debug !== true || (isset($_GET['action']) && $_GET['action'] == 'viewquery'))
-		return;
+	if (!isset($db_show_debug) || $db_show_debug !== true || (isset($_GET['action']) && $_GET['action'] == 'viewquery')) {
+			return;
+	}
 
-	if (empty($_SESSION['view_queries']))
-		$_SESSION['view_queries'] = 0;
-	if (empty($context['debug']['language_files']))
-		$context['debug']['language_files'] = array();
-	if (empty($context['debug']['sheets']))
-		$context['debug']['sheets'] = array();
+	if (empty($_SESSION['view_queries'])) {
+			$_SESSION['view_queries'] = 0;
+	}
+	if (empty($context['debug']['language_files'])) {
+			$context['debug']['language_files'] = array();
+	}
+	if (empty($context['debug']['sheets'])) {
+			$context['debug']['sheets'] = array();
+	}
 
 	$files = get_included_files();
 	$total_size = 0;
 	for ($i = 0, $n = count($files); $i < $n; $i++)
 	{
-		if (file_exists($files[$i]))
-			$total_size += filesize($files[$i]);
+		if (file_exists($files[$i])) {
+					$total_size += filesize($files[$i]);
+		}
 		$files[$i] = strtr($files[$i], array($boarddir => '.', $sourcedir => '(Sources)', $cachedir => '(Cache)', $settings['actual_theme_dir'] => '(Current Theme)'));
 	}
 
@@ -251,8 +265,9 @@ 
 	{
 		foreach ($db_cache as $q => $qq)
 		{
-			if (!empty($qq['w']))
-				$warnings += count($qq['w']);
+			if (!empty($qq['w'])) {
+							$warnings += count($qq['w']);
+			}
 		}
 
 		$_SESSION['debug'] = &$db_cache;
@@ -273,12 +288,14 @@ 
 	',(isset($context['debug']['instances']) ? ($txt['debug_instances'] . (empty($context['debug']['instances']) ? 0 : count($context['debug']['instances'])) . ' (<a href="javascript:void(0);" onclick="document.getElementById(\'debug_instances\').style.display = \'inline\'; this.style.display = \'none\'; return false;">'. $txt['debug_show'] .'</a><span id="debug_instances" style="display: none;"><em>'. implode('</em>, <em>', array_keys($context['debug']['instances'])) .'</em></span>)'. '<br>') : ''),'
 	', $txt['debug_files_included'], count($files), ' - ', round($total_size / 1024), $txt['debug_kb'], ' (<a href="javascript:void(0);" onclick="document.getElementById(\'debug_include_info\').style.display = \'inline\'; this.style.display = \'none\'; return false;">', $txt['debug_show'], '</a><span id="debug_include_info" style="display: none;"><em>', implode('</em>, <em>', $files), '</em></span>)<br>';
 
-	if (function_exists('memory_get_peak_usage'))
-		echo $txt['debug_memory_use'], ceil(memory_get_peak_usage() / 1024), $txt['debug_kb'], '<br>';
+	if (function_exists('memory_get_peak_usage')) {
+			echo $txt['debug_memory_use'], ceil(memory_get_peak_usage() / 1024), $txt['debug_kb'], '<br>';
+	}
 
 	// What tokens are active?
-	if (isset($_SESSION['token']))
-		echo $txt['debug_tokens'] . '<em>' . implode(',</em> <em>', array_keys($_SESSION['token'])), '</em>.<br>';
+	if (isset($_SESSION['token'])) {
+			echo $txt['debug_tokens'] . '<em>' . implode(',</em> <em>', array_keys($_SESSION['token'])), '</em>.<br>';
+	}
 
 	if (!empty($modSettings['cache_enable']) && !empty($cache_hits))
 	{
@@ -292,10 +309,12 @@ 
 			$total_t += $cache_hit['t'];
 			$total_s += $cache_hit['s'];
 		}
-		if (!isset($cache_misses))
-			$cache_misses = array();
-		foreach ($cache_misses as $missed)
-			$missed_entries[] = $missed['d'] . ' ' . $missed['k'];
+		if (!isset($cache_misses)) {
+					$cache_misses = array();
+		}
+		foreach ($cache_misses as $missed) {
+					$missed_entries[] = $missed['d'] . ' ' . $missed['k'];
+		}
 
 		echo '
 	', $txt['debug_cache_hits'], $cache_count, ': ', sprintf($txt['debug_cache_seconds_bytes_total'], comma_format($total_t, 5), comma_format($total_s)), ' (<a href="javascript:void(0);" onclick="document.getElementById(\'debug_cache_info\').style.display = \'inline\'; this.style.display = \'none\'; return false;">', $txt['debug_show'], '</a><span id="debug_cache_info" style="display: none;"><em>', implode('</em>, <em>', $entries), '</em></span>)<br>
@@ -306,38 +325,44 @@ 
 	<a href="', $scripturl, '?action=viewquery" target="_blank" class="new_win">', $warnings == 0 ? sprintf($txt['debug_queries_used'], (int) $db_count) : sprintf($txt['debug_queries_used_and_warnings'], (int) $db_count, $warnings), '</a><br>
 	<br>';
 
-	if ($_SESSION['view_queries'] == 1 && !empty($db_cache))
-		foreach ($db_cache as $q => $qq)
+	if ($_SESSION['view_queries'] == 1 && !empty($db_cache)) {
+			foreach ($db_cache as $q => $qq)
 		{
 			$is_select = strpos(trim($qq['q']), 'SELECT') === 0 || preg_match('~^INSERT(?: IGNORE)? INTO \w+(?:\s+\([^)]+\))?\s+SELECT .+$~s', trim($qq['q'])) != 0;
+	}
 			// Temporary tables created in earlier queries are not explainable.
 			if ($is_select)
 			{
-				foreach (array('log_topics_unread', 'topics_posted_in', 'tmp_log_search_topics', 'tmp_log_search_messages') as $tmp)
-					if (strpos(trim($qq['q']), $tmp) !== false)
+				foreach (array('log_topics_unread', 'topics_posted_in', 'tmp_log_search_topics', 'tmp_log_search_messages') as $tmp) {
+									if (strpos(trim($qq['q']), $tmp) !== false)
 					{
 						$is_select = false;
+				}
 						break;
 					}
 			}
 			// But actual creation of the temporary tables are.
-			elseif (preg_match('~^CREATE TEMPORARY TABLE .+?SELECT .+$~s', trim($qq['q'])) != 0)
-				$is_select = true;
+			elseif (preg_match('~^CREATE TEMPORARY TABLE .+?SELECT .+$~s', trim($qq['q'])) != 0) {
+							$is_select = true;
+			}
 
 			// Make the filenames look a bit better.
-			if (isset($qq['f']))
-				$qq['f'] = preg_replace('~^' . preg_quote($boarddir, '~') . '~', '...', $qq['f']);
+			if (isset($qq['f'])) {
+							$qq['f'] = preg_replace('~^' . preg_quote($boarddir, '~') . '~', '...', $qq['f']);
+			}
 
 			echo '
 	<strong>', $is_select ? '<a href="' . $scripturl . '?action=viewquery;qq=' . ($q + 1) . '#qq' . $q . '" target="_blank" class="new_win" style="text-decoration: none;">' : '', nl2br(str_replace("\t", '&nbsp;&nbsp;&nbsp;', $smcFunc['htmlspecialchars'](ltrim($qq['q'], "\n\r")))) . ($is_select ? '</a></strong>' : '</strong>') . '<br>
 	&nbsp;&nbsp;&nbsp;';
-			if (!empty($qq['f']) && !empty($qq['l']))
-				echo sprintf($txt['debug_query_in_line'], $qq['f'], $qq['l']);
+			if (!empty($qq['f']) && !empty($qq['l'])) {
+							echo sprintf($txt['debug_query_in_line'], $qq['f'], $qq['l']);
+			}
 
-			if (isset($qq['s'], $qq['t']) && isset($txt['debug_query_which_took_at']))
-				echo sprintf($txt['debug_query_which_took_at'], round($qq['t'], 8), round($qq['s'], 8)) . '<br>';
-			elseif (isset($qq['t']))
-				echo sprintf($txt['debug_query_which_took'], round($qq['t'], 8)) . '<br>';
+			if (isset($qq['s'], $qq['t']) && isset($txt['debug_query_which_took_at'])) {
+							echo sprintf($txt['debug_query_which_took_at'], round($qq['t'], 8), round($qq['s'], 8)) . '<br>';
+			} elseif (isset($qq['t'])) {
+							echo sprintf($txt['debug_query_which_took'], round($qq['t'], 8)) . '<br>';
+			}
 			echo '
 	<br>';
 		}
@@ -362,12 +387,14 @@ 
 	global $modSettings, $smcFunc;
 	static $cache_stats = array();
 
-	if (empty($modSettings['trackStats']))
-		return false;
-	if (!empty($stats))
-		return $cache_stats = array_merge($cache_stats, $stats);
-	elseif (empty($cache_stats))
-		return false;
+	if (empty($modSettings['trackStats'])) {
+			return false;
+	}
+	if (!empty($stats)) {
+			return $cache_stats = array_merge($cache_stats, $stats);
+	} elseif (empty($cache_stats)) {
+			return false;
+	}
 
 	$setStringUpdate = '';
 	$insert_keys = array();
@@ -380,10 +407,11 @@ 
 		$setStringUpdate .= '
 			' . $field . ' = ' . ($change === '+' ? $field . ' + 1' : '{int:' . $field . '}') . ',';
 
-		if ($change === '+')
-			$cache_stats[$field] = 1;
-		else
-			$update_parameters[$field] = $change;
+		if ($change === '+') {
+					$cache_stats[$field] = 1;
+		} else {
+					$update_parameters[$field] = $change;
+		}
 		$insert_keys[$field] = 'int';
 	}
 
@@ -447,43 +475,50 @@ 
 	);
 
 	// Make sure this particular log is enabled first...
-	if (empty($modSettings['modlog_enabled']))
-		unset ($log_types['moderate']);
-	if (empty($modSettings['userlog_enabled']))
-		unset ($log_types['user']);
-	if (empty($modSettings['adminlog_enabled']))
-		unset ($log_types['admin']);
+	if (empty($modSettings['modlog_enabled'])) {
+			unset ($log_types['moderate']);
+	}
+	if (empty($modSettings['userlog_enabled'])) {
+			unset ($log_types['user']);
+	}
+	if (empty($modSettings['adminlog_enabled'])) {
+			unset ($log_types['admin']);
+	}
 
 	call_integration_hook('integrate_log_types', array(&$log_types));
 
 	foreach ($logs as $log)
 	{
-		if (!isset($log_types[$log['log_type']]))
-			return false;
+		if (!isset($log_types[$log['log_type']])) {
+					return false;
+		}
 
-		if (!is_array($log['extra']))
-			trigger_error('logActions(): data is not an array with action \'' . $log['action'] . '\'', E_USER_NOTICE);
+		if (!is_array($log['extra'])) {
+					trigger_error('logActions(): data is not an array with action \'' . $log['action'] . '\'', E_USER_NOTICE);
+		}
 
 		// Pull out the parts we want to store separately, but also make sure that the data is proper
 		if (isset($log['extra']['topic']))
 		{
-			if (!is_numeric($log['extra']['topic']))
-				trigger_error('logActions(): data\'s topic is not a number', E_USER_NOTICE);
+			if (!is_numeric($log['extra']['topic'])) {
+							trigger_error('logActions(): data\'s topic is not a number', E_USER_NOTICE);
+			}
 			$topic_id = empty($log['extra']['topic']) ? 0 : (int) $log['extra']['topic'];
 			unset($log['extra']['topic']);
+		} else {
+					$topic_id = 0;
 		}
-		else
-			$topic_id = 0;
 
 		if (isset($log['extra']['message']))
 		{
-			if (!is_numeric($log['extra']['message']))
-				trigger_error('logActions(): data\'s message is not a number', E_USER_NOTICE);
+			if (!is_numeric($log['extra']['message'])) {
+							trigger_error('logActions(): data\'s message is not a number', E_USER_NOTICE);
+			}
 			$msg_id = empty($log['extra']['message']) ? 0 : (int) $log['extra']['message'];
 			unset($log['extra']['message']);
+		} else {
+					$msg_id = 0;
 		}
-		else
-			$msg_id = 0;
 
 		// @todo cache this?
 		// Is there an associated report on this?
@@ -510,23 +545,26 @@ 
 			$smcFunc['db_free_result']($request);
 		}
 
-		if (isset($log['extra']['member']) && !is_numeric($log['extra']['member']))
-			trigger_error('logActions(): data\'s member is not a number', E_USER_NOTICE);
+		if (isset($log['extra']['member']) && !is_numeric($log['extra']['member'])) {
+					trigger_error('logActions(): data\'s member is not a number', E_USER_NOTICE);
+		}
 
 		if (isset($log['extra']['board']))
 		{
-			if (!is_numeric($log['extra']['board']))
-				trigger_error('logActions(): data\'s board is not a number', E_USER_NOTICE);
+			if (!is_numeric($log['extra']['board'])) {
+							trigger_error('logActions(): data\'s board is not a number', E_USER_NOTICE);
+			}
 			$board_id = empty($log['extra']['board']) ? 0 : (int) $log['extra']['board'];
 			unset($log['extra']['board']);
+		} else {
+					$board_id = 0;
 		}
-		else
-			$board_id = 0;
 
 		if (isset($log['extra']['board_to']))
 		{
-			if (!is_numeric($log['extra']['board_to']))
-				trigger_error('logActions(): data\'s board_to is not a number', E_USER_NOTICE);
+			if (!is_numeric($log['extra']['board_to'])) {
+							trigger_error('logActions(): data\'s board_to is not a number', E_USER_NOTICE);
+			}
 			if (empty($board_id))
 			{
 				$board_id = empty($log['extra']['board_to']) ? 0 : (int) $log['extra']['board_to'];
@@ -534,10 +572,11 @@ 
 			}
 		}
 
-		if (isset($log['extra']['member_affected']))
-			$memID = $log['extra']['member_affected'];
-		else
-			$memID = $user_info['id'];
+		if (isset($log['extra']['member_affected'])) {
+					$memID = $log['extra']['member_affected'];
+		} else {
+					$memID = $user_info['id'];
+		}
 
 		$inserts[] = array(
 			time(), $log_types[$log['log_type']], $memID, $user_info['ip'], $log['action'],