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