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