ElggRewriteTester.php

Go to the documentation of this file.

<?php

class ElggRewriteTester {
    protected $webserver;
    protected $serverSupportsRemoteRead;
    protected $rewriteTestPassed;
    protected $htaccessIssue;

    public function __construct() {
        $this->webserver = 'unknown';
    }

    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);
    }

    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';
    }

    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/";
        }
    }

    public function runRewriteTest($url) {

        $this->serverSupportsRemoteRead = true;

        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);
        } elseif (function_exists('curl_init')) {
            // try curl if installed
            $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);
        } else {
            $response = '';
        }

        if ($response !== 'success') {
            $this->serverSupportsRemoteRead = false;
            return false;
        }

        return true;
    }

    public function runLocalhostAccessTest() {
        $url = elgg_get_site_url();
        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);
        } elseif (function_exists('curl_init')) {
            // try curl if installed
            $ch = curl_init();
            curl_setopt($ch, CURLOPT_URL, $url);
            curl_setopt($ch, CURLOPT_TIMEOUT, 5);
            curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
            $response = curl_exec($ch);
            curl_close($ch);
        }

        return $response !== false;
    }

    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}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;
    }

    protected function returnStatus($url) {
        if ($this->rewriteTestPassed) {
            return array(
                'severity' => 'pass',
                'message' => elgg_echo('install:check:rewrite:success'),
            );
        }

        if ($this->serverSupportsRemoteRead == FALSE) {
            $msg = elgg_echo('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_echo('install:error:rewrite:apache');
            $msg = "$serverString\n\n";
            if (!isset($this->htaccessIssue)) {
                $msg .= elgg_echo('install:error:rewrite:allowoverride');
                $msg .= elgg_view('install/js_rewrite_check', array('url' => $url));

                return array(
                    'severity' => 'failure',
                    'message' => $msg,
                );
            }
            $msg .= elgg_echo("install:error:rewrite:htaccess:{$this->htaccessIssue}");
            return array(
                'severity' => 'failure',
                'message' => $msg,
            );
        }

        if ($this->webserver != 'unknown') {
            $serverString = elgg_echo("install:error:rewrite:{$this->webserver}");
            $msg = "$serverString\n\n";
            $msg .= elgg_echo("install:error:rewrite:altserver");
            return array(
                'severity' => 'failure',
                'message' => $msg,
            );
        }

        return array(
            'severity' => 'failure',
            'message' => elgg_echo('install:error:rewrite:unknown'),
        );
    }
}