include/text.php

   1 <?php
   2 /**
   3  * @file include/text.php
   4  */
   5
   6 use Friendica\App;
   7 use Friendica\Content\ContactSelector;
   8 use Friendica\Content\Feature;
   9 use Friendica\Content\Smilies;
  10 use Friendica\Content\Text\BBCode;
  11 use Friendica\Core\Addon;
  12 use Friendica\Core\Config;
  13 use Friendica\Core\L10n;
  14 use Friendica\Core\PConfig;
  15 use Friendica\Core\System;
  16 use Friendica\Database\DBM;
  17 use Friendica\Model\Contact;
  18 use Friendica\Model\Event;
  19 use Friendica\Model\Item;
  20 use Friendica\Model\Profile;
  21 use Friendica\Render\FriendicaSmarty;
  22 use Friendica\Util\DateTimeFormat;
  23 use Friendica\Util\Map;
  24
  25 require_once "mod/proxy.php";
  26 require_once "include/conversation.php";
  27
  28 /**
  29  * This is our template processor
  30  *
  31  * @param string|FriendicaSmarty $s the string requiring macro substitution,
  32  *                              or an instance of FriendicaSmarty
  33  * @param array $r key value pairs (search => replace)
  34  * @return string substituted string
  35  */
  36 function replace_macros($s, $r) {
  37
  38         $stamp1 = microtime(true);
  39
  40         $a = get_app();
  41
  42         // pass $baseurl to all templates
  43         $r['$baseurl'] = System::baseUrl();
  44
  45         $t = $a->template_engine();
  46         try {
  47                 $output = $t->replaceMacros($s, $r);
  48         } catch (Exception $e) {
  49                 echo "<pre><b>" . __FUNCTION__ . "</b>: " . $e->getMessage() . "</pre>";
  50                 killme();
  51         }
  52
  53         $a->save_timestamp($stamp1, "rendering");
  54
  55         return $output;
  56 }
  57
  58 /**
  59  * @brief Generates a pseudo-random string of hexadecimal characters
  60  *
  61  * @param int $size
  62  * @return string
  63  */
  64 function random_string($size = 64)
  65 {
  66         $byte_size = ceil($size / 2);
  67
  68         $bytes = random_bytes($byte_size);
  69
  70         $return = substr(bin2hex($bytes), 0, $size);
  71
  72         return $return;
  73 }
  74
  75 /**
  76  * This is our primary input filter.
  77  *
  78  * The high bit hack only involved some old IE browser, forget which (IE5/Mac?)
  79  * that had an XSS attack vector due to stripping the high-bit on an 8-bit character
  80  * after cleansing, and angle chars with the high bit set could get through as markup.
  81  *
  82  * This is now disabled because it was interfering with some legitimate unicode sequences
  83  * and hopefully there aren't a lot of those browsers left.
  84  *
  85  * Use this on any text input where angle chars are not valid or permitted
  86  * They will be replaced with safer brackets. This may be filtered further
  87  * if these are not allowed either.
  88  *
  89  * @param string $string Input string
  90  * @return string Filtered string
  91  */
  92 function notags($string) {
  93         return str_replace(["<", ">"], ['[', ']'], $string);
  94
  95 //  High-bit filter no longer used
  96 //      return str_replace(array("<",">","\xBA","\xBC","\xBE"), array('[',']','','',''), $string);
  97 }
  98
  99
 100 /**
 101  * use this on "body" or "content" input where angle chars shouldn't be removed,
 102  * and allow them to be safely displayed.
 103  * @param string $string
 104  * @return string
 105  */
 106 function escape_tags($string) {
 107         return htmlspecialchars($string, ENT_COMPAT, 'UTF-8', false);
 108 }
 109
 110
 111 /**
 112  * generate a string that's random, but usually pronounceable.
 113  * used to generate initial passwords
 114  * @param int $len
 115  * @return string
 116  */
 117 function autoname($len) {
 118
 119         if ($len <= 0) {
 120                 return '';
 121         }
 122
 123         $vowels = ['a','a','ai','au','e','e','e','ee','ea','i','ie','o','ou','u'];
 124         if (mt_rand(0, 5) == 4) {
 125                 $vowels[] = 'y';
 126         }
 127
 128         $cons = [
 129                         'b','bl','br',
 130                         'c','ch','cl','cr',
 131                         'd','dr',
 132                         'f','fl','fr',
 133                         'g','gh','gl','gr',
 134                         'h',
 135                         'j',
 136                         'k','kh','kl','kr',
 137                         'l',
 138                         'm',
 139                         'n',
 140                         'p','ph','pl','pr',
 141                         'qu',
 142                         'r','rh',
 143                         's','sc','sh','sm','sp','st',
 144                         't','th','tr',
 145                         'v',
 146                         'w','wh',
 147                         'x',
 148                         'z','zh'
 149                         ];
 150
 151         $midcons = ['ck','ct','gn','ld','lf','lm','lt','mb','mm', 'mn','mp',
 152                                 'nd','ng','nk','nt','rn','rp','rt'];
 153
 154         $noend = ['bl', 'br', 'cl','cr','dr','fl','fr','gl','gr',
 155                                 'kh', 'kl','kr','mn','pl','pr','rh','tr','qu','wh','q'];
 156
 157         $start = mt_rand(0,2);
 158         if ($start == 0) {
 159                 $table = $vowels;
 160         } else {
 161                 $table = $cons;
 162         }
 163
 164         $word = '';
 165
 166         for ($x = 0; $x < $len; $x ++) {
 167                 $r = mt_rand(0,count($table) - 1);
 168                 $word .= $table[$r];
 169
 170                 if ($table == $vowels) {
 171                         $table = array_merge($cons,$midcons);
 172                 } else {
 173                         $table = $vowels;
 174                 }
 175
 176         }
 177
 178         $word = substr($word,0,$len);
 179
 180         foreach ($noend as $noe) {
 181                 $noelen = strlen($noe);
 182                 if ((strlen($word) > $noelen) && (substr($word, -$noelen) == $noe)) {
 183                         $word = autoname($len);
 184                         break;
 185                 }
 186         }
 187
 188         return $word;
 189 }
 190
 191
 192 /**
 193  * escape text ($str) for XML transport
 194  * @param string $str
 195  * @return string Escaped text.
 196  */
 197 function xmlify($str) {
 198         /// @TODO deprecated code found?
 199 /*      $buffer = '';
 200
 201         $len = mb_strlen($str);
 202         for ($x = 0; $x < $len; $x ++) {
 203                 $char = mb_substr($str,$x,1);
 204
 205                 switch($char) {
 206
 207                         case "\r" :
 208                                 break;
 209                         case "&" :
 210                                 $buffer .= '&amp;';
 211                                 break;
 212                         case "'" :
 213                                 $buffer .= '&apos;';
 214                                 break;
 215                         case "\"" :
 216                                 $buffer .= '&quot;';
 217                                 break;
 218                         case '<' :
 219                                 $buffer .= '&lt;';
 220                                 break;
 221                         case '>' :
 222                                 $buffer .= '&gt;';
 223                                 break;
 224                         case "\n" :
 225                                 $buffer .= "\n";
 226                                 break;
 227                         default :
 228                                 $buffer .= $char;
 229                                 break;
 230                 }
 231         }*/
 232         /*
 233         $buffer = mb_ereg_replace("&", "&amp;", $str);
 234         $buffer = mb_ereg_replace("'", "&apos;", $buffer);
 235         $buffer = mb_ereg_replace('"', "&quot;", $buffer);
 236         $buffer = mb_ereg_replace("<", "&lt;", $buffer);
 237         $buffer = mb_ereg_replace(">", "&gt;", $buffer);
 238         */
 239         $buffer = htmlspecialchars($str, ENT_QUOTES, "UTF-8");
 240         $buffer = trim($buffer);
 241
 242         return $buffer;
 243 }
 244
 245
 246 /**
 247  * undo an xmlify
 248  * @param string $s xml escaped text
 249  * @return string unescaped text
 250  */
 251 function unxmlify($s) {
 252         /// @TODO deprecated code found?
 253 //      $ret = str_replace('&amp;','&', $s);
 254 //      $ret = str_replace(array('&lt;','&gt;','&quot;','&apos;'),array('<','>','"',"'"),$ret);
 255         /*$ret = mb_ereg_replace('&amp;', '&', $s);
 256         $ret = mb_ereg_replace('&apos;', "'", $ret);
 257         $ret = mb_ereg_replace('&quot;', '"', $ret);
 258         $ret = mb_ereg_replace('&lt;', "<", $ret);
 259         $ret = mb_ereg_replace('&gt;', ">", $ret);
 260         */
 261         $ret = htmlspecialchars_decode($s, ENT_QUOTES);
 262         return $ret;
 263 }
 264
 265
 266 /**
 267  * @brief Paginator function. Pushes relevant links in a pager array structure.
 268  *
 269  * Links are generated depending on the current page and the total number of items.
 270  * Inactive links (like "first" and "prev" on page 1) are given the "disabled" class.
 271  * Current page link is given the "active" CSS class
 272  *
 273  * @param App $a App instance
 274  * @param int $count [optional] item count (used with minimal pager)
 275  * @return Array data for pagination template
 276  */
 277 function paginate_data(App $a, $count = null) {
 278         $stripped = preg_replace('/([&?]page=[0-9]*)/', '', $a->query_string);
 279
 280         $stripped = str_replace('q=', '', $stripped);
 281         $stripped = trim($stripped, '/');
 282         $pagenum = $a->pager['page'];
 283
 284         if (($a->page_offset != '') && !preg_match('/[?&].offset=/', $stripped)) {
 285                 $stripped .= '&offset=' . urlencode($a->page_offset);
 286         }
 287
 288         $url = $stripped;
 289         $data = [];
 290
 291         function _l(&$d, $name, $url, $text, $class = '') {
 292                 if (strpos($url, '?') === false && ($pos = strpos($url, '&')) !== false) {
 293                         $url = substr($url, 0, $pos) . '?' . substr($url, $pos + 1);
 294                 }
 295
 296                 $d[$name] = ['url' => $url, 'text' => $text, 'class' => $class];
 297         }
 298
 299         if (!is_null($count)) {
 300                 // minimal pager (newer / older)
 301                 $data['class'] = 'pager';
 302                 _l($data, 'prev', $url . '&page=' . ($a->pager['page'] - 1), L10n::t('newer'), 'previous' . ($a->pager['page'] == 1 ? ' disabled' : ''));
 303                 _l($data, 'next', $url . '&page=' . ($a->pager['page'] + 1), L10n::t('older'), 'next' . ($count <= 0 ? ' disabled' : ''));
 304         } else {
 305                 // full pager (first / prev / 1 / 2 / ... / 14 / 15 / next / last)
 306                 $data['class'] = 'pagination';
 307                 if ($a->pager['total'] > $a->pager['itemspage']) {
 308                         _l($data, 'first', $url . '&page=1', L10n::t('first'), $a->pager['page'] == 1 ? 'disabled' : '');
 309                         _l($data, 'prev', $url . '&page=' . ($a->pager['page'] - 1), L10n::t('prev'), $a->pager['page'] == 1 ? 'disabled' : '');
 310
 311                         $numpages = $a->pager['total'] / $a->pager['itemspage'];
 312
 313                         $numstart = 1;
 314                         $numstop = $numpages;
 315
 316                         // Limit the number of displayed page number buttons.
 317                         if ($numpages > 8) {
 318                                 $numstart = (($pagenum > 4) ? ($pagenum - 4) : 1);
 319                                 $numstop = (($pagenum > ($numpages - 7)) ? $numpages : ($numstart + 8));
 320                         }
 321
 322                         $pages = [];
 323
 324                         for ($i = $numstart; $i <= $numstop; $i++) {
 325                                 if ($i == $a->pager['page']) {
 326                                         _l($pages, $i, '#',  $i, 'current active');
 327                                 } else {
 328                                         _l($pages, $i, $url . '&page='. $i, $i, 'n');
 329                                 }
 330                         }
 331
 332                         if (($a->pager['total'] % $a->pager['itemspage']) != 0) {
 333                                 if ($i == $a->pager['page']) {
 334                                         _l($pages, $i, '#',  $i, 'current active');
 335                                 } else {
 336                                         _l($pages, $i, $url . '&page=' . $i, $i, 'n');
 337                                 }
 338                         }
 339
 340                         $data['pages'] = $pages;
 341
 342                         $lastpage = (($numpages > intval($numpages)) ? intval($numpages)+1 : $numpages);
 343                         _l($data, 'next', $url . '&page=' . ($a->pager['page'] + 1), L10n::t('next'), $a->pager['page'] == $lastpage ? 'disabled' : '');
 344                         _l($data, 'last', $url . '&page=' . $lastpage, L10n::t('last'), $a->pager['page'] == $lastpage ? 'disabled' : '');
 345                 }
 346         }
 347
 348         return $data;
 349 }
 350
 351
 352 /**
 353  * Automatic pagination.
 354  *
 355  *  To use, get the count of total items.
 356  * Then call $a->set_pager_total($number_items);
 357  * Optionally call $a->set_pager_itemspage($n) to the number of items to display on each page
 358  * Then call paginate($a) after the end of the display loop to insert the pager block on the page
 359  * (assuming there are enough items to paginate).
 360  * When using with SQL, the setting LIMIT %d, %d => $a->pager['start'],$a->pager['itemspage']
 361  * will limit the results to the correct items for the current page.
 362  * The actual page handling is then accomplished at the application layer.
 363  *
 364  * @param App $a App instance
 365  * @return string html for pagination #FIXME remove html
 366  */
 367 function paginate(App $a) {
 368
 369         $data = paginate_data($a);
 370         $tpl = get_markup_template("paginate.tpl");
 371         return replace_macros($tpl, ["pager" => $data]);
 372
 373 }
 374
 375
 376 /**
 377  * Alternative pager
 378  * @param App $a App instance
 379  * @param int $i
 380  * @return string html for pagination #FIXME remove html
 381  */
 382 function alt_pager(App $a, $i) {
 383
 384         $data = paginate_data($a, $i);
 385         $tpl = get_markup_template("paginate.tpl");
 386         return replace_macros($tpl, ['pager' => $data]);
 387
 388 }
 389
 390
 391 /**
 392  * Loader for infinite scrolling
 393  * @return string html for loader
 394  */
 395 function scroll_loader() {
 396         $tpl = get_markup_template("scroll_loader.tpl");
 397         return replace_macros($tpl, [
 398                 'wait' => L10n::t('Loading more entries...'),
 399                 'end' => L10n::t('The end')
 400         ]);
 401 }
 402
 403
 404 /**
 405  * Turn user/group ACLs stored as angle bracketed text into arrays
 406  *
 407  * @param string $s
 408  * @return array
 409  */
 410 function expand_acl($s) {
 411         // turn string array of angle-bracketed elements into numeric array
 412         // e.g. "<1><2><3>" => array(1,2,3);
 413         $ret = [];
 414
 415         if (strlen($s)) {
 416                 $t = str_replace('<', '', $s);
 417                 $a = explode('>', $t);
 418                 foreach ($a as $aa) {
 419                         if (intval($aa)) {
 420                                 $ret[] = intval($aa);
 421                         }
 422                 }
 423         }
 424         return $ret;
 425 }
 426
 427
 428 /**
 429  * Wrap ACL elements in angle brackets for storage
 430  * @param string $item
 431  */
 432 function sanitise_acl(&$item) {
 433         if (intval($item)) {
 434                 $item = '<' . intval(notags(trim($item))) . '>';
 435         } else {
 436                 unset($item);
 437         }
 438 }
 439
 440
 441 /**
 442  * Convert an ACL array to a storable string
 443  *
 444  * Normally ACL permissions will be an array.
 445  * We'll also allow a comma-separated string.
 446  *
 447  * @param string|array $p
 448  * @return string
 449  */
 450 function perms2str($p) {
 451         $ret = '';
 452         if (is_array($p)) {
 453                 $tmp = $p;
 454         } else {
 455                 $tmp = explode(',', $p);
 456         }
 457
 458         if (is_array($tmp)) {
 459                 array_walk($tmp, 'sanitise_acl');
 460                 $ret = implode('', $tmp);
 461         }
 462         return $ret;
 463 }
 464
 465
 466 /**
 467  * generate a guaranteed unique (for this domain) item ID for ATOM
 468  * safe from birthday paradox
 469  *
 470  * @param string $hostname
 471  * @param int $uid
 472  * @return string
 473  */
 474 function item_new_uri($hostname, $uid, $guid = "") {
 475
 476         do {
 477                 if ($guid == "") {
 478                         $hash = get_guid(32);
 479                 } else {
 480                         $hash = $guid;
 481                         $guid = "";
 482                 }
 483
 484                 $uri = "urn:X-dfrn:" . $hostname . ':' . $uid . ':' . $hash;
 485
 486                 $dups = dba::exists('item', ['uri' => $uri]);
 487         } while ($dups == true);
 488
 489         return $uri;
 490 }
 491
 492 /**
 493  * @deprecated
 494  * wrapper to load a view template, checking for alternate
 495  * languages before falling back to the default
 496  *
 497  * @global string $lang
 498  * @global App $a
 499  * @param string $s view name
 500  * @return string
 501  */
 502 function load_view_file($s) {
 503         global $lang, $a;
 504         if (! isset($lang)) {
 505                 $lang = 'en';
 506         }
 507         $b = basename($s);
 508         $d = dirname($s);
 509         if (file_exists("$d/$lang/$b")) {
 510                 $stamp1 = microtime(true);
 511                 $content = file_get_contents("$d/$lang/$b");
 512                 $a->save_timestamp($stamp1, "file");
 513                 return $content;
 514         }
 515
 516         $theme = $a->getCurrentTheme();
 517
 518         if (file_exists("$d/theme/$theme/$b")) {
 519                 $stamp1 = microtime(true);
 520                 $content = file_get_contents("$d/theme/$theme/$b");
 521                 $a->save_timestamp($stamp1, "file");
 522                 return $content;
 523         }
 524
 525         $stamp1 = microtime(true);
 526         $content = file_get_contents($s);
 527         $a->save_timestamp($stamp1, "file");
 528         return $content;
 529 }
 530
 531
 532 /**
 533  * load a view template, checking for alternate
 534  * languages before falling back to the default
 535  *
 536  * @global string $lang
 537  * @param string $s view path
 538  * @return string
 539  */
 540 function get_intltext_template($s) {
 541         global $lang;
 542
 543         $a = get_app();
 544         $engine = '';
 545         if ($a->theme['template_engine'] === 'smarty3') {
 546                 $engine = "/smarty3";
 547         }
 548
 549         if (! isset($lang)) {
 550                 $lang = 'en';
 551         }
 552
 553         if (file_exists("view/lang/$lang$engine/$s")) {
 554                 $stamp1 = microtime(true);
 555                 $content = file_get_contents("view/lang/$lang$engine/$s");
 556                 $a->save_timestamp($stamp1, "file");
 557                 return $content;
 558         } elseif (file_exists("view/lang/en$engine/$s")) {
 559                 $stamp1 = microtime(true);
 560                 $content = file_get_contents("view/lang/en$engine/$s");
 561                 $a->save_timestamp($stamp1, "file");
 562                 return $content;
 563         } else {
 564                 $stamp1 = microtime(true);
 565                 $content = file_get_contents("view$engine/$s");
 566                 $a->save_timestamp($stamp1, "file");
 567                 return $content;
 568         }
 569 }
 570
 571
 572 /**
 573  * load template $s
 574  *
 575  * @param string $s
 576  * @param string $root
 577  * @return string
 578  */
 579 function get_markup_template($s, $root = '') {
 580         $stamp1 = microtime(true);
 581
 582         $a = get_app();
 583         $t = $a->template_engine();
 584         try {
 585                 $template = $t->getTemplateFile($s, $root);
 586         } catch (Exception $e) {
 587                 echo "<pre><b>" . __FUNCTION__ . "</b>: " . $e->getMessage() . "</pre>";
 588                 killme();
 589         }
 590
 591         $a->save_timestamp($stamp1, "file");
 592
 593         return $template;
 594 }
 595
 596 /**
 597  *  for html,xml parsing - let's say you've got
 598  *  an attribute foobar="class1 class2 class3"
 599  *  and you want to find out if it contains 'class3'.
 600  *  you can't use a normal sub string search because you
 601  *  might match 'notclass3' and a regex to do the job is
 602  *  possible but a bit complicated.
 603  *  pass the attribute string as $attr and the attribute you
 604  *  are looking for as $s - returns true if found, otherwise false
 605  *
 606  * @param string $attr attribute value
 607  * @param string $s string to search
 608  * @return boolean True if found, False otherwise
 609  */
 610 function attribute_contains($attr, $s) {
 611         $a = explode(' ', $attr);
 612         return (count($a) && in_array($s,$a));
 613 }
 614
 615
 616 /* setup int->string log level map */
 617 $LOGGER_LEVELS = [];
 618
 619 /**
 620  * @brief Logs the given message at the given log level
 621  *
 622  * log levels:
 623  * LOGGER_NORMAL (default)
 624  * LOGGER_TRACE
 625  * LOGGER_DEBUG
 626  * LOGGER_DATA
 627  * LOGGER_ALL
 628  *
 629  * @global App $a
 630  * @global array $LOGGER_LEVELS
 631  * @param string $msg
 632  * @param int $level
 633  */
 634 function logger($msg, $level = 0) {
 635         $a = get_app();
 636         global $LOGGER_LEVELS;
 637
 638         // turn off logger in install mode
 639         if (
 640                 $a->mode == App::MODE_INSTALL
 641                 || !dba::$connected
 642         ) {
 643                 return;
 644         }
 645
 646         $debugging = Config::get('system','debugging');
 647         $logfile   = Config::get('system','logfile');
 648         $loglevel = intval(Config::get('system','loglevel'));
 649
 650         if (
 651                 ! $debugging
 652                 || ! $logfile
 653                 || $level > $loglevel
 654         ) {
 655                 return;
 656         }
 657
 658         if (count($LOGGER_LEVELS) == 0) {
 659                 foreach (get_defined_constants() as $k => $v) {
 660                         if (substr($k, 0, 7) == "LOGGER_") {
 661                                 $LOGGER_LEVELS[$v] = substr($k, 7, 7);
 662                         }
 663                 }
 664         }
 665
 666         $process_id = session_id();
 667
 668         if ($process_id == '') {
 669                 $process_id = get_app()->process_id;
 670         }
 671
 672         $callers = debug_backtrace();
 673         $logline = sprintf("%s@%s\t[%s]:%s:%s:%s\t%s\n",
 674                         DateTimeFormat::utcNow(DateTimeFormat::ATOM),
 675                         $process_id,
 676                         $LOGGER_LEVELS[$level],
 677                         basename($callers[0]['file']),
 678                         $callers[0]['line'],
 679                         $callers[1]['function'],
 680                         $msg
 681                 );
 682
 683         $stamp1 = microtime(true);
 684         @file_put_contents($logfile, $logline, FILE_APPEND);
 685         $a->save_timestamp($stamp1, "file");
 686 }
 687
 688 /**
 689  * @brief An alternative logger for development.
 690  * Works largely as logger() but allows developers
 691  * to isolate particular elements they are targetting
 692  * personally without background noise
 693  *
 694  * log levels:
 695  * LOGGER_NORMAL (default)
 696  * LOGGER_TRACE
 697  * LOGGER_DEBUG
 698  * LOGGER_DATA
 699  * LOGGER_ALL
 700  *
 701  * @global App $a
 702  * @global array $LOGGER_LEVELS
 703  * @param string $msg
 704  * @param int $level
 705  */
 706
 707 function dlogger($msg, $level = 0) {
 708         $a = get_app();
 709
 710         // turn off logger in install mode
 711         if (
 712                 $a->mode == App::MODE_INSTALL
 713                 || !dba::$connected
 714         ) {
 715                 return;
 716         }
 717
 718         $logfile = Config::get('system', 'dlogfile');
 719         if (! $logfile) {
 720                 return;
 721         }
 722
 723         $dlogip = Config::get('system', 'dlogip');
 724         if (!is_null($dlogip) && $_SERVER['REMOTE_ADDR'] != $dlogip) {
 725                 return;
 726         }
 727
 728         if (count($LOGGER_LEVELS) == 0) {
 729                 foreach (get_defined_constants() as $k => $v) {
 730                         if (substr($k, 0, 7) == "LOGGER_") {
 731                                 $LOGGER_LEVELS[$v] = substr($k, 7, 7);
 732                         }
 733                 }
 734         }
 735
 736         $process_id = session_id();
 737
 738         if ($process_id == '') {
 739                 $process_id = get_app()->process_id;
 740         }
 741
 742         $callers = debug_backtrace();
 743         $logline = sprintf("%s@\t%s:\t%s:\t%s\t%s\t%s\n",
 744                         DateTimeFormat::utcNow(),
 745                         $process_id,
 746                         basename($callers[0]['file']),
 747                         $callers[0]['line'],
 748                         $callers[1]['function'],
 749                         $msg
 750                 );
 751
 752         $stamp1 = microtime(true);
 753         @file_put_contents($logfile, $logline, FILE_APPEND);
 754         $a->save_timestamp($stamp1, "file");
 755 }
 756
 757
 758 /**
 759  * Compare activity uri. Knows about activity namespace.
 760  *
 761  * @param string $haystack
 762  * @param string $needle
 763  * @return boolean
 764  */
 765 function activity_match($haystack,$needle) {
 766         return (($haystack === $needle) || ((basename($needle) === $haystack) && strstr($needle, NAMESPACE_ACTIVITY_SCHEMA)));
 767 }
 768
 769
 770 /**
 771  * @brief Pull out all #hashtags and @person tags from $string.
 772  *
 773  * We also get @person@domain.com - which would make
 774  * the regex quite complicated as tags can also
 775  * end a sentence. So we'll run through our results
 776  * and strip the period from any tags which end with one.
 777  * Returns array of tags found, or empty array.
 778  *
 779  * @param string $string Post content
 780  * @return array List of tag and person names
 781  */
 782 function get_tags($string) {
 783         $ret = [];
 784
 785         // Convert hashtag links to hashtags
 786         $string = preg_replace('/#\[url\=([^\[\]]*)\](.*?)\[\/url\]/ism', '#$2', $string);
 787
 788         // ignore anything in a code block
 789         $string = preg_replace('/\[code\](.*?)\[\/code\]/sm', '', $string);
 790
 791         // Force line feeds at bbtags
 792         $string = str_replace(['[', ']'], ["\n[", "]\n"], $string);
 793
 794         // ignore anything in a bbtag
 795         $string = preg_replace('/\[(.*?)\]/sm', '', $string);
 796
 797         // Match full names against @tags including the space between first and last
 798         // We will look these up afterward to see if they are full names or not recognisable.
 799
 800         if (preg_match_all('/(@[^ \x0D\x0A,:?]+ [^ \x0D\x0A@,:?]+)([ \x0D\x0A@,:?]|$)/', $string, $matches)) {
 801                 foreach ($matches[1] as $match) {
 802                         if (strstr($match, ']')) {
 803                                 // we might be inside a bbcode color tag - leave it alone
 804                                 continue;
 805                         }
 806                         if (substr($match, -1, 1) === '.') {
 807                                 $ret[] = substr($match, 0, -1);
 808                         } else {
 809                                 $ret[] = $match;
 810                         }
 811                 }
 812         }
 813
 814         // Otherwise pull out single word tags. These can be @nickname, @first_last
 815         // and #hash tags.
 816
 817         if (preg_match_all('/([!#@][^\^ \x0D\x0A,;:?]+)([ \x0D\x0A,;:?]|$)/', $string, $matches)) {
 818                 foreach ($matches[1] as $match) {
 819                         if (strstr($match, ']')) {
 820                                 // we might be inside a bbcode color tag - leave it alone
 821                                 continue;
 822                         }
 823                         if (substr($match, -1, 1) === '.') {
 824                                 $match = substr($match,0,-1);
 825                         }
 826                         // ignore strictly numeric tags like #1
 827                         if ((strpos($match, '#') === 0) && ctype_digit(substr($match, 1))) {
 828                                 continue;
 829                         }
 830                         // try not to catch url fragments
 831                         if (strpos($string, $match) && preg_match('/[a-zA-z0-9\/]/', substr($string, strpos($string, $match) - 1, 1))) {
 832                                 continue;
 833                         }
 834                         $ret[] = $match;
 835                 }
 836         }
 837         return $ret;
 838 }
 839
 840
 841 /**
 842  * quick and dirty quoted_printable encoding
 843  *
 844  * @param string $s
 845  * @return string
 846  */
 847 function qp($s) {
 848         return str_replace("%", "=", rawurlencode($s));
 849 }
 850
 851
 852 /**
 853  * Get html for contact block.
 854  *
 855  * @template contact_block.tpl
 856  * @hook contact_block_end (contacts=>array, output=>string)
 857  * @return string
 858  */
 859 function contact_block() {
 860         $o = '';
 861         $a = get_app();
 862
 863         $shown = PConfig::get($a->profile['uid'], 'system', 'display_friend_count', 24);
 864         if ($shown == 0) {
 865                 return;
 866         }
 867
 868         if (!is_array($a->profile) || $a->profile['hide-friends']) {
 869                 return $o;
 870         }
 871         $r = q("SELECT COUNT(*) AS `total` FROM `contact`
 872                         WHERE `uid` = %d AND NOT `self` AND NOT `blocked`
 873                                 AND NOT `pending` AND NOT `hidden` AND NOT `archive`
 874                                 AND `network` IN ('%s', '%s', '%s')",
 875                         intval($a->profile['uid']),
 876                         dbesc(NETWORK_DFRN),
 877                         dbesc(NETWORK_OSTATUS),
 878                         dbesc(NETWORK_DIASPORA)
 879         );
 880         if (DBM::is_result($r)) {
 881                 $total = intval($r[0]['total']);
 882         }
 883         if (!$total) {
 884                 $contacts = L10n::t('No contacts');
 885                 $micropro = null;
 886         } else {
 887                 // Splitting the query in two parts makes it much faster
 888                 $r = q("SELECT `id` FROM `contact`
 889                                 WHERE `uid` = %d AND NOT `self` AND NOT `blocked`
 890                                         AND NOT `pending` AND NOT `hidden` AND NOT `archive`
 891                                         AND `network` IN ('%s', '%s', '%s')
 892                                 ORDER BY RAND() LIMIT %d",
 893                                 intval($a->profile['uid']),
 894                                 dbesc(NETWORK_DFRN),
 895                                 dbesc(NETWORK_OSTATUS),
 896                                 dbesc(NETWORK_DIASPORA),
 897                                 intval($shown)
 898                 );
 899                 if (DBM::is_result($r)) {
 900                         $contacts = [];
 901                         foreach ($r AS $contact) {
 902                                 $contacts[] = $contact["id"];
 903                         }
 904                         $r = q("SELECT `id`, `uid`, `addr`, `url`, `name`, `thumb`, `network` FROM `contact` WHERE `id` IN (%s)",
 905                                 dbesc(implode(",", $contacts)));
 906
 907                         if (DBM::is_result($r)) {
 908                                 $contacts = L10n::tt('%d Contact', '%d Contacts', $total);
 909                                 $micropro = [];
 910                                 foreach ($r as $rr) {
 911                                         $micropro[] = micropro($rr, true, 'mpfriend');
 912                                 }
 913                         }
 914                 }
 915         }
 916
 917         $tpl = get_markup_template('contact_block.tpl');
 918         $o = replace_macros($tpl, [
 919                 '$contacts' => $contacts,
 920                 '$nickname' => $a->profile['nickname'],
 921                 '$viewcontacts' => L10n::t('View Contacts'),
 922                 '$micropro' => $micropro,
 923         ]);
 924
 925         $arr = ['contacts' => $r, 'output' => $o];
 926
 927         Addon::callHooks('contact_block_end', $arr);
 928         return $o;
 929
 930 }
 931
 932
 933 /**
 934  * @brief Format contacts as picture links or as texxt links
 935  *
 936  * @param array $contact Array with contacts which contains an array with
 937  *      int 'id' => The ID of the contact
 938  *      int 'uid' => The user ID of the user who owns this data
 939  *      string 'name' => The name of the contact
 940  *      string 'url' => The url to the profile page of the contact
 941  *      string 'addr' => The webbie of the contact (e.g.) username@friendica.com
 942  *      string 'network' => The network to which the contact belongs to
 943  *      string 'thumb' => The contact picture
 944  *      string 'click' => js code which is performed when clicking on the contact
 945  * @param boolean $redirect If true try to use the redir url if it's possible
 946  * @param string $class CSS class for the
 947  * @param boolean $textmode If true display the contacts as text links
 948  *      if false display the contacts as picture links
 949
 950  * @return string Formatted html
 951  */
 952 function micropro($contact, $redirect = false, $class = '', $textmode = false) {
 953
 954         // Use the contact URL if no address is available
 955         if (!x($contact, "addr")) {
 956                 $contact["addr"] = $contact["url"];
 957         }
 958
 959         $url = $contact['url'];
 960         $sparkle = '';
 961         $redir = false;
 962
 963         if ($redirect) {
 964                 $url = Contact::magicLink($contact['url']);
 965                 if (strpos($url, 'redir/') === 0) {
 966                         $sparkle = ' sparkle';
 967                 }
 968         }
 969
 970         // If there is some js available we don't need the url
 971         if (x($contact, 'click')) {
 972                 $url = '';
 973         }
 974
 975         return replace_macros(get_markup_template(($textmode)?'micropro_txt.tpl':'micropro_img.tpl'),[
 976                 '$click' => defaults($contact, 'click', ''),
 977                 '$class' => $class,
 978                 '$url' => $url,
 979                 '$photo' => proxy_url($contact['thumb'], false, PROXY_SIZE_THUMB),
 980                 '$name' => $contact['name'],
 981                 'title' => $contact['name'] . ' [' . $contact['addr'] . ']',
 982                 '$parkle' => $sparkle,
 983                 '$redir' => $redir,
 984
 985         ]);
 986 }
 987
 988 /**
 989  * Search box.
 990  *
 991  * @param string $s     Search query.
 992  * @param string $id    HTML id
 993  * @param string $url   Search url.
 994  * @param bool   $save  Show save search button.
 995  * @param bool   $aside Display the search widgit aside.
 996  *
 997  * @return string Formatted HTML.
 998  */
 999 function search($s, $id = 'search-box', $url = 'search', $save = false, $aside = true)
1000 {
1001         $mode = 'text';
1002
1003         if (strpos($s, '#') === 0) {
1004                 $mode = 'tag';
1005         }
1006         $save_label = $mode === 'text' ? L10n::t('Save') : L10n::t('Follow');
1007
1008         $values = [
1009                         '$s' => htmlspecialchars($s),
1010                         '$id' => $id,
1011                         '$action_url' => $url,
1012                         '$search_label' => L10n::t('Search'),
1013                         '$save_label' => $save_label,
1014                         '$savedsearch' => Feature::isEnabled(local_user(),'savedsearch'),
1015                         '$search_hint' => L10n::t('@name, !forum, #tags, content'),
1016                         '$mode' => $mode
1017                 ];
1018
1019         if (!$aside) {
1020                 $values['$searchoption'] = [
1021                                         L10n::t("Full Text"),
1022                                         L10n::t("Tags"),
1023                                         L10n::t("Contacts")];
1024
1025                 if (Config::get('system','poco_local_search')) {
1026                         $values['$searchoption'][] = L10n::t("Forums");
1027                 }
1028         }
1029
1030         return replace_macros(get_markup_template('searchbox.tpl'), $values);
1031 }
1032
1033 /**
1034  * @brief Check for a valid email string
1035  *
1036  * @param string $email_address
1037  * @return boolean
1038  */
1039 function valid_email($email_address)
1040 {
1041         return preg_match('/^[_a-zA-Z0-9\-\+]+(\.[_a-zA-Z0-9\-\+]+)*@[a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)+$/', $email_address);
1042 }
1043
1044
1045 /**
1046  * Replace naked text hyperlink with HTML formatted hyperlink
1047  *
1048  * @param string $s
1049  */
1050 function linkify($s) {
1051         $s = preg_replace("/(https?\:\/\/[a-zA-Z0-9\:\/\-\?\&\;\.\=\_\~\#\'\%\$\!\+]*)/", ' <a href="$1" target="_blank">$1</a>', $s);
1052         $s = preg_replace("/\<(.*?)(src|href)=(.*?)\&amp\;(.*?)\>/ism",'<$1$2=$3&$4>',$s);
1053         return $s;
1054 }
1055
1056
1057 /**
1058  * Load poke verbs
1059  *
1060  * @return array index is present tense verb
1061  *                               value is array containing past tense verb, translation of present, translation of past
1062  * @hook poke_verbs pokes array
1063  */
1064 function get_poke_verbs() {
1065
1066         // index is present tense verb
1067         // value is array containing past tense verb, translation of present, translation of past
1068
1069         $arr = [
1070                 'poke' => ['poked', L10n::t('poke'), L10n::t('poked')],
1071                 'ping' => ['pinged', L10n::t('ping'), L10n::t('pinged')],
1072                 'prod' => ['prodded', L10n::t('prod'), L10n::t('prodded')],
1073                 'slap' => ['slapped', L10n::t('slap'), L10n::t('slapped')],
1074                 'finger' => ['fingered', L10n::t('finger'), L10n::t('fingered')],
1075                 'rebuff' => ['rebuffed', L10n::t('rebuff'), L10n::t('rebuffed')],
1076         ];
1077         Addon::callHooks('poke_verbs', $arr);
1078         return $arr;
1079 }
1080
1081 /**
1082  * @brief Translate days and months names.
1083  *
1084  * @param string $s String with day or month name.
1085  * @return string Translated string.
1086  */
1087 function day_translate($s) {
1088         $ret = str_replace(['Monday','Tuesday','Wednesday','Thursday','Friday','Saturday','Sunday'],
1089                 [L10n::t('Monday'), L10n::t('Tuesday'), L10n::t('Wednesday'), L10n::t('Thursday'), L10n::t('Friday'), L10n::t('Saturday'), L10n::t('Sunday')],
1090                 $s);
1091
1092         $ret = str_replace(['January','February','March','April','May','June','July','August','September','October','November','December'],
1093                 [L10n::t('January'), L10n::t('February'), L10n::t('March'), L10n::t('April'), L10n::t('May'), L10n::t('June'), L10n::t('July'), L10n::t('August'), L10n::t('September'), L10n::t('October'), L10n::t('November'), L10n::t('December')],
1094                 $ret);
1095
1096         return $ret;
1097 }
1098
1099 /**
1100  * @brief Translate short days and months names.
1101  *
1102  * @param string $s String with short day or month name.
1103  * @return string Translated string.
1104  */
1105 function day_short_translate($s) {
1106         $ret = str_replace(['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun'],
1107                 [L10n::t('Mon'), L10n::t('Tue'), L10n::t('Wed'), L10n::t('Thu'), L10n::t('Fri'), L10n::t('Sat'), L10n::t('Sun')],
1108                 $s);
1109         $ret = str_replace(['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov','Dec'],
1110                 [L10n::t('Jan'), L10n::t('Feb'), L10n::t('Mar'), L10n::t('Apr'), L10n::t('May'), ('Jun'), L10n::t('Jul'), L10n::t('Aug'), L10n::t('Sep'), L10n::t('Oct'), L10n::t('Nov'), L10n::t('Dec')],
1111                 $ret);
1112         return $ret;
1113 }
1114
1115
1116 /**
1117  * Normalize url
1118  *
1119  * @param string $url
1120  * @return string
1121  */
1122 function normalise_link($url) {
1123         $ret = str_replace(['https:', '//www.'], ['http:', '//'], $url);
1124         return rtrim($ret,'/');
1125 }
1126
1127
1128 /**
1129  * Compare two URLs to see if they are the same, but ignore
1130  * slight but hopefully insignificant differences such as if one
1131  * is https and the other isn't, or if one is www.something and
1132  * the other isn't - and also ignore case differences.
1133  *
1134  * @param string $a first url
1135  * @param string $b second url
1136  * @return boolean True if the URLs match, otherwise False
1137  *
1138  */
1139 function link_compare($a, $b) {
1140         return (strcasecmp(normalise_link($a), normalise_link($b)) === 0);
1141 }
1142
1143
1144 /**
1145  * @brief Find any non-embedded images in private items and add redir links to them
1146  *
1147  * @param App $a
1148  * @param array &$item The field array of an item row
1149  */
1150 function redir_private_images($a, &$item)
1151 {
1152         $matches = false;
1153         $cnt = preg_match_all('|\[img\](http[^\[]*?/photo/[a-fA-F0-9]+?(-[0-9]\.[\w]+?)?)\[\/img\]|', $item['body'], $matches, PREG_SET_ORDER);
1154         if ($cnt) {
1155                 foreach ($matches as $mtch) {
1156                         if (strpos($mtch[1], '/redir') !== false) {
1157                                 continue;
1158                         }
1159
1160                         if ((local_user() == $item['uid']) && ($item['private'] != 0) && ($item['contact-id'] != $a->contact['id']) && ($item['network'] == NETWORK_DFRN)) {
1161                                 $img_url = 'redir?f=1&quiet=1&url=' . urlencode($mtch[1]) . '&conurl=' . urlencode($item['author-link']);
1162                                 $item['body'] = str_replace($mtch[0], '[img]' . $img_url . '[/img]', $item['body']);
1163                         }
1164                 }
1165         }
1166 }
1167
1168 /**
1169  * Sets the "rendered-html" field of the provided item
1170  *
1171  * Body is preserved to avoid side-effects as we modify it just-in-time for spoilers and private image links
1172  *
1173  * @param array $item
1174  * @param bool  $update
1175  *
1176  * @todo Remove reference, simply return "rendered-html" and "rendered-hash"
1177  */
1178 function put_item_in_cache(&$item, $update = false)
1179 {
1180         $body = $item["body"];
1181
1182         $rendered_hash = defaults($item, 'rendered-hash', '');
1183         $rendered_html = defaults($item, 'rendered-html', '');
1184
1185         if ($rendered_hash == ''
1186                 || $item["rendered-html"] == ""
1187                 || $rendered_hash != hash("md5", $item["body"])
1188                 || Config::get("system", "ignore_cache")
1189         ) {
1190                 $a = get_app();
1191                 redir_private_images($a, $item);
1192
1193                 $item["rendered-html"] = prepare_text($item["body"]);
1194                 $item["rendered-hash"] = hash("md5", $item["body"]);
1195
1196                 // Force an update if the generated values differ from the existing ones
1197                 if ($rendered_hash != $item["rendered-hash"]) {
1198                         $update = true;
1199                 }
1200
1201                 // Only compare the HTML when we forcefully ignore the cache
1202                 if (Config::get("system", "ignore_cache") && ($rendered_html != $item["rendered-html"])) {
1203                         $update = true;
1204                 }
1205
1206                 if ($update && ($item["id"] > 0)) {
1207                         dba::update('item', ['rendered-html' => $item["rendered-html"], 'rendered-hash' => $item["rendered-hash"]],
1208                                         ['id' => $item["id"]], false);
1209                 }
1210         }
1211
1212         $item["body"] = $body;
1213 }
1214
1215 /**
1216  * @brief Given an item array, convert the body element from bbcode to html and add smilie icons.
1217  * If attach is true, also add icons for item attachments.
1218  *
1219  * @param array   $item
1220  * @param boolean $attach
1221  * @param boolean $is_preview
1222  * @return string item body html
1223  * @hook prepare_body_init item array before any work
1224  * @hook prepare_body_content_filter ('item'=>item array, 'filter_reasons'=>string array) before first bbcode to html
1225  * @hook prepare_body ('item'=>item array, 'html'=>body string, 'is_preview'=>boolean, 'filter_reasons'=>string array) after first bbcode to html
1226  * @hook prepare_body_final ('item'=>item array, 'html'=>body string) after attach icons and blockquote special case handling (spoiler, author)
1227  */
1228 function prepare_body(array &$item, $attach = false, $is_preview = false)
1229 {
1230         $a = get_app();
1231         Addon::callHooks('prepare_body_init', $item);
1232
1233         // In order to provide theme developers more possibilities, event items
1234         // are treated differently.
1235         if ($item['object-type'] === ACTIVITY_OBJ_EVENT && isset($item['event-id'])) {
1236                 $ev = Event::getItemHTML($item);
1237                 return $ev;
1238         }
1239
1240         $tags = \Friendica\Model\Term::populateTagsFromItem($item);
1241
1242         $item['tags'] = $tags['tags'];
1243         $item['hashtags'] = $tags['hashtags'];
1244         $item['mentions'] = $tags['mentions'];
1245
1246         // Compile eventual content filter reasons
1247         $filter_reasons = [];
1248         if (!$is_preview && public_contact() != $item['author-id']) {
1249                 if (!empty($item['content-warning']) && (!local_user() || !PConfig::get(local_user(), 'system', 'disable_cw', false))) {
1250                         $filter_reasons[] = L10n::t('Content warning: %s', $item['content-warning']);
1251                 }
1252
1253                 $hook_data = [
1254                         'item' => $item,
1255                         'filter_reasons' => $filter_reasons
1256                 ];
1257                 Addon::callHooks('prepare_body_content_filter', $hook_data);
1258                 $filter_reasons = $hook_data['filter_reasons'];
1259                 unset($hook_data);
1260         }
1261
1262         // Update the cached values if there is no "zrl=..." on the links.
1263         $update = (!local_user() && !remote_user() && ($item["uid"] == 0));
1264
1265         // Or update it if the current viewer is the intented viewer.
1266         if (($item["uid"] == local_user()) && ($item["uid"] != 0)) {
1267                 $update = true;
1268         }
1269
1270         put_item_in_cache($item, $update);
1271         $s = $item["rendered-html"];
1272
1273         $hook_data = [
1274                 'item' => $item,
1275                 'html' => $s,
1276                 'preview' => $is_preview,
1277                 'filter_reasons' => $filter_reasons
1278         ];
1279         Addon::callHooks('prepare_body', $hook_data);
1280         $s = $hook_data['html'];
1281         unset($hook_data);
1282
1283         if (! $attach) {
1284                 // Replace the blockquotes with quotes that are used in mails.
1285                 $mailquote = '<blockquote type="cite" class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">';
1286                 $s = str_replace(['<blockquote>', '<blockquote class="spoiler">', '<blockquote class="author">'], [$mailquote, $mailquote, $mailquote], $s);
1287                 return $s;
1288         }
1289
1290         $as = '';
1291         $vhead = false;
1292         $matches = [];
1293         preg_match_all('|\[attach\]href=\"(.*?)\" length=\"(.*?)\" type=\"(.*?)\"(?: title=\"(.*?)\")?|', $item['attach'], $matches, PREG_SET_ORDER);
1294         foreach ($matches as $mtch) {
1295                 $mime = $mtch[3];
1296
1297                 $the_url = Contact::magicLinkById($item['author-id'], $mtch[1]);
1298
1299                 if (strpos($mime, 'video') !== false) {
1300                         if (!$vhead) {
1301                                 $vhead = true;
1302                                 $a->page['htmlhead'] .= replace_macros(get_markup_template('videos_head.tpl'), [
1303                                         '$baseurl' => System::baseUrl(),
1304                                 ]);
1305                                 $a->page['end'] .= replace_macros(get_markup_template('videos_end.tpl'), [
1306                                         '$baseurl' => System::baseUrl(),
1307                                 ]);
1308                         }
1309
1310                         $id = end(explode('/', $the_url));
1311                         $as .= replace_macros(get_markup_template('video_top.tpl'), [
1312                                 '$video' => [
1313                                         'id'     => $id,
1314                                         'title'  => L10n::t('View Video'),
1315                                         'src'    => $the_url,
1316                                         'mime'   => $mime,
1317                                 ],
1318                         ]);
1319                 }
1320
1321                 $filetype = strtolower(substr($mime, 0, strpos($mime, '/')));
1322                 if ($filetype) {
1323                         $filesubtype = strtolower(substr($mime, strpos($mime, '/') + 1));
1324                         $filesubtype = str_replace('.', '-', $filesubtype);
1325                 } else {
1326                         $filetype = 'unkn';
1327                         $filesubtype = 'unkn';
1328                 }
1329
1330                 $title = escape_tags(trim(!empty($mtch[4]) ? $mtch[4] : $mtch[1]));
1331                 $title .= ' ' . $mtch[2] . ' ' . L10n::t('bytes');
1332
1333                 $icon = '<div class="attachtype icon s22 type-' . $filetype . ' subtype-' . $filesubtype . '"></div>';
1334                 $as .= '<a href="' . strip_tags($the_url) . '" title="' . $title . '" class="attachlink" target="_blank" >' . $icon . '</a>';
1335         }
1336
1337         if ($as != '') {
1338                 $s .= '<div class="body-attach">'.$as.'<div class="clear"></div></div>';
1339         }
1340
1341         // Map.
1342         if (strpos($s, '<div class="map">') !== false && x($item, 'coord')) {
1343                 $x = Map::byCoordinates(trim($item['coord']));
1344                 if ($x) {
1345                         $s = preg_replace('/\<div class\=\"map\"\>/', '$0' . $x, $s);
1346                 }
1347         }
1348
1349
1350         // Look for spoiler.
1351         $spoilersearch = '<blockquote class="spoiler">';
1352
1353         // Remove line breaks before the spoiler.
1354         while ((strpos($s, "\n" . $spoilersearch) !== false)) {
1355                 $s = str_replace("\n" . $spoilersearch, $spoilersearch, $s);
1356         }
1357         while ((strpos($s, "<br />" . $spoilersearch) !== false)) {
1358                 $s = str_replace("<br />" . $spoilersearch, $spoilersearch, $s);
1359         }
1360
1361         while ((strpos($s, $spoilersearch) !== false)) {
1362                 $pos = strpos($s, $spoilersearch);
1363                 $rnd = random_string(8);
1364                 $spoilerreplace = '<br /> <span id="spoiler-wrap-' . $rnd . '" class="spoiler-wrap fakelink" onclick="openClose(\'spoiler-' . $rnd . '\');">' . L10n::t('Click to open/close') . '</span>'.
1365                                         '<blockquote class="spoiler" id="spoiler-' . $rnd . '" style="display: none;">';
1366                 $s = substr($s, 0, $pos) . $spoilerreplace . substr($s, $pos + strlen($spoilersearch));
1367         }
1368
1369         // Look for quote with author.
1370         $authorsearch = '<blockquote class="author">';
1371
1372         while ((strpos($s, $authorsearch) !== false)) {
1373                 $pos = strpos($s, $authorsearch);
1374                 $rnd = random_string(8);
1375                 $authorreplace = '<br /> <span id="author-wrap-' . $rnd . '" class="author-wrap fakelink" onclick="openClose(\'author-' . $rnd . '\');">' . L10n::t('Click to open/close') . '</span>'.
1376                                         '<blockquote class="author" id="author-' . $rnd . '" style="display: block;">';
1377                 $s = substr($s, 0, $pos) . $authorreplace . substr($s, $pos + strlen($authorsearch));
1378         }
1379
1380         // Replace friendica image url size with theme preference.
1381         if (x($a->theme_info, 'item_image_size')){
1382                 $ps = $a->theme_info['item_image_size'];
1383                 $s = preg_replace('|(<img[^>]+src="[^"]+/photo/[0-9a-f]+)-[0-9]|', "$1-" . $ps, $s);
1384         }
1385
1386         $s = apply_content_filter($s, $filter_reasons);
1387
1388         $hook_data = ['item' => $item, 'html' => $s];
1389         Addon::callHooks('prepare_body_final', $hook_data);
1390
1391         return $hook_data['html'];
1392 }
1393
1394 /**
1395  * Given a HTML text and a set of filtering reasons, adds a content hiding header with the provided reasons
1396  *
1397  * Reasons are expected to have been translated already.
1398  *
1399  * @param string $html
1400  * @param array  $reasons
1401  * @return string
1402  */
1403 function apply_content_filter($html, array $reasons)
1404 {
1405         if (count($reasons)) {
1406                 $tpl = get_markup_template('wall/content_filter.tpl');
1407                 $html = replace_macros($tpl, [
1408                         '$reasons'   => $reasons,
1409                         '$rnd'       => random_string(8),
1410                         '$openclose' => L10n::t('Click to open/close'),
1411                         '$html'      => $html
1412                 ]);
1413         }
1414
1415         return $html;
1416 }
1417
1418 /**
1419  * @brief Given a text string, convert from bbcode to html and add smilie icons.
1420  *
1421  * @param string $text String with bbcode.
1422  * @return string Formattet HTML.
1423  */
1424 function prepare_text($text) {
1425         if (stristr($text, '[nosmile]')) {
1426                 $s = BBCode::convert($text);
1427         } else {
1428                 $s = Smilies::replace(BBCode::convert($text));
1429         }
1430
1431         return trim($s);
1432 }
1433
1434 /**
1435  * return array with details for categories and folders for an item
1436  *
1437  * @param array $item
1438  * @return array
1439  *
1440   * [
1441  *      [ // categories array
1442  *          {
1443  *               'name': 'category name',
1444  *               'removeurl': 'url to remove this category',
1445  *               'first': 'is the first in this array? true/false',
1446  *               'last': 'is the last in this array? true/false',
1447  *           } ,
1448  *           ....
1449  *       ],
1450  *       [ //folders array
1451  *                      {
1452  *               'name': 'folder name',
1453  *               'removeurl': 'url to remove this folder',
1454  *               'first': 'is the first in this array? true/false',
1455  *               'last': 'is the last in this array? true/false',
1456  *           } ,
1457  *           ....
1458  *       ]
1459  *  ]
1460  */
1461 function get_cats_and_terms($item)
1462 {
1463         $categories = [];
1464         $folders = [];
1465
1466         $matches = false;
1467         $first = true;
1468         $cnt = preg_match_all('/<(.*?)>/', $item['file'], $matches, PREG_SET_ORDER);
1469         if ($cnt) {
1470                 foreach ($matches as $mtch) {
1471                         $categories[] = [
1472                                 'name' => xmlify(file_tag_decode($mtch[1])),
1473                                 'url' =>  "#",
1474                                 'removeurl' => ((local_user() == $item['uid'])?'filerm/' . $item['id'] . '?f=&cat=' . xmlify(file_tag_decode($mtch[1])):""),
1475                                 'first' => $first,
1476                                 'last' => false
1477                         ];
1478                         $first = false;
1479                 }
1480         }
1481
1482         if (count($categories)) {
1483                 $categories[count($categories) - 1]['last'] = true;
1484         }
1485
1486         if (local_user() == $item['uid']) {
1487                 $matches = false;
1488                 $first = true;
1489                 $cnt = preg_match_all('/\[(.*?)\]/', $item['file'], $matches, PREG_SET_ORDER);
1490                 if ($cnt) {
1491                         foreach ($matches as $mtch) {
1492                                 $folders[] = [
1493                                         'name' => xmlify(file_tag_decode($mtch[1])),
1494                                         'url' =>  "#",
1495                                         'removeurl' => ((local_user() == $item['uid']) ? 'filerm/' . $item['id'] . '?f=&term=' . xmlify(file_tag_decode($mtch[1])) : ""),
1496                                         'first' => $first,
1497                                         'last' => false
1498                                 ];
1499                                 $first = false;
1500                         }
1501                 }
1502         }
1503
1504         if (count($folders)) {
1505                 $folders[count($folders) - 1]['last'] = true;
1506         }
1507
1508         return [$categories, $folders];
1509 }
1510
1511
1512 /**
1513  * get private link for item
1514  * @param array $item
1515  * @return boolean|array False if item has not plink, otherwise array('href'=>plink url, 'title'=>translated title)
1516  */
1517 function get_plink($item) {
1518         $a = get_app();
1519
1520         if ($a->user['nickname'] != "") {
1521                 $ret = [
1522                                 //'href' => "display/" . $a->user['nickname'] . "/" . $item['id'],
1523                                 'href' => "display/" . $item['guid'],
1524                                 'orig' => "display/" . $item['guid'],
1525                                 'title' => L10n::t('View on separate page'),
1526                                 'orig_title' => L10n::t('view on separate page'),
1527                         ];
1528
1529                 if (x($item, 'plink')) {
1530                         $ret["href"] = $a->remove_baseurl($item['plink']);
1531                         $ret["title"] = L10n::t('link to source');
1532                 }
1533
1534         } elseif (x($item, 'plink') && ($item['private'] != 1)) {
1535                 $ret = [
1536                                 'href' => $item['plink'],
1537                                 'orig' => $item['plink'],
1538                                 'title' => L10n::t('link to source'),
1539                         ];
1540         } else {
1541                 $ret = [];
1542         }
1543
1544         return $ret;
1545 }
1546
1547
1548 /**
1549  * replace html amp entity with amp char
1550  * @param string $s
1551  * @return string
1552  */
1553 function unamp($s) {
1554         return str_replace('&amp;', '&', $s);
1555 }
1556
1557
1558 /**
1559  * return number of bytes in size (K, M, G)
1560  * @param string $size_str
1561  * @return number
1562  */
1563 function return_bytes($size_str) {
1564         switch (substr ($size_str, -1)) {
1565                 case 'M': case 'm': return (int)$size_str * 1048576;
1566                 case 'K': case 'k': return (int)$size_str * 1024;
1567                 case 'G': case 'g': return (int)$size_str * 1073741824;
1568                 default: return $size_str;
1569         }
1570 }
1571
1572
1573 /**
1574  * @return string
1575  */
1576 function generate_user_guid() {
1577         $found = true;
1578         do {
1579                 $guid = get_guid(32);
1580                 $x = q("SELECT `uid` FROM `user` WHERE `guid` = '%s' LIMIT 1",
1581                         dbesc($guid)
1582                 );
1583                 if (! DBM::is_result($x)) {
1584                         $found = false;
1585                 }
1586         } while ($found == true);
1587
1588         return $guid;
1589 }
1590
1591
1592 /**
1593  * @param string $s
1594  * @param boolean $strip_padding
1595  * @return string
1596  */
1597 function base64url_encode($s, $strip_padding = false) {
1598
1599         $s = strtr(base64_encode($s), '+/', '-_');
1600
1601         if ($strip_padding) {
1602                 $s = str_replace('=','',$s);
1603         }
1604
1605         return $s;
1606 }
1607
1608 /**
1609  * @param string $s
1610  * @return string
1611  */
1612 function base64url_decode($s) {
1613
1614         if (is_array($s)) {
1615                 logger('base64url_decode: illegal input: ' . print_r(debug_backtrace(), true));
1616                 return $s;
1617         }
1618
1619 /*
1620  *  // Placeholder for new rev of salmon which strips base64 padding.
1621  *  // PHP base64_decode handles the un-padded input without requiring this step
1622  *  // Uncomment if you find you need it.
1623  *
1624  *      $l = strlen($s);
1625  *      if (! strpos($s,'=')) {
1626  *              $m = $l % 4;
1627  *              if ($m == 2)
1628  *                      $s .= '==';
1629  *              if ($m == 3)
1630  *                      $s .= '=';
1631  *      }
1632  *
1633  */
1634
1635         return base64_decode(strtr($s,'-_','+/'));
1636 }
1637
1638
1639 /**
1640  * return div element with class 'clear'
1641  * @return string
1642  * @deprecated
1643  */
1644 function cleardiv() {
1645         return '<div class="clear"></div>';
1646 }
1647
1648
1649 function bb_translate_video($s) {
1650
1651         $matches = null;
1652         $r = preg_match_all("/\[video\](.*?)\[\/video\]/ism",$s,$matches,PREG_SET_ORDER);
1653         if ($r) {
1654                 foreach ($matches as $mtch) {
1655                         if ((stristr($mtch[1], 'youtube')) || (stristr($mtch[1], 'youtu.be'))) {
1656                                 $s = str_replace($mtch[0], '[youtube]' . $mtch[1] . '[/youtube]', $s);
1657                         } elseif (stristr($mtch[1], 'vimeo')) {
1658                                 $s = str_replace($mtch[0], '[vimeo]' . $mtch[1] . '[/vimeo]', $s);
1659                         }
1660                 }
1661         }
1662         return $s;
1663 }
1664
1665 function html2bb_video($s) {
1666
1667         $s = preg_replace('#<object[^>]+>(.*?)https?://www.youtube.com/((?:v|cp)/[A-Za-z0-9\-_=]+)(.*?)</object>#ism',
1668                         '[youtube]$2[/youtube]', $s);
1669
1670         $s = preg_replace('#<iframe[^>](.*?)https?://www.youtube.com/embed/([A-Za-z0-9\-_=]+)(.*?)</iframe>#ism',
1671                         '[youtube]$2[/youtube]', $s);
1672
1673         $s = preg_replace('#<iframe[^>](.*?)https?://player.vimeo.com/video/([0-9]+)(.*?)</iframe>#ism',
1674                         '[vimeo]$2[/vimeo]', $s);
1675
1676         return $s;
1677 }
1678
1679 /**
1680  * apply xmlify() to all values of array $val, recursively
1681  * @param array $val
1682  * @return array
1683  */
1684 function array_xmlify($val){
1685         if (is_bool($val)) {
1686                 return $val?"true":"false";
1687         } elseif (is_array($val)) {
1688                 return array_map('array_xmlify', $val);
1689         }
1690         return xmlify((string) $val);
1691 }
1692
1693
1694 /**
1695  * transform link href and img src from relative to absolute
1696  *
1697  * @param string $text
1698  * @param string $base base url
1699  * @return string
1700  */
1701 function reltoabs($text, $base) {
1702         if (empty($base)) {
1703                 return $text;
1704         }
1705
1706         $base = rtrim($base,'/');
1707
1708         $base2 = $base . "/";
1709
1710         // Replace links
1711         $pattern = "/<a([^>]*) href=\"(?!http|https|\/)([^\"]*)\"/";
1712         $replace = "<a\${1} href=\"" . $base2 . "\${2}\"";
1713         $text = preg_replace($pattern, $replace, $text);
1714
1715         $pattern = "/<a([^>]*) href=\"(?!http|https)([^\"]*)\"/";
1716         $replace = "<a\${1} href=\"" . $base . "\${2}\"";
1717         $text = preg_replace($pattern, $replace, $text);
1718
1719         // Replace images
1720         $pattern = "/<img([^>]*) src=\"(?!http|https|\/)([^\"]*)\"/";
1721         $replace = "<img\${1} src=\"" . $base2 . "\${2}\"";
1722         $text = preg_replace($pattern, $replace, $text);
1723
1724         $pattern = "/<img([^>]*) src=\"(?!http|https)([^\"]*)\"/";
1725         $replace = "<img\${1} src=\"" . $base . "\${2}\"";
1726         $text = preg_replace($pattern, $replace, $text);
1727
1728
1729         // Done
1730         return $text;
1731 }
1732
1733 /**
1734  * get translated item type
1735  *
1736  * @param array $itme
1737  * @return string
1738  */
1739 function item_post_type($item) {
1740         if (intval($item['event-id'])) {
1741                 return L10n::t('event');
1742         } elseif (strlen($item['resource-id'])) {
1743                 return L10n::t('photo');
1744         } elseif (strlen($item['verb']) && $item['verb'] !== ACTIVITY_POST) {
1745                 return L10n::t('activity');
1746         } elseif ($item['id'] != $item['parent']) {
1747                 return L10n::t('comment');
1748         }
1749
1750         return L10n::t('post');
1751 }
1752
1753 // post categories and "save to file" use the same item.file table for storage.
1754 // We will differentiate the different uses by wrapping categories in angle brackets
1755 // and save to file categories in square brackets.
1756 // To do this we need to escape these characters if they appear in our tag.
1757
1758 function file_tag_encode($s) {
1759         return str_replace(['<','>','[',']'],['%3c','%3e','%5b','%5d'],$s);
1760 }
1761
1762 function file_tag_decode($s) {
1763         return str_replace(['%3c', '%3e', '%5b', '%5d'], ['<', '>', '[', ']'], $s);
1764 }
1765
1766 function file_tag_file_query($table,$s,$type = 'file') {
1767
1768         if ($type == 'file') {
1769                 $str = preg_quote('[' . str_replace('%', '%%', file_tag_encode($s)) . ']');
1770         } else {
1771                 $str = preg_quote('<' . str_replace('%', '%%', file_tag_encode($s)) . '>');
1772         }
1773         return " AND " . (($table) ? dbesc($table) . '.' : '') . "file regexp '" . dbesc($str) . "' ";
1774 }
1775
1776 // ex. given music,video return <music><video> or [music][video]
1777 function file_tag_list_to_file($list, $type = 'file') {
1778         $tag_list = '';
1779         if (strlen($list)) {
1780                 $list_array = explode(",",$list);
1781                 if ($type == 'file') {
1782                         $lbracket = '[';
1783                         $rbracket = ']';
1784                 } else {
1785                         $lbracket = '<';
1786                         $rbracket = '>';
1787                 }
1788
1789                 foreach ($list_array as $item) {
1790                         if (strlen($item)) {
1791                                 $tag_list .= $lbracket . file_tag_encode(trim($item))  . $rbracket;
1792                         }
1793                 }
1794         }
1795         return $tag_list;
1796 }
1797
1798 // ex. given <music><video>[friends], return music,video or friends
1799 function file_tag_file_to_list($file, $type = 'file') {
1800         $matches = false;
1801         $list = '';
1802         if ($type == 'file') {
1803                 $cnt = preg_match_all('/\[(.*?)\]/', $file, $matches, PREG_SET_ORDER);
1804         } else {
1805                 $cnt = preg_match_all('/<(.*?)>/', $file, $matches, PREG_SET_ORDER);
1806         }
1807         if ($cnt) {
1808                 foreach ($matches as $mtch) {
1809                         if (strlen($list)) {
1810                                 $list .= ',';
1811                         }
1812                         $list .= file_tag_decode($mtch[1]);
1813                 }
1814         }
1815
1816         return $list;
1817 }
1818
1819 function file_tag_update_pconfig($uid, $file_old, $file_new, $type = 'file') {
1820         // $file_old - categories previously associated with an item
1821         // $file_new - new list of categories for an item
1822
1823         if (!intval($uid)) {
1824                 return false;
1825         } elseif ($file_old == $file_new) {
1826                 return true;
1827         }
1828
1829         $saved = PConfig::get($uid, 'system', 'filetags');
1830         if (strlen($saved)) {
1831                 if ($type == 'file') {
1832                         $lbracket = '[';
1833                         $rbracket = ']';
1834                         $termtype = TERM_FILE;
1835                 } else {
1836                         $lbracket = '<';
1837                         $rbracket = '>';
1838                         $termtype = TERM_CATEGORY;
1839                 }
1840
1841                 $filetags_updated = $saved;
1842
1843                 // check for new tags to be added as filetags in pconfig
1844                 $new_tags = [];
1845                 $check_new_tags = explode(",",file_tag_file_to_list($file_new,$type));
1846
1847                 foreach ($check_new_tags as $tag) {
1848                         if (! stristr($saved,$lbracket . file_tag_encode($tag) . $rbracket)) {
1849                                 $new_tags[] = $tag;
1850                         }
1851                 }
1852
1853                 $filetags_updated .= file_tag_list_to_file(implode(",",$new_tags),$type);
1854
1855                 // check for deleted tags to be removed from filetags in pconfig
1856                 $deleted_tags = [];
1857                 $check_deleted_tags = explode(",",file_tag_file_to_list($file_old,$type));
1858
1859                 foreach ($check_deleted_tags as $tag) {
1860                         if (! stristr($file_new,$lbracket . file_tag_encode($tag) . $rbracket)) {
1861                                 $deleted_tags[] = $tag;
1862                         }
1863                 }
1864
1865                 foreach ($deleted_tags as $key => $tag) {
1866                         $r = q("SELECT `oid` FROM `term` WHERE `term` = '%s' AND `otype` = %d AND `type` = %d AND `uid` = %d",
1867                                 dbesc($tag),
1868                                 intval(TERM_OBJ_POST),
1869                                 intval($termtype),
1870                                 intval($uid));
1871
1872                         if (DBM::is_result($r)) {
1873                                 unset($deleted_tags[$key]);
1874                         } else {
1875                                 $filetags_updated = str_replace($lbracket . file_tag_encode($tag) . $rbracket,'',$filetags_updated);
1876                         }
1877                 }
1878
1879                 if ($saved != $filetags_updated) {
1880                         PConfig::set($uid, 'system', 'filetags', $filetags_updated);
1881                 }
1882                 return true;
1883         } elseif (strlen($file_new)) {
1884                 PConfig::set($uid, 'system', 'filetags', $file_new);
1885         }
1886         return true;
1887 }
1888
1889 function file_tag_save_file($uid, $item, $file)
1890 {
1891         if (! intval($uid)) {
1892                 return false;
1893         }
1894
1895         $r = q("SELECT `file` FROM `item` WHERE `id` = %d AND `uid` = %d LIMIT 1",
1896                 intval($item),
1897                 intval($uid)
1898         );
1899         if (DBM::is_result($r)) {
1900                 if (!stristr($r[0]['file'],'[' . file_tag_encode($file) . ']')) {
1901                         $fields = ['file' => $r[0]['file'] . '[' . file_tag_encode($file) . ']'];
1902                         Item::update($fields, ['id' => $item]);
1903                 }
1904                 $saved = PConfig::get($uid, 'system', 'filetags');
1905                 if (!strlen($saved) || !stristr($saved, '[' . file_tag_encode($file) . ']')) {
1906                         PConfig::set($uid, 'system', 'filetags', $saved . '[' . file_tag_encode($file) . ']');
1907                 }
1908                 info(L10n::t('Item filed'));
1909         }
1910         return true;
1911 }
1912
1913 function file_tag_unsave_file($uid, $item, $file, $cat = false)
1914 {
1915         if (! intval($uid)) {
1916                 return false;
1917         }
1918
1919         if ($cat == true) {
1920                 $pattern = '<' . file_tag_encode($file) . '>' ;
1921                 $termtype = TERM_CATEGORY;
1922         } else {
1923                 $pattern = '[' . file_tag_encode($file) . ']' ;
1924                 $termtype = TERM_FILE;
1925         }
1926
1927         $r = q("SELECT `file` FROM `item` WHERE `id` = %d AND `uid` = %d LIMIT 1",
1928                 intval($item),
1929                 intval($uid)
1930         );
1931         if (! DBM::is_result($r)) {
1932                 return false;
1933         }
1934
1935         $fields = ['file' => str_replace($pattern,'',$r[0]['file'])];
1936         Item::update($fields, ['id' => $item]);
1937
1938         $r = q("SELECT `oid` FROM `term` WHERE `term` = '%s' AND `otype` = %d AND `type` = %d AND `uid` = %d",
1939                 dbesc($file),
1940                 intval(TERM_OBJ_POST),
1941                 intval($termtype),
1942                 intval($uid)
1943         );
1944         if (!DBM::is_result($r)) {
1945                 $saved = PConfig::get($uid, 'system', 'filetags');
1946                 PConfig::set($uid, 'system', 'filetags', str_replace($pattern, '', $saved));
1947         }
1948
1949         return true;
1950 }
1951
1952 function normalise_openid($s) {
1953         return trim(str_replace(['http://', 'https://'], ['', ''], $s), '/');
1954 }
1955
1956
1957 function undo_post_tagging($s) {
1958         $matches = null;
1959         $cnt = preg_match_all('/([!#@])\[url=(.*?)\](.*?)\[\/url\]/ism', $s, $matches, PREG_SET_ORDER);
1960         if ($cnt) {
1961                 foreach ($matches as $mtch) {
1962                         if (in_array($mtch[1], ['!', '@'])) {
1963                                 $contact = Contact::getDetailsByURL($mtch[2]);
1964                                 $mtch[3] = empty($contact['addr']) ? $mtch[2] : $contact['addr'];
1965                         }
1966                         $s = str_replace($mtch[0], $mtch[1] . $mtch[3],$s);
1967                 }
1968         }
1969         return $s;
1970 }
1971
1972 function protect_sprintf($s) {
1973         return str_replace('%', '%%', $s);
1974 }
1975
1976 /// @TODO Rewrite this
1977 function is_a_date_arg($s) {
1978         $i = intval($s);
1979
1980         if ($i > 1900) {
1981                 $y = date('Y');
1982
1983                 if ($i <= $y + 1 && strpos($s, '-') == 4) {
1984                         $m = intval(substr($s, 5));
1985
1986                         if ($m > 0 && $m <= 12) {
1987                                 return true;
1988                         }
1989                 }
1990         }
1991
1992         return false;
1993 }
1994
1995 /**
1996  * remove intentation from a text
1997  */
1998 function deindent($text, $chr = "[\t ]", $count = NULL) {
1999         $lines = explode("\n", $text);
2000         if (is_null($count)) {
2001                 $m = [];
2002                 $k = 0;
2003                 while ($k < count($lines) && strlen($lines[$k]) == 0) {
2004                         $k++;
2005                 }
2006                 preg_match("|^" . $chr . "*|", $lines[$k], $m);
2007                 $count = strlen($m[0]);
2008         }
2009
2010         for ($k = 0; $k < count($lines); $k++) {
2011                 $lines[$k] = preg_replace("|^" . $chr . "{" . $count . "}|", "", $lines[$k]);
2012         }
2013
2014         return implode("\n", $lines);
2015 }
2016
2017 function formatBytes($bytes, $precision = 2) {
2018         $units = ['B', 'KB', 'MB', 'GB', 'TB'];
2019
2020         $bytes = max($bytes, 0);
2021         $pow = floor(($bytes ? log($bytes) : 0) / log(1024));
2022         $pow = min($pow, count($units) - 1);
2023
2024         $bytes /= pow(1024, $pow);
2025
2026         return round($bytes, $precision) . ' ' . $units[$pow];
2027 }
2028
2029 /**
2030  * @brief translate and format the networkname of a contact
2031  *
2032  * @param string $network
2033  *      Networkname of the contact (e.g. dfrn, rss and so on)
2034  * @param sting $url
2035  *      The contact url
2036  * @return string
2037  */
2038 function format_network_name($network, $url = 0) {
2039         if ($network != "") {
2040                 if ($url != "") {
2041                         $network_name = '<a href="'.$url.'">'.ContactSelector::networkToName($network, $url)."</a>";
2042                 } else {
2043                         $network_name = ContactSelector::networkToName($network);
2044                 }
2045
2046                 return $network_name;
2047         }
2048 }
2049
2050 /**
2051  * @brief Syntax based code highlighting for popular languages.
2052  * @param string $s Code block
2053  * @param string $lang Programming language
2054  * @return string Formated html
2055  */
2056 function text_highlight($s, $lang) {
2057         if ($lang === 'js') {
2058                 $lang = 'javascript';
2059         }
2060
2061         if ($lang === 'bash') {
2062                 $lang = 'sh';
2063         }
2064
2065         // @TODO: Replace Text_Highlighter_Renderer_Html by scrivo/highlight.php
2066
2067         // Autoload the library to make constants available
2068         class_exists('Text_Highlighter_Renderer_Html');
2069
2070         $options = [
2071                 'numbers' => HL_NUMBERS_LI,
2072                 'tabsize' => 4,
2073         ];
2074
2075         $tag_added = false;
2076         $s = trim(html_entity_decode($s, ENT_COMPAT));
2077         $s = str_replace('    ', "\t", $s);
2078
2079         /*
2080          * The highlighter library insists on an opening php tag for php code blocks. If
2081          * it isn't present, nothing is highlighted. So we're going to see if it's present.
2082          * If not, we'll add it, and then quietly remove it after we get the processed output back.
2083          */
2084         if ($lang === 'php' && strpos($s, '<?php') !== 0) {
2085                 $s = '<?php' . "\n" . $s;
2086                 $tag_added = true;
2087         }
2088
2089         $renderer = new Text_Highlighter_Renderer_Html($options);
2090         $factory = new Text_Highlighter();
2091         $hl = $factory->factory($lang);
2092         $hl->setRenderer($renderer);
2093         $o = $hl->highlight($s);
2094         $o = str_replace("\n", '', $o);
2095
2096         if ($tag_added) {
2097                 $b = substr($o, 0, strpos($o, '<li>'));
2098                 $e = substr($o, strpos($o, '</li>'));
2099                 $o = $b . $e;
2100         }
2101
2102         return '<code>' . $o . '</code>';
2103 }