lib/util.php

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