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