RewriteTester.php

Go to the documentation of this file.

<?php

namespace Elgg\Router;

use Elgg\Http\Request;
use Elgg\Project\Paths;

class RewriteTester {
    
    protected string $webserver;
    
    protected bool $serverSupportsRemoteRead;
    
    protected bool $rewriteTestPassed;
    
    protected string $htaccessIssue;

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

    public function run(string $url): array {

        $this->webserver = $this->guessWebServer();

        $this->rewriteTestPassed = $this->runRewriteTest($url);

        if ($this->rewriteTestPassed === false) {
            if ($this->webserver == 'apache' || $this->webserver == 'unknown') {
                if ($this->createHtaccess($url)) {
                    $this->rewriteTestPassed = $this->runRewriteTest($url);
                }
            }
        }

        return $this->returnStatus($url);
    }

    protected function guessWebServer(): string {
        if (empty($_SERVER['SERVER_SOFTWARE'])) {
            return 'unknown';
        }

        $serverString = strtolower($_SERVER['SERVER_SOFTWARE']);
        $possibleServers = ['apache', 'nginx', 'lighttpd', 'iis'];
        foreach ($possibleServers as $server) {
            if (elgg_strpos($serverString, $server) !== false) {
                return $server;
            }
        }
        
        return 'unknown';
    }

    protected function guessSubdirectory(string $url): string|false {
        $elements = parse_url($url);
        if (!is_array($elements) || !isset($elements['path'])) {
            return false;
        }
        
        $subdir = trim(dirname($elements['path']), '/');
        if (!$subdir) {
            return false;
        }
        
        return "/{$subdir}/";
    }

    public function runRewriteTest(string $url): bool {
        $this->serverSupportsRemoteRead = ($this->fetchUrl($url) === Request::REWRITE_TEST_OUTPUT);
        return $this->serverSupportsRemoteRead;
    }
    
    public function runLocalhostAccessTest(): bool {
        return (bool) $this->fetchUrl(_elgg_services()->config->wwwroot);
    }

    private function fetchUrl(string $url): string {
        $response = '';

        if (ini_get('allow_url_fopen')) {
            $ctx = stream_context_create([
                'http' => [
                    'follow_location' => 0,
                    'timeout' => 5,
                ],
            ]);
            $response = @file_get_contents($url, false, $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;
    }

    public function createHtaccess(string $url): bool {
        $htaccess = Paths::project() . '.htaccess';

        if (file_exists($htaccess)) {
            // check that this is the Elgg .htaccess
            $data = file_get_contents($htaccess);
            if (empty($data)) {
                // don't have permission to read the file
                $this->htaccessIssue = 'read_permission';
                return false;
            }

            if (elgg_strpos($data, 'Elgg') === false) {
                $this->htaccessIssue = 'non_elgg_htaccess';
                return false;
            }

            // check if this is an old Elgg htaccess
            if (elgg_strpos($data, 'RewriteRule ^rewrite.php$ install.php') === false) {
                $this->htaccessIssue = 'old_elgg_htaccess';
                return false;
            }
            
            return true;
        }

        if (!is_writable(Paths::project())) {
            $this->htaccessIssue = 'write_permission';
            return false;
        }

        // create the .htaccess file
        $result = copy(Paths::elgg() . 'install/config/htaccess.dist', $htaccess);
        if (!$result) {
            $this->htaccessIssue = 'cannot_copy';
            return false;
        }
        
        // does default RewriteBase work already?
        if (!$this->runRewriteTest($url)) {
            //try to rewrite to guessed subdirectory
            $subdir = $this->guessSubdirectory($url);
            if (!empty($subdir)) {
                $contents = file_get_contents($htaccess);
                $contents = preg_replace("/#RewriteBase \/(\r?\n)/", "RewriteBase $subdir\$1", $contents);
                if ($contents) {
                    file_put_contents($htaccess, $contents);
                }
            }
        }

        return true;
    }

    protected function returnStatus(string $url): array {
        if ($this->rewriteTestPassed) {
            return [
                'severity' => 'success',
                'message' => _elgg_services()->translator->translate('install:check:rewrite:success'),
            ];
        }

        if ($this->serverSupportsRemoteRead === false) {
            $msg = _elgg_services()->translator->translate('install:warning:rewrite:unknown', [$url]);
            $msg .= elgg_view('install/js_rewrite_check', ['url' => $url]);
            
            return [
                'severity' => 'warning',
                'message' => $msg,
            ];
        }

        if ($this->webserver === 'apache') {
            $msg = _elgg_services()->translator->translate('install:error:rewrite:apache');
            $msg .= PHP_EOL . PHP_EOL;
            if (!isset($this->htaccessIssue)) {
                $msg .= _elgg_services()->translator->translate('install:error:rewrite:allowoverride');
                $msg .= elgg_view('install/js_rewrite_check', ['url' => $url]);
            
                return [
                    'severity' => 'warning',
                    'message' => $msg,
                ];
            }
            
            $msg .= _elgg_services()->translator->translate("install:error:rewrite:htaccess:{$this->htaccessIssue}");
            return [
                'severity' => 'warning',
                'message' => $msg,
            ];
        }

        if ($this->webserver !== 'unknown') {
            $msg = _elgg_services()->translator->translate("install:error:rewrite:{$this->webserver}");
            $msg .= PHP_EOL . PHP_EOL;
            $msg .= _elgg_services()->translator->translate('install:error:rewrite:altserver');
            return [
                'severity' => 'warning',
                'message' => $msg,
            ];
        }

        return [
            'severity' => 'warning',
            'message' => _elgg_services()->translator->translate('install:error:rewrite:unknown'),
        ];
    }
}