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