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