lib/util.php

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