lib/util.php

   1 <?php
   2 /*
   3  * Laconica - a distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, Control Yourself, 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     $language = common_language();
  55     // So we don't have to make people install the gettext locales
  56     $locale_set = common_init_locale($language);
  57     bindtextdomain("laconica", common_config('site','locale_path'));
  58     bind_textdomain_codeset("laconica", "UTF-8");
  59     textdomain("laconica");
  60     setlocale(LC_CTYPE, 'C');
  61     if(!$locale_set) {
  62         common_log(LOG_INFO,'Language requested:'.$language.' - locale could not be set:',__FILE__);
  63     }
  64 }
  65
  66 function common_timezone()
  67 {
  68     if (common_logged_in()) {
  69         $user = common_current_user();
  70         if ($user->timezone) {
  71             return $user->timezone;
  72         }
  73     }
  74
  75     return common_config('site', 'timezone');
  76 }
  77
  78 function common_language()
  79 {
  80
  81     // If there is a user logged in and they've set a language preference
  82     // then return that one...
  83     if (_have_config() && common_logged_in()) {
  84         $user = common_current_user();
  85         $user_language = $user->language;
  86         if ($user_language)
  87           return $user_language;
  88     }
  89
  90     // Otherwise, find the best match for the languages requested by the
  91     // user's browser...
  92     $httplang = isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? $_SERVER['HTTP_ACCEPT_LANGUAGE'] : null;
  93     if (!empty($httplang)) {
  94         $language = client_prefered_language($httplang);
  95         if ($language)
  96           return $language;
  97     }
  98
  99     // Finally, if none of the above worked, use the site's default...
 100     return common_config('site', 'language');
 101 }
 102 // salted, hashed passwords are stored in the DB
 103
 104 function common_munge_password($password, $id)
 105 {
 106     return md5($password . $id);
 107 }
 108
 109 // check if a username exists and has matching password
 110 function common_check_user($nickname, $password)
 111 {
 112     // NEVER allow blank passwords, even if they match the DB
 113     if (mb_strlen($password) == 0) {
 114         return false;
 115     }
 116     $user = User::staticGet('nickname', $nickname);
 117     if (is_null($user) || $user === false) {
 118         return false;
 119     } else {
 120         if (0 == strcmp(common_munge_password($password, $user->id),
 121                         $user->password)) {
 122             return $user;
 123         } else {
 124             return false;
 125         }
 126     }
 127 }
 128
 129 // is the current user logged in?
 130 function common_logged_in()
 131 {
 132     return (!is_null(common_current_user()));
 133 }
 134
 135 function common_have_session()
 136 {
 137     return (0 != strcmp(session_id(), ''));
 138 }
 139
 140 function common_ensure_session()
 141 {
 142     $c = null;
 143     if (array_key_exists(session_name(), $_COOKIE)) {
 144         $c = $_COOKIE[session_name()];
 145     }
 146     if (!common_have_session()) {
 147         if (common_config('sessions', 'handle')) {
 148             Session::setSaveHandler();
 149         }
 150         @session_start();
 151         if (!isset($_SESSION['started'])) {
 152             $_SESSION['started'] = time();
 153             if (!empty($c)) {
 154                 common_log(LOG_WARNING, 'Session cookie "' . $_COOKIE[session_name()] . '" ' .
 155                            ' is set but started value is null');
 156             }
 157         }
 158     }
 159 }
 160
 161 // Three kinds of arguments:
 162 // 1) a user object
 163 // 2) a nickname
 164 // 3) null to clear
 165
 166 // Initialize to false; set to null if none found
 167
 168 $_cur = false;
 169
 170 function common_set_user($user)
 171 {
 172
 173     global $_cur;
 174
 175     if (is_null($user) && common_have_session()) {
 176         $_cur = null;
 177         unset($_SESSION['userid']);
 178         return true;
 179     } else if (is_string($user)) {
 180         $nickname = $user;
 181         $user = User::staticGet('nickname', $nickname);
 182     } else if (!($user instanceof User)) {
 183         return false;
 184     }
 185
 186     if ($user) {
 187         common_ensure_session();
 188         $_SESSION['userid'] = $user->id;
 189         $_cur = $user;
 190         return $_cur;
 191     }
 192     return false;
 193 }
 194
 195 function common_set_cookie($key, $value, $expiration=0)
 196 {
 197     $path = common_config('site', 'path');
 198     $server = common_config('site', 'server');
 199
 200     if ($path && ($path != '/')) {
 201         $cookiepath = '/' . $path . '/';
 202     } else {
 203         $cookiepath = '/';
 204     }
 205     return setcookie($key,
 206                      $value,
 207                      $expiration,
 208                      $cookiepath,
 209                      $server);
 210 }
 211
 212 define('REMEMBERME', 'rememberme');
 213 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
 214
 215 function common_rememberme($user=null)
 216 {
 217     if (!$user) {
 218         $user = common_current_user();
 219         if (!$user) {
 220             common_debug('No current user to remember', __FILE__);
 221             return false;
 222         }
 223     }
 224
 225     $rm = new Remember_me();
 226
 227     $rm->code = common_good_rand(16);
 228     $rm->user_id = $user->id;
 229
 230     // Wrap the insert in some good ol' fashioned transaction code
 231
 232     $rm->query('BEGIN');
 233
 234     $result = $rm->insert();
 235
 236     if (!$result) {
 237         common_log_db_error($rm, 'INSERT', __FILE__);
 238         common_debug('Error adding rememberme record for ' . $user->nickname, __FILE__);
 239         return false;
 240     }
 241
 242     $rm->query('COMMIT');
 243
 244     common_debug('Inserted rememberme record (' . $rm->code . ', ' . $rm->user_id . '); result = ' . $result . '.', __FILE__);
 245
 246     $cookieval = $rm->user_id . ':' . $rm->code;
 247
 248     common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
 249
 250     common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
 251
 252     return true;
 253 }
 254
 255 function common_remembered_user()
 256 {
 257
 258     $user = null;
 259
 260     $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
 261
 262     if (!$packed) {
 263         return null;
 264     }
 265
 266     list($id, $code) = explode(':', $packed);
 267
 268     if (!$id || !$code) {
 269         common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
 270         common_forgetme();
 271         return null;
 272     }
 273
 274     $rm = Remember_me::staticGet($code);
 275
 276     if (!$rm) {
 277         common_log(LOG_WARNING, 'No such remember code: ' . $code);
 278         common_forgetme();
 279         return null;
 280     }
 281
 282     if ($rm->user_id != $id) {
 283         common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
 284         common_forgetme();
 285         return null;
 286     }
 287
 288     $user = User::staticGet($rm->user_id);
 289
 290     if (!$user) {
 291         common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
 292         common_forgetme();
 293         return null;
 294     }
 295
 296     // successful!
 297     $result = $rm->delete();
 298
 299     if (!$result) {
 300         common_log_db_error($rm, 'DELETE', __FILE__);
 301         common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
 302         common_forgetme();
 303         return null;
 304     }
 305
 306     common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
 307
 308     common_set_user($user);
 309     common_real_login(false);
 310
 311     // We issue a new cookie, so they can log in
 312     // automatically again after this session
 313
 314     common_rememberme($user);
 315
 316     return $user;
 317 }
 318
 319 // must be called with a valid user!
 320
 321 function common_forgetme()
 322 {
 323     common_set_cookie(REMEMBERME, '', 0);
 324 }
 325
 326 // who is the current user?
 327 function common_current_user()
 328 {
 329     global $_cur;
 330
 331     if (!_have_config()) {
 332         return null;
 333     }
 334
 335     if ($_cur === false) {
 336
 337         if (isset($_REQUEST[session_name()]) || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
 338             common_ensure_session();
 339             $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
 340             if ($id) {
 341                 $_cur = User::staticGet($id);
 342                 return $_cur;
 343             }
 344         }
 345
 346         // that didn't work; try to remember; will init $_cur to null on failure
 347         $_cur = common_remembered_user();
 348
 349         if ($_cur) {
 350             common_debug("Got User " . $_cur->nickname);
 351             common_debug("Faking session on remembered user");
 352             // XXX: Is this necessary?
 353             $_SESSION['userid'] = $_cur->id;
 354         }
 355     }
 356
 357     return $_cur;
 358 }
 359
 360 // Logins that are 'remembered' aren't 'real' -- they're subject to
 361 // cookie-stealing. So, we don't let them do certain things. New reg,
 362 // OpenID, and password logins _are_ real.
 363
 364 function common_real_login($real=true)
 365 {
 366     common_ensure_session();
 367     $_SESSION['real_login'] = $real;
 368 }
 369
 370 function common_is_real_login()
 371 {
 372     return common_logged_in() && $_SESSION['real_login'];
 373 }
 374
 375 // get canonical version of nickname for comparison
 376 function common_canonical_nickname($nickname)
 377 {
 378     // XXX: UTF-8 canonicalization (like combining chars)
 379     return strtolower($nickname);
 380 }
 381
 382 // get canonical version of email for comparison
 383 function common_canonical_email($email)
 384 {
 385     // XXX: canonicalize UTF-8
 386     // XXX: lcase the domain part
 387     return $email;
 388 }
 389
 390 function common_render_content($text, $notice)
 391 {
 392     $r = common_render_text($text);
 393     $id = $notice->profile_id;
 394     $r = preg_replace('/(^|\s+)@([A-Za-z0-9]{1,64})/e', "'\\1@'.common_at_link($id, '\\2')", $r);
 395     $r = preg_replace('/^T ([A-Z0-9]{1,64}) /e', "'T '.common_at_link($id, '\\1').' '", $r);
 396     $r = preg_replace('/(^|\s+)@#([A-Za-z0-9]{1,64})/e', "'\\1@#'.common_at_hash_link($id, '\\2')", $r);
 397     $r = preg_replace('/(^|\s)!([A-Za-z0-9]{1,64})/e', "'\\1!'.common_group_link($id, '\\2')", $r);
 398     return $r;
 399 }
 400
 401 function common_render_text($text)
 402 {
 403     $r = htmlspecialchars($text);
 404
 405     $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
 406     $r = common_replace_urls_callback($r, 'common_linkify');
 407     $r = preg_replace('/(^|\(|\[|\s+)#([\pL\pN_\-\.]{1,64})/e', "'\\1#'.common_tag_link('\\2')", $r);
 408     // XXX: machine tags
 409     return $r;
 410 }
 411
 412 function common_replace_urls_callback($text, $callback, $notice_id = null) {
 413     // Start off with a regex
 414     $regex = '#'.
 415     '(?:^|\s+)('.
 416         '(?:'.
 417             '(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|irc)://'.
 418             '|'.
 419             '(?:mailto|aim|tel|xmpp):'.
 420         ')?'.
 421         '(?:'.
 422         '(?:(?: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
 423         '|(?:'.
 424             '(?:[0-9a-f]{1,4}:){1,1}(?::[0-9a-f]{1,4}){1,6}|'. //IPv6
 425             '(?:[0-9a-f]{1,4}:){1,2}(?::[0-9a-f]{1,4}){1,5}|'.
 426             '(?:[0-9a-f]{1,4}:){1,3}(?::[0-9a-f]{1,4}){1,4}|'.
 427             '(?:[0-9a-f]{1,4}:){1,4}(?::[0-9a-f]{1,4}){1,3}|'.
 428             '(?:[0-9a-f]{1,4}:){1,5}(?::[0-9a-f]{1,4}){1,2}|'.
 429             '(?:[0-9a-f]{1,4}:){1,6}(?::[0-9a-f]{1,4}){1,1}|'.
 430             '(?:(?:[0-9a-f]{1,4}:){1,7}|:):|'.
 431             ':(?::[0-9a-f]{1,4}){1,7}|'.
 432             '(?:(?:(?:[0-9a-f]{1,4}:){6})(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3})|'.
 433             '(?:(?:[0-9a-f]{1,4}:){5}[0-9a-f]{1,4}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3})|'.
 434             '(?:[0-9a-f]{1,4}:){5}:[0-9a-f]{1,4}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|'.
 435             '(?:[0-9a-f]{1,4}:){1,1}(?::[0-9a-f]{1,4}){1,4}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|'.
 436             '(?:[0-9a-f]{1,4}:){1,2}(?::[0-9a-f]{1,4}){1,3}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|'.
 437             '(?:[0-9a-f]{1,4}:){1,3}(?::[0-9a-f]{1,4}){1,2}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|'.
 438             '(?:[0-9a-f]{1,4}:){1,4}(?::[0-9a-f]{1,4}){1,1}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|'.
 439             '(?:(?:[0-9a-f]{1,4}:){1,5}|:):(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|'.
 440             ':(?::[0-9a-f]{1,4}){1,5}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}'.
 441         ')|'.
 442         '(?:[^.\s/:]+\.)+'. //DNS
 443         '(?:museum|travel|onion|[a-z]{2,4})'.
 444         ')'.
 445         '(?:[:/][^\s]*)?'.
 446     ')'.
 447     '#ix';
 448
 449     $callback_helper = curry(callback_helper, 3);
 450     return preg_replace_callback($regex, $callback_helper($callback,$notice_id) ,$text);
 451 }
 452
 453 function callback_helper($callback, $notice_id, $matches) {
 454     if(empty($notice_id)){
 455         return $callback($matches[1],$notice_id);
 456     }else{
 457         return $callback($matches[1]);
 458     }
 459 }
 460
 461 function curry($func, $arity) {
 462     return create_function('', "
 463         \$args = func_get_args();
 464         if(count(\$args) >= $arity)
 465             return call_user_func_array('$func', \$args);
 466         \$args = var_export(\$args, 1);
 467         return create_function('','
 468             \$a = func_get_args();
 469             \$z = ' . \$args . ';
 470             \$a = array_merge(\$z,\$a);
 471             return call_user_func_array(\'$func\', \$a);
 472         ');
 473     ");
 474 }
 475
 476 function common_linkify($url) {
 477     // It comes in special'd, so we unspecial it before passing to the stringifying
 478     // functions
 479     $url = htmlspecialchars_decode($url);
 480
 481     $canon = File_redirection::_canonUrl($url);
 482
 483     $longurl_data = File_redirection::where($url);
 484     if (is_array($longurl_data)) {
 485         $longurl = $longurl_data['url'];
 486     } elseif (is_string($longurl_data)) {
 487         $longurl = $longurl_data;
 488     } else {
 489         throw new ServerException("Can't linkify url '$url'");
 490     }
 491
 492     $attrs = array('href' => $canon, 'rel' => 'external');
 493
 494     $is_attachment = false;
 495     $attachment_id = null;
 496     $has_thumb = false;
 497
 498     // Check to see whether there's a filename associated with this URL.
 499     // If there is, it's an upload and qualifies as an attachment
 500
 501     $localfile = File::staticGet('url', $longurl);
 502
 503     if (!empty($localfile)) {
 504         if (isset($localfile->filename)) {
 505             $is_attachment = true;
 506             $attachment_id = $localfile->id;
 507         }
 508     }
 509
 510     // if this URL is an attachment, then we set class='attachment' and id='attahcment-ID'
 511     // where ID is the id of the attachment for the given URL.
 512     //
 513     // we need a better test telling what can be shown as an attachment
 514     // we're currently picking up oembeds only.
 515     // I think the best option is another file_view table in the db
 516     // and associated dbobject.
 517
 518     $query = "select file_oembed.file_id as file_id from file join file_oembed on file.id = file_oembed.file_id where file.url='$longurl'";
 519     $file = new File;
 520     $file->query($query);
 521     $file->fetch();
 522
 523     if (!empty($file->file_id)) {
 524         $is_attachment = true;
 525         $attachment_id = $file->file_id;
 526
 527         $query = "select file_thumbnail.file_id as file_id from file join file_thumbnail on file.id = file_thumbnail.file_id where file.url='$longurl'";
 528         $file2 = new File;
 529         $file2->query($query);
 530         $file2->fetch();
 531
 532         if (!empty($file2)) {
 533             $has_thumb = true;
 534         }
 535     }
 536
 537     // Add clippy
 538     if ($is_attachment) {
 539         $attrs['class'] = 'attachment';
 540         if ($has_thumb) {
 541             $attrs['class'] = 'attachment thumbnail';
 542         }
 543         $attrs['id'] = "attachment-{$attachment_id}";
 544     }
 545
 546     return XMLStringer::estring('a', $attrs, $url);
 547 }
 548
 549 function common_shorten_links($text)
 550 {
 551     if (mb_strlen($text) <= 140) return $text;
 552     return common_replace_urls_callback($text, array('File_redirection', 'makeShort'));
 553 }
 554
 555 function common_xml_safe_str($str)
 556 {
 557     // Neutralize control codes and surrogates
 558         return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
 559 }
 560
 561 function common_tag_link($tag)
 562 {
 563     $canonical = common_canonical_tag($tag);
 564     $url = common_local_url('tag', array('tag' => $canonical));
 565     $xs = new XMLStringer();
 566     $xs->elementStart('span', 'tag');
 567     $xs->element('a', array('href' => $url,
 568                             'rel' => 'tag'),
 569                  $tag);
 570     $xs->elementEnd('span');
 571     return $xs->getString();
 572 }
 573
 574 function common_canonical_tag($tag)
 575 {
 576   $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
 577   return str_replace(array('-', '_', '.'), '', $tag);
 578 }
 579
 580 function common_valid_profile_tag($str)
 581 {
 582     return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
 583 }
 584
 585 function common_at_link($sender_id, $nickname)
 586 {
 587     $sender = Profile::staticGet($sender_id);
 588     $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
 589     if ($recipient) {
 590         $user = User::staticGet('id', $recipient->id);
 591         if ($user) {
 592             $url = common_local_url('userbyid', array('id' => $user->id));
 593         } else {
 594             $url = $recipient->profileurl;
 595         }
 596         $xs = new XMLStringer(false);
 597         $attrs = array('href' => $url,
 598                        'class' => 'url');
 599         if (!empty($recipient->fullname)) {
 600             $attrs['title'] = $recipient->fullname . ' (' . $recipient->nickname . ')';
 601         }
 602         $xs->elementStart('span', 'vcard');
 603         $xs->elementStart('a', $attrs);
 604         $xs->element('span', 'fn nickname', $nickname);
 605         $xs->elementEnd('a');
 606         $xs->elementEnd('span');
 607         return $xs->getString();
 608     } else {
 609         return $nickname;
 610     }
 611 }
 612
 613 function common_group_link($sender_id, $nickname)
 614 {
 615     $sender = Profile::staticGet($sender_id);
 616     $group = User_group::getForNickname($nickname);
 617     if ($group && $sender->isMember($group)) {
 618         $attrs = array('href' => $group->permalink(),
 619                        'class' => 'url');
 620         if (!empty($group->fullname)) {
 621             $attrs['title'] = $group->fullname . ' (' . $group->nickname . ')';
 622         }
 623         $xs = new XMLStringer();
 624         $xs->elementStart('span', 'vcard');
 625         $xs->elementStart('a', $attrs);
 626         $xs->element('span', 'fn nickname', $nickname);
 627         $xs->elementEnd('a');
 628         $xs->elementEnd('span');
 629         return $xs->getString();
 630     } else {
 631         return $nickname;
 632     }
 633 }
 634
 635 function common_at_hash_link($sender_id, $tag)
 636 {
 637     $user = User::staticGet($sender_id);
 638     if (!$user) {
 639         return $tag;
 640     }
 641     $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
 642     if ($tagged) {
 643         $url = common_local_url('subscriptions',
 644                                 array('nickname' => $user->nickname,
 645                                       'tag' => $tag));
 646         $xs = new XMLStringer();
 647         $xs->elementStart('span', 'tag');
 648         $xs->element('a', array('href' => $url,
 649                                 'rel' => $tag),
 650                      $tag);
 651         $xs->elementEnd('span');
 652         return $xs->getString();
 653     } else {
 654         return $tag;
 655     }
 656 }
 657
 658 function common_relative_profile($sender, $nickname, $dt=null)
 659 {
 660     // Try to find profiles this profile is subscribed to that have this nickname
 661     $recipient = new Profile();
 662     // XXX: use a join instead of a subquery
 663     $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
 664     $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
 665     if ($recipient->find(true)) {
 666         // XXX: should probably differentiate between profiles with
 667         // the same name by date of most recent update
 668         return $recipient;
 669     }
 670     // Try to find profiles that listen to this profile and that have this nickname
 671     $recipient = new Profile();
 672     // XXX: use a join instead of a subquery
 673     $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
 674     $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
 675     if ($recipient->find(true)) {
 676         // XXX: should probably differentiate between profiles with
 677         // the same name by date of most recent update
 678         return $recipient;
 679     }
 680     // If this is a local user, try to find a local user with that nickname.
 681     $sender = User::staticGet($sender->id);
 682     if ($sender) {
 683         $recipient_user = User::staticGet('nickname', $nickname);
 684         if ($recipient_user) {
 685             return $recipient_user->getProfile();
 686         }
 687     }
 688     // Otherwise, no links. @messages from local users to remote users,
 689     // or from remote users to other remote users, are just
 690     // outside our ability to make intelligent guesses about
 691     return null;
 692 }
 693
 694 function common_local_url($action, $args=null, $params=null, $fragment=null)
 695 {
 696     static $sensitive = array('login', 'register', 'passwordsettings',
 697                               'twittersettings', 'finishopenidlogin',
 698                               'finishaddopenid', 'api');
 699
 700     $r = Router::get();
 701     $path = $r->build($action, $args, $params, $fragment);
 702
 703     $ssl = in_array($action, $sensitive);
 704
 705     if (common_config('site','fancy')) {
 706         $url = common_path(mb_substr($path, 1), $ssl);
 707     } else {
 708         if (mb_strpos($path, '/index.php') === 0) {
 709             $url = common_path(mb_substr($path, 1), $ssl);
 710         } else {
 711             $url = common_path('index.php'.$path, $ssl);
 712         }
 713     }
 714     return $url;
 715 }
 716
 717 function common_path($relative, $ssl=false)
 718 {
 719     $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
 720
 721     if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
 722         || common_config('site', 'ssl') === 'always') {
 723         $proto = 'https';
 724         if (is_string(common_config('site', 'sslserver')) &&
 725             mb_strlen(common_config('site', 'sslserver')) > 0) {
 726             $serverpart = common_config('site', 'sslserver');
 727         } else {
 728             $serverpart = common_config('site', 'server');
 729         }
 730     } else {
 731         $proto = 'http';
 732         $serverpart = common_config('site', 'server');
 733     }
 734
 735     return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
 736 }
 737
 738 function common_date_string($dt)
 739 {
 740     // XXX: do some sexy date formatting
 741     // return date(DATE_RFC822, $dt);
 742     $t = strtotime($dt);
 743     $now = time();
 744     $diff = $now - $t;
 745
 746     if ($now < $t) { // that shouldn't happen!
 747         return common_exact_date($dt);
 748     } else if ($diff < 60) {
 749         return _('a few seconds ago');
 750     } else if ($diff < 92) {
 751         return _('about a minute ago');
 752     } else if ($diff < 3300) {
 753         return sprintf(_('about %d minutes ago'), round($diff/60));
 754     } else if ($diff < 5400) {
 755         return _('about an hour ago');
 756     } else if ($diff < 22 * 3600) {
 757         return sprintf(_('about %d hours ago'), round($diff/3600));
 758     } else if ($diff < 37 * 3600) {
 759         return _('about a day ago');
 760     } else if ($diff < 24 * 24 * 3600) {
 761         return sprintf(_('about %d days ago'), round($diff/(24*3600)));
 762     } else if ($diff < 46 * 24 * 3600) {
 763         return _('about a month ago');
 764     } else if ($diff < 330 * 24 * 3600) {
 765         return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
 766     } else if ($diff < 480 * 24 * 3600) {
 767         return _('about a year ago');
 768     } else {
 769         return common_exact_date($dt);
 770     }
 771 }
 772
 773 function common_exact_date($dt)
 774 {
 775     static $_utc;
 776     static $_siteTz;
 777
 778     if (!$_utc) {
 779         $_utc = new DateTimeZone('UTC');
 780         $_siteTz = new DateTimeZone(common_timezone());
 781     }
 782
 783     $dateStr = date('d F Y H:i:s', strtotime($dt));
 784     $d = new DateTime($dateStr, $_utc);
 785     $d->setTimezone($_siteTz);
 786     return $d->format(DATE_RFC850);
 787 }
 788
 789 function common_date_w3dtf($dt)
 790 {
 791     $dateStr = date('d F Y H:i:s', strtotime($dt));
 792     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 793     $d->setTimezone(new DateTimeZone(common_timezone()));
 794     return $d->format(DATE_W3C);
 795 }
 796
 797 function common_date_rfc2822($dt)
 798 {
 799     $dateStr = date('d F Y H:i:s', strtotime($dt));
 800     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 801     $d->setTimezone(new DateTimeZone(common_timezone()));
 802     return $d->format('r');
 803 }
 804
 805 function common_date_iso8601($dt)
 806 {
 807     $dateStr = date('d F Y H:i:s', strtotime($dt));
 808     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 809     $d->setTimezone(new DateTimeZone(common_timezone()));
 810     return $d->format('c');
 811 }
 812
 813 function common_sql_now()
 814 {
 815     return common_sql_date(time());
 816 }
 817
 818 function common_sql_date($datetime)
 819 {
 820     return strftime('%Y-%m-%d %H:%M:%S', $datetime);
 821 }
 822
 823 function common_redirect($url, $code=307)
 824 {
 825     static $status = array(301 => "Moved Permanently",
 826                            302 => "Found",
 827                            303 => "See Other",
 828                            307 => "Temporary Redirect");
 829
 830     header('HTTP/1.1 '.$code.' '.$status[$code]);
 831     header("Location: $url");
 832
 833     $xo = new XMLOutputter();
 834     $xo->startXML('a',
 835                   '-//W3C//DTD XHTML 1.0 Strict//EN',
 836                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
 837     $xo->element('a', array('href' => $url), $url);
 838     $xo->endXML();
 839     exit;
 840 }
 841
 842 function common_broadcast_notice($notice, $remote=false)
 843 {
 844     return common_enqueue_notice($notice);
 845 }
 846
 847 // Stick the notice on the queue
 848
 849 function common_enqueue_notice($notice)
 850 {
 851     static $localTransports = array('omb',
 852                                     'twitter',
 853                                     'facebook',
 854                                     'ping');
 855     static $allTransports = array('sms');
 856
 857     $transports = $allTransports;
 858
 859     $xmpp = common_config('xmpp', 'enabled');
 860
 861     if ($xmpp) {
 862         $transports[] = 'jabber';
 863     }
 864
 865     if ($notice->is_local == Notice::LOCAL_PUBLIC ||
 866         $notice->is_local == Notice::LOCAL_NONPUBLIC) {
 867         $transports = array_merge($transports, $localTransports);
 868         if ($xmpp) {
 869             $transports[] = 'public';
 870         }
 871     }
 872
 873     $qm = QueueManager::get();
 874
 875     foreach ($transports as $transport)
 876     {
 877         $qm->enqueue($notice, $transport);
 878     }
 879
 880     return true;
 881 }
 882
 883 function common_broadcast_profile($profile)
 884 {
 885     // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
 886     require_once(INSTALLDIR.'/lib/omb.php');
 887     omb_broadcast_profile($profile);
 888     // XXX: Other broadcasts...?
 889     return true;
 890 }
 891
 892 function common_profile_url($nickname)
 893 {
 894     return common_local_url('showstream', array('nickname' => $nickname));
 895 }
 896
 897 // Should make up a reasonable root URL
 898
 899 function common_root_url($ssl=false)
 900 {
 901     return common_path('', $ssl);
 902 }
 903
 904 // returns $bytes bytes of random data as a hexadecimal string
 905 // "good" here is a goal and not a guarantee
 906
 907 function common_good_rand($bytes)
 908 {
 909     // XXX: use random.org...?
 910     if (@file_exists('/dev/urandom')) {
 911         return common_urandom($bytes);
 912     } else { // FIXME: this is probably not good enough
 913         return common_mtrand($bytes);
 914     }
 915 }
 916
 917 function common_urandom($bytes)
 918 {
 919     $h = fopen('/dev/urandom', 'rb');
 920     // should not block
 921     $src = fread($h, $bytes);
 922     fclose($h);
 923     $enc = '';
 924     for ($i = 0; $i < $bytes; $i++) {
 925         $enc .= sprintf("%02x", (ord($src[$i])));
 926     }
 927     return $enc;
 928 }
 929
 930 function common_mtrand($bytes)
 931 {
 932     $enc = '';
 933     for ($i = 0; $i < $bytes; $i++) {
 934         $enc .= sprintf("%02x", mt_rand(0, 255));
 935     }
 936     return $enc;
 937 }
 938
 939 function common_set_returnto($url)
 940 {
 941     common_ensure_session();
 942     $_SESSION['returnto'] = $url;
 943 }
 944
 945 function common_get_returnto()
 946 {
 947     common_ensure_session();
 948     return $_SESSION['returnto'];
 949 }
 950
 951 function common_timestamp()
 952 {
 953     return date('YmdHis');
 954 }
 955
 956 function common_ensure_syslog()
 957 {
 958     static $initialized = false;
 959     if (!$initialized) {
 960         openlog(common_config('syslog', 'appname'), 0,
 961             common_config('syslog', 'facility'));
 962         $initialized = true;
 963     }
 964 }
 965
 966 function common_log_line($priority, $msg)
 967 {
 968     static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
 969                                       'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
 970     return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
 971 }
 972
 973 function common_log($priority, $msg, $filename=null)
 974 {
 975     $logfile = common_config('site', 'logfile');
 976     if ($logfile) {
 977         $log = fopen($logfile, "a");
 978         if ($log) {
 979             $output = common_log_line($priority, $msg);
 980             fwrite($log, $output);
 981             fclose($log);
 982         }
 983     } else {
 984         common_ensure_syslog();
 985         syslog($priority, $msg);
 986     }
 987 }
 988
 989 function common_debug($msg, $filename=null)
 990 {
 991     if ($filename) {
 992         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
 993     } else {
 994         common_log(LOG_DEBUG, $msg);
 995     }
 996 }
 997
 998 function common_log_db_error(&$object, $verb, $filename=null)
 999 {
1000     $objstr = common_log_objstring($object);
1001     $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1002     common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1003 }
1004
1005 function common_log_objstring(&$object)
1006 {
1007     if (is_null($object)) {
1008         return "null";
1009     }
1010     if (!($object instanceof DB_DataObject)) {
1011         return "(unknown)";
1012     }
1013     $arr = $object->toArray();
1014     $fields = array();
1015     foreach ($arr as $k => $v) {
1016         $fields[] = "$k='$v'";
1017     }
1018     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1019     return $objstring;
1020 }
1021
1022 function common_valid_http_url($url)
1023 {
1024     return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1025 }
1026
1027 function common_valid_tag($tag)
1028 {
1029     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1030         return (Validate::email($matches[1]) ||
1031                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1032     }
1033     return false;
1034 }
1035
1036 /* Following functions are copied from MediaWiki GlobalFunctions.php
1037  * and written by Evan Prodromou. */
1038
1039 function common_accept_to_prefs($accept, $def = '*/*')
1040 {
1041     // No arg means accept anything (per HTTP spec)
1042     if(!$accept) {
1043         return array($def => 1);
1044     }
1045
1046     $prefs = array();
1047
1048     $parts = explode(',', $accept);
1049
1050     foreach($parts as $part) {
1051         // FIXME: doesn't deal with params like 'text/html; level=1'
1052         @list($value, $qpart) = explode(';', trim($part));
1053         $match = array();
1054         if(!isset($qpart)) {
1055             $prefs[$value] = 1;
1056         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1057             $prefs[$value] = $match[1];
1058         }
1059     }
1060
1061     return $prefs;
1062 }
1063
1064 function common_mime_type_match($type, $avail)
1065 {
1066     if(array_key_exists($type, $avail)) {
1067         return $type;
1068     } else {
1069         $parts = explode('/', $type);
1070         if(array_key_exists($parts[0] . '/*', $avail)) {
1071             return $parts[0] . '/*';
1072         } elseif(array_key_exists('*/*', $avail)) {
1073             return '*/*';
1074         } else {
1075             return null;
1076         }
1077     }
1078 }
1079
1080 function common_negotiate_type($cprefs, $sprefs)
1081 {
1082     $combine = array();
1083
1084     foreach(array_keys($sprefs) as $type) {
1085         $parts = explode('/', $type);
1086         if($parts[1] != '*') {
1087             $ckey = common_mime_type_match($type, $cprefs);
1088             if($ckey) {
1089                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1090             }
1091         }
1092     }
1093
1094     foreach(array_keys($cprefs) as $type) {
1095         $parts = explode('/', $type);
1096         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1097             $skey = common_mime_type_match($type, $sprefs);
1098             if($skey) {
1099                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1100             }
1101         }
1102     }
1103
1104     $bestq = 0;
1105     $besttype = 'text/html';
1106
1107     foreach(array_keys($combine) as $type) {
1108         if($combine[$type] > $bestq) {
1109             $besttype = $type;
1110             $bestq = $combine[$type];
1111         }
1112     }
1113
1114     if ('text/html' === $besttype) {
1115         return "text/html; charset=utf-8";
1116     }
1117     return $besttype;
1118 }
1119
1120 function common_config($main, $sub)
1121 {
1122     global $config;
1123     return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1124 }
1125
1126 function common_copy_args($from)
1127 {
1128     $to = array();
1129     $strip = get_magic_quotes_gpc();
1130     foreach ($from as $k => $v) {
1131         $to[$k] = ($strip) ? stripslashes($v) : $v;
1132     }
1133     return $to;
1134 }
1135
1136 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1137 // This is used before handing a request off to OAuthRequest::from_request.
1138 function common_remove_magic_from_request()
1139 {
1140     if(get_magic_quotes_gpc()) {
1141         $_POST=array_map('stripslashes',$_POST);
1142         $_GET=array_map('stripslashes',$_GET);
1143     }
1144 }
1145
1146 function common_user_uri(&$user)
1147 {
1148     return common_local_url('userbyid', array('id' => $user->id));
1149 }
1150
1151 function common_notice_uri(&$notice)
1152 {
1153     return common_local_url('shownotice',
1154                             array('notice' => $notice->id));
1155 }
1156
1157 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1158
1159 function common_confirmation_code($bits)
1160 {
1161     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1162     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1163     $chars = ceil($bits/5);
1164     $code = '';
1165     for ($i = 0; $i < $chars; $i++) {
1166         // XXX: convert to string and back
1167         $num = hexdec(common_good_rand(1));
1168         // XXX: randomness is too precious to throw away almost
1169         // 40% of the bits we get!
1170         $code .= $codechars[$num%32];
1171     }
1172     return $code;
1173 }
1174
1175 // convert markup to HTML
1176
1177 function common_markup_to_html($c)
1178 {
1179     $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1180     $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1181     $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1182     return Markdown($c);
1183 }
1184
1185 function common_profile_uri($profile)
1186 {
1187     if (!$profile) {
1188         return null;
1189     }
1190     $user = User::staticGet($profile->id);
1191     if ($user) {
1192         return $user->uri;
1193     }
1194
1195     $remote = Remote_profile::staticGet($profile->id);
1196     if ($remote) {
1197         return $remote->uri;
1198     }
1199     // XXX: this is a very bad profile!
1200     return null;
1201 }
1202
1203 function common_canonical_sms($sms)
1204 {
1205     // strip non-digits
1206     preg_replace('/\D/', '', $sms);
1207     return $sms;
1208 }
1209
1210 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1211 {
1212     switch ($errno) {
1213
1214      case E_ERROR:
1215      case E_COMPILE_ERROR:
1216      case E_CORE_ERROR:
1217      case E_USER_ERROR:
1218      case E_PARSE:
1219      case E_RECOVERABLE_ERROR:
1220         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
1221         die();
1222         break;
1223
1224      case E_WARNING:
1225      case E_COMPILE_WARNING:
1226      case E_CORE_WARNING:
1227      case E_USER_WARNING:
1228         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1229         break;
1230
1231      case E_NOTICE:
1232      case E_USER_NOTICE:
1233         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1234         break;
1235
1236      case E_STRICT:
1237      case E_DEPRECATED:
1238      case E_USER_DEPRECATED:
1239         // XXX: config variable to log this stuff, too
1240         break;
1241
1242      default:
1243         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
1244         die();
1245         break;
1246     }
1247
1248     // FIXME: show error page if we're on the Web
1249     /* Don't execute PHP internal error handler */
1250     return true;
1251 }
1252
1253 function common_session_token()
1254 {
1255     common_ensure_session();
1256     if (!array_key_exists('token', $_SESSION)) {
1257         $_SESSION['token'] = common_good_rand(64);
1258     }
1259     return $_SESSION['token'];
1260 }
1261
1262 function common_cache_key($extra)
1263 {
1264     $base_key = common_config('memcached', 'base');
1265
1266     if (empty($base_key)) {
1267         $base_key = common_keyize(common_config('site', 'name'));
1268     }
1269
1270     return 'laconica:' . $base_key . ':' . $extra;
1271 }
1272
1273 function common_keyize($str)
1274 {
1275     $str = strtolower($str);
1276     $str = preg_replace('/\s/', '_', $str);
1277     return $str;
1278 }
1279
1280 function common_memcache()
1281 {
1282     static $cache = null;
1283     if (!common_config('memcached', 'enabled')) {
1284         return null;
1285     } else {
1286         if (!$cache) {
1287             $cache = new Memcache();
1288             $servers = common_config('memcached', 'server');
1289             if (is_array($servers)) {
1290                 foreach($servers as $server) {
1291                     $cache->addServer($server);
1292                 }
1293             } else {
1294                 $cache->addServer($servers);
1295             }
1296         }
1297         return $cache;
1298     }
1299 }
1300
1301 function common_compatible_license($from, $to)
1302 {
1303     // XXX: better compatibility check needed here!
1304     return ($from == $to);
1305 }
1306
1307 /**
1308  * returns a quoted table name, if required according to config
1309  */
1310 function common_database_tablename($tablename)
1311 {
1312
1313   if(common_config('db','quote_identifiers')) {
1314       $tablename = '"'. $tablename .'"';
1315   }
1316   //table prefixes could be added here later
1317   return $tablename;
1318 }
1319
1320 function common_shorten_url($long_url)
1321 {
1322     $user = common_current_user();
1323     if (empty($user)) {
1324         // common current user does not find a user when called from the XMPP daemon
1325         // therefore we'll set one here fix, so that XMPP given URLs may be shortened
1326         $svc = 'ur1.ca';
1327     } else {
1328         $svc = $user->urlshorteningservice;
1329     }
1330
1331     $curlh = curl_init();
1332     curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
1333     curl_setopt($curlh, CURLOPT_USERAGENT, 'Laconica');
1334     curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
1335
1336     switch($svc) {
1337      case 'ur1.ca':
1338         require_once INSTALLDIR.'/lib/Shorturl_api.php';
1339         $short_url_service = new LilUrl;
1340         $short_url = $short_url_service->shorten($long_url);
1341         break;
1342
1343      case '2tu.us':
1344         $short_url_service = new TightUrl;
1345         require_once INSTALLDIR.'/lib/Shorturl_api.php';
1346         $short_url = $short_url_service->shorten($long_url);
1347         break;
1348
1349      case 'ptiturl.com':
1350         require_once INSTALLDIR.'/lib/Shorturl_api.php';
1351         $short_url_service = new PtitUrl;
1352         $short_url = $short_url_service->shorten($long_url);
1353         break;
1354
1355      case 'bit.ly':
1356         curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($long_url));
1357         $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
1358         break;
1359
1360      case 'is.gd':
1361         curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($long_url));
1362         $short_url = curl_exec($curlh);
1363         break;
1364      case 'snipr.com':
1365         curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($long_url));
1366         $short_url = curl_exec($curlh);
1367         break;
1368      case 'metamark.net':
1369         curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($long_url));
1370         $short_url = curl_exec($curlh);
1371         break;
1372      case 'tinyurl.com':
1373         curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($long_url));
1374         $short_url = curl_exec($curlh);
1375         break;
1376      default:
1377         $short_url = false;
1378     }
1379
1380     curl_close($curlh);
1381
1382     return $short_url;
1383 }
1384
1385 function common_client_ip()
1386 {
1387     if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
1388         return null;
1389     }
1390
1391     if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
1392         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1393             $proxy = $_SERVER['HTTP_CLIENT_IP'];
1394         } else {
1395             $proxy = $_SERVER['REMOTE_ADDR'];
1396         }
1397         $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
1398     } else {
1399         $proxy = null;
1400         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1401             $ip = $_SERVER['HTTP_CLIENT_IP'];
1402         } else {
1403             $ip = $_SERVER['REMOTE_ADDR'];
1404         }
1405     }
1406
1407     return array($proxy, $ip);
1408 }