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                 $mentioned = $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     // Replace common eol and extra whitespace input chars
 806     $unWelcome = array(
 807         "\t",  // tab
 808         "\n",  // newline
 809         "\r",  // cr
 810         "\0",  // null byte eos
 811         "\x0B" // vertical tab
 812     );
 813
 814     $replacement = array(
 815         ' ', // single space
 816         ' ',
 817         '',  // nothing
 818         '',
 819         ' '
 820     );
 821
 822     $str = str_replace($unWelcome, $replacement, $str);
 823
 824     // Neutralize any additional control codes and UTF-16 surrogates
 825     // (Twitter uses '*')
 826     return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
 827 }
 828
 829 function common_tag_link($tag)
 830 {
 831     $canonical = common_canonical_tag($tag);
 832     $url = common_local_url('tag', array('tag' => $canonical));
 833     $xs = new XMLStringer();
 834     $xs->elementStart('span', 'tag');
 835     $xs->element('a', array('href' => $url,
 836                             'rel' => 'tag'),
 837                  $tag);
 838     $xs->elementEnd('span');
 839     return $xs->getString();
 840 }
 841
 842 function common_canonical_tag($tag)
 843 {
 844   $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
 845   return str_replace(array('-', '_', '.'), '', $tag);
 846 }
 847
 848 function common_valid_profile_tag($str)
 849 {
 850     return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
 851 }
 852
 853 function common_group_link($sender_id, $nickname)
 854 {
 855     $sender = Profile::staticGet($sender_id);
 856     $group = User_group::getForNickname($nickname);
 857     if ($sender && $group && $sender->isMember($group)) {
 858         $attrs = array('href' => $group->permalink(),
 859                        'class' => 'url');
 860         if (!empty($group->fullname)) {
 861             $attrs['title'] = $group->fullname . ' (' . $group->nickname . ')';
 862         }
 863         $xs = new XMLStringer();
 864         $xs->elementStart('span', 'vcard');
 865         $xs->elementStart('a', $attrs);
 866         $xs->element('span', 'fn nickname', $nickname);
 867         $xs->elementEnd('a');
 868         $xs->elementEnd('span');
 869         return $xs->getString();
 870     } else {
 871         return $nickname;
 872     }
 873 }
 874
 875 function common_relative_profile($sender, $nickname, $dt=null)
 876 {
 877     // Try to find profiles this profile is subscribed to that have this nickname
 878     $recipient = new Profile();
 879     // XXX: use a join instead of a subquery
 880     $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
 881     $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
 882     if ($recipient->find(true)) {
 883         // XXX: should probably differentiate between profiles with
 884         // the same name by date of most recent update
 885         return $recipient;
 886     }
 887     // Try to find profiles that listen to this profile and that have this nickname
 888     $recipient = new Profile();
 889     // XXX: use a join instead of a subquery
 890     $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
 891     $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
 892     if ($recipient->find(true)) {
 893         // XXX: should probably differentiate between profiles with
 894         // the same name by date of most recent update
 895         return $recipient;
 896     }
 897     // If this is a local user, try to find a local user with that nickname.
 898     $sender = User::staticGet($sender->id);
 899     if ($sender) {
 900         $recipient_user = User::staticGet('nickname', $nickname);
 901         if ($recipient_user) {
 902             return $recipient_user->getProfile();
 903         }
 904     }
 905     // Otherwise, no links. @messages from local users to remote users,
 906     // or from remote users to other remote users, are just
 907     // outside our ability to make intelligent guesses about
 908     return null;
 909 }
 910
 911 function common_local_url($action, $args=null, $params=null, $fragment=null, $addSession=true)
 912 {
 913     $r = Router::get();
 914     $path = $r->build($action, $args, $params, $fragment);
 915
 916     $ssl = common_is_sensitive($action);
 917
 918     if (common_config('site','fancy')) {
 919         $url = common_path(mb_substr($path, 1), $ssl, $addSession);
 920     } else {
 921         if (mb_strpos($path, '/index.php') === 0) {
 922             $url = common_path(mb_substr($path, 1), $ssl, $addSession);
 923         } else {
 924             $url = common_path('index.php'.$path, $ssl, $addSession);
 925         }
 926     }
 927     return $url;
 928 }
 929
 930 function common_is_sensitive($action)
 931 {
 932     static $sensitive = array('login', 'register', 'passwordsettings',
 933                               'twittersettings', 'api');
 934     $ssl = null;
 935
 936     if (Event::handle('SensitiveAction', array($action, &$ssl))) {
 937         $ssl = in_array($action, $sensitive);
 938     }
 939
 940     return $ssl;
 941 }
 942
 943 function common_path($relative, $ssl=false, $addSession=true)
 944 {
 945     $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
 946
 947     if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
 948         || common_config('site', 'ssl') === 'always') {
 949         $proto = 'https';
 950         if (is_string(common_config('site', 'sslserver')) &&
 951             mb_strlen(common_config('site', 'sslserver')) > 0) {
 952             $serverpart = common_config('site', 'sslserver');
 953         } else if (common_config('site', 'server')) {
 954             $serverpart = common_config('site', 'server');
 955         } else {
 956             common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
 957         }
 958     } else {
 959         $proto = 'http';
 960         if (common_config('site', 'server')) {
 961             $serverpart = common_config('site', 'server');
 962         } else {
 963             common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
 964         }
 965     }
 966
 967     if ($addSession) {
 968         $relative = common_inject_session($relative, $serverpart);
 969     }
 970
 971     return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
 972 }
 973
 974 function common_inject_session($url, $serverpart = null)
 975 {
 976     if (common_have_session()) {
 977
 978         if (empty($serverpart)) {
 979             $serverpart = parse_url($url, PHP_URL_HOST);
 980         }
 981
 982         $currentServer = $_SERVER['HTTP_HOST'];
 983
 984         // Are we pointing to another server (like an SSL server?)
 985
 986         if (!empty($currentServer) &&
 987             0 != strcasecmp($currentServer, $serverpart)) {
 988             // Pass the session ID as a GET parameter
 989             $sesspart = session_name() . '=' . session_id();
 990             $i = strpos($url, '?');
 991             if ($i === false) { // no GET params, just append
 992                 $url .= '?' . $sesspart;
 993             } else {
 994                 $url = substr($url, 0, $i + 1).$sesspart.'&'.substr($url, $i + 1);
 995             }
 996         }
 997     }
 998
 999     return $url;
1000 }
1001
1002 function common_date_string($dt)
1003 {
1004     // XXX: do some sexy date formatting
1005     // return date(DATE_RFC822, $dt);
1006     $t = strtotime($dt);
1007     $now = time();
1008     $diff = $now - $t;
1009
1010     if ($now < $t) { // that shouldn't happen!
1011         return common_exact_date($dt);
1012     } else if ($diff < 60) {
1013         return _('a few seconds ago');
1014     } else if ($diff < 92) {
1015         return _('about a minute ago');
1016     } else if ($diff < 3300) {
1017         return sprintf(_('about %d minutes ago'), round($diff/60));
1018     } else if ($diff < 5400) {
1019         return _('about an hour ago');
1020     } else if ($diff < 22 * 3600) {
1021         return sprintf(_('about %d hours ago'), round($diff/3600));
1022     } else if ($diff < 37 * 3600) {
1023         return _('about a day ago');
1024     } else if ($diff < 24 * 24 * 3600) {
1025         return sprintf(_('about %d days ago'), round($diff/(24*3600)));
1026     } else if ($diff < 46 * 24 * 3600) {
1027         return _('about a month ago');
1028     } else if ($diff < 330 * 24 * 3600) {
1029         return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
1030     } else if ($diff < 480 * 24 * 3600) {
1031         return _('about a year ago');
1032     } else {
1033         return common_exact_date($dt);
1034     }
1035 }
1036
1037 function common_exact_date($dt)
1038 {
1039     static $_utc;
1040     static $_siteTz;
1041
1042     if (!$_utc) {
1043         $_utc = new DateTimeZone('UTC');
1044         $_siteTz = new DateTimeZone(common_timezone());
1045     }
1046
1047     $dateStr = date('d F Y H:i:s', strtotime($dt));
1048     $d = new DateTime($dateStr, $_utc);
1049     $d->setTimezone($_siteTz);
1050     return $d->format(DATE_RFC850);
1051 }
1052
1053 function common_date_w3dtf($dt)
1054 {
1055     $dateStr = date('d F Y H:i:s', strtotime($dt));
1056     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1057     $d->setTimezone(new DateTimeZone(common_timezone()));
1058     return $d->format(DATE_W3C);
1059 }
1060
1061 function common_date_rfc2822($dt)
1062 {
1063     $dateStr = date('d F Y H:i:s', strtotime($dt));
1064     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1065     $d->setTimezone(new DateTimeZone(common_timezone()));
1066     return $d->format('r');
1067 }
1068
1069 function common_date_iso8601($dt)
1070 {
1071     $dateStr = date('d F Y H:i:s', strtotime($dt));
1072     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1073     $d->setTimezone(new DateTimeZone(common_timezone()));
1074     return $d->format('c');
1075 }
1076
1077 function common_sql_now()
1078 {
1079     return common_sql_date(time());
1080 }
1081
1082 function common_sql_date($datetime)
1083 {
1084     return strftime('%Y-%m-%d %H:%M:%S', $datetime);
1085 }
1086
1087 /**
1088  * Return an SQL fragment to calculate an age-based weight from a given
1089  * timestamp or datetime column.
1090  *
1091  * @param string $column name of field we're comparing against current time
1092  * @param integer $dropoff divisor for age in seconds before exponentiation
1093  * @return string SQL fragment
1094  */
1095 function common_sql_weight($column, $dropoff)
1096 {
1097     if (common_config('db', 'type') == 'pgsql') {
1098         // PostgreSQL doesn't support timestampdiff function.
1099         // @fixme will this use the right time zone?
1100         // @fixme does this handle cross-year subtraction correctly?
1101         return "sum(exp(-extract(epoch from (now() - $column)) / $dropoff))";
1102     } else {
1103         return "sum(exp(timestampdiff(second, utc_timestamp(), $column) / $dropoff))";
1104     }
1105 }
1106
1107 function common_redirect($url, $code=307)
1108 {
1109     static $status = array(301 => "Moved Permanently",
1110                            302 => "Found",
1111                            303 => "See Other",
1112                            307 => "Temporary Redirect");
1113
1114     header('HTTP/1.1 '.$code.' '.$status[$code]);
1115     header("Location: $url");
1116
1117     $xo = new XMLOutputter();
1118     $xo->startXML('a',
1119                   '-//W3C//DTD XHTML 1.0 Strict//EN',
1120                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1121     $xo->element('a', array('href' => $url), $url);
1122     $xo->endXML();
1123     exit;
1124 }
1125
1126 function common_broadcast_notice($notice, $remote=false)
1127 {
1128     // DO NOTHING!
1129 }
1130
1131 // Stick the notice on the queue
1132
1133 function common_enqueue_notice($notice)
1134 {
1135     static $localTransports = array('omb',
1136                                     'ping');
1137
1138     $transports = array();
1139     if (common_config('sms', 'enabled')) {
1140         $transports[] = 'sms';
1141     }
1142     if (Event::hasHandler('HandleQueuedNotice')) {
1143         $transports[] = 'plugin';
1144     }
1145
1146     $xmpp = common_config('xmpp', 'enabled');
1147
1148     if ($xmpp) {
1149         $transports[] = 'jabber';
1150     }
1151
1152     // @fixme move these checks into QueueManager and/or individual handlers
1153     if ($notice->is_local == Notice::LOCAL_PUBLIC ||
1154         $notice->is_local == Notice::LOCAL_NONPUBLIC) {
1155         $transports = array_merge($transports, $localTransports);
1156         if ($xmpp) {
1157             $transports[] = 'public';
1158         }
1159     }
1160
1161     if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
1162
1163         $qm = QueueManager::get();
1164
1165         foreach ($transports as $transport)
1166         {
1167             $qm->enqueue($notice, $transport);
1168         }
1169
1170         Event::handle('EndEnqueueNotice', array($notice, $transports));
1171     }
1172
1173     return true;
1174 }
1175
1176 /**
1177  * Broadcast profile updates to OMB and other remote subscribers.
1178  *
1179  * Since this may be slow with a lot of subscribers or bad remote sites,
1180  * this is run through the background queues if possible.
1181  */
1182 function common_broadcast_profile(Profile $profile)
1183 {
1184     $qm = QueueManager::get();
1185     $qm->enqueue($profile, "profile");
1186     return true;
1187 }
1188
1189 function common_profile_url($nickname)
1190 {
1191     return common_local_url('showstream', array('nickname' => $nickname),
1192                             null, null, false);
1193 }
1194
1195 // Should make up a reasonable root URL
1196
1197 function common_root_url($ssl=false)
1198 {
1199     $url = common_path('', $ssl, false);
1200     $i = strpos($url, '?');
1201     if ($i !== false) {
1202         $url = substr($url, 0, $i);
1203     }
1204     return $url;
1205 }
1206
1207 // returns $bytes bytes of random data as a hexadecimal string
1208 // "good" here is a goal and not a guarantee
1209
1210 function common_good_rand($bytes)
1211 {
1212     // XXX: use random.org...?
1213     if (@file_exists('/dev/urandom')) {
1214         return common_urandom($bytes);
1215     } else { // FIXME: this is probably not good enough
1216         return common_mtrand($bytes);
1217     }
1218 }
1219
1220 function common_urandom($bytes)
1221 {
1222     $h = fopen('/dev/urandom', 'rb');
1223     // should not block
1224     $src = fread($h, $bytes);
1225     fclose($h);
1226     $enc = '';
1227     for ($i = 0; $i < $bytes; $i++) {
1228         $enc .= sprintf("%02x", (ord($src[$i])));
1229     }
1230     return $enc;
1231 }
1232
1233 function common_mtrand($bytes)
1234 {
1235     $enc = '';
1236     for ($i = 0; $i < $bytes; $i++) {
1237         $enc .= sprintf("%02x", mt_rand(0, 255));
1238     }
1239     return $enc;
1240 }
1241
1242 function common_set_returnto($url)
1243 {
1244     common_ensure_session();
1245     $_SESSION['returnto'] = $url;
1246 }
1247
1248 function common_get_returnto()
1249 {
1250     common_ensure_session();
1251     return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
1252 }
1253
1254 function common_timestamp()
1255 {
1256     return date('YmdHis');
1257 }
1258
1259 function common_ensure_syslog()
1260 {
1261     static $initialized = false;
1262     if (!$initialized) {
1263         openlog(common_config('syslog', 'appname'), 0,
1264             common_config('syslog', 'facility'));
1265         $initialized = true;
1266     }
1267 }
1268
1269 function common_log_line($priority, $msg)
1270 {
1271     static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1272                                       'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1273     return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
1274 }
1275
1276 function common_request_id()
1277 {
1278     $pid = getmypid();
1279     $server = common_config('site', 'server');
1280     if (php_sapi_name() == 'cli') {
1281         $script = basename($_SERVER['PHP_SELF']);
1282         return "$server:$script:$pid";
1283     } else {
1284         static $req_id = null;
1285         if (!isset($req_id)) {
1286             $req_id = substr(md5(mt_rand()), 0, 8);
1287         }
1288         if (isset($_SERVER['REQUEST_URI'])) {
1289             $url = $_SERVER['REQUEST_URI'];
1290         }
1291         $method = $_SERVER['REQUEST_METHOD'];
1292         return "$server:$pid.$req_id $method $url";
1293     }
1294 }
1295
1296 function common_log($priority, $msg, $filename=null)
1297 {
1298     if(Event::handle('StartLog', array(&$priority, &$msg, &$filename))){
1299         $msg = '[' . common_request_id() . '] ' . $msg;
1300         $logfile = common_config('site', 'logfile');
1301         if ($logfile) {
1302             $log = fopen($logfile, "a");
1303             if ($log) {
1304                 $output = common_log_line($priority, $msg);
1305                 fwrite($log, $output);
1306                 fclose($log);
1307             }
1308         } else {
1309             common_ensure_syslog();
1310             syslog($priority, $msg);
1311         }
1312         Event::handle('EndLog', array($priority, $msg, $filename));
1313     }
1314 }
1315
1316 function common_debug($msg, $filename=null)
1317 {
1318     if ($filename) {
1319         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1320     } else {
1321         common_log(LOG_DEBUG, $msg);
1322     }
1323 }
1324
1325 function common_log_db_error(&$object, $verb, $filename=null)
1326 {
1327     $objstr = common_log_objstring($object);
1328     $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1329     common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1330 }
1331
1332 function common_log_objstring(&$object)
1333 {
1334     if (is_null($object)) {
1335         return "null";
1336     }
1337     if (!($object instanceof DB_DataObject)) {
1338         return "(unknown)";
1339     }
1340     $arr = $object->toArray();
1341     $fields = array();
1342     foreach ($arr as $k => $v) {
1343         if (is_object($v)) {
1344             $fields[] = "$k='".get_class($v)."'";
1345         } else {
1346             $fields[] = "$k='$v'";
1347         }
1348     }
1349     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1350     return $objstring;
1351 }
1352
1353 function common_valid_http_url($url)
1354 {
1355     return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1356 }
1357
1358 function common_valid_tag($tag)
1359 {
1360     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1361         return (Validate::email($matches[1]) ||
1362                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1363     }
1364     return false;
1365 }
1366
1367 /* Following functions are copied from MediaWiki GlobalFunctions.php
1368  * and written by Evan Prodromou. */
1369
1370 function common_accept_to_prefs($accept, $def = '*/*')
1371 {
1372     // No arg means accept anything (per HTTP spec)
1373     if(!$accept) {
1374         return array($def => 1);
1375     }
1376
1377     $prefs = array();
1378
1379     $parts = explode(',', $accept);
1380
1381     foreach($parts as $part) {
1382         // FIXME: doesn't deal with params like 'text/html; level=1'
1383         @list($value, $qpart) = explode(';', trim($part));
1384         $match = array();
1385         if(!isset($qpart)) {
1386             $prefs[$value] = 1;
1387         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1388             $prefs[$value] = $match[1];
1389         }
1390     }
1391
1392     return $prefs;
1393 }
1394
1395 function common_mime_type_match($type, $avail)
1396 {
1397     if(array_key_exists($type, $avail)) {
1398         return $type;
1399     } else {
1400         $parts = explode('/', $type);
1401         if(array_key_exists($parts[0] . '/*', $avail)) {
1402             return $parts[0] . '/*';
1403         } elseif(array_key_exists('*/*', $avail)) {
1404             return '*/*';
1405         } else {
1406             return null;
1407         }
1408     }
1409 }
1410
1411 function common_negotiate_type($cprefs, $sprefs)
1412 {
1413     $combine = array();
1414
1415     foreach(array_keys($sprefs) as $type) {
1416         $parts = explode('/', $type);
1417         if($parts[1] != '*') {
1418             $ckey = common_mime_type_match($type, $cprefs);
1419             if($ckey) {
1420                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1421             }
1422         }
1423     }
1424
1425     foreach(array_keys($cprefs) as $type) {
1426         $parts = explode('/', $type);
1427         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1428             $skey = common_mime_type_match($type, $sprefs);
1429             if($skey) {
1430                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1431             }
1432         }
1433     }
1434
1435     $bestq = 0;
1436     $besttype = 'text/html';
1437
1438     foreach(array_keys($combine) as $type) {
1439         if($combine[$type] > $bestq) {
1440             $besttype = $type;
1441             $bestq = $combine[$type];
1442         }
1443     }
1444
1445     if ('text/html' === $besttype) {
1446         return "text/html; charset=utf-8";
1447     }
1448     return $besttype;
1449 }
1450
1451 function common_config($main, $sub)
1452 {
1453     global $config;
1454     return (array_key_exists($main, $config) &&
1455             array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
1456 }
1457
1458 function common_copy_args($from)
1459 {
1460     $to = array();
1461     $strip = get_magic_quotes_gpc();
1462     foreach ($from as $k => $v) {
1463         $to[$k] = ($strip) ? stripslashes($v) : $v;
1464     }
1465     return $to;
1466 }
1467
1468 /**
1469  * Neutralise the evil effects of magic_quotes_gpc in the current request.
1470  * This is used before handing a request off to OAuthRequest::from_request.
1471  * @fixme Doesn't consider vars other than _POST and _GET?
1472  * @fixme Can't be undone and could corrupt data if run twice.
1473  */
1474 function common_remove_magic_from_request()
1475 {
1476     if(get_magic_quotes_gpc()) {
1477         $_POST=array_map('stripslashes',$_POST);
1478         $_GET=array_map('stripslashes',$_GET);
1479     }
1480 }
1481
1482 function common_user_uri(&$user)
1483 {
1484     return common_local_url('userbyid', array('id' => $user->id),
1485                             null, null, false);
1486 }
1487
1488 function common_notice_uri(&$notice)
1489 {
1490     return common_local_url('shownotice',
1491                             array('notice' => $notice->id));
1492 }
1493
1494 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1495
1496 function common_confirmation_code($bits)
1497 {
1498     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1499     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1500     $chars = ceil($bits/5);
1501     $code = '';
1502     for ($i = 0; $i < $chars; $i++) {
1503         // XXX: convert to string and back
1504         $num = hexdec(common_good_rand(1));
1505         // XXX: randomness is too precious to throw away almost
1506         // 40% of the bits we get!
1507         $code .= $codechars[$num%32];
1508     }
1509     return $code;
1510 }
1511
1512 // convert markup to HTML
1513
1514 function common_markup_to_html($c)
1515 {
1516     $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1517     $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1518     $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1519     return Markdown($c);
1520 }
1521
1522 function common_profile_uri($profile)
1523 {
1524     if (!$profile) {
1525         return null;
1526     }
1527     $user = User::staticGet($profile->id);
1528     if ($user) {
1529         return $user->uri;
1530     }
1531
1532     $remote = Remote_profile::staticGet($profile->id);
1533     if ($remote) {
1534         return $remote->uri;
1535     }
1536     // XXX: this is a very bad profile!
1537     return null;
1538 }
1539
1540 function common_canonical_sms($sms)
1541 {
1542     // strip non-digits
1543     preg_replace('/\D/', '', $sms);
1544     return $sms;
1545 }
1546
1547 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1548 {
1549     switch ($errno) {
1550
1551      case E_ERROR:
1552      case E_COMPILE_ERROR:
1553      case E_CORE_ERROR:
1554      case E_USER_ERROR:
1555      case E_PARSE:
1556      case E_RECOVERABLE_ERROR:
1557         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
1558         die();
1559         break;
1560
1561      case E_WARNING:
1562      case E_COMPILE_WARNING:
1563      case E_CORE_WARNING:
1564      case E_USER_WARNING:
1565         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1566         break;
1567
1568      case E_NOTICE:
1569      case E_USER_NOTICE:
1570         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1571         break;
1572
1573      case E_STRICT:
1574      case E_DEPRECATED:
1575      case E_USER_DEPRECATED:
1576         // XXX: config variable to log this stuff, too
1577         break;
1578
1579      default:
1580         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
1581         die();
1582         break;
1583     }
1584
1585     // FIXME: show error page if we're on the Web
1586     /* Don't execute PHP internal error handler */
1587     return true;
1588 }
1589
1590 function common_session_token()
1591 {
1592     common_ensure_session();
1593     if (!array_key_exists('token', $_SESSION)) {
1594         $_SESSION['token'] = common_good_rand(64);
1595     }
1596     return $_SESSION['token'];
1597 }
1598
1599 function common_cache_key($extra)
1600 {
1601     return Cache::key($extra);
1602 }
1603
1604 function common_keyize($str)
1605 {
1606     return Cache::keyize($str);
1607 }
1608
1609 function common_memcache()
1610 {
1611     return Cache::instance();
1612 }
1613
1614 function common_license_terms($uri)
1615 {
1616     if(preg_match('/creativecommons.org\/licenses\/([^\/]+)/', $uri, $matches)) {
1617         return explode('-',$matches[1]);
1618     }
1619     return array($uri);
1620 }
1621
1622 function common_compatible_license($from, $to)
1623 {
1624     $from_terms = common_license_terms($from);
1625     // public domain and cc-by are compatible with everything
1626     if(count($from_terms) == 1 && ($from_terms[0] == 'publicdomain' || $from_terms[0] == 'by')) {
1627         return true;
1628     }
1629     $to_terms = common_license_terms($to);
1630     // sa is compatible across versions. IANAL
1631     if(in_array('sa',$from_terms) || in_array('sa',$to_terms)) {
1632         return count(array_diff($from_terms, $to_terms)) == 0;
1633     }
1634     // XXX: better compatibility check needed here!
1635     // Should at least normalise URIs
1636     return ($from == $to);
1637 }
1638
1639 /**
1640  * returns a quoted table name, if required according to config
1641  */
1642 function common_database_tablename($tablename)
1643 {
1644
1645   if(common_config('db','quote_identifiers')) {
1646       $tablename = '"'. $tablename .'"';
1647   }
1648   //table prefixes could be added here later
1649   return $tablename;
1650 }
1651
1652 /**
1653  * Shorten a URL with the current user's configured shortening service,
1654  * or ur1.ca if configured, or not at all if no shortening is set up.
1655  * Length is not considered.
1656  *
1657  * @param string $long_url
1658  * @return string may return the original URL if shortening failed
1659  *
1660  * @fixme provide a way to specify a particular shortener
1661  * @fixme provide a way to specify to use a given user's shortening preferences
1662  */
1663 function common_shorten_url($long_url)
1664 {
1665     $long_url = trim($long_url);
1666     $user = common_current_user();
1667     if (empty($user)) {
1668         // common current user does not find a user when called from the XMPP daemon
1669         // therefore we'll set one here fix, so that XMPP given URLs may be shortened
1670         $shortenerName = 'ur1.ca';
1671     } else {
1672         $shortenerName = $user->urlshorteningservice;
1673     }
1674
1675     if(Event::handle('StartShortenUrl', array($long_url,$shortenerName,&$shortenedUrl))){
1676         //URL wasn't shortened, so return the long url
1677         return $long_url;
1678     }else{
1679         //URL was shortened, so return the result
1680         return trim($shortenedUrl);
1681     }
1682 }
1683
1684 /**
1685  * @return mixed array($proxy, $ip) for web requests; proxy may be null
1686  *               null if not a web request
1687  *
1688  * @fixme X-Forwarded-For can be chained by multiple proxies;
1689           we should parse the list and provide a cleaner array
1690  * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
1691  * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
1692  *        use function to get exact request headers from Apache if possible.
1693  */
1694 function common_client_ip()
1695 {
1696     if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
1697         return null;
1698     }
1699
1700     if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
1701         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1702             $proxy = $_SERVER['HTTP_CLIENT_IP'];
1703         } else {
1704             $proxy = $_SERVER['REMOTE_ADDR'];
1705         }
1706         $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
1707     } else {
1708         $proxy = null;
1709         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1710             $ip = $_SERVER['HTTP_CLIENT_IP'];
1711         } else {
1712             $ip = $_SERVER['REMOTE_ADDR'];
1713         }
1714     }
1715
1716     return array($proxy, $ip);
1717 }
1718
1719 function common_url_to_nickname($url)
1720 {
1721     static $bad = array('query', 'user', 'password', 'port', 'fragment');
1722
1723     $parts = parse_url($url);
1724
1725     # If any of these parts exist, this won't work
1726
1727     foreach ($bad as $badpart) {
1728         if (array_key_exists($badpart, $parts)) {
1729             return null;
1730         }
1731     }
1732
1733     # We just have host and/or path
1734
1735     # If it's just a host...
1736     if (array_key_exists('host', $parts) &&
1737         (!array_key_exists('path', $parts) || strcmp($parts['path'], '/') == 0))
1738     {
1739         $hostparts = explode('.', $parts['host']);
1740
1741         # Try to catch common idiom of nickname.service.tld
1742
1743         if ((count($hostparts) > 2) &&
1744             (strlen($hostparts[count($hostparts) - 2]) > 3) && # try to skip .co.uk, .com.au
1745             (strcmp($hostparts[0], 'www') != 0))
1746         {
1747             return common_nicknamize($hostparts[0]);
1748         } else {
1749             # Do the whole hostname
1750             return common_nicknamize($parts['host']);
1751         }
1752     } else {
1753         if (array_key_exists('path', $parts)) {
1754             # Strip starting, ending slashes
1755             $path = preg_replace('@/$@', '', $parts['path']);
1756             $path = preg_replace('@^/@', '', $path);
1757             $path = basename($path);
1758             if ($path) {
1759                 return common_nicknamize($path);
1760             }
1761         }
1762     }
1763
1764     return null;
1765 }
1766
1767 function common_nicknamize($str)
1768 {
1769     $str = preg_replace('/\W/', '', $str);
1770     return strtolower($str);
1771 }