lib/util.php

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