Segments::hasPart() - Code Metrics - Inspection of "inline docs revisions" - o2system/kernel - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( f28312...62896a )

unknown
created 2019-02-09 04:08 UTC
Segments::hasPart() A

↳ Parent: Segments
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	2
dl	0
loc	3
rs	10
c	0
b	0
f	0
<?php
/**
 * This file is part of the O2System Framework package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author         Steeve Andrian Salim
 * @copyright      Copyright (c) Steeve Andrian Salim
 */

// ------------------------------------------------------------------------

namespace O2System\Kernel\Http\Message\Uri;

// ------------------------------------------------------------------------

use O2System\Spl\DataStructures\SplArrayObject;
use O2System\Spl\Exceptions\RuntimeException;

/**
 * Class Segments
 *
 * @package O2System\Kernel\Http\Message\Uri
 */
class Segments
{
    /**
     * Segments::$string
     *
     * @var string
     */
    protected $string;

    /**
     * Segments::$parts
     *
     * @var array
     */
    protected $parts;

    // ------------------------------------------------------------------------

    /**
     * Segments::__construct
     *
     * @param string|null $string
     */
    public function __construct($string = null)
    {
        if (is_null($string)) {
            if (kernel()->services->has('config')) {
                if (config()->offsetExists('uri')) {
                if (/** @scrutinizer ignore-call */ config()->offsetExists('uri')) {
                    $protocol = strtoupper(config('uri')->offsetGet('protocol'));
                }
            }

            empty($protocol) && $protocol = 'REQUEST_URI';

            switch ($protocol) {
                case 'AUTO':
                case 'REQUEST_URI':
                    $string = $this->parseRequestUri();
                    break;
                case 'QUERY_STRING':
                    $string = $this->parseQueryString();
                    break;
                case 'PATH_INFO':
                default:
                    $string = isset($_SERVER[ $protocol ])
                        ? $_SERVER[ $protocol ]
                        : $this->parseRequestUri();
                    break;
            }

        } elseif (is_array($string)) {

            $string = implode('/', $string);
        }

        $string = str_replace(['\\', '_'], ['/', '-'], $string);
        $string = trim(remove_invisible_characters($string, false), '/');
        $this->setParts(explode('/', $string));
    }

    // ------------------------------------------------------------------------

    /**
     * Segments::parseRequestUri
     *
     * Parse REQUEST_URI
     *
     * Will parse REQUEST_URI and automatically detect the URI from it,
     * while fixing the query string if necessary.
     *
     * @access  protected
     * @return  string
     */
    protected function parseRequestUri()
    {
        if ( ! isset($_SERVER[ 'REQUEST_URI' ], $_SERVER[ 'SCRIPT_NAME' ])) {
            return '';
        }

        $uri = parse_url($_SERVER[ 'REQUEST_URI' ]);
        $query = isset($uri[ 'query' ])
            ? $uri[ 'query' ]
            : '';
        $uri = isset($uri[ 'path' ])
            ? $uri[ 'path' ]
            : '';

        if (isset($_SERVER[ 'SCRIPT_NAME' ][ 0 ])) {
            if (strpos($uri, $_SERVER[ 'SCRIPT_NAME' ]) === 0) {
                $uri = (string)substr($uri, strlen($_SERVER[ 'SCRIPT_NAME' ]));
            } elseif (strpos($uri, dirname($_SERVER[ 'SCRIPT_NAME' ])) === 0) {
                $uri = (string)substr($uri, strlen(dirname($_SERVER[ 'SCRIPT_NAME' ])));
            }
        }

        // This section ensures that even on servers that require the URI to be in the query string (Nginx) a correct
        // URI is found, and also fixes the QUERY_STRING server var and $_GET array.
        if (trim($uri, '/') === '' AND strncmp($query, '/', 1) === 0) {
            $query = explode('?', $query, 2);
            $uri = $query[ 0 ];

            $_SERVER[ 'QUERY_STRING' ] = isset($query[ 1 ])
                ? $query[ 1 ]
                : '';
        } else {
            $_SERVER[ 'QUERY_STRING' ] = $query;
        }

        if (isset($_GET[ 'SEGMENTS_STRING' ])) {
            $uri = $_GET[ 'SEGMENTS_STRING' ];
            unset($_GET[ 'SEGMENTS_STRING' ]);

            $_SERVER[ 'QUERY_STRING' ] = str_replace([
                'SEGMENTS_STRING=' . $uri . '&',
                'SEGMENTS_STRING=' . $uri,
            ], '', $_SERVER[ 'QUERY_STRING' ]);
        }

        parse_str($_SERVER[ 'QUERY_STRING' ], $_GET);

        if ($uri === '/' || $uri === '') {
            return '/';
        }

        return $uri;
    }

    // ------------------------------------------------------------------------

    /**
     * Segments::parseQueryString
     *
     * Parse QUERY_STRING
     *
     * Will parse QUERY_STRING and automatically detect the URI from it.
     *
     * @access  protected
     * @return  string
     */
    protected function parseQueryString()
    {
        $uri = isset($_SERVER[ 'QUERY_STRING' ])
            ? $_SERVER[ 'QUERY_STRING' ]
            : @getenv('QUERY_STRING');

        if (trim($uri, '/') === '') {
            return '';
        } elseif (strncmp($uri, '/', 1) === 0) {
            $uri = explode('?', $uri, 2);
            $_SERVER[ 'QUERY_STRING' ] = isset($uri[ 1 ])
                ? $uri[ 1 ]
                : '';
            $uri = rawurldecode($uri[ 0 ]);
        }

        parse_str($_SERVER[ 'QUERY_STRING' ], $_GET);

        return $uri;
    }

    // --------------------------------------------------------------------

    /**
     * Segments::getString
     *
     * Get String
     *
     * Get Requested Uri String
     *
     * @return string
     */
    public function getString()
    {
        return empty($this->string)
            ? '/'
            : $this->string;
    }

    // ------------------------------------------------------------------------

    /**
     * Segments::addString
     *
     * @param string $string
     *
     * @return \O2System\Kernel\Http\Message\Uri\Segments
     */
    public function addString($string)
    {
        $string = $this->string . '/' . trim($string, '/');

        return $this->withString($string);
    }

    // ------------------------------------------------------------------------

    /**
     * Segments::withString
     *
     * @param string $string
     *
     * @return \O2System\Kernel\Http\Message\Uri\Segments
     */
    public function withString($string)
    {
        $string = trim(remove_invisible_characters($string, false), '/');

        return $this->withParts(explode('/', $string));
    }

    // ------------------------------------------------------------------------

    /**
     * Segments::withParts
     *
     * @param array $parts
     *
     * @return \O2System\Kernel\Http\Message\Uri\Segments
     */
    public function withParts(array $parts)
    {
        $uri = clone $this;
        $uri->setParts($parts);

        return $uri;
    }

    // ------------------------------------------------------------------------

    /**
     * Segments::addParts
     *
     * @param array $parts
     *
     * @return \O2System\Kernel\Http\Message\Uri\Segments
     */
    public function addParts(array $parts)
    {
        $parts = array_merge($this->parts, $parts);

        return $this->withParts($parts);
    }

    // ------------------------------------------------------------------------

    /**
     * Segments::getPart
     *
     * Get Segment
     *
     * @param int $n (n) of Uri Segments
     *
     * @return mixed
     */
    public function getPart($n)
    {
        return isset($this->parts[ $n ])
            ? $this->parts[ $n ]
            : false;
    }

    // ------------------------------------------------------------------------

    /**
     * Segments::getParts
     *
     * Get Segments
     *
     * @return array
     */
    public function getParts()
    {
        return $this->parts;
    }

    // ------------------------------------------------------------------------

    /**
     * Segments::setParts
     *
     * @param array $parts
     *
     * @throws \O2System\Spl\Exceptions\RuntimeException
     */
    protected function setParts(array $parts)
    {
        if (count($parts)) {
            $validSegments = [];

            if (count($parts)) {
                foreach ($parts as $part) {
                    // Filter segments for security
                    if ($part = trim($this->filterPart($part))) {
                        if (class_exists('O2System\Framework', false)) {
                            if (false !== ($language = language()->registered($part))) {
                            if (false !== ($language = language()->/** @scrutinizer ignore-call */ registered($part))) {
                                language()->setDefault($part);

                                continue;
                            }
                        }

                        if ( ! in_array($part, $validSegments)) {
                            $validSegments[] = $part;
                        }
                    }
                }
            }

            $validSegments = array_filter($validSegments);
            array_unshift($validSegments, null);

            unset($validSegments[ 0 ]);

            $this->parts = $validSegments;
            $this->string = implode('/', $this->parts);
        }
    }

    // ------------------------------------------------------------------------

    /**
     * Segments::hasPart
     *
     * Has Segment
     *
     * @param string $part
     * @param bool   $isCaseSensitive
     *
     * @return bool
     */
    public function hasPart($part, $isCaseSensitive = false)
    {
        return (bool)in_array($part, $this->parts, $isCaseSensitive);
    }

    // ------------------------------------------------------------------------

    /**
     * Segments::getTotalParts
     *
     * Get Total Segments
     *
     * @return int
     */
    public function getTotalParts()
    {
        return count($this->parts);
    }

    // ------------------------------------------------------------------------

    /**
     * Segments::__toString
     *
     * @return string
     */
    public function __toString()
    {
        if (count($this->parts)) {
            return implode('/', $this->parts);
        }

        return '';
    }

    // ------------------------------------------------------------------------

    /**
     * Segments::filterPart
     *
     * Filters segments for malicious characters.
     *
     * @param string $string URI String
     *
     * @return mixed
     * @throws RuntimeException
     */
    protected function filterPart($string)
    {
        if (function_exists('config')) {
            $config = config('uri');
        }

        if (empty($config)) {
            $config = new SplArrayObject([
                'permittedChars' => 'a-z 0-9~%.:_\-@#',
                'suffix'         => null,
            ]);
        }

        if ( ! empty($string) AND
            ! empty($config->offsetGet('permittedChars')) AND
            ! preg_match('/^[' . $config->offsetGet('permittedChars') . ']+$/i', $string) AND
            ! is_cli()
        ) {
            throw new RuntimeException('E_URI_HAS_DISALLOWED_CHARACTERS', 105);
        }

        $regex = ['$', '(', ')', '%28', '%29', 'index', '.php', '.phtml']; // Bad
        $replace = ['&#36;', '&#40;', '&#41;', '&#40;', '&#41;']; // Good

        if ( ! empty($config)) {
            array_push($regex, $config->offsetGet('suffix'));
            array_push($replace, '');
        }

        // Convert programatic characters to entities and return
        return str_replace($regex, $replace, $string);
    }
}
o2system / kernel

GitHub Access Token became invalid

Push — master ( f28312...62896a )

Segments::hasPart() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
