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