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