lib/util.php

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