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