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