]>
git.immae.eu Git - github/shaarli/Shaarli.git/blob - application/Url.php
3 * Converts an array-represented URL to a string
5 * Source: http://php.net/manual/en/function.parse-url.php#106731
7 * @see http://php.net/manual/en/function.parse-url.php
9 * @param array $parsedUrl an array-represented URL
11 * @return string the string representation of the URL
13 function unparse_url($parsedUrl)
15 $scheme = isset($parsedUrl['scheme']) ? $parsedUrl['scheme'].'://' : '';
16 $host = isset($parsedUrl['host']) ? $parsedUrl['host'] : '';
17 $port = isset($parsedUrl['port']) ? ':'.$parsedUrl['port'] : '';
18 $user = isset($parsedUrl['user']) ? $parsedUrl['user'] : '';
19 $pass = isset($parsedUrl['pass']) ? ':'.$parsedUrl['pass'] : '';
20 $pass = ($user || $pass) ? "$pass@" : '';
21 $path = isset($parsedUrl['path']) ? $parsedUrl['path'] : '';
22 $query = isset($parsedUrl['query']) ? '?'.$parsedUrl['query'] : '';
23 $fragment = isset($parsedUrl['fragment']) ? '#'.$parsedUrl['fragment'] : '';
25 return "$scheme$user$pass$host$port$path$query$fragment";
29 * Removes undesired query parameters and fragments
31 * @param string url Url to be cleaned
33 * @return string the string representation of this URL after cleanup
35 function cleanup_url($url)
37 $obj_url = new Url($url);
38 return $obj_url->cleanup();
44 * @param string url Url for which the scheme is requested
46 * @return mixed the URL scheme or false if none is provided.
48 function get_url_scheme($url)
50 $obj_url = new Url($url);
51 return $obj_url->getScheme();
55 * Adds a trailing slash at the end of URL if necessary.
57 * @param string $url URL to check/edit.
59 * @return string $url URL with a end trailing slash.
61 function add_trailing_slash($url)
63 return $url . (!endsWith($url, '/') ? '/' : '');
66 * Converts an URL with an IDN host to a ASCII one.
68 * @param string $url Input URL.
70 * @return string converted URL.
72 function url_with_idn_to_ascii($url)
74 $parts = parse_url($url);
75 $parts['host'] = idn_to_ascii($parts['host']);
77 $httpUrl = new \http\Url($parts);
78 return $httpUrl->toString();
81 * URL representation and cleanup utilities
84 * scheme://[username:password@]host[:port][/path][?query][#fragment]
87 * http://username:password@hostname:9090/path?arg1=value1&arg2=value2#anchor
88 * https://host.name.tld
89 * https://h2.g2/faq/?vendor=hitchhiker&item=guide&dest=galaxy#answer
91 * @see http://www.faqs.org/rfcs/rfc3986.html
95 private static $annoyingQueryParams = array(
107 // Google Analytics & FeedProxy
114 private static $annoyingFragments = array(
123 * URL parts represented as an array
125 * @see http://php.net/parse_url
130 * Parses a string containing a URL
132 * @param string $url a string containing a URL
134 public function __construct($url)
136 $url = self::cleanupUnparsedUrl(trim($url));
137 $this->parts = parse_url($url);
139 if (!empty($url) && empty($this->parts['scheme'])) {
140 $this->parts['scheme'] = 'http';
145 * Clean up URL before it's parsed.
146 * ie. handle urlencode, url prefixes, etc.
148 * @param string $url URL to clean.
150 * @return string cleaned URL.
152 protected static function cleanupUnparsedUrl($url)
154 return self::removeFirefoxAboutReader($url);
158 * Remove Firefox Reader prefix if it's present.
160 * @param string $input url
162 * @return string cleaned url
164 protected static function removeFirefoxAboutReader($input)
166 $firefoxPrefix = 'about://reader?url=';
167 if (startsWith($input, $firefoxPrefix)) {
168 return urldecode(ltrim($input, $firefoxPrefix));
174 * Returns a string representation of this URL
176 public function toString()
178 return unparse_url($this->parts);
182 * Removes undesired query parameters
184 protected function cleanupQuery()
186 if (! isset($this->parts['query'])) {
190 $queryParams = explode('&', $this->parts['query']);
192 foreach (self::$annoyingQueryParams as $annoying) {
193 foreach ($queryParams as $param) {
194 if (startsWith($param, $annoying)) {
195 $queryParams = array_diff($queryParams, array($param));
201 if (count($queryParams) == 0) {
202 unset($this->parts['query']);
206 $this->parts['query'] = implode('&', $queryParams);
210 * Removes undesired fragments
212 protected function cleanupFragment()
214 if (! isset($this->parts['fragment'])) {
218 foreach (self::$annoyingFragments as $annoying) {
219 if (startsWith($this->parts['fragment'], $annoying)) {
220 unset($this->parts['fragment']);
227 * Removes undesired query parameters and fragments
229 * @return string the string representation of this URL after cleanup
231 public function cleanup()
233 $this->cleanupQuery();
234 $this->cleanupFragment();
235 return $this->toString();
239 * Converts an URL with an International Domain Name host to a ASCII one.
240 * This requires PHP-intl. If it's not available, just returns this->cleanup().
242 * @return string converted cleaned up URL.
244 public function idnToAscii()
246 $out = $this->cleanup();
247 if (! function_exists('idn_to_ascii') || ! isset($this->parts['host'])) {
250 $asciiHost = idn_to_ascii($this->parts['host']);
251 return str_replace($this->parts['host'], $asciiHost, $out);
257 * @return string the URL scheme or false if none is provided.
259 public function getScheme() {
260 if (!isset($this->parts['scheme'])) {
263 return $this->parts['scheme'];
269 * @return string the URL host or false if none is provided.
271 public function getHost() {
272 if (empty($this->parts['host'])) {
275 return $this->parts['host'];
279 * Test if the Url is an HTTP one.
281 * @return true is HTTP, false otherwise.
283 public function isHttp() {
284 return strpos(strtolower($this->parts['scheme']), 'http') !== false;