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', common_canonical_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($r, $notice);
 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($text, $notice)
 435 {
 436     $mentions = common_find_mentions($text, $notice);
 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($text, $notice)
 491 {
 492     $mentions = array();
 493
 494     $sender = Profile::staticGet('id', $notice->profile_id);
 495
 496     if (empty($sender)) {
 497         return $mentions;
 498     }
 499
 500     if (Event::handle('StartFindMentions', array($sender, $text, &$mentions))) {
 501
 502         // Get the context of the original notice, if any
 503
 504         $originalAuthor   = null;
 505         $originalNotice   = null;
 506         $originalMentions = array();
 507
 508         // Is it a reply?
 509
 510         if (!empty($notice) && !empty($notice->reply_to)) {
 511             $originalNotice = Notice::staticGet('id', $notice->reply_to);
 512             if (!empty($originalNotice)) {
 513                 $originalAuthor = Profile::staticGet('id', $originalNotice->profile_id);
 514
 515                 $ids = $originalNotice->getReplies();
 516
 517                 foreach ($ids as $id) {
 518                     $repliedTo = Profile::staticGet('id', $id);
 519                     if (!empty($repliedTo)) {
 520                         $originalMentions[$repliedTo->nickname] = $repliedTo;
 521                     }
 522                 }
 523             }
 524         }
 525
 526         preg_match_all('/^T ([A-Z0-9]{1,64}) /',
 527                        $text,
 528                        $tmatches,
 529                        PREG_OFFSET_CAPTURE);
 530
 531         preg_match_all('/(?:^|\s+)@(['.NICKNAME_FMT.']{1,64})/',
 532                        $text,
 533                        $atmatches,
 534                        PREG_OFFSET_CAPTURE);
 535
 536         $matches = array_merge($tmatches[1], $atmatches[1]);
 537
 538         foreach ($matches as $match) {
 539
 540             $nickname = common_canonical_nickname($match[0]);
 541
 542             // Try to get a profile for this nickname.
 543             // Start with conversation context, then go to
 544             // sender context.
 545
 546             if (!empty($originalAuthor) && $originalAuthor->nickname == $nickname) {
 547
 548                 $mentioned = $originalAuthor;
 549
 550             } else if (!empty($originalMentions) &&
 551                        array_key_exists($nickname, $originalMentions)) {
 552
 553                 $mention = $originalMentions[$nickname];
 554             } else {
 555                 $mentioned = common_relative_profile($sender, $nickname);
 556             }
 557
 558             if (!empty($mentioned)) {
 559
 560                 $user = User::staticGet('id', $mentioned->id);
 561
 562                 if ($user) {
 563                     $url = common_local_url('userbyid', array('id' => $user->id));
 564                 } else {
 565                     $url = $mentioned->profileurl;
 566                 }
 567
 568                 $mention = array('mentioned' => array($mentioned),
 569                                  'text' => $match[0],
 570                                  'position' => $match[1],
 571                                  'url' => $url);
 572
 573                 if (!empty($mentioned->fullname)) {
 574                     $mention['title'] = $mentioned->fullname;
 575                 }
 576
 577                 $mentions[] = $mention;
 578             }
 579         }
 580
 581         // @#tag => mention of all subscriptions tagged 'tag'
 582
 583         preg_match_all('/(?:^|[\s\.\,\:\;]+)@#([\pL\pN_\-\.]{1,64})/',
 584                        $text,
 585                        $hmatches,
 586                        PREG_OFFSET_CAPTURE);
 587
 588         foreach ($hmatches[1] as $hmatch) {
 589
 590             $tag = common_canonical_tag($hmatch[0]);
 591
 592             $tagged = Profile_tag::getTagged($sender->id, $tag);
 593
 594             $url = common_local_url('subscriptions',
 595                                     array('nickname' => $sender->nickname,
 596                                           'tag' => $tag));
 597
 598             $mentions[] = array('mentioned' => $tagged,
 599                                 'text' => $hmatch[0],
 600                                 'position' => $hmatch[1],
 601                                 'url' => $url);
 602         }
 603
 604         Event::handle('EndFindMentions', array($sender, $text, &$mentions));
 605     }
 606
 607     return $mentions;
 608 }
 609
 610 function common_render_text($text)
 611 {
 612     $r = htmlspecialchars($text);
 613
 614     $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
 615     $r = common_replace_urls_callback($r, 'common_linkify');
 616     $r = preg_replace('/(^|\&quot\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/e', "'\\1#'.common_tag_link('\\2')", $r);
 617     // XXX: machine tags
 618     return $r;
 619 }
 620
 621 function common_replace_urls_callback($text, $callback, $notice_id = null) {
 622     // Start off with a regex
 623     $regex = '#'.
 624     '(?:^|[\s\<\>\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
 625     '('.
 626         '(?:'.
 627             '(?:'. //Known protocols
 628                 '(?:'.
 629                     '(?:(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|irc)://)'.
 630                     '|'.
 631                     '(?:(?:mailto|aim|tel|xmpp):)'.
 632                 ')'.
 633                 '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
 634                 '(?:'.
 635                     '(?:'.
 636                         '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
 637                     ')|(?:'.
 638                         '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
 639                     ')'.
 640                 ')'.
 641             ')'.
 642             '|(?:(?: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
 643             '|(?:'. //IPv6
 644                 '\[?(?:(?:(?:[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})))\]?(?<!:)'.
 645             ')|(?:'. //DNS
 646                 '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
 647                 '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
 648                 //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
 649                 '(?: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)'.
 650             ')(?![\pN\pL\-\_])'.
 651         ')'.
 652         '(?:'.
 653             '(?:\:\d+)?'. //:port
 654             '(?:/[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@]*)?'. // /path
 655             '(?:\?[\pN\pL\$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@\/]*)?'. // ?query string
 656             '(?:\#[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\@/\?\#]*)?'. // #fragment
 657         ')(?<![\?\.\,\#\,])'.
 658     ')'.
 659     '#ixu';
 660     //preg_match_all($regex,$text,$matches);
 661     //print_r($matches);
 662     return preg_replace_callback($regex, curry('callback_helper',$callback,$notice_id) ,$text);
 663 }
 664
 665 function callback_helper($matches, $callback, $notice_id) {
 666     $url=$matches[1];
 667     $left = strpos($matches[0],$url);
 668     $right = $left+strlen($url);
 669
 670     $groupSymbolSets=array(
 671         array(
 672             'left'=>'(',
 673             'right'=>')'
 674         ),
 675         array(
 676             'left'=>'[',
 677             'right'=>']'
 678         ),
 679         array(
 680             'left'=>'{',
 681             'right'=>'}'
 682         ),
 683         array(
 684             'left'=>'<',
 685             'right'=>'>'
 686         )
 687     );
 688     $cannotEndWith=array('.','?',',','#');
 689     $original_url=$url;
 690     do{
 691         $original_url=$url;
 692         foreach($groupSymbolSets as $groupSymbolSet){
 693             if(substr($url,-1)==$groupSymbolSet['right']){
 694                 $group_left_count = substr_count($url,$groupSymbolSet['left']);
 695                 $group_right_count = substr_count($url,$groupSymbolSet['right']);
 696                 if($group_left_count<$group_right_count){
 697                     $right-=1;
 698                     $url=substr($url,0,-1);
 699                 }
 700             }
 701         }
 702         if(in_array(substr($url,-1),$cannotEndWith)){
 703             $right-=1;
 704             $url=substr($url,0,-1);
 705         }
 706     }while($original_url!=$url);
 707
 708     if(empty($notice_id)){
 709         $result = call_user_func_array($callback, array($url));
 710     }else{
 711         $result = call_user_func_array($callback, array(array($url,$notice_id)) );
 712     }
 713     return substr($matches[0],0,$left) . $result . substr($matches[0],$right);
 714 }
 715
 716 if (version_compare(PHP_VERSION, '5.3.0', 'ge')) {
 717     // lambda implementation in a separate file; PHP 5.2 won't parse it.
 718     require_once INSTALLDIR . "/lib/curry.php";
 719 } else {
 720     function curry($fn) {
 721         $args = func_get_args();
 722         array_shift($args);
 723         $id = uniqid('_partial');
 724         $GLOBALS[$id] = array($fn, $args);
 725         return create_function('',
 726                                '$args = func_get_args(); '.
 727                                'return call_user_func_array('.
 728                                '$GLOBALS["'.$id.'"][0],'.
 729                                'array_merge('.
 730                                '$args,'.
 731                                '$GLOBALS["'.$id.'"][1]));');
 732     }
 733 }
 734
 735 function common_linkify($url) {
 736     // It comes in special'd, so we unspecial it before passing to the stringifying
 737     // functions
 738     $url = htmlspecialchars_decode($url);
 739
 740    if(strpos($url, '@') !== false && strpos($url, ':') === false) {
 741        //url is an email address without the mailto: protocol
 742        $canon = "mailto:$url";
 743        $longurl = "mailto:$url";
 744    }else{
 745
 746         $canon = File_redirection::_canonUrl($url);
 747
 748         $longurl_data = File_redirection::where($canon);
 749         if (is_array($longurl_data)) {
 750             $longurl = $longurl_data['url'];
 751         } elseif (is_string($longurl_data)) {
 752             $longurl = $longurl_data;
 753         } else {
 754             throw new ServerException("Can't linkify url '$url'");
 755         }
 756     }
 757     $attrs = array('href' => $canon, 'title' => $longurl, 'rel' => 'external');
 758
 759     $is_attachment = false;
 760     $attachment_id = null;
 761     $has_thumb = false;
 762
 763     // Check to see whether this is a known "attachment" URL.
 764
 765     $f = File::staticGet('url', $longurl);
 766
 767     if (empty($f)) {
 768         // XXX: this writes to the database. :<
 769         $f = File::processNew($longurl);
 770     }
 771
 772     if (!empty($f)) {
 773         if ($f->getEnclosure()) {
 774             $is_attachment = true;
 775             $attachment_id = $f->id;
 776
 777             $thumb = File_thumbnail::staticGet('file_id', $f->id);
 778             if (!empty($thumb)) {
 779                 $has_thumb = true;
 780             }
 781         }
 782     }
 783
 784     // Add clippy
 785     if ($is_attachment) {
 786         $attrs['class'] = 'attachment';
 787         if ($has_thumb) {
 788             $attrs['class'] = 'attachment thumbnail';
 789         }
 790         $attrs['id'] = "attachment-{$attachment_id}";
 791     }
 792
 793     return XMLStringer::estring('a', $attrs, $url);
 794 }
 795
 796 function common_shorten_links($text)
 797 {
 798     $maxLength = Notice::maxContent();
 799     if ($maxLength == 0 || mb_strlen($text) <= $maxLength) return $text;
 800     return common_replace_urls_callback($text, array('File_redirection', 'makeShort'));
 801 }
 802
 803 function common_xml_safe_str($str)
 804 {
 805     // Neutralize control codes and surrogates
 806         return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
 807 }
 808
 809 function common_tag_link($tag)
 810 {
 811     $canonical = common_canonical_tag($tag);
 812     $url = common_local_url('tag', array('tag' => $canonical));
 813     $xs = new XMLStringer();
 814     $xs->elementStart('span', 'tag');
 815     $xs->element('a', array('href' => $url,
 816                             'rel' => 'tag'),
 817                  $tag);
 818     $xs->elementEnd('span');
 819     return $xs->getString();
 820 }
 821
 822 function common_canonical_tag($tag)
 823 {
 824   $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
 825   return str_replace(array('-', '_', '.'), '', $tag);
 826 }
 827
 828 function common_valid_profile_tag($str)
 829 {
 830     return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
 831 }
 832
 833 function common_group_link($sender_id, $nickname)
 834 {
 835     $sender = Profile::staticGet($sender_id);
 836     $group = User_group::getForNickname($nickname);
 837     if ($sender && $group && $sender->isMember($group)) {
 838         $attrs = array('href' => $group->permalink(),
 839                        'class' => 'url');
 840         if (!empty($group->fullname)) {
 841             $attrs['title'] = $group->fullname . ' (' . $group->nickname . ')';
 842         }
 843         $xs = new XMLStringer();
 844         $xs->elementStart('span', 'vcard');
 845         $xs->elementStart('a', $attrs);
 846         $xs->element('span', 'fn nickname', $nickname);
 847         $xs->elementEnd('a');
 848         $xs->elementEnd('span');
 849         return $xs->getString();
 850     } else {
 851         return $nickname;
 852     }
 853 }
 854
 855 function common_relative_profile($sender, $nickname, $dt=null)
 856 {
 857     // Try to find profiles this profile is subscribed to that have this nickname
 858     $recipient = new Profile();
 859     // XXX: use a join instead of a subquery
 860     $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
 861     $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
 862     if ($recipient->find(true)) {
 863         // XXX: should probably differentiate between profiles with
 864         // the same name by date of most recent update
 865         return $recipient;
 866     }
 867     // Try to find profiles that listen to this profile and that have this nickname
 868     $recipient = new Profile();
 869     // XXX: use a join instead of a subquery
 870     $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
 871     $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
 872     if ($recipient->find(true)) {
 873         // XXX: should probably differentiate between profiles with
 874         // the same name by date of most recent update
 875         return $recipient;
 876     }
 877     // If this is a local user, try to find a local user with that nickname.
 878     $sender = User::staticGet($sender->id);
 879     if ($sender) {
 880         $recipient_user = User::staticGet('nickname', $nickname);
 881         if ($recipient_user) {
 882             return $recipient_user->getProfile();
 883         }
 884     }
 885     // Otherwise, no links. @messages from local users to remote users,
 886     // or from remote users to other remote users, are just
 887     // outside our ability to make intelligent guesses about
 888     return null;
 889 }
 890
 891 function common_local_url($action, $args=null, $params=null, $fragment=null, $addSession=true)
 892 {
 893     $r = Router::get();
 894     $path = $r->build($action, $args, $params, $fragment);
 895
 896     $ssl = common_is_sensitive($action);
 897
 898     if (common_config('site','fancy')) {
 899         $url = common_path(mb_substr($path, 1), $ssl, $addSession);
 900     } else {
 901         if (mb_strpos($path, '/index.php') === 0) {
 902             $url = common_path(mb_substr($path, 1), $ssl, $addSession);
 903         } else {
 904             $url = common_path('index.php'.$path, $ssl, $addSession);
 905         }
 906     }
 907     return $url;
 908 }
 909
 910 function common_is_sensitive($action)
 911 {
 912     static $sensitive = array('login', 'register', 'passwordsettings',
 913                               'twittersettings', 'api');
 914     $ssl = null;
 915
 916     if (Event::handle('SensitiveAction', array($action, &$ssl))) {
 917         $ssl = in_array($action, $sensitive);
 918     }
 919
 920     return $ssl;
 921 }
 922
 923 function common_path($relative, $ssl=false, $addSession=true)
 924 {
 925     $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
 926
 927     if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
 928         || common_config('site', 'ssl') === 'always') {
 929         $proto = 'https';
 930         if (is_string(common_config('site', 'sslserver')) &&
 931             mb_strlen(common_config('site', 'sslserver')) > 0) {
 932             $serverpart = common_config('site', 'sslserver');
 933         } else if (common_config('site', 'server')) {
 934             $serverpart = common_config('site', 'server');
 935         } else {
 936             common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
 937         }
 938     } else {
 939         $proto = 'http';
 940         if (common_config('site', 'server')) {
 941             $serverpart = common_config('site', 'server');
 942         } else {
 943             common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
 944         }
 945     }
 946
 947     if ($addSession) {
 948         $relative = common_inject_session($relative, $serverpart);
 949     }
 950
 951     return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
 952 }
 953
 954 function common_inject_session($url, $serverpart = null)
 955 {
 956     if (common_have_session()) {
 957
 958         if (empty($serverpart)) {
 959             $serverpart = parse_url($url, PHP_URL_HOST);
 960         }
 961
 962         $currentServer = $_SERVER['HTTP_HOST'];
 963
 964         // Are we pointing to another server (like an SSL server?)
 965
 966         if (!empty($currentServer) &&
 967             0 != strcasecmp($currentServer, $serverpart)) {
 968             // Pass the session ID as a GET parameter
 969             $sesspart = session_name() . '=' . session_id();
 970             $i = strpos($url, '?');
 971             if ($i === false) { // no GET params, just append
 972                 $url .= '?' . $sesspart;
 973             } else {
 974                 $url = substr($url, 0, $i + 1).$sesspart.'&'.substr($url, $i + 1);
 975             }
 976         }
 977     }
 978
 979     return $url;
 980 }
 981
 982 function common_date_string($dt)
 983 {
 984     // XXX: do some sexy date formatting
 985     // return date(DATE_RFC822, $dt);
 986     $t = strtotime($dt);
 987     $now = time();
 988     $diff = $now - $t;
 989
 990     if ($now < $t) { // that shouldn't happen!
 991         return common_exact_date($dt);
 992     } else if ($diff < 60) {
 993         return _('a few seconds ago');
 994     } else if ($diff < 92) {
 995         return _('about a minute ago');
 996     } else if ($diff < 3300) {
 997         return sprintf(_('about %d minutes ago'), round($diff/60));
 998     } else if ($diff < 5400) {
 999         return _('about an hour ago');
1000     } else if ($diff < 22 * 3600) {
1001         return sprintf(_('about %d hours ago'), round($diff/3600));
1002     } else if ($diff < 37 * 3600) {
1003         return _('about a day ago');
1004     } else if ($diff < 24 * 24 * 3600) {
1005         return sprintf(_('about %d days ago'), round($diff/(24*3600)));
1006     } else if ($diff < 46 * 24 * 3600) {
1007         return _('about a month ago');
1008     } else if ($diff < 330 * 24 * 3600) {
1009         return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
1010     } else if ($diff < 480 * 24 * 3600) {
1011         return _('about a year ago');
1012     } else {
1013         return common_exact_date($dt);
1014     }
1015 }
1016
1017 function common_exact_date($dt)
1018 {
1019     static $_utc;
1020     static $_siteTz;
1021
1022     if (!$_utc) {
1023         $_utc = new DateTimeZone('UTC');
1024         $_siteTz = new DateTimeZone(common_timezone());
1025     }
1026
1027     $dateStr = date('d F Y H:i:s', strtotime($dt));
1028     $d = new DateTime($dateStr, $_utc);
1029     $d->setTimezone($_siteTz);
1030     return $d->format(DATE_RFC850);
1031 }
1032
1033 function common_date_w3dtf($dt)
1034 {
1035     $dateStr = date('d F Y H:i:s', strtotime($dt));
1036     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1037     $d->setTimezone(new DateTimeZone(common_timezone()));
1038     return $d->format(DATE_W3C);
1039 }
1040
1041 function common_date_rfc2822($dt)
1042 {
1043     $dateStr = date('d F Y H:i:s', strtotime($dt));
1044     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1045     $d->setTimezone(new DateTimeZone(common_timezone()));
1046     return $d->format('r');
1047 }
1048
1049 function common_date_iso8601($dt)
1050 {
1051     $dateStr = date('d F Y H:i:s', strtotime($dt));
1052     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1053     $d->setTimezone(new DateTimeZone(common_timezone()));
1054     return $d->format('c');
1055 }
1056
1057 function common_sql_now()
1058 {
1059     return common_sql_date(time());
1060 }
1061
1062 function common_sql_date($datetime)
1063 {
1064     return strftime('%Y-%m-%d %H:%M:%S', $datetime);
1065 }
1066
1067 /**
1068  * Return an SQL fragment to calculate an age-based weight from a given
1069  * timestamp or datetime column.
1070  *
1071  * @param string $column name of field we're comparing against current time
1072  * @param integer $dropoff divisor for age in seconds before exponentiation
1073  * @return string SQL fragment
1074  */
1075 function common_sql_weight($column, $dropoff)
1076 {
1077     if (common_config('db', 'type') == 'pgsql') {
1078         // PostgreSQL doesn't support timestampdiff function.
1079         // @fixme will this use the right time zone?
1080         // @fixme does this handle cross-year subtraction correctly?
1081         return "sum(exp(-extract(epoch from (now() - $column)) / $dropoff))";
1082     } else {
1083         return "sum(exp(timestampdiff(second, utc_timestamp(), $column) / $dropoff))";
1084     }
1085 }
1086
1087 function common_redirect($url, $code=307)
1088 {
1089     static $status = array(301 => "Moved Permanently",
1090                            302 => "Found",
1091                            303 => "See Other",
1092                            307 => "Temporary Redirect");
1093
1094     header('HTTP/1.1 '.$code.' '.$status[$code]);
1095     header("Location: $url");
1096
1097     $xo = new XMLOutputter();
1098     $xo->startXML('a',
1099                   '-//W3C//DTD XHTML 1.0 Strict//EN',
1100                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1101     $xo->element('a', array('href' => $url), $url);
1102     $xo->endXML();
1103     exit;
1104 }
1105
1106 function common_broadcast_notice($notice, $remote=false)
1107 {
1108     // DO NOTHING!
1109 }
1110
1111 // Stick the notice on the queue
1112
1113 function common_enqueue_notice($notice)
1114 {
1115     static $localTransports = array('omb',
1116                                     'ping');
1117
1118     $transports = array();
1119     if (common_config('sms', 'enabled')) {
1120         $transports[] = 'sms';
1121     }
1122     if (Event::hasHandler('HandleQueuedNotice')) {
1123         $transports[] = 'plugin';
1124     }
1125
1126     $xmpp = common_config('xmpp', 'enabled');
1127
1128     if ($xmpp) {
1129         $transports[] = 'jabber';
1130     }
1131
1132     // @fixme move these checks into QueueManager and/or individual handlers
1133     if ($notice->is_local == Notice::LOCAL_PUBLIC ||
1134         $notice->is_local == Notice::LOCAL_NONPUBLIC) {
1135         $transports = array_merge($transports, $localTransports);
1136         if ($xmpp) {
1137             $transports[] = 'public';
1138         }
1139     }
1140
1141     if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
1142
1143         $qm = QueueManager::get();
1144
1145         foreach ($transports as $transport)
1146         {
1147             $qm->enqueue($notice, $transport);
1148         }
1149
1150         Event::handle('EndEnqueueNotice', array($notice, $transports));
1151     }
1152
1153     return true;
1154 }
1155
1156 /**
1157  * Broadcast profile updates to OMB and other remote subscribers.
1158  *
1159  * Since this may be slow with a lot of subscribers or bad remote sites,
1160  * this is run through the background queues if possible.
1161  */
1162 function common_broadcast_profile(Profile $profile)
1163 {
1164     $qm = QueueManager::get();
1165     $qm->enqueue($profile, "profile");
1166     return true;
1167 }
1168
1169 function common_profile_url($nickname)
1170 {
1171     return common_local_url('showstream', array('nickname' => $nickname),
1172                             null, null, false);
1173 }
1174
1175 // Should make up a reasonable root URL
1176
1177 function common_root_url($ssl=false)
1178 {
1179     $url = common_path('', $ssl, false);
1180     $i = strpos($url, '?');
1181     if ($i !== false) {
1182         $url = substr($url, 0, $i);
1183     }
1184     return $url;
1185 }
1186
1187 // returns $bytes bytes of random data as a hexadecimal string
1188 // "good" here is a goal and not a guarantee
1189
1190 function common_good_rand($bytes)
1191 {
1192     // XXX: use random.org...?
1193     if (@file_exists('/dev/urandom')) {
1194         return common_urandom($bytes);
1195     } else { // FIXME: this is probably not good enough
1196         return common_mtrand($bytes);
1197     }
1198 }
1199
1200 function common_urandom($bytes)
1201 {
1202     $h = fopen('/dev/urandom', 'rb');
1203     // should not block
1204     $src = fread($h, $bytes);
1205     fclose($h);
1206     $enc = '';
1207     for ($i = 0; $i < $bytes; $i++) {
1208         $enc .= sprintf("%02x", (ord($src[$i])));
1209     }
1210     return $enc;
1211 }
1212
1213 function common_mtrand($bytes)
1214 {
1215     $enc = '';
1216     for ($i = 0; $i < $bytes; $i++) {
1217         $enc .= sprintf("%02x", mt_rand(0, 255));
1218     }
1219     return $enc;
1220 }
1221
1222 function common_set_returnto($url)
1223 {
1224     common_ensure_session();
1225     $_SESSION['returnto'] = $url;
1226 }
1227
1228 function common_get_returnto()
1229 {
1230     common_ensure_session();
1231     return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
1232 }
1233
1234 function common_timestamp()
1235 {
1236     return date('YmdHis');
1237 }
1238
1239 function common_ensure_syslog()
1240 {
1241     static $initialized = false;
1242     if (!$initialized) {
1243         openlog(common_config('syslog', 'appname'), 0,
1244             common_config('syslog', 'facility'));
1245         $initialized = true;
1246     }
1247 }
1248
1249 function common_log_line($priority, $msg)
1250 {
1251     static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1252                                       'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1253     return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
1254 }
1255
1256 function common_request_id()
1257 {
1258     $pid = getmypid();
1259     $server = common_config('site', 'server');
1260     if (php_sapi_name() == 'cli') {
1261         $script = basename($_SERVER['PHP_SELF']);
1262         return "$server:$script:$pid";
1263     } else {
1264         static $req_id = null;
1265         if (!isset($req_id)) {
1266             $req_id = substr(md5(mt_rand()), 0, 8);
1267         }
1268         if (isset($_SERVER['REQUEST_URI'])) {
1269             $url = $_SERVER['REQUEST_URI'];
1270         }
1271         $method = $_SERVER['REQUEST_METHOD'];
1272         return "$server:$pid.$req_id $method $url";
1273     }
1274 }
1275
1276 function common_log($priority, $msg, $filename=null)
1277 {
1278     if(Event::handle('StartLog', array(&$priority, &$msg, &$filename))){
1279         $msg = '[' . common_request_id() . '] ' . $msg;
1280         $logfile = common_config('site', 'logfile');
1281         if ($logfile) {
1282             $log = fopen($logfile, "a");
1283             if ($log) {
1284                 $output = common_log_line($priority, $msg);
1285                 fwrite($log, $output);
1286                 fclose($log);
1287             }
1288         } else {
1289             common_ensure_syslog();
1290             syslog($priority, $msg);
1291         }
1292         Event::handle('EndLog', array($priority, $msg, $filename));
1293     }
1294 }
1295
1296 function common_debug($msg, $filename=null)
1297 {
1298     if ($filename) {
1299         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1300     } else {
1301         common_log(LOG_DEBUG, $msg);
1302     }
1303 }
1304
1305 function common_log_db_error(&$object, $verb, $filename=null)
1306 {
1307     $objstr = common_log_objstring($object);
1308     $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1309     common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1310 }
1311
1312 function common_log_objstring(&$object)
1313 {
1314     if (is_null($object)) {
1315         return "null";
1316     }
1317     if (!($object instanceof DB_DataObject)) {
1318         return "(unknown)";
1319     }
1320     $arr = $object->toArray();
1321     $fields = array();
1322     foreach ($arr as $k => $v) {
1323         if (is_object($v)) {
1324             $fields[] = "$k='".get_class($v)."'";
1325         } else {
1326             $fields[] = "$k='$v'";
1327         }
1328     }
1329     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1330     return $objstring;
1331 }
1332
1333 function common_valid_http_url($url)
1334 {
1335     return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1336 }
1337
1338 function common_valid_tag($tag)
1339 {
1340     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1341         return (Validate::email($matches[1]) ||
1342                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1343     }
1344     return false;
1345 }
1346
1347 /* Following functions are copied from MediaWiki GlobalFunctions.php
1348  * and written by Evan Prodromou. */
1349
1350 function common_accept_to_prefs($accept, $def = '*/*')
1351 {
1352     // No arg means accept anything (per HTTP spec)
1353     if(!$accept) {
1354         return array($def => 1);
1355     }
1356
1357     $prefs = array();
1358
1359     $parts = explode(',', $accept);
1360
1361     foreach($parts as $part) {
1362         // FIXME: doesn't deal with params like 'text/html; level=1'
1363         @list($value, $qpart) = explode(';', trim($part));
1364         $match = array();
1365         if(!isset($qpart)) {
1366             $prefs[$value] = 1;
1367         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1368             $prefs[$value] = $match[1];
1369         }
1370     }
1371
1372     return $prefs;
1373 }
1374
1375 function common_mime_type_match($type, $avail)
1376 {
1377     if(array_key_exists($type, $avail)) {
1378         return $type;
1379     } else {
1380         $parts = explode('/', $type);
1381         if(array_key_exists($parts[0] . '/*', $avail)) {
1382             return $parts[0] . '/*';
1383         } elseif(array_key_exists('*/*', $avail)) {
1384             return '*/*';
1385         } else {
1386             return null;
1387         }
1388     }
1389 }
1390
1391 function common_negotiate_type($cprefs, $sprefs)
1392 {
1393     $combine = array();
1394
1395     foreach(array_keys($sprefs) as $type) {
1396         $parts = explode('/', $type);
1397         if($parts[1] != '*') {
1398             $ckey = common_mime_type_match($type, $cprefs);
1399             if($ckey) {
1400                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1401             }
1402         }
1403     }
1404
1405     foreach(array_keys($cprefs) as $type) {
1406         $parts = explode('/', $type);
1407         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1408             $skey = common_mime_type_match($type, $sprefs);
1409             if($skey) {
1410                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1411             }
1412         }
1413     }
1414
1415     $bestq = 0;
1416     $besttype = 'text/html';
1417
1418     foreach(array_keys($combine) as $type) {
1419         if($combine[$type] > $bestq) {
1420             $besttype = $type;
1421             $bestq = $combine[$type];
1422         }
1423     }
1424
1425     if ('text/html' === $besttype) {
1426         return "text/html; charset=utf-8";
1427     }
1428     return $besttype;
1429 }
1430
1431 function common_config($main, $sub)
1432 {
1433     global $config;
1434     return (array_key_exists($main, $config) &&
1435             array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
1436 }
1437
1438 function common_copy_args($from)
1439 {
1440     $to = array();
1441     $strip = get_magic_quotes_gpc();
1442     foreach ($from as $k => $v) {
1443         $to[$k] = ($strip) ? stripslashes($v) : $v;
1444     }
1445     return $to;
1446 }
1447
1448 /**
1449  * Neutralise the evil effects of magic_quotes_gpc in the current request.
1450  * This is used before handing a request off to OAuthRequest::from_request.
1451  * @fixme Doesn't consider vars other than _POST and _GET?
1452  * @fixme Can't be undone and could corrupt data if run twice.
1453  */
1454 function common_remove_magic_from_request()
1455 {
1456     if(get_magic_quotes_gpc()) {
1457         $_POST=array_map('stripslashes',$_POST);
1458         $_GET=array_map('stripslashes',$_GET);
1459     }
1460 }
1461
1462 function common_user_uri(&$user)
1463 {
1464     return common_local_url('userbyid', array('id' => $user->id),
1465                             null, null, false);
1466 }
1467
1468 function common_notice_uri(&$notice)
1469 {
1470     return common_local_url('shownotice',
1471                             array('notice' => $notice->id));
1472 }
1473
1474 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1475
1476 function common_confirmation_code($bits)
1477 {
1478     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1479     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1480     $chars = ceil($bits/5);
1481     $code = '';
1482     for ($i = 0; $i < $chars; $i++) {
1483         // XXX: convert to string and back
1484         $num = hexdec(common_good_rand(1));
1485         // XXX: randomness is too precious to throw away almost
1486         // 40% of the bits we get!
1487         $code .= $codechars[$num%32];
1488     }
1489     return $code;
1490 }
1491
1492 // convert markup to HTML
1493
1494 function common_markup_to_html($c)
1495 {
1496     $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1497     $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1498     $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1499     return Markdown($c);
1500 }
1501
1502 function common_profile_uri($profile)
1503 {
1504     if (!$profile) {
1505         return null;
1506     }
1507     $user = User::staticGet($profile->id);
1508     if ($user) {
1509         return $user->uri;
1510     }
1511
1512     $remote = Remote_profile::staticGet($profile->id);
1513     if ($remote) {
1514         return $remote->uri;
1515     }
1516     // XXX: this is a very bad profile!
1517     return null;
1518 }
1519
1520 function common_canonical_sms($sms)
1521 {
1522     // strip non-digits
1523     preg_replace('/\D/', '', $sms);
1524     return $sms;
1525 }
1526
1527 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1528 {
1529     switch ($errno) {
1530
1531      case E_ERROR:
1532      case E_COMPILE_ERROR:
1533      case E_CORE_ERROR:
1534      case E_USER_ERROR:
1535      case E_PARSE:
1536      case E_RECOVERABLE_ERROR:
1537         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
1538         die();
1539         break;
1540
1541      case E_WARNING:
1542      case E_COMPILE_WARNING:
1543      case E_CORE_WARNING:
1544      case E_USER_WARNING:
1545         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1546         break;
1547
1548      case E_NOTICE:
1549      case E_USER_NOTICE:
1550         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1551         break;
1552
1553      case E_STRICT:
1554      case E_DEPRECATED:
1555      case E_USER_DEPRECATED:
1556         // XXX: config variable to log this stuff, too
1557         break;
1558
1559      default:
1560         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
1561         die();
1562         break;
1563     }
1564
1565     // FIXME: show error page if we're on the Web
1566     /* Don't execute PHP internal error handler */
1567     return true;
1568 }
1569
1570 function common_session_token()
1571 {
1572     common_ensure_session();
1573     if (!array_key_exists('token', $_SESSION)) {
1574         $_SESSION['token'] = common_good_rand(64);
1575     }
1576     return $_SESSION['token'];
1577 }
1578
1579 function common_cache_key($extra)
1580 {
1581     return Cache::key($extra);
1582 }
1583
1584 function common_keyize($str)
1585 {
1586     return Cache::keyize($str);
1587 }
1588
1589 function common_memcache()
1590 {
1591     return Cache::instance();
1592 }
1593
1594 function common_license_terms($uri)
1595 {
1596     if(preg_match('/creativecommons.org\/licenses\/([^\/]+)/', $uri, $matches)) {
1597         return explode('-',$matches[1]);
1598     }
1599     return array($uri);
1600 }
1601
1602 function common_compatible_license($from, $to)
1603 {
1604     $from_terms = common_license_terms($from);
1605     // public domain and cc-by are compatible with everything
1606     if(count($from_terms) == 1 && ($from_terms[0] == 'publicdomain' || $from_terms[0] == 'by')) {
1607         return true;
1608     }
1609     $to_terms = common_license_terms($to);
1610     // sa is compatible across versions. IANAL
1611     if(in_array('sa',$from_terms) || in_array('sa',$to_terms)) {
1612         return count(array_diff($from_terms, $to_terms)) == 0;
1613     }
1614     // XXX: better compatibility check needed here!
1615     // Should at least normalise URIs
1616     return ($from == $to);
1617 }
1618
1619 /**
1620  * returns a quoted table name, if required according to config
1621  */
1622 function common_database_tablename($tablename)
1623 {
1624
1625   if(common_config('db','quote_identifiers')) {
1626       $tablename = '"'. $tablename .'"';
1627   }
1628   //table prefixes could be added here later
1629   return $tablename;
1630 }
1631
1632 /**
1633  * Shorten a URL with the current user's configured shortening service,
1634  * or ur1.ca if configured, or not at all if no shortening is set up.
1635  * Length is not considered.
1636  *
1637  * @param string $long_url
1638  * @return string may return the original URL if shortening failed
1639  *
1640  * @fixme provide a way to specify a particular shortener
1641  * @fixme provide a way to specify to use a given user's shortening preferences
1642  */
1643 function common_shorten_url($long_url)
1644 {
1645     $long_url = trim($long_url);
1646     $user = common_current_user();
1647     if (empty($user)) {
1648         // common current user does not find a user when called from the XMPP daemon
1649         // therefore we'll set one here fix, so that XMPP given URLs may be shortened
1650         $shortenerName = 'ur1.ca';
1651     } else {
1652         $shortenerName = $user->urlshorteningservice;
1653     }
1654
1655     if(Event::handle('StartShortenUrl', array($long_url,$shortenerName,&$shortenedUrl))){
1656         //URL wasn't shortened, so return the long url
1657         return $long_url;
1658     }else{
1659         //URL was shortened, so return the result
1660         return trim($shortenedUrl);
1661     }
1662 }
1663
1664 /**
1665  * @return mixed array($proxy, $ip) for web requests; proxy may be null
1666  *               null if not a web request
1667  *
1668  * @fixme X-Forwarded-For can be chained by multiple proxies;
1669           we should parse the list and provide a cleaner array
1670  * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
1671  * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
1672  *        use function to get exact request headers from Apache if possible.
1673  */
1674 function common_client_ip()
1675 {
1676     if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
1677         return null;
1678     }
1679
1680     if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
1681         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1682             $proxy = $_SERVER['HTTP_CLIENT_IP'];
1683         } else {
1684             $proxy = $_SERVER['REMOTE_ADDR'];
1685         }
1686         $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
1687     } else {
1688         $proxy = null;
1689         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1690             $ip = $_SERVER['HTTP_CLIENT_IP'];
1691         } else {
1692             $ip = $_SERVER['REMOTE_ADDR'];
1693         }
1694     }
1695
1696     return array($proxy, $ip);
1697 }
1698
1699 function common_url_to_nickname($url)
1700 {
1701     static $bad = array('query', 'user', 'password', 'port', 'fragment');
1702
1703     $parts = parse_url($url);
1704
1705     # If any of these parts exist, this won't work
1706
1707     foreach ($bad as $badpart) {
1708         if (array_key_exists($badpart, $parts)) {
1709             return null;
1710         }
1711     }
1712
1713     # We just have host and/or path
1714
1715     # If it's just a host...
1716     if (array_key_exists('host', $parts) &&
1717         (!array_key_exists('path', $parts) || strcmp($parts['path'], '/') == 0))
1718     {
1719         $hostparts = explode('.', $parts['host']);
1720
1721         # Try to catch common idiom of nickname.service.tld
1722
1723         if ((count($hostparts) > 2) &&
1724             (strlen($hostparts[count($hostparts) - 2]) > 3) && # try to skip .co.uk, .com.au
1725             (strcmp($hostparts[0], 'www') != 0))
1726         {
1727             return common_nicknamize($hostparts[0]);
1728         } else {
1729             # Do the whole hostname
1730             return common_nicknamize($parts['host']);
1731         }
1732     } else {
1733         if (array_key_exists('path', $parts)) {
1734             # Strip starting, ending slashes
1735             $path = preg_replace('@/$@', '', $parts['path']);
1736             $path = preg_replace('@^/@', '', $path);
1737             $path = basename($path);
1738             if ($path) {
1739                 return common_nicknamize($path);
1740             }
1741         }
1742     }
1743
1744     return null;
1745 }
1746
1747 function common_nicknamize($str)
1748 {
1749     $str = preg_replace('/\W/', '', $str);
1750     return strtolower($str);
1751 }