123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257 |
- <?php
- /**
- * Elgg RewriteTester.
- * Test if URL rewriting is working.
- *
- * @package Elgg.Core
- * @subpackage Installer
- */
- class ElggRewriteTester {
- protected $webserver;
- protected $serverSupportsRemoteRead;
- protected $rewriteTestPassed;
- protected $htaccessIssue;
- /**
- * Set the webserver as unknown.
- */
- public function __construct() {
- $this->webserver = 'unknown';
- }
- /**
- * Run the rewrite test and return a status array
- *
- * @param string $url URL of rewrite test
- * @param string $path Root directory of Elgg with trailing slash
- *
- * @return array
- */
- public function run($url, $path) {
- $this->webserver = \ElggRewriteTester::guessWebServer();
- $this->rewriteTestPassed = $this->runRewriteTest($url);
- if ($this->rewriteTestPassed == FALSE) {
- if ($this->webserver == 'apache' || $this->webserver == 'unknown') {
- if ($this->createHtaccess($url, $path)) {
- $this->rewriteTestPassed = $this->runRewriteTest($url);
- }
- }
- }
- return $this->returnStatus($url);
- }
- /**
- * Guess the web server from $_SERVER['SERVER_SOFTWARE']
- *
- * @return string
- */
- public static function guessWebServer() {
- $serverString = strtolower($_SERVER['SERVER_SOFTWARE']);
- $possibleServers = array('apache', 'nginx', 'lighttpd', 'iis');
- foreach ($possibleServers as $server) {
- if (strpos($serverString, $server) !== FALSE) {
- return $server;
- }
- }
- return 'unknown';
- }
- /**
- * Guess if url contains subdirectory or not.
- *
- * @param string $url Rewrite test URL
- *
- * @return string|bool Subdirectory string with beginning and trailing slash or false if were unable to determine subdirectory
- * or pointing at root of domain already
- */
- public function guessSubdirectory($url) {
- $elements = parse_url($url);
- if (!$elements || !isset($elements['path'])) {
- return false;
- }
- $subdir = trim(dirname($elements['path']), '/');
- if (!$subdir) {
- return false;
- } else {
- return "/$subdir/";
- }
- }
- /**
- * Hit the rewrite test URL to determine if the rewrite rules are working
- *
- * @param string $url Rewrite test URL
- *
- * @return bool
- */
- public function runRewriteTest($url) {
- $this->serverSupportsRemoteRead = ($this->fetchUrl($url) === 'success');
- return $this->serverSupportsRemoteRead;
- }
-
- /**
- * Check whether the site homepage can be fetched via curl
- *
- * @return boolean
- */
- public function runLocalhostAccessTest() {
- $url = _elgg_services()->config->getSiteUrl();
- return (bool)$this->fetchUrl($url);
- }
- /**
- * Fetch a URL
- *
- * @param string $url The URL
- *
- * @return string Note that empty string may imply failure in fetching or empty response
- */
- private function fetchUrl($url) {
- $response = '';
- if (ini_get('allow_url_fopen')) {
- $ctx = stream_context_create(array(
- 'http' => array(
- 'follow_location' => 0,
- 'timeout' => 5,
- ),
- ));
- $response = @file_get_contents($url, null, $ctx);
- }
- if (!$response && function_exists('curl_init')) {
- $ch = curl_init();
- curl_setopt($ch, CURLOPT_URL, $url);
- curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
- curl_setopt($ch, CURLOPT_TIMEOUT, 5);
- curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
- $response = curl_exec($ch);
- curl_close($ch);
- }
- return (string)$response;
- }
- /**
- * Create Elgg's .htaccess file or confirm that it exists
- *
- * @param string $url URL of rewrite test
- * @param string $path Elgg's root directory with trailing slash
- *
- * @return bool
- */
- public function createHtaccess($url, $path) {
- $filename = "{$path}.htaccess";
- if (file_exists($filename)) {
- // check that this is the Elgg .htaccess
- $data = file_get_contents($filename);
- if ($data === FALSE) {
- // don't have permission to read the file
- $this->htaccessIssue = 'read_permission';
- return FALSE;
- }
- if (strpos($data, 'Elgg') === FALSE) {
- $this->htaccessIssue = 'non_elgg_htaccess';
- return FALSE;
- } else {
- // check if this is an old Elgg htaccess
- if (strpos($data, 'RewriteRule ^rewrite.php$ install.php') == FALSE) {
- $this->htaccessIssue = 'old_elgg_htaccess';
- return FALSE;
- }
- return TRUE;
- }
- }
- if (!is_writable($path)) {
- $this->htaccessIssue = 'write_permission';
- return FALSE;
- }
- // create the .htaccess file
- $result = copy("{$path}install/config/htaccess.dist", $filename);
- if (!$result) {
- $this->htaccessIssue = 'cannot_copy';
- return FALSE;
- }
-
- // does default RewriteBase work already?
- if (!$this->runRewriteTest($url)) {
- //try to rewrite to guessed subdirectory
- if ($subdir = $this->guessSubdirectory($url)) {
- $contents = file_get_contents($filename);
- $contents = preg_replace("/#RewriteBase \/(\r?\n)/", "RewriteBase $subdir\$1", $contents);
- if ($contents) {
- file_put_contents($filename, $contents);
- }
- }
- }
- return TRUE;
- }
- /**
- * Create the status array required by the ElggInstaller
- *
- * @param string $url Rewrite test URL
- *
- * @return array
- */
- protected function returnStatus($url) {
- if ($this->rewriteTestPassed) {
- return array(
- 'severity' => 'pass',
- 'message' => _elgg_services()->translator->translate('install:check:rewrite:success'),
- );
- }
- if ($this->serverSupportsRemoteRead == FALSE) {
- $msg = _elgg_services()->translator->translate('install:warning:rewrite:unknown', array($url));
- $msg .= elgg_view('install/js_rewrite_check', array('url' => $url));
-
- return array(
- 'severity' => 'warning',
- 'message' => $msg,
- );
- }
- if ($this->webserver == 'apache') {
- $serverString = _elgg_services()->translator->translate('install:error:rewrite:apache');
- $msg = "$serverString\n\n";
- if (!isset($this->htaccessIssue)) {
- $msg .= _elgg_services()->translator->translate('install:error:rewrite:allowoverride');
- $msg .= elgg_view('install/js_rewrite_check', array('url' => $url));
-
- return array(
- 'severity' => 'failure',
- 'message' => $msg,
- );
- }
- $msg .= _elgg_services()->translator->translate("install:error:rewrite:htaccess:{$this->htaccessIssue}");
- return array(
- 'severity' => 'failure',
- 'message' => $msg,
- );
- }
- if ($this->webserver != 'unknown') {
- $serverString = _elgg_services()->translator->translate("install:error:rewrite:{$this->webserver}");
- $msg = "$serverString\n\n";
- $msg .= _elgg_services()->translator->translate("install:error:rewrite:altserver");
- return array(
- 'severity' => 'failure',
- 'message' => $msg,
- );
- }
- return array(
- 'severity' => 'failure',
- 'message' => _elgg_services()->translator->translate('install:error:rewrite:unknown'),
- );
- }
- }
|