lib/util.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, StatusNet, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 /* XXX: break up into separate modules (HTTP, user, files) */
  21
  22 // Show a server error
  23
  24 function common_server_error($msg, $code=500)
  25 {
  26     $err = new ServerErrorAction($msg, $code);
  27     $err->showPage();
  28 }
  29
  30 // Show a user error
  31 function common_user_error($msg, $code=400)
  32 {
  33     $err = new ClientErrorAction($msg, $code);
  34     $err->showPage();
  35 }
  36
  37 function common_init_locale($language=null)
  38 {
  39     if(!$language) {
  40         $language = common_language();
  41     }
  42     putenv('LANGUAGE='.$language);
  43     putenv('LANG='.$language);
  44     return setlocale(LC_ALL, $language . ".utf8",
  45                      $language . ".UTF8",
  46                      $language . ".utf-8",
  47                      $language . ".UTF-8",
  48                      $language);
  49 }
  50
  51 function common_init_language()
  52 {
  53     mb_internal_encoding('UTF-8');
  54
  55     // gettext seems very picky... We first need to setlocale()
  56     // to a locale which _does_ exist on the system, and _then_
  57     // we can set in another locale that may not be set up
  58     // (say, ga_ES for Galego/Galician) it seems to take it.
  59     common_init_locale("en_US");
  60
  61     $language = common_language();
  62     $locale_set = common_init_locale($language);
  63     setlocale(LC_CTYPE, 'C');
  64
  65     // So we don't have to make people install the gettext locales
  66     $path = common_config('site','locale_path');
  67     bindtextdomain("statusnet", $path);
  68     bind_textdomain_codeset("statusnet", "UTF-8");
  69     textdomain("statusnet");
  70
  71     if(!$locale_set) {
  72         common_log(LOG_INFO, 'Language requested:' . $language . ' - locale could not be set. Perhaps that system locale is not installed.', __FILE__);
  73     }
  74 }
  75
  76 function common_timezone()
  77 {
  78     if (common_logged_in()) {
  79         $user = common_current_user();
  80         if ($user->timezone) {
  81             return $user->timezone;
  82         }
  83     }
  84
  85     return common_config('site', 'timezone');
  86 }
  87
  88 function common_language()
  89 {
  90
  91     // If there is a user logged in and they've set a language preference
  92     // then return that one...
  93     if (_have_config() && common_logged_in()) {
  94         $user = common_current_user();
  95         $user_language = $user->language;
  96         if ($user_language)
  97           return $user_language;
  98     }
  99
 100     // Otherwise, find the best match for the languages requested by the
 101     // user's browser...
 102     $httplang = isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? $_SERVER['HTTP_ACCEPT_LANGUAGE'] : null;
 103     if (!empty($httplang)) {
 104         $language = client_prefered_language($httplang);
 105         if ($language)
 106           return $language;
 107     }
 108
 109     // Finally, if none of the above worked, use the site's default...
 110     return common_config('site', 'language');
 111 }
 112 // salted, hashed passwords are stored in the DB
 113
 114 function common_munge_password($password, $id)
 115 {
 116     return md5($password . $id);
 117 }
 118
 119 // check if a username exists and has matching password
 120 function common_check_user($nickname, $password)
 121 {
 122     // NEVER allow blank passwords, even if they match the DB
 123     if (mb_strlen($password) == 0) {
 124         return false;
 125     }
 126     $user = User::staticGet('nickname', $nickname);
 127     if (is_null($user) || $user === false) {
 128         return false;
 129     } else {
 130         if (0 == strcmp(common_munge_password($password, $user->id),
 131                         $user->password)) {
 132             return $user;
 133         } else {
 134             return false;
 135         }
 136     }
 137 }
 138
 139 // is the current user logged in?
 140 function common_logged_in()
 141 {
 142     return (!is_null(common_current_user()));
 143 }
 144
 145 function common_have_session()
 146 {
 147     return (0 != strcmp(session_id(), ''));
 148 }
 149
 150 function common_ensure_session()
 151 {
 152     $c = null;
 153     if (array_key_exists(session_name(), $_COOKIE)) {
 154         $c = $_COOKIE[session_name()];
 155     }
 156     if (!common_have_session()) {
 157         if (common_config('sessions', 'handle')) {
 158             Session::setSaveHandler();
 159         }
 160         @session_start();
 161         if (!isset($_SESSION['started'])) {
 162             $_SESSION['started'] = time();
 163             if (!empty($c)) {
 164                 common_log(LOG_WARNING, 'Session cookie "' . $_COOKIE[session_name()] . '" ' .
 165                            ' is set but started value is null');
 166             }
 167         }
 168     }
 169 }
 170
 171 // Three kinds of arguments:
 172 // 1) a user object
 173 // 2) a nickname
 174 // 3) null to clear
 175
 176 // Initialize to false; set to null if none found
 177
 178 $_cur = false;
 179
 180 function common_set_user($user)
 181 {
 182
 183     global $_cur;
 184
 185     if (is_null($user) && common_have_session()) {
 186         $_cur = null;
 187         unset($_SESSION['userid']);
 188         return true;
 189     } else if (is_string($user)) {
 190         $nickname = $user;
 191         $user = User::staticGet('nickname', $nickname);
 192     } else if (!($user instanceof User)) {
 193         return false;
 194     }
 195
 196     if ($user) {
 197         common_ensure_session();
 198         $_SESSION['userid'] = $user->id;
 199         $_cur = $user;
 200         return $_cur;
 201     }
 202     return false;
 203 }
 204
 205 function common_set_cookie($key, $value, $expiration=0)
 206 {
 207     $path = common_config('site', 'path');
 208     $server = common_config('site', 'server');
 209
 210     if ($path && ($path != '/')) {
 211         $cookiepath = '/' . $path . '/';
 212     } else {
 213         $cookiepath = '/';
 214     }
 215     return setcookie($key,
 216                      $value,
 217                      $expiration,
 218                      $cookiepath,
 219                      $server);
 220 }
 221
 222 define('REMEMBERME', 'rememberme');
 223 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
 224
 225 function common_rememberme($user=null)
 226 {
 227     if (!$user) {
 228         $user = common_current_user();
 229         if (!$user) {
 230             common_debug('No current user to remember', __FILE__);
 231             return false;
 232         }
 233     }
 234
 235     $rm = new Remember_me();
 236
 237     $rm->code = common_good_rand(16);
 238     $rm->user_id = $user->id;
 239
 240     // Wrap the insert in some good ol' fashioned transaction code
 241
 242     $rm->query('BEGIN');
 243
 244     $result = $rm->insert();
 245
 246     if (!$result) {
 247         common_log_db_error($rm, 'INSERT', __FILE__);
 248         common_debug('Error adding rememberme record for ' . $user->nickname, __FILE__);
 249         return false;
 250     }
 251
 252     $rm->query('COMMIT');
 253
 254     common_debug('Inserted rememberme record (' . $rm->code . ', ' . $rm->user_id . '); result = ' . $result . '.', __FILE__);
 255
 256     $cookieval = $rm->user_id . ':' . $rm->code;
 257
 258     common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
 259
 260     common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
 261
 262     return true;
 263 }
 264
 265 function common_remembered_user()
 266 {
 267
 268     $user = null;
 269
 270     $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
 271
 272     if (!$packed) {
 273         return null;
 274     }
 275
 276     list($id, $code) = explode(':', $packed);
 277
 278     if (!$id || !$code) {
 279         common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
 280         common_forgetme();
 281         return null;
 282     }
 283
 284     $rm = Remember_me::staticGet($code);
 285
 286     if (!$rm) {
 287         common_log(LOG_WARNING, 'No such remember code: ' . $code);
 288         common_forgetme();
 289         return null;
 290     }
 291
 292     if ($rm->user_id != $id) {
 293         common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
 294         common_forgetme();
 295         return null;
 296     }
 297
 298     $user = User::staticGet($rm->user_id);
 299
 300     if (!$user) {
 301         common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
 302         common_forgetme();
 303         return null;
 304     }
 305
 306     // successful!
 307     $result = $rm->delete();
 308
 309     if (!$result) {
 310         common_log_db_error($rm, 'DELETE', __FILE__);
 311         common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
 312         common_forgetme();
 313         return null;
 314     }
 315
 316     common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
 317
 318     common_set_user($user);
 319     common_real_login(false);
 320
 321     // We issue a new cookie, so they can log in
 322     // automatically again after this session
 323
 324     common_rememberme($user);
 325
 326     return $user;
 327 }
 328
 329 // must be called with a valid user!
 330
 331 function common_forgetme()
 332 {
 333     common_set_cookie(REMEMBERME, '', 0);
 334 }
 335
 336 // who is the current user?
 337 function common_current_user()
 338 {
 339     global $_cur;
 340
 341     if (!_have_config()) {
 342         return null;
 343     }
 344
 345     if ($_cur === false) {
 346
 347         if (isset($_REQUEST[session_name()]) || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
 348             common_ensure_session();
 349             $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
 350             if ($id) {
 351                 $_cur = User::staticGet($id);
 352                 return $_cur;
 353             }
 354         }
 355
 356         // that didn't work; try to remember; will init $_cur to null on failure
 357         $_cur = common_remembered_user();
 358
 359         if ($_cur) {
 360             common_debug("Got User " . $_cur->nickname);
 361             common_debug("Faking session on remembered user");
 362             // XXX: Is this necessary?
 363             $_SESSION['userid'] = $_cur->id;
 364         }
 365     }
 366
 367     return $_cur;
 368 }
 369
 370 // Logins that are 'remembered' aren't 'real' -- they're subject to
 371 // cookie-stealing. So, we don't let them do certain things. New reg,
 372 // OpenID, and password logins _are_ real.
 373
 374 function common_real_login($real=true)
 375 {
 376     common_ensure_session();
 377     $_SESSION['real_login'] = $real;
 378 }
 379
 380 function common_is_real_login()
 381 {
 382     return common_logged_in() && $_SESSION['real_login'];
 383 }
 384
 385 // get canonical version of nickname for comparison
 386 function common_canonical_nickname($nickname)
 387 {
 388     // XXX: UTF-8 canonicalization (like combining chars)
 389     return strtolower($nickname);
 390 }
 391
 392 // get canonical version of email for comparison
 393 function common_canonical_email($email)
 394 {
 395     // XXX: canonicalize UTF-8
 396     // XXX: lcase the domain part
 397     return $email;
 398 }
 399
 400 function common_render_content($text, $notice)
 401 {
 402     $r = common_render_text($text);
 403     $id = $notice->profile_id;
 404     $r = preg_replace('/(^|\s+)@(['.NICKNAME_FMT.']{1,64})/e', "'\\1@'.common_at_link($id, '\\2')", $r);
 405     $r = preg_replace('/^T ([A-Z0-9]{1,64}) /e', "'T '.common_at_link($id, '\\1').' '", $r);
 406     $r = preg_replace('/(^|[\s\.\,\:\;]+)@#([A-Za-z0-9]{1,64})/e', "'\\1@#'.common_at_hash_link($id, '\\2')", $r);
 407     $r = preg_replace('/(^|[\s\.\,\:\;]+)!([A-Za-z0-9]{1,64})/e', "'\\1!'.common_group_link($id, '\\2')", $r);
 408     return $r;
 409 }
 410
 411 function common_render_text($text)
 412 {
 413     $r = htmlspecialchars($text);
 414
 415     $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
 416     $r = common_replace_urls_callback($r, 'common_linkify');
 417     $r = preg_replace('/(^|\&quot\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/e', "'\\1#'.common_tag_link('\\2')", $r);
 418     // XXX: machine tags
 419     return $r;
 420 }
 421
 422 function common_replace_urls_callback($text, $callback, $notice_id = null) {
 423     // Start off with a regex
 424     $regex = '#'.
 425     '(?:^|[\s\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
 426     '('.
 427         '(?:'.
 428             '(?:'. //Known protocols
 429                 '(?:'.
 430                     '(?:(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|irc)://)'.
 431                     '|'.
 432                     '(?:(?:mailto|aim|tel|xmpp):)'.
 433                 ')'.
 434                 '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
 435                 '(?:'.
 436                     '(?:'.
 437                         '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
 438                     ')|(?:'.
 439                         '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
 440                     ')'.
 441                 ')'.
 442             ')'.
 443             '|(?:(?: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
 444             '|(?:'. //IPv6
 445                 '\[?(?:(?:(?:[0-9A-Fa-f]{1,4}:){7}(?:(?:[0-9A-Fa-f]{1,4})|:))|(?:(?:[0-9A-Fa-f]{1,4}:){6}(?::|(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})|(?::[0-9A-Fa-f]{1,4})))|(?:(?:[0-9A-Fa-f]{1,4}:){5}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:){4}(?::[0-9A-Fa-f]{1,4}){0,1}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:){3}(?::[0-9A-Fa-f]{1,4}){0,2}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:){2}(?::[0-9A-Fa-f]{1,4}){0,3}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:)(?::[0-9A-Fa-f]{1,4}){0,4}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?::(?::[0-9A-Fa-f]{1,4}){0,5}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})))\]?(?<!:)'.
 446             ')|(?:'. //DNS
 447                 '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
 448                 '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
 449                 //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
 450                 '(?:AC|AD|AE|AERO|AF|AG|AI|AL|AM|AN|AO|AQ|AR|ARPA|AS|ASIA|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BIZ|BJ|BM|BN|BO|BR|BS|BT|BV|BW|BY|BZ|CA|CAT|CC|CD|CF|CG|CH|CI|CK|CL|CM|CN|CO|COM|COOP|CR|CU|CV|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EDU|EE|EG|ER|ES|ET|EU|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GOV|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HT|HU|ID|IE|IL|IM|IN|INFO|INT|IO|IQ|IR|IS|IT|JE|JM|JO|JOBS|JP|KE|KG|KH|KI|KM|KN|KP|KR|KW|KY|KZ|LA|LB|LC|LI|LK|LR|LS|LT|LU|LV|LY|MA|MC|MD|ME|MG|MH|MIL|MK|ML|MM|MN|MO|MOBI|MP|MQ|MR|MS|MT|MU|MUSEUM|MV|MW|MX|MY|MZ|NA|NAME|NC|NE|NET|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|ORG|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PRO|PS|PT|PW|PY|QA|RE|RO|RS|RU|RW|SA|SB|SC|SD|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SO|SR|ST|SU|SV|SY|SZ|TC|TD|TEL|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TP|TR|TRAVEL|TT|TV|TW|TZ|UA|UG|UK|US|UY|UZ|VA|VC|VE|VG|VI|VN|VU|WF|WS|XN--0ZWM56D|测试|XN--11B5BS3A9AJ6G|परीक्षा|XN--80AKHBYKNJ4F|испытание|XN--9T4B11YI5A|테스트|XN--DEBA0AD|טעסט|XN--G6W251D|測試|XN--HGBK6AJ7F53BBA|آزمایشی|XN--HLCJ6AYA9ESC7A|பரிட்சை|XN--JXALPDLP|δοκιμή|XN--KGBECHTV|إختبار|XN--ZCKZAH|テスト|YE|YT|YU|ZA|ZM|ZW|local|loc|onion)'.
 451             ')(?![\pN\pL\-\_])'.
 452         ')'.
 453         '(?:'.
 454             '(?:\:\d+)?'. //:port
 455             '(?:/[\pN\pL$\[\]\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\"@]*)?'. // /path
 456             '(?:\?[\pN\pL\$\[\]\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\"@\/]*)?'. // ?query string
 457             '(?:\#[\pN\pL$\[\]\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\"\@/\?\#]*)?'. // #fragment
 458         ')(?<![\?\.\,\#\,])'.
 459     ')'.
 460     '#ixu';
 461     //preg_match_all($regex,$text,$matches);
 462     //print_r($matches);
 463     return preg_replace_callback($regex, curry('callback_helper',$callback,$notice_id) ,$text);
 464 }
 465
 466 function callback_helper($matches, $callback, $notice_id) {
 467     $url=$matches[1];
 468     $left = strpos($matches[0],$url);
 469     $right = $left+strlen($url);
 470
 471     $groupSymbolSets=array(
 472         array(
 473             'left'=>'(',
 474             'right'=>')'
 475         ),
 476         array(
 477             'left'=>'[',
 478             'right'=>']'
 479         ),
 480         array(
 481             'left'=>'{',
 482             'right'=>'}'
 483         )
 484     );
 485     $cannotEndWith=array('.','?',',','#');
 486     $original_url=$url;
 487     do{
 488         $original_url=$url;
 489         foreach($groupSymbolSets as $groupSymbolSet){
 490             if(substr($url,-1)==$groupSymbolSet['right']){
 491                 $group_left_count = substr_count($url,$groupSymbolSet['left']);
 492                 $group_right_count = substr_count($url,$groupSymbolSet['right']);
 493                 if($group_left_count<$group_right_count){
 494                     $right-=1;
 495                     $url=substr($url,0,-1);
 496                 }
 497             }
 498         }
 499         if(in_array(substr($url,-1),$cannotEndWith)){
 500             $right-=1;
 501             $url=substr($url,0,-1);
 502         }
 503     }while($original_url!=$url);
 504
 505     if(empty($notice_id)){
 506         $result = call_user_func_array($callback, array($url));
 507     }else{
 508         $result = call_user_func_array($callback, array(array($url,$notice_id)) );
 509     }
 510     return substr($matches[0],0,$left) . $result . substr($matches[0],$right);
 511 }
 512
 513 function curry($fn) {
 514     //TODO switch to a PHP 5.3 function closure based approach if PHP 5.3 is used
 515     $args = func_get_args();
 516     array_shift($args);
 517     $id = uniqid('_partial');
 518     $GLOBALS[$id] = array($fn, $args);
 519     return create_function('',
 520                            '$args = func_get_args(); '.
 521                            'return call_user_func_array('.
 522                            '$GLOBALS["'.$id.'"][0],'.
 523                            'array_merge('.
 524                            '$args,'.
 525                            '$GLOBALS["'.$id.'"][1]));');
 526 }
 527
 528 function common_linkify($url) {
 529     // It comes in special'd, so we unspecial it before passing to the stringifying
 530     // functions
 531     $url = htmlspecialchars_decode($url);
 532
 533    if(strpos($url, '@') !== false && strpos($url, ':') === false) {
 534        //url is an email address without the mailto: protocol
 535        $canon = "mailto:$url";
 536        $longurl = "mailto:$url";
 537    }else{
 538
 539         $canon = File_redirection::_canonUrl($url);
 540
 541         $longurl_data = File_redirection::where($canon);
 542         if (is_array($longurl_data)) {
 543             $longurl = $longurl_data['url'];
 544         } elseif (is_string($longurl_data)) {
 545             $longurl = $longurl_data;
 546         } else {
 547             throw new ServerException("Can't linkify url '$url'");
 548         }
 549     }
 550     $attrs = array('href' => $canon, 'title' => $longurl, 'rel' => 'external');
 551
 552     $is_attachment = false;
 553     $attachment_id = null;
 554     $has_thumb = false;
 555
 556     // Check to see whether this is a known "attachment" URL.
 557
 558     $f = File::staticGet('url', $longurl);
 559
 560     if (empty($f)) {
 561         // XXX: this writes to the database. :<
 562         $f = File::processNew($longurl);
 563     }
 564
 565     if (!empty($f)) {
 566         if ($f->isEnclosure()) {
 567             $is_attachment = true;
 568             $attachment_id = $f->id;
 569         } else {
 570             $foe = File_oembed::staticGet('file_id', $f->id);
 571             if (!empty($foe)) {
 572                 // if it has OEmbed info, it's an attachment, too
 573                 $is_attachment = true;
 574                 $attachment_id = $f->id;
 575
 576                 $thumb = File_thumbnail::staticGet('file_id', $f->id);
 577                 if (!empty($thumb)) {
 578                     $has_thumb = true;
 579                 }
 580             }
 581         }
 582     }
 583
 584     // Add clippy
 585     if ($is_attachment) {
 586         $attrs['class'] = 'attachment';
 587         if ($has_thumb) {
 588             $attrs['class'] = 'attachment thumbnail';
 589         }
 590         $attrs['id'] = "attachment-{$attachment_id}";
 591     }
 592
 593     return XMLStringer::estring('a', $attrs, $url);
 594 }
 595
 596 function common_shorten_links($text)
 597 {
 598     $maxLength = Notice::maxContent();
 599     if ($maxLength == 0 || mb_strlen($text) <= $maxLength) return $text;
 600     return common_replace_urls_callback($text, array('File_redirection', 'makeShort'));
 601 }
 602
 603 function common_xml_safe_str($str)
 604 {
 605     // Neutralize control codes and surrogates
 606         return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
 607 }
 608
 609 function common_tag_link($tag)
 610 {
 611     $canonical = common_canonical_tag($tag);
 612     $url = common_local_url('tag', array('tag' => $canonical));
 613     $xs = new XMLStringer();
 614     $xs->elementStart('span', 'tag');
 615     $xs->element('a', array('href' => $url,
 616                             'rel' => 'tag'),
 617                  $tag);
 618     $xs->elementEnd('span');
 619     return $xs->getString();
 620 }
 621
 622 function common_canonical_tag($tag)
 623 {
 624   $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
 625   return str_replace(array('-', '_', '.'), '', $tag);
 626 }
 627
 628 function common_valid_profile_tag($str)
 629 {
 630     return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
 631 }
 632
 633 function common_at_link($sender_id, $nickname)
 634 {
 635     $sender = Profile::staticGet($sender_id);
 636     $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
 637     if ($recipient) {
 638         $user = User::staticGet('id', $recipient->id);
 639         if ($user) {
 640             $url = common_local_url('userbyid', array('id' => $user->id));
 641         } else {
 642             $url = $recipient->profileurl;
 643         }
 644         $xs = new XMLStringer(false);
 645         $attrs = array('href' => $url,
 646                        'class' => 'url');
 647         if (!empty($recipient->fullname)) {
 648             $attrs['title'] = $recipient->fullname . ' (' . $recipient->nickname . ')';
 649         }
 650         $xs->elementStart('span', 'vcard');
 651         $xs->elementStart('a', $attrs);
 652         $xs->element('span', 'fn nickname', $nickname);
 653         $xs->elementEnd('a');
 654         $xs->elementEnd('span');
 655         return $xs->getString();
 656     } else {
 657         return $nickname;
 658     }
 659 }
 660
 661 function common_group_link($sender_id, $nickname)
 662 {
 663     $sender = Profile::staticGet($sender_id);
 664     $group = User_group::getForNickname($nickname);
 665     if ($group && $sender->isMember($group)) {
 666         $attrs = array('href' => $group->permalink(),
 667                        'class' => 'url');
 668         if (!empty($group->fullname)) {
 669             $attrs['title'] = $group->fullname . ' (' . $group->nickname . ')';
 670         }
 671         $xs = new XMLStringer();
 672         $xs->elementStart('span', 'vcard');
 673         $xs->elementStart('a', $attrs);
 674         $xs->element('span', 'fn nickname', $nickname);
 675         $xs->elementEnd('a');
 676         $xs->elementEnd('span');
 677         return $xs->getString();
 678     } else {
 679         return $nickname;
 680     }
 681 }
 682
 683 function common_at_hash_link($sender_id, $tag)
 684 {
 685     $user = User::staticGet($sender_id);
 686     if (!$user) {
 687         return $tag;
 688     }
 689     $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
 690     if ($tagged) {
 691         $url = common_local_url('subscriptions',
 692                                 array('nickname' => $user->nickname,
 693                                       'tag' => $tag));
 694         $xs = new XMLStringer();
 695         $xs->elementStart('span', 'tag');
 696         $xs->element('a', array('href' => $url,
 697                                 'rel' => $tag),
 698                      $tag);
 699         $xs->elementEnd('span');
 700         return $xs->getString();
 701     } else {
 702         return $tag;
 703     }
 704 }
 705
 706 function common_relative_profile($sender, $nickname, $dt=null)
 707 {
 708     // Try to find profiles this profile is subscribed to that have this nickname
 709     $recipient = new Profile();
 710     // XXX: use a join instead of a subquery
 711     $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
 712     $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
 713     if ($recipient->find(true)) {
 714         // XXX: should probably differentiate between profiles with
 715         // the same name by date of most recent update
 716         return $recipient;
 717     }
 718     // Try to find profiles that listen to this profile and that have this nickname
 719     $recipient = new Profile();
 720     // XXX: use a join instead of a subquery
 721     $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
 722     $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
 723     if ($recipient->find(true)) {
 724         // XXX: should probably differentiate between profiles with
 725         // the same name by date of most recent update
 726         return $recipient;
 727     }
 728     // If this is a local user, try to find a local user with that nickname.
 729     $sender = User::staticGet($sender->id);
 730     if ($sender) {
 731         $recipient_user = User::staticGet('nickname', $nickname);
 732         if ($recipient_user) {
 733             return $recipient_user->getProfile();
 734         }
 735     }
 736     // Otherwise, no links. @messages from local users to remote users,
 737     // or from remote users to other remote users, are just
 738     // outside our ability to make intelligent guesses about
 739     return null;
 740 }
 741
 742 function common_local_url($action, $args=null, $params=null, $fragment=null)
 743 {
 744     $r = Router::get();
 745     $path = $r->build($action, $args, $params, $fragment);
 746
 747     $ssl = common_is_sensitive($action);
 748
 749     if (common_config('site','fancy')) {
 750         $url = common_path(mb_substr($path, 1), $ssl);
 751     } else {
 752         if (mb_strpos($path, '/index.php') === 0) {
 753             $url = common_path(mb_substr($path, 1), $ssl);
 754         } else {
 755             $url = common_path('index.php'.$path, $ssl);
 756         }
 757     }
 758     return $url;
 759 }
 760
 761 function common_is_sensitive($action)
 762 {
 763     static $sensitive = array('login', 'register', 'passwordsettings',
 764                               'twittersettings', 'api');
 765     $ssl = null;
 766
 767     if (Event::handle('SensitiveAction', array($action, &$ssl))) {
 768         $ssl = in_array($action, $sensitive);
 769     }
 770
 771     return $ssl;
 772 }
 773
 774 function common_path($relative, $ssl=false)
 775 {
 776     $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
 777
 778     if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
 779         || common_config('site', 'ssl') === 'always') {
 780         $proto = 'https';
 781         if (is_string(common_config('site', 'sslserver')) &&
 782             mb_strlen(common_config('site', 'sslserver')) > 0) {
 783             $serverpart = common_config('site', 'sslserver');
 784         } else {
 785             $serverpart = common_config('site', 'server');
 786         }
 787     } else {
 788         $proto = 'http';
 789         $serverpart = common_config('site', 'server');
 790     }
 791
 792     return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
 793 }
 794
 795 function common_date_string($dt)
 796 {
 797     // XXX: do some sexy date formatting
 798     // return date(DATE_RFC822, $dt);
 799     $t = strtotime($dt);
 800     $now = time();
 801     $diff = $now - $t;
 802
 803     if ($now < $t) { // that shouldn't happen!
 804         return common_exact_date($dt);
 805     } else if ($diff < 60) {
 806         return _('a few seconds ago');
 807     } else if ($diff < 92) {
 808         return _('about a minute ago');
 809     } else if ($diff < 3300) {
 810         return sprintf(_('about %d minutes ago'), round($diff/60));
 811     } else if ($diff < 5400) {
 812         return _('about an hour ago');
 813     } else if ($diff < 22 * 3600) {
 814         return sprintf(_('about %d hours ago'), round($diff/3600));
 815     } else if ($diff < 37 * 3600) {
 816         return _('about a day ago');
 817     } else if ($diff < 24 * 24 * 3600) {
 818         return sprintf(_('about %d days ago'), round($diff/(24*3600)));
 819     } else if ($diff < 46 * 24 * 3600) {
 820         return _('about a month ago');
 821     } else if ($diff < 330 * 24 * 3600) {
 822         return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
 823     } else if ($diff < 480 * 24 * 3600) {
 824         return _('about a year ago');
 825     } else {
 826         return common_exact_date($dt);
 827     }
 828 }
 829
 830 function common_exact_date($dt)
 831 {
 832     static $_utc;
 833     static $_siteTz;
 834
 835     if (!$_utc) {
 836         $_utc = new DateTimeZone('UTC');
 837         $_siteTz = new DateTimeZone(common_timezone());
 838     }
 839
 840     $dateStr = date('d F Y H:i:s', strtotime($dt));
 841     $d = new DateTime($dateStr, $_utc);
 842     $d->setTimezone($_siteTz);
 843     return $d->format(DATE_RFC850);
 844 }
 845
 846 function common_date_w3dtf($dt)
 847 {
 848     $dateStr = date('d F Y H:i:s', strtotime($dt));
 849     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 850     $d->setTimezone(new DateTimeZone(common_timezone()));
 851     return $d->format(DATE_W3C);
 852 }
 853
 854 function common_date_rfc2822($dt)
 855 {
 856     $dateStr = date('d F Y H:i:s', strtotime($dt));
 857     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 858     $d->setTimezone(new DateTimeZone(common_timezone()));
 859     return $d->format('r');
 860 }
 861
 862 function common_date_iso8601($dt)
 863 {
 864     $dateStr = date('d F Y H:i:s', strtotime($dt));
 865     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 866     $d->setTimezone(new DateTimeZone(common_timezone()));
 867     return $d->format('c');
 868 }
 869
 870 function common_sql_now()
 871 {
 872     return common_sql_date(time());
 873 }
 874
 875 function common_sql_date($datetime)
 876 {
 877     return strftime('%Y-%m-%d %H:%M:%S', $datetime);
 878 }
 879
 880 function common_redirect($url, $code=307)
 881 {
 882     static $status = array(301 => "Moved Permanently",
 883                            302 => "Found",
 884                            303 => "See Other",
 885                            307 => "Temporary Redirect");
 886
 887     header('HTTP/1.1 '.$code.' '.$status[$code]);
 888     header("Location: $url");
 889
 890     $xo = new XMLOutputter();
 891     $xo->startXML('a',
 892                   '-//W3C//DTD XHTML 1.0 Strict//EN',
 893                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
 894     $xo->element('a', array('href' => $url), $url);
 895     $xo->endXML();
 896     exit;
 897 }
 898
 899 function common_broadcast_notice($notice, $remote=false)
 900 {
 901     return common_enqueue_notice($notice);
 902 }
 903
 904 // Stick the notice on the queue
 905
 906 function common_enqueue_notice($notice)
 907 {
 908     static $localTransports = array('omb',
 909                                     'facebook',
 910                                     'ping');
 911
 912     static $allTransports = array('sms', 'plugin');
 913
 914     $transports = $allTransports;
 915
 916     $xmpp = common_config('xmpp', 'enabled');
 917
 918     if ($xmpp) {
 919         $transports[] = 'jabber';
 920     }
 921
 922     if ($notice->is_local == Notice::LOCAL_PUBLIC ||
 923         $notice->is_local == Notice::LOCAL_NONPUBLIC) {
 924         $transports = array_merge($transports, $localTransports);
 925         if ($xmpp) {
 926             $transports[] = 'public';
 927         }
 928     }
 929
 930     if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
 931
 932         $qm = QueueManager::get();
 933
 934         foreach ($transports as $transport)
 935         {
 936             $qm->enqueue($notice, $transport);
 937         }
 938
 939         Event::handle('EndEnqueueNotice', array($notice, $transports));
 940     }
 941
 942     return true;
 943 }
 944
 945 function common_broadcast_profile($profile)
 946 {
 947     // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
 948     require_once(INSTALLDIR.'/lib/omb.php');
 949     omb_broadcast_profile($profile);
 950     // XXX: Other broadcasts...?
 951     return true;
 952 }
 953
 954 function common_profile_url($nickname)
 955 {
 956     return common_local_url('showstream', array('nickname' => $nickname));
 957 }
 958
 959 // Should make up a reasonable root URL
 960
 961 function common_root_url($ssl=false)
 962 {
 963     return common_path('', $ssl);
 964 }
 965
 966 // returns $bytes bytes of random data as a hexadecimal string
 967 // "good" here is a goal and not a guarantee
 968
 969 function common_good_rand($bytes)
 970 {
 971     // XXX: use random.org...?
 972     if (@file_exists('/dev/urandom')) {
 973         return common_urandom($bytes);
 974     } else { // FIXME: this is probably not good enough
 975         return common_mtrand($bytes);
 976     }
 977 }
 978
 979 function common_urandom($bytes)
 980 {
 981     $h = fopen('/dev/urandom', 'rb');
 982     // should not block
 983     $src = fread($h, $bytes);
 984     fclose($h);
 985     $enc = '';
 986     for ($i = 0; $i < $bytes; $i++) {
 987         $enc .= sprintf("%02x", (ord($src[$i])));
 988     }
 989     return $enc;
 990 }
 991
 992 function common_mtrand($bytes)
 993 {
 994     $enc = '';
 995     for ($i = 0; $i < $bytes; $i++) {
 996         $enc .= sprintf("%02x", mt_rand(0, 255));
 997     }
 998     return $enc;
 999 }
1000
1001 function common_set_returnto($url)
1002 {
1003     common_ensure_session();
1004     $_SESSION['returnto'] = $url;
1005 }
1006
1007 function common_get_returnto()
1008 {
1009     common_ensure_session();
1010     return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
1011 }
1012
1013 function common_timestamp()
1014 {
1015     return date('YmdHis');
1016 }
1017
1018 function common_ensure_syslog()
1019 {
1020     static $initialized = false;
1021     if (!$initialized) {
1022         openlog(common_config('syslog', 'appname'), 0,
1023             common_config('syslog', 'facility'));
1024         $initialized = true;
1025     }
1026 }
1027
1028 function common_log_line($priority, $msg)
1029 {
1030     static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1031                                       'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1032     return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
1033 }
1034
1035 function common_log($priority, $msg, $filename=null)
1036 {
1037     $logfile = common_config('site', 'logfile');
1038     if ($logfile) {
1039         $log = fopen($logfile, "a");
1040         if ($log) {
1041             $output = common_log_line($priority, $msg);
1042             fwrite($log, $output);
1043             fclose($log);
1044         }
1045     } else {
1046         common_ensure_syslog();
1047         syslog($priority, $msg);
1048     }
1049 }
1050
1051 function common_debug($msg, $filename=null)
1052 {
1053     if ($filename) {
1054         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1055     } else {
1056         common_log(LOG_DEBUG, $msg);
1057     }
1058 }
1059
1060 function common_log_db_error(&$object, $verb, $filename=null)
1061 {
1062     $objstr = common_log_objstring($object);
1063     $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1064     common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1065 }
1066
1067 function common_log_objstring(&$object)
1068 {
1069     if (is_null($object)) {
1070         return "null";
1071     }
1072     if (!($object instanceof DB_DataObject)) {
1073         return "(unknown)";
1074     }
1075     $arr = $object->toArray();
1076     $fields = array();
1077     foreach ($arr as $k => $v) {
1078         $fields[] = "$k='$v'";
1079     }
1080     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1081     return $objstring;
1082 }
1083
1084 function common_valid_http_url($url)
1085 {
1086     return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1087 }
1088
1089 function common_valid_tag($tag)
1090 {
1091     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1092         return (Validate::email($matches[1]) ||
1093                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1094     }
1095     return false;
1096 }
1097
1098 /* Following functions are copied from MediaWiki GlobalFunctions.php
1099  * and written by Evan Prodromou. */
1100
1101 function common_accept_to_prefs($accept, $def = '*/*')
1102 {
1103     // No arg means accept anything (per HTTP spec)
1104     if(!$accept) {
1105         return array($def => 1);
1106     }
1107
1108     $prefs = array();
1109
1110     $parts = explode(',', $accept);
1111
1112     foreach($parts as $part) {
1113         // FIXME: doesn't deal with params like 'text/html; level=1'
1114         @list($value, $qpart) = explode(';', trim($part));
1115         $match = array();
1116         if(!isset($qpart)) {
1117             $prefs[$value] = 1;
1118         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1119             $prefs[$value] = $match[1];
1120         }
1121     }
1122
1123     return $prefs;
1124 }
1125
1126 function common_mime_type_match($type, $avail)
1127 {
1128     if(array_key_exists($type, $avail)) {
1129         return $type;
1130     } else {
1131         $parts = explode('/', $type);
1132         if(array_key_exists($parts[0] . '/*', $avail)) {
1133             return $parts[0] . '/*';
1134         } elseif(array_key_exists('*/*', $avail)) {
1135             return '*/*';
1136         } else {
1137             return null;
1138         }
1139     }
1140 }
1141
1142 function common_negotiate_type($cprefs, $sprefs)
1143 {
1144     $combine = array();
1145
1146     foreach(array_keys($sprefs) as $type) {
1147         $parts = explode('/', $type);
1148         if($parts[1] != '*') {
1149             $ckey = common_mime_type_match($type, $cprefs);
1150             if($ckey) {
1151                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1152             }
1153         }
1154     }
1155
1156     foreach(array_keys($cprefs) as $type) {
1157         $parts = explode('/', $type);
1158         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1159             $skey = common_mime_type_match($type, $sprefs);
1160             if($skey) {
1161                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1162             }
1163         }
1164     }
1165
1166     $bestq = 0;
1167     $besttype = 'text/html';
1168
1169     foreach(array_keys($combine) as $type) {
1170         if($combine[$type] > $bestq) {
1171             $besttype = $type;
1172             $bestq = $combine[$type];
1173         }
1174     }
1175
1176     if ('text/html' === $besttype) {
1177         return "text/html; charset=utf-8";
1178     }
1179     return $besttype;
1180 }
1181
1182 function common_config($main, $sub)
1183 {
1184     global $config;
1185     return (array_key_exists($main, $config) &&
1186             array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
1187 }
1188
1189 function common_copy_args($from)
1190 {
1191     $to = array();
1192     $strip = get_magic_quotes_gpc();
1193     foreach ($from as $k => $v) {
1194         $to[$k] = ($strip) ? stripslashes($v) : $v;
1195     }
1196     return $to;
1197 }
1198
1199 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1200 // This is used before handing a request off to OAuthRequest::from_request.
1201 function common_remove_magic_from_request()
1202 {
1203     if(get_magic_quotes_gpc()) {
1204         $_POST=array_map('stripslashes',$_POST);
1205         $_GET=array_map('stripslashes',$_GET);
1206     }
1207 }
1208
1209 function common_user_uri(&$user)
1210 {
1211     return common_local_url('userbyid', array('id' => $user->id));
1212 }
1213
1214 function common_notice_uri(&$notice)
1215 {
1216     return common_local_url('shownotice',
1217                             array('notice' => $notice->id));
1218 }
1219
1220 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1221
1222 function common_confirmation_code($bits)
1223 {
1224     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1225     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1226     $chars = ceil($bits/5);
1227     $code = '';
1228     for ($i = 0; $i < $chars; $i++) {
1229         // XXX: convert to string and back
1230         $num = hexdec(common_good_rand(1));
1231         // XXX: randomness is too precious to throw away almost
1232         // 40% of the bits we get!
1233         $code .= $codechars[$num%32];
1234     }
1235     return $code;
1236 }
1237
1238 // convert markup to HTML
1239
1240 function common_markup_to_html($c)
1241 {
1242     $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1243     $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1244     $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1245     return Markdown($c);
1246 }
1247
1248 function common_profile_uri($profile)
1249 {
1250     if (!$profile) {
1251         return null;
1252     }
1253     $user = User::staticGet($profile->id);
1254     if ($user) {
1255         return $user->uri;
1256     }
1257
1258     $remote = Remote_profile::staticGet($profile->id);
1259     if ($remote) {
1260         return $remote->uri;
1261     }
1262     // XXX: this is a very bad profile!
1263     return null;
1264 }
1265
1266 function common_canonical_sms($sms)
1267 {
1268     // strip non-digits
1269     preg_replace('/\D/', '', $sms);
1270     return $sms;
1271 }
1272
1273 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1274 {
1275     switch ($errno) {
1276
1277      case E_ERROR:
1278      case E_COMPILE_ERROR:
1279      case E_CORE_ERROR:
1280      case E_USER_ERROR:
1281      case E_PARSE:
1282      case E_RECOVERABLE_ERROR:
1283         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
1284         die();
1285         break;
1286
1287      case E_WARNING:
1288      case E_COMPILE_WARNING:
1289      case E_CORE_WARNING:
1290      case E_USER_WARNING:
1291         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1292         break;
1293
1294      case E_NOTICE:
1295      case E_USER_NOTICE:
1296         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1297         break;
1298
1299      case E_STRICT:
1300      case E_DEPRECATED:
1301      case E_USER_DEPRECATED:
1302         // XXX: config variable to log this stuff, too
1303         break;
1304
1305      default:
1306         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
1307         die();
1308         break;
1309     }
1310
1311     // FIXME: show error page if we're on the Web
1312     /* Don't execute PHP internal error handler */
1313     return true;
1314 }
1315
1316 function common_session_token()
1317 {
1318     common_ensure_session();
1319     if (!array_key_exists('token', $_SESSION)) {
1320         $_SESSION['token'] = common_good_rand(64);
1321     }
1322     return $_SESSION['token'];
1323 }
1324
1325 function common_cache_key($extra)
1326 {
1327     $base_key = common_config('memcached', 'base');
1328
1329     if (empty($base_key)) {
1330         $base_key = common_keyize(common_config('site', 'name'));
1331     }
1332
1333     return 'statusnet:' . $base_key . ':' . $extra;
1334 }
1335
1336 function common_keyize($str)
1337 {
1338     $str = strtolower($str);
1339     $str = preg_replace('/\s/', '_', $str);
1340     return $str;
1341 }
1342
1343 function common_memcache()
1344 {
1345     static $cache = null;
1346     if (!common_config('memcached', 'enabled')) {
1347         return null;
1348     } else {
1349         if (!$cache) {
1350             $cache = new Memcache();
1351             $servers = common_config('memcached', 'server');
1352             if (is_array($servers)) {
1353                 foreach($servers as $server) {
1354                     $cache->addServer($server);
1355                 }
1356             } else {
1357                 $cache->addServer($servers);
1358             }
1359         }
1360         return $cache;
1361     }
1362 }
1363
1364 function common_compatible_license($from, $to)
1365 {
1366     // XXX: better compatibility check needed here!
1367     return ($from == $to);
1368 }
1369
1370 /**
1371  * returns a quoted table name, if required according to config
1372  */
1373 function common_database_tablename($tablename)
1374 {
1375
1376   if(common_config('db','quote_identifiers')) {
1377       $tablename = '"'. $tablename .'"';
1378   }
1379   //table prefixes could be added here later
1380   return $tablename;
1381 }
1382
1383 function common_shorten_url($long_url)
1384 {
1385     $user = common_current_user();
1386     if (empty($user)) {
1387         // common current user does not find a user when called from the XMPP daemon
1388         // therefore we'll set one here fix, so that XMPP given URLs may be shortened
1389         $svc = 'ur1.ca';
1390     } else {
1391         $svc = $user->urlshorteningservice;
1392     }
1393     global $_shorteners;
1394     if (!isset($_shorteners[$svc])) {
1395         //the user selected service doesn't exist, so default to ur1.ca
1396         $svc = 'ur1.ca';
1397     }
1398     if (!isset($_shorteners[$svc])) {
1399         // no shortener plugins installed.
1400         return $long_url;
1401     }
1402
1403     $reflectionObj = new ReflectionClass($_shorteners[$svc]['callInfo'][0]);
1404     $short_url_service = $reflectionObj->newInstanceArgs($_shorteners[$svc]['callInfo'][1]);
1405     $short_url = $short_url_service->shorten($long_url);
1406
1407     return $short_url;
1408 }
1409
1410 function common_client_ip()
1411 {
1412     if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
1413         return null;
1414     }
1415
1416     if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
1417         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1418             $proxy = $_SERVER['HTTP_CLIENT_IP'];
1419         } else {
1420             $proxy = $_SERVER['REMOTE_ADDR'];
1421         }
1422         $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
1423     } else {
1424         $proxy = null;
1425         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1426             $ip = $_SERVER['HTTP_CLIENT_IP'];
1427         } else {
1428             $ip = $_SERVER['REMOTE_ADDR'];
1429         }
1430     }
1431
1432     return array($proxy, $ip);
1433 }