]>
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, '/') ? '/' : '');
67 * URL representation and cleanup utilities
70 * scheme://[username:password@]host[:port][/path][?query][#fragment]
73 * http://username:password@hostname:9090/path?arg1=value1&arg2=value2#anchor
74 * https://host.name.tld
75 * https://h2.g2/faq/?vendor=hitchhiker&item=guide&dest=galaxy#answer
77 * @see http://www.faqs.org/rfcs/rfc3986.html
81 private static $annoyingQueryParams = array(
93 // Google Analytics & FeedProxy
100 private static $annoyingFragments = array(
109 * URL parts represented as an array
111 * @see http://php.net/parse_url
116 * Parses a string containing a URL
118 * @param string $url a string containing a URL
120 public function __construct($url)
122 $url = self::cleanupUnparsedUrl(trim($url));
123 $this->parts = parse_url($url);
125 if (!empty($url) && empty($this->parts['scheme'])) {
126 $this->parts['scheme'] = 'http';
131 * Clean up URL before it's parsed.
132 * ie. handle urlencode, url prefixes, etc.
134 * @param string $url URL to clean.
136 * @return string cleaned URL.
138 protected static function cleanupUnparsedUrl($url)
140 return self::removeFirefoxAboutReader($url);
144 * Remove Firefox Reader prefix if it's present.
146 * @param string $input url
148 * @return string cleaned url
150 protected static function removeFirefoxAboutReader($input)
152 $firefoxPrefix = 'about://reader?url=';
153 if (startsWith($input, $firefoxPrefix)) {
154 return urldecode(ltrim($input, $firefoxPrefix));
160 * Returns a string representation of this URL
162 public function toString()
164 return unparse_url($this->parts);
168 * Removes undesired query parameters
170 protected function cleanupQuery()
172 if (! isset($this->parts['query'])) {
176 $queryParams = explode('&', $this->parts['query']);
178 foreach (self::$annoyingQueryParams as $annoying) {
179 foreach ($queryParams as $param) {
180 if (startsWith($param, $annoying)) {
181 $queryParams = array_diff($queryParams, array($param));
187 if (count($queryParams) == 0) {
188 unset($this->parts['query']);
192 $this->parts['query'] = implode('&', $queryParams);
196 * Removes undesired fragments
198 protected function cleanupFragment()
200 if (! isset($this->parts['fragment'])) {
204 foreach (self::$annoyingFragments as $annoying) {
205 if (startsWith($this->parts['fragment'], $annoying)) {
206 unset($this->parts['fragment']);
213 * Removes undesired query parameters and fragments
215 * @return string the string representation of this URL after cleanup
217 public function cleanup()
219 $this->cleanupQuery();
220 $this->cleanupFragment();
221 return $this->toString();
225 * Converts an URL with an International Domain Name host to a ASCII one.
226 * This requires PHP-intl. If it's not available, just returns this->cleanup().
228 * @return string converted cleaned up URL.
230 public function idnToAscii()
232 $out = $this->cleanup();
233 if (! function_exists('idn_to_ascii') || ! isset($this->parts['host'])) {
236 $asciiHost = idn_to_ascii($this->parts['host']);
237 return str_replace($this->parts['host'], $asciiHost, $out);
243 * @return string the URL scheme or false if none is provided.
245 public function getScheme() {
246 if (!isset($this->parts['scheme'])) {
249 return $this->parts['scheme'];
255 * @return string the URL host or false if none is provided.
257 public function getHost() {
258 if (empty($this->parts['host'])) {
261 return $this->parts['host'];
265 * Test if the Url is an HTTP one.
267 * @return true is HTTP, false otherwise.
269 public function isHttp() {
270 return strpos(strtolower($this->parts['scheme']), 'http') !== false;