3 * @file src/Util/Network.php
5 namespace Friendica\Util;
8 use Friendica\Core\Addon;
9 use Friendica\Core\L10n;
10 use Friendica\Core\System;
11 use Friendica\Core\Config;
12 use Friendica\Network\Probe;
13 use Friendica\Object\Image;
14 use Friendica\Util\XML;
23 * If binary flag is true, return binary results.
24 * Set the cookiejar argument to a string (e.g. "/tmp/friendica-cookies.txt")
25 * to preserve cookies from one request to the next.
27 * @param string $url URL to fetch
28 * @param boolean $binary default false
29 * TRUE if asked to return binary results (file download)
30 * @param integer $redirects The recursion counter for internal use - default 0
31 * @param integer $timeout Timeout in seconds, default system config value or 60 seconds
32 * @param string $accept_content supply Accept: header with 'accept_content' as the value
33 * @param string $cookiejar Path to cookie jar file
35 * @return string The fetched content
37 public static function fetchUrl($url, $binary = false, &$redirects = 0, $timeout = 0, $accept_content = null, $cookiejar = 0)
44 'accept_content'=>$accept_content,
45 'cookiejar'=>$cookiejar
53 * @brief fetches an URL.
55 * @param string $url URL to fetch
56 * @param boolean $binary default false
57 * TRUE if asked to return binary results (file download)
58 * @param int $redirects The recursion counter for internal use - default 0
59 * @param array $opts (optional parameters) assoziative array with:
60 * 'accept_content' => supply Accept: header with 'accept_content' as the value
61 * 'timeout' => int Timeout in seconds, default system config value or 60 seconds
62 * 'http_auth' => username:password
63 * 'novalidate' => do not validate SSL certs, default is to validate using our CA list
64 * 'nobody' => only return the header
65 * 'cookiejar' => path to cookie jar file
67 * @return array an assoziative array with:
68 * int 'return_code' => HTTP return code or 0 if timeout or failure
69 * boolean 'success' => boolean true (if HTTP 2xx result) or false
70 * string 'redirect_url' => in case of redirect, content was finally retrieved from this URL
71 * string 'header' => HTTP headers
72 * string 'body' => fetched content
74 public static function curl($url, $binary = false, &$redirects = 0, $opts = [])
76 $ret = ['return_code' => 0, 'success' => false, 'header' => '', 'info' => '', 'body' => ''];
78 $stamp1 = microtime(true);
82 if (self::isUrlBlocked($url)) {
83 logger('domain of ' . $url . ' is blocked', LOGGER_DATA);
87 $ch = @curl_init($url);
89 if (($redirects > 8) || (!$ch)) {
93 @curl_setopt($ch, CURLOPT_HEADER, true);
95 if (x($opts, "cookiejar")) {
96 curl_setopt($ch, CURLOPT_COOKIEJAR, $opts["cookiejar"]);
97 curl_setopt($ch, CURLOPT_COOKIEFILE, $opts["cookiejar"]);
100 // These settings aren't needed. We're following the location already.
101 // @curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
102 // @curl_setopt($ch, CURLOPT_MAXREDIRS, 5);
104 if (x($opts, 'accept_content')) {
108 ['Accept: ' . $opts['accept_content']]
112 @curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
113 @curl_setopt($ch, CURLOPT_USERAGENT, $a->get_useragent());
115 $range = intval(Config::get('system', 'curl_range_bytes', 0));
118 @curl_setopt($ch, CURLOPT_RANGE, '0-' . $range);
121 // Without this setting it seems as if some webservers send compressed content
122 // This seems to confuse curl so that it shows this uncompressed.
123 /// @todo We could possibly set this value to "gzip" or something similar
124 curl_setopt($ch, CURLOPT_ENCODING, '');
126 if (x($opts, 'headers')) {
127 @curl_setopt($ch, CURLOPT_HTTPHEADER, $opts['headers']);
130 if (x($opts, 'nobody')) {
131 @curl_setopt($ch, CURLOPT_NOBODY, $opts['nobody']);
134 if (x($opts, 'timeout')) {
135 @curl_setopt($ch, CURLOPT_TIMEOUT, $opts['timeout']);
137 $curl_time = Config::get('system', 'curl_timeout', 60);
138 @curl_setopt($ch, CURLOPT_TIMEOUT, intval($curl_time));
141 // by default we will allow self-signed certs
142 // but you can override this
144 $check_cert = Config::get('system', 'verifyssl');
145 @curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, (($check_cert) ? true : false));
148 @curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
151 $proxy = Config::get('system', 'proxy');
153 if (strlen($proxy)) {
154 @curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, 1);
155 @curl_setopt($ch, CURLOPT_PROXY, $proxy);
156 $proxyuser = @Config::get('system', 'proxyuser');
158 if (strlen($proxyuser)) {
159 @curl_setopt($ch, CURLOPT_PROXYUSERPWD, $proxyuser);
163 if (Config::get('system', 'ipv4_resolve', false)) {
164 curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
168 @curl_setopt($ch, CURLOPT_BINARYTRANSFER, 1);
171 $a->set_curl_code(0);
173 // don't let curl abort the entire application
174 // if it throws any errors.
176 $s = @curl_exec($ch);
177 $curl_info = @curl_getinfo($ch);
179 // Special treatment for HTTP Code 416
180 // See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/416
181 if (($curl_info['http_code'] == 416) && ($range > 0)) {
182 @curl_setopt($ch, CURLOPT_RANGE, '');
183 $s = @curl_exec($ch);
184 $curl_info = @curl_getinfo($ch);
187 if (curl_errno($ch) !== CURLE_OK) {
188 logger('error fetching ' . $url . ': ' . curl_error($ch), LOGGER_NORMAL);
191 $ret['errno'] = curl_errno($ch);
194 $ret['info'] = $curl_info;
196 $http_code = $curl_info['http_code'];
198 logger($url . ': ' . $http_code . " " . $s, LOGGER_DATA);
201 // Pull out multiple headers, e.g. proxy and continuation headers
202 // allow for HTTP/2.x without fixing code
204 while (preg_match('/^HTTP\/[1-2].+? [1-5][0-9][0-9]/', $base)) {
205 $chunk = substr($base, 0, strpos($base, "\r\n\r\n") + 4);
207 $base = substr($base, strlen($chunk));
210 $a->set_curl_code($http_code);
211 $a->set_curl_content_type($curl_info['content_type']);
212 $a->set_curl_headers($header);
214 if ($http_code == 301 || $http_code == 302 || $http_code == 303 || $http_code == 307) {
215 $new_location_info = @parse_url($curl_info['redirect_url']);
216 $old_location_info = @parse_url($curl_info['url']);
218 $newurl = $curl_info['redirect_url'];
220 if (($new_location_info['path'] == '') && ( $new_location_info['host'] != '')) {
221 $newurl = $new_location_info['scheme'] . '://' . $new_location_info['host'] . $old_location_info['path'];
226 if (preg_match('/(Location:|URI:)(.*?)\n/i', $header, $matches)) {
227 $newurl = trim(array_pop($matches));
229 if (strpos($newurl, '/') === 0) {
230 $newurl = $old_location_info["scheme"]."://".$old_location_info["host"].$newurl;
233 if (filter_var($newurl, FILTER_VALIDATE_URL)) {
236 return self::curl($newurl, $binary, $redirects, $opts);
240 $a->set_curl_code($http_code);
241 $a->set_curl_content_type($curl_info['content_type']);
243 $rc = intval($http_code);
244 $ret['return_code'] = $rc;
245 $ret['success'] = (($rc >= 200 && $rc <= 299) ? true : false);
246 $ret['redirect_url'] = $url;
248 if (!$ret['success']) {
249 $ret['error'] = curl_error($ch);
250 $ret['debug'] = $curl_info;
251 logger('error: '.$url.': '.$ret['return_code'].' - '.$ret['error'], LOGGER_DEBUG);
252 logger('debug: '.print_r($curl_info, true), LOGGER_DATA);
255 $ret['body'] = substr($s, strlen($header));
256 $ret['header'] = $header;
258 if (x($opts, 'debug')) {
259 $ret['debug'] = $curl_info;
264 $a->save_timestamp($stamp1, 'network');
270 * @brief Send POST request to $url
272 * @param string $url URL to post
273 * @param mixed $params array of POST variables
274 * @param string $headers HTTP headers
275 * @param integer $redirects Recursion counter for internal use - default = 0
276 * @param integer $timeout The timeout in seconds, default system config value or 60 seconds
278 * @return string The content
280 public static function post($url, $params, $headers = null, &$redirects = 0, $timeout = 0)
282 $stamp1 = microtime(true);
284 if (self::isUrlBlocked($url)) {
285 logger('post_url: domain of ' . $url . ' is blocked', LOGGER_DATA);
290 $ch = curl_init($url);
292 if (($redirects > 8) || (!$ch)) {
296 logger('post_url: start ' . $url, LOGGER_DATA);
298 curl_setopt($ch, CURLOPT_HEADER, true);
299 curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
300 curl_setopt($ch, CURLOPT_POST, 1);
301 curl_setopt($ch, CURLOPT_POSTFIELDS, $params);
302 curl_setopt($ch, CURLOPT_USERAGENT, $a->get_useragent());
304 if (Config::get('system', 'ipv4_resolve', false)) {
305 curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
308 if (intval($timeout)) {
309 curl_setopt($ch, CURLOPT_TIMEOUT, $timeout);
311 $curl_time = Config::get('system', 'curl_timeout', 60);
312 curl_setopt($ch, CURLOPT_TIMEOUT, intval($curl_time));
315 if (defined('LIGHTTPD')) {
316 if (!is_array($headers)) {
317 $headers = ['Expect:'];
319 if (!in_array('Expect:', $headers)) {
320 array_push($headers, 'Expect:');
326 curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
329 $check_cert = Config::get('system', 'verifyssl');
330 curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, (($check_cert) ? true : false));
333 @curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
336 $proxy = Config::get('system', 'proxy');
338 if (strlen($proxy)) {
339 curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, 1);
340 curl_setopt($ch, CURLOPT_PROXY, $proxy);
341 $proxyuser = Config::get('system', 'proxyuser');
342 if (strlen($proxyuser)) {
343 curl_setopt($ch, CURLOPT_PROXYUSERPWD, $proxyuser);
347 $a->set_curl_code(0);
349 // don't let curl abort the entire application
350 // if it throws any errors.
352 $s = @curl_exec($ch);
355 $curl_info = curl_getinfo($ch);
356 $http_code = $curl_info['http_code'];
358 logger('post_url: result ' . $http_code . ' - ' . $url, LOGGER_DATA);
362 // Pull out multiple headers, e.g. proxy and continuation headers
363 // allow for HTTP/2.x without fixing code
365 while (preg_match('/^HTTP\/[1-2].+? [1-5][0-9][0-9]/', $base)) {
366 $chunk = substr($base, 0, strpos($base, "\r\n\r\n") + 4);
368 $base = substr($base, strlen($chunk));
371 if ($http_code == 301 || $http_code == 302 || $http_code == 303 || $http_code == 307) {
373 preg_match('/(Location:|URI:)(.*?)\n/', $header, $matches);
374 $newurl = trim(array_pop($matches));
376 if (strpos($newurl, '/') === 0) {
377 $newurl = $old_location_info["scheme"] . "://" . $old_location_info["host"] . $newurl;
380 if (filter_var($newurl, FILTER_VALIDATE_URL)) {
382 logger('post_url: redirect ' . $url . ' to ' . $newurl);
383 return self::post($newurl, $params, $headers, $redirects, $timeout);
387 $a->set_curl_code($http_code);
389 $body = substr($s, strlen($header));
391 $a->set_curl_headers($header);
395 $a->save_timestamp($stamp1, 'network');
397 logger('post_url: end ' . $url, LOGGER_DATA);
403 * @brief Check URL to see if it's real
405 * Take a URL from the wild, prepend http:// if necessary
406 * and check DNS to see if it's real (or check if is a valid IP address)
408 * @param string $url The URL to be validated
409 * @return string|boolean The actual working URL, false else
411 public static function isUrlValid($url)
413 if (Config::get('system', 'disable_url_validation')) {
417 // no naked subdomains (allow localhost for tests)
418 if (strpos($url, '.') === false && strpos($url, '/localhost/') === false) {
422 if (substr($url, 0, 4) != 'http') {
423 $url = 'http://' . $url;
426 /// @TODO Really suppress function outcomes? Why not find them + debug them?
427 $h = @parse_url($url);
429 if ((is_array($h)) && (@dns_get_record($h['host'], DNS_A + DNS_CNAME + DNS_PTR) || filter_var($h['host'], FILTER_VALIDATE_IP) )) {
437 * @brief Checks that email is an actual resolvable internet address
439 * @param string $addr The email address
440 * @return boolean True if it's a valid email address, false if it's not
442 public static function isEmailDomainValid($addr)
444 if (Config::get('system', 'disable_email_validation')) {
448 if (! strpos($addr, '@')) {
452 $h = substr($addr, strpos($addr, '@') + 1);
454 if (($h) && (dns_get_record($h, DNS_A + DNS_CNAME + DNS_PTR + DNS_MX) || filter_var($h, FILTER_VALIDATE_IP) )) {
461 * @brief Check if URL is allowed
463 * Check $url against our list of allowed sites,
464 * wildcards allowed. If allowed_sites is unset return true;
466 * @param string $url URL which get tested
467 * @return boolean True if url is allowed otherwise return false
469 public static function isUrlAllowed($url)
471 $h = @parse_url($url);
477 $str_allowed = Config::get('system', 'allowed_sites');
478 if (! $str_allowed) {
484 $host = strtolower($h['host']);
486 // always allow our own site
487 if ($host == strtolower($_SERVER['SERVER_NAME'])) {
491 $fnmatch = function_exists('fnmatch');
492 $allowed = explode(',', $str_allowed);
494 if (count($allowed)) {
495 foreach ($allowed as $a) {
496 $pat = strtolower(trim($a));
497 if (($fnmatch && fnmatch($pat, $host)) || ($pat == $host)) {
507 * Checks if the provided url domain is on the domain blocklist.
508 * Returns true if it is or malformed URL, false if not.
510 * @param string $url The url to check the domain from
514 public static function isUrlBlocked($url)
516 $h = @parse_url($url);
522 $domain_blocklist = Config::get('system', 'blocklist', []);
523 if (! $domain_blocklist) {
527 $host = strtolower($h['host']);
529 foreach ($domain_blocklist as $domain_block) {
530 if (strtolower($domain_block['domain']) == $host) {
539 * @brief Check if email address is allowed to register here.
541 * Compare against our list (wildcards allowed).
543 * @param string $email email address
544 * @return boolean False if not allowed, true if allowed
545 * or if allowed list is not configured
547 public static function isEmailDomainAllowed($email)
549 $domain = strtolower(substr($email, strpos($email, '@') + 1));
554 $str_allowed = Config::get('system', 'allowed_email', '');
555 if (!x($str_allowed)) {
559 $allowed = explode(',', $str_allowed);
561 return self::isDomainAllowed($domain, $allowed);
565 * Checks for the existence of a domain in a domain list
567 * @brief Checks for the existence of a domain in a domain list
568 * @param string $domain
569 * @param array $domain_list
572 public static function isDomainAllowed($domain, array $domain_list)
576 foreach ($domain_list as $item) {
577 $pat = strtolower(trim($item));
578 if (fnmatch($pat, $domain) || ($pat == $domain)) {
587 public static function lookupAvatarByEmail($email)
589 $avatar['size'] = 175;
590 $avatar['email'] = $email;
592 $avatar['success'] = false;
594 Addon::callHooks('avatar_lookup', $avatar);
596 if (! $avatar['success']) {
597 $avatar['url'] = System::baseUrl() . '/images/person-175.jpg';
600 logger('Avatar: ' . $avatar['email'] . ' ' . $avatar['url'], LOGGER_DEBUG);
601 return $avatar['url'];
605 * @brief Remove Google Analytics and other tracking platforms params from URL
607 * @param string $url Any user-submitted URL that may contain tracking params
608 * @return string The same URL stripped of tracking parameters
610 public static function stripTrackingQueryParams($url)
612 $urldata = parse_url($url);
613 if (is_string($urldata["query"])) {
614 $query = $urldata["query"];
615 parse_str($query, $querydata);
617 if (is_array($querydata)) {
618 foreach ($querydata as $param => $value) {
622 "utm_source", "utm_medium", "utm_term", "utm_content", "utm_campaign",
623 "wt_mc", "pk_campaign", "pk_kwd", "mc_cid", "mc_eid",
624 "fb_action_ids", "fb_action_types", "fb_ref",
626 "woo_campaign", "woo_source", "woo_medium", "woo_content", "woo_term"]
629 $pair = $param . "=" . urlencode($value);
630 $url = str_replace($pair, "", $url);
632 // Second try: if the url isn't encoded completely
633 $pair = $param . "=" . str_replace(" ", "+", $value);
634 $url = str_replace($pair, "", $url);
636 // Third try: Maybey the url isn't encoded at all
637 $pair = $param . "=" . $value;
638 $url = str_replace($pair, "", $url);
640 $url = str_replace(["?&", "&&"], ["?", ""], $url);
645 if (substr($url, -1, 1) == "?") {
646 $url = substr($url, 0, -1);
654 * @brief Returns the original URL of the provided URL
656 * This function strips tracking query params and follows redirections, either
657 * through HTTP code or meta refresh tags. Stops after 10 redirections.
659 * @todo Remove the $fetchbody parameter that generates an extraneous HEAD request
661 * @see ParseUrl::getSiteinfo
663 * @param string $url A user-submitted URL
664 * @param int $depth The current redirection recursion level (internal)
665 * @param bool $fetchbody Wether to fetch the body or not after the HEAD requests
666 * @return string A canonical URL
668 public static function finalUrl($url, $depth = 1, $fetchbody = false)
672 $url = self::stripTrackingQueryParams($url);
678 $url = trim($url, "'");
680 $stamp1 = microtime(true);
683 curl_setopt($ch, CURLOPT_URL, $url);
684 curl_setopt($ch, CURLOPT_HEADER, 1);
685 curl_setopt($ch, CURLOPT_NOBODY, 1);
686 curl_setopt($ch, CURLOPT_TIMEOUT, 10);
687 curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
688 curl_setopt($ch, CURLOPT_USERAGENT, $a->get_useragent());
691 $curl_info = @curl_getinfo($ch);
692 $http_code = $curl_info['http_code'];
695 $a->save_timestamp($stamp1, "network");
697 if ($http_code == 0) {
701 if ((($curl_info['http_code'] == "301") || ($curl_info['http_code'] == "302"))
702 && (($curl_info['redirect_url'] != "") || ($curl_info['location'] != ""))
704 if ($curl_info['redirect_url'] != "") {
705 return(self::finalUrl($curl_info['redirect_url'], ++$depth, $fetchbody));
707 return(self::finalUrl($curl_info['location'], ++$depth, $fetchbody));
711 // Check for redirects in the meta elements of the body if there are no redirects in the header.
713 return(self::finalUrl($url, ++$depth, true));
716 // if the file is too large then exit
717 if ($curl_info["download_content_length"] > 1000000) {
721 // if it isn't a HTML file then exit
722 if (($curl_info["content_type"] != "") && !strstr(strtolower($curl_info["content_type"]), "html")) {
726 $stamp1 = microtime(true);
729 curl_setopt($ch, CURLOPT_URL, $url);
730 curl_setopt($ch, CURLOPT_HEADER, 0);
731 curl_setopt($ch, CURLOPT_NOBODY, 0);
732 curl_setopt($ch, CURLOPT_TIMEOUT, 10);
733 curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
734 curl_setopt($ch, CURLOPT_USERAGENT, $a->get_useragent());
736 $body = curl_exec($ch);
739 $a->save_timestamp($stamp1, "network");
741 if (trim($body) == "") {
745 // Check for redirect in meta elements
746 $doc = new DOMDocument();
747 @$doc->loadHTML($body);
749 $xpath = new DomXPath($doc);
751 $list = $xpath->query("//meta[@content]");
752 foreach ($list as $node) {
754 if ($node->attributes->length) {
755 foreach ($node->attributes as $attribute) {
756 $attr[$attribute->name] = $attribute->value;
760 if (@$attr["http-equiv"] == 'refresh') {
761 $path = $attr["content"];
762 $pathinfo = explode(";", $path);
763 foreach ($pathinfo as $value) {
764 if (substr(strtolower($value), 0, 4) == "url=") {
765 return(self::finalUrl(substr($value, 4), ++$depth));
775 * @brief Find the matching part between two url
777 * @param string $url1
778 * @param string $url2
779 * @return string The matching part
781 public static function getUrlMatch($url1, $url2)
783 if (($url1 == "") || ($url2 == "")) {
787 $url1 = normalise_link($url1);
788 $url2 = normalise_link($url2);
790 $parts1 = parse_url($url1);
791 $parts2 = parse_url($url2);
793 if (!isset($parts1["host"]) || !isset($parts2["host"])) {
797 if ($parts1["scheme"] != $parts2["scheme"]) {
801 if ($parts1["host"] != $parts2["host"]) {
805 if ($parts1["port"] != $parts2["port"]) {
809 $match = $parts1["scheme"]."://".$parts1["host"];
811 if ($parts1["port"]) {
812 $match .= ":".$parts1["port"];
815 $pathparts1 = explode("/", $parts1["path"]);
816 $pathparts2 = explode("/", $parts2["path"]);
821 $path1 = $pathparts1[$i];
822 $path2 = $pathparts2[$i];
824 if ($path1 == $path2) {
827 } while (($path1 == $path2) && ($i++ <= count($pathparts1)));
831 return normalise_link($match);
835 * @brief Glue url parts together
837 * @param array $parsed URL parts
839 * @return string The glued URL
841 public static function unparseURL($parsed)
843 $get = function ($key) use ($parsed) {
844 return isset($parsed[$key]) ? $parsed[$key] : null;
847 $pass = $get('pass');
848 $user = $get('user');
849 $userinfo = $pass !== null ? "$user:$pass" : $user;
850 $port = $get('port');
851 $scheme = $get('scheme');
852 $query = $get('query');
853 $fragment = $get('fragment');
854 $authority = ($userinfo !== null ? $userinfo."@" : '') .
856 ($port ? ":$port" : '');
858 return (strlen($scheme) ? $scheme.":" : '') .
859 (strlen($authority) ? "//".$authority : '') .
861 (strlen($query) ? "?".$query : '') .
862 (strlen($fragment) ? "#".$fragment : '');