lib/util.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008-2011, StatusNet, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 /* XXX: break up into separate modules (HTTP, user, files) */
  21
  22 /**
  23  * Show a server error.
  24  */
  25 function common_server_error($msg, $code=500)
  26 {
  27     $err = new ServerErrorAction($msg, $code);
  28     $err->showPage();
  29 }
  30
  31 /**
  32  * Show a user error.
  33  */
  34 function common_user_error($msg, $code=400)
  35 {
  36     $err = new ClientErrorAction($msg, $code);
  37     $err->showPage();
  38 }
  39
  40 /**
  41  * This should only be used at setup; processes switching languages
  42  * to send text to other users should use common_switch_locale().
  43  *
  44  * @param string $language Locale language code (optional; empty uses
  45  *                         current user's preference or site default)
  46  * @return mixed success
  47  */
  48 function common_init_locale($language=null)
  49 {
  50     if(!$language) {
  51         $language = common_language();
  52     }
  53     putenv('LANGUAGE='.$language);
  54     putenv('LANG='.$language);
  55     $ok =  setlocale(LC_ALL, $language . ".utf8",
  56                      $language . ".UTF8",
  57                      $language . ".utf-8",
  58                      $language . ".UTF-8",
  59                      $language);
  60
  61     return $ok;
  62 }
  63
  64 /**
  65  * Initialize locale and charset settings and gettext with our message catalog,
  66  * using the current user's language preference or the site default.
  67  *
  68  * This should generally only be run at framework initialization; code switching
  69  * languages at runtime should call common_switch_language().
  70  *
  71  * @access private
  72  */
  73 function common_init_language()
  74 {
  75     mb_internal_encoding('UTF-8');
  76
  77     // Note that this setlocale() call may "fail" but this is harmless;
  78     // gettext will still select the right language.
  79     $language = common_language();
  80     $locale_set = common_init_locale($language);
  81
  82     if (!$locale_set) {
  83         // The requested locale doesn't exist on the system.
  84         //
  85         // gettext seems very picky... We first need to setlocale()
  86         // to a locale which _does_ exist on the system, and _then_
  87         // we can set in another locale that may not be set up
  88         // (say, ga_ES for Galego/Galician) it seems to take it.
  89         //
  90         // For some reason C and POSIX which are guaranteed to work
  91         // don't do the job. en_US.UTF-8 should be there most of the
  92         // time, but not guaranteed.
  93         $ok = common_init_locale("en_US");
  94         if (!$ok && strtolower(substr(PHP_OS, 0, 3)) != 'win') {
  95             // Try to find a complete, working locale on Unix/Linux...
  96             // @fixme shelling out feels awfully inefficient
  97             // but I don't think there's a more standard way.
  98             $all = `locale -a`;
  99             foreach (explode("\n", $all) as $locale) {
 100                 if (preg_match('/\.utf[-_]?8$/i', $locale)) {
 101                     $ok = setlocale(LC_ALL, $locale);
 102                     if ($ok) {
 103                         break;
 104                     }
 105                 }
 106             }
 107         }
 108         if (!$ok) {
 109             common_log(LOG_ERR, "Unable to find a UTF-8 locale on this system; UI translations may not work.");
 110         }
 111         $locale_set = common_init_locale($language);
 112     }
 113
 114     common_init_gettext();
 115 }
 116
 117 /**
 118  * @access private
 119  */
 120 function common_init_gettext()
 121 {
 122     setlocale(LC_CTYPE, 'C');
 123     // So we do not have to make people install the gettext locales
 124     $path = common_config('site','locale_path');
 125     bindtextdomain("statusnet", $path);
 126     bind_textdomain_codeset("statusnet", "UTF-8");
 127     textdomain("statusnet");
 128 }
 129
 130 /**
 131  * Switch locale during runtime, and poke gettext until it cries uncle.
 132  * Otherwise, sometimes it doesn't actually switch away from the old language.
 133  *
 134  * @param string $language code for locale ('en', 'fr', 'pt_BR' etc)
 135  */
 136 function common_switch_locale($language=null)
 137 {
 138     common_init_locale($language);
 139
 140     setlocale(LC_CTYPE, 'C');
 141     // So we do not have to make people install the gettext locales
 142     $path = common_config('site','locale_path');
 143     bindtextdomain("statusnet", $path);
 144     bind_textdomain_codeset("statusnet", "UTF-8");
 145     textdomain("statusnet");
 146 }
 147
 148 function common_timezone()
 149 {
 150     if (common_logged_in()) {
 151         $user = common_current_user();
 152         if ($user->timezone) {
 153             return $user->timezone;
 154         }
 155     }
 156
 157     return common_config('site', 'timezone');
 158 }
 159
 160 function common_valid_language($lang)
 161 {
 162     if ($lang) {
 163         // Validate -- we don't want to end up with a bogus code
 164         // left over from some old junk.
 165         foreach (common_config('site', 'languages') as $code => $info) {
 166             if ($info['lang'] == $lang) {
 167                 return true;
 168             }
 169         }
 170     }
 171     return false;
 172 }
 173
 174 function common_language()
 175 {
 176     // Allow ?uselang=xx override, very useful for debugging
 177     // and helping translators check usage and context.
 178     if (isset($_GET['uselang'])) {
 179         $uselang = strval($_GET['uselang']);
 180         if (common_valid_language($uselang)) {
 181             return $uselang;
 182         }
 183     }
 184
 185     // If there is a user logged in and they've set a language preference
 186     // then return that one...
 187     if (_have_config() && common_logged_in()) {
 188         $user = common_current_user();
 189
 190         if (common_valid_language($user->language)) {
 191             return $user->language;
 192         }
 193     }
 194
 195     // Otherwise, find the best match for the languages requested by the
 196     // user's browser...
 197     if (common_config('site', 'langdetect')) {
 198         $httplang = isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? $_SERVER['HTTP_ACCEPT_LANGUAGE'] : null;
 199         if (!empty($httplang)) {
 200             $language = client_prefered_language($httplang);
 201             if ($language)
 202               return $language;
 203         }
 204     }
 205
 206     // Finally, if none of the above worked, use the site's default...
 207     return common_config('site', 'language');
 208 }
 209
 210 /**
 211  * Salted, hashed passwords are stored in the DB.
 212  */
 213 function common_munge_password($password, Profile $profile=null)
 214 {
 215     $hashed = null;
 216
 217     if (Event::handle('StartHashPassword', array(&$hashed, $password, $profile))) {
 218         Event::handle('EndHashPassword', array(&$hashed, $password, $profile));
 219     }
 220     if (empty($hashed)) {
 221         throw new PasswordHashException();
 222     }
 223
 224     return $hashed;
 225 }
 226
 227 /**
 228  * Check if a username exists and has matching password.
 229  */
 230 function common_check_user($nickname, $password)
 231 {
 232     // empty nickname always unacceptable
 233     if (empty($nickname)) {
 234         return false;
 235     }
 236
 237     $authenticatedUser = false;
 238
 239     if (Event::handle('StartCheckPassword', array($nickname, $password, &$authenticatedUser))) {
 240
 241         if (common_is_email($nickname)) {
 242             $user = User::getKV('email', common_canonical_email($nickname));
 243         } else {
 244             $user = User::getKV('nickname', Nickname::normalize($nickname));
 245         }
 246
 247         if ($user instanceof User && !empty($password)) {
 248             if (0 == strcmp(common_munge_password($password, $user->getProfile()), $user->password)) {
 249                 //internal checking passed
 250                 $authenticatedUser = $user;
 251             }
 252         }
 253     }
 254     Event::handle('EndCheckPassword', array($nickname, $password, $authenticatedUser));
 255
 256     return $authenticatedUser;
 257 }
 258
 259 /**
 260  * Is the current user logged in?
 261  */
 262 function common_logged_in()
 263 {
 264     return (!is_null(common_current_user()));
 265 }
 266
 267 function common_local_referer()
 268 {
 269     return isset($_SERVER['HTTP_REFERER'])
 270             && parse_url($_SERVER['HTTP_REFERER'], PHP_URL_HOST) === common_config('site', 'server');
 271 }
 272
 273 function common_have_session()
 274 {
 275     return (0 != strcmp(session_id(), ''));
 276 }
 277
 278 function common_ensure_session()
 279 {
 280     $c = null;
 281     if (array_key_exists(session_name(), $_COOKIE)) {
 282         $c = $_COOKIE[session_name()];
 283     }
 284     if (!common_have_session()) {
 285         if (common_config('sessions', 'handle')) {
 286             Session::setSaveHandler();
 287         }
 288         if (array_key_exists(session_name(), $_GET)) {
 289             $id = $_GET[session_name()];
 290         } else if (array_key_exists(session_name(), $_COOKIE)) {
 291             $id = $_COOKIE[session_name()];
 292         }
 293         if (isset($id)) {
 294             session_id($id);
 295         }
 296         @session_start();
 297         if (!isset($_SESSION['started'])) {
 298             $_SESSION['started'] = time();
 299             if (!empty($id)) {
 300                 common_log(LOG_WARNING, 'Session cookie "' . $_COOKIE[session_name()] . '" ' .
 301                            ' is set but started value is null');
 302             }
 303         }
 304     }
 305 }
 306
 307 // Three kinds of arguments:
 308 // 1) a user object
 309 // 2) a nickname
 310 // 3) null to clear
 311
 312 // Initialize to false; set to null if none found
 313 $_cur = false;
 314
 315 function common_set_user($user)
 316 {
 317     global $_cur;
 318
 319     if (is_null($user) && common_have_session()) {
 320         $_cur = null;
 321         unset($_SESSION['userid']);
 322         return true;
 323     } else if (is_string($user)) {
 324         $nickname = $user;
 325         $user = User::getKV('nickname', $nickname);
 326     } else if (!$user instanceof User) {
 327         return false;
 328     }
 329
 330     if ($user) {
 331         if (Event::handle('StartSetUser', array(&$user))) {
 332             if (!empty($user)) {
 333                 if (!$user->hasRight(Right::WEBLOGIN)) {
 334                     // TRANS: Authorisation exception thrown when a user a not allowed to login.
 335                     throw new AuthorizationException(_('Not allowed to log in.'));
 336                 }
 337                 common_ensure_session();
 338                 $_SESSION['userid'] = $user->id;
 339                 $_cur = $user;
 340                 Event::handle('EndSetUser', array($user));
 341                 return $_cur;
 342             }
 343         }
 344     }
 345     return false;
 346 }
 347
 348 function common_set_cookie($key, $value, $expiration=0)
 349 {
 350     $path = common_config('site', 'path');
 351     $server = common_config('site', 'server');
 352
 353     if ($path && ($path != '/')) {
 354         $cookiepath = '/' . $path . '/';
 355     } else {
 356         $cookiepath = '/';
 357     }
 358     return setcookie($key,
 359                      $value,
 360                      $expiration,
 361                      $cookiepath,
 362                      $server,
 363                      GNUsocial::useHTTPS());
 364 }
 365
 366 define('REMEMBERME', 'rememberme');
 367 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
 368
 369 function common_rememberme($user=null)
 370 {
 371     if (!$user) {
 372         $user = common_current_user();
 373         if (!$user) {
 374             return false;
 375         }
 376     }
 377
 378     $rm = new Remember_me();
 379
 380     $rm->code = common_random_hexstr(16);
 381     $rm->user_id = $user->id;
 382
 383     // Wrap the insert in some good ol' fashioned transaction code
 384
 385     $rm->query('BEGIN');
 386
 387     $result = $rm->insert();
 388
 389     if (!$result) {
 390         common_log_db_error($rm, 'INSERT', __FILE__);
 391         $rm->query('ROLLBACK');
 392         return false;
 393     }
 394
 395     $rm->query('COMMIT');
 396
 397     $cookieval = $rm->user_id . ':' . $rm->code;
 398
 399     common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
 400
 401     common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
 402
 403     return true;
 404 }
 405
 406 function common_remembered_user()
 407 {
 408     $user = null;
 409
 410     $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
 411
 412     if (!$packed) {
 413         return null;
 414     }
 415
 416     list($id, $code) = explode(':', $packed);
 417
 418     if (!$id || !$code) {
 419         common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
 420         common_forgetme();
 421         return null;
 422     }
 423
 424     $rm = Remember_me::getKV('code', $code);
 425
 426     if (!$rm) {
 427         common_log(LOG_WARNING, 'No such remember code: ' . $code);
 428         common_forgetme();
 429         return null;
 430     }
 431
 432     if ($rm->user_id != $id) {
 433         common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
 434         common_forgetme();
 435         return null;
 436     }
 437
 438     $user = User::getKV('id', $rm->user_id);
 439
 440     if (!$user instanceof User) {
 441         common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
 442         common_forgetme();
 443         return null;
 444     }
 445
 446     // successful!
 447     $result = $rm->delete();
 448
 449     if (!$result) {
 450         common_log_db_error($rm, 'DELETE', __FILE__);
 451         common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
 452         common_forgetme();
 453         return null;
 454     }
 455
 456     common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
 457
 458     common_set_user($user);
 459     common_real_login(false);
 460
 461     // We issue a new cookie, so they can log in
 462     // automatically again after this session
 463
 464     common_rememberme($user);
 465
 466     return $user;
 467 }
 468
 469 /**
 470  * must be called with a valid user!
 471  */
 472 function common_forgetme()
 473 {
 474     common_set_cookie(REMEMBERME, '', 0);
 475 }
 476
 477 /**
 478  * Who is the current user?
 479  */
 480 function common_current_user()
 481 {
 482     global $_cur;
 483
 484     if (!_have_config()) {
 485         return null;
 486     }
 487
 488     if ($_cur === false) {
 489
 490         if (isset($_COOKIE[session_name()]) || isset($_GET[session_name()])
 491             || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
 492             common_ensure_session();
 493             $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
 494             if ($id) {
 495                 $user = User::getKV('id', $id);
 496                 if ($user instanceof User) {
 497                         $_cur = $user;
 498                         return $_cur;
 499                 }
 500             }
 501         }
 502
 503         // that didn't work; try to remember; will init $_cur to null on failure
 504         $_cur = common_remembered_user();
 505
 506         if ($_cur) {
 507             // XXX: Is this necessary?
 508             $_SESSION['userid'] = $_cur->id;
 509         }
 510     }
 511
 512     return $_cur;
 513 }
 514
 515 /**
 516  * Logins that are 'remembered' aren't 'real' -- they're subject to
 517  * cookie-stealing. So, we don't let them do certain things. New reg,
 518  * OpenID, and password logins _are_ real.
 519  */
 520 function common_real_login($real=true)
 521 {
 522     common_ensure_session();
 523     $_SESSION['real_login'] = $real;
 524 }
 525
 526 function common_is_real_login()
 527 {
 528     return common_logged_in() && $_SESSION['real_login'];
 529 }
 530
 531 /**
 532  * Get a hash portion for HTTP caching Etags and such including
 533  * info on the current user's session. If login/logout state changes,
 534  * or we've changed accounts, or we've renamed the current user,
 535  * we'll get a new hash value.
 536  *
 537  * This should not be considered secure information.
 538  *
 539  * @param User $user (optional; uses common_current_user() if left out)
 540  * @return string
 541  */
 542 function common_user_cache_hash($user=false)
 543 {
 544     if ($user === false) {
 545         $user = common_current_user();
 546     }
 547     if ($user) {
 548         return crc32($user->id . ':' . $user->nickname);
 549     } else {
 550         return '0';
 551     }
 552 }
 553
 554 /**
 555  * get canonical version of nickname for comparison
 556  *
 557  * @param string $nickname
 558  * @return string
 559  *
 560  * @throws NicknameException on invalid input
 561  * @deprecated call Nickname::normalize() directly.
 562  */
 563 function common_canonical_nickname($nickname)
 564 {
 565     return Nickname::normalize($nickname);
 566 }
 567
 568 /**
 569  * get canonical version of email for comparison
 570  *
 571  * @fixme actually normalize
 572  * @fixme reject invalid input
 573  *
 574  * @param string $email
 575  * @return string
 576  */
 577 function common_canonical_email($email)
 578 {
 579     // XXX: canonicalize UTF-8
 580     // XXX: lcase the domain part
 581     return $email;
 582 }
 583
 584 function common_to_alphanumeric($str)
 585 {
 586     $filtered = preg_replace('/[^A-Za-z0-9]\s*/', '', $str);
 587     if (strlen($filtered) < 1) {
 588         throw new Exception('Filtered string was zero-length.');
 589     }
 590     return $filtered;
 591 }
 592
 593 function common_purify($html, array $args=array())
 594 {
 595     require_once INSTALLDIR.'/extlib/HTMLPurifier/HTMLPurifier.auto.php';
 596
 597     $cfg = HTMLPurifier_Config::createDefault();
 598     /**
 599      * rel values that should be avoided since they can be used to infer
 600      * information about the _current_ page, not the h-entry:
 601      *
 602      *      directory, home, license, payment
 603      *
 604      * Source: http://microformats.org/wiki/rel
 605      */
 606     $cfg->set('Attr.AllowedRel', ['bookmark', 'enclosure', 'nofollow', 'tag', 'noreferrer']);
 607     $cfg->set('HTML.ForbiddenAttributes', array('style'));  // id, on* etc. are already filtered by default
 608     $cfg->set('URI.AllowedSchemes', array_fill_keys(common_url_schemes(), true));
 609     if (isset($args['URI.Base'])) {
 610         $cfg->set('URI.Base', $args['URI.Base']);   // if null this is like unsetting it I presume
 611         $cfg->set('URI.MakeAbsolute', !is_null($args['URI.Base']));   // if we have a URI base, convert relative URLs to absolute ones.
 612     }
 613     foreach (common_config('htmlpurifier') as $key=>$val) {
 614         $cfg->set($key, $val);
 615     }
 616
 617     // Remove more elements than what the default filter removes, default in GNU social are remotely
 618     // linked resources such as img, video, audio
 619     $forbiddenElements = array();
 620     foreach (common_config('htmlfilter') as $tag=>$filter) {
 621         if ($filter === true) {
 622             $forbiddenElements[] = $tag;
 623         }
 624     }
 625     $cfg->set('HTML.ForbiddenElements', $forbiddenElements);
 626
 627     $html = common_remove_unicode_formatting($html);
 628
 629     $purifier = new HTMLPurifier($cfg);
 630     $purified = $purifier->purify($html);
 631     Event::handle('EndCommonPurify', array(&$purified, $html));
 632
 633     return $purified;
 634 }
 635
 636 function common_remove_unicode_formatting($text)
 637 {
 638     // Strip Unicode text formatting/direction codes
 639     // this is pretty dangerous for visualisation of text and can be used for mischief
 640     return preg_replace('/[\\x{200b}-\\x{200f}\\x{202a}-\\x{202e}]/u', '', $text);
 641 }
 642
 643 /**
 644  * Partial notice markup rendering step: build links to !group references.
 645  *
 646  * @param string    $text partially rendered HTML
 647  * @param Profile   $author the Profile that is composing the current notice
 648  * @param Notice    $parent the Notice this is sent in reply to, if any
 649  * @return string partially rendered HTML
 650  */
 651 function common_render_content($text, Profile $author, Notice $parent=null)
 652 {
 653     $text = common_render_text($text);
 654     $text = common_linkify_mentions($text, $author, $parent);
 655     return $text;
 656 }
 657
 658 /**
 659  * Finds @-mentions within the partially-rendered text section and
 660  * turns them into live links.
 661  *
 662  * Should generally not be called except from common_render_content().
 663  *
 664  * @param string    $text   partially-rendered HTML
 665  * @param Profile   $author the Profile that is composing the current notice
 666  * @param Notice    $parent the Notice this is sent in reply to, if any
 667  * @return string partially-rendered HTML
 668  */
 669 function common_linkify_mentions($text, Profile $author, Notice $parent=null)
 670 {
 671     $mentions = common_find_mentions($text, $author, $parent);
 672
 673     // We need to go through in reverse order by position,
 674     // so our positions stay valid despite our fudging with the
 675     // string!
 676
 677     $points = array();
 678
 679     foreach ($mentions as $mention)
 680     {
 681         $points[$mention['position']] = $mention;
 682     }
 683
 684     krsort($points);
 685
 686     foreach ($points as $position => $mention) {
 687
 688         $linkText = common_linkify_mention($mention);
 689
 690         $text = substr_replace($text, $linkText, $position, $mention['length']);
 691     }
 692
 693     return $text;
 694 }
 695
 696 function common_linkify_mention(array $mention)
 697 {
 698     $output = null;
 699
 700     if (Event::handle('StartLinkifyMention', array($mention, &$output))) {
 701
 702         $xs = new XMLStringer(false);
 703
 704         $attrs = array('href' => $mention['url'],
 705                        'class' => 'h-card u-url p-nickname '.$mention['type']);
 706
 707         if (!empty($mention['title'])) {
 708             $attrs['title'] = $mention['title'];
 709         }
 710
 711         $xs->element('a', $attrs, $mention['text']);
 712
 713         $output = $xs->getString();
 714
 715         Event::handle('EndLinkifyMention', array($mention, &$output));
 716     }
 717
 718     return $output;
 719 }
 720
 721 function common_get_attentions($text, Profile $sender, Notice $parent=null)
 722 {
 723     $mentions = common_find_mentions($text, $sender, $parent);
 724     $atts = array();
 725     foreach ($mentions as $mention) {
 726         foreach ($mention['mentioned'] as $mentioned) {
 727             $atts[$mentioned->getUri()] = $mentioned->getObjectType();
 728         }
 729     }
 730     if ($parent instanceof Notice) {
 731         $parentAuthor = $parent->getProfile();
 732         // afaik groups can't be authors
 733         $atts[$parentAuthor->getUri()] = ActivityObject::PERSON;
 734     }
 735     return $atts;
 736 }
 737
 738 /**
 739  * Find @-mentions in the given text, using the given notice object as context.
 740  * References will be resolved with common_relative_profile() against the user
 741  * who posted the notice.
 742  *
 743  * Note the return data format is internal, to be used for building links and
 744  * such. Should not be used directly; rather, call common_linkify_mentions().
 745  *
 746  * @param string    $text
 747  * @param Profile   $sender the Profile that is sending the current text
 748  * @param Notice    $parent the Notice this text is in reply to, if any
 749  *
 750  * @return array
 751  *
 752  * @access private
 753  */
 754 function common_find_mentions($text, Profile $sender, Notice $parent=null)
 755 {
 756     $mentions = array();
 757
 758     if (Event::handle('StartFindMentions', array($sender, $text, &$mentions))) {
 759         // Get the context of the original notice, if any
 760         $origMentions = array();
 761         // Does it have a parent notice for context?
 762         if ($parent instanceof Notice) {
 763             foreach ($parent->getAttentionProfiles() as $repliedTo) {
 764                 if (!$repliedTo->isPerson()) {
 765                     continue;
 766                 }
 767                 $origMentions[$repliedTo->id] = $repliedTo;
 768             }
 769         }
 770
 771         $matches = common_find_mentions_raw($text);
 772
 773         foreach ($matches as $match) {
 774             try {
 775                 $nickname = Nickname::normalize($match[0]);
 776             } catch (NicknameException $e) {
 777                 // Bogus match? Drop it.
 778                 continue;
 779             }
 780
 781                         // primarily mention the profiles mentioned in the parent
 782             $mention_found_in_origMentions = false;
 783             foreach($origMentions as $origMentionsId=>$origMention) {
 784                 if($origMention->getNickname() == $nickname) {
 785                     $mention_found_in_origMentions = $origMention;
 786                     // don't mention same twice! the parent might have mentioned
 787                     // two users with same nickname on different instances
 788                     unset($origMentions[$origMentionsId]);
 789                     break;
 790                 }
 791             }
 792
 793             // Try to get a profile for this nickname.
 794             // Start with parents mentions, then go to parents sender context
 795             if ($mention_found_in_origMentions) {
 796                 $mentioned = $mention_found_in_origMentions;
 797             } else if ($parent instanceof Notice && $parent->getProfile()->getNickname() === $nickname) {
 798                 $mentioned = $parent->getProfile();
 799             } else {
 800                 // sets to null if no match
 801                 $mentioned = common_relative_profile($sender, $nickname);
 802             }
 803
 804             if ($mentioned instanceof Profile) {
 805                 try {
 806                     $url = $mentioned->getUri();    // prefer the URI as URL, if it is one.
 807                     if (!common_valid_http_url($url)) {
 808                         $url = $mentioned->getUrl();
 809                     }
 810                 } catch (InvalidUrlException $e) {
 811                     $url = common_local_url('userbyid', array('id' => $mentioned->getID()));
 812                 }
 813
 814                 $mention = array('mentioned' => array($mentioned),
 815                                  'type' => 'mention',
 816                                  'text' => $match[0],
 817                                  'position' => $match[1],
 818                                  'length' => mb_strlen($match[0]),
 819                                  'title' => $mentioned->getFullname(),
 820                                  'url' => $url);
 821
 822                 $mentions[] = $mention;
 823             }
 824         }
 825
 826         // @#tag => mention of all subscriptions tagged 'tag'
 827
 828         preg_match_all('/'.Nickname::BEFORE_MENTIONS.'@#([\pL\pN_\-\.]{1,64})/',
 829                        $text, $hmatches, PREG_OFFSET_CAPTURE);
 830         foreach ($hmatches[1] as $hmatch) {
 831             $tag = common_canonical_tag($hmatch[0]);
 832             $plist = Profile_list::getByTaggerAndTag($sender->getID(), $tag);
 833             if (!$plist instanceof Profile_list || $plist->private) {
 834                 continue;
 835             }
 836             $tagged = $sender->getTaggedSubscribers($tag);
 837
 838             $url = common_local_url('showprofiletag',
 839                                     array('nickname' => $sender->getNickname(),
 840                                           'tag' => $tag));
 841
 842             $mentions[] = array('mentioned' => $tagged,
 843                                 'type'      => 'list',
 844                                 'text' => $hmatch[0],
 845                                 'position' => $hmatch[1],
 846                                 'length' => mb_strlen($hmatch[0]),
 847                                 'url' => $url);
 848         }
 849
 850         preg_match_all('/'.Nickname::BEFORE_MENTIONS.'!(' . Nickname::DISPLAY_FMT . ')/',
 851                        $text, $hmatches, PREG_OFFSET_CAPTURE);
 852         foreach ($hmatches[1] as $hmatch) {
 853             $nickname = Nickname::normalize($hmatch[0]);
 854             $group = User_group::getForNickname($nickname, $sender);
 855
 856             if (!$group instanceof User_group || !$sender->isMember($group)) {
 857                 continue;
 858             }
 859
 860             $profile = $group->getProfile();
 861
 862             $mentions[] = array('mentioned' => array($profile),
 863                                 'type'      => 'group',
 864                                 'text'      => $hmatch[0],
 865                                 'position'  => $hmatch[1],
 866                                 'length'    => mb_strlen($hmatch[0]),
 867                                 'url'       => $group->permalink(),
 868                                 'title'     => $group->getFancyName());
 869         }
 870
 871         Event::handle('EndFindMentions', array($sender, $text, &$mentions));
 872     }
 873
 874     return $mentions;
 875 }
 876
 877 /**
 878  * Does the actual regex pulls to find @-mentions in text.
 879  * Should generally not be called directly; for use in common_find_mentions.
 880  *
 881  * @param string $text
 882  * @return array of PCRE match arrays
 883  */
 884 function common_find_mentions_raw($text)
 885 {
 886     $tmatches = array();
 887     preg_match_all('/^T (' . Nickname::DISPLAY_FMT . ') /',
 888                    $text,
 889                    $tmatches,
 890                    PREG_OFFSET_CAPTURE);
 891
 892     $atmatches = array();
 893     // the regexp's "(?!\@)" makes sure it doesn't matches the single "@remote" in "@remote@server.com"
 894     preg_match_all('/'.Nickname::BEFORE_MENTIONS.'@(' . Nickname::DISPLAY_FMT . ')\b(?!\@)/',
 895                    $text,
 896                    $atmatches,
 897                    PREG_OFFSET_CAPTURE);
 898
 899     $matches = array_merge($tmatches[1], $atmatches[1]);
 900     return $matches;
 901 }
 902
 903 function common_render_text($text)
 904 {
 905     $text = common_remove_unicode_formatting($text);
 906     $text = nl2br(htmlspecialchars($text));
 907
 908     $text = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $text);
 909     $text = common_replace_urls_callback($text, 'common_linkify');
 910     $text = preg_replace_callback('/(^|\&quot\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/u',
 911                 function ($m) { return "{$m[1]}#".common_tag_link($m[2]); }, $text);
 912     // XXX: machine tags
 913     return $text;
 914 }
 915
 916 define('_URL_SCHEME_COLON_DOUBLE_SLASH', 1);
 917 define('_URL_SCHEME_SINGLE_COLON', 2);
 918 define('_URL_SCHEME_NO_DOMAIN', 4);
 919 define('_URL_SCHEME_COLON_COORDINATES', 8);
 920
 921 function common_url_schemes($filter=null)
 922 {
 923     // TODO: move these to $config
 924     $schemes = [
 925                 'http'      => _URL_SCHEME_COLON_DOUBLE_SLASH,
 926                 'https'     => _URL_SCHEME_COLON_DOUBLE_SLASH,
 927                 'ftp'       => _URL_SCHEME_COLON_DOUBLE_SLASH,
 928                 'ftps'      => _URL_SCHEME_COLON_DOUBLE_SLASH,
 929                 'mms'       => _URL_SCHEME_COLON_DOUBLE_SLASH,
 930                 'rtsp'      => _URL_SCHEME_COLON_DOUBLE_SLASH,
 931                 'gopher'    => _URL_SCHEME_COLON_DOUBLE_SLASH,
 932                 'news'      => _URL_SCHEME_COLON_DOUBLE_SLASH,
 933                 'nntp'      => _URL_SCHEME_COLON_DOUBLE_SLASH,
 934                 'telnet'    => _URL_SCHEME_COLON_DOUBLE_SLASH,
 935                 'wais'      => _URL_SCHEME_COLON_DOUBLE_SLASH,
 936                 'file'      => _URL_SCHEME_COLON_DOUBLE_SLASH,
 937                 'prospero'  => _URL_SCHEME_COLON_DOUBLE_SLASH,
 938                 'webcal'    => _URL_SCHEME_COLON_DOUBLE_SLASH,
 939                 'irc'       => _URL_SCHEME_COLON_DOUBLE_SLASH,
 940                 'ircs'      => _URL_SCHEME_COLON_DOUBLE_SLASH,
 941                 'aim'       => _URL_SCHEME_SINGLE_COLON,
 942                 'bitcoin'   => _URL_SCHEME_SINGLE_COLON,
 943                 'fax'       => _URL_SCHEME_SINGLE_COLON,
 944                 'jabber'    => _URL_SCHEME_SINGLE_COLON,
 945                 'mailto'    => _URL_SCHEME_SINGLE_COLON,
 946                 'tel'       => _URL_SCHEME_SINGLE_COLON,
 947                 'xmpp'      => _URL_SCHEME_SINGLE_COLON,
 948                 'magnet'    => _URL_SCHEME_NO_DOMAIN,
 949                 'geo'       => _URL_SCHEME_COLON_COORDINATES,
 950                 ];
 951
 952     return array_keys(
 953             array_filter($schemes,
 954                 function ($scheme) use ($filter) {
 955                     return is_null($filter) || ($scheme & $filter);
 956                 })
 957             );
 958 }
 959
 960 /**
 961  * Find links in the given text and pass them to the given callback function.
 962  *
 963  * @param string $text
 964  * @param function($text, $arg) $callback: return replacement text
 965  * @param mixed $arg: optional argument will be passed on to the callback
 966  */
 967 function common_replace_urls_callback($text, $callback, $arg = null) {
 968     $geouri_labeltext_regex = '\pN\pL\-';
 969     $geouri_mark_regex = '\-\_\.\!\~\*\\\'\(\)';    // the \\\' is really pretty
 970     $geouri_unreserved_regex = '\pN\pL' . $geouri_mark_regex;
 971     $geouri_punreserved_regex = '\[\]\:\&\+\$';
 972     $geouri_pctencoded_regex = '(?:\%[0-9a-fA-F][0-9a-fA-F])';
 973     $geouri_paramchar_regex = $geouri_unreserved_regex . $geouri_punreserved_regex; //FIXME: add $geouri_pctencoded_regex here so it works
 974
 975     // Start off with a regex
 976     $regex = '#'.
 977     '(?:^|[\s\<\>\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
 978     '('.
 979         '(?:'.
 980             '(?:'. //Known protocols
 981                 '(?:'.
 982                     '(?:(?:' . implode('|', common_url_schemes(_URL_SCHEME_COLON_DOUBLE_SLASH)) . ')://)'.
 983                     '|'.
 984                     '(?:(?:' . implode('|', common_url_schemes(_URL_SCHEME_SINGLE_COLON)) . '):)'.
 985                 ')'.
 986                 '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
 987                 '(?:'.
 988                     '(?:'.
 989                         '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
 990                     ')|(?:'.
 991                         '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
 992                     ')'.
 993                 ')'.
 994             ')'.
 995             '|(?:'.
 996                 '(?:' . implode('|', common_url_schemes(_URL_SCHEME_COLON_COORDINATES)) . '):'.
 997                 // There's an order that must be followed here too, if ;crs= is used, it must precede ;u=
 998                 // Also 'crsp' (;crs=$crsp) must match $geouri_labeltext_regex
 999                 // Also 'uval' (;u=$uval) must be a pnum: \-?[0-9]+
1000                 '(?:'.
1001                     '(?:[0-9]+(?:\.[0-9]+)?(?:\,[0-9]+(?:\.[0-9]+)?){1,2})'.    // 1(.23)?(,4(.56)){1,2}
1002                     '(?:\;(?:['.$geouri_labeltext_regex.']+)(?:\=['.$geouri_paramchar_regex.']+)*)*'.
1003                 ')'.
1004             ')'.
1005             // URLs without domain name, like magnet:?xt=...
1006             '|(?:(?:' . implode('|', common_url_schemes(_URL_SCHEME_NO_DOMAIN)) . '):(?=\?))'.  // zero-length lookahead requires ? after :
1007             (common_config('linkify', 'bare_ipv4')   // Convert IPv4 addresses to hyperlinks
1008                 ? '|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)'
1009                 : '').
1010             (common_config('linkify', 'bare_ipv6')   // Convert IPv6 addresses to hyperlinks
1011                 ? '|(?:'. //IPv6
1012                     '\[?(?:(?:(?:[0-9A-Fa-f]{1,4}:){7}(?:(?:[0-9A-Fa-f]{1,4})|:))|(?:(?:[0-9A-Fa-f]{1,4}:){6}(?::|(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})|(?::[0-9A-Fa-f]{1,4})))|(?:(?:[0-9A-Fa-f]{1,4}:){5}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:){4}(?::[0-9A-Fa-f]{1,4}){0,1}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:){3}(?::[0-9A-Fa-f]{1,4}){0,2}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:){2}(?::[0-9A-Fa-f]{1,4}){0,3}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:)(?::[0-9A-Fa-f]{1,4}){0,4}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?::(?::[0-9A-Fa-f]{1,4}){0,5}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})))\]?(?<!:)'.
1013                     ')'
1014                 : '').
1015             (common_config('linkify', 'bare_domains')
1016                 ? '|(?:'. //DNS
1017                     '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
1018                     '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
1019                     //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
1020                     '(?:AC|AD|AE|AERO|AF|AG|AI|AL|AM|AN|AO|AQ|AR|ARPA|AS|ASIA|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BIZ|BJ|BM|BN|BO|BR|BS|BT|BV|BW|BY|BZ|CA|CAT|CC|CD|CF|CG|CH|CI|CK|CL|CM|CN|CO|COM|COOP|CR|CU|CV|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EDU|EE|EG|ER|ES|ET|EU|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GOV|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HT|HU|ID|IE|IL|IM|IN|INFO|INT|IO|IQ|IR|IS|IT|JE|JM|JO|JOBS|JP|KE|KG|KH|KI|KM|KN|KP|KR|KW|KY|KZ|LA|LB|LC|LI|LK|LR|LS|LT|LU|LV|LY|MA|MC|MD|ME|MG|MH|MIL|MK|ML|MM|MN|MO|MOBI|MP|MQ|MR|MS|MT|MU|MUSEUM|MV|MW|MX|MY|MZ|NA|NAME|NC|NE|NET|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|ORG|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PRO|PS|PT|PW|PY|QA|RE|RO|RS|RU|RW|SA|SB|SC|SD|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SO|SR|ST|SU|SV|SY|SZ|TC|TD|TEL|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TP|TR|TRAVEL|TT|TV|TW|TZ|UA|UG|UK|US|UY|UZ|VA|VC|VE|VG|VI|VN|VU|WF|WS|XN--0ZWM56D|测试|XN--11B5BS3A9AJ6G|परीक्षा|XN--80AKHBYKNJ4F|испытание|XN--9T4B11YI5A|테스트|XN--DEBA0AD|טעסט|XN--G6W251D|測試|XN--HGBK6AJ7F53BBA|آزمایشی|XN--HLCJ6AYA9ESC7A|பரிட்சை|XN--JXALPDLP|δοκιμή|XN--KGBECHTV|إختبار|XN--ZCKZAH|テスト|YE|YT|YU|ZA|ZM|ZONE|ZW|local|loc|onion)'.
1021             ')(?![\pN\pL\-\_])'
1022                 : '') . // if common_config('linkify', 'bare_domains') is false, don't add anything here
1023         ')'.
1024         '(?:'.
1025             '(?:\:\d+)?'. //:port
1026             '(?:/['  . URL_REGEX_VALID_PATH_CHARS    . ']*)?'.  // path
1027             '(?:\?[' . URL_REGEX_VALID_QSTRING_CHARS . ']*)?'.  // ?query string
1028             '(?:\#[' . URL_REGEX_VALID_FRAGMENT_CHARS . ']*)?'. // #fragment
1029         ')(?<!['. URL_REGEX_EXCLUDED_END_CHARS .'])'.
1030     ')'.
1031     '#ixu';
1032     //preg_match_all($regex,$text,$matches);
1033     //print_r($matches);
1034     return preg_replace_callback($regex, curry('callback_helper',$callback,$arg) ,$text);
1035 }
1036
1037 /**
1038  * Intermediate callback for common_replace_links(), helps resolve some
1039  * ambiguous link forms before passing on to the final callback.
1040  *
1041  * @param array $matches
1042  * @param callable $callback
1043  * @param mixed $arg optional argument to pass on as second param to callback
1044  * @return string
1045  *
1046  * @access private
1047  */
1048 function callback_helper($matches, $callback, $arg=null) {
1049     $url=$matches[1];
1050     $left = strpos($matches[0],$url);
1051     $right = $left+strlen($url);
1052
1053     $groupSymbolSets=array(
1054         array(
1055             'left'=>'(',
1056             'right'=>')'
1057         ),
1058         array(
1059             'left'=>'[',
1060             'right'=>']'
1061         ),
1062         array(
1063             'left'=>'{',
1064             'right'=>'}'
1065         ),
1066         array(
1067             'left'=>'<',
1068             'right'=>'>'
1069         )
1070     );
1071     $cannotEndWith=array('.','?',',','#');
1072     $original_url=$url;
1073     do{
1074         $original_url=$url;
1075         foreach($groupSymbolSets as $groupSymbolSet){
1076             if(substr($url,-1)==$groupSymbolSet['right']){
1077                 $group_left_count = substr_count($url,$groupSymbolSet['left']);
1078                 $group_right_count = substr_count($url,$groupSymbolSet['right']);
1079                 if($group_left_count<$group_right_count){
1080                     $right-=1;
1081                     $url=substr($url,0,-1);
1082                 }
1083             }
1084         }
1085         if(in_array(substr($url,-1),$cannotEndWith)){
1086             $right-=1;
1087             $url=substr($url,0,-1);
1088         }
1089     }while($original_url!=$url);
1090
1091     $result = call_user_func_array($callback, array($url, $arg));
1092     return substr($matches[0],0,$left) . $result . substr($matches[0],$right);
1093 }
1094
1095 require_once INSTALLDIR . "/lib/curry.php";
1096
1097 function common_linkify($url) {
1098     // It comes in special'd, so we unspecial it before passing to the stringifying
1099     // functions
1100     $url = htmlspecialchars_decode($url);
1101
1102     if (strpos($url, '@') !== false && strpos($url, ':') === false && Validate::email($url)) {
1103         //url is an email address without the mailto: protocol
1104         $canon = "mailto:$url";
1105         $longurl = "mailto:$url";
1106     } else {
1107         $canon = File_redirection::_canonUrl($url);
1108         $longurl_data = File_redirection::where($canon, common_config('attachments', 'process_links'));
1109
1110         if(isset($longurl_data->redir_url)) {
1111                         $longurl = $longurl_data->redir_url;
1112         } else {
1113             // e.g. local files
1114                 $longurl = $longurl_data->url;
1115         }
1116     }
1117
1118     $attrs = array('href' => $longurl, 'title' => $longurl);
1119
1120     $is_attachment = false;
1121     $attachment_id = null;
1122     $has_thumb = false;
1123
1124     // Check to see whether this is a known "attachment" URL.
1125
1126     try {
1127         $f = File::getByUrl($longurl);
1128     } catch (NoResultException $e) {
1129         if (common_config('attachments', 'process_links')) {
1130             // XXX: this writes to the database. :<
1131             try {
1132                 $f = File::processNew($longurl);
1133             } catch (ServerException $e) {
1134                 $f = null;
1135             }
1136         }
1137     }
1138
1139     if ($f instanceof File) {
1140         try {
1141             $enclosure = $f->getEnclosure();
1142             $is_attachment = true;
1143             $attachment_id = $f->id;
1144
1145             $thumb = File_thumbnail::getKV('file_id', $f->id);
1146             $has_thumb = ($thumb instanceof File_thumbnail);
1147         } catch (ServerException $e) {
1148             // There was not enough metadata available
1149         }
1150     }
1151
1152     // Whether to nofollow
1153     $nf = common_config('nofollow', 'external');
1154
1155     if ($nf == 'never') {
1156         $attrs['rel'] = 'external';
1157     } else {
1158         $attrs['rel'] = 'nofollow external';
1159     }
1160
1161     // Add clippy
1162     if ($is_attachment) {
1163         $attrs['class'] = 'attachment';
1164         if ($has_thumb) {
1165             $attrs['class'] = 'attachment thumbnail';
1166         }
1167         $attrs['id'] = "attachment-{$attachment_id}";
1168         $attrs['rel'] .= ' noreferrer';
1169     }
1170
1171     return XMLStringer::estring('a', $attrs, $url);
1172 }
1173
1174 /**
1175  * Find and shorten links in a given chunk of text if it's longer than the
1176  * configured notice content limit (or unconditionally).
1177  *
1178  * Side effects: may save file and file_redirection records for referenced URLs.
1179  *
1180  * Pass the $user option or call $user->shortenLinks($text) to ensure the proper
1181  * user's options are used; otherwise the current web session user's setitngs
1182  * will be used or ur1.ca if there is no active web login.
1183  *
1184  * @param string $text
1185  * @param boolean $always (optional)
1186  * @param User $user (optional)
1187  *
1188  * @return string
1189  */
1190 function common_shorten_links($text, $always = false, User $user=null)
1191 {
1192     if ($user === null) {
1193         $user = common_current_user();
1194     }
1195
1196     $maxLength = User_urlshortener_prefs::maxNoticeLength($user);
1197
1198     if ($always || ($maxLength != -1 && mb_strlen($text) > $maxLength)) {
1199         return common_replace_urls_callback($text, array('File_redirection', 'forceShort'), $user);
1200     } else {
1201         return common_replace_urls_callback($text, array('File_redirection', 'makeShort'), $user);
1202     }
1203 }
1204
1205 /**
1206  * Very basic stripping of invalid UTF-8 input text.
1207  *
1208  * @param string $str
1209  * @return mixed string or null if invalid input
1210  *
1211  * @todo ideally we should drop bad chars, and maybe do some of the checks
1212  *       from common_xml_safe_str. But we can't strip newlines, etc.
1213  * @todo Unicode normalization might also be useful, but not needed now.
1214  */
1215 function common_validate_utf8($str)
1216 {
1217     // preg_replace will return NULL on invalid UTF-8 input.
1218     //
1219     // Note: empty regex //u also caused NULL return on some
1220     // production machines, but none of our test machines.
1221     //
1222     // This should be replaced with a more reliable check.
1223     return preg_replace('/\x00/u', '', $str);
1224 }
1225
1226 /**
1227  * Make sure an arbitrary string is safe for output in XML as a single line.
1228  *
1229  * @param string $str
1230  * @return string
1231  */
1232 function common_xml_safe_str($str)
1233 {
1234     // Replace common eol and extra whitespace input chars
1235     $unWelcome = array(
1236         "\t",  // tab
1237         "\n",  // newline
1238         "\r",  // cr
1239         "\0",  // null byte eos
1240         "\x0B" // vertical tab
1241     );
1242
1243     $replacement = array(
1244         ' ', // single space
1245         ' ',
1246         '',  // nothing
1247         '',
1248         ' '
1249     );
1250
1251     $str = str_replace($unWelcome, $replacement, $str);
1252
1253     // Neutralize any additional control codes and UTF-16 surrogates
1254     // (Twitter uses '*')
1255     return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
1256 }
1257
1258 function common_slugify($str)
1259 {
1260     // php5-intl is highly recommended...
1261     if (!function_exists('transliterator_transliterate')) {
1262         $str = preg_replace('/[^\pL\pN]/u', '', $str);
1263         $str = mb_convert_case($str, MB_CASE_LOWER, 'UTF-8');
1264         $str = substr($str, 0, 64);
1265         return $str;
1266     }
1267     $str = transliterator_transliterate(
1268                         'Any-Latin;' .      // any charset to latin compatible
1269                             'NFD;' .        // decompose
1270                             '[:Nonspacing Mark:] Remove;' . // remove nonspacing marks (accents etc.)
1271                             'NFC;' .        // composite again
1272                             '[:Punctuation:] Remove;' . // remove punctuation (.,¿? etc.)
1273                             'Lower();' .    // turn into lowercase
1274                             'Latin-ASCII;',  // get ASCII equivalents (ð to d for example)
1275                         $str);
1276     return preg_replace('/[^\pL\pN]/', '', $str);
1277 }
1278
1279 function common_tag_link($tag)
1280 {
1281     $canonical = common_canonical_tag($tag);
1282     if (common_config('singleuser', 'enabled')) {
1283         // regular TagAction isn't set up in 1user mode
1284         $nickname = User::singleUserNickname();
1285         $url = common_local_url('showstream',
1286                                 array('nickname' => $nickname,
1287                                       'tag' => $canonical));
1288     } else {
1289         $url = common_local_url('tag', array('tag' => $canonical));
1290     }
1291     $xs = new XMLStringer();
1292     $xs->elementStart('span', 'tag');
1293     $xs->element('a', array('href' => $url,
1294                             'rel' => 'tag'),
1295                  $tag);
1296     $xs->elementEnd('span');
1297     return $xs->getString();
1298 }
1299
1300 function common_canonical_tag($tag)
1301 {
1302     $tag = common_slugify($tag);
1303     $tag = substr($tag, 0, 64);
1304     return $tag;
1305 }
1306
1307 function common_valid_profile_tag($str)
1308 {
1309     return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
1310 }
1311
1312 /**
1313  * Resolve an ambiguous profile nickname reference, checking in following order:
1314  * - profiles that $sender subscribes to
1315  * - profiles that subscribe to $sender
1316  * - local user profiles
1317  *
1318  * WARNING: does not validate or normalize $nickname -- MUST BE PRE-VALIDATED
1319  * OR THERE MAY BE A RISK OF SQL INJECTION ATTACKS. THIS FUNCTION DOES NOT
1320  * ESCAPE SQL.
1321  *
1322  * @fixme validate input
1323  * @fixme escape SQL
1324  * @fixme fix or remove mystery third parameter
1325  * @fixme is $sender a User or Profile?
1326  *
1327  * @param <type> $sender the user or profile in whose context we're looking
1328  * @param string $nickname validated nickname of
1329  * @param <type> $dt unused mystery parameter; in Notice reply-to handling a timestamp is passed.
1330  *
1331  * @return Profile or null
1332  */
1333 function common_relative_profile($sender, $nickname, $dt=null)
1334 {
1335     // Will throw exception on invalid input.
1336     $nickname = Nickname::normalize($nickname);
1337
1338     // Try to find profiles this profile is subscribed to that have this nickname
1339     $recipient = new Profile();
1340     // XXX: use a join instead of a subquery
1341     $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.intval($sender->id).' and subscribed = id)', 'AND');
1342     $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1343     if ($recipient->find(true)) {
1344         // XXX: should probably differentiate between profiles with
1345         // the same name by date of most recent update
1346         return $recipient;
1347     }
1348     // Try to find profiles that listen to this profile and that have this nickname
1349     $recipient = new Profile();
1350     // XXX: use a join instead of a subquery
1351     $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.intval($sender->id).' and subscriber = id)', 'AND');
1352     $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1353     if ($recipient->find(true)) {
1354         // XXX: should probably differentiate between profiles with
1355         // the same name by date of most recent update
1356         return $recipient;
1357     }
1358     // If this is a local user, try to find a local user with that nickname.
1359     $sender = User::getKV('id', $sender->id);
1360     if ($sender instanceof User) {
1361         $recipient_user = User::getKV('nickname', $nickname);
1362         if ($recipient_user instanceof User) {
1363             return $recipient_user->getProfile();
1364         }
1365     }
1366     // Otherwise, no links. @messages from local users to remote users,
1367     // or from remote users to other remote users, are just
1368     // outside our ability to make intelligent guesses about
1369     return null;
1370 }
1371
1372 function common_local_url($action, $args=null, $params=null, $fragment=null, $addSession=true)
1373 {
1374     if (Event::handle('StartLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url))) {
1375         $r = Router::get();
1376         $path = $r->build($action, $args, $params, $fragment);
1377
1378         $ssl = GNUsocial::useHTTPS();
1379
1380         if (common_config('site','fancy')) {
1381             $url = common_path($path, $ssl, $addSession);
1382         } else {
1383             if (mb_strpos($path, '/index.php') === 0) {
1384                 $url = common_path($path, $ssl, $addSession);
1385             } else {
1386                 $url = common_path('index.php/'.$path, $ssl, $addSession);
1387             }
1388         }
1389         Event::handle('EndLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url));
1390     }
1391     return $url;
1392 }
1393
1394 function common_path($relative, $ssl=false, $addSession=true)
1395 {
1396     $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
1397
1398     if ($ssl && GNUsocial::useHTTPS()) {
1399         $proto = 'https';
1400         if (is_string(common_config('site', 'sslserver')) &&
1401             mb_strlen(common_config('site', 'sslserver')) > 0) {
1402             $serverpart = common_config('site', 'sslserver');
1403         } else if (common_config('site', 'server')) {
1404             $serverpart = common_config('site', 'server');
1405         } else {
1406             common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1407         }
1408     } else {
1409         $proto = 'http';
1410         if (common_config('site', 'server')) {
1411             $serverpart = common_config('site', 'server');
1412         } else {
1413             common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1414         }
1415     }
1416
1417     if ($addSession) {
1418         $relative = common_inject_session($relative, $serverpart);
1419     }
1420
1421     return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
1422 }
1423
1424 // FIXME: Maybe this should also be able to handle non-fancy URLs with index.php?p=...
1425 function common_fake_local_fancy_url($url)
1426 {
1427     /**
1428      * This is a hacky fix to make URIs generated with "index.php/" match against
1429      * locally stored URIs without that. So for example if the remote site is looking
1430      * up the webfinger for some user and for some reason knows about https://some.example/user/1
1431      * but we locally store and report only https://some.example/index.php/user/1 then they would
1432      * dismiss the profile for not having an identified alias.
1433      *
1434      * There are various live instances where these issues occur, for various reasons.
1435      * Most of them being users fiddling with configuration while already having
1436      * started federating (distributing the URI to other servers) or maybe manually
1437      * editing the local database.
1438      */
1439     if (!preg_match(
1440                 // [1] protocol part, we can only rewrite http/https anyway.
1441                 '/^(https?:\/\/)' .
1442                 // [2] site name.
1443                 // FIXME: Dunno how this acts if we're aliasing ourselves with a .onion domain etc.
1444                 '('.preg_quote(common_config('site', 'server'), '/').')' .
1445                 // [3] site path, or if that is empty just '/' (to retain the /)
1446                 '('.preg_quote(common_config('site', 'path') ?: '/', '/').')' .
1447                 // [4] + [5] extract index.php (+ possible leading double /) and the rest of the URL separately.
1448                 '(\/?index\.php\/)(.*)$/', $url, $matches)) {
1449         // if preg_match failed to match
1450         throw new Exception('No known change could be made to the URL.');
1451     }
1452
1453     // now reconstruct the URL with everything except the "index.php/" part
1454     $fancy_url = '';
1455     foreach ([1,2,3,5] as $idx) {
1456         $fancy_url .= $matches[$idx];
1457     }
1458     return $fancy_url;
1459 }
1460
1461 // FIXME: Maybe this should also be able to handle non-fancy URLs with index.php?p=...
1462 function common_fake_local_nonfancy_url($url)
1463 {
1464     /**
1465      * This is a hacky fix to make URIs NOT generated with "index.php/" match against
1466      * locally stored URIs WITH that. The reverse from the above.
1467      *
1468      * It will also "repair" index.php URLs with multiple / prepended. Like https://some.example///index.php/user/1
1469      */
1470     if (!preg_match(
1471                 // [1] protocol part, we can only rewrite http/https anyway.
1472                 '/^(https?:\/\/)' .
1473                 // [2] site name.
1474                 // FIXME: Dunno how this acts if we're aliasing ourselves with a .onion domain etc.
1475                 '('.preg_quote(common_config('site', 'server'), '/').')' .
1476                 // [3] site path, or if that is empty just '/' (to retain the /)
1477                 '('.preg_quote(common_config('site', 'path') ?: '/', '/').')' .
1478                 // [4] should be empty (might contain one or more / and then maybe also index.php). Will be overwritten.
1479                 // [5] will have the extracted actual URL part (besides site path)
1480                 '((?!index.php\/)\/*(?:index.php\/)?)(.*)$/', $url, $matches)) {
1481         // if preg_match failed to match
1482         throw new Exception('No known change could be made to the URL.');
1483     }
1484
1485     $matches[4] = 'index.php/'; // inject the index.php/ rewritethingy
1486
1487     // remove the first element, which is the full matching string
1488     array_shift($matches);
1489     return implode($matches);
1490 }
1491
1492 function common_inject_session($url, $serverpart = null)
1493 {
1494     if (!common_have_session()) {
1495         return $url;
1496     }
1497
1498     if (empty($serverpart)) {
1499         $serverpart = parse_url($url, PHP_URL_HOST);
1500     }
1501
1502     $currentServer = (array_key_exists('HTTP_HOST', $_SERVER)) ? $_SERVER['HTTP_HOST'] : null;
1503
1504     // Are we pointing to another server (like an SSL server?)
1505
1506     if (!empty($currentServer) && 0 != strcasecmp($currentServer, $serverpart)) {
1507         // Pass the session ID as a GET parameter
1508         $sesspart = session_name() . '=' . session_id();
1509         $i = strpos($url, '?');
1510         if ($i === false) { // no GET params, just append
1511             $url .= '?' . $sesspart;
1512         } else {
1513             $url = substr($url, 0, $i + 1).$sesspart.'&'.substr($url, $i + 1);
1514         }
1515     }
1516
1517     return $url;
1518 }
1519
1520 function common_date_string($dt)
1521 {
1522     // XXX: do some sexy date formatting
1523     // return date(DATE_RFC822, $dt);
1524     $t = strtotime($dt);
1525     $now = time();
1526     $diff = $now - $t;
1527
1528     if ($now < $t) { // that shouldn't happen!
1529         return common_exact_date($dt);
1530     } else if ($diff < 60) {
1531         // TRANS: Used in notices to indicate when the notice was made compared to now.
1532         return _('a few seconds ago');
1533     } else if ($diff < 92) {
1534         // TRANS: Used in notices to indicate when the notice was made compared to now.
1535         return _('about a minute ago');
1536     } else if ($diff < 3300) {
1537         $minutes = round($diff/60);
1538         // TRANS: Used in notices to indicate when the notice was made compared to now.
1539         return sprintf( _m('about one minute ago', 'about %d minutes ago', $minutes), $minutes);
1540     } else if ($diff < 5400) {
1541         // TRANS: Used in notices to indicate when the notice was made compared to now.
1542         return _('about an hour ago');
1543     } else if ($diff < 22 * 3600) {
1544         $hours = round($diff/3600);
1545         // TRANS: Used in notices to indicate when the notice was made compared to now.
1546         return sprintf( _m('about one hour ago', 'about %d hours ago', $hours), $hours);
1547     } else if ($diff < 37 * 3600) {
1548         // TRANS: Used in notices to indicate when the notice was made compared to now.
1549         return _('about a day ago');
1550     } else if ($diff < 24 * 24 * 3600) {
1551         $days = round($diff/(24*3600));
1552         // TRANS: Used in notices to indicate when the notice was made compared to now.
1553         return sprintf( _m('about one day ago', 'about %d days ago', $days), $days);
1554     } else if ($diff < 46 * 24 * 3600) {
1555         // TRANS: Used in notices to indicate when the notice was made compared to now.
1556         return _('about a month ago');
1557     } else if ($diff < 330 * 24 * 3600) {
1558         $months = round($diff/(30*24*3600));
1559         // TRANS: Used in notices to indicate when the notice was made compared to now.
1560         return sprintf( _m('about one month ago', 'about %d months ago',$months), $months);
1561     } else if ($diff < 480 * 24 * 3600) {
1562         // TRANS: Used in notices to indicate when the notice was made compared to now.
1563         return _('about a year ago');
1564     } else {
1565         return common_exact_date($dt);
1566     }
1567 }
1568
1569 function common_exact_date($dt)
1570 {
1571     static $_utc;
1572     static $_siteTz;
1573
1574     if (!$_utc) {
1575         $_utc = new DateTimeZone('UTC');
1576         $_siteTz = new DateTimeZone(common_timezone());
1577     }
1578
1579     $dateStr = date('d F Y H:i:s', strtotime($dt));
1580     $d = new DateTime($dateStr, $_utc);
1581     $d->setTimezone($_siteTz);
1582     // TRANS: Human-readable full date-time specification (formatting on http://php.net/date)
1583     return $d->format(_('l, d-M-Y H:i:s T'));
1584 }
1585
1586 function common_date_w3dtf($dt)
1587 {
1588     $dateStr = date('d F Y H:i:s', strtotime($dt));
1589     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1590     $d->setTimezone(new DateTimeZone(common_timezone()));
1591     return $d->format(DATE_W3C);
1592 }
1593
1594 function common_date_rfc2822($dt)
1595 {
1596     $dateStr = date('d F Y H:i:s', strtotime($dt));
1597     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1598     $d->setTimezone(new DateTimeZone(common_timezone()));
1599     return $d->format('r');
1600 }
1601
1602 function common_date_iso8601($dt)
1603 {
1604     $dateStr = date('d F Y H:i:s', strtotime($dt));
1605     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1606     $d->setTimezone(new DateTimeZone(common_timezone()));
1607     return $d->format('c');
1608 }
1609
1610 function common_sql_now()
1611 {
1612     return common_sql_date(time());
1613 }
1614
1615 function common_sql_date($datetime)
1616 {
1617     return strftime('%Y-%m-%d %H:%M:%S', $datetime);
1618 }
1619
1620 /**
1621  * Return an SQL fragment to calculate an age-based weight from a given
1622  * timestamp or datetime column.
1623  *
1624  * @param string $column name of field we're comparing against current time
1625  * @param integer $dropoff divisor for age in seconds before exponentiation
1626  * @return string SQL fragment
1627  */
1628 function common_sql_weight($column, $dropoff)
1629 {
1630     if (common_config('db', 'type') == 'pgsql') {
1631         // PostgreSQL doesn't support timestampdiff function.
1632         // @fixme will this use the right time zone?
1633         // @fixme does this handle cross-year subtraction correctly?
1634         return "sum(exp(-extract(epoch from (now() - $column)) / $dropoff))";
1635     } else {
1636         return "sum(exp(timestampdiff(second, utc_timestamp(), $column) / $dropoff))";
1637     }
1638 }
1639
1640 function common_redirect($url, $code=307)
1641 {
1642     static $status = array(301 => "Moved Permanently",
1643                            302 => "Found",
1644                            303 => "See Other",
1645                            307 => "Temporary Redirect");
1646
1647     header('HTTP/1.1 '.$code.' '.$status[$code]);
1648     header("Location: $url");
1649     header("Connection: close");
1650
1651     $xo = new XMLOutputter();
1652     $xo->startXML('a',
1653                   '-//W3C//DTD XHTML 1.0 Strict//EN',
1654                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1655     $xo->element('a', array('href' => $url), $url);
1656     $xo->endXML();
1657     exit;
1658 }
1659
1660 // Stick the notice on the queue
1661
1662 function common_enqueue_notice($notice)
1663 {
1664     static $localTransports = array('ping');
1665
1666     $transports = array();
1667     if (common_config('sms', 'enabled')) {
1668         $transports[] = 'sms';
1669     }
1670     if (Event::hasHandler('HandleQueuedNotice')) {
1671         $transports[] = 'plugin';
1672     }
1673
1674     // We can skip these for gatewayed notices.
1675     if ($notice->isLocal()) {
1676         $transports = array_merge($transports, $localTransports);
1677     }
1678
1679     if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
1680
1681         $qm = QueueManager::get();
1682
1683         foreach ($transports as $transport)
1684         {
1685             $qm->enqueue($notice, $transport);
1686         }
1687
1688         Event::handle('EndEnqueueNotice', array($notice, $transports));
1689     }
1690
1691     return true;
1692 }
1693
1694 function common_profile_url($nickname)
1695 {
1696     return common_local_url('showstream', array('nickname' => $nickname),
1697                             null, null, false);
1698 }
1699
1700 /**
1701  * Should make up a reasonable root URL
1702  *
1703  * @param   bool    $tls    true or false to force TLS scheme, null to use server configuration
1704  */
1705 function common_root_url($tls=null)
1706 {
1707     if (is_null($tls)) {
1708         $tls = GNUsocial::useHTTPS();
1709     }
1710     $url = common_path('', $tls, false);
1711     $i = strpos($url, '?');
1712     if ($i !== false) {
1713         $url = substr($url, 0, $i);
1714     }
1715     return $url;
1716 }
1717
1718 /**
1719  * returns $bytes bytes of raw random data
1720  */
1721 function common_random_rawstr($bytes)
1722 {
1723     $rawstr = @file_exists('/dev/urandom')
1724             ? common_urandom($bytes)
1725             : common_mtrand($bytes);
1726
1727     return $rawstr;
1728 }
1729
1730 /**
1731  * returns $bytes bytes of random data as a hexadecimal string
1732  */
1733 function common_random_hexstr($bytes)
1734 {
1735     $str = common_random_rawstr($bytes);
1736
1737     $hexstr = '';
1738     for ($i = 0; $i < $bytes; $i++) {
1739         $hexstr .= sprintf("%02x", ord($str[$i]));
1740     }
1741     return $hexstr;
1742 }
1743
1744 function common_urandom($bytes)
1745 {
1746     $h = fopen('/dev/urandom', 'rb');
1747     // should not block
1748     $src = fread($h, $bytes);
1749     fclose($h);
1750     return $src;
1751 }
1752
1753 function common_mtrand($bytes)
1754 {
1755     $str = '';
1756     for ($i = 0; $i < $bytes; $i++) {
1757         $str .= chr(mt_rand(0, 255));
1758     }
1759     return $str;
1760 }
1761
1762 /**
1763  * Record the given URL as the return destination for a future
1764  * form submission, to be read by common_get_returnto().
1765  *
1766  * @param string $url
1767  *
1768  * @fixme as a session-global setting, this can allow multiple forms
1769  * to conflict and overwrite each others' returnto destinations if
1770  * the user has multiple tabs or windows open.
1771  *
1772  * Should refactor to index with a token or otherwise only pass the
1773  * data along its intended path.
1774  */
1775 function common_set_returnto($url)
1776 {
1777     common_ensure_session();
1778     $_SESSION['returnto'] = $url;
1779 }
1780
1781 /**
1782  * Fetch a return-destination URL previously recorded by
1783  * common_set_returnto().
1784  *
1785  * @return mixed URL string or null
1786  *
1787  * @fixme as a session-global setting, this can allow multiple forms
1788  * to conflict and overwrite each others' returnto destinations if
1789  * the user has multiple tabs or windows open.
1790  *
1791  * Should refactor to index with a token or otherwise only pass the
1792  * data along its intended path.
1793  */
1794 function common_get_returnto()
1795 {
1796     common_ensure_session();
1797     return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
1798 }
1799
1800 function common_timestamp()
1801 {
1802     return date('YmdHis');
1803 }
1804
1805 function common_ensure_syslog()
1806 {
1807     static $initialized = false;
1808     if (!$initialized) {
1809         openlog(common_config('syslog', 'appname'), 0,
1810             common_config('syslog', 'facility'));
1811         $initialized = true;
1812     }
1813 }
1814
1815 function common_log_line($priority, $msg)
1816 {
1817     static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1818                                       'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1819     return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . PHP_EOL;
1820 }
1821
1822 function common_request_id()
1823 {
1824     $pid = getmypid();
1825     $server = common_config('site', 'server');
1826     if (php_sapi_name() == 'cli') {
1827         $script = basename($_SERVER['PHP_SELF']);
1828         return "$server:$script:$pid";
1829     } else {
1830         static $req_id = null;
1831         if (!isset($req_id)) {
1832             $req_id = substr(md5(mt_rand()), 0, 8);
1833         }
1834         if (isset($_SERVER['REQUEST_URI'])) {
1835             $url = $_SERVER['REQUEST_URI'];
1836         }
1837         $method = $_SERVER['REQUEST_METHOD'];
1838         return "$server:$pid.$req_id $method $url";
1839     }
1840 }
1841
1842 function common_log($priority, $msg, $filename=null)
1843 {
1844     if(Event::handle('StartLog', array(&$priority, &$msg, &$filename))){
1845         $msg = (empty($filename)) ? $msg : basename($filename) . ' - ' . $msg;
1846         $msg = '[' . common_request_id() . '] ' . $msg;
1847         $logfile = common_config('site', 'logfile');
1848         if ($logfile) {
1849             $log = fopen($logfile, "a");
1850             if ($log) {
1851                 $output = common_log_line($priority, $msg);
1852                 fwrite($log, $output);
1853                 fclose($log);
1854             }
1855         } else {
1856             common_ensure_syslog();
1857             syslog($priority, $msg);
1858         }
1859         Event::handle('EndLog', array($priority, $msg, $filename));
1860     }
1861 }
1862
1863 function common_debug($msg, $filename=null)
1864 {
1865     if ($filename) {
1866         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1867     } else {
1868         common_log(LOG_DEBUG, $msg);
1869     }
1870 }
1871
1872 function common_log_db_error(&$object, $verb, $filename=null)
1873 {
1874     global $_PEAR;
1875
1876     $objstr = common_log_objstring($object);
1877     $last_error = &$_PEAR->getStaticProperty('DB_DataObject','lastError');
1878     if (is_object($last_error)) {
1879         $msg = $last_error->message;
1880     } else {
1881         $msg = 'Unknown error (' . var_export($last_error, true) . ')';
1882     }
1883     common_log(LOG_ERR, $msg . '(' . $verb . ' on ' . $objstr . ')', $filename);
1884 }
1885
1886 function common_log_objstring(&$object)
1887 {
1888     if (is_null($object)) {
1889         return "null";
1890     }
1891     if (!($object instanceof DB_DataObject)) {
1892         return "(unknown)";
1893     }
1894     $arr = $object->toArray();
1895     $fields = array();
1896     foreach ($arr as $k => $v) {
1897         if (is_object($v)) {
1898             $fields[] = "$k='".get_class($v)."'";
1899         } else {
1900             $fields[] = "$k='$v'";
1901         }
1902     }
1903     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1904     return $objstring;
1905 }
1906
1907 function common_valid_http_url($url, $secure=false)
1908 {
1909     if (empty($url)) {
1910         return false;
1911     }
1912
1913     // If $secure is true, only allow https URLs to pass
1914     // (if false, we use '?' in 'https?' to say the 's' is optional)
1915     $regex = $secure ? '/^https$/' : '/^https?$/';
1916     return filter_var($url, FILTER_VALIDATE_URL)
1917             && preg_match($regex, parse_url($url, PHP_URL_SCHEME));
1918 }
1919
1920 function common_valid_tag($tag)
1921 {
1922     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1923         return (Validate::email($matches[1]) ||
1924                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1925     }
1926     return false;
1927 }
1928
1929 /**
1930  * Determine if given domain or address literal is valid
1931  * eg for use in JIDs and URLs. Does not check if the domain
1932  * exists!
1933  *
1934  * @param string $domain
1935  * @return boolean valid or not
1936  */
1937 function common_valid_domain($domain)
1938 {
1939     $octet = "(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])";
1940     $ipv4 = "(?:$octet(?:\.$octet){3})";
1941     if (preg_match("/^$ipv4$/u", $domain)) return true;
1942
1943     $group = "(?:[0-9a-f]{1,4})";
1944     $ipv6 = "(?:\[($group(?::$group){0,7})?(::)?($group(?::$group){0,7})?\])"; // http://tools.ietf.org/html/rfc3513#section-2.2
1945
1946     if (preg_match("/^$ipv6$/ui", $domain, $matches)) {
1947         $before = explode(":", $matches[1]);
1948         $zeroes = $matches[2];
1949         $after = explode(":", $matches[3]);
1950         if ($zeroes) {
1951             $min = 0;
1952             $max = 7;
1953         } else {
1954             $min = 1;
1955             $max = 8;
1956         }
1957         $explicit = count($before) + count($after);
1958         if ($explicit < $min || $explicit > $max) {
1959             return false;
1960         }
1961         return true;
1962     }
1963
1964     try {
1965         require_once "Net/IDNA.php";
1966         $idn = Net_IDNA::getInstance();
1967         $domain = $idn->encode($domain);
1968     } catch (Exception $e) {
1969         return false;
1970     }
1971
1972     $subdomain = "(?:[a-z0-9][a-z0-9-]*)"; // @fixme
1973     $fqdn = "(?:$subdomain(?:\.$subdomain)*\.?)";
1974
1975     return preg_match("/^$fqdn$/ui", $domain);
1976 }
1977
1978 /* Following functions are copied from MediaWiki GlobalFunctions.php
1979  * and written by Evan Prodromou. */
1980
1981 function common_accept_to_prefs($accept, $def = '*/*')
1982 {
1983     // No arg means accept anything (per HTTP spec)
1984     if(!$accept) {
1985         return array($def => 1);
1986     }
1987
1988     $prefs = array();
1989
1990     $parts = explode(',', $accept);
1991
1992     foreach($parts as $part) {
1993         // FIXME: doesn't deal with params like 'text/html; level=1'
1994         @list($value, $qpart) = explode(';', trim($part));
1995         $match = array();
1996         if(!isset($qpart)) {
1997             $prefs[$value] = 1;
1998         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1999             $prefs[$value] = $match[1];
2000         }
2001     }
2002
2003     return $prefs;
2004 }
2005
2006 // Match by our supported file extensions
2007 function common_supported_filename_to_mime($filename)
2008 {
2009     // Accept a filename and take out the extension
2010     if (strpos($filename, '.') === false) {
2011         throw new ServerException(sprintf('No extension on filename: %1$s', _ve($filename)));
2012     }
2013
2014     $fileext = substr(strrchr($filename, '.'), 1);
2015     return common_supported_ext_to_mime($fileext);
2016 }
2017
2018 function common_supported_ext_to_mime($fileext)
2019 {
2020     $supported = common_config('attachments', 'supported');
2021     if ($supported === true) {
2022         // FIXME: Should we just accept the extension straight off when supported === true?
2023         throw new UnknownExtensionMimeException($fileext);
2024     }
2025     foreach($supported as $type => $ext) {
2026         if ($ext === $fileext) {
2027             return $type;
2028         }
2029     }
2030
2031     throw new ServerException('Unsupported file extension');
2032 }
2033
2034 // Match by our supported mime types
2035 function common_supported_mime_to_ext($mimetype)
2036 {
2037     $supported = common_config('attachments', 'supported');
2038     if (is_array($supported)) {
2039         foreach($supported as $type => $ext) {
2040             if ($mimetype === $type) {
2041                 return $ext;
2042             }
2043         }
2044     }
2045
2046     throw new UnknownMimeExtensionException($mimetype);
2047 }
2048
2049 // The MIME "media" is the part before the slash (video in video/webm)
2050 function common_get_mime_media($type)
2051 {
2052     $tmp = explode('/', $type);
2053     return strtolower($tmp[0]);
2054 }
2055
2056 // Get only the mimetype and not additional info (separated from bare mime with semi-colon)
2057 function common_bare_mime($mimetype)
2058 {
2059     $mimetype = mb_strtolower($mimetype);
2060     if ($semicolon = mb_strpos($mimetype, ';')) {
2061         $mimetype = mb_substr($mimetype, 0, $semicolon);
2062     }
2063     return $mimetype;
2064 }
2065
2066 function common_mime_type_match($type, $avail)
2067 {
2068     if(array_key_exists($type, $avail)) {
2069         return $type;
2070     } else {
2071         $parts = explode('/', $type);
2072         if(array_key_exists($parts[0] . '/*', $avail)) {
2073             return $parts[0] . '/*';
2074         } elseif(array_key_exists('*/*', $avail)) {
2075             return '*/*';
2076         } else {
2077             return null;
2078         }
2079     }
2080 }
2081
2082 function common_negotiate_type($cprefs, $sprefs)
2083 {
2084     $combine = array();
2085
2086     foreach(array_keys($sprefs) as $type) {
2087         $parts = explode('/', $type);
2088         if($parts[1] != '*') {
2089             $ckey = common_mime_type_match($type, $cprefs);
2090             if($ckey) {
2091                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2092             }
2093         }
2094     }
2095
2096     foreach(array_keys($cprefs) as $type) {
2097         $parts = explode('/', $type);
2098         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
2099             $skey = common_mime_type_match($type, $sprefs);
2100             if($skey) {
2101                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2102             }
2103         }
2104     }
2105
2106     $bestq = 0;
2107     $besttype = 'text/html';
2108
2109     foreach(array_keys($combine) as $type) {
2110         if($combine[$type] > $bestq) {
2111             $besttype = $type;
2112             $bestq = $combine[$type];
2113         }
2114     }
2115
2116     if ('text/html' === $besttype) {
2117         return "text/html; charset=utf-8";
2118     }
2119     return $besttype;
2120 }
2121
2122 function common_config($main, $sub=null)
2123 {
2124     global $config;
2125     if (is_null($sub)) {
2126         // Return the config category array
2127         return array_key_exists($main, $config) ? $config[$main] : array();
2128     }
2129     // Return the config value
2130     return (array_key_exists($main, $config) &&
2131             array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
2132 }
2133
2134 function common_config_set($main, $sub, $value)
2135 {
2136     global $config;
2137     if (!array_key_exists($main, $config)) {
2138         $config[$main] = array();
2139     }
2140     $config[$main][$sub] = $value;
2141 }
2142
2143 function common_config_append($main, $sub, $value)
2144 {
2145     global $config;
2146     if (!array_key_exists($main, $config)) {
2147         $config[$main] = array();
2148     }
2149     if (!array_key_exists($sub, $config[$main])) {
2150         $config[$main][$sub] = array();
2151     }
2152     if (!is_array($config[$main][$sub])) {
2153         $config[$main][$sub] = array($config[$main][$sub]);
2154     }
2155     array_push($config[$main][$sub], $value);
2156 }
2157
2158 /**
2159  * Pull arguments from a GET/POST/REQUEST array with first-level input checks:
2160  * strips "magic quotes" slashes if necessary, and kills invalid UTF-8 strings.
2161  *
2162  * @param array $from
2163  * @return array
2164  */
2165 function common_copy_args($from)
2166 {
2167     $to = array();
2168     $strip = get_magic_quotes_gpc();
2169     foreach ($from as $k => $v) {
2170         if(is_array($v)) {
2171             $to[$k] = common_copy_args($v);
2172         } else {
2173             if ($strip) {
2174                 $v = stripslashes($v);
2175             }
2176             $to[$k] = strval(common_validate_utf8($v));
2177         }
2178     }
2179     return $to;
2180 }
2181
2182 /**
2183  * Neutralise the evil effects of magic_quotes_gpc in the current request.
2184  * This is used before handing a request off to OAuthRequest::from_request.
2185  * @fixme Doesn't consider vars other than _POST and _GET?
2186  * @fixme Can't be undone and could corrupt data if run twice.
2187  */
2188 function common_remove_magic_from_request()
2189 {
2190     if(get_magic_quotes_gpc()) {
2191         $_POST=array_map('stripslashes',$_POST);
2192         $_GET=array_map('stripslashes',$_GET);
2193     }
2194 }
2195
2196 function common_user_uri(&$user)
2197 {
2198     return common_local_url('userbyid', array('id' => $user->id),
2199                             null, null, false);
2200 }
2201
2202 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
2203
2204 function common_confirmation_code($bits)
2205 {
2206     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
2207     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
2208     $chars = ceil($bits/5);
2209     $code = '';
2210     for ($i = 0; $i < $chars; $i++) {
2211         // XXX: convert to string and back
2212         $num = hexdec(common_random_hexstr(1));
2213         // XXX: randomness is too precious to throw away almost
2214         // 40% of the bits we get!
2215         $code .= $codechars[$num%32];
2216     }
2217     return $code;
2218 }
2219
2220 // convert markup to HTML
2221 function common_markup_to_html($c, $args=null)
2222 {
2223     if ($c === null) {
2224         return '';
2225     }
2226
2227     if (is_null($args)) {
2228         $args = array();
2229     }
2230
2231     // XXX: not very efficient
2232
2233     foreach ($args as $name => $value) {
2234         $c = preg_replace('/%%arg.'.$name.'%%/', $value, $c);
2235     }
2236
2237     $c = preg_replace_callback('/%%user.(\w+)%%/', function ($m) { return common_user_property($m[1]); }, $c);
2238     $c = preg_replace_callback('/%%action.(\w+)%%/', function ($m) { return common_local_url($m[1]); }, $c);
2239     $c = preg_replace_callback('/%%doc.(\w+)%%/', function ($m) { return common_local_url('doc', array('title'=>$m[1])); }, $c);
2240     $c = preg_replace_callback('/%%(\w+).(\w+)%%/', function ($m) { return common_config($m[1], $m[2]); }, $c);
2241
2242     return \Michelf\Markdown::defaultTransform($c);
2243 }
2244
2245 function common_user_property($property)
2246 {
2247     $profile = Profile::current();
2248
2249     if (empty($profile)) {
2250         return null;
2251     }
2252
2253     switch ($property) {
2254     case 'profileurl':
2255     case 'nickname':
2256     case 'fullname':
2257     case 'location':
2258     case 'bio':
2259         return $profile->$property;
2260         break;
2261     case 'avatar':
2262         try {
2263             return $profile->getAvatar(AVATAR_STREAM_SIZE);
2264         } catch (Exception $e) {
2265             return null;
2266         }
2267         break;
2268     case 'bestname':
2269         return $profile->getBestName();
2270         break;
2271     default:
2272         return null;
2273     }
2274 }
2275
2276 function common_profile_uri($profile)
2277 {
2278     $uri = null;
2279
2280     if (!empty($profile)) {
2281         if (Event::handle('StartCommonProfileURI', array($profile, &$uri))) {
2282             $user = User::getKV('id', $profile->id);
2283             if ($user instanceof User) {
2284                 $uri = $user->getUri();
2285             }
2286             Event::handle('EndCommonProfileURI', array($profile, &$uri));
2287         }
2288     }
2289
2290     // XXX: this is a very bad profile!
2291     return $uri;
2292 }
2293
2294 function common_canonical_sms($sms)
2295 {
2296     // strip non-digits
2297     preg_replace('/\D/', '', $sms);
2298     return $sms;
2299 }
2300
2301 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
2302 {
2303     switch ($errno) {
2304
2305      case E_ERROR:
2306      case E_COMPILE_ERROR:
2307      case E_CORE_ERROR:
2308      case E_USER_ERROR:
2309      case E_PARSE:
2310      case E_RECOVERABLE_ERROR:
2311         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
2312         die();
2313         break;
2314
2315      case E_WARNING:
2316      case E_COMPILE_WARNING:
2317      case E_CORE_WARNING:
2318      case E_USER_WARNING:
2319         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
2320         break;
2321
2322      case E_NOTICE:
2323      case E_USER_NOTICE:
2324         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
2325         break;
2326
2327      case E_STRICT:
2328      case E_DEPRECATED:
2329      case E_USER_DEPRECATED:
2330         // XXX: config variable to log this stuff, too
2331         break;
2332
2333      default:
2334         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
2335         die();
2336         break;
2337     }
2338
2339     // FIXME: show error page if we're on the Web
2340     /* Don't execute PHP internal error handler */
2341     return true;
2342 }
2343
2344 function common_session_token()
2345 {
2346     common_ensure_session();
2347     if (!array_key_exists('token', $_SESSION)) {
2348         $_SESSION['token'] = common_random_hexstr(64);
2349     }
2350     return $_SESSION['token'];
2351 }
2352
2353 function common_license_terms($uri)
2354 {
2355     if(preg_match('/creativecommons.org\/licenses\/([^\/]+)/', $uri, $matches)) {
2356         return explode('-',$matches[1]);
2357     }
2358     return array($uri);
2359 }
2360
2361 function common_compatible_license($from, $to)
2362 {
2363     $from_terms = common_license_terms($from);
2364     // public domain and cc-by are compatible with everything
2365     if(count($from_terms) == 1 && ($from_terms[0] == 'publicdomain' || $from_terms[0] == 'by')) {
2366         return true;
2367     }
2368     $to_terms = common_license_terms($to);
2369     // sa is compatible across versions. IANAL
2370     if(in_array('sa',$from_terms) || in_array('sa',$to_terms)) {
2371         return count(array_diff($from_terms, $to_terms)) == 0;
2372     }
2373     // XXX: better compatibility check needed here!
2374     // Should at least normalise URIs
2375     return ($from == $to);
2376 }
2377
2378 /**
2379  * returns a quoted table name, if required according to config
2380  */
2381 function common_database_tablename($tablename)
2382 {
2383   if(common_config('db','quote_identifiers')) {
2384       $tablename = '"'. $tablename .'"';
2385   }
2386   //table prefixes could be added here later
2387   return $tablename;
2388 }
2389
2390 /**
2391  * Shorten a URL with the current user's configured shortening service,
2392  * or ur1.ca if configured, or not at all if no shortening is set up.
2393  *
2394  * @param string  $long_url original URL
2395  * @param User $user to specify a particular user's options
2396  * @param boolean $force    Force shortening (used when notice is too long)
2397  * @return string may return the original URL if shortening failed
2398  *
2399  * @fixme provide a way to specify a particular shortener
2400  */
2401 function common_shorten_url($long_url, User $user=null, $force = false)
2402 {
2403     $long_url = trim($long_url);
2404
2405     $user = common_current_user();
2406
2407     $maxUrlLength = User_urlshortener_prefs::maxUrlLength($user);
2408
2409     // $force forces shortening even if it's not strictly needed
2410     // I doubt URL shortening is ever 'strictly' needed. - ESP
2411
2412     if (($maxUrlLength == -1 || mb_strlen($long_url) < $maxUrlLength) && !$force) {
2413         return $long_url;
2414     }
2415
2416     $shortenerName = User_urlshortener_prefs::urlShorteningService($user);
2417
2418     if (Event::handle('StartShortenUrl',
2419                       array($long_url, $shortenerName, &$shortenedUrl))) {
2420         if ($shortenerName == 'internal') {
2421             try {
2422                 $f = File::processNew($long_url);
2423                 $shortenedUrl = common_local_url('redirecturl', array('id' => $f->id));
2424                 if ((mb_strlen($shortenedUrl) < mb_strlen($long_url)) || $force) {
2425                     return $shortenedUrl;
2426                 } else {
2427                     return $long_url;
2428                 }
2429             } catch (ServerException $e) {
2430                 return $long_url;
2431             }
2432         } else {
2433             return $long_url;
2434         }
2435     } else {
2436         //URL was shortened, so return the result
2437         return trim($shortenedUrl);
2438     }
2439 }
2440
2441 /**
2442  * @return mixed array($proxy, $ip) for web requests; proxy may be null
2443  *               null if not a web request
2444  *
2445  * @fixme X-Forwarded-For can be chained by multiple proxies;
2446           we should parse the list and provide a cleaner array
2447  * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
2448  * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
2449  *        use function to get exact request headers from Apache if possible.
2450  */
2451 function common_client_ip()
2452 {
2453     if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
2454         return null;
2455     }
2456
2457     if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
2458         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2459             $proxy = $_SERVER['HTTP_CLIENT_IP'];
2460         } else {
2461             $proxy = $_SERVER['REMOTE_ADDR'];
2462         }
2463         $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
2464     } else {
2465         $proxy = null;
2466         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2467             $ip = $_SERVER['HTTP_CLIENT_IP'];
2468         } else {
2469             $ip = $_SERVER['REMOTE_ADDR'];
2470         }
2471     }
2472
2473     return array($proxy, $ip);
2474 }
2475
2476 function common_url_to_nickname($url)
2477 {
2478     static $bad = array('query', 'user', 'password', 'port', 'fragment');
2479
2480     $parts = parse_url($url);
2481
2482     // If any of these parts exist, this won't work
2483
2484     foreach ($bad as $badpart) {
2485         if (array_key_exists($badpart, $parts)) {
2486             return null;
2487         }
2488     }
2489
2490     // We just have host and/or path
2491
2492     // If it's just a host...
2493     if (array_key_exists('host', $parts) &&
2494         (!array_key_exists('path', $parts) || strcmp($parts['path'], '/') == 0))
2495     {
2496         $hostparts = explode('.', $parts['host']);
2497
2498         // Try to catch common idiom of nickname.service.tld
2499
2500         if ((count($hostparts) > 2) &&
2501             (strlen($hostparts[count($hostparts) - 2]) > 3) && # try to skip .co.uk, .com.au
2502             (strcmp($hostparts[0], 'www') != 0))
2503         {
2504             return common_nicknamize($hostparts[0]);
2505         } else {
2506             // Do the whole hostname
2507             return common_nicknamize($parts['host']);
2508         }
2509     } else {
2510         if (array_key_exists('path', $parts)) {
2511             // Strip starting, ending slashes
2512             $path = preg_replace('@/$@', '', $parts['path']);
2513             $path = preg_replace('@^/@', '', $path);
2514             $path = basename($path);
2515
2516             // Hack for MediaWiki user pages, in the form:
2517             // http://example.com/wiki/User:Myname
2518             // ('User' may be localized.)
2519             if (strpos($path, ':')) {
2520                 $parts = array_filter(explode(':', $path));
2521                 $path = $parts[count($parts) - 1];
2522             }
2523
2524             if ($path) {
2525                 return common_nicknamize($path);
2526             }
2527         }
2528     }
2529
2530     return null;
2531 }
2532
2533 function common_nicknamize($str)
2534 {
2535     try {
2536         return Nickname::normalize($str);
2537     } catch (NicknameException $e) {
2538         return null;
2539     }
2540 }
2541
2542 function common_perf_counter($key, $val=null)
2543 {
2544     global $_perfCounters;
2545     if (isset($_perfCounters)) {
2546         if (common_config('site', 'logperf')) {
2547             if (array_key_exists($key, $_perfCounters)) {
2548                 $_perfCounters[$key][] = $val;
2549             } else {
2550                 $_perfCounters[$key] = array($val);
2551             }
2552             if (common_config('site', 'logperf_detail')) {
2553                 common_log(LOG_DEBUG, "PERF COUNTER HIT: $key $val");
2554             }
2555         }
2556     }
2557 }
2558
2559 function common_log_perf_counters()
2560 {
2561     if (common_config('site', 'logperf')) {
2562         global $_startTime, $_perfCounters;
2563
2564         if (isset($_startTime)) {
2565             $endTime = microtime(true);
2566             $diff = round(($endTime - $_startTime) * 1000);
2567             common_log(LOG_DEBUG, "PERF runtime: ${diff}ms");
2568         }
2569         $counters = $_perfCounters;
2570         ksort($counters);
2571         foreach ($counters as $key => $values) {
2572             $count = count($values);
2573             $unique = count(array_unique($values));
2574             common_log(LOG_DEBUG, "PERF COUNTER: $key $count ($unique unique)");
2575         }
2576     }
2577 }
2578
2579 function common_is_email($str)
2580 {
2581     return (strpos($str, '@') !== false);
2582 }
2583
2584 function common_init_stats()
2585 {
2586     global $_mem, $_ts;
2587
2588     $_mem = memory_get_usage(true);
2589     $_ts  = microtime(true);
2590 }
2591
2592 function common_log_delta($comment=null)
2593 {
2594     global $_mem, $_ts;
2595
2596     $mold = $_mem;
2597     $told = $_ts;
2598
2599     $_mem = memory_get_usage(true);
2600     $_ts  = microtime(true);
2601
2602     $mtotal = $_mem - $mold;
2603     $ttotal = $_ts - $told;
2604
2605     if (empty($comment)) {
2606         $comment = 'Delta';
2607     }
2608
2609     common_debug(sprintf("%s: %d %d", $comment, $mtotal, round($ttotal * 1000000)));
2610 }
2611
2612 function common_strip_html($html, $trim=true, $save_whitespace=false)
2613 {
2614     // first replace <br /> with \n
2615     $html = preg_replace('/\<(\s*)?br(\s*)?\/?(\s*)?\>/i', "\n", $html);
2616     // then, unless explicitly avoided, remove excessive whitespace
2617     if (!$save_whitespace) {
2618         $html = preg_replace('/\s+/', ' ', $html);
2619     }
2620     $text = html_entity_decode(strip_tags($html), ENT_QUOTES, 'UTF-8');
2621     return $trim ? trim($text) : $text;
2622 }
2623
2624 function html_sprintf()
2625 {
2626     $args = func_get_args();
2627     for ($i=1; $i<count($args); $i++) {
2628         $args[$i] = htmlspecialchars($args[$i]);
2629     }
2630     return call_user_func_array('sprintf', $args);
2631 }
2632
2633 function _ve($var)
2634 {
2635     return var_export($var, true);
2636 }