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