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