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