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     preg_match_all($regex, $text, $matches);
 449     // Then clean up what the regex left behind
 450     $offset = 0;
 451     foreach($matches[1] as $url) {
 452         // Call user specified func
 453         if (empty($notice_id)) {
 454             $modified_url = call_user_func($callback, $url);
 455         } else {
 456             $modified_url = call_user_func($callback, array($url, $notice_id));
 457         }
 458
 459         // Replace it!
 460         $start = mb_strpos($text, $url, $offset);
 461         $text = mb_substr($text, 0, $start).$modified_url.mb_substr($text, $start + mb_strlen($url), mb_strlen($text));
 462         $offset = $start + mb_strlen($modified_url);
 463     }
 464
 465     return $text;
 466 }
 467
 468 function common_linkify($url) {
 469     // It comes in special'd, so we unspecial it before passing to the stringifying
 470     // functions
 471     $url = htmlspecialchars_decode($url);
 472
 473     $canon = File_redirection::_canonUrl($url);
 474
 475     $longurl_data = File_redirection::where($url);
 476     if (is_array($longurl_data)) {
 477         $longurl = $longurl_data['url'];
 478     } elseif (is_string($longurl_data)) {
 479         $longurl = $longurl_data;
 480     } else {
 481         throw new ServerException("Can't linkify url '$url'");
 482     }
 483
 484     $attrs = array('href' => $canon, 'rel' => 'external');
 485
 486     $is_attachment = false;
 487     $attachment_id = null;
 488     $has_thumb = false;
 489
 490     // Check to see whether there's a filename associated with this URL.
 491     // If there is, it's an upload and qualifies as an attachment
 492
 493     $localfile = File::staticGet('url', $longurl);
 494
 495     if (!empty($localfile)) {
 496         if (isset($localfile->filename)) {
 497             $is_attachment = true;
 498             $attachment_id = $localfile->id;
 499         }
 500     }
 501
 502     // if this URL is an attachment, then we set class='attachment' and id='attahcment-ID'
 503     // where ID is the id of the attachment for the given URL.
 504     //
 505     // we need a better test telling what can be shown as an attachment
 506     // we're currently picking up oembeds only.
 507     // I think the best option is another file_view table in the db
 508     // and associated dbobject.
 509
 510     $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'";
 511     $file = new File;
 512     $file->query($query);
 513     $file->fetch();
 514
 515     if (!empty($file->file_id)) {
 516         $is_attachment = true;
 517         $attachment_id = $file->file_id;
 518
 519         $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'";
 520         $file2 = new File;
 521         $file2->query($query);
 522         $file2->fetch();
 523
 524         if (!empty($file2)) {
 525             $has_thumb = true;
 526         }
 527     }
 528
 529     // Add clippy
 530     if ($is_attachment) {
 531         $attrs['class'] = 'attachment';
 532         if ($has_thumb) {
 533             $attrs['class'] = 'attachment thumbnail';
 534         }
 535         $attrs['id'] = "attachment-{$attachment_id}";
 536     }
 537
 538     return XMLStringer::estring('a', $attrs, $url);
 539 }
 540
 541 function common_shorten_links($text)
 542 {
 543     $maxLength = Notice::maxContent();
 544     if ($maxLength == 0 || mb_strlen($text) <= $maxLength) return $text;
 545     return common_replace_urls_callback($text, array('File_redirection', 'makeShort'));
 546 }
 547
 548 function common_xml_safe_str($str)
 549 {
 550     // Neutralize control codes and surrogates
 551         return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
 552 }
 553
 554 function common_tag_link($tag)
 555 {
 556     $canonical = common_canonical_tag($tag);
 557     $url = common_local_url('tag', array('tag' => $canonical));
 558     $xs = new XMLStringer();
 559     $xs->elementStart('span', 'tag');
 560     $xs->element('a', array('href' => $url,
 561                             'rel' => 'tag'),
 562                  $tag);
 563     $xs->elementEnd('span');
 564     return $xs->getString();
 565 }
 566
 567 function common_canonical_tag($tag)
 568 {
 569   $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
 570   return str_replace(array('-', '_', '.'), '', $tag);
 571 }
 572
 573 function common_valid_profile_tag($str)
 574 {
 575     return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
 576 }
 577
 578 function common_at_link($sender_id, $nickname)
 579 {
 580     $sender = Profile::staticGet($sender_id);
 581     $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
 582     if ($recipient) {
 583         $user = User::staticGet('id', $recipient->id);
 584         if ($user) {
 585             $url = common_local_url('userbyid', array('id' => $user->id));
 586         } else {
 587             $url = $recipient->profileurl;
 588         }
 589         $xs = new XMLStringer(false);
 590         $attrs = array('href' => $url,
 591                        'class' => 'url');
 592         if (!empty($recipient->fullname)) {
 593             $attrs['title'] = $recipient->fullname . ' (' . $recipient->nickname . ')';
 594         }
 595         $xs->elementStart('span', 'vcard');
 596         $xs->elementStart('a', $attrs);
 597         $xs->element('span', 'fn nickname', $nickname);
 598         $xs->elementEnd('a');
 599         $xs->elementEnd('span');
 600         return $xs->getString();
 601     } else {
 602         return $nickname;
 603     }
 604 }
 605
 606 function common_group_link($sender_id, $nickname)
 607 {
 608     $sender = Profile::staticGet($sender_id);
 609     $group = User_group::getForNickname($nickname);
 610     if ($group && $sender->isMember($group)) {
 611         $attrs = array('href' => $group->permalink(),
 612                        'class' => 'url');
 613         if (!empty($group->fullname)) {
 614             $attrs['title'] = $group->fullname . ' (' . $group->nickname . ')';
 615         }
 616         $xs = new XMLStringer();
 617         $xs->elementStart('span', 'vcard');
 618         $xs->elementStart('a', $attrs);
 619         $xs->element('span', 'fn nickname', $nickname);
 620         $xs->elementEnd('a');
 621         $xs->elementEnd('span');
 622         return $xs->getString();
 623     } else {
 624         return $nickname;
 625     }
 626 }
 627
 628 function common_at_hash_link($sender_id, $tag)
 629 {
 630     $user = User::staticGet($sender_id);
 631     if (!$user) {
 632         return $tag;
 633     }
 634     $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
 635     if ($tagged) {
 636         $url = common_local_url('subscriptions',
 637                                 array('nickname' => $user->nickname,
 638                                       'tag' => $tag));
 639         $xs = new XMLStringer();
 640         $xs->elementStart('span', 'tag');
 641         $xs->element('a', array('href' => $url,
 642                                 'rel' => $tag),
 643                      $tag);
 644         $xs->elementEnd('span');
 645         return $xs->getString();
 646     } else {
 647         return $tag;
 648     }
 649 }
 650
 651 function common_relative_profile($sender, $nickname, $dt=null)
 652 {
 653     // Try to find profiles this profile is subscribed to that have this nickname
 654     $recipient = new Profile();
 655     // XXX: use a join instead of a subquery
 656     $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
 657     $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
 658     if ($recipient->find(true)) {
 659         // XXX: should probably differentiate between profiles with
 660         // the same name by date of most recent update
 661         return $recipient;
 662     }
 663     // Try to find profiles that listen to this profile and that have this nickname
 664     $recipient = new Profile();
 665     // XXX: use a join instead of a subquery
 666     $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
 667     $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
 668     if ($recipient->find(true)) {
 669         // XXX: should probably differentiate between profiles with
 670         // the same name by date of most recent update
 671         return $recipient;
 672     }
 673     // If this is a local user, try to find a local user with that nickname.
 674     $sender = User::staticGet($sender->id);
 675     if ($sender) {
 676         $recipient_user = User::staticGet('nickname', $nickname);
 677         if ($recipient_user) {
 678             return $recipient_user->getProfile();
 679         }
 680     }
 681     // Otherwise, no links. @messages from local users to remote users,
 682     // or from remote users to other remote users, are just
 683     // outside our ability to make intelligent guesses about
 684     return null;
 685 }
 686
 687 function common_local_url($action, $args=null, $params=null, $fragment=null)
 688 {
 689     $r = Router::get();
 690     $path = $r->build($action, $args, $params, $fragment);
 691
 692     $ssl = common_is_sensitive($action);
 693
 694     if (common_config('site','fancy')) {
 695         $url = common_path(mb_substr($path, 1), $ssl);
 696     } else {
 697         if (mb_strpos($path, '/index.php') === 0) {
 698             $url = common_path(mb_substr($path, 1), $ssl);
 699         } else {
 700             $url = common_path('index.php'.$path, $ssl);
 701         }
 702     }
 703     return $url;
 704 }
 705
 706 function common_is_sensitive($action)
 707 {
 708     static $sensitive = array('login', 'register', 'passwordsettings',
 709                               'twittersettings', 'api');
 710     $ssl = null;
 711
 712     if (Event::handle('SensitiveAction', array($action, &$ssl))) {
 713         $ssl = in_array($action, $sensitive);
 714     }
 715
 716     return $ssl;
 717 }
 718
 719 function common_path($relative, $ssl=false)
 720 {
 721     $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
 722
 723     if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
 724         || common_config('site', 'ssl') === 'always') {
 725         $proto = 'https';
 726         if (is_string(common_config('site', 'sslserver')) &&
 727             mb_strlen(common_config('site', 'sslserver')) > 0) {
 728             $serverpart = common_config('site', 'sslserver');
 729         } else {
 730             $serverpart = common_config('site', 'server');
 731         }
 732     } else {
 733         $proto = 'http';
 734         $serverpart = common_config('site', 'server');
 735     }
 736
 737     return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
 738 }
 739
 740 function common_date_string($dt)
 741 {
 742     // XXX: do some sexy date formatting
 743     // return date(DATE_RFC822, $dt);
 744     $t = strtotime($dt);
 745     $now = time();
 746     $diff = $now - $t;
 747
 748     if ($now < $t) { // that shouldn't happen!
 749         return common_exact_date($dt);
 750     } else if ($diff < 60) {
 751         return _('a few seconds ago');
 752     } else if ($diff < 92) {
 753         return _('about a minute ago');
 754     } else if ($diff < 3300) {
 755         return sprintf(_('about %d minutes ago'), round($diff/60));
 756     } else if ($diff < 5400) {
 757         return _('about an hour ago');
 758     } else if ($diff < 22 * 3600) {
 759         return sprintf(_('about %d hours ago'), round($diff/3600));
 760     } else if ($diff < 37 * 3600) {
 761         return _('about a day ago');
 762     } else if ($diff < 24 * 24 * 3600) {
 763         return sprintf(_('about %d days ago'), round($diff/(24*3600)));
 764     } else if ($diff < 46 * 24 * 3600) {
 765         return _('about a month ago');
 766     } else if ($diff < 330 * 24 * 3600) {
 767         return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
 768     } else if ($diff < 480 * 24 * 3600) {
 769         return _('about a year ago');
 770     } else {
 771         return common_exact_date($dt);
 772     }
 773 }
 774
 775 function common_exact_date($dt)
 776 {
 777     static $_utc;
 778     static $_siteTz;
 779
 780     if (!$_utc) {
 781         $_utc = new DateTimeZone('UTC');
 782         $_siteTz = new DateTimeZone(common_timezone());
 783     }
 784
 785     $dateStr = date('d F Y H:i:s', strtotime($dt));
 786     $d = new DateTime($dateStr, $_utc);
 787     $d->setTimezone($_siteTz);
 788     return $d->format(DATE_RFC850);
 789 }
 790
 791 function common_date_w3dtf($dt)
 792 {
 793     $dateStr = date('d F Y H:i:s', strtotime($dt));
 794     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 795     $d->setTimezone(new DateTimeZone(common_timezone()));
 796     return $d->format(DATE_W3C);
 797 }
 798
 799 function common_date_rfc2822($dt)
 800 {
 801     $dateStr = date('d F Y H:i:s', strtotime($dt));
 802     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 803     $d->setTimezone(new DateTimeZone(common_timezone()));
 804     return $d->format('r');
 805 }
 806
 807 function common_date_iso8601($dt)
 808 {
 809     $dateStr = date('d F Y H:i:s', strtotime($dt));
 810     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 811     $d->setTimezone(new DateTimeZone(common_timezone()));
 812     return $d->format('c');
 813 }
 814
 815 function common_sql_now()
 816 {
 817     return common_sql_date(time());
 818 }
 819
 820 function common_sql_date($datetime)
 821 {
 822     return strftime('%Y-%m-%d %H:%M:%S', $datetime);
 823 }
 824
 825 function common_redirect($url, $code=307)
 826 {
 827     static $status = array(301 => "Moved Permanently",
 828                            302 => "Found",
 829                            303 => "See Other",
 830                            307 => "Temporary Redirect");
 831
 832     header('HTTP/1.1 '.$code.' '.$status[$code]);
 833     header("Location: $url");
 834
 835     $xo = new XMLOutputter();
 836     $xo->startXML('a',
 837                   '-//W3C//DTD XHTML 1.0 Strict//EN',
 838                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
 839     $xo->element('a', array('href' => $url), $url);
 840     $xo->endXML();
 841     exit;
 842 }
 843
 844 function common_broadcast_notice($notice, $remote=false)
 845 {
 846     return common_enqueue_notice($notice);
 847 }
 848
 849 // Stick the notice on the queue
 850
 851 function common_enqueue_notice($notice)
 852 {
 853     static $localTransports = array('omb',
 854                                     'twitter',
 855                                     'facebook',
 856                                     'ping');
 857     static $allTransports = array('sms');
 858
 859     $transports = $allTransports;
 860
 861     $xmpp = common_config('xmpp', 'enabled');
 862
 863     if ($xmpp) {
 864         $transports[] = 'jabber';
 865     }
 866
 867     if ($notice->is_local == Notice::LOCAL_PUBLIC ||
 868         $notice->is_local == Notice::LOCAL_NONPUBLIC) {
 869         $transports = array_merge($transports, $localTransports);
 870         if ($xmpp) {
 871             $transports[] = 'public';
 872         }
 873     }
 874
 875     $qm = QueueManager::get();
 876
 877     foreach ($transports as $transport)
 878     {
 879         $qm->enqueue($notice, $transport);
 880     }
 881
 882     return true;
 883 }
 884
 885 function common_broadcast_profile($profile)
 886 {
 887     // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
 888     require_once(INSTALLDIR.'/lib/omb.php');
 889     omb_broadcast_profile($profile);
 890     // XXX: Other broadcasts...?
 891     return true;
 892 }
 893
 894 function common_profile_url($nickname)
 895 {
 896     return common_local_url('showstream', array('nickname' => $nickname));
 897 }
 898
 899 // Should make up a reasonable root URL
 900
 901 function common_root_url($ssl=false)
 902 {
 903     return common_path('', $ssl);
 904 }
 905
 906 // returns $bytes bytes of random data as a hexadecimal string
 907 // "good" here is a goal and not a guarantee
 908
 909 function common_good_rand($bytes)
 910 {
 911     // XXX: use random.org...?
 912     if (@file_exists('/dev/urandom')) {
 913         return common_urandom($bytes);
 914     } else { // FIXME: this is probably not good enough
 915         return common_mtrand($bytes);
 916     }
 917 }
 918
 919 function common_urandom($bytes)
 920 {
 921     $h = fopen('/dev/urandom', 'rb');
 922     // should not block
 923     $src = fread($h, $bytes);
 924     fclose($h);
 925     $enc = '';
 926     for ($i = 0; $i < $bytes; $i++) {
 927         $enc .= sprintf("%02x", (ord($src[$i])));
 928     }
 929     return $enc;
 930 }
 931
 932 function common_mtrand($bytes)
 933 {
 934     $enc = '';
 935     for ($i = 0; $i < $bytes; $i++) {
 936         $enc .= sprintf("%02x", mt_rand(0, 255));
 937     }
 938     return $enc;
 939 }
 940
 941 function common_set_returnto($url)
 942 {
 943     common_ensure_session();
 944     $_SESSION['returnto'] = $url;
 945 }
 946
 947 function common_get_returnto()
 948 {
 949     common_ensure_session();
 950     return $_SESSION['returnto'];
 951 }
 952
 953 function common_timestamp()
 954 {
 955     return date('YmdHis');
 956 }
 957
 958 function common_ensure_syslog()
 959 {
 960     static $initialized = false;
 961     if (!$initialized) {
 962         openlog(common_config('syslog', 'appname'), 0,
 963             common_config('syslog', 'facility'));
 964         $initialized = true;
 965     }
 966 }
 967
 968 function common_log_line($priority, $msg)
 969 {
 970     static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
 971                                       'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
 972     return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
 973 }
 974
 975 function common_log($priority, $msg, $filename=null)
 976 {
 977     $logfile = common_config('site', 'logfile');
 978     if ($logfile) {
 979         $log = fopen($logfile, "a");
 980         if ($log) {
 981             $output = common_log_line($priority, $msg);
 982             fwrite($log, $output);
 983             fclose($log);
 984         }
 985     } else {
 986         common_ensure_syslog();
 987         syslog($priority, $msg);
 988     }
 989 }
 990
 991 function common_debug($msg, $filename=null)
 992 {
 993     if ($filename) {
 994         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
 995     } else {
 996         common_log(LOG_DEBUG, $msg);
 997     }
 998 }
 999
1000 function common_log_db_error(&$object, $verb, $filename=null)
1001 {
1002     $objstr = common_log_objstring($object);
1003     $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1004     common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1005 }
1006
1007 function common_log_objstring(&$object)
1008 {
1009     if (is_null($object)) {
1010         return "null";
1011     }
1012     if (!($object instanceof DB_DataObject)) {
1013         return "(unknown)";
1014     }
1015     $arr = $object->toArray();
1016     $fields = array();
1017     foreach ($arr as $k => $v) {
1018         $fields[] = "$k='$v'";
1019     }
1020     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1021     return $objstring;
1022 }
1023
1024 function common_valid_http_url($url)
1025 {
1026     return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1027 }
1028
1029 function common_valid_tag($tag)
1030 {
1031     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1032         return (Validate::email($matches[1]) ||
1033                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1034     }
1035     return false;
1036 }
1037
1038 /* Following functions are copied from MediaWiki GlobalFunctions.php
1039  * and written by Evan Prodromou. */
1040
1041 function common_accept_to_prefs($accept, $def = '*/*')
1042 {
1043     // No arg means accept anything (per HTTP spec)
1044     if(!$accept) {
1045         return array($def => 1);
1046     }
1047
1048     $prefs = array();
1049
1050     $parts = explode(',', $accept);
1051
1052     foreach($parts as $part) {
1053         // FIXME: doesn't deal with params like 'text/html; level=1'
1054         @list($value, $qpart) = explode(';', trim($part));
1055         $match = array();
1056         if(!isset($qpart)) {
1057             $prefs[$value] = 1;
1058         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1059             $prefs[$value] = $match[1];
1060         }
1061     }
1062
1063     return $prefs;
1064 }
1065
1066 function common_mime_type_match($type, $avail)
1067 {
1068     if(array_key_exists($type, $avail)) {
1069         return $type;
1070     } else {
1071         $parts = explode('/', $type);
1072         if(array_key_exists($parts[0] . '/*', $avail)) {
1073             return $parts[0] . '/*';
1074         } elseif(array_key_exists('*/*', $avail)) {
1075             return '*/*';
1076         } else {
1077             return null;
1078         }
1079     }
1080 }
1081
1082 function common_negotiate_type($cprefs, $sprefs)
1083 {
1084     $combine = array();
1085
1086     foreach(array_keys($sprefs) as $type) {
1087         $parts = explode('/', $type);
1088         if($parts[1] != '*') {
1089             $ckey = common_mime_type_match($type, $cprefs);
1090             if($ckey) {
1091                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1092             }
1093         }
1094     }
1095
1096     foreach(array_keys($cprefs) as $type) {
1097         $parts = explode('/', $type);
1098         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1099             $skey = common_mime_type_match($type, $sprefs);
1100             if($skey) {
1101                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1102             }
1103         }
1104     }
1105
1106     $bestq = 0;
1107     $besttype = 'text/html';
1108
1109     foreach(array_keys($combine) as $type) {
1110         if($combine[$type] > $bestq) {
1111             $besttype = $type;
1112             $bestq = $combine[$type];
1113         }
1114     }
1115
1116     if ('text/html' === $besttype) {
1117         return "text/html; charset=utf-8";
1118     }
1119     return $besttype;
1120 }
1121
1122 function common_config($main, $sub)
1123 {
1124     global $config;
1125     return (array_key_exists($main, $config) &&
1126             array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
1127 }
1128
1129 function common_copy_args($from)
1130 {
1131     $to = array();
1132     $strip = get_magic_quotes_gpc();
1133     foreach ($from as $k => $v) {
1134         $to[$k] = ($strip) ? stripslashes($v) : $v;
1135     }
1136     return $to;
1137 }
1138
1139 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1140 // This is used before handing a request off to OAuthRequest::from_request.
1141 function common_remove_magic_from_request()
1142 {
1143     if(get_magic_quotes_gpc()) {
1144         $_POST=array_map('stripslashes',$_POST);
1145         $_GET=array_map('stripslashes',$_GET);
1146     }
1147 }
1148
1149 function common_user_uri(&$user)
1150 {
1151     return common_local_url('userbyid', array('id' => $user->id));
1152 }
1153
1154 function common_notice_uri(&$notice)
1155 {
1156     return common_local_url('shownotice',
1157                             array('notice' => $notice->id));
1158 }
1159
1160 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1161
1162 function common_confirmation_code($bits)
1163 {
1164     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1165     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1166     $chars = ceil($bits/5);
1167     $code = '';
1168     for ($i = 0; $i < $chars; $i++) {
1169         // XXX: convert to string and back
1170         $num = hexdec(common_good_rand(1));
1171         // XXX: randomness is too precious to throw away almost
1172         // 40% of the bits we get!
1173         $code .= $codechars[$num%32];
1174     }
1175     return $code;
1176 }
1177
1178 // convert markup to HTML
1179
1180 function common_markup_to_html($c)
1181 {
1182     $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1183     $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1184     $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1185     return Markdown($c);
1186 }
1187
1188 function common_profile_uri($profile)
1189 {
1190     if (!$profile) {
1191         return null;
1192     }
1193     $user = User::staticGet($profile->id);
1194     if ($user) {
1195         return $user->uri;
1196     }
1197
1198     $remote = Remote_profile::staticGet($profile->id);
1199     if ($remote) {
1200         return $remote->uri;
1201     }
1202     // XXX: this is a very bad profile!
1203     return null;
1204 }
1205
1206 function common_canonical_sms($sms)
1207 {
1208     // strip non-digits
1209     preg_replace('/\D/', '', $sms);
1210     return $sms;
1211 }
1212
1213 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1214 {
1215     switch ($errno) {
1216
1217      case E_ERROR:
1218      case E_COMPILE_ERROR:
1219      case E_CORE_ERROR:
1220      case E_USER_ERROR:
1221      case E_PARSE:
1222      case E_RECOVERABLE_ERROR:
1223         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
1224         die();
1225         break;
1226
1227      case E_WARNING:
1228      case E_COMPILE_WARNING:
1229      case E_CORE_WARNING:
1230      case E_USER_WARNING:
1231         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1232         break;
1233
1234      case E_NOTICE:
1235      case E_USER_NOTICE:
1236         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1237         break;
1238
1239      case E_STRICT:
1240      case E_DEPRECATED:
1241      case E_USER_DEPRECATED:
1242         // XXX: config variable to log this stuff, too
1243         break;
1244
1245      default:
1246         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
1247         die();
1248         break;
1249     }
1250
1251     // FIXME: show error page if we're on the Web
1252     /* Don't execute PHP internal error handler */
1253     return true;
1254 }
1255
1256 function common_session_token()
1257 {
1258     common_ensure_session();
1259     if (!array_key_exists('token', $_SESSION)) {
1260         $_SESSION['token'] = common_good_rand(64);
1261     }
1262     return $_SESSION['token'];
1263 }
1264
1265 function common_cache_key($extra)
1266 {
1267     $base_key = common_config('memcached', 'base');
1268
1269     if (empty($base_key)) {
1270         $base_key = common_keyize(common_config('site', 'name'));
1271     }
1272
1273     return 'laconica:' . $base_key . ':' . $extra;
1274 }
1275
1276 function common_keyize($str)
1277 {
1278     $str = strtolower($str);
1279     $str = preg_replace('/\s/', '_', $str);
1280     return $str;
1281 }
1282
1283 function common_memcache()
1284 {
1285     static $cache = null;
1286     if (!common_config('memcached', 'enabled')) {
1287         return null;
1288     } else {
1289         if (!$cache) {
1290             $cache = new Memcache();
1291             $servers = common_config('memcached', 'server');
1292             if (is_array($servers)) {
1293                 foreach($servers as $server) {
1294                     $cache->addServer($server);
1295                 }
1296             } else {
1297                 $cache->addServer($servers);
1298             }
1299         }
1300         return $cache;
1301     }
1302 }
1303
1304 function common_compatible_license($from, $to)
1305 {
1306     // XXX: better compatibility check needed here!
1307     return ($from == $to);
1308 }
1309
1310 /**
1311  * returns a quoted table name, if required according to config
1312  */
1313 function common_database_tablename($tablename)
1314 {
1315
1316   if(common_config('db','quote_identifiers')) {
1317       $tablename = '"'. $tablename .'"';
1318   }
1319   //table prefixes could be added here later
1320   return $tablename;
1321 }
1322
1323 function common_shorten_url($long_url)
1324 {
1325     $user = common_current_user();
1326     if (empty($user)) {
1327         // common current user does not find a user when called from the XMPP daemon
1328         // therefore we'll set one here fix, so that XMPP given URLs may be shortened
1329         $svc = 'ur1.ca';
1330     } else {
1331         $svc = $user->urlshorteningservice;
1332     }
1333
1334     $curlh = curl_init();
1335     curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
1336     curl_setopt($curlh, CURLOPT_USERAGENT, 'Laconica');
1337     curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
1338
1339     switch($svc) {
1340      case 'ur1.ca':
1341         require_once INSTALLDIR.'/lib/Shorturl_api.php';
1342         $short_url_service = new LilUrl;
1343         $short_url = $short_url_service->shorten($long_url);
1344         break;
1345
1346      case '2tu.us':
1347         $short_url_service = new TightUrl;
1348         require_once INSTALLDIR.'/lib/Shorturl_api.php';
1349         $short_url = $short_url_service->shorten($long_url);
1350         break;
1351
1352      case 'ptiturl.com':
1353         require_once INSTALLDIR.'/lib/Shorturl_api.php';
1354         $short_url_service = new PtitUrl;
1355         $short_url = $short_url_service->shorten($long_url);
1356         break;
1357
1358      case 'bit.ly':
1359         curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($long_url));
1360         $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
1361         break;
1362
1363      case 'is.gd':
1364         curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($long_url));
1365         $short_url = curl_exec($curlh);
1366         break;
1367      case 'snipr.com':
1368         curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($long_url));
1369         $short_url = curl_exec($curlh);
1370         break;
1371      case 'metamark.net':
1372         curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($long_url));
1373         $short_url = curl_exec($curlh);
1374         break;
1375      case 'tinyurl.com':
1376         curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($long_url));
1377         $short_url = curl_exec($curlh);
1378         break;
1379      default:
1380         $short_url = false;
1381     }
1382
1383     curl_close($curlh);
1384
1385     return $short_url;
1386 }
1387
1388 function common_client_ip()
1389 {
1390     if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
1391         return null;
1392     }
1393
1394     if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
1395         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1396             $proxy = $_SERVER['HTTP_CLIENT_IP'];
1397         } else {
1398             $proxy = $_SERVER['REMOTE_ADDR'];
1399         }
1400         $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
1401     } else {
1402         $proxy = null;
1403         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1404             $ip = $_SERVER['HTTP_CLIENT_IP'];
1405         } else {
1406             $ip = $_SERVER['REMOTE_ADDR'];
1407         }
1408     }
1409
1410     return array($proxy, $ip);
1411 }