Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace AmpProject;

[2] Fix | Delete

[3] Fix | Delete

use AmpProject\Exception\FailedToParseUrl;

[4] Fix | Delete

[5] Fix | Delete

/**

[6] Fix | Delete

* Helper class to work with URLs.

[7] Fix | Delete

[8] Fix | Delete

* @property-read string|null $scheme

[9] Fix | Delete

* @property-read string|null $host

[10] Fix | Delete

* @property-read string|null $port

[11] Fix | Delete

* @property-read string|null $user

[12] Fix | Delete

* @property-read string|null $pass

[13] Fix | Delete

* @property-read string|null $path

[14] Fix | Delete

* @property-read string|null $query

[15] Fix | Delete

* @property-read string|null $fragment

[16] Fix | Delete

[17] Fix | Delete

* @package ampproject/amp-toolbox

[18] Fix | Delete

[19] Fix | Delete

final class Url

[20] Fix | Delete

{

[21] Fix | Delete

[22] Fix | Delete

const SCHEME = 'scheme';

[23] Fix | Delete

const HOST = 'host';

[24] Fix | Delete

const PORT = 'port';

[25] Fix | Delete

const USER = 'user';

[26] Fix | Delete

const PASS = 'pass';

[27] Fix | Delete

const PATH = 'path';

[28] Fix | Delete

const QUERY = 'query';

[29] Fix | Delete

const FRAGMENT = 'fragment';

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* Regular expression pattern used to collapse the current path ('.').

[33] Fix | Delete

[34] Fix | Delete

* @var string

[35] Fix | Delete

[36] Fix | Delete

const COLLAPSE_CURRENT_PATHS_REGEX_PATTERN = '#/\./#';

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* Regular expression pattern used to collapse a relative path ('..').

[40] Fix | Delete

[41] Fix | Delete

* @var string

[42] Fix | Delete

[43] Fix | Delete

const COLLAPSE_RELATIVE_PATHS_REGEX_PATTERN = '#(?<=/)(?!\.\./)[^/]+/\.\./#';

[44] Fix | Delete

[45] Fix | Delete

/**

[46] Fix | Delete

* Error message to use when the __get() is triggered for an unknown property.

[47] Fix | Delete

[48] Fix | Delete

* @var string

[49] Fix | Delete

[50] Fix | Delete

const PROPERTY_GETTER_ERROR_MESSAGE = 'Undefined property: AmpProject\\Url::';

[51] Fix | Delete

[52] Fix | Delete

/**

[53] Fix | Delete

* Scheme.

[54] Fix | Delete

[55] Fix | Delete

* @var string|null

[56] Fix | Delete

[57] Fix | Delete

private $scheme;

[58] Fix | Delete

[59] Fix | Delete

/**

[60] Fix | Delete

* Host.

[61] Fix | Delete

[62] Fix | Delete

* @var string|null

[63] Fix | Delete

[64] Fix | Delete

private $host;

[65] Fix | Delete

[66] Fix | Delete

/**

[67] Fix | Delete

* Port.

[68] Fix | Delete

[69] Fix | Delete

* @var string|null

[70] Fix | Delete

[71] Fix | Delete

private $port;

[72] Fix | Delete

[73] Fix | Delete

/**

[74] Fix | Delete

* User.

[75] Fix | Delete

[76] Fix | Delete

* @var string|null

[77] Fix | Delete

[78] Fix | Delete

private $user;

[79] Fix | Delete

[80] Fix | Delete

/**

[81] Fix | Delete

* Password.

[82] Fix | Delete

[83] Fix | Delete

* @var string|null

[84] Fix | Delete

[85] Fix | Delete

private $pass;

[86] Fix | Delete

[87] Fix | Delete

/**

[88] Fix | Delete

* Query string.

[89] Fix | Delete

[90] Fix | Delete

* @var string|null

[91] Fix | Delete

[92] Fix | Delete

private $query;

[93] Fix | Delete

[94] Fix | Delete

/**

[95] Fix | Delete

* Path.

[96] Fix | Delete

[97] Fix | Delete

* @var string|null

[98] Fix | Delete

[99] Fix | Delete

private $path;

[100] Fix | Delete

[101] Fix | Delete

/**

[102] Fix | Delete

* Fragment.

[103] Fix | Delete

[104] Fix | Delete

* @var string|null

[105] Fix | Delete

[106] Fix | Delete

private $fragment;

[107] Fix | Delete

[108] Fix | Delete

/**

[109] Fix | Delete

* Default URL parts to use when constructing an absolute URL out of a relative one.

[110] Fix | Delete

[111] Fix | Delete

* @var string[]

[112] Fix | Delete

[113] Fix | Delete

const URL_DEFAULT_PARTS = [

[114] Fix | Delete

self::SCHEME => 'https',

[115] Fix | Delete

self::HOST => 'example.com',

[116] Fix | Delete

self::PORT => null,

[117] Fix | Delete

self::USER => null,

[118] Fix | Delete

self::PASS => null,

[119] Fix | Delete

self::PATH => null,

[120] Fix | Delete

self::QUERY => null,

[121] Fix | Delete

self::FRAGMENT => null,

[122] Fix | Delete

];

[123] Fix | Delete

[124] Fix | Delete

/**

[125] Fix | Delete

* Url constructor.

[126] Fix | Delete

[127] Fix | Delete

* @param string|null $url URL.

[128] Fix | Delete

* @param Url|null $baseUrl Base URL.

[129] Fix | Delete

* @throws FailedToParseUrl Exception when the URL or Base URL is malformed.

[130] Fix | Delete

[131] Fix | Delete

public function __construct($url = null, Url $baseUrl = null)

[132] Fix | Delete

{

[133] Fix | Delete

$parsedUrl = [];

[134] Fix | Delete

[135] Fix | Delete

if ($url !== null) {

[136] Fix | Delete

$parsedUrl = parse_url($url);

[137] Fix | Delete

if (false === $parsedUrl) {

[138] Fix | Delete

throw FailedToParseUrl::forUrl($url);

[139] Fix | Delete

}

[140] Fix | Delete

}

[141] Fix | Delete

[142] Fix | Delete

if ($baseUrl) {

[143] Fix | Delete

if (isset($parsedUrl[self::PATH]) && 0 !== strpos($parsedUrl[self::PATH], '/')) {

[144] Fix | Delete

$root = rtrim($baseUrl->path, '/');

[145] Fix | Delete

$parsedUrl[self::PATH] = $this->unrelativizePath("{$root}/{$parsedUrl[self::PATH]}");

[146] Fix | Delete

}

[147] Fix | Delete

$parsedUrl = array_merge($baseUrl->toArray(), $parsedUrl);

[148] Fix | Delete

}

[149] Fix | Delete

[150] Fix | Delete

if ($parsedUrl) {

[151] Fix | Delete

foreach ($parsedUrl as $key => $value) {

[152] Fix | Delete

if (is_object($this) && property_exists($this, $key)) {

[153] Fix | Delete

$this->$key = $value;

[154] Fix | Delete

}

[155] Fix | Delete

}

[156] Fix | Delete

}

[157] Fix | Delete

}

[158] Fix | Delete

[159] Fix | Delete

/**

[160] Fix | Delete

* Eliminate relative segments (../ and ./) from a path.

[161] Fix | Delete

[162] Fix | Delete

* @param string $path Path with relative segments. This is not a URL, so no host and no query string.

[163] Fix | Delete

* @return string Unrelativized path.

[164] Fix | Delete

[165] Fix | Delete

private function unrelativizePath($path)

[166] Fix | Delete

{

[167] Fix | Delete

[168] Fix | Delete

// Eliminate current directory relative paths, like <foo/./bar/./baz.css> => <foo/bar/baz.css>.

[169] Fix | Delete

do {

[170] Fix | Delete

$path = preg_replace(

[171] Fix | Delete

self::COLLAPSE_CURRENT_PATHS_REGEX_PATTERN,

[172] Fix | Delete

'/',

[173] Fix | Delete

$path,

[174] Fix | Delete

-1,

[175] Fix | Delete

$count

[176] Fix | Delete

);

[177] Fix | Delete

} while (0 !== $count);

[178] Fix | Delete

[179] Fix | Delete

// Collapse relative paths, like <foo/bar/../../baz.css> => <baz.css>.

[180] Fix | Delete

do {

[181] Fix | Delete

$path = preg_replace(

[182] Fix | Delete

self::COLLAPSE_RELATIVE_PATHS_REGEX_PATTERN,

[183] Fix | Delete

'',

[184] Fix | Delete

$path,

[185] Fix | Delete

[186] Fix | Delete

$count

[187] Fix | Delete

);

[188] Fix | Delete

} while (0 !== $count);

[189] Fix | Delete

[190] Fix | Delete

return $path;

[191] Fix | Delete

}

[192] Fix | Delete

[193] Fix | Delete

/**

[194] Fix | Delete

* Check whether the URL is a valid image source URL.

[195] Fix | Delete

[196] Fix | Delete

* @return bool Whether the src string is a valid image source URL.

[197] Fix | Delete

[198] Fix | Delete

public function isValidNonDataUrl()

[199] Fix | Delete

{

[200] Fix | Delete

// Bail early on 'data:' assets.

[201] Fix | Delete

if ($this->scheme === 'data') {

[202] Fix | Delete

return false;

[203] Fix | Delete

}

[204] Fix | Delete

[205] Fix | Delete

// @TODO: This probably needs additional logic.

[206] Fix | Delete

[207] Fix | Delete

$parts = array_merge(self::URL_DEFAULT_PARTS, $this->toArray(true));

[208] Fix | Delete

[209] Fix | Delete

return (bool)filter_var(self::toString($parts), FILTER_VALIDATE_URL);

[210] Fix | Delete

}

[211] Fix | Delete

[212] Fix | Delete

/**

[213] Fix | Delete

* Get the URL parts as an associative array.

[214] Fix | Delete

[215] Fix | Delete

* @param bool $sparse Whether to only include parts with non-empty values.

[216] Fix | Delete

[217] Fix | Delete

* @return array Associative array with URL parts.

[218] Fix | Delete

[219] Fix | Delete

public function toArray($sparse = false)

[220] Fix | Delete

{

[221] Fix | Delete

$array = [

[222] Fix | Delete

self::SCHEME => $this->scheme,

[223] Fix | Delete

self::HOST => $this->host,

[224] Fix | Delete

self::PORT => $this->port,

[225] Fix | Delete

self::USER => $this->user,

[226] Fix | Delete

self::PASS => $this->pass,

[227] Fix | Delete

self::PATH => $this->path,

[228] Fix | Delete

self::QUERY => $this->query,

[229] Fix | Delete

self::FRAGMENT => $this->fragment,

[230] Fix | Delete

];

[231] Fix | Delete

[232] Fix | Delete

return $sparse ? array_filter($array) : $array;

[233] Fix | Delete

}

[234] Fix | Delete

[235] Fix | Delete

/**

[236] Fix | Delete

* Serialize to string.

[237] Fix | Delete

[238] Fix | Delete

* @return string URL.

[239] Fix | Delete

[240] Fix | Delete

public function __toString()

[241] Fix | Delete

{

[242] Fix | Delete

return self::toString($this->toArray());

[243] Fix | Delete

}

[244] Fix | Delete

[245] Fix | Delete

/**

[246] Fix | Delete

* Return a provided URL parsed into parts as an assembled string.

[247] Fix | Delete

[248] Fix | Delete

* @param array $parts Parts of the URL to assemble.

[249] Fix | Delete

* @return string Assembled URL string.

[250] Fix | Delete

[251] Fix | Delete

public static function toString($parts)

[252] Fix | Delete

{

[253] Fix | Delete

$url = ! empty($parts[self::SCHEME]) ? "{$parts[self::SCHEME]}://" : '//';

[254] Fix | Delete

[255] Fix | Delete

if (! empty($parts[self::USER])) {

[256] Fix | Delete

$url .= "{$parts[self::USER]}";

[257] Fix | Delete

if (! empty($parts[self::PASS])) {

[258] Fix | Delete

$url .= ":{$parts[self::PASS]}";

[259] Fix | Delete

}

[260] Fix | Delete

$url .= '@';

[261] Fix | Delete

}

[262] Fix | Delete

[263] Fix | Delete

$url .= ! empty($parts[self::HOST]) ? "{$parts[self::HOST]}" : 'localhost';

[264] Fix | Delete

[265] Fix | Delete

if (! empty($parts[self::PORT])) {

[266] Fix | Delete

$url .= ":{$parts[self::PORT]}";

[267] Fix | Delete

}

[268] Fix | Delete

[269] Fix | Delete

$url .= ! empty($parts[self::PATH]) ? "{$parts[self::PATH]}" : '/';

[270] Fix | Delete

[271] Fix | Delete

if (! empty($parts[self::QUERY])) {

[272] Fix | Delete

$url .= "?{$parts[self::QUERY]}";

[273] Fix | Delete

}

[274] Fix | Delete

[275] Fix | Delete

if (! empty($parts[self::FRAGMENT])) {

[276] Fix | Delete

$url .= "#{$parts[self::FRAGMENT]}";

[277] Fix | Delete

}

[278] Fix | Delete

[279] Fix | Delete

return $url;

[280] Fix | Delete

}

[281] Fix | Delete

[282] Fix | Delete

/**

[283] Fix | Delete

* Magic getter to return the individual parts.

[284] Fix | Delete

[285] Fix | Delete

* @param string $name Name of the part to return.

[286] Fix | Delete

* @return string|null Part string or null if it was not found during parsing.

[287] Fix | Delete

[288] Fix | Delete

public function __get($name)

[289] Fix | Delete

{

[290] Fix | Delete

if (array_key_exists($name, self::URL_DEFAULT_PARTS)) {

[291] Fix | Delete

return $this->$name;

[292] Fix | Delete

}

[293] Fix | Delete

[294] Fix | Delete

// Mimic regular PHP behavior for missing notices.

[295] Fix | Delete

trigger_error(self::PROPERTY_GETTER_ERROR_MESSAGE . $name, E_USER_NOTICE);

[296] Fix | Delete

return null;

[297] Fix | Delete

}

[298] Fix | Delete

}

[299] Fix | Delete

[300] Fix | Delete