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