lib/util.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, 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 // Show a server error
  23
  24 function common_server_error($msg, $code=500)
  25 {
  26     $err = new ServerErrorAction($msg, $code);
  27     $err->showPage();
  28 }
  29
  30 // Show a user error
  31 function common_user_error($msg, $code=400)
  32 {
  33     $err = new ClientErrorAction($msg, $code);
  34     $err->showPage();
  35 }
  36
  37 /**
  38  * This should only be used at setup; processes switching languages
  39  * to send text to other users should use common_switch_locale().
  40  *
  41  * @param string $language Locale language code (optional; empty uses
  42  *                         current user's preference or site default)
  43  * @return mixed success
  44  */
  45 function common_init_locale($language=null)
  46 {
  47     if(!$language) {
  48         $language = common_language();
  49     }
  50     putenv('LANGUAGE='.$language);
  51     putenv('LANG='.$language);
  52     $ok =  setlocale(LC_ALL, $language . ".utf8",
  53                      $language . ".UTF8",
  54                      $language . ".utf-8",
  55                      $language . ".UTF-8",
  56                      $language);
  57
  58     return $ok;
  59 }
  60
  61 /**
  62  * Initialize locale and charset settings and gettext with our message catalog,
  63  * using the current user's language preference or the site default.
  64  *
  65  * This should generally only be run at framework initialization; code switching
  66  * languages at runtime should call common_switch_language().
  67  *
  68  * @access private
  69  */
  70 function common_init_language()
  71 {
  72     mb_internal_encoding('UTF-8');
  73
  74     // Note that this setlocale() call may "fail" but this is harmless;
  75     // gettext will still select the right language.
  76     $language = common_language();
  77     $locale_set = common_init_locale($language);
  78
  79     if (!$locale_set) {
  80         // The requested locale doesn't exist on the system.
  81         //
  82         // gettext seems very picky... We first need to setlocale()
  83         // to a locale which _does_ exist on the system, and _then_
  84         // we can set in another locale that may not be set up
  85         // (say, ga_ES for Galego/Galician) it seems to take it.
  86         //
  87         // For some reason C and POSIX which are guaranteed to work
  88         // don't do the job. en_US.UTF-8 should be there most of the
  89         // time, but not guaranteed.
  90         $ok = common_init_locale("en_US");
  91         if (!$ok) {
  92             // Try to find a complete, working locale...
  93             // @fixme shelling out feels awfully inefficient
  94             // but I don't think there's a more standard way.
  95             $all = `locale -a`;
  96             foreach (explode("\n", $all) as $locale) {
  97                 if (preg_match('/\.utf[-_]?8$/i', $locale)) {
  98                     $ok = setlocale(LC_ALL, $locale);
  99                     if ($ok) {
 100                         break;
 101                     }
 102                 }
 103             }
 104             if (!$ok) {
 105                 common_log(LOG_ERR, "Unable to find a UTF-8 locale on this system; UI translations may not work.");
 106             }
 107         }
 108         $locale_set = common_init_locale($language);
 109     }
 110
 111     common_init_gettext();
 112 }
 113
 114 /**
 115  * @access private
 116  */
 117 function common_init_gettext()
 118 {
 119     setlocale(LC_CTYPE, 'C');
 120     // So we do not have to make people install the gettext locales
 121     $path = common_config('site','locale_path');
 122     bindtextdomain("statusnet", $path);
 123     bind_textdomain_codeset("statusnet", "UTF-8");
 124     textdomain("statusnet");
 125 }
 126
 127 /**
 128  * Switch locale during runtime, and poke gettext until it cries uncle.
 129  * Otherwise, sometimes it doesn't actually switch away from the old language.
 130  *
 131  * @param string $language code for locale ('en', 'fr', 'pt_BR' etc)
 132  */
 133 function common_switch_locale($language=null)
 134 {
 135     common_init_locale($language);
 136
 137     setlocale(LC_CTYPE, 'C');
 138     // So we do not have to make people install the gettext locales
 139     $path = common_config('site','locale_path');
 140     bindtextdomain("statusnet", $path);
 141     bind_textdomain_codeset("statusnet", "UTF-8");
 142     textdomain("statusnet");
 143 }
 144
 145
 146 function common_timezone()
 147 {
 148     if (common_logged_in()) {
 149         $user = common_current_user();
 150         if ($user->timezone) {
 151             return $user->timezone;
 152         }
 153     }
 154
 155     return common_config('site', 'timezone');
 156 }
 157
 158 function common_language()
 159 {
 160
 161     // If there is a user logged in and they've set a language preference
 162     // then return that one...
 163     if (_have_config() && common_logged_in()) {
 164         $user = common_current_user();
 165         $user_language = $user->language;
 166
 167         if ($user->language) {
 168             // Validate -- we don't want to end up with a bogus code
 169             // left over from some old junk.
 170             foreach (common_config('site', 'languages') as $code => $info) {
 171                 if ($info['lang'] == $user_language) {
 172                     return $user_language;
 173                 }
 174             }
 175         }
 176     }
 177
 178     // Otherwise, find the best match for the languages requested by the
 179     // user's browser...
 180     if (common_config('site', 'langdetect')) {
 181         $httplang = isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? $_SERVER['HTTP_ACCEPT_LANGUAGE'] : null;
 182         if (!empty($httplang)) {
 183             $language = client_prefered_language($httplang);
 184             if ($language)
 185               return $language;
 186         }
 187     }
 188
 189     // Finally, if none of the above worked, use the site's default...
 190     return common_config('site', 'language');
 191 }
 192 // salted, hashed passwords are stored in the DB
 193
 194 function common_munge_password($password, $id)
 195 {
 196     if (is_object($id) || is_object($password)) {
 197         $e = new Exception();
 198         common_log(LOG_ERR, __METHOD__ . ' object in param to common_munge_password ' .
 199                    str_replace("\n", " ", $e->getTraceAsString()));
 200     }
 201     return md5($password . $id);
 202 }
 203
 204 // check if a username exists and has matching password
 205
 206 function common_check_user($nickname, $password)
 207 {
 208     // empty nickname always unacceptable
 209     if (empty($nickname)) {
 210         return false;
 211     }
 212
 213     $authenticatedUser = false;
 214
 215     if (Event::handle('StartCheckPassword', array($nickname, $password, &$authenticatedUser))) {
 216         $user = User::staticGet('nickname', common_canonical_nickname($nickname));
 217         if (!empty($user)) {
 218             if (!empty($password)) { // never allow login with blank password
 219                 if (0 == strcmp(common_munge_password($password, $user->id),
 220                                 $user->password)) {
 221                     //internal checking passed
 222                     $authenticatedUser = $user;
 223                 }
 224             }
 225         }
 226         Event::handle('EndCheckPassword', array($nickname, $password, $authenticatedUser));
 227     }
 228
 229     return $authenticatedUser;
 230 }
 231
 232 // is the current user logged in?
 233 function common_logged_in()
 234 {
 235     return (!is_null(common_current_user()));
 236 }
 237
 238 function common_have_session()
 239 {
 240     return (0 != strcmp(session_id(), ''));
 241 }
 242
 243 function common_ensure_session()
 244 {
 245     $c = null;
 246     if (array_key_exists(session_name(), $_COOKIE)) {
 247         $c = $_COOKIE[session_name()];
 248     }
 249     if (!common_have_session()) {
 250         if (common_config('sessions', 'handle')) {
 251             Session::setSaveHandler();
 252         }
 253         if (array_key_exists(session_name(), $_GET)) {
 254             $id = $_GET[session_name()];
 255         } else if (array_key_exists(session_name(), $_COOKIE)) {
 256             $id = $_COOKIE[session_name()];
 257         }
 258         if (isset($id)) {
 259             session_id($id);
 260         }
 261         @session_start();
 262         if (!isset($_SESSION['started'])) {
 263             $_SESSION['started'] = time();
 264             if (!empty($id)) {
 265                 common_log(LOG_WARNING, 'Session cookie "' . $_COOKIE[session_name()] . '" ' .
 266                            ' is set but started value is null');
 267             }
 268         }
 269     }
 270 }
 271
 272 // Three kinds of arguments:
 273 // 1) a user object
 274 // 2) a nickname
 275 // 3) null to clear
 276
 277 // Initialize to false; set to null if none found
 278
 279 $_cur = false;
 280
 281 function common_set_user($user)
 282 {
 283
 284     global $_cur;
 285
 286     if (is_null($user) && common_have_session()) {
 287         $_cur = null;
 288         unset($_SESSION['userid']);
 289         return true;
 290     } else if (is_string($user)) {
 291         $nickname = $user;
 292         $user = User::staticGet('nickname', $nickname);
 293     } else if (!($user instanceof User)) {
 294         return false;
 295     }
 296
 297     if ($user) {
 298         if (Event::handle('StartSetUser', array(&$user))) {
 299             if($user){
 300                 common_ensure_session();
 301                 $_SESSION['userid'] = $user->id;
 302                 $_cur = $user;
 303                 Event::handle('EndSetUser', array($user));
 304                 return $_cur;
 305             }
 306         }
 307     }
 308     return false;
 309 }
 310
 311 function common_set_cookie($key, $value, $expiration=0)
 312 {
 313     $path = common_config('site', 'path');
 314     $server = common_config('site', 'server');
 315
 316     if ($path && ($path != '/')) {
 317         $cookiepath = '/' . $path . '/';
 318     } else {
 319         $cookiepath = '/';
 320     }
 321     return setcookie($key,
 322                      $value,
 323                      $expiration,
 324                      $cookiepath,
 325                      $server);
 326 }
 327
 328 define('REMEMBERME', 'rememberme');
 329 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
 330
 331 function common_rememberme($user=null)
 332 {
 333     if (!$user) {
 334         $user = common_current_user();
 335         if (!$user) {
 336             return false;
 337         }
 338     }
 339
 340     $rm = new Remember_me();
 341
 342     $rm->code = common_good_rand(16);
 343     $rm->user_id = $user->id;
 344
 345     // Wrap the insert in some good ol' fashioned transaction code
 346
 347     $rm->query('BEGIN');
 348
 349     $result = $rm->insert();
 350
 351     if (!$result) {
 352         common_log_db_error($rm, 'INSERT', __FILE__);
 353         return false;
 354     }
 355
 356     $rm->query('COMMIT');
 357
 358     $cookieval = $rm->user_id . ':' . $rm->code;
 359
 360     common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
 361
 362     common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
 363
 364     return true;
 365 }
 366
 367 function common_remembered_user()
 368 {
 369
 370     $user = null;
 371
 372     $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
 373
 374     if (!$packed) {
 375         return null;
 376     }
 377
 378     list($id, $code) = explode(':', $packed);
 379
 380     if (!$id || !$code) {
 381         common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
 382         common_forgetme();
 383         return null;
 384     }
 385
 386     $rm = Remember_me::staticGet($code);
 387
 388     if (!$rm) {
 389         common_log(LOG_WARNING, 'No such remember code: ' . $code);
 390         common_forgetme();
 391         return null;
 392     }
 393
 394     if ($rm->user_id != $id) {
 395         common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
 396         common_forgetme();
 397         return null;
 398     }
 399
 400     $user = User::staticGet($rm->user_id);
 401
 402     if (!$user) {
 403         common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
 404         common_forgetme();
 405         return null;
 406     }
 407
 408     // successful!
 409     $result = $rm->delete();
 410
 411     if (!$result) {
 412         common_log_db_error($rm, 'DELETE', __FILE__);
 413         common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
 414         common_forgetme();
 415         return null;
 416     }
 417
 418     common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
 419
 420     common_set_user($user);
 421     common_real_login(false);
 422
 423     // We issue a new cookie, so they can log in
 424     // automatically again after this session
 425
 426     common_rememberme($user);
 427
 428     return $user;
 429 }
 430
 431 // must be called with a valid user!
 432
 433 function common_forgetme()
 434 {
 435     common_set_cookie(REMEMBERME, '', 0);
 436 }
 437
 438 // who is the current user?
 439 function common_current_user()
 440 {
 441     global $_cur;
 442
 443     if (!_have_config()) {
 444         return null;
 445     }
 446
 447     if ($_cur === false) {
 448
 449         if (isset($_COOKIE[session_name()]) || isset($_GET[session_name()])
 450             || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
 451             common_ensure_session();
 452             $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
 453             if ($id) {
 454                 $user = User::staticGet($id);
 455                 if ($user) {
 456                         $_cur = $user;
 457                         return $_cur;
 458                 }
 459             }
 460         }
 461
 462         // that didn't work; try to remember; will init $_cur to null on failure
 463         $_cur = common_remembered_user();
 464
 465         if ($_cur) {
 466             // XXX: Is this necessary?
 467             $_SESSION['userid'] = $_cur->id;
 468         }
 469     }
 470
 471     return $_cur;
 472 }
 473
 474 // Logins that are 'remembered' aren't 'real' -- they're subject to
 475 // cookie-stealing. So, we don't let them do certain things. New reg,
 476 // OpenID, and password logins _are_ real.
 477
 478 function common_real_login($real=true)
 479 {
 480     common_ensure_session();
 481     $_SESSION['real_login'] = $real;
 482 }
 483
 484 function common_is_real_login()
 485 {
 486     return common_logged_in() && $_SESSION['real_login'];
 487 }
 488
 489 // get canonical version of nickname for comparison
 490 function common_canonical_nickname($nickname)
 491 {
 492     // XXX: UTF-8 canonicalization (like combining chars)
 493     return strtolower($nickname);
 494 }
 495
 496 // get canonical version of email for comparison
 497 function common_canonical_email($email)
 498 {
 499     // XXX: canonicalize UTF-8
 500     // XXX: lcase the domain part
 501     return $email;
 502 }
 503
 504 function common_render_content($text, $notice)
 505 {
 506     $r = common_render_text($text);
 507     $id = $notice->profile_id;
 508     $r = common_linkify_mentions($r, $notice);
 509     $r = preg_replace('/(^|[\s\.\,\:\;]+)!([A-Za-z0-9]{1,64})/e', "'\\1!'.common_group_link($id, '\\2')", $r);
 510     return $r;
 511 }
 512
 513 function common_linkify_mentions($text, $notice)
 514 {
 515     $mentions = common_find_mentions($text, $notice);
 516
 517     // We need to go through in reverse order by position,
 518     // so our positions stay valid despite our fudging with the
 519     // string!
 520
 521     $points = array();
 522
 523     foreach ($mentions as $mention)
 524     {
 525         $points[$mention['position']] = $mention;
 526     }
 527
 528     krsort($points);
 529
 530     foreach ($points as $position => $mention) {
 531
 532         $linkText = common_linkify_mention($mention);
 533
 534         $text = substr_replace($text, $linkText, $position, mb_strlen($mention['text']));
 535     }
 536
 537     return $text;
 538 }
 539
 540 function common_linkify_mention($mention)
 541 {
 542     $output = null;
 543
 544     if (Event::handle('StartLinkifyMention', array($mention, &$output))) {
 545
 546         $xs = new XMLStringer(false);
 547
 548         $attrs = array('href' => $mention['url'],
 549                        'class' => 'url');
 550
 551         if (!empty($mention['title'])) {
 552             $attrs['title'] = $mention['title'];
 553         }
 554
 555         $xs->elementStart('span', 'vcard');
 556         $xs->elementStart('a', $attrs);
 557         $xs->element('span', 'fn nickname', $mention['text']);
 558         $xs->elementEnd('a');
 559         $xs->elementEnd('span');
 560
 561         $output = $xs->getString();
 562
 563         Event::handle('EndLinkifyMention', array($mention, &$output));
 564     }
 565
 566     return $output;
 567 }
 568
 569 function common_find_mentions($text, $notice)
 570 {
 571     $mentions = array();
 572
 573     $sender = Profile::staticGet('id', $notice->profile_id);
 574
 575     if (empty($sender)) {
 576         return $mentions;
 577     }
 578
 579     if (Event::handle('StartFindMentions', array($sender, $text, &$mentions))) {
 580
 581         // Get the context of the original notice, if any
 582
 583         $originalAuthor   = null;
 584         $originalNotice   = null;
 585         $originalMentions = array();
 586
 587         // Is it a reply?
 588
 589         if (!empty($notice) && !empty($notice->reply_to)) {
 590             $originalNotice = Notice::staticGet('id', $notice->reply_to);
 591             if (!empty($originalNotice)) {
 592                 $originalAuthor = Profile::staticGet('id', $originalNotice->profile_id);
 593
 594                 $ids = $originalNotice->getReplies();
 595
 596                 foreach ($ids as $id) {
 597                     $repliedTo = Profile::staticGet('id', $id);
 598                     if (!empty($repliedTo)) {
 599                         $originalMentions[$repliedTo->nickname] = $repliedTo;
 600                     }
 601                 }
 602             }
 603         }
 604
 605         preg_match_all('/^T ([A-Z0-9]{1,64}) /',
 606                        $text,
 607                        $tmatches,
 608                        PREG_OFFSET_CAPTURE);
 609
 610         preg_match_all('/(?:^|\s+)@(['.NICKNAME_FMT.']{1,64})/',
 611                        $text,
 612                        $atmatches,
 613                        PREG_OFFSET_CAPTURE);
 614
 615         $matches = array_merge($tmatches[1], $atmatches[1]);
 616
 617         foreach ($matches as $match) {
 618
 619             $nickname = common_canonical_nickname($match[0]);
 620
 621             // Try to get a profile for this nickname.
 622             // Start with conversation context, then go to
 623             // sender context.
 624
 625             if (!empty($originalAuthor) && $originalAuthor->nickname == $nickname) {
 626
 627                 $mentioned = $originalAuthor;
 628
 629             } else if (!empty($originalMentions) &&
 630                        array_key_exists($nickname, $originalMentions)) {
 631
 632                 $mentioned = $originalMentions[$nickname];
 633             } else {
 634                 $mentioned = common_relative_profile($sender, $nickname);
 635             }
 636
 637             if (!empty($mentioned)) {
 638
 639                 $user = User::staticGet('id', $mentioned->id);
 640
 641                 if ($user) {
 642                     $url = common_local_url('userbyid', array('id' => $user->id));
 643                 } else {
 644                     $url = $mentioned->profileurl;
 645                 }
 646
 647                 $mention = array('mentioned' => array($mentioned),
 648                                  'text' => $match[0],
 649                                  'position' => $match[1],
 650                                  'url' => $url);
 651
 652                 if (!empty($mentioned->fullname)) {
 653                     $mention['title'] = $mentioned->fullname;
 654                 }
 655
 656                 $mentions[] = $mention;
 657             }
 658         }
 659
 660         // @#tag => mention of all subscriptions tagged 'tag'
 661
 662         preg_match_all('/(?:^|[\s\.\,\:\;]+)@#([\pL\pN_\-\.]{1,64})/',
 663                        $text,
 664                        $hmatches,
 665                        PREG_OFFSET_CAPTURE);
 666
 667         foreach ($hmatches[1] as $hmatch) {
 668
 669             $tag = common_canonical_tag($hmatch[0]);
 670
 671             $tagged = Profile_tag::getTagged($sender->id, $tag);
 672
 673             $url = common_local_url('subscriptions',
 674                                     array('nickname' => $sender->nickname,
 675                                           'tag' => $tag));
 676
 677             $mentions[] = array('mentioned' => $tagged,
 678                                 'text' => $hmatch[0],
 679                                 'position' => $hmatch[1],
 680                                 'url' => $url);
 681         }
 682
 683         Event::handle('EndFindMentions', array($sender, $text, &$mentions));
 684     }
 685
 686     return $mentions;
 687 }
 688
 689 function common_render_text($text)
 690 {
 691     $r = htmlspecialchars($text);
 692
 693     $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
 694     $r = common_replace_urls_callback($r, 'common_linkify');
 695     $r = preg_replace('/(^|\&quot\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/e', "'\\1#'.common_tag_link('\\2')", $r);
 696     // XXX: machine tags
 697     return $r;
 698 }
 699
 700 function common_replace_urls_callback($text, $callback, $notice_id = null) {
 701     // Start off with a regex
 702     $regex = '#'.
 703     '(?:^|[\s\<\>\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
 704     '('.
 705         '(?:'.
 706             '(?:'. //Known protocols
 707                 '(?:'.
 708                     '(?:(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|irc)://)'.
 709                     '|'.
 710                     '(?:(?:mailto|aim|tel|xmpp):)'.
 711                 ')'.
 712                 '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
 713                 '(?:'.
 714                     '(?:'.
 715                         '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
 716                     ')|(?:'.
 717                         '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
 718                     ')'.
 719                 ')'.
 720             ')'.
 721             '|(?:(?: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
 722             '|(?:'. //IPv6
 723                 '\[?(?:(?:(?:[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})))\]?(?<!:)'.
 724             ')|(?:'. //DNS
 725                 '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
 726                 '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
 727                 //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
 728                 '(?: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|ZW|local|loc|onion)'.
 729             ')(?![\pN\pL\-\_])'.
 730         ')'.
 731         '(?:'.
 732             '(?:\:\d+)?'. //:port
 733             '(?:/[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@]*)?'. // /path
 734             '(?:\?[\pN\pL\$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@\/]*)?'. // ?query string
 735             '(?:\#[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\@/\?\#]*)?'. // #fragment
 736         ')(?<![\?\.\,\#\,])'.
 737     ')'.
 738     '#ixu';
 739     //preg_match_all($regex,$text,$matches);
 740     //print_r($matches);
 741     return preg_replace_callback($regex, curry('callback_helper',$callback,$notice_id) ,$text);
 742 }
 743
 744 function callback_helper($matches, $callback, $notice_id) {
 745     $url=$matches[1];
 746     $left = strpos($matches[0],$url);
 747     $right = $left+strlen($url);
 748
 749     $groupSymbolSets=array(
 750         array(
 751             'left'=>'(',
 752             'right'=>')'
 753         ),
 754         array(
 755             'left'=>'[',
 756             'right'=>']'
 757         ),
 758         array(
 759             'left'=>'{',
 760             'right'=>'}'
 761         ),
 762         array(
 763             'left'=>'<',
 764             'right'=>'>'
 765         )
 766     );
 767     $cannotEndWith=array('.','?',',','#');
 768     $original_url=$url;
 769     do{
 770         $original_url=$url;
 771         foreach($groupSymbolSets as $groupSymbolSet){
 772             if(substr($url,-1)==$groupSymbolSet['right']){
 773                 $group_left_count = substr_count($url,$groupSymbolSet['left']);
 774                 $group_right_count = substr_count($url,$groupSymbolSet['right']);
 775                 if($group_left_count<$group_right_count){
 776                     $right-=1;
 777                     $url=substr($url,0,-1);
 778                 }
 779             }
 780         }
 781         if(in_array(substr($url,-1),$cannotEndWith)){
 782             $right-=1;
 783             $url=substr($url,0,-1);
 784         }
 785     }while($original_url!=$url);
 786
 787     if(empty($notice_id)){
 788         $result = call_user_func_array($callback, array($url));
 789     }else{
 790         $result = call_user_func_array($callback, array(array($url,$notice_id)) );
 791     }
 792     return substr($matches[0],0,$left) . $result . substr($matches[0],$right);
 793 }
 794
 795 if (version_compare(PHP_VERSION, '5.3.0', 'ge')) {
 796     // lambda implementation in a separate file; PHP 5.2 won't parse it.
 797     require_once INSTALLDIR . "/lib/curry.php";
 798 } else {
 799     function curry($fn) {
 800         $args = func_get_args();
 801         array_shift($args);
 802         $id = uniqid('_partial');
 803         $GLOBALS[$id] = array($fn, $args);
 804         return create_function('',
 805                                '$args = func_get_args(); '.
 806                                'return call_user_func_array('.
 807                                '$GLOBALS["'.$id.'"][0],'.
 808                                'array_merge('.
 809                                '$args,'.
 810                                '$GLOBALS["'.$id.'"][1]));');
 811     }
 812 }
 813
 814 function common_linkify($url) {
 815     // It comes in special'd, so we unspecial it before passing to the stringifying
 816     // functions
 817     $url = htmlspecialchars_decode($url);
 818
 819    if(strpos($url, '@') !== false && strpos($url, ':') === false) {
 820        //url is an email address without the mailto: protocol
 821        $canon = "mailto:$url";
 822        $longurl = "mailto:$url";
 823    }else{
 824
 825         $canon = File_redirection::_canonUrl($url);
 826
 827         $longurl_data = File_redirection::where($canon);
 828         if (is_array($longurl_data)) {
 829             $longurl = $longurl_data['url'];
 830         } elseif (is_string($longurl_data)) {
 831             $longurl = $longurl_data;
 832         } else {
 833             throw new ServerException("Can't linkify url '$url'");
 834         }
 835     }
 836     $attrs = array('href' => $canon, 'title' => $longurl, 'rel' => 'external');
 837
 838     $is_attachment = false;
 839     $attachment_id = null;
 840     $has_thumb = false;
 841
 842     // Check to see whether this is a known "attachment" URL.
 843
 844     $f = File::staticGet('url', $longurl);
 845
 846     if (empty($f)) {
 847         // XXX: this writes to the database. :<
 848         $f = File::processNew($longurl);
 849     }
 850
 851     if (!empty($f)) {
 852         if ($f->getEnclosure() || File_oembed::staticGet('file_id',$f->id)) {
 853             $is_attachment = true;
 854             $attachment_id = $f->id;
 855
 856             $thumb = File_thumbnail::staticGet('file_id', $f->id);
 857             if (!empty($thumb)) {
 858                 $has_thumb = true;
 859             }
 860         }
 861     }
 862
 863     // Add clippy
 864     if ($is_attachment) {
 865         $attrs['class'] = 'attachment';
 866         if ($has_thumb) {
 867             $attrs['class'] = 'attachment thumbnail';
 868         }
 869         $attrs['id'] = "attachment-{$attachment_id}";
 870     }
 871
 872     return XMLStringer::estring('a', $attrs, $url);
 873 }
 874
 875 function common_shorten_links($text, $always = false)
 876 {
 877     $maxLength = Notice::maxContent();
 878     if (!$always && ($maxLength == 0 || mb_strlen($text) <= $maxLength)) return $text;
 879     return common_replace_urls_callback($text, array('File_redirection', 'makeShort'));
 880 }
 881
 882 function common_xml_safe_str($str)
 883 {
 884     // Replace common eol and extra whitespace input chars
 885     $unWelcome = array(
 886         "\t",  // tab
 887         "\n",  // newline
 888         "\r",  // cr
 889         "\0",  // null byte eos
 890         "\x0B" // vertical tab
 891     );
 892
 893     $replacement = array(
 894         ' ', // single space
 895         ' ',
 896         '',  // nothing
 897         '',
 898         ' '
 899     );
 900
 901     $str = str_replace($unWelcome, $replacement, $str);
 902
 903     // Neutralize any additional control codes and UTF-16 surrogates
 904     // (Twitter uses '*')
 905     return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
 906 }
 907
 908 function common_tag_link($tag)
 909 {
 910     $canonical = common_canonical_tag($tag);
 911     if (common_config('singleuser', 'enabled')) {
 912         // regular TagAction isn't set up in 1user mode
 913         $url = common_local_url('showstream',
 914                                 array('nickname' => common_config('singleuser', 'nickname'),
 915                                       'tag' => $canonical));
 916     } else {
 917         $url = common_local_url('tag', array('tag' => $canonical));
 918     }
 919     $xs = new XMLStringer();
 920     $xs->elementStart('span', 'tag');
 921     $xs->element('a', array('href' => $url,
 922                             'rel' => 'tag'),
 923                  $tag);
 924     $xs->elementEnd('span');
 925     return $xs->getString();
 926 }
 927
 928 function common_canonical_tag($tag)
 929 {
 930   $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
 931   return str_replace(array('-', '_', '.'), '', $tag);
 932 }
 933
 934 function common_valid_profile_tag($str)
 935 {
 936     return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
 937 }
 938
 939 function common_group_link($sender_id, $nickname)
 940 {
 941     $sender = Profile::staticGet($sender_id);
 942     $group = User_group::getForNickname($nickname, $sender);
 943     if ($sender && $group && $sender->isMember($group)) {
 944         $attrs = array('href' => $group->permalink(),
 945                        'class' => 'url');
 946         if (!empty($group->fullname)) {
 947             $attrs['title'] = $group->fullname . ' (' . $group->nickname . ')';
 948         }
 949         $xs = new XMLStringer();
 950         $xs->elementStart('span', 'vcard');
 951         $xs->elementStart('a', $attrs);
 952         $xs->element('span', 'fn nickname', $nickname);
 953         $xs->elementEnd('a');
 954         $xs->elementEnd('span');
 955         return $xs->getString();
 956     } else {
 957         return $nickname;
 958     }
 959 }
 960
 961 function common_relative_profile($sender, $nickname, $dt=null)
 962 {
 963     // Try to find profiles this profile is subscribed to that have this nickname
 964     $recipient = new Profile();
 965     // XXX: use a join instead of a subquery
 966     $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
 967     $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
 968     if ($recipient->find(true)) {
 969         // XXX: should probably differentiate between profiles with
 970         // the same name by date of most recent update
 971         return $recipient;
 972     }
 973     // Try to find profiles that listen to this profile and that have this nickname
 974     $recipient = new Profile();
 975     // XXX: use a join instead of a subquery
 976     $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
 977     $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
 978     if ($recipient->find(true)) {
 979         // XXX: should probably differentiate between profiles with
 980         // the same name by date of most recent update
 981         return $recipient;
 982     }
 983     // If this is a local user, try to find a local user with that nickname.
 984     $sender = User::staticGet($sender->id);
 985     if ($sender) {
 986         $recipient_user = User::staticGet('nickname', $nickname);
 987         if ($recipient_user) {
 988             return $recipient_user->getProfile();
 989         }
 990     }
 991     // Otherwise, no links. @messages from local users to remote users,
 992     // or from remote users to other remote users, are just
 993     // outside our ability to make intelligent guesses about
 994     return null;
 995 }
 996
 997 function common_local_url($action, $args=null, $params=null, $fragment=null, $addSession=true)
 998 {
 999     $r = Router::get();
1000     $path = $r->build($action, $args, $params, $fragment);
1001
1002     $ssl = common_is_sensitive($action);
1003
1004     if (common_config('site','fancy')) {
1005         $url = common_path(mb_substr($path, 1), $ssl, $addSession);
1006     } else {
1007         if (mb_strpos($path, '/index.php') === 0) {
1008             $url = common_path(mb_substr($path, 1), $ssl, $addSession);
1009         } else {
1010             $url = common_path('index.php'.$path, $ssl, $addSession);
1011         }
1012     }
1013     return $url;
1014 }
1015
1016 function common_is_sensitive($action)
1017 {
1018     static $sensitive = array('login', 'register', 'passwordsettings',
1019                               'twittersettings', 'api');
1020     $ssl = null;
1021
1022     if (Event::handle('SensitiveAction', array($action, &$ssl))) {
1023         $ssl = in_array($action, $sensitive);
1024     }
1025
1026     return $ssl;
1027 }
1028
1029 function common_path($relative, $ssl=false, $addSession=true)
1030 {
1031     $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
1032
1033     if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
1034         || common_config('site', 'ssl') === 'always') {
1035         $proto = 'https';
1036         if (is_string(common_config('site', 'sslserver')) &&
1037             mb_strlen(common_config('site', 'sslserver')) > 0) {
1038             $serverpart = common_config('site', 'sslserver');
1039         } else if (common_config('site', 'server')) {
1040             $serverpart = common_config('site', 'server');
1041         } else {
1042             common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1043         }
1044     } else {
1045         $proto = 'http';
1046         if (common_config('site', 'server')) {
1047             $serverpart = common_config('site', 'server');
1048         } else {
1049             common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1050         }
1051     }
1052
1053     if ($addSession) {
1054         $relative = common_inject_session($relative, $serverpart);
1055     }
1056
1057     return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
1058 }
1059
1060 function common_inject_session($url, $serverpart = null)
1061 {
1062     if (common_have_session()) {
1063
1064         if (empty($serverpart)) {
1065             $serverpart = parse_url($url, PHP_URL_HOST);
1066         }
1067
1068         $currentServer = $_SERVER['HTTP_HOST'];
1069
1070         // Are we pointing to another server (like an SSL server?)
1071
1072         if (!empty($currentServer) &&
1073             0 != strcasecmp($currentServer, $serverpart)) {
1074             // Pass the session ID as a GET parameter
1075             $sesspart = session_name() . '=' . session_id();
1076             $i = strpos($url, '?');
1077             if ($i === false) { // no GET params, just append
1078                 $url .= '?' . $sesspart;
1079             } else {
1080                 $url = substr($url, 0, $i + 1).$sesspart.'&'.substr($url, $i + 1);
1081             }
1082         }
1083     }
1084
1085     return $url;
1086 }
1087
1088 function common_date_string($dt)
1089 {
1090     // XXX: do some sexy date formatting
1091     // return date(DATE_RFC822, $dt);
1092     $t = strtotime($dt);
1093     $now = time();
1094     $diff = $now - $t;
1095
1096     if ($now < $t) { // that shouldn't happen!
1097         return common_exact_date($dt);
1098     } else if ($diff < 60) {
1099         // TRANS: Used in notices to indicate when the notice was made compared to now.
1100         return _('a few seconds ago');
1101     } else if ($diff < 92) {
1102         // TRANS: Used in notices to indicate when the notice was made compared to now.
1103         return _('about a minute ago');
1104     } else if ($diff < 3300) {
1105         // XXX: should support plural.
1106         // TRANS: Used in notices to indicate when the notice was made compared to now.
1107         return sprintf(_('about %d minutes ago'), round($diff/60));
1108     } else if ($diff < 5400) {
1109         // TRANS: Used in notices to indicate when the notice was made compared to now.
1110         return _('about an hour ago');
1111     } else if ($diff < 22 * 3600) {
1112         // XXX: should support plural.
1113         // TRANS: Used in notices to indicate when the notice was made compared to now.
1114         return sprintf(_('about %d hours ago'), round($diff/3600));
1115     } else if ($diff < 37 * 3600) {
1116         // TRANS: Used in notices to indicate when the notice was made compared to now.
1117         return _('about a day ago');
1118     } else if ($diff < 24 * 24 * 3600) {
1119         // XXX: should support plural.
1120         // TRANS: Used in notices to indicate when the notice was made compared to now.
1121         return sprintf(_('about %d days ago'), round($diff/(24*3600)));
1122     } else if ($diff < 46 * 24 * 3600) {
1123         // TRANS: Used in notices to indicate when the notice was made compared to now.
1124         return _('about a month ago');
1125     } else if ($diff < 330 * 24 * 3600) {
1126         // XXX: should support plural.
1127         // TRANS: Used in notices to indicate when the notice was made compared to now.
1128         return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
1129     } else if ($diff < 480 * 24 * 3600) {
1130         // TRANS: Used in notices to indicate when the notice was made compared to now.
1131         return _('about a year ago');
1132     } else {
1133         return common_exact_date($dt);
1134     }
1135 }
1136
1137 function common_exact_date($dt)
1138 {
1139     static $_utc;
1140     static $_siteTz;
1141
1142     if (!$_utc) {
1143         $_utc = new DateTimeZone('UTC');
1144         $_siteTz = new DateTimeZone(common_timezone());
1145     }
1146
1147     $dateStr = date('d F Y H:i:s', strtotime($dt));
1148     $d = new DateTime($dateStr, $_utc);
1149     $d->setTimezone($_siteTz);
1150     return $d->format(DATE_RFC850);
1151 }
1152
1153 function common_date_w3dtf($dt)
1154 {
1155     $dateStr = date('d F Y H:i:s', strtotime($dt));
1156     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1157     $d->setTimezone(new DateTimeZone(common_timezone()));
1158     return $d->format(DATE_W3C);
1159 }
1160
1161 function common_date_rfc2822($dt)
1162 {
1163     $dateStr = date('d F Y H:i:s', strtotime($dt));
1164     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1165     $d->setTimezone(new DateTimeZone(common_timezone()));
1166     return $d->format('r');
1167 }
1168
1169 function common_date_iso8601($dt)
1170 {
1171     $dateStr = date('d F Y H:i:s', strtotime($dt));
1172     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1173     $d->setTimezone(new DateTimeZone(common_timezone()));
1174     return $d->format('c');
1175 }
1176
1177 function common_sql_now()
1178 {
1179     return common_sql_date(time());
1180 }
1181
1182 function common_sql_date($datetime)
1183 {
1184     return strftime('%Y-%m-%d %H:%M:%S', $datetime);
1185 }
1186
1187 /**
1188  * Return an SQL fragment to calculate an age-based weight from a given
1189  * timestamp or datetime column.
1190  *
1191  * @param string $column name of field we're comparing against current time
1192  * @param integer $dropoff divisor for age in seconds before exponentiation
1193  * @return string SQL fragment
1194  */
1195 function common_sql_weight($column, $dropoff)
1196 {
1197     if (common_config('db', 'type') == 'pgsql') {
1198         // PostgreSQL doesn't support timestampdiff function.
1199         // @fixme will this use the right time zone?
1200         // @fixme does this handle cross-year subtraction correctly?
1201         return "sum(exp(-extract(epoch from (now() - $column)) / $dropoff))";
1202     } else {
1203         return "sum(exp(timestampdiff(second, utc_timestamp(), $column) / $dropoff))";
1204     }
1205 }
1206
1207 function common_redirect($url, $code=307)
1208 {
1209     static $status = array(301 => "Moved Permanently",
1210                            302 => "Found",
1211                            303 => "See Other",
1212                            307 => "Temporary Redirect");
1213
1214     header('HTTP/1.1 '.$code.' '.$status[$code]);
1215     header("Location: $url");
1216
1217     $xo = new XMLOutputter();
1218     $xo->startXML('a',
1219                   '-//W3C//DTD XHTML 1.0 Strict//EN',
1220                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1221     $xo->element('a', array('href' => $url), $url);
1222     $xo->endXML();
1223     exit;
1224 }
1225
1226 function common_broadcast_notice($notice, $remote=false)
1227 {
1228     // DO NOTHING!
1229 }
1230
1231 // Stick the notice on the queue
1232
1233 function common_enqueue_notice($notice)
1234 {
1235     static $localTransports = array('omb',
1236                                     'ping');
1237
1238     $transports = array();
1239     if (common_config('sms', 'enabled')) {
1240         $transports[] = 'sms';
1241     }
1242     if (Event::hasHandler('HandleQueuedNotice')) {
1243         $transports[] = 'plugin';
1244     }
1245
1246     $xmpp = common_config('xmpp', 'enabled');
1247
1248     if ($xmpp) {
1249         $transports[] = 'jabber';
1250     }
1251
1252     // @fixme move these checks into QueueManager and/or individual handlers
1253     if ($notice->is_local == Notice::LOCAL_PUBLIC ||
1254         $notice->is_local == Notice::LOCAL_NONPUBLIC) {
1255         $transports = array_merge($transports, $localTransports);
1256         if ($xmpp) {
1257             $transports[] = 'public';
1258         }
1259     }
1260
1261     if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
1262
1263         $qm = QueueManager::get();
1264
1265         foreach ($transports as $transport)
1266         {
1267             $qm->enqueue($notice, $transport);
1268         }
1269
1270         Event::handle('EndEnqueueNotice', array($notice, $transports));
1271     }
1272
1273     return true;
1274 }
1275
1276 /**
1277  * Broadcast profile updates to OMB and other remote subscribers.
1278  *
1279  * Since this may be slow with a lot of subscribers or bad remote sites,
1280  * this is run through the background queues if possible.
1281  */
1282 function common_broadcast_profile(Profile $profile)
1283 {
1284     $qm = QueueManager::get();
1285     $qm->enqueue($profile, "profile");
1286     return true;
1287 }
1288
1289 function common_profile_url($nickname)
1290 {
1291     return common_local_url('showstream', array('nickname' => $nickname),
1292                             null, null, false);
1293 }
1294
1295 // Should make up a reasonable root URL
1296
1297 function common_root_url($ssl=false)
1298 {
1299     $url = common_path('', $ssl, false);
1300     $i = strpos($url, '?');
1301     if ($i !== false) {
1302         $url = substr($url, 0, $i);
1303     }
1304     return $url;
1305 }
1306
1307 // returns $bytes bytes of random data as a hexadecimal string
1308 // "good" here is a goal and not a guarantee
1309
1310 function common_good_rand($bytes)
1311 {
1312     // XXX: use random.org...?
1313     if (@file_exists('/dev/urandom')) {
1314         return common_urandom($bytes);
1315     } else { // FIXME: this is probably not good enough
1316         return common_mtrand($bytes);
1317     }
1318 }
1319
1320 function common_urandom($bytes)
1321 {
1322     $h = fopen('/dev/urandom', 'rb');
1323     // should not block
1324     $src = fread($h, $bytes);
1325     fclose($h);
1326     $enc = '';
1327     for ($i = 0; $i < $bytes; $i++) {
1328         $enc .= sprintf("%02x", (ord($src[$i])));
1329     }
1330     return $enc;
1331 }
1332
1333 function common_mtrand($bytes)
1334 {
1335     $enc = '';
1336     for ($i = 0; $i < $bytes; $i++) {
1337         $enc .= sprintf("%02x", mt_rand(0, 255));
1338     }
1339     return $enc;
1340 }
1341
1342 /**
1343  * Record the given URL as the return destination for a future
1344  * form submission, to be read by common_get_returnto().
1345  *
1346  * @param string $url
1347  *
1348  * @fixme as a session-global setting, this can allow multiple forms
1349  * to conflict and overwrite each others' returnto destinations if
1350  * the user has multiple tabs or windows open.
1351  *
1352  * Should refactor to index with a token or otherwise only pass the
1353  * data along its intended path.
1354  */
1355 function common_set_returnto($url)
1356 {
1357     common_ensure_session();
1358     $_SESSION['returnto'] = $url;
1359 }
1360
1361 /**
1362  * Fetch a return-destination URL previously recorded by
1363  * common_set_returnto().
1364  *
1365  * @return mixed URL string or null
1366  *
1367  * @fixme as a session-global setting, this can allow multiple forms
1368  * to conflict and overwrite each others' returnto destinations if
1369  * the user has multiple tabs or windows open.
1370  *
1371  * Should refactor to index with a token or otherwise only pass the
1372  * data along its intended path.
1373  */
1374 function common_get_returnto()
1375 {
1376     common_ensure_session();
1377     return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
1378 }
1379
1380 function common_timestamp()
1381 {
1382     return date('YmdHis');
1383 }
1384
1385 function common_ensure_syslog()
1386 {
1387     static $initialized = false;
1388     if (!$initialized) {
1389         openlog(common_config('syslog', 'appname'), 0,
1390             common_config('syslog', 'facility'));
1391         $initialized = true;
1392     }
1393 }
1394
1395 function common_log_line($priority, $msg)
1396 {
1397     static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1398                                       'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1399     return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . PHP_EOL;
1400 }
1401
1402 function common_request_id()
1403 {
1404     $pid = getmypid();
1405     $server = common_config('site', 'server');
1406     if (php_sapi_name() == 'cli') {
1407         $script = basename($_SERVER['PHP_SELF']);
1408         return "$server:$script:$pid";
1409     } else {
1410         static $req_id = null;
1411         if (!isset($req_id)) {
1412             $req_id = substr(md5(mt_rand()), 0, 8);
1413         }
1414         if (isset($_SERVER['REQUEST_URI'])) {
1415             $url = $_SERVER['REQUEST_URI'];
1416         }
1417         $method = $_SERVER['REQUEST_METHOD'];
1418         return "$server:$pid.$req_id $method $url";
1419     }
1420 }
1421
1422 function common_log($priority, $msg, $filename=null)
1423 {
1424     if(Event::handle('StartLog', array(&$priority, &$msg, &$filename))){
1425         $msg = '[' . common_request_id() . '] ' . $msg;
1426         $logfile = common_config('site', 'logfile');
1427         if ($logfile) {
1428             $log = fopen($logfile, "a");
1429             if ($log) {
1430                 $output = common_log_line($priority, $msg);
1431                 fwrite($log, $output);
1432                 fclose($log);
1433             }
1434         } else {
1435             common_ensure_syslog();
1436             syslog($priority, $msg);
1437         }
1438         Event::handle('EndLog', array($priority, $msg, $filename));
1439     }
1440 }
1441
1442 function common_debug($msg, $filename=null)
1443 {
1444     if ($filename) {
1445         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1446     } else {
1447         common_log(LOG_DEBUG, $msg);
1448     }
1449 }
1450
1451 function common_log_db_error(&$object, $verb, $filename=null)
1452 {
1453     $objstr = common_log_objstring($object);
1454     $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1455     common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1456 }
1457
1458 function common_log_objstring(&$object)
1459 {
1460     if (is_null($object)) {
1461         return "null";
1462     }
1463     if (!($object instanceof DB_DataObject)) {
1464         return "(unknown)";
1465     }
1466     $arr = $object->toArray();
1467     $fields = array();
1468     foreach ($arr as $k => $v) {
1469         if (is_object($v)) {
1470             $fields[] = "$k='".get_class($v)."'";
1471         } else {
1472             $fields[] = "$k='$v'";
1473         }
1474     }
1475     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1476     return $objstring;
1477 }
1478
1479 function common_valid_http_url($url)
1480 {
1481     return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1482 }
1483
1484 function common_valid_tag($tag)
1485 {
1486     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1487         return (Validate::email($matches[1]) ||
1488                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1489     }
1490     return false;
1491 }
1492
1493 /**
1494  * Determine if given domain or address literal is valid
1495  * eg for use in JIDs and URLs. Does not check if the domain
1496  * exists!
1497  *
1498  * @param string $domain
1499  * @return boolean valid or not
1500  */
1501 function common_valid_domain($domain)
1502 {
1503     $octet = "(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])";
1504     $ipv4 = "(?:$octet(?:\.$octet){3})";
1505     if (preg_match("/^$ipv4$/u", $domain)) return true;
1506
1507     $group = "(?:[0-9a-f]{1,4})";
1508     $ipv6 = "(?:\[($group(?::$group){0,7})?(::)?($group(?::$group){0,7})?\])"; // http://tools.ietf.org/html/rfc3513#section-2.2
1509
1510     if (preg_match("/^$ipv6$/ui", $domain, $matches)) {
1511         $before = explode(":", $matches[1]);
1512         $zeroes = $matches[2];
1513         $after = explode(":", $matches[3]);
1514         if ($zeroes) {
1515             $min = 0;
1516             $max = 7;
1517         } else {
1518             $min = 1;
1519             $max = 8;
1520         }
1521         $explicit = count($before) + count($after);
1522         if ($explicit < $min || $explicit > $max) {
1523             return false;
1524         }
1525         return true;
1526     }
1527
1528     try {
1529         require_once "Net/IDNA.php";
1530         $idn = Net_IDNA::getInstance();
1531         $domain = $idn->encode($domain);
1532     } catch (Exception $e) {
1533         return false;
1534     }
1535
1536     $subdomain = "(?:[a-z0-9][a-z0-9-]*)"; // @fixme
1537     $fqdn = "(?:$subdomain(?:\.$subdomain)*\.?)";
1538
1539     return preg_match("/^$fqdn$/ui", $domain);
1540 }
1541
1542 /* Following functions are copied from MediaWiki GlobalFunctions.php
1543  * and written by Evan Prodromou. */
1544
1545 function common_accept_to_prefs($accept, $def = '*/*')
1546 {
1547     // No arg means accept anything (per HTTP spec)
1548     if(!$accept) {
1549         return array($def => 1);
1550     }
1551
1552     $prefs = array();
1553
1554     $parts = explode(',', $accept);
1555
1556     foreach($parts as $part) {
1557         // FIXME: doesn't deal with params like 'text/html; level=1'
1558         @list($value, $qpart) = explode(';', trim($part));
1559         $match = array();
1560         if(!isset($qpart)) {
1561             $prefs[$value] = 1;
1562         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1563             $prefs[$value] = $match[1];
1564         }
1565     }
1566
1567     return $prefs;
1568 }
1569
1570 function common_mime_type_match($type, $avail)
1571 {
1572     if(array_key_exists($type, $avail)) {
1573         return $type;
1574     } else {
1575         $parts = explode('/', $type);
1576         if(array_key_exists($parts[0] . '/*', $avail)) {
1577             return $parts[0] . '/*';
1578         } elseif(array_key_exists('*/*', $avail)) {
1579             return '*/*';
1580         } else {
1581             return null;
1582         }
1583     }
1584 }
1585
1586 function common_negotiate_type($cprefs, $sprefs)
1587 {
1588     $combine = array();
1589
1590     foreach(array_keys($sprefs) as $type) {
1591         $parts = explode('/', $type);
1592         if($parts[1] != '*') {
1593             $ckey = common_mime_type_match($type, $cprefs);
1594             if($ckey) {
1595                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1596             }
1597         }
1598     }
1599
1600     foreach(array_keys($cprefs) as $type) {
1601         $parts = explode('/', $type);
1602         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1603             $skey = common_mime_type_match($type, $sprefs);
1604             if($skey) {
1605                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1606             }
1607         }
1608     }
1609
1610     $bestq = 0;
1611     $besttype = 'text/html';
1612
1613     foreach(array_keys($combine) as $type) {
1614         if($combine[$type] > $bestq) {
1615             $besttype = $type;
1616             $bestq = $combine[$type];
1617         }
1618     }
1619
1620     if ('text/html' === $besttype) {
1621         return "text/html; charset=utf-8";
1622     }
1623     return $besttype;
1624 }
1625
1626 function common_config($main, $sub)
1627 {
1628     global $config;
1629     return (array_key_exists($main, $config) &&
1630             array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
1631 }
1632
1633 function common_copy_args($from)
1634 {
1635     $to = array();
1636     $strip = get_magic_quotes_gpc();
1637     foreach ($from as $k => $v) {
1638         if($strip) {
1639             if(is_array($v)) {
1640                 $to[$k] = common_copy_args($v);
1641             } else {
1642                 $to[$k] = stripslashes($v);
1643             }
1644         } else {
1645             $to[$k] = $v;
1646         }
1647     }
1648     return $to;
1649 }
1650
1651 /**
1652  * Neutralise the evil effects of magic_quotes_gpc in the current request.
1653  * This is used before handing a request off to OAuthRequest::from_request.
1654  * @fixme Doesn't consider vars other than _POST and _GET?
1655  * @fixme Can't be undone and could corrupt data if run twice.
1656  */
1657 function common_remove_magic_from_request()
1658 {
1659     if(get_magic_quotes_gpc()) {
1660         $_POST=array_map('stripslashes',$_POST);
1661         $_GET=array_map('stripslashes',$_GET);
1662     }
1663 }
1664
1665 function common_user_uri(&$user)
1666 {
1667     return common_local_url('userbyid', array('id' => $user->id),
1668                             null, null, false);
1669 }
1670
1671 function common_notice_uri(&$notice)
1672 {
1673     return common_local_url('shownotice',
1674                             array('notice' => $notice->id),
1675                             null, null, false);
1676 }
1677
1678 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1679
1680 function common_confirmation_code($bits)
1681 {
1682     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1683     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1684     $chars = ceil($bits/5);
1685     $code = '';
1686     for ($i = 0; $i < $chars; $i++) {
1687         // XXX: convert to string and back
1688         $num = hexdec(common_good_rand(1));
1689         // XXX: randomness is too precious to throw away almost
1690         // 40% of the bits we get!
1691         $code .= $codechars[$num%32];
1692     }
1693     return $code;
1694 }
1695
1696 // convert markup to HTML
1697
1698 function common_markup_to_html($c)
1699 {
1700     $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1701     $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1702     $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1703     return Markdown($c);
1704 }
1705
1706 function common_profile_uri($profile)
1707 {
1708     if (!$profile) {
1709         return null;
1710     }
1711     $user = User::staticGet($profile->id);
1712     if ($user) {
1713         return $user->uri;
1714     }
1715
1716     $remote = Remote_profile::staticGet($profile->id);
1717     if ($remote) {
1718         return $remote->uri;
1719     }
1720     // XXX: this is a very bad profile!
1721     return null;
1722 }
1723
1724 function common_canonical_sms($sms)
1725 {
1726     // strip non-digits
1727     preg_replace('/\D/', '', $sms);
1728     return $sms;
1729 }
1730
1731 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1732 {
1733     switch ($errno) {
1734
1735      case E_ERROR:
1736      case E_COMPILE_ERROR:
1737      case E_CORE_ERROR:
1738      case E_USER_ERROR:
1739      case E_PARSE:
1740      case E_RECOVERABLE_ERROR:
1741         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
1742         die();
1743         break;
1744
1745      case E_WARNING:
1746      case E_COMPILE_WARNING:
1747      case E_CORE_WARNING:
1748      case E_USER_WARNING:
1749         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1750         break;
1751
1752      case E_NOTICE:
1753      case E_USER_NOTICE:
1754         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1755         break;
1756
1757      case E_STRICT:
1758      case E_DEPRECATED:
1759      case E_USER_DEPRECATED:
1760         // XXX: config variable to log this stuff, too
1761         break;
1762
1763      default:
1764         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
1765         die();
1766         break;
1767     }
1768
1769     // FIXME: show error page if we're on the Web
1770     /* Don't execute PHP internal error handler */
1771     return true;
1772 }
1773
1774 function common_session_token()
1775 {
1776     common_ensure_session();
1777     if (!array_key_exists('token', $_SESSION)) {
1778         $_SESSION['token'] = common_good_rand(64);
1779     }
1780     return $_SESSION['token'];
1781 }
1782
1783 function common_cache_key($extra)
1784 {
1785     return Cache::key($extra);
1786 }
1787
1788 function common_keyize($str)
1789 {
1790     return Cache::keyize($str);
1791 }
1792
1793 function common_memcache()
1794 {
1795     return Cache::instance();
1796 }
1797
1798 function common_license_terms($uri)
1799 {
1800     if(preg_match('/creativecommons.org\/licenses\/([^\/]+)/', $uri, $matches)) {
1801         return explode('-',$matches[1]);
1802     }
1803     return array($uri);
1804 }
1805
1806 function common_compatible_license($from, $to)
1807 {
1808     $from_terms = common_license_terms($from);
1809     // public domain and cc-by are compatible with everything
1810     if(count($from_terms) == 1 && ($from_terms[0] == 'publicdomain' || $from_terms[0] == 'by')) {
1811         return true;
1812     }
1813     $to_terms = common_license_terms($to);
1814     // sa is compatible across versions. IANAL
1815     if(in_array('sa',$from_terms) || in_array('sa',$to_terms)) {
1816         return count(array_diff($from_terms, $to_terms)) == 0;
1817     }
1818     // XXX: better compatibility check needed here!
1819     // Should at least normalise URIs
1820     return ($from == $to);
1821 }
1822
1823 /**
1824  * returns a quoted table name, if required according to config
1825  */
1826 function common_database_tablename($tablename)
1827 {
1828
1829   if(common_config('db','quote_identifiers')) {
1830       $tablename = '"'. $tablename .'"';
1831   }
1832   //table prefixes could be added here later
1833   return $tablename;
1834 }
1835
1836 /**
1837  * Shorten a URL with the current user's configured shortening service,
1838  * or ur1.ca if configured, or not at all if no shortening is set up.
1839  * Length is not considered.
1840  *
1841  * @param string $long_url
1842  * @return string may return the original URL if shortening failed
1843  *
1844  * @fixme provide a way to specify a particular shortener
1845  * @fixme provide a way to specify to use a given user's shortening preferences
1846  */
1847 function common_shorten_url($long_url)
1848 {
1849     $long_url = trim($long_url);
1850     $user = common_current_user();
1851     if (empty($user)) {
1852         // common current user does not find a user when called from the XMPP daemon
1853         // therefore we'll set one here fix, so that XMPP given URLs may be shortened
1854         $shortenerName = 'ur1.ca';
1855     } else {
1856         $shortenerName = $user->urlshorteningservice;
1857     }
1858
1859     if(Event::handle('StartShortenUrl', array($long_url,$shortenerName,&$shortenedUrl))){
1860         //URL wasn't shortened, so return the long url
1861         return $long_url;
1862     }else{
1863         //URL was shortened, so return the result
1864         return trim($shortenedUrl);
1865     }
1866 }
1867
1868 /**
1869  * @return mixed array($proxy, $ip) for web requests; proxy may be null
1870  *               null if not a web request
1871  *
1872  * @fixme X-Forwarded-For can be chained by multiple proxies;
1873           we should parse the list and provide a cleaner array
1874  * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
1875  * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
1876  *        use function to get exact request headers from Apache if possible.
1877  */
1878 function common_client_ip()
1879 {
1880     if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
1881         return null;
1882     }
1883
1884     if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
1885         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1886             $proxy = $_SERVER['HTTP_CLIENT_IP'];
1887         } else {
1888             $proxy = $_SERVER['REMOTE_ADDR'];
1889         }
1890         $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
1891     } else {
1892         $proxy = null;
1893         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1894             $ip = $_SERVER['HTTP_CLIENT_IP'];
1895         } else {
1896             $ip = $_SERVER['REMOTE_ADDR'];
1897         }
1898     }
1899
1900     return array($proxy, $ip);
1901 }
1902
1903 function common_url_to_nickname($url)
1904 {
1905     static $bad = array('query', 'user', 'password', 'port', 'fragment');
1906
1907     $parts = parse_url($url);
1908
1909     # If any of these parts exist, this won't work
1910
1911     foreach ($bad as $badpart) {
1912         if (array_key_exists($badpart, $parts)) {
1913             return null;
1914         }
1915     }
1916
1917     # We just have host and/or path
1918
1919     # If it's just a host...
1920     if (array_key_exists('host', $parts) &&
1921         (!array_key_exists('path', $parts) || strcmp($parts['path'], '/') == 0))
1922     {
1923         $hostparts = explode('.', $parts['host']);
1924
1925         # Try to catch common idiom of nickname.service.tld
1926
1927         if ((count($hostparts) > 2) &&
1928             (strlen($hostparts[count($hostparts) - 2]) > 3) && # try to skip .co.uk, .com.au
1929             (strcmp($hostparts[0], 'www') != 0))
1930         {
1931             return common_nicknamize($hostparts[0]);
1932         } else {
1933             # Do the whole hostname
1934             return common_nicknamize($parts['host']);
1935         }
1936     } else {
1937         if (array_key_exists('path', $parts)) {
1938             # Strip starting, ending slashes
1939             $path = preg_replace('@/$@', '', $parts['path']);
1940             $path = preg_replace('@^/@', '', $path);
1941             $path = basename($path);
1942
1943             // Hack for MediaWiki user pages, in the form:
1944             // http://example.com/wiki/User:Myname
1945             // ('User' may be localized.)
1946             if (strpos($path, ':')) {
1947                 $parts = array_filter(explode(':', $path));
1948                 $path = $parts[count($parts) - 1];
1949             }
1950
1951             if ($path) {
1952                 return common_nicknamize($path);
1953             }
1954         }
1955     }
1956
1957     return null;
1958 }
1959
1960 function common_nicknamize($str)
1961 {
1962     $str = preg_replace('/\W/', '', $str);
1963     return strtolower($str);
1964 }