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     if (common_config('cache', 'dir')) {
 614         $cfg->set('Cache.SerializerPath', common_config('cache', 'dir'));
 615     }
 616     // if you don't want to use the default cache dir for htmlpurifier, set it specifically as $config['htmlpurifier']['Cache.SerializerPath'] = '/tmp'; or something.
 617     foreach (common_config('htmlpurifier') as $key=>$val) {
 618         $cfg->set($key, $val);
 619     }
 620
 621     // Remove more elements than what the default filter removes, default in GNU social are remotely
 622     // linked resources such as img, video, audio
 623     $forbiddenElements = array();
 624     foreach (common_config('htmlfilter') as $tag=>$filter) {
 625         if ($filter === true) {
 626             $forbiddenElements[] = $tag;
 627         }
 628     }
 629     $cfg->set('HTML.ForbiddenElements', $forbiddenElements);
 630
 631     $html = common_remove_unicode_formatting($html);
 632
 633     $purifier = new HTMLPurifier($cfg);
 634     $purified = $purifier->purify($html);
 635     Event::handle('EndCommonPurify', array(&$purified, $html));
 636
 637     return $purified;
 638 }
 639
 640 function common_remove_unicode_formatting($text)
 641 {
 642     // Strip Unicode text formatting/direction codes
 643     // this is pretty dangerous for visualisation of text and can be used for mischief
 644     return preg_replace('/[\\x{200b}-\\x{200f}\\x{202a}-\\x{202e}]/u', '', $text);
 645 }
 646
 647 /**
 648  * Partial notice markup rendering step: build links to !group references.
 649  *
 650  * @param string    $text partially rendered HTML
 651  * @param Profile   $author the Profile that is composing the current notice
 652  * @param Notice    $parent the Notice this is sent in reply to, if any
 653  * @return string partially rendered HTML
 654  */
 655 function common_render_content($text, Profile $author, Notice $parent=null)
 656 {
 657     $text = common_render_text($text);
 658     $text = common_linkify_mentions($text, $author, $parent);
 659     return $text;
 660 }
 661
 662 /**
 663  * Finds @-mentions within the partially-rendered text section and
 664  * turns them into live links.
 665  *
 666  * Should generally not be called except from common_render_content().
 667  *
 668  * @param string    $text   partially-rendered HTML
 669  * @param Profile   $author the Profile that is composing the current notice
 670  * @param Notice    $parent the Notice this is sent in reply to, if any
 671  * @return string partially-rendered HTML
 672  */
 673 function common_linkify_mentions($text, Profile $author, Notice $parent=null)
 674 {
 675     $mentions = common_find_mentions($text, $author, $parent);
 676
 677     // We need to go through in reverse order by position,
 678     // so our positions stay valid despite our fudging with the
 679     // string!
 680
 681     $points = array();
 682
 683     foreach ($mentions as $mention)
 684     {
 685         $points[$mention['position']] = $mention;
 686     }
 687
 688     krsort($points);
 689
 690     foreach ($points as $position => $mention) {
 691
 692         $linkText = common_linkify_mention($mention);
 693
 694         $text = substr_replace($text, $linkText, $position, $mention['length']);
 695     }
 696
 697     return $text;
 698 }
 699
 700 function common_linkify_mention(array $mention)
 701 {
 702     $output = null;
 703
 704     if (Event::handle('StartLinkifyMention', array($mention, &$output))) {
 705
 706         $xs = new XMLStringer(false);
 707
 708         $attrs = array('href' => $mention['url'],
 709                        'class' => 'h-card u-url p-nickname '.$mention['type']);
 710
 711         if (!empty($mention['title'])) {
 712             $attrs['title'] = $mention['title'];
 713         }
 714
 715         $xs->element('a', $attrs, $mention['text']);
 716
 717         $output = $xs->getString();
 718
 719         Event::handle('EndLinkifyMention', array($mention, &$output));
 720     }
 721
 722     return $output;
 723 }
 724
 725 function common_get_attentions($text, Profile $sender, Notice $parent=null)
 726 {
 727     $mentions = common_find_mentions($text, $sender, $parent);
 728     $atts = array();
 729     foreach ($mentions as $mention) {
 730         foreach ($mention['mentioned'] as $mentioned) {
 731             $atts[$mentioned->getUri()] = $mentioned->getObjectType();
 732         }
 733     }
 734     if ($parent instanceof Notice) {
 735         $parentAuthor = $parent->getProfile();
 736         // afaik groups can't be authors
 737         $atts[$parentAuthor->getUri()] = ActivityObject::PERSON;
 738     }
 739     return $atts;
 740 }
 741
 742 /**
 743  * Find @-mentions in the given text, using the given notice object as context.
 744  * References will be resolved with common_relative_profile() against the user
 745  * who posted the notice.
 746  *
 747  * Note the return data format is internal, to be used for building links and
 748  * such. Should not be used directly; rather, call common_linkify_mentions().
 749  *
 750  * @param string    $text
 751  * @param Profile   $sender the Profile that is sending the current text
 752  * @param Notice    $parent the Notice this text is in reply to, if any
 753  *
 754  * @return array
 755  *
 756  * @access private
 757  */
 758 function common_find_mentions($text, Profile $sender, Notice $parent=null)
 759 {
 760     $mentions = array();
 761
 762     if (Event::handle('StartFindMentions', array($sender, $text, &$mentions))) {
 763         // Get the context of the original notice, if any
 764         $origMentions = array();
 765         // Does it have a parent notice for context?
 766         if ($parent instanceof Notice) {
 767             foreach ($parent->getAttentionProfiles() as $repliedTo) {
 768                 if (!$repliedTo->isPerson()) {
 769                     continue;
 770                 }
 771                 $origMentions[$repliedTo->id] = $repliedTo;
 772             }
 773         }
 774
 775         $matches = common_find_mentions_raw($text, '@');
 776
 777         foreach ($matches as $match) {
 778             try {
 779                 $nickname = Nickname::normalize($match[0]);
 780             } catch (NicknameException $e) {
 781                 // Bogus match? Drop it.
 782                 continue;
 783             }
 784
 785                         // primarily mention the profiles mentioned in the parent
 786             $mention_found_in_origMentions = false;
 787             foreach($origMentions as $origMentionsId=>$origMention) {
 788                 if($origMention->getNickname() == $nickname) {
 789                     $mention_found_in_origMentions = $origMention;
 790                     // don't mention same twice! the parent might have mentioned
 791                     // two users with same nickname on different instances
 792                     unset($origMentions[$origMentionsId]);
 793                     break;
 794                 }
 795             }
 796
 797             // Try to get a profile for this nickname.
 798             // Start with parents mentions, then go to parents sender context
 799             if ($mention_found_in_origMentions) {
 800                 $mentioned = $mention_found_in_origMentions;
 801             } else if ($parent instanceof Notice && $parent->getProfile()->getNickname() === $nickname) {
 802                 $mentioned = $parent->getProfile();
 803             } else {
 804                 // sets to null if no match
 805                 $mentioned = common_relative_profile($sender, $nickname);
 806             }
 807
 808             if ($mentioned instanceof Profile) {
 809                 try {
 810                     $url = $mentioned->getUri();    // prefer the URI as URL, if it is one.
 811                     if (!common_valid_http_url($url)) {
 812                         $url = $mentioned->getUrl();
 813                     }
 814                 } catch (InvalidUrlException $e) {
 815                     $url = common_local_url('userbyid', array('id' => $mentioned->getID()));
 816                 }
 817
 818                 $mention = array('mentioned' => array($mentioned),
 819                                  'type' => 'mention',
 820                                  'text' => $match[0],
 821                                  'position' => $match[1],
 822                                  'length' => mb_strlen($match[0]),
 823                                  'title' => $mentioned->getFullname(),
 824                                  'url' => $url);
 825
 826                 $mentions[] = $mention;
 827             }
 828         }
 829
 830         // @#tag => mention of all subscriptions tagged 'tag'
 831
 832         preg_match_all('/'.Nickname::BEFORE_MENTIONS.'@#([\pL\pN_\-\.]{1,64})/',
 833                        $text, $hmatches, PREG_OFFSET_CAPTURE);
 834         foreach ($hmatches[1] as $hmatch) {
 835             $tag = common_canonical_tag($hmatch[0]);
 836             $plist = Profile_list::getByTaggerAndTag($sender->getID(), $tag);
 837             if (!$plist instanceof Profile_list || $plist->private) {
 838                 continue;
 839             }
 840             $tagged = $sender->getTaggedSubscribers($tag);
 841
 842             $url = common_local_url('showprofiletag',
 843                                     array('nickname' => $sender->getNickname(),
 844                                           'tag' => $tag));
 845
 846             $mentions[] = array('mentioned' => $tagged,
 847                                 'type'      => 'list',
 848                                 'text' => $hmatch[0],
 849                                 'position' => $hmatch[1],
 850                                 'length' => mb_strlen($hmatch[0]),
 851                                 'url' => $url);
 852         }
 853
 854         $hmatches = common_find_mentions_raw($text, '!');
 855         foreach ($hmatches as $hmatch) {
 856             $nickname = Nickname::normalize($hmatch[0]);
 857             $group = User_group::getForNickname($nickname, $sender);
 858
 859             if (!$group instanceof User_group || !$sender->isMember($group)) {
 860                 continue;
 861             }
 862
 863             $profile = $group->getProfile();
 864
 865             $mentions[] = array('mentioned' => array($profile),
 866                                 'type'      => 'group',
 867                                 'text'      => $hmatch[0],
 868                                 'position'  => $hmatch[1],
 869                                 'length'    => mb_strlen($hmatch[0]),
 870                                 'url'       => $group->permalink(),
 871                                 'title'     => $group->getFancyName());
 872         }
 873
 874         Event::handle('EndFindMentions', array($sender, $text, &$mentions));
 875     }
 876
 877     return $mentions;
 878 }
 879
 880 /**
 881  * Does the actual regex pulls to find @-mentions in text.
 882  * Should generally not be called directly; for use in common_find_mentions.
 883  *
 884  * @param string $text
 885  * @param string $preMention Character(s) that signals a mention ('@', '!'...)
 886  * @return array of PCRE match arrays
 887  */
 888 function common_find_mentions_raw($text, $preMention='@')
 889 {
 890     $tmatches = array();
 891     preg_match_all('/^T (' . Nickname::DISPLAY_FMT . ') /',
 892                    $text,
 893                    $tmatches,
 894                    PREG_OFFSET_CAPTURE);
 895
 896     $atmatches = array();
 897     // the regexp's "(?!\@)" makes sure it doesn't matches the single "@remote" in "@remote@server.com"
 898     preg_match_all('/'.Nickname::BEFORE_MENTIONS.preg_quote($preMention, '/').'(' . Nickname::DISPLAY_FMT . ')\b(?!\@)/',
 899                    $text,
 900                    $atmatches,
 901                    PREG_OFFSET_CAPTURE);
 902
 903     $matches = array_merge($tmatches[1], $atmatches[1]);
 904     return $matches;
 905 }
 906
 907 function common_render_text($text)
 908 {
 909     $text = common_remove_unicode_formatting($text);
 910     $text = nl2br(htmlspecialchars($text));
 911
 912     $text = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $text);
 913     $text = common_replace_urls_callback($text, 'common_linkify');
 914     $text = preg_replace_callback('/(^|\&quot\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/u',
 915                 function ($m) { return "{$m[1]}#".common_tag_link($m[2]); }, $text);
 916     // XXX: machine tags
 917     return $text;
 918 }
 919
 920 define('_URL_SCHEME_COLON_DOUBLE_SLASH', 1);
 921 define('_URL_SCHEME_SINGLE_COLON', 2);
 922 define('_URL_SCHEME_NO_DOMAIN', 4);
 923 define('_URL_SCHEME_COLON_COORDINATES', 8);
 924
 925 function common_url_schemes($filter=null)
 926 {
 927     // TODO: move these to $config
 928     $schemes = [
 929                 'http'      => _URL_SCHEME_COLON_DOUBLE_SLASH,
 930                 'https'     => _URL_SCHEME_COLON_DOUBLE_SLASH,
 931                 'ftp'       => _URL_SCHEME_COLON_DOUBLE_SLASH,
 932                 'ftps'      => _URL_SCHEME_COLON_DOUBLE_SLASH,
 933                 'mms'       => _URL_SCHEME_COLON_DOUBLE_SLASH,
 934                 'rtsp'      => _URL_SCHEME_COLON_DOUBLE_SLASH,
 935                 'gopher'    => _URL_SCHEME_COLON_DOUBLE_SLASH,
 936                 'news'      => _URL_SCHEME_COLON_DOUBLE_SLASH,
 937                 'nntp'      => _URL_SCHEME_COLON_DOUBLE_SLASH,
 938                 'telnet'    => _URL_SCHEME_COLON_DOUBLE_SLASH,
 939                 'wais'      => _URL_SCHEME_COLON_DOUBLE_SLASH,
 940                 'file'      => _URL_SCHEME_COLON_DOUBLE_SLASH,
 941                 'prospero'  => _URL_SCHEME_COLON_DOUBLE_SLASH,
 942                 'webcal'    => _URL_SCHEME_COLON_DOUBLE_SLASH,
 943                 'irc'       => _URL_SCHEME_COLON_DOUBLE_SLASH,
 944                 'ircs'      => _URL_SCHEME_COLON_DOUBLE_SLASH,
 945                 'aim'       => _URL_SCHEME_SINGLE_COLON,
 946                 'bitcoin'   => _URL_SCHEME_SINGLE_COLON,
 947                 'fax'       => _URL_SCHEME_SINGLE_COLON,
 948                 'jabber'    => _URL_SCHEME_SINGLE_COLON,
 949                 'mailto'    => _URL_SCHEME_SINGLE_COLON,
 950                 'tel'       => _URL_SCHEME_SINGLE_COLON,
 951                 'xmpp'      => _URL_SCHEME_SINGLE_COLON,
 952                 'magnet'    => _URL_SCHEME_NO_DOMAIN,
 953                 'geo'       => _URL_SCHEME_COLON_COORDINATES,
 954                 ];
 955
 956     return array_keys(
 957             array_filter($schemes,
 958                 function ($scheme) use ($filter) {
 959                     return is_null($filter) || ($scheme & $filter);
 960                 })
 961             );
 962 }
 963
 964 /**
 965  * Find links in the given text and pass them to the given callback function.
 966  *
 967  * @param string $text
 968  * @param function($text, $arg) $callback: return replacement text
 969  * @param mixed $arg: optional argument will be passed on to the callback
 970  */
 971 function common_replace_urls_callback($text, $callback, $arg = null) {
 972     $geouri_labeltext_regex = '\pN\pL\-';
 973     $geouri_mark_regex = '\-\_\.\!\~\*\\\'\(\)';    // the \\\' is really pretty
 974     $geouri_unreserved_regex = '\pN\pL' . $geouri_mark_regex;
 975     $geouri_punreserved_regex = '\[\]\:\&\+\$';
 976     $geouri_pctencoded_regex = '(?:\%[0-9a-fA-F][0-9a-fA-F])';
 977     $geouri_paramchar_regex = $geouri_unreserved_regex . $geouri_punreserved_regex; //FIXME: add $geouri_pctencoded_regex here so it works
 978
 979     // Start off with a regex
 980     $regex = '#'.
 981     '(?:^|[\s\<\>\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
 982     '('.
 983         '(?:'.
 984             '(?:'. //Known protocols
 985                 '(?:'.
 986                     '(?:(?:' . implode('|', common_url_schemes(_URL_SCHEME_COLON_DOUBLE_SLASH)) . ')://)'.
 987                     '|'.
 988                     '(?:(?:' . implode('|', common_url_schemes(_URL_SCHEME_SINGLE_COLON)) . '):)'.
 989                 ')'.
 990                 '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
 991                 '(?:'.
 992                     '(?:'.
 993                         '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
 994                     ')|(?:'.
 995                         '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
 996                     ')'.
 997                 ')'.
 998             ')'.
 999             '|(?:'.
1000                 '(?:' . implode('|', common_url_schemes(_URL_SCHEME_COLON_COORDINATES)) . '):'.
1001                 // There's an order that must be followed here too, if ;crs= is used, it must precede ;u=
1002                 // Also 'crsp' (;crs=$crsp) must match $geouri_labeltext_regex
1003                 // Also 'uval' (;u=$uval) must be a pnum: \-?[0-9]+
1004                 '(?:'.
1005                     '(?:[0-9]+(?:\.[0-9]+)?(?:\,[0-9]+(?:\.[0-9]+)?){1,2})'.    // 1(.23)?(,4(.56)){1,2}
1006                     '(?:\;(?:['.$geouri_labeltext_regex.']+)(?:\=['.$geouri_paramchar_regex.']+)*)*'.
1007                 ')'.
1008             ')'.
1009             // URLs without domain name, like magnet:?xt=...
1010             '|(?:(?:' . implode('|', common_url_schemes(_URL_SCHEME_NO_DOMAIN)) . '):(?=\?))'.  // zero-length lookahead requires ? after :
1011             (common_config('linkify', 'bare_ipv4')   // Convert IPv4 addresses to hyperlinks
1012                 ? '|(?:(?: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]?)'
1013                 : '').
1014             (common_config('linkify', 'bare_ipv6')   // Convert IPv6 addresses to hyperlinks
1015                 ? '|(?:'. //IPv6
1016                     '\[?(?:(?:(?:[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})))\]?(?<!:)'.
1017                     ')'
1018                 : '').
1019             (common_config('linkify', 'bare_domains')
1020                 ? '|(?:'. //DNS
1021                     '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
1022                     '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
1023                     //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
1024                     '(?: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)'.
1025             ')(?![\pN\pL\-\_])'
1026                 : '') . // if common_config('linkify', 'bare_domains') is false, don't add anything here
1027         ')'.
1028         '(?:'.
1029             '(?:\:\d+)?'. //:port
1030             '(?:/['  . URL_REGEX_VALID_PATH_CHARS    . ']*)?'.  // path
1031             '(?:\?[' . URL_REGEX_VALID_QSTRING_CHARS . ']*)?'.  // ?query string
1032             '(?:\#[' . URL_REGEX_VALID_FRAGMENT_CHARS . ']*)?'. // #fragment
1033         ')(?<!['. URL_REGEX_EXCLUDED_END_CHARS .'])'.
1034     ')'.
1035     '#ixu';
1036     //preg_match_all($regex,$text,$matches);
1037     //print_r($matches);
1038     return preg_replace_callback($regex, curry('callback_helper',$callback,$arg) ,$text);
1039 }
1040
1041 /**
1042  * Intermediate callback for common_replace_links(), helps resolve some
1043  * ambiguous link forms before passing on to the final callback.
1044  *
1045  * @param array $matches
1046  * @param callable $callback
1047  * @param mixed $arg optional argument to pass on as second param to callback
1048  * @return string
1049  *
1050  * @access private
1051  */
1052 function callback_helper($matches, $callback, $arg=null) {
1053     $url=$matches[1];
1054     $left = strpos($matches[0],$url);
1055     $right = $left+strlen($url);
1056
1057     $groupSymbolSets=array(
1058         array(
1059             'left'=>'(',
1060             'right'=>')'
1061         ),
1062         array(
1063             'left'=>'[',
1064             'right'=>']'
1065         ),
1066         array(
1067             'left'=>'{',
1068             'right'=>'}'
1069         ),
1070         array(
1071             'left'=>'<',
1072             'right'=>'>'
1073         )
1074     );
1075     $cannotEndWith=array('.','?',',','#');
1076     $original_url=$url;
1077     do{
1078         $original_url=$url;
1079         foreach($groupSymbolSets as $groupSymbolSet){
1080             if(substr($url,-1)==$groupSymbolSet['right']){
1081                 $group_left_count = substr_count($url,$groupSymbolSet['left']);
1082                 $group_right_count = substr_count($url,$groupSymbolSet['right']);
1083                 if($group_left_count<$group_right_count){
1084                     $right-=1;
1085                     $url=substr($url,0,-1);
1086                 }
1087             }
1088         }
1089         if(in_array(substr($url,-1),$cannotEndWith)){
1090             $right-=1;
1091             $url=substr($url,0,-1);
1092         }
1093     }while($original_url!=$url);
1094
1095     $result = call_user_func_array($callback, array($url, $arg));
1096     return substr($matches[0],0,$left) . $result . substr($matches[0],$right);
1097 }
1098
1099 require_once INSTALLDIR . "/lib/curry.php";
1100
1101 function common_linkify($url) {
1102     // It comes in special'd, so we unspecial it before passing to the stringifying
1103     // functions
1104     $url = htmlspecialchars_decode($url);
1105
1106     if (strpos($url, '@') !== false && strpos($url, ':') === false && Validate::email($url)) {
1107         //url is an email address without the mailto: protocol
1108         $canon = "mailto:$url";
1109         $longurl = "mailto:$url";
1110     } else {
1111         $canon = File_redirection::_canonUrl($url);
1112         $longurl_data = File_redirection::where($canon, common_config('attachments', 'process_links'));
1113
1114         if(isset($longurl_data->redir_url)) {
1115                         $longurl = $longurl_data->redir_url;
1116         } else {
1117             // e.g. local files
1118                 $longurl = $longurl_data->url;
1119         }
1120     }
1121
1122     $attrs = array('href' => $longurl, 'title' => $longurl);
1123
1124     $is_attachment = false;
1125     $attachment_id = null;
1126     $has_thumb = false;
1127
1128     // Check to see whether this is a known "attachment" URL.
1129
1130     try {
1131         $f = File::getByUrl($longurl);
1132     } catch (NoResultException $e) {
1133         if (common_config('attachments', 'process_links')) {
1134             // XXX: this writes to the database. :<
1135             try {
1136                 $f = File::processNew($longurl);
1137             } catch (ServerException $e) {
1138                 $f = null;
1139             }
1140         }
1141     }
1142
1143     if ($f instanceof File) {
1144         try {
1145             $enclosure = $f->getEnclosure();
1146             $is_attachment = true;
1147             $attachment_id = $f->id;
1148
1149             $thumb = File_thumbnail::getKV('file_id', $f->id);
1150             $has_thumb = ($thumb instanceof File_thumbnail);
1151         } catch (ServerException $e) {
1152             // There was not enough metadata available
1153         }
1154     }
1155
1156     // Whether to nofollow
1157     $nf = common_config('nofollow', 'external');
1158
1159     if ($nf == 'never') {
1160         $attrs['rel'] = 'external';
1161     } else {
1162         $attrs['rel'] = 'nofollow external';
1163     }
1164
1165     // Add clippy
1166     if ($is_attachment) {
1167         $attrs['class'] = 'attachment';
1168         if ($has_thumb) {
1169             $attrs['class'] = 'attachment thumbnail';
1170         }
1171         $attrs['id'] = "attachment-{$attachment_id}";
1172         $attrs['rel'] .= ' noreferrer';
1173     }
1174
1175     return XMLStringer::estring('a', $attrs, $url);
1176 }
1177
1178 /**
1179  * Find and shorten links in a given chunk of text if it's longer than the
1180  * configured notice content limit (or unconditionally).
1181  *
1182  * Side effects: may save file and file_redirection records for referenced URLs.
1183  *
1184  * Pass the $user option or call $user->shortenLinks($text) to ensure the proper
1185  * user's options are used; otherwise the current web session user's setitngs
1186  * will be used or ur1.ca if there is no active web login.
1187  *
1188  * @param string $text
1189  * @param boolean $always (optional)
1190  * @param User $user (optional)
1191  *
1192  * @return string
1193  */
1194 function common_shorten_links($text, $always = false, User $user=null)
1195 {
1196     if ($user === null) {
1197         $user = common_current_user();
1198     }
1199
1200     $maxLength = User_urlshortener_prefs::maxNoticeLength($user);
1201
1202     if ($always || ($maxLength != -1 && mb_strlen($text) > $maxLength)) {
1203         return common_replace_urls_callback($text, array('File_redirection', 'forceShort'), $user);
1204     } else {
1205         return common_replace_urls_callback($text, array('File_redirection', 'makeShort'), $user);
1206     }
1207 }
1208
1209 /**
1210  * Very basic stripping of invalid UTF-8 input text.
1211  *
1212  * @param string $str
1213  * @return mixed string or null if invalid input
1214  *
1215  * @todo ideally we should drop bad chars, and maybe do some of the checks
1216  *       from common_xml_safe_str. But we can't strip newlines, etc.
1217  * @todo Unicode normalization might also be useful, but not needed now.
1218  */
1219 function common_validate_utf8($str)
1220 {
1221     // preg_replace will return NULL on invalid UTF-8 input.
1222     //
1223     // Note: empty regex //u also caused NULL return on some
1224     // production machines, but none of our test machines.
1225     //
1226     // This should be replaced with a more reliable check.
1227     return preg_replace('/\x00/u', '', $str);
1228 }
1229
1230 /**
1231  * Make sure an arbitrary string is safe for output in XML as a single line.
1232  *
1233  * @param string $str
1234  * @return string
1235  */
1236 function common_xml_safe_str($str)
1237 {
1238     // Replace common eol and extra whitespace input chars
1239     $unWelcome = array(
1240         "\t",  // tab
1241         "\n",  // newline
1242         "\r",  // cr
1243         "\0",  // null byte eos
1244         "\x0B" // vertical tab
1245     );
1246
1247     $replacement = array(
1248         ' ', // single space
1249         ' ',
1250         '',  // nothing
1251         '',
1252         ' '
1253     );
1254
1255     $str = str_replace($unWelcome, $replacement, $str);
1256
1257     // Neutralize any additional control codes and UTF-16 surrogates
1258     // (Twitter uses '*')
1259     return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
1260 }
1261
1262 function common_slugify($str)
1263 {
1264     // php5-intl is highly recommended...
1265     if (!function_exists('transliterator_transliterate')) {
1266         $str = preg_replace('/[^\pL\pN]/u', '', $str);
1267         $str = mb_convert_case($str, MB_CASE_LOWER, 'UTF-8');
1268         $str = substr($str, 0, 64);
1269         return $str;
1270     }
1271     $str = transliterator_transliterate(
1272                         'Any-Latin;' .      // any charset to latin compatible
1273                             'NFD;' .        // decompose
1274                             '[:Nonspacing Mark:] Remove;' . // remove nonspacing marks (accents etc.)
1275                             'NFC;' .        // composite again
1276                             '[:Punctuation:] Remove;' . // remove punctuation (.,¿? etc.)
1277                             'Lower();' .    // turn into lowercase
1278                             'Latin-ASCII;',  // get ASCII equivalents (ð to d for example)
1279                         $str);
1280     return preg_replace('/[^\pL\pN]/', '', $str);
1281 }
1282
1283 function common_tag_link($tag)
1284 {
1285     $canonical = common_canonical_tag($tag);
1286     if (common_config('singleuser', 'enabled')) {
1287         // regular TagAction isn't set up in 1user mode
1288         $nickname = User::singleUserNickname();
1289         $url = common_local_url('showstream',
1290                                 array('nickname' => $nickname,
1291                                       'tag' => $canonical));
1292     } else {
1293         $url = common_local_url('tag', array('tag' => $canonical));
1294     }
1295     $xs = new XMLStringer();
1296     $xs->elementStart('span', 'tag');
1297     $xs->element('a', array('href' => $url,
1298                             'rel' => 'tag'),
1299                  $tag);
1300     $xs->elementEnd('span');
1301     return $xs->getString();
1302 }
1303
1304 function common_canonical_tag($tag)
1305 {
1306     $tag = common_slugify($tag);
1307     $tag = substr($tag, 0, 64);
1308     return $tag;
1309 }
1310
1311 function common_valid_profile_tag($str)
1312 {
1313     return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
1314 }
1315
1316 /**
1317  * Resolve an ambiguous profile nickname reference, checking in following order:
1318  * - profiles that $sender subscribes to
1319  * - profiles that subscribe to $sender
1320  * - local user profiles
1321  *
1322  * WARNING: does not validate or normalize $nickname -- MUST BE PRE-VALIDATED
1323  * OR THERE MAY BE A RISK OF SQL INJECTION ATTACKS. THIS FUNCTION DOES NOT
1324  * ESCAPE SQL.
1325  *
1326  * @fixme validate input
1327  * @fixme escape SQL
1328  * @fixme fix or remove mystery third parameter
1329  * @fixme is $sender a User or Profile?
1330  *
1331  * @param <type> $sender the user or profile in whose context we're looking
1332  * @param string $nickname validated nickname of
1333  * @param <type> $dt unused mystery parameter; in Notice reply-to handling a timestamp is passed.
1334  *
1335  * @return Profile or null
1336  */
1337 function common_relative_profile($sender, $nickname, $dt=null)
1338 {
1339     // Will throw exception on invalid input.
1340     $nickname = Nickname::normalize($nickname);
1341
1342     // Try to find profiles this profile is subscribed to that have this nickname
1343     $recipient = new Profile();
1344     // XXX: use a join instead of a subquery
1345     $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.intval($sender->id).' and subscribed = id)', 'AND');
1346     $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1347     if ($recipient->find(true)) {
1348         // XXX: should probably differentiate between profiles with
1349         // the same name by date of most recent update
1350         return $recipient;
1351     }
1352     // Try to find profiles that listen to this profile and that have this nickname
1353     $recipient = new Profile();
1354     // XXX: use a join instead of a subquery
1355     $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.intval($sender->id).' and subscriber = id)', 'AND');
1356     $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1357     if ($recipient->find(true)) {
1358         // XXX: should probably differentiate between profiles with
1359         // the same name by date of most recent update
1360         return $recipient;
1361     }
1362     // If this is a local user, try to find a local user with that nickname.
1363     $sender = User::getKV('id', $sender->id);
1364     if ($sender instanceof User) {
1365         $recipient_user = User::getKV('nickname', $nickname);
1366         if ($recipient_user instanceof User) {
1367             return $recipient_user->getProfile();
1368         }
1369     }
1370     // Otherwise, no links. @messages from local users to remote users,
1371     // or from remote users to other remote users, are just
1372     // outside our ability to make intelligent guesses about
1373     return null;
1374 }
1375
1376 function common_local_url($action, $args=null, $params=null, $fragment=null, $addSession=true)
1377 {
1378     if (Event::handle('StartLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url))) {
1379         $r = Router::get();
1380         $path = $r->build($action, $args, $params, $fragment);
1381
1382         $ssl = GNUsocial::useHTTPS();
1383
1384         if (common_config('site','fancy')) {
1385             $url = common_path($path, $ssl, $addSession);
1386         } else {
1387             if (mb_strpos($path, '/index.php') === 0) {
1388                 $url = common_path($path, $ssl, $addSession);
1389             } else {
1390                 $url = common_path('index.php/'.$path, $ssl, $addSession);
1391             }
1392         }
1393         Event::handle('EndLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url));
1394     }
1395     return $url;
1396 }
1397
1398 function common_path($relative, $ssl=false, $addSession=true)
1399 {
1400     $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
1401
1402     if ($ssl && GNUsocial::useHTTPS()) {
1403         $proto = 'https';
1404         if (is_string(common_config('site', 'sslserver')) &&
1405             mb_strlen(common_config('site', 'sslserver')) > 0) {
1406             $serverpart = common_config('site', 'sslserver');
1407         } else if (common_config('site', 'server')) {
1408             $serverpart = common_config('site', 'server');
1409         } else {
1410             common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1411         }
1412     } else {
1413         $proto = 'http';
1414         if (common_config('site', 'server')) {
1415             $serverpart = common_config('site', 'server');
1416         } else {
1417             common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1418         }
1419     }
1420
1421     if ($addSession) {
1422         $relative = common_inject_session($relative, $serverpart);
1423     }
1424
1425     return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
1426 }
1427
1428 // FIXME: Maybe this should also be able to handle non-fancy URLs with index.php?p=...
1429 function common_fake_local_fancy_url($url)
1430 {
1431     /**
1432      * This is a hacky fix to make URIs generated with "index.php/" match against
1433      * locally stored URIs without that. So for example if the remote site is looking
1434      * up the webfinger for some user and for some reason knows about https://some.example/user/1
1435      * but we locally store and report only https://some.example/index.php/user/1 then they would
1436      * dismiss the profile for not having an identified alias.
1437      *
1438      * There are various live instances where these issues occur, for various reasons.
1439      * Most of them being users fiddling with configuration while already having
1440      * started federating (distributing the URI to other servers) or maybe manually
1441      * editing the local database.
1442      */
1443     if (!preg_match(
1444                 // [1] protocol part, we can only rewrite http/https anyway.
1445                 '/^(https?:\/\/)' .
1446                 // [2] site name.
1447                 // FIXME: Dunno how this acts if we're aliasing ourselves with a .onion domain etc.
1448                 '('.preg_quote(common_config('site', 'server'), '/').')' .
1449                 // [3] site path, or if that is empty just '/' (to retain the /)
1450                 '('.preg_quote(common_config('site', 'path') ?: '/', '/').')' .
1451                 // [4] + [5] extract index.php (+ possible leading double /) and the rest of the URL separately.
1452                 '(\/?index\.php\/)(.*)$/', $url, $matches)) {
1453         // if preg_match failed to match
1454         throw new Exception('No known change could be made to the URL.');
1455     }
1456
1457     // now reconstruct the URL with everything except the "index.php/" part
1458     $fancy_url = '';
1459     foreach ([1,2,3,5] as $idx) {
1460         $fancy_url .= $matches[$idx];
1461     }
1462     return $fancy_url;
1463 }
1464
1465 // FIXME: Maybe this should also be able to handle non-fancy URLs with index.php?p=...
1466 function common_fake_local_nonfancy_url($url)
1467 {
1468     /**
1469      * This is a hacky fix to make URIs NOT generated with "index.php/" match against
1470      * locally stored URIs WITH that. The reverse from the above.
1471      *
1472      * It will also "repair" index.php URLs with multiple / prepended. Like https://some.example///index.php/user/1
1473      */
1474     if (!preg_match(
1475                 // [1] protocol part, we can only rewrite http/https anyway.
1476                 '/^(https?:\/\/)' .
1477                 // [2] site name.
1478                 // FIXME: Dunno how this acts if we're aliasing ourselves with a .onion domain etc.
1479                 '('.preg_quote(common_config('site', 'server'), '/').')' .
1480                 // [3] site path, or if that is empty just '/' (to retain the /)
1481                 '('.preg_quote(common_config('site', 'path') ?: '/', '/').')' .
1482                 // [4] should be empty (might contain one or more / and then maybe also index.php). Will be overwritten.
1483                 // [5] will have the extracted actual URL part (besides site path)
1484                 '((?!index.php\/)\/*(?:index.php\/)?)(.*)$/', $url, $matches)) {
1485         // if preg_match failed to match
1486         throw new Exception('No known change could be made to the URL.');
1487     }
1488
1489     $matches[4] = 'index.php/'; // inject the index.php/ rewritethingy
1490
1491     // remove the first element, which is the full matching string
1492     array_shift($matches);
1493     return implode($matches);
1494 }
1495
1496 function common_inject_session($url, $serverpart = null)
1497 {
1498     if (!common_have_session()) {
1499         return $url;
1500     }
1501
1502     if (empty($serverpart)) {
1503         $serverpart = parse_url($url, PHP_URL_HOST);
1504     }
1505
1506     $currentServer = (array_key_exists('HTTP_HOST', $_SERVER)) ? $_SERVER['HTTP_HOST'] : null;
1507
1508     // Are we pointing to another server (like an SSL server?)
1509
1510     if (!empty($currentServer) && 0 != strcasecmp($currentServer, $serverpart)) {
1511         // Pass the session ID as a GET parameter
1512         $sesspart = session_name() . '=' . session_id();
1513         $i = strpos($url, '?');
1514         if ($i === false) { // no GET params, just append
1515             $url .= '?' . $sesspart;
1516         } else {
1517             $url = substr($url, 0, $i + 1).$sesspart.'&'.substr($url, $i + 1);
1518         }
1519     }
1520
1521     return $url;
1522 }
1523
1524 function common_date_string($dt)
1525 {
1526     // XXX: do some sexy date formatting
1527     // return date(DATE_RFC822, $dt);
1528     $t = strtotime($dt);
1529     $now = time();
1530     $diff = $now - $t;
1531
1532     if ($now < $t) { // that shouldn't happen!
1533         return common_exact_date($dt);
1534     } else if ($diff < 60) {
1535         // TRANS: Used in notices to indicate when the notice was made compared to now.
1536         return _('a few seconds ago');
1537     } else if ($diff < 92) {
1538         // TRANS: Used in notices to indicate when the notice was made compared to now.
1539         return _('about a minute ago');
1540     } else if ($diff < 3300) {
1541         $minutes = round($diff/60);
1542         // TRANS: Used in notices to indicate when the notice was made compared to now.
1543         return sprintf( _m('about one minute ago', 'about %d minutes ago', $minutes), $minutes);
1544     } else if ($diff < 5400) {
1545         // TRANS: Used in notices to indicate when the notice was made compared to now.
1546         return _('about an hour ago');
1547     } else if ($diff < 22 * 3600) {
1548         $hours = round($diff/3600);
1549         // TRANS: Used in notices to indicate when the notice was made compared to now.
1550         return sprintf( _m('about one hour ago', 'about %d hours ago', $hours), $hours);
1551     } else if ($diff < 37 * 3600) {
1552         // TRANS: Used in notices to indicate when the notice was made compared to now.
1553         return _('about a day ago');
1554     } else if ($diff < 24 * 24 * 3600) {
1555         $days = round($diff/(24*3600));
1556         // TRANS: Used in notices to indicate when the notice was made compared to now.
1557         return sprintf( _m('about one day ago', 'about %d days ago', $days), $days);
1558     } else if ($diff < 46 * 24 * 3600) {
1559         // TRANS: Used in notices to indicate when the notice was made compared to now.
1560         return _('about a month ago');
1561     } else if ($diff < 330 * 24 * 3600) {
1562         $months = round($diff/(30*24*3600));
1563         // TRANS: Used in notices to indicate when the notice was made compared to now.
1564         return sprintf( _m('about one month ago', 'about %d months ago',$months), $months);
1565     } else if ($diff < 480 * 24 * 3600) {
1566         // TRANS: Used in notices to indicate when the notice was made compared to now.
1567         return _('about a year ago');
1568     } else {
1569         return common_exact_date($dt);
1570     }
1571 }
1572
1573 function common_exact_date($dt)
1574 {
1575     static $_utc;
1576     static $_siteTz;
1577
1578     if (!$_utc) {
1579         $_utc = new DateTimeZone('UTC');
1580         $_siteTz = new DateTimeZone(common_timezone());
1581     }
1582
1583     $dateStr = date('d F Y H:i:s', strtotime($dt));
1584     $d = new DateTime($dateStr, $_utc);
1585     $d->setTimezone($_siteTz);
1586     // TRANS: Human-readable full date-time specification (formatting on http://php.net/date)
1587     return $d->format(_('l, d-M-Y H:i:s T'));
1588 }
1589
1590 function common_date_w3dtf($dt)
1591 {
1592     $dateStr = date('d F Y H:i:s', strtotime($dt));
1593     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1594     $d->setTimezone(new DateTimeZone(common_timezone()));
1595     return $d->format(DATE_W3C);
1596 }
1597
1598 function common_date_rfc2822($dt)
1599 {
1600     $dateStr = date('d F Y H:i:s', strtotime($dt));
1601     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1602     $d->setTimezone(new DateTimeZone(common_timezone()));
1603     return $d->format('r');
1604 }
1605
1606 function common_date_iso8601($dt)
1607 {
1608     $dateStr = date('d F Y H:i:s', strtotime($dt));
1609     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1610     $d->setTimezone(new DateTimeZone(common_timezone()));
1611     return $d->format('c');
1612 }
1613
1614 function common_sql_now()
1615 {
1616     return common_sql_date(time());
1617 }
1618
1619 function common_sql_date($datetime)
1620 {
1621     return strftime('%Y-%m-%d %H:%M:%S', $datetime);
1622 }
1623
1624 /**
1625  * Return an SQL fragment to calculate an age-based weight from a given
1626  * timestamp or datetime column.
1627  *
1628  * @param string $column name of field we're comparing against current time
1629  * @param integer $dropoff divisor for age in seconds before exponentiation
1630  * @return string SQL fragment
1631  */
1632 function common_sql_weight($column, $dropoff)
1633 {
1634     if (common_config('db', 'type') == 'pgsql') {
1635         // PostgreSQL doesn't support timestampdiff function.
1636         // @fixme will this use the right time zone?
1637         // @fixme does this handle cross-year subtraction correctly?
1638         return "sum(exp(-extract(epoch from (now() - $column)) / $dropoff))";
1639     } else {
1640         return "sum(exp(timestampdiff(second, utc_timestamp(), $column) / $dropoff))";
1641     }
1642 }
1643
1644 function common_redirect($url, $code=307)
1645 {
1646     static $status = array(301 => "Moved Permanently",
1647                            302 => "Found",
1648                            303 => "See Other",
1649                            307 => "Temporary Redirect");
1650
1651     header('HTTP/1.1 '.$code.' '.$status[$code]);
1652     header("Location: $url");
1653     header("Connection: close");
1654
1655     $xo = new XMLOutputter();
1656     $xo->startXML('a',
1657                   '-//W3C//DTD XHTML 1.0 Strict//EN',
1658                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1659     $xo->element('a', array('href' => $url), $url);
1660     $xo->endXML();
1661     exit;
1662 }
1663
1664 // Stick the notice on the queue
1665
1666 function common_enqueue_notice($notice)
1667 {
1668     static $localTransports = array('ping');
1669
1670     $transports = array();
1671     if (common_config('sms', 'enabled')) {
1672         $transports[] = 'sms';
1673     }
1674     if (Event::hasHandler('HandleQueuedNotice')) {
1675         $transports[] = 'plugin';
1676     }
1677
1678     // We can skip these for gatewayed notices.
1679     if ($notice->isLocal()) {
1680         $transports = array_merge($transports, $localTransports);
1681     }
1682
1683     if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
1684
1685         $qm = QueueManager::get();
1686
1687         foreach ($transports as $transport)
1688         {
1689             $qm->enqueue($notice, $transport);
1690         }
1691
1692         Event::handle('EndEnqueueNotice', array($notice, $transports));
1693     }
1694
1695     return true;
1696 }
1697
1698 function common_profile_url($nickname)
1699 {
1700     return common_local_url('showstream', array('nickname' => $nickname),
1701                             null, null, false);
1702 }
1703
1704 /**
1705  * Should make up a reasonable root URL
1706  *
1707  * @param   bool    $tls    true or false to force TLS scheme, null to use server configuration
1708  */
1709 function common_root_url($tls=null)
1710 {
1711     if (is_null($tls)) {
1712         $tls = GNUsocial::useHTTPS();
1713     }
1714     $url = common_path('', $tls, false);
1715     $i = strpos($url, '?');
1716     if ($i !== false) {
1717         $url = substr($url, 0, $i);
1718     }
1719     return $url;
1720 }
1721
1722 /**
1723  * returns $bytes bytes of raw random data
1724  */
1725 function common_random_rawstr($bytes)
1726 {
1727     $rawstr = @file_exists('/dev/urandom')
1728             ? common_urandom($bytes)
1729             : common_mtrand($bytes);
1730
1731     return $rawstr;
1732 }
1733
1734 /**
1735  * returns $bytes bytes of random data as a hexadecimal string
1736  */
1737 function common_random_hexstr($bytes)
1738 {
1739     $str = common_random_rawstr($bytes);
1740
1741     $hexstr = '';
1742     for ($i = 0; $i < $bytes; $i++) {
1743         $hexstr .= sprintf("%02x", ord($str[$i]));
1744     }
1745     return $hexstr;
1746 }
1747
1748 function common_urandom($bytes)
1749 {
1750     $h = fopen('/dev/urandom', 'rb');
1751     // should not block
1752     $src = fread($h, $bytes);
1753     fclose($h);
1754     return $src;
1755 }
1756
1757 function common_mtrand($bytes)
1758 {
1759     $str = '';
1760     for ($i = 0; $i < $bytes; $i++) {
1761         $str .= chr(mt_rand(0, 255));
1762     }
1763     return $str;
1764 }
1765
1766 /**
1767  * Record the given URL as the return destination for a future
1768  * form submission, to be read by common_get_returnto().
1769  *
1770  * @param string $url
1771  *
1772  * @fixme as a session-global setting, this can allow multiple forms
1773  * to conflict and overwrite each others' returnto destinations if
1774  * the user has multiple tabs or windows open.
1775  *
1776  * Should refactor to index with a token or otherwise only pass the
1777  * data along its intended path.
1778  */
1779 function common_set_returnto($url)
1780 {
1781     common_ensure_session();
1782     $_SESSION['returnto'] = $url;
1783 }
1784
1785 /**
1786  * Fetch a return-destination URL previously recorded by
1787  * common_set_returnto().
1788  *
1789  * @return mixed URL string or null
1790  *
1791  * @fixme as a session-global setting, this can allow multiple forms
1792  * to conflict and overwrite each others' returnto destinations if
1793  * the user has multiple tabs or windows open.
1794  *
1795  * Should refactor to index with a token or otherwise only pass the
1796  * data along its intended path.
1797  */
1798 function common_get_returnto()
1799 {
1800     common_ensure_session();
1801     return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
1802 }
1803
1804 function common_timestamp()
1805 {
1806     return date('YmdHis');
1807 }
1808
1809 function common_ensure_syslog()
1810 {
1811     static $initialized = false;
1812     if (!$initialized) {
1813         openlog(common_config('syslog', 'appname'), 0,
1814             common_config('syslog', 'facility'));
1815         $initialized = true;
1816     }
1817 }
1818
1819 function common_log_line($priority, $msg)
1820 {
1821     static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1822                                       'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1823     return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . PHP_EOL;
1824 }
1825
1826 function common_request_id()
1827 {
1828     $pid = getmypid();
1829     $server = common_config('site', 'server');
1830     if (php_sapi_name() == 'cli') {
1831         $script = basename($_SERVER['PHP_SELF']);
1832         return "$server:$script:$pid";
1833     } else {
1834         static $req_id = null;
1835         if (!isset($req_id)) {
1836             $req_id = substr(md5(mt_rand()), 0, 8);
1837         }
1838         if (isset($_SERVER['REQUEST_URI'])) {
1839             $url = $_SERVER['REQUEST_URI'];
1840         }
1841         $method = $_SERVER['REQUEST_METHOD'];
1842         return "$server:$pid.$req_id $method $url";
1843     }
1844 }
1845
1846 function common_log($priority, $msg, $filename=null)
1847 {
1848     if(Event::handle('StartLog', array(&$priority, &$msg, &$filename))){
1849         $msg = (empty($filename)) ? $msg : basename($filename) . ' - ' . $msg;
1850         $msg = '[' . common_request_id() . '] ' . $msg;
1851         $logfile = common_config('site', 'logfile');
1852         if ($logfile) {
1853             $log = fopen($logfile, "a");
1854             if ($log) {
1855                 $output = common_log_line($priority, $msg);
1856                 fwrite($log, $output);
1857                 fclose($log);
1858             }
1859         } else {
1860             common_ensure_syslog();
1861             syslog($priority, $msg);
1862         }
1863         Event::handle('EndLog', array($priority, $msg, $filename));
1864     }
1865 }
1866
1867 function common_debug($msg, $filename=null)
1868 {
1869     if ($filename) {
1870         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1871     } else {
1872         common_log(LOG_DEBUG, $msg);
1873     }
1874 }
1875
1876 function common_log_db_error(&$object, $verb, $filename=null)
1877 {
1878     global $_PEAR;
1879
1880     $objstr = common_log_objstring($object);
1881     $last_error = &$_PEAR->getStaticProperty('DB_DataObject','lastError');
1882     if (is_object($last_error)) {
1883         $msg = $last_error->message;
1884     } else {
1885         $msg = 'Unknown error (' . var_export($last_error, true) . ')';
1886     }
1887     common_log(LOG_ERR, $msg . '(' . $verb . ' on ' . $objstr . ')', $filename);
1888 }
1889
1890 function common_log_objstring(&$object)
1891 {
1892     if (is_null($object)) {
1893         return "null";
1894     }
1895     if (!($object instanceof DB_DataObject)) {
1896         return "(unknown)";
1897     }
1898     $arr = $object->toArray();
1899     $fields = array();
1900     foreach ($arr as $k => $v) {
1901         if (is_object($v)) {
1902             $fields[] = "$k='".get_class($v)."'";
1903         } else {
1904             $fields[] = "$k='$v'";
1905         }
1906     }
1907     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1908     return $objstring;
1909 }
1910
1911 function common_valid_http_url($url, $secure=false)
1912 {
1913     if (empty($url)) {
1914         return false;
1915     }
1916
1917     // If $secure is true, only allow https URLs to pass
1918     // (if false, we use '?' in 'https?' to say the 's' is optional)
1919     $regex = $secure ? '/^https$/' : '/^https?$/';
1920     return filter_var($url, FILTER_VALIDATE_URL)
1921             && preg_match($regex, parse_url($url, PHP_URL_SCHEME));
1922 }
1923
1924 function common_valid_tag($tag)
1925 {
1926     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1927         return (Validate::email($matches[1]) ||
1928                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1929     }
1930     return false;
1931 }
1932
1933 /**
1934  * Determine if given domain or address literal is valid
1935  * eg for use in JIDs and URLs. Does not check if the domain
1936  * exists!
1937  *
1938  * @param string $domain
1939  * @return boolean valid or not
1940  */
1941 function common_valid_domain($domain)
1942 {
1943     $octet = "(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])";
1944     $ipv4 = "(?:$octet(?:\.$octet){3})";
1945     if (preg_match("/^$ipv4$/u", $domain)) return true;
1946
1947     $group = "(?:[0-9a-f]{1,4})";
1948     $ipv6 = "(?:\[($group(?::$group){0,7})?(::)?($group(?::$group){0,7})?\])"; // http://tools.ietf.org/html/rfc3513#section-2.2
1949
1950     if (preg_match("/^$ipv6$/ui", $domain, $matches)) {
1951         $before = explode(":", $matches[1]);
1952         $zeroes = $matches[2];
1953         $after = explode(":", $matches[3]);
1954         if ($zeroes) {
1955             $min = 0;
1956             $max = 7;
1957         } else {
1958             $min = 1;
1959             $max = 8;
1960         }
1961         $explicit = count($before) + count($after);
1962         if ($explicit < $min || $explicit > $max) {
1963             return false;
1964         }
1965         return true;
1966     }
1967
1968     try {
1969         require_once "Net/IDNA.php";
1970         $idn = Net_IDNA::getInstance();
1971         $domain = $idn->encode($domain);
1972     } catch (Exception $e) {
1973         return false;
1974     }
1975
1976     $subdomain = "(?:[a-z0-9][a-z0-9-]*)"; // @fixme
1977     $fqdn = "(?:$subdomain(?:\.$subdomain)*\.?)";
1978
1979     return preg_match("/^$fqdn$/ui", $domain);
1980 }
1981
1982 /* Following functions are copied from MediaWiki GlobalFunctions.php
1983  * and written by Evan Prodromou. */
1984
1985 function common_accept_to_prefs($accept, $def = '*/*')
1986 {
1987     // No arg means accept anything (per HTTP spec)
1988     if(!$accept) {
1989         return array($def => 1);
1990     }
1991
1992     $prefs = array();
1993
1994     $parts = explode(',', $accept);
1995
1996     foreach($parts as $part) {
1997         // FIXME: doesn't deal with params like 'text/html; level=1'
1998         @list($value, $qpart) = explode(';', trim($part));
1999         $match = array();
2000         if(!isset($qpart)) {
2001             $prefs[$value] = 1;
2002         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
2003             $prefs[$value] = $match[1];
2004         }
2005     }
2006
2007     return $prefs;
2008 }
2009
2010 // Match by our supported file extensions
2011 function common_supported_filename_to_mime($filename)
2012 {
2013     // Accept a filename and take out the extension
2014     if (strpos($filename, '.') === false) {
2015         throw new ServerException(sprintf('No extension on filename: %1$s', _ve($filename)));
2016     }
2017
2018     $fileext = substr(strrchr($filename, '.'), 1);
2019     return common_supported_ext_to_mime($fileext);
2020 }
2021
2022 function common_supported_ext_to_mime($fileext)
2023 {
2024     $supported = common_config('attachments', 'supported');
2025     if ($supported === true) {
2026         // FIXME: Should we just accept the extension straight off when supported === true?
2027         throw new UnknownExtensionMimeException($fileext);
2028     }
2029     foreach($supported as $type => $ext) {
2030         if ($ext === $fileext) {
2031             return $type;
2032         }
2033     }
2034
2035     throw new ServerException('Unsupported file extension');
2036 }
2037
2038 // Match by our supported mime types
2039 function common_supported_mime_to_ext($mimetype)
2040 {
2041     $supported = common_config('attachments', 'supported');
2042     if (is_array($supported)) {
2043         foreach($supported as $type => $ext) {
2044             if ($mimetype === $type) {
2045                 return $ext;
2046             }
2047         }
2048     }
2049
2050     throw new UnknownMimeExtensionException($mimetype);
2051 }
2052
2053 // The MIME "media" is the part before the slash (video in video/webm)
2054 function common_get_mime_media($type)
2055 {
2056     $tmp = explode('/', $type);
2057     return strtolower($tmp[0]);
2058 }
2059
2060 // Get only the mimetype and not additional info (separated from bare mime with semi-colon)
2061 function common_bare_mime($mimetype)
2062 {
2063     $mimetype = mb_strtolower($mimetype);
2064     if ($semicolon = mb_strpos($mimetype, ';')) {
2065         $mimetype = mb_substr($mimetype, 0, $semicolon);
2066     }
2067     return trim($mimetype);
2068 }
2069
2070 function common_mime_type_match($type, $avail)
2071 {
2072     if(array_key_exists($type, $avail)) {
2073         return $type;
2074     } else {
2075         $parts = explode('/', $type);
2076         if(array_key_exists($parts[0] . '/*', $avail)) {
2077             return $parts[0] . '/*';
2078         } elseif(array_key_exists('*/*', $avail)) {
2079             return '*/*';
2080         } else {
2081             return null;
2082         }
2083     }
2084 }
2085
2086 function common_negotiate_type($cprefs, $sprefs)
2087 {
2088     $combine = array();
2089
2090     foreach(array_keys($sprefs) as $type) {
2091         $parts = explode('/', $type);
2092         if($parts[1] != '*') {
2093             $ckey = common_mime_type_match($type, $cprefs);
2094             if($ckey) {
2095                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2096             }
2097         }
2098     }
2099
2100     foreach(array_keys($cprefs) as $type) {
2101         $parts = explode('/', $type);
2102         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
2103             $skey = common_mime_type_match($type, $sprefs);
2104             if($skey) {
2105                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2106             }
2107         }
2108     }
2109
2110     $bestq = 0;
2111     $besttype = 'text/html';
2112
2113     foreach(array_keys($combine) as $type) {
2114         if($combine[$type] > $bestq) {
2115             $besttype = $type;
2116             $bestq = $combine[$type];
2117         }
2118     }
2119
2120     if ('text/html' === $besttype) {
2121         return "text/html; charset=utf-8";
2122     }
2123     return $besttype;
2124 }
2125
2126 function common_config($main, $sub=null)
2127 {
2128     global $config;
2129     if (is_null($sub)) {
2130         // Return the config category array
2131         return array_key_exists($main, $config) ? $config[$main] : array();
2132     }
2133     // Return the config value
2134     return (array_key_exists($main, $config) &&
2135             array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
2136 }
2137
2138 function common_config_set($main, $sub, $value)
2139 {
2140     global $config;
2141     if (!array_key_exists($main, $config)) {
2142         $config[$main] = array();
2143     }
2144     $config[$main][$sub] = $value;
2145 }
2146
2147 function common_config_append($main, $sub, $value)
2148 {
2149     global $config;
2150     if (!array_key_exists($main, $config)) {
2151         $config[$main] = array();
2152     }
2153     if (!array_key_exists($sub, $config[$main])) {
2154         $config[$main][$sub] = array();
2155     }
2156     if (!is_array($config[$main][$sub])) {
2157         $config[$main][$sub] = array($config[$main][$sub]);
2158     }
2159     array_push($config[$main][$sub], $value);
2160 }
2161
2162 /**
2163  * Pull arguments from a GET/POST/REQUEST array with first-level input checks:
2164  * strips "magic quotes" slashes if necessary, and kills invalid UTF-8 strings.
2165  *
2166  * @param array $from
2167  * @return array
2168  */
2169 function common_copy_args($from)
2170 {
2171     $to = array();
2172     $strip = get_magic_quotes_gpc();
2173     foreach ($from as $k => $v) {
2174         if(is_array($v)) {
2175             $to[$k] = common_copy_args($v);
2176         } else {
2177             if ($strip) {
2178                 $v = stripslashes($v);
2179             }
2180             $to[$k] = strval(common_validate_utf8($v));
2181         }
2182     }
2183     return $to;
2184 }
2185
2186 /**
2187  * Neutralise the evil effects of magic_quotes_gpc in the current request.
2188  * This is used before handing a request off to OAuthRequest::from_request.
2189  * @fixme Doesn't consider vars other than _POST and _GET?
2190  * @fixme Can't be undone and could corrupt data if run twice.
2191  */
2192 function common_remove_magic_from_request()
2193 {
2194     if(get_magic_quotes_gpc()) {
2195         $_POST=array_map('stripslashes',$_POST);
2196         $_GET=array_map('stripslashes',$_GET);
2197     }
2198 }
2199
2200 function common_user_uri(&$user)
2201 {
2202     return common_local_url('userbyid', array('id' => $user->id),
2203                             null, null, false);
2204 }
2205
2206 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
2207
2208 function common_confirmation_code($bits)
2209 {
2210     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
2211     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
2212     $chars = ceil($bits/5);
2213     $code = '';
2214     for ($i = 0; $i < $chars; $i++) {
2215         // XXX: convert to string and back
2216         $num = hexdec(common_random_hexstr(1));
2217         // XXX: randomness is too precious to throw away almost
2218         // 40% of the bits we get!
2219         $code .= $codechars[$num%32];
2220     }
2221     return $code;
2222 }
2223
2224 // convert markup to HTML
2225 function common_markup_to_html($c, $args=null)
2226 {
2227     if ($c === null) {
2228         return '';
2229     }
2230
2231     if (is_null($args)) {
2232         $args = array();
2233     }
2234
2235     // XXX: not very efficient
2236
2237     foreach ($args as $name => $value) {
2238         $c = preg_replace('/%%arg.'.$name.'%%/', $value, $c);
2239     }
2240
2241     $c = preg_replace_callback('/%%user.(\w+)%%/', function ($m) { return common_user_property($m[1]); }, $c);
2242     $c = preg_replace_callback('/%%action.(\w+)%%/', function ($m) { return common_local_url($m[1]); }, $c);
2243     $c = preg_replace_callback('/%%doc.(\w+)%%/', function ($m) { return common_local_url('doc', array('title'=>$m[1])); }, $c);
2244     $c = preg_replace_callback('/%%(\w+).(\w+)%%/', function ($m) { return common_config($m[1], $m[2]); }, $c);
2245
2246     return \Michelf\Markdown::defaultTransform($c);
2247 }
2248
2249 function common_user_property($property)
2250 {
2251     $profile = Profile::current();
2252
2253     if (empty($profile)) {
2254         return null;
2255     }
2256
2257     switch ($property) {
2258     case 'profileurl':
2259     case 'nickname':
2260     case 'fullname':
2261     case 'location':
2262     case 'bio':
2263         return $profile->$property;
2264         break;
2265     case 'avatar':
2266         try {
2267             return $profile->getAvatar(AVATAR_STREAM_SIZE);
2268         } catch (Exception $e) {
2269             return null;
2270         }
2271         break;
2272     case 'bestname':
2273         return $profile->getBestName();
2274         break;
2275     default:
2276         return null;
2277     }
2278 }
2279
2280 function common_profile_uri($profile)
2281 {
2282     $uri = null;
2283
2284     if (!empty($profile)) {
2285         if (Event::handle('StartCommonProfileURI', array($profile, &$uri))) {
2286             $user = User::getKV('id', $profile->id);
2287             if ($user instanceof User) {
2288                 $uri = $user->getUri();
2289             }
2290             Event::handle('EndCommonProfileURI', array($profile, &$uri));
2291         }
2292     }
2293
2294     // XXX: this is a very bad profile!
2295     return $uri;
2296 }
2297
2298 function common_canonical_sms($sms)
2299 {
2300     // strip non-digits
2301     preg_replace('/\D/', '', $sms);
2302     return $sms;
2303 }
2304
2305 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
2306 {
2307     switch ($errno) {
2308
2309      case E_ERROR:
2310      case E_COMPILE_ERROR:
2311      case E_CORE_ERROR:
2312      case E_USER_ERROR:
2313      case E_PARSE:
2314      case E_RECOVERABLE_ERROR:
2315         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
2316         die();
2317         break;
2318
2319      case E_WARNING:
2320      case E_COMPILE_WARNING:
2321      case E_CORE_WARNING:
2322      case E_USER_WARNING:
2323         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
2324         break;
2325
2326      case E_NOTICE:
2327      case E_USER_NOTICE:
2328         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
2329         break;
2330
2331      case E_STRICT:
2332      case E_DEPRECATED:
2333      case E_USER_DEPRECATED:
2334         // XXX: config variable to log this stuff, too
2335         break;
2336
2337      default:
2338         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
2339         die();
2340         break;
2341     }
2342
2343     // FIXME: show error page if we're on the Web
2344     /* Don't execute PHP internal error handler */
2345     return true;
2346 }
2347
2348 function common_session_token()
2349 {
2350     common_ensure_session();
2351     if (!array_key_exists('token', $_SESSION)) {
2352         $_SESSION['token'] = common_random_hexstr(64);
2353     }
2354     return $_SESSION['token'];
2355 }
2356
2357 function common_license_terms($uri)
2358 {
2359     if(preg_match('/creativecommons.org\/licenses\/([^\/]+)/', $uri, $matches)) {
2360         return explode('-',$matches[1]);
2361     }
2362     return array($uri);
2363 }
2364
2365 function common_compatible_license($from, $to)
2366 {
2367     $from_terms = common_license_terms($from);
2368     // public domain and cc-by are compatible with everything
2369     if(count($from_terms) == 1 && ($from_terms[0] == 'publicdomain' || $from_terms[0] == 'by')) {
2370         return true;
2371     }
2372     $to_terms = common_license_terms($to);
2373     // sa is compatible across versions. IANAL
2374     if(in_array('sa',$from_terms) || in_array('sa',$to_terms)) {
2375         return count(array_diff($from_terms, $to_terms)) == 0;
2376     }
2377     // XXX: better compatibility check needed here!
2378     // Should at least normalise URIs
2379     return ($from == $to);
2380 }
2381
2382 /**
2383  * returns a quoted table name, if required according to config
2384  */
2385 function common_database_tablename($tablename)
2386 {
2387   if(common_config('db','quote_identifiers')) {
2388       $tablename = '"'. $tablename .'"';
2389   }
2390   //table prefixes could be added here later
2391   return $tablename;
2392 }
2393
2394 /**
2395  * Shorten a URL with the current user's configured shortening service,
2396  * or ur1.ca if configured, or not at all if no shortening is set up.
2397  *
2398  * @param string  $long_url original URL
2399  * @param User $user to specify a particular user's options
2400  * @param boolean $force    Force shortening (used when notice is too long)
2401  * @return string may return the original URL if shortening failed
2402  *
2403  * @fixme provide a way to specify a particular shortener
2404  */
2405 function common_shorten_url($long_url, User $user=null, $force = false)
2406 {
2407     $long_url = trim($long_url);
2408
2409     $user = common_current_user();
2410
2411     $maxUrlLength = User_urlshortener_prefs::maxUrlLength($user);
2412
2413     // $force forces shortening even if it's not strictly needed
2414     // I doubt URL shortening is ever 'strictly' needed. - ESP
2415
2416     if (($maxUrlLength == -1 || mb_strlen($long_url) < $maxUrlLength) && !$force) {
2417         return $long_url;
2418     }
2419
2420     $shortenerName = User_urlshortener_prefs::urlShorteningService($user);
2421
2422     if (Event::handle('StartShortenUrl',
2423                       array($long_url, $shortenerName, &$shortenedUrl))) {
2424         if ($shortenerName == 'internal') {
2425             try {
2426                 $f = File::processNew($long_url);
2427                 $shortenedUrl = common_local_url('redirecturl', array('id' => $f->id));
2428                 if ((mb_strlen($shortenedUrl) < mb_strlen($long_url)) || $force) {
2429                     return $shortenedUrl;
2430                 } else {
2431                     return $long_url;
2432                 }
2433             } catch (ServerException $e) {
2434                 return $long_url;
2435             }
2436         } else {
2437             return $long_url;
2438         }
2439     } else {
2440         //URL was shortened, so return the result
2441         return trim($shortenedUrl);
2442     }
2443 }
2444
2445 /**
2446  * @return mixed array($proxy, $ip) for web requests; proxy may be null
2447  *               null if not a web request
2448  *
2449  * @fixme X-Forwarded-For can be chained by multiple proxies;
2450           we should parse the list and provide a cleaner array
2451  * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
2452  * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
2453  *        use function to get exact request headers from Apache if possible.
2454  */
2455 function common_client_ip()
2456 {
2457     if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
2458         return null;
2459     }
2460
2461     if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
2462         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2463             $proxy = $_SERVER['HTTP_CLIENT_IP'];
2464         } else {
2465             $proxy = $_SERVER['REMOTE_ADDR'];
2466         }
2467         $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
2468     } else {
2469         $proxy = null;
2470         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2471             $ip = $_SERVER['HTTP_CLIENT_IP'];
2472         } else {
2473             $ip = $_SERVER['REMOTE_ADDR'];
2474         }
2475     }
2476
2477     return array($proxy, $ip);
2478 }
2479
2480 function common_url_to_nickname($url)
2481 {
2482     static $bad = array('query', 'user', 'password', 'port', 'fragment');
2483
2484     $parts = parse_url($url);
2485
2486     // If any of these parts exist, this won't work
2487
2488     foreach ($bad as $badpart) {
2489         if (array_key_exists($badpart, $parts)) {
2490             return null;
2491         }
2492     }
2493
2494     // We just have host and/or path
2495
2496     // If it's just a host...
2497     if (array_key_exists('host', $parts) &&
2498         (!array_key_exists('path', $parts) || strcmp($parts['path'], '/') == 0))
2499     {
2500         $hostparts = explode('.', $parts['host']);
2501
2502         // Try to catch common idiom of nickname.service.tld
2503
2504         if ((count($hostparts) > 2) &&
2505             (strlen($hostparts[count($hostparts) - 2]) > 3) && # try to skip .co.uk, .com.au
2506             (strcmp($hostparts[0], 'www') != 0))
2507         {
2508             return common_nicknamize($hostparts[0]);
2509         } else {
2510             // Do the whole hostname
2511             return common_nicknamize($parts['host']);
2512         }
2513     } else {
2514         if (array_key_exists('path', $parts)) {
2515             // Strip starting, ending slashes
2516             $path = preg_replace('@/$@', '', $parts['path']);
2517             $path = preg_replace('@^/@', '', $path);
2518             $path = basename($path);
2519
2520             // Hack for MediaWiki user pages, in the form:
2521             // http://example.com/wiki/User:Myname
2522             // ('User' may be localized.)
2523             if (strpos($path, ':')) {
2524                 $parts = array_filter(explode(':', $path));
2525                 $path = $parts[count($parts) - 1];
2526             }
2527
2528             if ($path) {
2529                 return common_nicknamize($path);
2530             }
2531         }
2532     }
2533
2534     return null;
2535 }
2536
2537 function common_nicknamize($str)
2538 {
2539     try {
2540         return Nickname::normalize($str);
2541     } catch (NicknameException $e) {
2542         return null;
2543     }
2544 }
2545
2546 function common_perf_counter($key, $val=null)
2547 {
2548     global $_perfCounters;
2549     if (isset($_perfCounters)) {
2550         if (common_config('site', 'logperf')) {
2551             if (array_key_exists($key, $_perfCounters)) {
2552                 $_perfCounters[$key][] = $val;
2553             } else {
2554                 $_perfCounters[$key] = array($val);
2555             }
2556             if (common_config('site', 'logperf_detail')) {
2557                 common_log(LOG_DEBUG, "PERF COUNTER HIT: $key $val");
2558             }
2559         }
2560     }
2561 }
2562
2563 function common_log_perf_counters()
2564 {
2565     if (common_config('site', 'logperf')) {
2566         global $_startTime, $_perfCounters;
2567
2568         if (isset($_startTime)) {
2569             $endTime = microtime(true);
2570             $diff = round(($endTime - $_startTime) * 1000);
2571             common_log(LOG_DEBUG, "PERF runtime: ${diff}ms");
2572         }
2573         $counters = $_perfCounters;
2574         ksort($counters);
2575         foreach ($counters as $key => $values) {
2576             $count = count($values);
2577             $unique = count(array_unique($values));
2578             common_log(LOG_DEBUG, "PERF COUNTER: $key $count ($unique unique)");
2579         }
2580     }
2581 }
2582
2583 function common_is_email($str)
2584 {
2585     return (strpos($str, '@') !== false);
2586 }
2587
2588 function common_init_stats()
2589 {
2590     global $_mem, $_ts;
2591
2592     $_mem = memory_get_usage(true);
2593     $_ts  = microtime(true);
2594 }
2595
2596 function common_log_delta($comment=null)
2597 {
2598     global $_mem, $_ts;
2599
2600     $mold = $_mem;
2601     $told = $_ts;
2602
2603     $_mem = memory_get_usage(true);
2604     $_ts  = microtime(true);
2605
2606     $mtotal = $_mem - $mold;
2607     $ttotal = $_ts - $told;
2608
2609     if (empty($comment)) {
2610         $comment = 'Delta';
2611     }
2612
2613     common_debug(sprintf("%s: %d %d", $comment, $mtotal, round($ttotal * 1000000)));
2614 }
2615
2616 function common_strip_html($html, $trim=true, $save_whitespace=false)
2617 {
2618     // first replace <br /> with \n
2619     $html = preg_replace('/\<(\s*)?br(\s*)?\/?(\s*)?\>/i', "\n", $html);
2620     // then, unless explicitly avoided, remove excessive whitespace
2621     if (!$save_whitespace) {
2622         $html = preg_replace('/\s+/', ' ', $html);
2623     }
2624     $text = html_entity_decode(strip_tags($html), ENT_QUOTES, 'UTF-8');
2625     return $trim ? trim($text) : $text;
2626 }
2627
2628 function html_sprintf()
2629 {
2630     $args = func_get_args();
2631     for ($i=1; $i<count($args); $i++) {
2632         $args[$i] = htmlspecialchars($args[$i]);
2633     }
2634     return call_user_func_array('sprintf', $args);
2635 }
2636
2637 function _ve($var)
2638 {
2639     return var_export($var, true);
2640 }