Uri::withPort() - Code Metrics - Inspection of "v3.1" - sunrise-php/http-message - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#34)

by Anatoly

created 2024-10-30 02:19 UTC

Uri::withPort() A

↳ Parent: Uri

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	3
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	6
ccs	4
cts	4
cp	1
crap	1
rs	10

<?php declare(strict_types=1);

/**
 * It's free open-source software released under the MIT License.
 *
 * @author Anatoly Nekhay <[email protected]>
 * @copyright Copyright (c) 2018, Anatoly Nekhay
 * @license https://github.com/sunrise-php/http-message/blob/master/LICENSE
 * @link https://github.com/sunrise-php/http-message
 */

namespace Sunrise\Http\Message;

use Psr\Http\Message\UriInterface;
use Sunrise\Http\Message\Exception\InvalidArgumentException;
use Sunrise\Http\Message\Uri\Component\Fragment;
use Sunrise\Http\Message\Uri\Component\Host;
use Sunrise\Http\Message\Uri\Component\Path;
use Sunrise\Http\Message\Uri\Component\Port;
use Sunrise\Http\Message\Uri\Component\Query;
use Sunrise\Http\Message\Uri\Component\Scheme;
use Sunrise\Http\Message\Uri\Component\UserInfo;

use function is_string;
use function ltrim;
use function parse_url;
use function strncmp;

class Uri implements UriInterface
{
    private string $scheme = '';
    private string $userInfo = '';
    private string $host = '';
    private ?int $port = null;
    private string $path = '';
    private string $query = '';
    private string $fragment = '';

    /**
     * @throws InvalidArgumentException
     */
    public function __construct(string $uri = '')
    {
        if ($uri === '') {
            return;
        }

        $this->parseUri($uri);
    }

    /**
     * @param mixed $uri
     *
     * @throws InvalidArgumentException
     */
    public static function create($uri): UriInterface
    {
        if ($uri instanceof UriInterface) {
            return $uri;
        }

        if (!is_string($uri)) {
            throw new InvalidArgumentException('URI should be a string');
        }

        return new self($uri);
    }

    /**
     * @inheritDoc
     */
    public function withScheme($scheme): UriInterface
    {
        $clone = clone $this;
        $clone->setScheme($scheme);

        return $clone;
    }

    /**
     * @inheritDoc
     *
     * @throws InvalidArgumentException
     */
    public function withUserInfo($user, $password = null): UriInterface
    {
        $clone = clone $this;
        $clone->setUserInfo($user, $password);

        return $clone;
    }

    /**
     * @inheritDoc
     */
    public function withHost($host): UriInterface
    {
        $clone = clone $this;
        $clone->setHost($host);

        return $clone;
    }

    /**
     * @inheritDoc
     */
    public function withPort($port): UriInterface
    {
        $clone = clone $this;
        $clone->setPort($port);

        return $clone;
    }

    /**
     * @inheritDoc
     */
    public function withPath($path): UriInterface
    {
        $clone = clone $this;
        $clone->setPath($path);

        return $clone;
    }

    /**
     * @inheritDoc
     */
    public function withQuery($query): UriInterface
    {
        $clone = clone $this;
        $clone->setQuery($query);

        return $clone;
    }

    /**
     * @inheritDoc
     *
     * @throws InvalidArgumentException
     */
    public function withFragment($fragment): UriInterface
    {
        $clone = clone $this;
        $clone->setFragment($fragment);

        return $clone;
    }

    /**
     * @inheritDoc
     */
    public function getScheme(): string
    {
        return $this->scheme;
    }

    /**
     * @inheritDoc
     */
    public function getUserInfo(): string
    {
        return $this->userInfo;
    }

    /**
     * @inheritDoc
     */
    public function getHost(): string
    {
        return $this->host;
    }

    /**
     * @inheritDoc
     */
    public function getPort(): ?int
    {
        // The 80 is the default port number for the HTTP protocol.
        if ($this->port === 80 && $this->scheme === 'http') {
            return null;
        }

        // The 443 is the default port number for the HTTPS protocol.
        if ($this->port === 443 && $this->scheme === 'https') {
            return null;
        }

        return $this->port;
    }

    /**
     * @inheritDoc
     */
    public function getPath(): string
    {
        // CVE-2015-3257
        if (strncmp($this->path, '//', 2) === 0) {
            return '/' . ltrim($this->path, '/');
        }

        return $this->path;
    }

    /**
     * @inheritDoc
     */
    public function getQuery(): string
    {
        return $this->query;
    }

    /**
     * @inheritDoc
     */
    public function getFragment(): string
    {
        return $this->fragment;
    }

    /**
     * @inheritDoc
     */
    public function getAuthority(): string
    {
        // The host is the basic subcomponent.
        if ($this->host === '') {
            return '';
        }

        $authority = $this->host;
        if ($this->userInfo !== '') {
            $authority = $this->userInfo . '@' . $authority;
        }

        $port = $this->getPort();
        if ($port !== null) {
            $authority = $authority . ':' . $port;
        }

        return $authority;
    }

    /**
     * @inheritDoc
     */
    public function __toString(): string
    {
        $uri = '';

        $scheme = $this->scheme;
        if ($scheme !== '') {
            $uri .= $scheme . ':';
        }

        $authority = $this->getAuthority();
        if ($authority !== '') {
            $uri .= '//' . $authority;
        }

        $path = $this->path;
        if ($path !== '') {
            // https://github.com/sunrise-php/uri/issues/31
            // https://datatracker.ietf.org/doc/html/rfc3986#section-3.3
            //
            // If a URI contains an authority component,
            // then the path component must either be empty
            // or begin with a slash ("/") character.
            if ($authority !== '' && strncmp($path, '/', 1) !== 0) {
                $path = '/' . $path;
            }

            // https://github.com/sunrise-php/uri/issues/31
            // https://datatracker.ietf.org/doc/html/rfc3986#section-3.3
            //
            // If a URI does not contain an authority component,
            // then the path cannot begin with two slash characters ("//").
            if ($authority === '' && strncmp($path, '//', 2) === 0) {
                $path = '/' . ltrim($path, '/');
            }

            $uri .= $path;
        }

        $query = $this->query;
        if ($query !== '') {
            $uri .= '?' . $query;
        }

        $fragment = $this->fragment;
        if ($fragment !== '') {
            $uri .= '#' . $fragment;
        }

        return $uri;
    }

    /**
     * @param mixed $scheme
     *
     * @throws InvalidArgumentException
     */
    final protected function setScheme($scheme): void
    {
        $this->scheme = (new Scheme($scheme))->getValue();
    }

    /**
     * @param mixed $user
     * @param mixed $password
     *
     * @throws InvalidArgumentException
     */
    final protected function setUserInfo($user, $password): void
    {
        $this->userInfo = (new UserInfo($user, $password))->getValue();
    }

    /**
     * @param mixed $host
     *
     * @throws InvalidArgumentException
     */
    final protected function setHost($host): void
    {
        $this->host = (new Host($host))->getValue();
    }

    /**
     * @param mixed $port
     *
     * @throws InvalidArgumentException
     */
    final protected function setPort($port): void
    {
        $this->port = (new Port($port))->getValue();
    }

    /**
     * @param mixed $path
     *
     * @throws InvalidArgumentException
     */
    final protected function setPath($path): void
    {
        $this->path = (new Path($path))->getValue();
    }

    /**
     * @param mixed $query
     *
     * @throws InvalidArgumentException
     */
    final protected function setQuery($query): void
    {
        $this->query = (new Query($query))->getValue();
    }

    /**
     * @param mixed $fragment
     *
     * @throws InvalidArgumentException
     */
    final protected function setFragment($fragment): void
    {
        $this->fragment = (new Fragment($fragment))->getValue();
    }

    /**
     * @throws InvalidArgumentException
     */
    private function parseUri(string $uri): void
    {
        $components = parse_url($uri);
        if ($components === false) {
            throw new InvalidArgumentException('Invalid URI');
        }

        if (isset($components['scheme'])) {
            $this->setScheme($components['scheme']);
        }
        if (isset($components['user'])) {
            $this->setUserInfo($components['user'], $components['pass'] ?? null);
        }
        if (isset($components['host'])) {
            $this->setHost($components['host']);
        }
        if (isset($components['port'])) {
            $this->setPort($components['port']);
        }
        if (isset($components['path'])) {
            $this->setPath($components['path']);
        }
        if (isset($components['query'])) {
            $this->setQuery($components['query']);
        }
        if (isset($components['fragment'])) {
            $this->setFragment($components['fragment']);
        }
    }
}


1		<?php declare(strict_types=1);
2
3		/**
4		* It's free open-source software released under the MIT License.
5		*
6		* @author Anatoly Nekhay <[email protected]>
7		* @copyright Copyright (c) 2018, Anatoly Nekhay
8		* @license https://github.com/sunrise-php/http-message/blob/master/LICENSE
9		* @link https://github.com/sunrise-php/http-message
10		*/
11
12		namespace Sunrise\Http\Message;
13
14		use Psr\Http\Message\UriInterface;
15		use Sunrise\Http\Message\Exception\InvalidArgumentException;
16		use Sunrise\Http\Message\Uri\Component\Fragment;
17		use Sunrise\Http\Message\Uri\Component\Host;
18		use Sunrise\Http\Message\Uri\Component\Path;
19		use Sunrise\Http\Message\Uri\Component\Port;
20		use Sunrise\Http\Message\Uri\Component\Query;
21		use Sunrise\Http\Message\Uri\Component\Scheme;
22		use Sunrise\Http\Message\Uri\Component\UserInfo;
23
24		use function is_string;
25		use function ltrim;
26		use function parse_url;
27		use function strncmp;
28
29		class Uri implements UriInterface
30		{
31		private string $scheme = '';
32		private string $userInfo = '';
33		private string $host = '';
34		private ?int $port = null;
35		private string $path = '';
36		private string $query = '';
37		private string $fragment = '';
38
39		/**
40		* @throws InvalidArgumentException
41		*/
42	628	public function __construct(string $uri = '')
43		{
44	628	if ($uri === '') {
45	100	return;
46		}
47
48	532	$this->parseUri($uri);
49		}
50
51		/**
52		* @param mixed $uri
53		*
54		* @throws InvalidArgumentException
55		*/
56	489	public static function create($uri): UriInterface
57		{
58	489	if ($uri instanceof UriInterface) {
59	98	return $uri;
60		}
61
62	431	if (!is_string($uri)) {
63	1	throw new InvalidArgumentException('URI should be a string');
64		}
65
66	430	return new self($uri);
67		}
68
69		/**
70		* @inheritDoc
71		*/
72	19	public function withScheme($scheme): UriInterface
73		{
74	19	$clone = clone $this;
75	19	$clone->setScheme($scheme);
76
77	5	return $clone;
78		}
79
80		/**
81		* @inheritDoc
82		*
83		* @throws InvalidArgumentException
84		*/
85	25	public function withUserInfo($user, $password = null): UriInterface
86		{
87	25	$clone = clone $this;
88	25	$clone->setUserInfo($user, $password);
89
90	8	return $clone;
91		}
92
93		/**
94		* @inheritDoc
95		*/
96	15	public function withHost($host): UriInterface
97		{
98	15	$clone = clone $this;
99	15	$clone->setHost($host);
100
101	6	return $clone;
102		}
103
104		/**
105		* @inheritDoc
106		*/
107	15	public function withPort($port): UriInterface
108		{
109	15	$clone = clone $this;
110	15	$clone->setPort($port);
111
112	4	return $clone;
113		}
114
115		/**
116		* @inheritDoc
117		*/
118	14	public function withPath($path): UriInterface
119		{
120	14	$clone = clone $this;
121	14	$clone->setPath($path);
122
123	5	return $clone;
124		}
125
126		/**
127		* @inheritDoc
128		*/
129	13	public function withQuery($query): UriInterface
130		{
131	13	$clone = clone $this;
132	13	$clone->setQuery($query);
133
134	4	return $clone;
135		}
136
137		/**
138		* @inheritDoc
139		*
140		* @throws InvalidArgumentException
141		*/
142	13	public function withFragment($fragment): UriInterface
143		{
144	13	$clone = clone $this;
145	13	$clone->setFragment($fragment);
146
147	4	return $clone;
148		}
149
150		/**
151		* @inheritDoc
152		*/
153	9	public function getScheme(): string
154		{
155	9	return $this->scheme;
156		}
157
158		/**
159		* @inheritDoc
160		*/
161	8	public function getUserInfo(): string
162		{
163	8	return $this->userInfo;
164		}
165
166		/**
167		* @inheritDoc
168		*/
169	488	public function getHost(): string
170		{
171	488	return $this->host;
172		}
173
174		/**
175		* @inheritDoc
176		*/
177	77	public function getPort(): ?int
178		{
179		// The 80 is the default port number for the HTTP protocol.
180	77	if ($this->port === 80 && $this->scheme === 'http') {
181	3	return null;
182		}
183
184		// The 443 is the default port number for the HTTPS protocol.
185	77	if ($this->port === 443 && $this->scheme === 'https') {
186	2	return null;
187		}
188
189	77	return $this->port;
190		}
191
192		/**
193		* @inheritDoc
194		*/
195	51	public function getPath(): string
196		{
197		// CVE-2015-3257
198	51	if (strncmp($this->path, '//', 2) === 0) {
199	8	return '/' . ltrim($this->path, '/');
200		}
201
202	43	return $this->path;
203		}
204
205		/**
206		* @inheritDoc
207		*/
208	38	public function getQuery(): string
209		{
210	38	return $this->query;
211		}
212
213		/**
214		* @inheritDoc
215		*/
216	8	public function getFragment(): string
217		{
218	8	return $this->fragment;
219		}
220
221		/**
222		* @inheritDoc
223		*/
224	36	public function getAuthority(): string
225		{
226		// The host is the basic subcomponent.
227	36	if ($this->host === '') {
228	14	return '';
229		}
230
231	27	$authority = $this->host;
232	27	if ($this->userInfo !== '') {
233	7	$authority = $this->userInfo . '@' . $authority;
234		}
235
236	27	$port = $this->getPort();
237	27	if ($port !== null) {
238	9	$authority = $authority . ':' . $port;
239		}
240
241	27	return $authority;
242		}
243
244		/**
245		* @inheritDoc
246		*/
247	34	public function __toString(): string
248		{
249	34	$uri = '';
250
251	34	$scheme = $this->scheme;
252	34	if ($scheme !== '') {
253	23	$uri .= $scheme . ':';
254		}
255
256	34	$authority = $this->getAuthority();
257	34	if ($authority !== '') {
258	25	$uri .= '//' . $authority;
259		}
260
261	34	$path = $this->path;
262	34	if ($path !== '') {
263		// https://github.com/sunrise-php/uri/issues/31
264		// https://datatracker.ietf.org/doc/html/rfc3986#section-3.3
265		//
266		// If a URI contains an authority component,
267		// then the path component must either be empty
268		// or begin with a slash ("/") character.
269	32	if ($authority !== '' && strncmp($path, '/', 1) !== 0) {
270	1	$path = '/' . $path;
271		}
272
273		// https://github.com/sunrise-php/uri/issues/31
274		// https://datatracker.ietf.org/doc/html/rfc3986#section-3.3
275		//
276		// If a URI does not contain an authority component,
277		// then the path cannot begin with two slash characters ("//").
278	32	if ($authority === '' && strncmp($path, '//', 2) === 0) {
279	1	$path = '/' . ltrim($path, '/');
280		}
281
282	32	$uri .= $path;
283		}
284
285	34	$query = $this->query;
286	34	if ($query !== '') {
287	6	$uri .= '?' . $query;
288		}
289
290	34	$fragment = $this->fragment;
291	34	if ($fragment !== '') {
292	4	$uri .= '#' . $fragment;
293		}
294
295	34	return $uri;
296		}
297
298		/**
299		* @param mixed $scheme
300		*
301		* @throws InvalidArgumentException
302		*/
303	113	final protected function setScheme($scheme): void
304		{
305	113	$this->scheme = (new Scheme($scheme))->getValue();
306		}
307
308		/**
309		* @param mixed $user
310		* @param mixed $password
311		*
312		* @throws InvalidArgumentException
313		*/
314	62	final protected function setUserInfo($user, $password): void
315		{
316	62	$this->userInfo = (new UserInfo($user, $password))->getValue();
317		}
318
319		/**
320		* @param mixed $host
321		*
322		* @throws InvalidArgumentException
323		*/
324	124	final protected function setHost($host): void
325		{
326	124	$this->host = (new Host($host))->getValue();
327		}
328
329		/**
330		* @param mixed $port
331		*
332		* @throws InvalidArgumentException
333		*/
334	55	final protected function setPort($port): void
335		{
336	55	$this->port = (new Port($port))->getValue();
337		}
338
339		/**
340		* @param mixed $path
341		*
342		* @throws InvalidArgumentException
343		*/
344	535	final protected function setPath($path): void
345		{
346	535	$this->path = (new Path($path))->getValue();
347		}
348
349		/**
350		* @param mixed $query
351		*
352		* @throws InvalidArgumentException
353		*/
354	56	final protected function setQuery($query): void
355		{
356	56	$this->query = (new Query($query))->getValue();
357		}
358
359		/**
360		* @param mixed $fragment
361		*
362		* @throws InvalidArgumentException
363		*/
364	49	final protected function setFragment($fragment): void
365		{
366	49	$this->fragment = (new Fragment($fragment))->getValue();
367		}
368
369		/**
370		* @throws InvalidArgumentException
371		*/
372	532	private function parseUri(string $uri): void
373		{
374	532	$components = parse_url($uri);
375	532	if ($components === false) {
376	6	throw new InvalidArgumentException('Invalid URI');
377		}
378
379	526	if (isset($components['scheme'])) {
380	99	$this->setScheme($components['scheme']);
381		}
382	526	if (isset($components['user'])) {
383	42	$this->setUserInfo($components['user'], $components['pass'] ?? null);
384		}
385	526	if (isset($components['host'])) {
386	114	$this->setHost($components['host']);
387		}
388	526	if (isset($components['port'])) {
389	46	$this->setPort($components['port']);
390		}
391	526	if (isset($components['path'])) {
392	524	$this->setPath($components['path']);
393		}
394	526	if (isset($components['query'])) {
395	46	$this->setQuery($components['query']);
396		}
397	526	if (isset($components['fragment'])) {
398	39	$this->setFragment($components['fragment']);
399		}
400		}
401		}
402

sunrise-php / http-message

Pull Request — master (#34)

Uri::withPort() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like