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