]>
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
103 private static $annoyingFragments = array(
112 * URL parts represented as an array
114 * @see http://php.net/parse_url
119 * Parses a string containing a URL
121 * @param string $url a string containing a URL
123 public function __construct($url)
125 $url = self::cleanupUnparsedUrl(trim($url));
126 $this->parts = parse_url($url);
128 if (!empty($url) && empty($this->parts['scheme'])) {
129 $this->parts['scheme'] = 'http';
134 * Clean up URL before it's parsed.
135 * ie. handle urlencode, url prefixes, etc.
137 * @param string $url URL to clean.
139 * @return string cleaned URL.
141 protected static function cleanupUnparsedUrl($url)
143 return self::removeFirefoxAboutReader($url);
147 * Remove Firefox Reader prefix if it's present.
149 * @param string $input url
151 * @return string cleaned url
153 protected static function removeFirefoxAboutReader($input)
155 $firefoxPrefix = 'about://reader?url=';
156 if (startsWith($input, $firefoxPrefix)) {
157 return urldecode(ltrim($input, $firefoxPrefix));
163 * Returns a string representation of this URL
165 public function toString()
167 return unparse_url($this->parts);
171 * Removes undesired query parameters
173 protected function cleanupQuery()
175 if (! isset($this->parts['query'])) {
179 $queryParams = explode('&', $this->parts['query']);
181 foreach (self::$annoyingQueryParams as $annoying) {
182 foreach ($queryParams as $param) {
183 if (startsWith($param, $annoying)) {
184 $queryParams = array_diff($queryParams, array($param));
190 if (count($queryParams) == 0) {
191 unset($this->parts['query']);
195 $this->parts['query'] = implode('&', $queryParams);
199 * Removes undesired fragments
201 protected function cleanupFragment()
203 if (! isset($this->parts['fragment'])) {
207 foreach (self::$annoyingFragments as $annoying) {
208 if (startsWith($this->parts['fragment'], $annoying)) {
209 unset($this->parts['fragment']);
216 * Removes undesired query parameters and fragments
218 * @return string the string representation of this URL after cleanup
220 public function cleanup()
222 $this->cleanupQuery();
223 $this->cleanupFragment();
224 return $this->toString();
228 * Converts an URL with an International Domain Name host to a ASCII one.
229 * This requires PHP-intl. If it's not available, just returns this->cleanup().
231 * @return string converted cleaned up URL.
233 public function idnToAscii()
235 $out = $this->cleanup();
236 if (! function_exists('idn_to_ascii') || ! isset($this->parts['host'])) {
239 $asciiHost = idn_to_ascii($this->parts['host']);
240 return str_replace($this->parts['host'], $asciiHost, $out);
246 * @return string the URL scheme or false if none is provided.
248 public function getScheme() {
249 if (!isset($this->parts['scheme'])) {
252 return $this->parts['scheme'];
258 * @return string the URL host or false if none is provided.
260 public function getHost() {
261 if (empty($this->parts['host'])) {
264 return $this->parts['host'];
268 * Test if the Url is an HTTP one.
270 * @return true is HTTP, false otherwise.
272 public function isHttp() {
273 return strpos(strtolower($this->parts['scheme']), 'http') !== false;