]> git.mxchange.org Git - friendica.git/blob - include/network.php
Merge pull request #3199 from annando/issue-3196
[friendica.git] / include / network.php
1 <?php
2
3 /**
4  * @file include/network.php
5  */
6
7 use \Friendica\Core\Config;
8
9 require_once("include/xml.php");
10 require_once('include/Probe.php');
11
12 /**
13  * @brief Curl wrapper
14  *
15  * If binary flag is true, return binary results.
16  * Set the cookiejar argument to a string (e.g. "/tmp/friendica-cookies.txt")
17  * to preserve cookies from one request to the next.
18  *
19  * @param string $url URL to fetch
20  * @param boolean $binary default false
21  *    TRUE if asked to return binary results (file download)
22  * @param integer $redirects The recursion counter for internal use - default 0
23  * @param integer $timeout Timeout in seconds, default system config value or 60 seconds
24  * @param string $accept_content supply Accept: header with 'accept_content' as the value
25  * @param string $cookiejar Path to cookie jar file
26  *
27  * @return string The fetched content
28  */
29 function fetch_url($url,$binary = false, &$redirects = 0, $timeout = 0, $accept_content=Null, $cookiejar = 0) {
30
31         $ret = z_fetch_url(
32                 $url,
33                 $binary,
34                 $redirects,
35                 array('timeout'=>$timeout,
36                 'accept_content'=>$accept_content,
37                 'cookiejar'=>$cookiejar
38                 ));
39
40         return($ret['body']);
41 }
42
43 /**
44  * @brief fetches an URL.
45  *
46  * @param string $url URL to fetch
47  * @param boolean $binary default false
48  *    TRUE if asked to return binary results (file download)
49  * @param int $redirects The recursion counter for internal use - default 0
50  * @param array $opts (optional parameters) assoziative array with:
51  *    'accept_content' => supply Accept: header with 'accept_content' as the value
52  *    'timeout' => int Timeout in seconds, default system config value or 60 seconds
53  *    'http_auth' => username:password
54  *    'novalidate' => do not validate SSL certs, default is to validate using our CA list
55  *    'nobody' => only return the header
56  *    'cookiejar' => path to cookie jar file
57  *
58  * @return array an assoziative array with:
59  *    int 'return_code' => HTTP return code or 0 if timeout or failure
60  *    boolean 'success' => boolean true (if HTTP 2xx result) or false
61  *    string 'redirect_url' => in case of redirect, content was finally retrieved from this URL
62  *    string 'header' => HTTP headers
63  *    string 'body' => fetched content
64  */
65 function z_fetch_url($url,$binary = false, &$redirects = 0, $opts=array()) {
66
67         $ret = array('return_code' => 0, 'success' => false, 'header' => "", 'body' => "");
68
69
70         $stamp1 = microtime(true);
71
72         $a = get_app();
73
74         $ch = @curl_init($url);
75         if(($redirects > 8) || (! $ch))
76                 return false;
77
78         @curl_setopt($ch, CURLOPT_HEADER, true);
79
80         if(x($opts,"cookiejar")) {
81                 curl_setopt($ch, CURLOPT_COOKIEJAR, $opts["cookiejar"]);
82                 curl_setopt($ch, CURLOPT_COOKIEFILE, $opts["cookiejar"]);
83         }
84
85 // These settings aren't needed. We're following the location already.
86 //      @curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
87 //      @curl_setopt($ch, CURLOPT_MAXREDIRS, 5);
88
89         if (x($opts,'accept_content')){
90                 curl_setopt($ch,CURLOPT_HTTPHEADER, array (
91                         "Accept: " . $opts['accept_content']
92                 ));
93         }
94
95         @curl_setopt($ch, CURLOPT_RETURNTRANSFER,true);
96         @curl_setopt($ch, CURLOPT_USERAGENT, $a->get_useragent());
97
98         $range = intval(Config::get('system', 'curl_range_bytes', 0));
99         if ($range > 0) {
100                 @curl_setopt($ch, CURLOPT_RANGE, '0-'.$range);
101         }
102
103         if(x($opts,'headers')){
104                 @curl_setopt($ch, CURLOPT_HTTPHEADER, $opts['headers']);
105         }
106         if(x($opts,'nobody')){
107                 @curl_setopt($ch, CURLOPT_NOBODY, $opts['nobody']);
108         }
109         if(x($opts,'timeout')){
110                 @curl_setopt($ch, CURLOPT_TIMEOUT, $opts['timeout']);
111         } else {
112                 $curl_time = intval(get_config('system','curl_timeout'));
113                 @curl_setopt($ch, CURLOPT_TIMEOUT, (($curl_time !== false) ? $curl_time : 60));
114         }
115
116         // by default we will allow self-signed certs
117         // but you can override this
118
119         $check_cert = get_config('system','verifyssl');
120         @curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, (($check_cert) ? true : false));
121         if ($check_cert) {
122                 @curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
123         }
124
125         $prx = get_config('system','proxy');
126         if(strlen($prx)) {
127                 @curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, 1);
128                 @curl_setopt($ch, CURLOPT_PROXY, $prx);
129                 $prxusr = @get_config('system','proxyuser');
130                 if(strlen($prxusr))
131                         @curl_setopt($ch, CURLOPT_PROXYUSERPWD, $prxusr);
132         }
133         if($binary)
134                 @curl_setopt($ch, CURLOPT_BINARYTRANSFER,1);
135
136         $a->set_curl_code(0);
137
138         // don't let curl abort the entire application
139         // if it throws any errors.
140
141         $s = @curl_exec($ch);
142         if (curl_errno($ch) !== CURLE_OK) {
143                 logger('fetch_url error fetching '.$url.': '.curl_error($ch), LOGGER_NORMAL);
144         }
145
146         $base = $s;
147         $curl_info = @curl_getinfo($ch);
148
149         $http_code = $curl_info['http_code'];
150         logger('fetch_url '.$url.': '.$http_code." ".$s, LOGGER_DATA);
151         $header = '';
152
153         // Pull out multiple headers, e.g. proxy and continuation headers
154         // allow for HTTP/2.x without fixing code
155
156         while(preg_match('/^HTTP\/[1-2].+? [1-5][0-9][0-9]/',$base)) {
157                 $chunk = substr($base,0,strpos($base,"\r\n\r\n")+4);
158                 $header .= $chunk;
159                 $base = substr($base,strlen($chunk));
160         }
161
162         $a->set_curl_code($http_code);
163         $a->set_curl_content_type($curl_info['content_type']);
164         $a->set_curl_headers($header);
165
166         if($http_code == 301 || $http_code == 302 || $http_code == 303 || $http_code == 307) {
167                 $new_location_info = @parse_url($curl_info["redirect_url"]);
168                 $old_location_info = @parse_url($curl_info["url"]);
169
170                 $newurl = $curl_info["redirect_url"];
171
172                 if (($new_location_info["path"] == "") AND ($new_location_info["host"] != ""))
173                         $newurl = $new_location_info["scheme"]."://".$new_location_info["host"].$old_location_info["path"];
174
175                 $matches = array();
176                 if (preg_match('/(Location:|URI:)(.*?)\n/i', $header, $matches)) {
177                         $newurl = trim(array_pop($matches));
178                 }
179                 if(strpos($newurl,'/') === 0)
180                         $newurl = $old_location_info["scheme"]."://".$old_location_info["host"].$newurl;
181                 if (filter_var($newurl, FILTER_VALIDATE_URL)) {
182                         $redirects++;
183                         @curl_close($ch);
184                         return z_fetch_url($newurl,$binary, $redirects, $opts);
185                 }
186         }
187
188
189         $a->set_curl_code($http_code);
190         $a->set_curl_content_type($curl_info['content_type']);
191
192         $body = substr($s,strlen($header));
193
194
195
196         $rc = intval($http_code);
197         $ret['return_code'] = $rc;
198         $ret['success'] = (($rc >= 200 && $rc <= 299) ? true : false);
199         $ret['redirect_url'] = $url;
200         if(! $ret['success']) {
201                 $ret['error'] = curl_error($ch);
202                 $ret['debug'] = $curl_info;
203                 logger('z_fetch_url: error: ' . $url . ': ' . $ret['error'], LOGGER_DEBUG);
204                 logger('z_fetch_url: debug: ' . print_r($curl_info,true), LOGGER_DATA);
205         }
206         $ret['body'] = substr($s,strlen($header));
207         $ret['header'] = $header;
208         if(x($opts,'debug')) {
209                 $ret['debug'] = $curl_info;
210         }
211         @curl_close($ch);
212
213         $a->save_timestamp($stamp1, "network");
214
215         return($ret);
216
217 }
218
219 // post request to $url. $params is an array of post variables.
220
221 /**
222  * @brief Post request to $url
223  *
224  * @param string $url URL to post
225  * @param mixed $params
226  * @param string $headers HTTP headers
227  * @param integer $redirects Recursion counter for internal use - default = 0
228  * @param integer $timeout The timeout in seconds, default system config value or 60 seconds
229  *
230  * @return string The content
231  */
232 function post_url($url,$params, $headers = null, &$redirects = 0, $timeout = 0) {
233         $stamp1 = microtime(true);
234
235         $a = get_app();
236         $ch = curl_init($url);
237         if(($redirects > 8) || (! $ch))
238                 return false;
239
240         logger("post_url: start ".$url, LOGGER_DATA);
241
242         curl_setopt($ch, CURLOPT_HEADER, true);
243         curl_setopt($ch, CURLOPT_RETURNTRANSFER,true);
244         curl_setopt($ch, CURLOPT_POST,1);
245         curl_setopt($ch, CURLOPT_POSTFIELDS,$params);
246         curl_setopt($ch, CURLOPT_USERAGENT, $a->get_useragent());
247
248         if(intval($timeout)) {
249                 curl_setopt($ch, CURLOPT_TIMEOUT, $timeout);
250         }
251         else {
252                 $curl_time = intval(get_config('system','curl_timeout'));
253                 curl_setopt($ch, CURLOPT_TIMEOUT, (($curl_time !== false) ? $curl_time : 60));
254         }
255
256         if(defined('LIGHTTPD')) {
257                 if(!is_array($headers)) {
258                         $headers = array('Expect:');
259                 } else {
260                         if(!in_array('Expect:', $headers)) {
261                                 array_push($headers, 'Expect:');
262                         }
263                 }
264         }
265         if($headers)
266                 curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
267
268         $check_cert = get_config('system','verifyssl');
269         curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, (($check_cert) ? true : false));
270         if ($check_cert) {
271                 @curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
272         }
273         $prx = get_config('system','proxy');
274         if(strlen($prx)) {
275                 curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, 1);
276                 curl_setopt($ch, CURLOPT_PROXY, $prx);
277                 $prxusr = get_config('system','proxyuser');
278                 if(strlen($prxusr))
279                         curl_setopt($ch, CURLOPT_PROXYUSERPWD, $prxusr);
280         }
281
282         $a->set_curl_code(0);
283
284         // don't let curl abort the entire application
285         // if it throws any errors.
286
287         $s = @curl_exec($ch);
288
289         $base = $s;
290         $curl_info = curl_getinfo($ch);
291         $http_code = $curl_info['http_code'];
292
293         logger("post_url: result ".$http_code." - ".$url, LOGGER_DATA);
294
295         $header = '';
296
297         // Pull out multiple headers, e.g. proxy and continuation headers
298         // allow for HTTP/2.x without fixing code
299
300         while(preg_match('/^HTTP\/[1-2].+? [1-5][0-9][0-9]/',$base)) {
301                 $chunk = substr($base,0,strpos($base,"\r\n\r\n")+4);
302                 $header .= $chunk;
303                 $base = substr($base,strlen($chunk));
304         }
305
306         if($http_code == 301 || $http_code == 302 || $http_code == 303 || $http_code == 307) {
307                 $matches = array();
308                 preg_match('/(Location:|URI:)(.*?)\n/', $header, $matches);
309                 $newurl = trim(array_pop($matches));
310                 if(strpos($newurl,'/') === 0)
311                         $newurl = $old_location_info["scheme"] . "://" . $old_location_info["host"] . $newurl;
312                 if (filter_var($newurl, FILTER_VALIDATE_URL)) {
313                         $redirects++;
314                         logger("post_url: redirect ".$url." to ".$newurl);
315                         return post_url($newurl,$params, $headers, $redirects, $timeout);
316                         //return fetch_url($newurl,false,$redirects,$timeout);
317                 }
318         }
319         $a->set_curl_code($http_code);
320         $body = substr($s,strlen($header));
321
322         $a->set_curl_headers($header);
323
324         curl_close($ch);
325
326         $a->save_timestamp($stamp1, "network");
327
328         logger("post_url: end ".$url, LOGGER_DATA);
329
330         return($body);
331 }
332
333 // Generic XML return
334 // Outputs a basic dfrn XML status structure to STDOUT, with a <status> variable
335 // of $st and an optional text <message> of $message and terminates the current process.
336
337 function xml_status($st, $message = '') {
338
339         $xml_message = ((strlen($message)) ? "\t<message>" . xmlify($message) . "</message>\r\n" : '');
340
341         if($st)
342                 logger('xml_status returning non_zero: ' . $st . " message=" . $message);
343
344         header( "Content-type: text/xml" );
345         echo '<?xml version="1.0" encoding="UTF-8"?>'."\r\n";
346         echo "<result>\r\n\t<status>$st</status>\r\n$xml_message</result>\r\n";
347         killme();
348 }
349
350 /**
351  * @brief Send HTTP status header and exit.
352  *
353  * @param integer $val HTTP status result value
354  * @param array $description optional message
355  *    'title' => header title
356  *    'description' => optional message
357  */
358
359 /**
360  * @brief Send HTTP status header and exit.
361  *
362  * @param integer $val HTTP status result value
363  * @param array $description optional message
364  *    'title' => header title
365  *    'description' => optional message
366  */
367 function http_status_exit($val, $description = array()) {
368         $err = '';
369         if($val >= 400) {
370                 $err = 'Error';
371                 if (!isset($description["title"]))
372                         $description["title"] = $err." ".$val;
373         }
374         if($val >= 200 && $val < 300)
375                 $err = 'OK';
376
377         logger('http_status_exit ' . $val);
378         header($_SERVER["SERVER_PROTOCOL"] . ' ' . $val . ' ' . $err);
379
380         if (isset($description["title"])) {
381                 $tpl = get_markup_template('http_status.tpl');
382                 echo replace_macros($tpl, array('$title' => $description["title"],
383                                                 '$description' => $description["description"]));
384         }
385
386         killme();
387
388 }
389
390 /**
391  * @brief Check URL to se if ts's real
392  *
393  * Take a URL from the wild, prepend http:// if necessary
394  * and check DNS to see if it's real (or check if is a valid IP address)
395  *
396  * @param string $url The URL to be validated
397  * @return boolean True if it's a valid URL, fals if something wrong with it
398  */
399 function validate_url(&$url) {
400         if(get_config('system','disable_url_validation'))
401                 return true;
402
403         // no naked subdomains (allow localhost for tests)
404         if(strpos($url,'.') === false && strpos($url,'/localhost/') === false)
405                 return false;
406
407         if(substr($url,0,4) != 'http')
408                 $url = 'http://' . $url;
409
410         /// @TODO Really supress function outcomes? Why not find them + debug them?
411         $h = @parse_url($url);
412
413         if((is_array($h)) && (dns_get_record($h['host'], DNS_A + DNS_CNAME + DNS_PTR) || filter_var($h['host'], FILTER_VALIDATE_IP) )) {
414                 return true;
415         }
416
417         return false;
418 }
419
420 /**
421  * @brief Checks that email is an actual resolvable internet address
422  *
423  * @param string $addr The email address
424  * @return boolean True if it's a valid email address, false if it's not
425  */
426 function validate_email($addr) {
427
428         if(get_config('system','disable_email_validation'))
429                 return true;
430
431         if(! strpos($addr,'@'))
432                 return false;
433         $h = substr($addr,strpos($addr,'@') + 1);
434
435         if(($h) && (dns_get_record($h, DNS_A + DNS_CNAME + DNS_PTR + DNS_MX) || filter_var($h, FILTER_VALIDATE_IP) )) {
436                 return true;
437         }
438         return false;
439 }
440
441 /**
442  * @brief Check if URL is allowed
443  *
444  * Check $url against our list of allowed sites,
445  * wildcards allowed. If allowed_sites is unset return true;
446  *
447  * @param string $url URL which get tested
448  * @return boolean True if url is allowed otherwise return false
449  */
450 function allowed_url($url) {
451
452         $h = @parse_url($url);
453
454         if(! $h) {
455                 return false;
456         }
457
458         $str_allowed = get_config('system','allowed_sites');
459         if(! $str_allowed)
460                 return true;
461
462         $found = false;
463
464         $host = strtolower($h['host']);
465
466         // always allow our own site
467
468         if($host == strtolower($_SERVER['SERVER_NAME']))
469                 return true;
470
471         $fnmatch = function_exists('fnmatch');
472         $allowed = explode(',',$str_allowed);
473
474         if(count($allowed)) {
475                 foreach($allowed as $a) {
476                         $pat = strtolower(trim($a));
477                         if(($fnmatch && fnmatch($pat,$host)) || ($pat == $host)) {
478                                 $found = true;
479                                 break;
480                         }
481                 }
482         }
483         return $found;
484 }
485
486 /**
487  * @brief Check if email address is allowed to register here.
488  *
489  * Compare against our list (wildcards allowed).
490  *
491  * @param type $email
492  * @return boolean False if not allowed, true if allowed
493  *    or if allowed list is not configured
494  */
495 function allowed_email($email) {
496
497
498         $domain = strtolower(substr($email,strpos($email,'@') + 1));
499         if(! $domain)
500                 return false;
501
502         $str_allowed = get_config('system','allowed_email');
503         if(! $str_allowed)
504                 return true;
505
506         $found = false;
507
508         $fnmatch = function_exists('fnmatch');
509         $allowed = explode(',',$str_allowed);
510
511         if(count($allowed)) {
512                 foreach($allowed as $a) {
513                         $pat = strtolower(trim($a));
514                         if(($fnmatch && fnmatch($pat,$domain)) || ($pat == $domain)) {
515                                 $found = true;
516                                 break;
517                         }
518                 }
519         }
520         return $found;
521 }
522
523 function avatar_img($email) {
524
525         $avatar['size'] = 175;
526         $avatar['email'] = $email;
527         $avatar['url'] = '';
528         $avatar['success'] = false;
529
530         call_hooks('avatar_lookup', $avatar);
531
532         if (! $avatar['success']) {
533                 $avatar['url'] = App::get_baseurl() . '/images/person-175.jpg';
534         }
535
536         logger('Avatar: ' . $avatar['email'] . ' ' . $avatar['url'], LOGGER_DEBUG);
537         return $avatar['url'];
538 }
539
540
541 function parse_xml_string($s,$strict = true) {
542         /// @todo Move this function to the xml class
543         if($strict) {
544                 if(! strstr($s,'<?xml'))
545                         return false;
546                 $s2 = substr($s,strpos($s,'<?xml'));
547         }
548         else
549                 $s2 = $s;
550         libxml_use_internal_errors(true);
551
552         $x = @simplexml_load_string($s2);
553         if (! $x) {
554                 logger('libxml: parse: error: ' . $s2, LOGGER_DATA);
555                 foreach (libxml_get_errors() as $err) {
556                         logger('libxml: parse: ' . $err->code." at ".$err->line.":".$err->column." : ".$err->message, LOGGER_DATA);
557                 }
558                 libxml_clear_errors();
559         }
560         return $x;
561 }
562
563 function scale_external_images($srctext, $include_link = true, $scale_replace = false) {
564
565         // Suppress "view full size"
566         if (intval(get_config('system','no_view_full_size'))) {
567                 $include_link = false;
568         }
569
570         $a = get_app();
571
572         // Picture addresses can contain special characters
573         $s = htmlspecialchars_decode($srctext);
574
575         $matches = null;
576         $c = preg_match_all('/\[img.*?\](.*?)\[\/img\]/ism',$s,$matches,PREG_SET_ORDER);
577         if ($c) {
578                 require_once('include/Photo.php');
579                 foreach ($matches as $mtch) {
580                         logger('scale_external_image: ' . $mtch[1]);
581
582                         $hostname = str_replace('www.','',substr(App::get_baseurl(),strpos(App::get_baseurl(),'://')+3));
583                         if (stristr($mtch[1],$hostname)) {
584                                 continue;
585                         }
586
587                         // $scale_replace, if passed, is an array of two elements. The
588                         // first is the name of the full-size image. The second is the
589                         // name of a remote, scaled-down version of the full size image.
590                         // This allows Friendica to display the smaller remote image if
591                         // one exists, while still linking to the full-size image
592                         if ($scale_replace) {
593                                 $scaled = str_replace($scale_replace[0], $scale_replace[1], $mtch[1]);
594                         } else {
595                                 $scaled = $mtch[1];
596                         }
597                         $i = fetch_url($scaled);
598                         if (! $i) {
599                                 return $srctext;
600                         }
601
602                         // guess mimetype from headers or filename
603                         $type = guess_image_type($mtch[1],true);
604
605                         if ($i) {
606                                 $ph = new Photo($i, $type);
607                                 if ($ph->is_valid()) {
608                                         $orig_width = $ph->getWidth();
609                                         $orig_height = $ph->getHeight();
610
611                                         if ($orig_width > 640 || $orig_height > 640) {
612
613                                                 $ph->scaleImage(640);
614                                                 $new_width = $ph->getWidth();
615                                                 $new_height = $ph->getHeight();
616                                                 logger('scale_external_images: ' . $orig_width . '->' . $new_width . 'w ' . $orig_height . '->' . $new_height . 'h' . ' match: ' . $mtch[0], LOGGER_DEBUG);
617                                                 $s = str_replace($mtch[0],'[img=' . $new_width . 'x' . $new_height. ']' . $scaled . '[/img]'
618                                                         . "\n" . (($include_link)
619                                                                 ? '[url=' . $mtch[1] . ']' . t('view full size') . '[/url]' . "\n"
620                                                                 : ''),$s);
621                                                 logger('scale_external_images: new string: ' . $s, LOGGER_DEBUG);
622                                         }
623                                 }
624                         }
625                 }
626         }
627
628         // replace the special char encoding
629         $s = htmlspecialchars($s,ENT_NOQUOTES,'UTF-8');
630         return $s;
631 }
632
633
634 function fix_contact_ssl_policy(&$contact,$new_policy) {
635
636         $ssl_changed = false;
637         if ((intval($new_policy) == SSL_POLICY_SELFSIGN || $new_policy === 'self') && strstr($contact['url'],'https:')) {
638                 $ssl_changed = true;
639                 $contact['url']     =   str_replace('https:','http:',$contact['url']);
640                 $contact['request'] =   str_replace('https:','http:',$contact['request']);
641                 $contact['notify']  =   str_replace('https:','http:',$contact['notify']);
642                 $contact['poll']    =   str_replace('https:','http:',$contact['poll']);
643                 $contact['confirm'] =   str_replace('https:','http:',$contact['confirm']);
644                 $contact['poco']    =   str_replace('https:','http:',$contact['poco']);
645         }
646
647         if ((intval($new_policy) == SSL_POLICY_FULL || $new_policy === 'full') && strstr($contact['url'],'http:')) {
648                 $ssl_changed = true;
649                 $contact['url']     =   str_replace('http:','https:',$contact['url']);
650                 $contact['request'] =   str_replace('http:','https:',$contact['request']);
651                 $contact['notify']  =   str_replace('http:','https:',$contact['notify']);
652                 $contact['poll']    =   str_replace('http:','https:',$contact['poll']);
653                 $contact['confirm'] =   str_replace('http:','https:',$contact['confirm']);
654                 $contact['poco']    =   str_replace('http:','https:',$contact['poco']);
655         }
656
657         if ($ssl_changed) {
658                 q("UPDATE `contact` SET
659                         `url` = '%s',
660                         `request` = '%s',
661                         `notify` = '%s',
662                         `poll` = '%s',
663                         `confirm` = '%s',
664                         `poco` = '%s'
665                         WHERE `id` = %d LIMIT 1",
666                         dbesc($contact['url']),
667                         dbesc($contact['request']),
668                         dbesc($contact['notify']),
669                         dbesc($contact['poll']),
670                         dbesc($contact['confirm']),
671                         dbesc($contact['poco']),
672                         intval($contact['id'])
673                 );
674         }
675 }
676
677 /**
678  * @brief Remove Google Analytics and other tracking platforms params from URL
679  *
680  * @param string $url Any user-submitted URL that may contain tracking params
681  * @return string The same URL stripped of tracking parameters
682  */
683 function strip_tracking_query_params($url)
684 {
685         $urldata = parse_url($url);
686         if (is_string($urldata["query"])) {
687                 $query = $urldata["query"];
688                 parse_str($query, $querydata);
689
690                 if (is_array($querydata)) {
691                         foreach ($querydata AS $param => $value) {
692                                 if (in_array($param, array("utm_source", "utm_medium", "utm_term", "utm_content", "utm_campaign",
693                                                         "wt_mc", "pk_campaign", "pk_kwd", "mc_cid", "mc_eid",
694                                                         "fb_action_ids", "fb_action_types", "fb_ref",
695                                                         "awesm", "wtrid",
696                                                         "woo_campaign", "woo_source", "woo_medium", "woo_content", "woo_term"))) {
697
698                                         $pair = $param . "=" . urlencode($value);
699                                         $url = str_replace($pair, "", $url);
700
701                                         // Second try: if the url isn't encoded completely
702                                         $pair = $param . "=" . str_replace(" ", "+", $value);
703                                         $url = str_replace($pair, "", $url);
704
705                                         // Third try: Maybey the url isn't encoded at all
706                                         $pair = $param . "=" . $value;
707                                         $url = str_replace($pair, "", $url);
708
709                                         $url = str_replace(array("?&", "&&"), array("?", ""), $url);
710                                 }
711                         }
712                 }
713
714                 if (substr($url, -1, 1) == "?") {
715                         $url = substr($url, 0, -1);
716                 }
717         }
718
719         return $url;
720 }
721
722 /**
723  * @brief Returns the original URL of the provided URL
724  *
725  * This function strips tracking query params and follows redirections, either
726  * through HTTP code or meta refresh tags. Stops after 10 redirections.
727  *
728  * @todo Remove the $fetchbody parameter that generates an extraneous HEAD request
729  *
730  * @see ParseUrl::getSiteinfo
731  *
732  * @param string $url A user-submitted URL
733  * @param int $depth The current redirection recursion level (internal)
734  * @param bool $fetchbody Wether to fetch the body or not after the HEAD requests
735  * @return string A canonical URL
736  */
737 function original_url($url, $depth = 1, $fetchbody = false) {
738         $a = get_app();
739
740         $url = strip_tracking_query_params($url);
741
742         if ($depth > 10)
743                 return($url);
744
745         $url = trim($url, "'");
746
747         $stamp1 = microtime(true);
748
749         $siteinfo = array();
750         $ch = curl_init();
751         curl_setopt($ch, CURLOPT_URL, $url);
752         curl_setopt($ch, CURLOPT_HEADER, 1);
753         curl_setopt($ch, CURLOPT_NOBODY, 1);
754         curl_setopt($ch, CURLOPT_TIMEOUT, 10);
755         curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
756         curl_setopt($ch, CURLOPT_USERAGENT, $a->get_useragent());
757
758         $header = curl_exec($ch);
759         $curl_info = @curl_getinfo($ch);
760         $http_code = $curl_info['http_code'];
761         curl_close($ch);
762
763         $a->save_timestamp($stamp1, "network");
764
765         if ($http_code == 0)
766                 return($url);
767
768         if ((($curl_info['http_code'] == "301") OR ($curl_info['http_code'] == "302"))
769                 AND (($curl_info['redirect_url'] != "") OR ($curl_info['location'] != ""))) {
770                 if ($curl_info['redirect_url'] != "")
771                         return(original_url($curl_info['redirect_url'], ++$depth, $fetchbody));
772                 else
773                         return(original_url($curl_info['location'], ++$depth, $fetchbody));
774         }
775
776         // Check for redirects in the meta elements of the body if there are no redirects in the header.
777         if (!$fetchbody)
778                 return(original_url($url, ++$depth, true));
779
780         // if the file is too large then exit
781         if ($curl_info["download_content_length"] > 1000000)
782                 return($url);
783
784         // if it isn't a HTML file then exit
785         if (($curl_info["content_type"] != "") AND !strstr(strtolower($curl_info["content_type"]),"html"))
786                 return($url);
787
788         $stamp1 = microtime(true);
789
790         $ch = curl_init();
791         curl_setopt($ch, CURLOPT_URL, $url);
792         curl_setopt($ch, CURLOPT_HEADER, 0);
793         curl_setopt($ch, CURLOPT_NOBODY, 0);
794         curl_setopt($ch, CURLOPT_TIMEOUT, 10);
795         curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
796         curl_setopt($ch, CURLOPT_USERAGENT, $a->get_useragent());
797
798         $body = curl_exec($ch);
799         curl_close($ch);
800
801         $a->save_timestamp($stamp1, "network");
802
803         if (trim($body) == "")
804                 return($url);
805
806         // Check for redirect in meta elements
807         $doc = new DOMDocument();
808         @$doc->loadHTML($body);
809
810         $xpath = new DomXPath($doc);
811
812         $list = $xpath->query("//meta[@content]");
813         foreach ($list as $node) {
814                 $attr = array();
815                 if ($node->attributes->length)
816                         foreach ($node->attributes as $attribute)
817                                 $attr[$attribute->name] = $attribute->value;
818
819                 if (@$attr["http-equiv"] == 'refresh') {
820                         $path = $attr["content"];
821                         $pathinfo = explode(";", $path);
822                         $content = "";
823                         foreach ($pathinfo AS $value)
824                                 if (substr(strtolower($value), 0, 4) == "url=")
825                                         return(original_url(substr($value, 4), ++$depth));
826                 }
827         }
828
829         return($url);
830 }
831
832 function short_link($url) {
833         require_once('library/slinky.php');
834         $slinky = new Slinky($url);
835         $yourls_url = get_config('yourls','url1');
836         if ($yourls_url) {
837                 $yourls_username = get_config('yourls','username1');
838                 $yourls_password = get_config('yourls', 'password1');
839                 $yourls_ssl = get_config('yourls', 'ssl1');
840                 $yourls = new Slinky_YourLS();
841                 $yourls->set('username', $yourls_username);
842                 $yourls->set('password', $yourls_password);
843                 $yourls->set('ssl', $yourls_ssl);
844                 $yourls->set('yourls-url', $yourls_url);
845                 $slinky->set_cascade(array($yourls, new Slinky_Ur1ca(), new Slinky_TinyURL()));
846         } else {
847                 // setup a cascade of shortening services
848                 // try to get a short link from these services
849                 // in the order ur1.ca, tinyurl
850                 $slinky->set_cascade(array(new Slinky_Ur1ca(), new Slinky_TinyURL()));
851         }
852         return $slinky->short();
853 }
854
855 /**
856  * @brief Encodes content to json
857  *
858  * This function encodes an array to json format
859  * and adds an application/json HTTP header to the output.
860  * After finishing the process is getting killed.
861  *
862  * @param array $x The input content
863  */
864 function json_return_and_die($x) {
865         header("content-type: application/json");
866         echo json_encode($x);
867         killme();
868 }
869
870 /**
871  * @brief Find the matching part between two url
872  *
873  * @param string $url1
874  * @param string $url2
875  * @return string The matching part
876  */
877 function matching_url($url1, $url2) {
878
879         if (($url1 == "") OR ($url2 == ""))
880                 return "";
881
882         $url1 = normalise_link($url1);
883         $url2 = normalise_link($url2);
884
885         $parts1 = parse_url($url1);
886         $parts2 = parse_url($url2);
887
888         if (!isset($parts1["host"]) OR !isset($parts2["host"]))
889                 return "";
890
891         if ($parts1["scheme"] != $parts2["scheme"])
892                 return "";
893
894         if ($parts1["host"] != $parts2["host"])
895                 return "";
896
897         if ($parts1["port"] != $parts2["port"])
898                 return "";
899
900         $match = $parts1["scheme"]."://".$parts1["host"];
901
902         if ($parts1["port"])
903                 $match .= ":".$parts1["port"];
904
905         $pathparts1 = explode("/", $parts1["path"]);
906         $pathparts2 = explode("/", $parts2["path"]);
907
908         $i = 0;
909         $path = "";
910         do {
911                 $path1 = $pathparts1[$i];
912                 $path2 = $pathparts2[$i];
913
914                 if ($path1 == $path2)
915                         $path .= $path1."/";
916
917         } while (($path1 == $path2) AND ($i++ <= count($pathparts1)));
918
919         $match .= $path;
920
921         return normalise_link($match);
922 }