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