Elgg / Elgg

mod/diagnostics/start.php

<?php
/**
 * Elgg diagnostics
 *
 * @package ElggDiagnostics
 */

/**
 * Initialise the diagnostics tool
 *
 * @return void
 */
function diagnostics_init() {
	elgg_register_menu_item('page', [
		'name' => 'diagnostics',
		'text' => elgg_echo('admin:diagnostics'),
		'href' => 'admin/diagnostics',
		'section' => 'information',
		'context' => 'admin',
	]);
}

/**
 * Generate a basic report
 *
 * @param string $hook        'diagnostics:report'
 * @param string $type        'system'
 * @param string $returnvalue current return value
 * @param mixed  $params      supplied params
 *
 * @return string
 */
function diagnostics_basic_hook($hook, $type, $returnvalue, $params) {

	// Get version information
	$version = elgg_get_version();
	$release = elgg_get_version(true);

	$returnvalue .= elgg_echo('diagnostics:report:basic', [$release, $version]);

	return $returnvalue;
}

/**
 * Recursively list through a directory tree producing a hash of all installed files
 *
 * @param string $dir starting dir
 *
 * @return string
 */
function diagnostics_md5_dir($dir) {
	$extensions_allowed = ['.php', '.js', '.css'];

	$buffer = "";

	if (in_array(strrchr(trim($dir, "/"), '.'), $extensions_allowed)) {
		$dir = rtrim($dir, "/");
		$buffer .= md5_file($dir). "  " . $dir . "\n";
	} else if (is_dir($dir)) {
		$handle = opendir($dir);
		while ($file = readdir($handle)) {

It seems like $handle can also be of type false; however, parameter $dir_handle of readdir() does only seem to accept resource, maybe add an additional type check?

			if (($file != '.') && ($file != '..')) {
				$buffer .= diagnostics_md5_dir($dir . $file. "/");
			}
		}

		closedir($handle);

It seems like $handle can also be of type false; however, parameter $dir_handle of closedir() does only seem to accept resource, maybe add an additional type check?

	}

	return $buffer;
}

/**
 * Get some information about the files installed on a system
 *
 * @param string $hook        'diagnostics:report'
 * @param string $type        'system'
 * @param string $returnvalue current return value
 * @param mixed  $params      supplied params
 *
 * @return string
 */
function diagnostics_sigs_hook($hook, $type, $returnvalue, $params) {

	$base_dir = elgg_get_root_path();
	$returnvalue .= elgg_echo('diagnostics:report:md5', [diagnostics_md5_dir($base_dir)]);

	return $returnvalue;
}

/**
 * Get some information about the php install
 *
 * @param string $hook        'diagnostics:report'
 * @param string $type        'system'
 * @param string $returnvalue current return value
 * @param mixed  $params      supplied params
 *
 * @return string
 */
function diagnostics_phpinfo_hook($hook, $type, $returnvalue, $params) {

	ob_start();
	phpinfo();
	$phpinfo = ['phpinfo' => []];

	if (preg_match_all('#(?:<h2>(?:<a name=".*?">)?(.*?)(?:</a>)?</h2>)|(?:<tr(?: class=".*?")?><t[hd](?: class=".*?")?>(.*?)\s*</t[hd]>(?:<t[hd](?: class=".*?")?>(.*?)\s*</t[hd]>(?:<t[hd](?: class=".*?")?>(.*?)\s*</t[hd]>)?)?</tr>)#s', ob_get_clean(), $matches, PREG_SET_ORDER)) {
		foreach ($matches as $match) {
			if (strlen($match[1])) {
				$phpinfo[$match[1]] = [];
			} else if (isset($match[3])) {
				$phpinfo[end(array_keys($phpinfo))][$match[2]] = isset($match[4]) ? [$match[3], $match[4]] : $match[3];
			} else {
				$phpinfo[end(array_keys($phpinfo))][] = $match[2];
			}
		}
	}

	$returnvalue .= elgg_echo('diagnostics:report:php', [print_r($phpinfo, true)]);

	return $returnvalue;
}

/**
 * Get global variables
 *
 * @param string $hook        'diagnostics:report'
 * @param string $type        'system'
 * @param string $returnvalue current return value
 * @param mixed  $params      supplied params
 *
 * @return string
 */
function diagnostics_globals_hook($hook, $type, $returnvalue, $params) {

	$output = str_replace(elgg_get_config('dbpass'), '<<DBPASS>>', print_r($GLOBALS, true));
	$returnvalue .= elgg_echo('diagnostics:report:globals', [$output]);

	return $returnvalue;
}

return function() {
	elgg_register_event_handler('init', 'system', 'diagnostics_init');

	elgg_register_plugin_hook_handler('diagnostics:report', 'system', 'diagnostics_basic_hook', 0); // show basics first
	elgg_register_plugin_hook_handler('diagnostics:report', 'system', 'diagnostics_sigs_hook', 1); // Now the signatures

	elgg_register_plugin_hook_handler('diagnostics:report', 'system', 'diagnostics_globals_hook'); // Global variables
	elgg_register_plugin_hook_handler('diagnostics:report', 'system', 'diagnostics_phpinfo_hook'); // PHP info
};