Request.php

Go to the documentation of this file.

<?php

namespace Elgg\Http;

use Elgg\Config;
use Elgg\Context;
use Elgg\Exceptions\Http\BadRequestException;
use Elgg\Router\Route;
use Symfony\Component\HttpFoundation\File\UploadedFile;
use Symfony\Component\HttpFoundation\Request as SymfonyRequest;

class Request extends SymfonyRequest {

    const REWRITE_TEST_TOKEN = '__testing_rewrite';
    const REWRITE_TEST_OUTPUT = 'success';

    protected $context_stack;

    protected $route;
    
    protected $request_overrides;
    
    protected $filtered_params;
    
    protected $unfiltered_params;

    public function __construct(
        array $query = [],
        array $request = [],
        array $attributes = [],
        array $cookies = [],
        array $files = [],
        array $server = [],
        $content = null
    ) {
        parent::__construct($query, $request, $attributes, $cookies, $files, $server, $content);

        $this->initializeContext();
        
        $this->request_overrides = [];
    }
    
    public function initializeTrustedProxyConfiguration(Config $config) {
        $trusted_proxies = $config->http_request_trusted_proxy_ips;
        if (empty($trusted_proxies)) {
            return;
        }
        
        $allowed_headers = $config->http_request_trusted_proxy_headers;
        if (empty($allowed_headers)) {
            $allowed_headers = self::HEADER_X_FORWARDED_FOR | self::HEADER_X_FORWARDED_HOST | self::HEADER_X_FORWARDED_PORT | self::HEADER_X_FORWARDED_PROTO;
        }
        
        $this->setTrustedProxies($trusted_proxies, $allowed_headers);
    }

    public function initializeContext() {
        $context = new Context($this);
        $this->context_stack = $context;

        return $this;
    }

    public function getContextStack() {
        return $this->context_stack;
    }

    public function setRoute(Route $route) {
        $this->route = $route;
        foreach ($route->getMatchedParameters() as $key => $value) {
            $this->setParam($key, $value);
        }

        return $this;
    }

    public function getRoute() {
        return $this->route;
    }

    public function setParam(string $key, $value, bool $override_request = false) {
        if ($override_request) {
            $this->request_overrides[$key] = $value;
        } else {
            $this->request->set($key, $value);
        }

        // reset the cached params
        unset($this->filtered_params);
        unset($this->unfiltered_params);

        return $this;
    }

    public function getParam(string $key, $default = null, bool $filter_result = true) {
        $values = $this->getParams($filter_result);

        return elgg_extract($key, $values, $default);
    }

    public function getParams(bool $filter_result = true) {
        if (isset($this->filtered_params) && isset($this->unfiltered_params)) {
            return $filter_result ? $this->filtered_params : $this->unfiltered_params;
        }

        $request_overrides = $this->request_overrides;
        $query = $this->query->all();
        $attributes = $this->attributes->all();
        $post = $this->request->all();

        $this->unfiltered_params = array_merge($post, $attributes, $query, $request_overrides);

        // filter the input params
        $this->getContextStack()->push('input');
        $this->filtered_params = elgg_sanitize_input($this->unfiltered_params);
        $this->getContextStack()->pop();
        
        return $filter_result ? $this->filtered_params : $this->unfiltered_params;
    }

    public function getCurrentURL() {
        $url = parse_url(elgg_get_site_url());

        $page = $url['scheme'] . "://" . $url['host'];

        if (isset($url['port']) && $url['port']) {
            $page .= ":" . $url['port'];
        }

        $page = trim($page, "/");

        $page .= $this->getRequestUri();

        return $page;
    }

    public function getUrlSegments(bool $raw = false) {
        $path = trim($this->getElggPath(), '/');
        if (!$raw) {
            $path = htmlspecialchars($path, ENT_QUOTES, 'UTF-8');
        }
        if (!$path) {
            return [];
        }

        return explode('/', $path);
    }

    public function setUrlSegments(array $segments) {
        $base_path = trim($this->getBasePath(), '/');
        $server = $this->server->all();
        $server['REQUEST_URI'] = "$base_path/" . implode('/', $segments);

        return $this->duplicate(null, null, null, null, null, $server);
    }

    public function getFirstUrlSegment() {
        $segments = $this->getUrlSegments();
        if (!empty($segments)) {
            return array_shift($segments);
        }
        
        return '';
    }

    public function getElggPath() {
        if (php_sapi_name() === 'cli-server') {
            $path = $this->getRequestUri();
        } else {
            $path = $this->getPathInfo();
        }

        return preg_replace('~(\?.*)$~', '', $path);
    }

    public function getClientIp() {
        $ip = parent::getClientIp();

        if ($ip == $this->server->get('REMOTE_ADDR')) {
            // try one more
            $ip_addresses = $this->server->get('HTTP_X_REAL_IP');
            if ($ip_addresses) {
                $ip_addresses = explode(',', $ip_addresses);

                return array_pop($ip_addresses);
            }
        }

        return $ip;
    }

    public function isXmlHttpRequest() {
        return (strtolower($this->headers->get('X-Requested-With') ?: '') === 'xmlhttprequest'
            || $this->query->get('X-Requested-With') === 'XMLHttpRequest'
            || $this->request->get('X-Requested-With') === 'XMLHttpRequest');
    }

    public function sniffElggUrl() {
        $base_url = $this->getBaseUrl();

        // baseURL may end with the PHP script
        if ('.php' === substr($base_url, -4)) {
            $base_url = dirname($base_url);
        }

        $base_url = str_replace('\\', '/', $base_url);

        return rtrim($this->getSchemeAndHttpHost() . $base_url, '/') . '/';
    }

    public function isRewriteCheck() {
        if ($this->getPathInfo() !== ('/' . self::REWRITE_TEST_TOKEN)) {
            return false;
        }

        if (!$this->get(self::REWRITE_TEST_TOKEN)) {
            return false;
        }

        return true;
    }

    public function isAction(): bool {
        return $this->getFirstUrlSegment() === 'action';
    }

    public function isCliServer() {
        return php_sapi_name() === 'cli-server';
    }

    public function isCliServable($root) {
        $file = rtrim($root, '\\/') . $this->getElggPath();
        if (!is_file($file)) {
            return false;
        }

        // http://php.net/manual/en/features.commandline.webserver.php
        $extensions = ".3gp, .apk, .avi, .bmp, .css, .csv, .doc, .docx, .flac, .gif, .gz, .gzip, .htm, .html, .ics, .jpe, .jpeg, .jpg, .js, .kml, .kmz, .m4a, .mov, .mp3, .mp4, .mpeg, .mpg, .odp, .ods, .odt, .oga, .ogg, .ogv, .pdf, .pdf, .png, .pps, .pptx, .qt, .svg, .swf, .tar, .text, .tif, .txt, .wav, .webm, .wmv, .xls, .xlsx, .xml, .xsl, .xsd, and .zip";

        // The CLI server routes ALL requests here (even existing files), so we have to check for these.
        $ext = pathinfo($file, PATHINFO_EXTENSION);
        if (!$ext) {
            return false;
        }

        $ext = preg_quote($ext, '~');

        return (bool) preg_match("~\\.{$ext}[,$]~", $extensions);
    }

    public function getFiles($input_name) {
        $files = $this->files->get($input_name);
        if (empty($files)) {
            return [];
        }

        if (!is_array($files)) {
            $files = [$files];
        }

        return $files;
    }

    public function getFile($input_name, $check_for_validity = true) {
        $files = $this->getFiles($input_name);
        if (empty($files)) {
            return false;
        }

        $file = $files[0];
        if (empty($file)) {
            return false;
        }

        if ($check_for_validity && !$file->isValid()) {
            return false;
        }

        return $file;
    }

    public function validate() {
        $this->validateRequestHostHeader();
        $this->validateRequestBodyTruncated();
    }

    protected function validateRequestHostHeader() {
        $config = _elgg_services()->config;
        if (empty($config->wwwroot)) {
            return;
        }
        
        $config_host = parse_url($config->wwwroot, PHP_URL_HOST);
        if ($config_host === $this->getHost()) {
            return;
        }
        
        throw new BadRequestException(elgg_echo('BadRequestException:invalid_host_header'));
    }

    protected function validateRequestBodyTruncated(): void {
        $reported_bytes = $this->server->get('CONTENT_LENGTH');

        // Requests with multipart content type
        $post_data_count = count($this->request->all());

        // Requests with other content types
        $content = $this->getContent();
        $post_body_length = is_string($content) ? elgg_strlen($content) : 0;

        $file_count = count($this->files->all());
        
        $is_valid = function() use ($reported_bytes, $post_data_count, $post_body_length, $file_count) {
            if (empty($reported_bytes)) {
                // Content length is set for POST requests only
                return true;
            }

            if (empty($post_data_count) && empty($post_body_length) && empty($file_count)) {
                // The size of $_POST or uploaded files has exceed the size limit
                // and the request body/query has been truncated
                // thus the request reported bytes is set, but no postdata is found
                return false;
            }

            return true;
        };

        if ($is_valid()) {
            return;
        }
        
        $error_msg = elgg_trigger_deprecated_plugin_hook('action_gatekeeper:upload_exceeded_msg', 'all', [
            'post_size' => $reported_bytes,
            'visible_errors' => true,
        ], elgg_echo('actiongatekeeper:uploadexceeded'), "The 'action_gatekeeper:upload_exceeded_msg', 'all' has been deprecated", '4.3');
        
        throw new BadRequestException($error_msg);
    }
    
    public function correctBaseURL(\Elgg\Config $config): void {
        if (\Elgg\Application::isCli()) {
            return;
        }
        
        $path = parse_url($config->wwwroot, PHP_URL_PATH);
        
        $this->baseUrl = rtrim($path, '/');
    }
}