lib/util.php

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