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