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