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