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