lib/util.php

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