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_tag_link($tag)
1120 {
1121     $canonical = common_canonical_tag($tag);
1122     if (common_config('singleuser', 'enabled')) {
1123         // regular TagAction isn't set up in 1user mode
1124         $nickname = User::singleUserNickname();
1125         $url = common_local_url('showstream',
1126                                 array('nickname' => $nickname,
1127                                       'tag' => $canonical));
1128     } else {
1129         $url = common_local_url('tag', array('tag' => $canonical));
1130     }
1131     $xs = new XMLStringer();
1132     $xs->elementStart('span', 'tag');
1133     $xs->element('a', array('href' => $url,
1134                             'rel' => 'tag'),
1135                  $tag);
1136     $xs->elementEnd('span');
1137     return $xs->getString();
1138 }
1139
1140 function common_canonical_tag($tag)
1141 {
1142   // only alphanum
1143   $tag = preg_replace('/[^\pL\pN]/u', '', $tag);
1144   $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
1145   $tag = substr($tag, 0, 64);
1146   return $tag;
1147 }
1148
1149 function common_valid_profile_tag($str)
1150 {
1151     return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
1152 }
1153
1154 /**
1155  * Resolve an ambiguous profile nickname reference, checking in following order:
1156  * - profiles that $sender subscribes to
1157  * - profiles that subscribe to $sender
1158  * - local user profiles
1159  *
1160  * WARNING: does not validate or normalize $nickname -- MUST BE PRE-VALIDATED
1161  * OR THERE MAY BE A RISK OF SQL INJECTION ATTACKS. THIS FUNCTION DOES NOT
1162  * ESCAPE SQL.
1163  *
1164  * @fixme validate input
1165  * @fixme escape SQL
1166  * @fixme fix or remove mystery third parameter
1167  * @fixme is $sender a User or Profile?
1168  *
1169  * @param <type> $sender the user or profile in whose context we're looking
1170  * @param string $nickname validated nickname of
1171  * @param <type> $dt unused mystery parameter; in Notice reply-to handling a timestamp is passed.
1172  *
1173  * @return Profile or null
1174  */
1175 function common_relative_profile($sender, $nickname, $dt=null)
1176 {
1177     // Will throw exception on invalid input.
1178     $nickname = Nickname::normalize($nickname);
1179
1180     // Try to find profiles this profile is subscribed to that have this nickname
1181     $recipient = new Profile();
1182     // XXX: use a join instead of a subquery
1183     $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.intval($sender->id).' and subscribed = id)', 'AND');
1184     $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1185     if ($recipient->find(true)) {
1186         // XXX: should probably differentiate between profiles with
1187         // the same name by date of most recent update
1188         return $recipient;
1189     }
1190     // Try to find profiles that listen to this profile and that have this nickname
1191     $recipient = new Profile();
1192     // XXX: use a join instead of a subquery
1193     $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.intval($sender->id).' and subscriber = id)', 'AND');
1194     $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1195     if ($recipient->find(true)) {
1196         // XXX: should probably differentiate between profiles with
1197         // the same name by date of most recent update
1198         return $recipient;
1199     }
1200     // If this is a local user, try to find a local user with that nickname.
1201     $sender = User::getKV('id', $sender->id);
1202     if ($sender instanceof User) {
1203         $recipient_user = User::getKV('nickname', $nickname);
1204         if ($recipient_user instanceof User) {
1205             return $recipient_user->getProfile();
1206         }
1207     }
1208     // Otherwise, no links. @messages from local users to remote users,
1209     // or from remote users to other remote users, are just
1210     // outside our ability to make intelligent guesses about
1211     return null;
1212 }
1213
1214 function common_local_url($action, $args=null, $params=null, $fragment=null, $addSession=true)
1215 {
1216     if (Event::handle('StartLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url))) {
1217         $r = Router::get();
1218         $path = $r->build($action, $args, $params, $fragment);
1219
1220         $ssl = common_config('site', 'ssl') === 'always'
1221                 || StatusNet::isHTTPS()
1222                 || common_is_sensitive($action);
1223
1224         if (common_config('site','fancy')) {
1225             $url = common_path($path, $ssl, $addSession);
1226         } else {
1227             if (mb_strpos($path, '/index.php') === 0) {
1228                 $url = common_path($path, $ssl, $addSession);
1229             } else {
1230                 $url = common_path('index.php/'.$path, $ssl, $addSession);
1231             }
1232         }
1233         Event::handle('EndLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url));
1234     }
1235     return $url;
1236 }
1237
1238 function common_is_sensitive($action)
1239 {
1240     static $sensitive = array(
1241         'login',
1242         'register',
1243         'passwordsettings',
1244         'api',
1245         'ApiOAuthRequestToken',
1246         'ApiOAuthAccessToken',
1247         'ApiOAuthAuthorize',
1248         'ApiOAuthPin',
1249         'showapplication'
1250     );
1251     $ssl = null;
1252
1253     if (Event::handle('SensitiveAction', array($action, &$ssl))) {
1254         $ssl = in_array($action, $sensitive);
1255     }
1256
1257     return $ssl;
1258 }
1259
1260 function common_path($relative, $ssl=false, $addSession=true)
1261 {
1262     $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
1263
1264     if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
1265         || StatusNet::isHTTPS()
1266         || common_config('site', 'ssl') === 'always') {
1267         $proto = 'https';
1268         if (is_string(common_config('site', 'sslserver')) &&
1269             mb_strlen(common_config('site', 'sslserver')) > 0) {
1270             $serverpart = common_config('site', 'sslserver');
1271         } else if (common_config('site', 'server')) {
1272             $serverpart = common_config('site', 'server');
1273         } else {
1274             common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1275         }
1276     } else {
1277         $proto = 'http';
1278         if (common_config('site', 'server')) {
1279             $serverpart = common_config('site', 'server');
1280         } else {
1281             common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1282         }
1283     }
1284
1285     if ($addSession) {
1286         $relative = common_inject_session($relative, $serverpart);
1287     }
1288
1289     return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
1290 }
1291
1292 function common_inject_session($url, $serverpart = null)
1293 {
1294     if (!common_have_session()) {
1295         return $url;
1296     }
1297
1298     if (empty($serverpart)) {
1299         $serverpart = parse_url($url, PHP_URL_HOST);
1300     }
1301
1302     $currentServer = (array_key_exists('HTTP_HOST', $_SERVER)) ? $_SERVER['HTTP_HOST'] : null;
1303
1304     // Are we pointing to another server (like an SSL server?)
1305
1306     if (!empty($currentServer) && 0 != strcasecmp($currentServer, $serverpart)) {
1307         // Pass the session ID as a GET parameter
1308         $sesspart = session_name() . '=' . session_id();
1309         $i = strpos($url, '?');
1310         if ($i === false) { // no GET params, just append
1311             $url .= '?' . $sesspart;
1312         } else {
1313             $url = substr($url, 0, $i + 1).$sesspart.'&'.substr($url, $i + 1);
1314         }
1315     }
1316
1317     return $url;
1318 }
1319
1320 function common_date_string($dt)
1321 {
1322     // XXX: do some sexy date formatting
1323     // return date(DATE_RFC822, $dt);
1324     $t = strtotime($dt);
1325     $now = time();
1326     $diff = $now - $t;
1327
1328     if ($now < $t) { // that shouldn't happen!
1329         return common_exact_date($dt);
1330     } else if ($diff < 60) {
1331         // TRANS: Used in notices to indicate when the notice was made compared to now.
1332         return _('a few seconds ago');
1333     } else if ($diff < 92) {
1334         // TRANS: Used in notices to indicate when the notice was made compared to now.
1335         return _('about a minute ago');
1336     } else if ($diff < 3300) {
1337         $minutes = round($diff/60);
1338         // TRANS: Used in notices to indicate when the notice was made compared to now.
1339         return sprintf( _m('about one minute ago', 'about %d minutes ago', $minutes), $minutes);
1340     } else if ($diff < 5400) {
1341         // TRANS: Used in notices to indicate when the notice was made compared to now.
1342         return _('about an hour ago');
1343     } else if ($diff < 22 * 3600) {
1344         $hours = round($diff/3600);
1345         // TRANS: Used in notices to indicate when the notice was made compared to now.
1346         return sprintf( _m('about one hour ago', 'about %d hours ago', $hours), $hours);
1347     } else if ($diff < 37 * 3600) {
1348         // TRANS: Used in notices to indicate when the notice was made compared to now.
1349         return _('about a day ago');
1350     } else if ($diff < 24 * 24 * 3600) {
1351         $days = round($diff/(24*3600));
1352         // TRANS: Used in notices to indicate when the notice was made compared to now.
1353         return sprintf( _m('about one day ago', 'about %d days ago', $days), $days);
1354     } else if ($diff < 46 * 24 * 3600) {
1355         // TRANS: Used in notices to indicate when the notice was made compared to now.
1356         return _('about a month ago');
1357     } else if ($diff < 330 * 24 * 3600) {
1358         $months = round($diff/(30*24*3600));
1359         // TRANS: Used in notices to indicate when the notice was made compared to now.
1360         return sprintf( _m('about one month ago', 'about %d months ago',$months), $months);
1361     } else if ($diff < 480 * 24 * 3600) {
1362         // TRANS: Used in notices to indicate when the notice was made compared to now.
1363         return _('about a year ago');
1364     } else {
1365         return common_exact_date($dt);
1366     }
1367 }
1368
1369 function common_exact_date($dt)
1370 {
1371     static $_utc;
1372     static $_siteTz;
1373
1374     if (!$_utc) {
1375         $_utc = new DateTimeZone('UTC');
1376         $_siteTz = new DateTimeZone(common_timezone());
1377     }
1378
1379     $dateStr = date('d F Y H:i:s', strtotime($dt));
1380     $d = new DateTime($dateStr, $_utc);
1381     $d->setTimezone($_siteTz);
1382     // TRANS: Human-readable full date-time specification (formatting on http://php.net/date)
1383     return $d->format(_('l, d-M-Y H:i:s T'));
1384 }
1385
1386 function common_date_w3dtf($dt)
1387 {
1388     $dateStr = date('d F Y H:i:s', strtotime($dt));
1389     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1390     $d->setTimezone(new DateTimeZone(common_timezone()));
1391     return $d->format(DATE_W3C);
1392 }
1393
1394 function common_date_rfc2822($dt)
1395 {
1396     $dateStr = date('d F Y H:i:s', strtotime($dt));
1397     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1398     $d->setTimezone(new DateTimeZone(common_timezone()));
1399     return $d->format('r');
1400 }
1401
1402 function common_date_iso8601($dt)
1403 {
1404     $dateStr = date('d F Y H:i:s', strtotime($dt));
1405     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1406     $d->setTimezone(new DateTimeZone(common_timezone()));
1407     return $d->format('c');
1408 }
1409
1410 function common_sql_now()
1411 {
1412     return common_sql_date(time());
1413 }
1414
1415 function common_sql_date($datetime)
1416 {
1417     return strftime('%Y-%m-%d %H:%M:%S', $datetime);
1418 }
1419
1420 /**
1421  * Return an SQL fragment to calculate an age-based weight from a given
1422  * timestamp or datetime column.
1423  *
1424  * @param string $column name of field we're comparing against current time
1425  * @param integer $dropoff divisor for age in seconds before exponentiation
1426  * @return string SQL fragment
1427  */
1428 function common_sql_weight($column, $dropoff)
1429 {
1430     if (common_config('db', 'type') == 'pgsql') {
1431         // PostgreSQL doesn't support timestampdiff function.
1432         // @fixme will this use the right time zone?
1433         // @fixme does this handle cross-year subtraction correctly?
1434         return "sum(exp(-extract(epoch from (now() - $column)) / $dropoff))";
1435     } else {
1436         return "sum(exp(timestampdiff(second, utc_timestamp(), $column) / $dropoff))";
1437     }
1438 }
1439
1440 function common_redirect($url, $code=307)
1441 {
1442     static $status = array(301 => "Moved Permanently",
1443                            302 => "Found",
1444                            303 => "See Other",
1445                            307 => "Temporary Redirect");
1446
1447     header('HTTP/1.1 '.$code.' '.$status[$code]);
1448     header("Location: $url");
1449     header("Connection: close");
1450
1451     $xo = new XMLOutputter();
1452     $xo->startXML('a',
1453                   '-//W3C//DTD XHTML 1.0 Strict//EN',
1454                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1455     $xo->element('a', array('href' => $url), $url);
1456     $xo->endXML();
1457     exit;
1458 }
1459
1460 // Stick the notice on the queue
1461
1462 function common_enqueue_notice($notice)
1463 {
1464     static $localTransports = array('ping');
1465
1466     $transports = array();
1467     if (common_config('sms', 'enabled')) {
1468         $transports[] = 'sms';
1469     }
1470     if (Event::hasHandler('HandleQueuedNotice')) {
1471         $transports[] = 'plugin';
1472     }
1473
1474     // We can skip these for gatewayed notices.
1475     if ($notice->isLocal()) {
1476         $transports = array_merge($transports, $localTransports);
1477     }
1478
1479     if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
1480
1481         $qm = QueueManager::get();
1482
1483         foreach ($transports as $transport)
1484         {
1485             $qm->enqueue($notice, $transport);
1486         }
1487
1488         Event::handle('EndEnqueueNotice', array($notice, $transports));
1489     }
1490
1491     return true;
1492 }
1493
1494 function common_profile_url($nickname)
1495 {
1496     return common_local_url('showstream', array('nickname' => $nickname),
1497                             null, null, false);
1498 }
1499
1500 /**
1501  * Should make up a reasonable root URL
1502  */
1503 function common_root_url($ssl=false)
1504 {
1505     $url = common_path('', $ssl, false);
1506     $i = strpos($url, '?');
1507     if ($i !== false) {
1508         $url = substr($url, 0, $i);
1509     }
1510     return $url;
1511 }
1512
1513 /**
1514  * returns $bytes bytes of random data as a hexadecimal string
1515  */
1516 function common_random_hexstr($bytes)
1517 {
1518     $str = @file_exists('/dev/urandom')
1519             ? common_urandom($bytes)
1520             : common_mtrand($bytes);
1521
1522     $hexstr = '';
1523     for ($i = 0; $i < $bytes; $i++) {
1524         $hexstr .= sprintf("%02x", ord($str[$i]));
1525     }
1526     return $hexstr;
1527 }
1528
1529 function common_urandom($bytes)
1530 {
1531     $h = fopen('/dev/urandom', 'rb');
1532     // should not block
1533     $src = fread($h, $bytes);
1534     fclose($h);
1535     return $src;
1536 }
1537
1538 function common_mtrand($bytes)
1539 {
1540     $str = '';
1541     for ($i = 0; $i < $bytes; $i++) {
1542         $str .= chr(mt_rand(0, 255));
1543     }
1544     return $str;
1545 }
1546
1547 /**
1548  * Record the given URL as the return destination for a future
1549  * form submission, to be read by common_get_returnto().
1550  *
1551  * @param string $url
1552  *
1553  * @fixme as a session-global setting, this can allow multiple forms
1554  * to conflict and overwrite each others' returnto destinations if
1555  * the user has multiple tabs or windows open.
1556  *
1557  * Should refactor to index with a token or otherwise only pass the
1558  * data along its intended path.
1559  */
1560 function common_set_returnto($url)
1561 {
1562     common_ensure_session();
1563     $_SESSION['returnto'] = $url;
1564 }
1565
1566 /**
1567  * Fetch a return-destination URL previously recorded by
1568  * common_set_returnto().
1569  *
1570  * @return mixed URL string or null
1571  *
1572  * @fixme as a session-global setting, this can allow multiple forms
1573  * to conflict and overwrite each others' returnto destinations if
1574  * the user has multiple tabs or windows open.
1575  *
1576  * Should refactor to index with a token or otherwise only pass the
1577  * data along its intended path.
1578  */
1579 function common_get_returnto()
1580 {
1581     common_ensure_session();
1582     return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
1583 }
1584
1585 function common_timestamp()
1586 {
1587     return date('YmdHis');
1588 }
1589
1590 function common_ensure_syslog()
1591 {
1592     static $initialized = false;
1593     if (!$initialized) {
1594         openlog(common_config('syslog', 'appname'), 0,
1595             common_config('syslog', 'facility'));
1596         $initialized = true;
1597     }
1598 }
1599
1600 function common_log_line($priority, $msg)
1601 {
1602     static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1603                                       'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1604     return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . PHP_EOL;
1605 }
1606
1607 function common_request_id()
1608 {
1609     $pid = getmypid();
1610     $server = common_config('site', 'server');
1611     if (php_sapi_name() == 'cli') {
1612         $script = basename($_SERVER['PHP_SELF']);
1613         return "$server:$script:$pid";
1614     } else {
1615         static $req_id = null;
1616         if (!isset($req_id)) {
1617             $req_id = substr(md5(mt_rand()), 0, 8);
1618         }
1619         if (isset($_SERVER['REQUEST_URI'])) {
1620             $url = $_SERVER['REQUEST_URI'];
1621         }
1622         $method = $_SERVER['REQUEST_METHOD'];
1623         return "$server:$pid.$req_id $method $url";
1624     }
1625 }
1626
1627 function common_log($priority, $msg, $filename=null)
1628 {
1629     if(Event::handle('StartLog', array(&$priority, &$msg, &$filename))){
1630         $msg = (empty($filename)) ? $msg : basename($filename) . ' - ' . $msg;
1631         $msg = '[' . common_request_id() . '] ' . $msg;
1632         $logfile = common_config('site', 'logfile');
1633         if ($logfile) {
1634             $log = fopen($logfile, "a");
1635             if ($log) {
1636                 $output = common_log_line($priority, $msg);
1637                 fwrite($log, $output);
1638                 fclose($log);
1639             }
1640         } else {
1641             common_ensure_syslog();
1642             syslog($priority, $msg);
1643         }
1644         Event::handle('EndLog', array($priority, $msg, $filename));
1645     }
1646 }
1647
1648 function common_debug($msg, $filename=null)
1649 {
1650     if ($filename) {
1651         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1652     } else {
1653         common_log(LOG_DEBUG, $msg);
1654     }
1655 }
1656
1657 function common_log_db_error(&$object, $verb, $filename=null)
1658 {
1659     global $_PEAR;
1660
1661     $objstr = common_log_objstring($object);
1662     $last_error = &$_PEAR->getStaticProperty('DB_DataObject','lastError');
1663     if (is_object($last_error)) {
1664         $msg = $last_error->message;
1665     } else {
1666         $msg = 'Unknown error (' . var_export($last_error, true) . ')';
1667     }
1668     common_log(LOG_ERR, $msg . '(' . $verb . ' on ' . $objstr . ')', $filename);
1669 }
1670
1671 function common_log_objstring(&$object)
1672 {
1673     if (is_null($object)) {
1674         return "null";
1675     }
1676     if (!($object instanceof DB_DataObject)) {
1677         return "(unknown)";
1678     }
1679     $arr = $object->toArray();
1680     $fields = array();
1681     foreach ($arr as $k => $v) {
1682         if (is_object($v)) {
1683             $fields[] = "$k='".get_class($v)."'";
1684         } else {
1685             $fields[] = "$k='$v'";
1686         }
1687     }
1688     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1689     return $objstring;
1690 }
1691
1692 function common_valid_http_url($url, $secure=false)
1693 {
1694     // If $secure is true, only allow https URLs to pass
1695     // (if false, we use '?' in 'https?' to say the 's' is optional)
1696     $regex = $secure ? '/^https$/' : '/^https?$/';
1697     return filter_var($url, FILTER_VALIDATE_URL)
1698             && preg_match($regex, parse_url($url, PHP_URL_SCHEME));
1699 }
1700
1701 function common_valid_tag($tag)
1702 {
1703     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1704         return (Validate::email($matches[1]) ||
1705                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1706     }
1707     return false;
1708 }
1709
1710 /**
1711  * Determine if given domain or address literal is valid
1712  * eg for use in JIDs and URLs. Does not check if the domain
1713  * exists!
1714  *
1715  * @param string $domain
1716  * @return boolean valid or not
1717  */
1718 function common_valid_domain($domain)
1719 {
1720     $octet = "(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])";
1721     $ipv4 = "(?:$octet(?:\.$octet){3})";
1722     if (preg_match("/^$ipv4$/u", $domain)) return true;
1723
1724     $group = "(?:[0-9a-f]{1,4})";
1725     $ipv6 = "(?:\[($group(?::$group){0,7})?(::)?($group(?::$group){0,7})?\])"; // http://tools.ietf.org/html/rfc3513#section-2.2
1726
1727     if (preg_match("/^$ipv6$/ui", $domain, $matches)) {
1728         $before = explode(":", $matches[1]);
1729         $zeroes = $matches[2];
1730         $after = explode(":", $matches[3]);
1731         if ($zeroes) {
1732             $min = 0;
1733             $max = 7;
1734         } else {
1735             $min = 1;
1736             $max = 8;
1737         }
1738         $explicit = count($before) + count($after);
1739         if ($explicit < $min || $explicit > $max) {
1740             return false;
1741         }
1742         return true;
1743     }
1744
1745     try {
1746         require_once "Net/IDNA.php";
1747         $idn = Net_IDNA::getInstance();
1748         $domain = $idn->encode($domain);
1749     } catch (Exception $e) {
1750         return false;
1751     }
1752
1753     $subdomain = "(?:[a-z0-9][a-z0-9-]*)"; // @fixme
1754     $fqdn = "(?:$subdomain(?:\.$subdomain)*\.?)";
1755
1756     return preg_match("/^$fqdn$/ui", $domain);
1757 }
1758
1759 /* Following functions are copied from MediaWiki GlobalFunctions.php
1760  * and written by Evan Prodromou. */
1761
1762 function common_accept_to_prefs($accept, $def = '*/*')
1763 {
1764     // No arg means accept anything (per HTTP spec)
1765     if(!$accept) {
1766         return array($def => 1);
1767     }
1768
1769     $prefs = array();
1770
1771     $parts = explode(',', $accept);
1772
1773     foreach($parts as $part) {
1774         // FIXME: doesn't deal with params like 'text/html; level=1'
1775         @list($value, $qpart) = explode(';', trim($part));
1776         $match = array();
1777         if(!isset($qpart)) {
1778             $prefs[$value] = 1;
1779         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1780             $prefs[$value] = $match[1];
1781         }
1782     }
1783
1784     return $prefs;
1785 }
1786
1787 // Match by our supported file extensions
1788 function common_supported_ext_to_mime($fileext)
1789 {
1790     // Accept a filename and take out the extension
1791     if (strpos($fileext, '.') !== false) {
1792         $fileext = substr(strrchr($fileext, '.'), 1);
1793     }
1794
1795     $supported = common_config('attachments', 'supported');
1796     foreach($supported as $type => $ext) {
1797         if ($ext === $fileext) {
1798             return $type;
1799         }
1800     }
1801
1802     throw new ServerException('Unsupported file extension');
1803 }
1804
1805 // Match by our supported mime types
1806 function common_supported_mime_to_ext($mimetype)
1807 {
1808     $supported = common_config('attachments', 'supported');
1809     foreach($supported as $type => $ext) {
1810         if ($mimetype === $type) {
1811             return $ext;
1812         }
1813     }
1814
1815     throw new ServerException('Unsupported MIME type');
1816 }
1817
1818 // The MIME "media" is the part before the slash (video in video/webm)
1819 function common_get_mime_media($type)
1820 {
1821     $tmp = explode('/', $type);
1822     return strtolower($tmp[0]);
1823 }
1824
1825 function common_bare_mime($mimetype)
1826 {
1827     $mimetype = mb_strtolower($mimetype);
1828     if ($semicolon = mb_strpos($mimetype, ';')) {
1829         $mimetype = mb_substr($mimetype, 0, $semicolon);
1830     }
1831     return $mimetype;
1832 }
1833
1834 function common_mime_type_match($type, $avail)
1835 {
1836     if(array_key_exists($type, $avail)) {
1837         return $type;
1838     } else {
1839         $parts = explode('/', $type);
1840         if(array_key_exists($parts[0] . '/*', $avail)) {
1841             return $parts[0] . '/*';
1842         } elseif(array_key_exists('*/*', $avail)) {
1843             return '*/*';
1844         } else {
1845             return null;
1846         }
1847     }
1848 }
1849
1850 function common_negotiate_type($cprefs, $sprefs)
1851 {
1852     $combine = array();
1853
1854     foreach(array_keys($sprefs) as $type) {
1855         $parts = explode('/', $type);
1856         if($parts[1] != '*') {
1857             $ckey = common_mime_type_match($type, $cprefs);
1858             if($ckey) {
1859                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1860             }
1861         }
1862     }
1863
1864     foreach(array_keys($cprefs) as $type) {
1865         $parts = explode('/', $type);
1866         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1867             $skey = common_mime_type_match($type, $sprefs);
1868             if($skey) {
1869                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1870             }
1871         }
1872     }
1873
1874     $bestq = 0;
1875     $besttype = 'text/html';
1876
1877     foreach(array_keys($combine) as $type) {
1878         if($combine[$type] > $bestq) {
1879             $besttype = $type;
1880             $bestq = $combine[$type];
1881         }
1882     }
1883
1884     if ('text/html' === $besttype) {
1885         return "text/html; charset=utf-8";
1886     }
1887     return $besttype;
1888 }
1889
1890 function common_config($main, $sub)
1891 {
1892     global $config;
1893     return (array_key_exists($main, $config) &&
1894             array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
1895 }
1896
1897 function common_config_set($main, $sub, $value)
1898 {
1899     global $config;
1900     if (!array_key_exists($main, $config)) {
1901         $config[$main] = array();
1902     }
1903     $config[$main][$sub] = $value;
1904 }
1905
1906 function common_config_append($main, $sub, $value)
1907 {
1908     global $config;
1909     if (!array_key_exists($main, $config)) {
1910         $config[$main] = array();
1911     }
1912     if (!array_key_exists($sub, $config[$main])) {
1913         $config[$main][$sub] = array();
1914     }
1915     if (!is_array($config[$main][$sub])) {
1916         $config[$main][$sub] = array($config[$main][$sub]);
1917     }
1918     array_push($config[$main][$sub], $value);
1919 }
1920
1921 /**
1922  * Pull arguments from a GET/POST/REQUEST array with first-level input checks:
1923  * strips "magic quotes" slashes if necessary, and kills invalid UTF-8 strings.
1924  *
1925  * @param array $from
1926  * @return array
1927  */
1928 function common_copy_args($from)
1929 {
1930     $to = array();
1931     $strip = get_magic_quotes_gpc();
1932     foreach ($from as $k => $v) {
1933         if(is_array($v)) {
1934             $to[$k] = common_copy_args($v);
1935         } else {
1936             if ($strip) {
1937                 $v = stripslashes($v);
1938             }
1939             $to[$k] = strval(common_validate_utf8($v));
1940         }
1941     }
1942     return $to;
1943 }
1944
1945 /**
1946  * Neutralise the evil effects of magic_quotes_gpc in the current request.
1947  * This is used before handing a request off to OAuthRequest::from_request.
1948  * @fixme Doesn't consider vars other than _POST and _GET?
1949  * @fixme Can't be undone and could corrupt data if run twice.
1950  */
1951 function common_remove_magic_from_request()
1952 {
1953     if(get_magic_quotes_gpc()) {
1954         $_POST=array_map('stripslashes',$_POST);
1955         $_GET=array_map('stripslashes',$_GET);
1956     }
1957 }
1958
1959 function common_user_uri(&$user)
1960 {
1961     return common_local_url('userbyid', array('id' => $user->id),
1962                             null, null, false);
1963 }
1964
1965 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1966
1967 function common_confirmation_code($bits)
1968 {
1969     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1970     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1971     $chars = ceil($bits/5);
1972     $code = '';
1973     for ($i = 0; $i < $chars; $i++) {
1974         // XXX: convert to string and back
1975         $num = hexdec(common_random_hexstr(1));
1976         // XXX: randomness is too precious to throw away almost
1977         // 40% of the bits we get!
1978         $code .= $codechars[$num%32];
1979     }
1980     return $code;
1981 }
1982
1983 // convert markup to HTML
1984 function common_markup_to_html($c, $args=null)
1985 {
1986     if ($c === null) {
1987         return '';
1988     }
1989
1990     if (is_null($args)) {
1991         $args = array();
1992     }
1993
1994     // XXX: not very efficient
1995
1996     foreach ($args as $name => $value) {
1997         $c = preg_replace('/%%arg.'.$name.'%%/', $value, $c);
1998     }
1999
2000     $c = preg_replace_callback('/%%user.(\w+)%%/', function ($m) { return common_user_property($m[1]); }, $c);
2001     $c = preg_replace_callback('/%%action.(\w+)%%/', function ($m) { return common_local_url($m[1]); }, $c);
2002     $c = preg_replace_callback('/%%doc.(\w+)%%/', function ($m) { return common_local_url('doc', array('title'=>$m[1])); }, $c);
2003     $c = preg_replace_callback('/%%(\w+).(\w+)%%/', function ($m) { return common_config($m[1], $m[2]); }, $c);
2004
2005     return \Michelf\Markdown::defaultTransform($c);
2006 }
2007
2008 function common_user_property($property)
2009 {
2010     $profile = Profile::current();
2011
2012     if (empty($profile)) {
2013         return null;
2014     }
2015
2016     switch ($property) {
2017     case 'profileurl':
2018     case 'nickname':
2019     case 'fullname':
2020     case 'location':
2021     case 'bio':
2022         return $profile->$property;
2023         break;
2024     case 'avatar':
2025         try {
2026             return $profile->getAvatar(AVATAR_STREAM_SIZE);
2027         } catch (Exception $e) {
2028             return null;
2029         }
2030         break;
2031     case 'bestname':
2032         return $profile->getBestName();
2033         break;
2034     default:
2035         return null;
2036     }
2037 }
2038
2039 function common_profile_uri($profile)
2040 {
2041     $uri = null;
2042
2043     if (!empty($profile)) {
2044         if (Event::handle('StartCommonProfileURI', array($profile, &$uri))) {
2045             $user = User::getKV('id', $profile->id);
2046             if ($user instanceof User) {
2047                 $uri = $user->getUri();
2048             }
2049             Event::handle('EndCommonProfileURI', array($profile, &$uri));
2050         }
2051     }
2052
2053     // XXX: this is a very bad profile!
2054     return $uri;
2055 }
2056
2057 function common_canonical_sms($sms)
2058 {
2059     // strip non-digits
2060     preg_replace('/\D/', '', $sms);
2061     return $sms;
2062 }
2063
2064 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
2065 {
2066     switch ($errno) {
2067
2068      case E_ERROR:
2069      case E_COMPILE_ERROR:
2070      case E_CORE_ERROR:
2071      case E_USER_ERROR:
2072      case E_PARSE:
2073      case E_RECOVERABLE_ERROR:
2074         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
2075         die();
2076         break;
2077
2078      case E_WARNING:
2079      case E_COMPILE_WARNING:
2080      case E_CORE_WARNING:
2081      case E_USER_WARNING:
2082         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
2083         break;
2084
2085      case E_NOTICE:
2086      case E_USER_NOTICE:
2087         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
2088         break;
2089
2090      case E_STRICT:
2091      case E_DEPRECATED:
2092      case E_USER_DEPRECATED:
2093         // XXX: config variable to log this stuff, too
2094         break;
2095
2096      default:
2097         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
2098         die();
2099         break;
2100     }
2101
2102     // FIXME: show error page if we're on the Web
2103     /* Don't execute PHP internal error handler */
2104     return true;
2105 }
2106
2107 function common_session_token()
2108 {
2109     common_ensure_session();
2110     if (!array_key_exists('token', $_SESSION)) {
2111         $_SESSION['token'] = common_random_hexstr(64);
2112     }
2113     return $_SESSION['token'];
2114 }
2115
2116 function common_license_terms($uri)
2117 {
2118     if(preg_match('/creativecommons.org\/licenses\/([^\/]+)/', $uri, $matches)) {
2119         return explode('-',$matches[1]);
2120     }
2121     return array($uri);
2122 }
2123
2124 function common_compatible_license($from, $to)
2125 {
2126     $from_terms = common_license_terms($from);
2127     // public domain and cc-by are compatible with everything
2128     if(count($from_terms) == 1 && ($from_terms[0] == 'publicdomain' || $from_terms[0] == 'by')) {
2129         return true;
2130     }
2131     $to_terms = common_license_terms($to);
2132     // sa is compatible across versions. IANAL
2133     if(in_array('sa',$from_terms) || in_array('sa',$to_terms)) {
2134         return count(array_diff($from_terms, $to_terms)) == 0;
2135     }
2136     // XXX: better compatibility check needed here!
2137     // Should at least normalise URIs
2138     return ($from == $to);
2139 }
2140
2141 /**
2142  * returns a quoted table name, if required according to config
2143  */
2144 function common_database_tablename($tablename)
2145 {
2146   if(common_config('db','quote_identifiers')) {
2147       $tablename = '"'. $tablename .'"';
2148   }
2149   //table prefixes could be added here later
2150   return $tablename;
2151 }
2152
2153 /**
2154  * Shorten a URL with the current user's configured shortening service,
2155  * or ur1.ca if configured, or not at all if no shortening is set up.
2156  *
2157  * @param string  $long_url original URL
2158  * @param User $user to specify a particular user's options
2159  * @param boolean $force    Force shortening (used when notice is too long)
2160  * @return string may return the original URL if shortening failed
2161  *
2162  * @fixme provide a way to specify a particular shortener
2163  */
2164 function common_shorten_url($long_url, User $user=null, $force = false)
2165 {
2166     $long_url = trim($long_url);
2167
2168     $user = common_current_user();
2169
2170     $maxUrlLength = User_urlshortener_prefs::maxUrlLength($user);
2171
2172     // $force forces shortening even if it's not strictly needed
2173     // I doubt URL shortening is ever 'strictly' needed. - ESP
2174
2175     if (($maxUrlLength == -1 || mb_strlen($long_url) < $maxUrlLength) && !$force) {
2176         return $long_url;
2177     }
2178
2179     $shortenerName = User_urlshortener_prefs::urlShorteningService($user);
2180
2181     if (Event::handle('StartShortenUrl',
2182                       array($long_url, $shortenerName, &$shortenedUrl))) {
2183         if ($shortenerName == 'internal') {
2184             try {
2185                 $f = File::processNew($long_url);
2186                 $shortenedUrl = common_local_url('redirecturl', array('id' => $f->id));
2187                 if ((mb_strlen($shortenedUrl) < mb_strlen($long_url)) || $force) {
2188                     return $shortenedUrl;
2189                 } else {
2190                     return $long_url;
2191                 }
2192             } catch (ServerException $e) {
2193                 return $long_url;
2194             }
2195         } else {
2196             return $long_url;
2197         }
2198     } else {
2199         //URL was shortened, so return the result
2200         return trim($shortenedUrl);
2201     }
2202 }
2203
2204 /**
2205  * @return mixed array($proxy, $ip) for web requests; proxy may be null
2206  *               null if not a web request
2207  *
2208  * @fixme X-Forwarded-For can be chained by multiple proxies;
2209           we should parse the list and provide a cleaner array
2210  * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
2211  * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
2212  *        use function to get exact request headers from Apache if possible.
2213  */
2214 function common_client_ip()
2215 {
2216     if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
2217         return null;
2218     }
2219
2220     if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
2221         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2222             $proxy = $_SERVER['HTTP_CLIENT_IP'];
2223         } else {
2224             $proxy = $_SERVER['REMOTE_ADDR'];
2225         }
2226         $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
2227     } else {
2228         $proxy = null;
2229         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2230             $ip = $_SERVER['HTTP_CLIENT_IP'];
2231         } else {
2232             $ip = $_SERVER['REMOTE_ADDR'];
2233         }
2234     }
2235
2236     return array($proxy, $ip);
2237 }
2238
2239 function common_url_to_nickname($url)
2240 {
2241     static $bad = array('query', 'user', 'password', 'port', 'fragment');
2242
2243     $parts = parse_url($url);
2244
2245     // If any of these parts exist, this won't work
2246
2247     foreach ($bad as $badpart) {
2248         if (array_key_exists($badpart, $parts)) {
2249             return null;
2250         }
2251     }
2252
2253     // We just have host and/or path
2254
2255     // If it's just a host...
2256     if (array_key_exists('host', $parts) &&
2257         (!array_key_exists('path', $parts) || strcmp($parts['path'], '/') == 0))
2258     {
2259         $hostparts = explode('.', $parts['host']);
2260
2261         // Try to catch common idiom of nickname.service.tld
2262
2263         if ((count($hostparts) > 2) &&
2264             (strlen($hostparts[count($hostparts) - 2]) > 3) && # try to skip .co.uk, .com.au
2265             (strcmp($hostparts[0], 'www') != 0))
2266         {
2267             return common_nicknamize($hostparts[0]);
2268         } else {
2269             // Do the whole hostname
2270             return common_nicknamize($parts['host']);
2271         }
2272     } else {
2273         if (array_key_exists('path', $parts)) {
2274             // Strip starting, ending slashes
2275             $path = preg_replace('@/$@', '', $parts['path']);
2276             $path = preg_replace('@^/@', '', $path);
2277             $path = basename($path);
2278
2279             // Hack for MediaWiki user pages, in the form:
2280             // http://example.com/wiki/User:Myname
2281             // ('User' may be localized.)
2282             if (strpos($path, ':')) {
2283                 $parts = array_filter(explode(':', $path));
2284                 $path = $parts[count($parts) - 1];
2285             }
2286
2287             if ($path) {
2288                 return common_nicknamize($path);
2289             }
2290         }
2291     }
2292
2293     return null;
2294 }
2295
2296 function common_nicknamize($str)
2297 {
2298     try {
2299         return Nickname::normalize($str);
2300     } catch (NicknameException $e) {
2301         return null;
2302     }
2303 }
2304
2305 function common_perf_counter($key, $val=null)
2306 {
2307     global $_perfCounters;
2308     if (isset($_perfCounters)) {
2309         if (common_config('site', 'logperf')) {
2310             if (array_key_exists($key, $_perfCounters)) {
2311                 $_perfCounters[$key][] = $val;
2312             } else {
2313                 $_perfCounters[$key] = array($val);
2314             }
2315             if (common_config('site', 'logperf_detail')) {
2316                 common_log(LOG_DEBUG, "PERF COUNTER HIT: $key $val");
2317             }
2318         }
2319     }
2320 }
2321
2322 function common_log_perf_counters()
2323 {
2324     if (common_config('site', 'logperf')) {
2325         global $_startTime, $_perfCounters;
2326
2327         if (isset($_startTime)) {
2328             $endTime = microtime(true);
2329             $diff = round(($endTime - $_startTime) * 1000);
2330             common_log(LOG_DEBUG, "PERF runtime: ${diff}ms");
2331         }
2332         $counters = $_perfCounters;
2333         ksort($counters);
2334         foreach ($counters as $key => $values) {
2335             $count = count($values);
2336             $unique = count(array_unique($values));
2337             common_log(LOG_DEBUG, "PERF COUNTER: $key $count ($unique unique)");
2338         }
2339     }
2340 }
2341
2342 function common_is_email($str)
2343 {
2344     return (strpos($str, '@') !== false);
2345 }
2346
2347 function common_init_stats()
2348 {
2349     global $_mem, $_ts;
2350
2351     $_mem = memory_get_usage(true);
2352     $_ts  = microtime(true);
2353 }
2354
2355 function common_log_delta($comment=null)
2356 {
2357     global $_mem, $_ts;
2358
2359     $mold = $_mem;
2360     $told = $_ts;
2361
2362     $_mem = memory_get_usage(true);
2363     $_ts  = microtime(true);
2364
2365     $mtotal = $_mem - $mold;
2366     $ttotal = $_ts - $told;
2367
2368     if (empty($comment)) {
2369         $comment = 'Delta';
2370     }
2371
2372     common_debug(sprintf("%s: %d %d", $comment, $mtotal, round($ttotal * 1000000)));
2373 }
2374
2375 function common_strip_html($html, $trim=true, $save_whitespace=false)
2376 {
2377     if (!$save_whitespace) {
2378         $html = preg_replace('/\s+/', ' ', $html);
2379     }
2380     $text = html_entity_decode(strip_tags($html), ENT_QUOTES, 'UTF-8');
2381     return $trim ? trim($text) : $text;
2382 }