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