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