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