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