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