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