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