index.php

<?php
error_reporting(E_ALL | E_STRICT);

/**
 * Checks that the server environment is up to scratch for running
 * SilverStripe CMS / Framework (http://silverstripe.org).
 * 
 * Refer to README.md file for more information.
 * 
 * @package ssreqcheck
 * @author Sean Harvey <sean at silverstripe dot com>
 */
class RequirementsChecker {

	/**
	 * Check that a php.ini option is set set to "Off".
	 * ini_get() returns "Off" settings as an empty string.
	 * 
	 * @param string $name Name of configuration setting
	 * @return boolean TRUE passed assertion | FALSE failed assertion
	 */
	public function assertPhpIniOptionOff($option) {
		return !ini_get($option);
	}

	/**
	 * Check that the current PHP version is of at least the version specified.
	 * 
	 * @param mixed $version Minimum version of PHP to assert
	 * @return boolean TRUE passed assertion | FALSE failed assertion
	 */
	public function assertMinimumPhpVersion($version) {
		return version_compare($version, PHP_VERSION, '<=');
	}

	/**
	 * Check that a PHP extension has been loaded.
	 * 
	 * @param string $name Name of extension, e.g. "gd"
	 * @return boolean TRUE passed assertion | FALSE failed assertion
	 */
	public function assertPhpExtensionLoaded($name) {
		return extension_loaded($name);
	}

	/**
	 * Check that a PHP class exists.
	 * 
	 * @param string $name Name of class, e.g. "DOMDocument"
	 * @return boolean TRUE passed assertion | FALSE failed assertion
	 */
	public function assertPhpClassExists($name) {
		return class_exists($name);
	}
	
	/**
	 * Try to find the version of the given PHP extension.
	 * 
	 * phpversion() doesn't always return extension versions, so specific
	 * checks need to be done for extensions like GD.
	 * 
	 * @param string $name Name of extension, e.g. "gd"
	 * @return string String of version
	 */
	public function getPhpExtensionVersion($name) {
		$version = phpversion($name);
		if(!$version && $name == 'gd') {
			$info = function_exists('gd_info') ? gd_info() : array();
			$version = isset($info['GD Version']) ? $info['GD Version'] : '';
		}
		return preg_replace('%[^0-9\.]%', '', $version);
	}

	/**
	 * Check a loaded PHP extension is of at least the version specified.
	 * @param string $name Name of extension to check, e.g. "gd"
	 * @param mixed $version Minimum version of extension to assert
	 * @return boolean TRUE passed assertion | FALSE failed assertion
	 */
	public function assertMinimumPhpExtensionVersion($name, $version) {
		return version_compare($version, $this->getPhpExtensionVersion($name), '<=');
	}

	/**
	 * Convert given memory limit into bytes.
	 * 
	 * @param string $mem Existing memory limit e.g. "64M" to convert to bytes
	 * @return int Memory limit in bytes
	 */
	public function convertPhpMemoryBytes($mem) {
		switch(strtolower(substr($mem, -1))) {
			case 'k':
				return round(substr($mem, 0, -1) * 1024);
				break;
			case 'm':
				return round(substr($mem, 0, -1) * 1024 * 1024);
				break;
			case 'g':
				return round(substr($mem, 0, -1) * 1024 * 1024 * 1024);
				break;
			default:
				return round($mem);
		}
	}

	/**
	 * Convert bytes to a string so it can be used in ini_set()
	 * @param int|string $bytes Bytes to convert
	 * @return string
	 */
	public function convertBytesToString($bytes) {
		return (($bytes / 1024) / 1024) . 'M';
	}

	/**
	 * Check that PHP is currently given a memory limit of at least the specified amount.
	 * @param string $minimum Minimum limit to check, e.g. "64M"
	 * @return boolean TRUE passed assertion | FALSE failed assertion
	 */
	public function assertMinimumPhpMemory($minimum) {
		return $this->convertPhpMemoryBytes(ini_get('memory_limit')) >= $this->convertPhpMemoryBytes($minimum);
	}

	/**
	 * Check that ini_set() can be used to set a higher memory limit than the original limit.
	 * @param string $increase Increase amount, can be either "64M" string or bytes integer
	 * @return boolean TRUE passed assertion | FALSE failed assertion
	 */
	public function assertIncreasePhpMemory($increase) {
		$original = $this->convertPhpMemoryBytes(ini_get('memory_limit'));
		if(is_string($increase)) $increase = $this->convertPhpMemoryBytes($increase);
		ini_set('memory_limit', $this->convertBytesToString($original + $increase));
		$new = $this->convertPhpMemoryBytes(ini_get('memory_limit'));
		ini_set('memory_limit', $this->convertBytesToString($original));
		return $new == $original + $increase;
	}

	/**
	 * Check that set_include_path() can be used to set additional include paths.
	 * @param string $paths Additional paths to set
	 * @return boolean TRUE passed assertion | FALSE failed assertion
	 */
	public function assertSetAdditionalIncludePaths($paths) {
		$original = get_include_path();
		set_include_path($paths . PATH_SEPARATOR . get_include_path());
		$new = get_include_path();
		set_include_path($original);
		return $new == $paths . PATH_SEPARATOR . $original;
	}

	/**
	 * Check that the date.timezone PHP configuration option has been set
	 * to a valid timezone identifier.
	 * 
	 * @return boolean TRUE passed assertion | FALSE failed assertion
	 */
	public function assertPhpDateTimezoneSetAndValid() {
		return ini_get('date.timezone') && in_array(ini_get('date.timezone'), timezone_identifiers_list());
	}

	/**
	 * Return a PHP opcache extension that may be loaded.
	 * @return string Name of opcode cacher and version number (if available)
	 */
	public function getPhpOpcodeCacher() {
		if ($this->assertPhpExtensionLoaded('Zend OPcache') && ini_get('opcache.enable')) {
			return trim('Zend OPcache ' . $this->getPhpExtensionVersion('Zend OPcache'));
		} elseif($this->assertPhpExtensionLoaded('xcache') && ini_get('xcache.cacher')) {
			return trim('XCache ' . $this->getPhpExtensionVersion('xcache'));
		} elseif($this->assertPhpExtensionLoaded('wincache') && ini_get('wincache.ocenabled')) {
			return trim('WinCache ' . $this->getPhpExtensionVersion('wincache'));
		} elseif($this->assertPhpExtensionLoaded('eaccelerator') && ini_get('eaccelerator.enable')) {
			return trim('eAccelerator ' . $this->getPhpExtensionVersion('eaccelerator'));
		} elseif($this->assertPhpExtensionLoaded('apc') && ini_get('apc.enabled')) {
			return trim('APC ' . $this->getPhpExtensionVersion('apc'));
		}

		return false;
	}

	/**
	 * Check that a PHP opcode cacher is installed, and enabled.
	 * @return boolean TRUE passed assertion | FALSE failed assertion
	 */
	public function assertPhpOpcodeCacherEnabled() {
		return (bool) $this->getPhpOpcodeCacher();
	}

	/**
	 * Return the default temp path PHP uses to store temporary files.
	 * @return string Path of temp path | FALSE cannot find path
	 */
	public function getDefaultPhpTempPath() {
		return sys_get_temp_dir();
	}

	/**
	 * Check there is a default PHP temp path available.
	 * @return boolean TRUE passed assertion | FALSE failed assertion
	 */
	public function assertDefaultPhpTempPath() {
		return (bool) $this->getDefaultPhpTempPath();
	}

	/**
	 * Check that a new directory can be created at the default PHP temp path.
	 * @return boolean TRUE passed assertion | FALSE failed assertion
	 */
	public function assertDefaultPhpTempPathWritable() {
		$result = false;
		$path = $this->getDefaultPhpTempPath() . DIRECTORY_SEPARATOR . 'ssreqcheck-test';
		$result = @mkdir($path);
		if($result) rmdir($path);
		return $result;
	}

	/**
	 * Get the URL used for testing webserver URL rewriting
	 * @return string
	 */
	public function getWebserverUrlRewritingURL() {
		return sprintf(
			'http://%s/%s/rewritetest/test-url?testquery=testvalue',
			$_SERVER['HTTP_HOST'],
			trim(dirname($_SERVER['SCRIPT_NAME']), '/')
		);
	}

	/**
	 * Return the response of a test URL rewrite setup.
	 * This will only work for Apache (.htaccess) and IIS 7.x (web.config).
	 * This uses fsockopen() in the event that file_get_contents() has been disabled.
	 * 
	 * Does not work when PHP is running in CLI.
	 * 
	 * @return string Response text from request
	 */
	public function getWebserverUrlRewritingResponse() {
		$response = @file_get_contents($this->getWebserverUrlRewritingURL());

		if(!$response) {
			$response = '';
			$url = parse_url($this->getWebserverUrlRewritingURL());
			$fp = fsockopen($url['host'], $_SERVER['SERVER_PORT'], $errno, $errstr);
			if(!$fp) {
				return sprintf("ERROR: %s (%s)", $errstr, $errno);
			} else {
				$out = sprintf('GET %s?%s HTTP/1.1', $url['path'], $url['query']) . PHP_EOL;
				$out .= sprintf('Host: %s:%d', $url['host'], $_SERVER['SERVER_PORT']) . PHP_EOL;
				$out .= 'Connection: Close' . PHP_EOL . PHP_EOL;
				fwrite($fp, $out);
				while(!feof($fp)) {
					$response .= fgets($fp, 8192);
				}
				fclose($fp);
			}
		}

		return $response;
	}

	/**
	 * Determine if URL rewriting support is working on the webserver.
	 * 
	 * Rather than doing specific checks for Apache or IIS, this method will
	 * check the response of a specific test URL in order to make a determination
	 * of URL rewriting is working or not.
	 * 
	 * @return boolean TRUE passed assertion | FALSE failed assertion | NULL skipped assertion
	 */
	public function assertWebserverUrlRewritingSupport() {
		if(!isset($_SERVER['HTTP_HOST'])) return null;

		$path = 'rewritetest/.htaccess';
		$fh = fopen($path, 'r');
		$contents = fread($fh, filesize($path));
		fclose($fh);

		// put a RewriteBase in .htaccess file temporarily for the test
		if(is_writable($path) && strpos($contents, 'RewriteBase') === false) {
			$newcontents = str_replace(
				'RewriteEngine On',
				'RewriteEngine On' . PHP_EOL . sprintf('RewriteBase %s', dirname($_SERVER['SCRIPT_NAME']) . '/rewritetest'), $contents
			);
			$fh = fopen($path, 'wb');
			fwrite($fh, $newcontents);
			fclose($fh);
		}

		$response = $this->getWebserverUrlRewritingResponse();

		// restore .htaccess back to the original
		if(is_writable($path)) {
			$fh = fopen($path, 'wb');
			fwrite($fh, $contents);
			fclose($fh);
		}

		return (bool) preg_match('/test.php queryval: testvalue/', $response);
	}

	/**
	 * Try to get system information using a command line utility.
	 * @return string System information summary
	 */
	public function getSystemInformation() {
		$value = '';
		if(preg_match('/WIN/', PHP_OS)) {
			@exec('systeminfo', $output, $return_var);
			if($return_var === 0) {
				foreach($output as $info) {
					if(preg_match('/OS/', $info)) {
						$value .= trim(substr($info, 25)) . ' ';
					}
				}
			}
			$value = trim($value);
		} else {
			// ASSUMPTION: UNIX based operating system with "uname" command
			exec('uname -a', $output, $return_var);
			if($return_var === 0) {
				$value = trim($output[0]);
			}
		}

		return $value ?: 'Unknown';
	}

}
/**
 * Simple abstraction class which formats text based on whether PHP is running
 * under the command line or from a web browser.
 * 
 * @package ssreqcheck
 * @author Sean Harvey <sean at silverstripe dot com>
 */
class RequirementsFormatter {

	/**
	 * Is PHP currently running as CLI?
	 * @return boolean TRUE yes | FALSE no
	 */
	public function isCli() {
		return php_sapi_name() == 'cli';
	}

	/**
	 * Return a message, along with system EOL character.
	 * If in CLI, strip all HTML tags that may be present in message.
	 * 
	 * @param string $message Message to show
	 * @return processed message to show
	 */
	public function show($message) {
		return ($this->isCli()) ? strip_tags($message) . PHP_EOL : $message . '<br>' . PHP_EOL;
	}

	/**
	 * Return a message from an assertion suitable for someone to read.
	 * 
	 * @param string $name Name of the assertion made, e.g. "PHP memory at least 64M"
	 * @param boolean $result boolean|null result of assertion, either TRUE passed or FALSE failed or NULL for skipped
	 * @param string $message Optional: Message to show when failure occurs
	 * @param boolean $fatal Optional: Show assertion failure as fatal. Set to false for warning
	 * @return string Assertion encoded in an HTML string (or without HTML if in CLI mode)
	 */
	public function showAssertion($assertion, $result, $message, $fatal = true) {
		$status = ($result === true) ? 'passed' : ($result === null ? 'skipped' : ($fatal ? 'failed' : 'warning'));
		if($result === null || $result === false) {
			$text = strtoupper($status) . ': ' . $message;
		} else {
			$text = strtoupper($status) . ': ' . $assertion;
		}

		return $this->show(sprintf('<span class="%s">', $status) . $text . '</span>');
	}

	/**
	 * Return a text shown as a header.
	 * 
	 * @param string $text Text to show for header
	 * @param int $level Level of header as an integer
	 * @return processed message to show
	 */
	public function heading($text, $level = 1) {
		if($this->isCli()) {
			return '** ' . $text . ' **' . PHP_EOL;
		} else {
			return sprintf('<h%d>', $level) . $text . sprintf('</h%d>', $level) . PHP_EOL;
		}
	}

	/**
	 * Show a newline character with a <br> HTML element.
	 * If in CLI, just show a newline character.
	 * 
	 * @return processed message to show
	 */
	public function nl() {
		return ($this->isCli()) ? PHP_EOL : '<br>' . PHP_EOL;
	}

}

$r = new RequirementsChecker();
$f = new RequirementsFormatter();

if(isset($_SERVER['HTTP_HOST'])) {
	echo '<html>' . PHP_EOL;
	echo '<head>' . PHP_EOL;
	echo '<title>SilverStripe Requirements</title>' . PHP_EOL;
	echo '<style type="text/css">' . PHP_EOL;
	echo '@import url("styles.css");' . PHP_EOL;
	echo '</style>' . PHP_EOL;
	echo '</head>' . PHP_EOL;
	echo '<body>' . PHP_EOL;
}

echo $f->heading('SilverStripe Requirements Checker', 1);

echo $f->heading('System information', 2);
echo $f->show(sprintf('System: %s', $r->getSystemInformation()));
echo $f->show(sprintf('Webserver Software: %s', isset($_SERVER['SERVER_SOFTWARE']) ? $_SERVER['SERVER_SOFTWARE'] : 'Unknown'));

// see if we can show who the process owner is (the web server user, mostly)
if(function_exists('posix_getpwuid')) {
	$processUser = posix_getpwuid(posix_geteuid());
	$processUserName = $processUser['name'];
} else {
	// on windows, get_current_user() returns the process user, not the owner of the script!
	$processUserName = get_current_user();
}

echo $f->show(sprintf('Current process user: %s', $processUserName));
echo $f->show(sprintf('SAPI: %s', php_sapi_name()));
echo $f->show(sprintf('PHP Version: %s', PHP_VERSION));
echo $f->show(sprintf('PHP configuration file path: %s', get_cfg_var('cfg_file_path')));
echo $f->nl();

echo $f->heading('Webserver configuration', 2);
echo $f->showAssertion(
	'URL rewrite support',
	$r->assertWebserverUrlRewritingSupport(),
	$f->isCli() ? 'URL rewrite support. Please run the checker from your browser' : sprintf('URL rewrite test failed. Please check <a href="%1$s">%1$s</a> in your browser directly.<br> Please also check <strong>%2$s</strong> user can write to <strong>rewritetest/.htaccess</strong> and try again.', $r->getWebserverUrlRewritingURL(), $processUserName),
	false
);
echo $f->nl();

echo $f->heading('PHP configuration', 2);
echo $f->showAssertion(
	sprintf('PHP version at least <strong>5.3.2</strong> (%s)', PHP_VERSION),
	$r->assertMinimumPhpVersion('5.3.2'),
	PHP_VERSION
);
echo $f->nl();

echo $f->showAssertion(
	sprintf('memory_limit option at least <strong>64M</strong> (%s)', ini_get('memory_limit')),
	$r->assertMinimumPhpMemory('64M'),
	sprintf('You only have %s memory. SilverStripe requires at least <strong>64M</strong>', ini_get('memory_limit')),
	false
);
if(!$r->assertMinimumPhpMemory('64M')) echo $f->showAssertion(
	'can increase memory_limit option by 64M using ini_set()',
	$r->assertIncreasePhpMemory('64M'),
	'Unable to increase memory by 64M. Please make sure you set at least <strong>64M</strong> for PHP memory_limit option',
	!$r->assertMinimumPhpMemory('64M')
);
echo $f->showAssertion(
	'can set additional include paths using set_include_path()',
	$r->assertSetAdditionalIncludePaths('/test/path'),
	'Additional paths cannot be set using set_include_path(). '
	. '<a href="http://silverstripe.org/installing-silverstripe/show/12361">More information in silverstripe.org/forums</a>'
);
echo $f->showAssertion(
	sprintf('date.timezone option set and valid (%s)', ini_get('date.timezone')),
	$r->assertPhpDateTimezoneSetAndValid(),
	sprintf('date.timezone option needs to be set to your server timezone. PHP guessed <strong>%s</strong>, but it\'s not safe to rely on the system timezone', @date_default_timezone_get())
);
echo $f->showAssertion(
	'asp_tags option set to <strong>Off</strong>',
	$r->assertPhpIniOptionOff('asp_tags'),
	'asp_tags option should be set to <strong>Off</strong>'
);
echo $f->showAssertion(
	'safe_mode option set to <strong>Off</strong>',
	$r->assertPhpIniOptionOff('safe_mode'),
	'safe_mode option is deprecated. Please set it to <strong>Off</strong>'
);
echo $f->showAssertion(
	'allow_call_time_pass_reference option set to <strong>Off</strong>',
	$r->assertPhpIniOptionOff('allow_call_time_pass_reference'),
	'allow_call_time_pass_reference option is deprecated. Please set it to <strong>Off</strong>',
	false
);
echo $f->showAssertion(
	'short_open_tag option option set to <strong>Off</strong>',
	$r->assertPhpIniOptionOff('short_open_tag'),
	'short_open_tag option should be set to <strong>Off</strong>',
	false
);
echo $f->showAssertion(
	'magic_quotes_gpc option set to <strong>Off</strong>',
	$r->assertPhpIniOptionOff('magic_quotes_gpc'),
	'magic_quotes_gpc option is deprecated. This can cause issues with cookies, <a href="http://silverstripe.org/blog-module-forum/show/15011">see here</a> for more information. Please set it to <strong>Off</strong>'
);
echo $f->showAssertion(
	'register_globals option set to <strong>Off</strong>',
	$r->assertPhpIniOptionOff('register_globals'),
	'register_globals option is deprecated. Please set it to <strong>Off</strong>'
);
echo $f->nl();

echo $f->showAssertion(
	'curl extension loaded',
	$r->assertPhpExtensionLoaded('curl'),
	'curl extension not loaded'
);
echo $f->showAssertion(
	'dom extension loaded',
	$r->assertPhpExtensionLoaded('dom'),
	'dom extension not loaded'
);
echo $f->showAssertion(
	'gd extension loaded',
	$r->assertPhpExtensionLoaded('gd'),
	'gd extension not loaded'
);
if($r->assertPhpExtensionLoaded('gd')) echo $f->showAssertion(
	sprintf('gd extension version at least <strong>2.0</strong> (%s)', $r->getPhpExtensionVersion('gd')),
	$r->assertMinimumPhpExtensionVersion('gd', '2.0'),
	'gd extension is too old. SilverStripe requires at least gd version 2.0'
);
echo $f->showAssertion(
	'hash extension loaded',
	$r->assertPhpExtensionLoaded('hash'),
	'hash extension not loaded'
);
echo $f->showAssertion(
	'iconv extension loaded',
	$r->assertPhpExtensionLoaded('iconv'),
	'iconv extension not loaded'
);
echo $f->showAssertion(
	'mbstring extension loaded',
	$r->assertPhpExtensionLoaded('mbstring'),
	'mbstring extension not loaded'
);
echo $f->showAssertion(
	'posix extension loaded',
	preg_match('/WIN/', PHP_OS) ? null : $r->assertPhpExtensionLoaded('posix'),
	'posix extension not loaded'
);
echo $f->showAssertion(
	'session extension loaded',
	$r->assertPhpExtensionLoaded('session'),
	'session extension not loaded'
);
echo $f->showAssertion(
	'tokenizer extension loaded',
	$r->assertPhpExtensionLoaded('tokenizer'),
	'tokenizer extension not loaded'
);
echo $f->showAssertion(
	'tidy extension loaded',
	$r->assertPhpExtensionLoaded('tidy'),
	'tidy extension not loaded',
	false
);
echo $f->showAssertion(
	'xml extension loaded',
	$r->assertPhpExtensionLoaded('xml'),
	'xml extension not loaded'
);
echo $f->nl();

echo $f->showAssertion(
	sprintf('opcode cacher extension installed (%s)', $r->getPhpOpcodeCacher()),
	$r->assertPhpOpcodeCacherEnabled(),
	'no opcode cacher extension is installed and enabled. It is highly recommended to install and enable either Zend OPcache, XCache, WinCache, APC, or eAccelerator',
	false
);
echo $f->nl();

echo $f->showAssertion(
	sprintf('default temp path is accessible by <strong>%s</strong> user (%s)', $processUserName, $r->getDefaultPhpTempPath()),
	$r->assertDefaultPhpTempPath(),
	sprintf('no default temp path found. Please create a <strong>silverstripe-cache</strong> directory where SilverStripe is located with </strong>%s</strong> user write permissions', $processUserName),
	false
);
if($r->getDefaultPhpTempPath()) echo $f->showAssertion(
	sprintf('default temp path is writable by <strong>%s</strong> user, new directories can be created (%s)', $processUserName, $r->getDefaultPhpTempPath()),
	$r->assertDefaultPhpTempPathWritable(),
	sprintf('default temp path is not writable by <strong>%1$s</strong> user, new directories cannot be created.<br> Please create a <strong>silverstripe-cache</strong> directory where SilverStripe is located with <strong>%1$s</strong> user write permissions', $processUserName),
	false
);

if(isset($_SERVER['HTTP_HOST'])) {
	echo '</body>' . PHP_EOL;
	echo '</html>';
}