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