check.php

<?php
/*
 +-------------------------------------------------------------------------+
 | Copyright (C) 2022-2024 The Cacti Group, Inc.                           |
 |                                                                         |
 | Based on the Original Plugin developed by Howard Jones                  |
 |                                                                         |
 | Copyright (C) 2005-2022 Howard Jones and contributors                   |
 |                                                                         |
 | Permission is hereby granted, free of charge, to any person obtaining   |
 | a copy of this software and associated documentation files              |
 | (the "Software"), to deal in the Software without restriction,          |
 | including without limitation the rights to use, copy, modify, merge,    |
 | publish, distribute, sublicense, and/or sell copies of the Software,    |
 | and to permit persons to whom the Software is furnished to do so,       |
 | subject to the following conditions:                                    |
 |                                                                         |
 | The above copyright notice and this permission notice shall be          |
 | included in all copies or substantial portions of the Software.         |
 |                                                                         |
 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,         |
 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES         |
 | OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND                |
 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS     |
 | BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN      |
 | ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN       |
 | CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE        |
 | SOFTWARE.                                                               |
 +-------------------------------------------------------------------------+
 | Cacti: The Complete RRDtool-based Graphing Solution                     |
 +-------------------------------------------------------------------------+
 | Extensions to Howard Jones' original work are designed, written, and    |
 | maintained by the Cacti Group.                                          |
 |                                                                         |
 | Howard Jones was the original author of Weathermap.  You can reach      |
 | him at: howie@thingy.com                                                |
 +-------------------------------------------------------------------------+
 | http://www.network-weathermap.com/                                      |
 | http://www.cacti.net/                                                   |
 +-------------------------------------------------------------------------+
*/

// get some basics...
$php_version = phpversion();
$mem_allowed = ini_get('memory_limit');
$php_os      = php_uname();

$mem_warning = '(Ok)';
$mem_allowed_int = return_bytes($mem_allowed);

if (($mem_allowed_int > 0) && ($mem_allowed_int < 500000000)) {
	$mem_warning = '(You should increase this value to at least 500M)';
}

// capture the PHP 'General Info' table
ob_start();
phpinfo(INFO_GENERAL);
$s = ob_get_contents();
ob_end_clean();

// <tr><td class='e'>System </td><td class='v'>Windows NT BLINKYZERO 6.0 build 6000 </td></tr>
// since preg_* are potentially missing, we'll have to do this without regexps.
foreach (explode("\n",$s) as $line) {
	$line = str_replace('<tr><td class="e">', '', $line);
	$line = str_replace('</td></tr>','',$line);
	$line = str_replace('</td><td class="v">', ' => ', $line);

	$sep_pos = strpos($line, ' => ');

	if ($sep_pos !== false) {
		// by here, it should be a straight 'name => value'
		$name  = substr($line,0,$sep_pos);
		$value = substr($line,$sep_pos+4);

		$php_general[$name] = $value;
	}
}

$ini_file  = $php_general['Loaded Configuration File'];
$extra_ini = php_ini_scanned_files();

if ($extra_ini != '') {
	$extra_ini = PHP_EOL . 'The following additional ini files were read:' . PHP_EOL . PHP_EOL . $extra_ini;
} else {
	$extra_ini = PHP_EOL . 'There were no additional ini files, according to PHP.';
}

$gdversion = '';
$gdbuiltin = false;
$gdstring  = '';

if (function_exists('gd_info')) {
	$gdinfo    = gd_info();
	$gdversion = $gdinfo['GD Version'];

	if (strpos($gdversion, 'bundled') !== false) {
		$gdbuiltin = true;
		$gdstring  = 'This PHP uses the \'bundled\' GD library, which doesn\'t have alpha-blending bugs. That\'s good!' . PHP_EOL;
	} else {
		$gdstring  = 'This PHP uses the system GD library, which MIGHT have alpha-blending bugs. Check that you have at least GD 2.0.34 installed, if you see problems with weathermap segfaulting.' . PHP_EOL . PHP_EOL;
		$gdstring .= 'You can test for this specific fault by running check-gdbug.php' . PHP_EOL;
	}
} else {
	$gdstring = 'The gdinfo() function is not available, which means that either the GD extension is not available, not enabled, or not installed.' . PHP_EOL;
}

if (isset($argv)) {
	$environment = 'CLI';

	print PHP_EOL;

	print '----------------------------------------------------' . PHP_EOL;
	print 'Weathermap Pre-Install Checker' . PHP_EOL . PHP_EOL;

	print 'This script checks for some common problems with your PHP and server' . PHP_EOL;
	print 'environment that may stop Weathermap or the Editor from working.' . PHP_EOL . PHP_EOL;

	print 'NOTE: You should run this script as both a web page AND from the' . PHP_EOL;
	print 'command-line, as the environment can be different in each.' . PHP_EOL . PHP_EOL;

	print 'This is the PHP version that is responsible for:' . PHP_EOL . PHP_EOL;

	print ' * creating maps from the Cacti poller' . PHP_EOL;
	print ' * the command-line weathermap tool' . PHP_EOL . PHP_EOL;

	print 'PHP Basics' . PHP_EOL;
	print '----------' . PHP_EOL;

	print "PHP Version:  $php_version" . PHP_EOL;
	print "Server OS:    $php_os" . PHP_EOL;
	print "memory_limit: $mem_allowed $mem_warning" . PHP_EOL . PHP_EOL;

	print "The php.ini file was $ini_file" . PHP_EOL;
	print $extra_ini . PHP_EOL . PHP_EOL;

	print 'PHP Functions' . PHP_EOL;
	print '-------------' . PHP_EOL;

	print 'Some parts of Weathermap need special support in your PHP' . PHP_EOL;
	print 'installation to work.' . PHP_EOL . PHP_EOL;

	print wordwrap($gdstring) . PHP_EOL;
} else {
	$environment = 'web';
?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
    <title>Weathermap Pre-Install Checker</title>
    <style type='text/css'>
    body { font-family: 'Lucida Grande',Arial,sans-serif; font-size: 10pt; }
    p {margin-bottom: 10px; margin-top: 10px;}
    table { margin: 20px;}
    .critical { width: 400px; padding: 10px; background: #fee; border: 1px solid #f88; padding-left: 20px; background: left no-repeat url(images/icons/exclamation.png); }
    .noncritical { width: 400px; padding: 10px; background: #ffe; border: 1px solid #fb8; }
    .ok { width: 400px; padding: 10px; background: #efe; border: 1px solid #8f8; }
    </style>
</head>
<body>
    <h1>Weathermap Pre-install Checker</h1>

    <p>This page checks for some common problems with your PHP and server environment that may stop Weathermap or the Editor from working.</p>
	<p>NOTE: You should run this script as a web page AND from the command-line, as the environment can be different in each.</p>

	<h2>PHP Basics</h2>

	<p>This is the PHP version that is responsible for</p>
	<ul>
		<li>The web-based editor</li>
		<li>Building maps with Rebuild Now from Cacti</li>
	</ul>

	<p>This is PHP Version <?php print $php_version ?> running on "<?php print $php_os ?>" with a memory_limit of '<?php print $mem_allowed ?>'. <?php print $mem_warning ?></p>
	<p>The php.ini file was <?php print $ini_file ?></p>
	<p><?php print $extra_ini ?></p>

	<h2>PHP Functions</h2>

    <p>Some parts of Weathermap need special support in your PHP installation to work.</p>
    <?php print $gdstring; ?>
	<table>
<?php
}

$critical=0;
$noncritical=0;

# critical, what-it-affects, what-it-is
$functions = array(
	'imagepng' => array(
		true,
		false,
		'all of Weathermap',
		'part of the GD library and the "gd" PHP extension'
	),
	'imagecreatetruecolor' => array(
		true,
		false,
		'all of Weathermap',
		'part of the GD library and the "gd" PHP extension'
	),
	'imagealphablending' => array(
		true,
		false,
		'all of Weathermap',
		'part of the GD library and the "gd" PHP extension'
	),
	'imageSaveAlpha' => array(
		true,
		false,
		'all of Weathermap',
		'part of the GD library and the "gd" PHP extension'
	),
	'preg_match' => array(
		true,
		false,
		'configuration reading',
		'provided by the "pcre" extension'
	),
	'imagecreatefrompng' => array(
		true,
		false,
		'all of Weathermap',
		'part of the GD library and the "gd" PHP extension'
	),
	'imagecreatefromjpeg' => array(
		false,
		false,
		'JPEG input support for ICON and BACKGROUND',
		'an optional part of the GD library and the "gd" PHP extension'
	),
	'imagecreatefromgif' => array(
		false,
		false,
		'GIF input support for ICON and BACKGROUND',
		'an optional part of the GD library and the "gd" PHP extension'
	),
	'imagejpeg' => array(
		false,
		false,
		'JPEG output support',
		'an optional part of the GD library and the "gd" PHP extension'
	),
	'imagegif' => array(
		false,
		false,
		'GIF output support',
		'an optional part of the GD library and the "gd" PHP extension'
	),
	/*
	'imagefilter' => array(
		false,
		false,
		'colorizing icons',
		'a special function of the PHP-supplied GD library ONLY (not the external GD library' . ($gdbuiltin ? '':' that you are using').')'
	), */
	'imagecopyresampled' => array(
		false,
		false,
		'Thumbnail creation in the Cacti plugin',
		'an optional part of the GD library and the "gd" PHP extension'
	),
	'imagettfbbox' => array(
		false,
		false,
		'TrueType font support',
		'an optional part of the GD library and the "gd" PHP extension'
	),
	'memory_get_usage' => array(
		false, true,
		'memory-usage debugging',
		'not supported on all PHP versions and platforms'
	)
);

$results = array();

foreach ($functions as $function=>$details) {
	$exists = '';
	$notes  = '';

	if ($environment == 'web') {
		print "<tr><td align=right>$function()</td>";
	}

	if (function_exists($function)) {
		$exists = 'YES';

		if ($environment == 'web') {
			print '<td><img alt="YES" src="images/icons/tick.png" /></td>';
		}
	} else {
		$exists = 'NO';

		if ($details[0]) {
			$notes .= 'CRITICAL.   ';

			if ($environment == 'web') {
				print '<td><img alt="NO" src="images/icons/exclamation.png" /><b>CRITICAL</b> ';
			}

			$critical++;
		} else {
			if (!$details[1]) {
				$notes .= 'Non-Critical.   ';

				if ($environment == 'web') {
					print '<td><img  alt="NO" src="images/icons/cross.png" /><i>non-critical</i>  ';
				}

				$noncritical++;
			} else {
				$notes .= 'Minor.   ';

				if ($environment == 'web') {
					print '<td><img alt="NO" src="images/icons/cross.png" /><i>minor</i>  ';
				}
			}
		}

		$explanation = 'This is required for ' . $details[2] . '. It is ' . $details[3] . '.';
		$notes .= $explanation;

		if ($environment == 'web') {
			print "$explanation</td>";
		}
	}

	if ($environment == 'web') {
		print '</tr>';
	} else {
		$wnotes = wordwrap($notes, 50);
		$lines  = explode("\n", $wnotes);

		$i = 0;

		foreach ($lines as $noteline) {
			if ($i == 0) {
				print sprintf('%20s %5s %-52s' . PHP_EOL, $function, $exists, $noteline);

				$i++;
			} else {
				print sprintf('%20s %5s %-52s' . PHP_EOL, '', '', $noteline);

				$i++;
			}
		}
	}
}

if ($environment == 'web') {
	print '</table>';
}

if (($critical + $noncritical) > 0) {
	if ($environment == 'web') {
		print "<p>If these functions are not found, you may need to <ul><li>check that the 'extension=' line for that extension is uncommented in your php.ini file (then restart your webserver), or<li>install the extension, if it isn't installed already</ul>On Debian/Ubuntu systems, you may also need to use the php5enmod command to enable the extension.</p>";
	} else {
		print PHP_EOL;
		print 'If these functions are not found, you may need to:' . PHP_EOL . PHP_EOL;
		print ' * check that the \'extension=\' line for that extension is uncommented in' . PHP_EOL;
		print '   your php.ini file (then restart your webserver), or' . PHP_EOL;
		print ' * install the extension, if it isn\'t installed already' . PHP_EOL . PHP_EOL;
	}

	print wordwrap('The details of how this is done will depend on your operating system, and on where you installed (or compiled) your PHP from originally. Usually, you would install an RPM, or other package on Linux systems, a port on *BSD, or a DLL on Windows. If you build PHP from source, you need to add extra options to the \'./configure\' line. Consult your PHP documentation for more information.' . PHP_EOL);

	if ($environment == 'web') {
		print '</p>';
	}
}

if ($environment == 'CLI') {
	print PHP_EOL;
	print '---------------------------------------------------------------------' . PHP_EOL;
}

if ($critical > 0) {
	if ($environment == 'web') {
		print '<div class="critical">';
	}

	print wordwrap('There are problems with your PHP or server environment that will stop Weathermap from working. You need to correct these issues if you wish to use Weathermap.' . PHP_EOL);

	if ($environment == 'web') {
		print '</div>';
	}
} elseif ($noncritical > 0) {
	if ($environment == 'web') {
		print '<div class="noncritical">';
	}

	print wordwrap('Some features of Weathermap will not be available to you, due to lack of support in your PHP installation. You can still proceed with Weathermap though.' . PHP_EOL);

	if ($environment == 'web') {
		print '</div>';
	}
} else {
	if ($environment == 'web') {
		print '<div class="ok">';
	}

	print wordwrap('OK! Your PHP and server environment *seems* to have support for ALL of the Weathermap features. Make sure you have run this script BOTH as a web page and from the CLI to be sure, however.' . PHP_EOL);

	if ($environment == 'web') {
		print '</div>';
	}
}

if ($environment == 'web') {
	print '</body></html>';
}

function return_bytes($val) {
	$val = trim($val);

	if ($val != '') {
		$last = strtolower($val[strlen($val)-1]);

		switch($last) {
			// The 'G' modifier is available since PHP 5.1.0
			case 'g':
			$val *= 1024;
			case 'm':
			$val *= 1024;
			case 'k':
			$val *= 1024;
		}
	} else {
		$val = 0;
	}

	return $val;
}

if ($environment == 'web') {
	print '</table></body></html>';
}