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 ($f->isEnclosure()) {
 556             $is_attachment = true;
 557             $attachment_id = $f->id;
 558         } else {
 559             $foe = File_oembed::staticGet('file_id', $f->id);
 560             if (!empty($foe)) {
 561                 // if it has OEmbed info, it's an attachment, too
 562                 $is_attachment = true;
 563                 $attachment_id = $f->id;
 564
 565                 $thumb = File_thumbnail::staticGet('file_id', $f->id);
 566                 if (!empty($thumb)) {
 567                     $has_thumb = true;
 568                 }
 569             }
 570         }
 571     }
 572
 573     // Add clippy
 574     if ($is_attachment) {
 575         $attrs['class'] = 'attachment';
 576         if ($has_thumb) {
 577             $attrs['class'] = 'attachment thumbnail';
 578         }
 579         $attrs['id'] = "attachment-{$attachment_id}";
 580     }
 581
 582     return XMLStringer::estring('a', $attrs, $url);
 583 }
 584
 585 function common_shorten_links($text)
 586 {
 587     if (mb_strlen($text) <= 140) 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     static $sensitive = array('login', 'register', 'passwordsettings',
 733                               'twittersettings', 'finishopenidlogin',
 734                               'finishaddopenid', 'api');
 735
 736     $r = Router::get();
 737     $path = $r->build($action, $args, $params, $fragment);
 738
 739     $ssl = in_array($action, $sensitive);
 740
 741     if (common_config('site','fancy')) {
 742         $url = common_path(mb_substr($path, 1), $ssl);
 743     } else {
 744         if (mb_strpos($path, '/index.php') === 0) {
 745             $url = common_path(mb_substr($path, 1), $ssl);
 746         } else {
 747             $url = common_path('index.php'.$path, $ssl);
 748         }
 749     }
 750     return $url;
 751 }
 752
 753 function common_path($relative, $ssl=false)
 754 {
 755     $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
 756
 757     if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
 758         || common_config('site', 'ssl') === 'always') {
 759         $proto = 'https';
 760         if (is_string(common_config('site', 'sslserver')) &&
 761             mb_strlen(common_config('site', 'sslserver')) > 0) {
 762             $serverpart = common_config('site', 'sslserver');
 763         } else {
 764             $serverpart = common_config('site', 'server');
 765         }
 766     } else {
 767         $proto = 'http';
 768         $serverpart = common_config('site', 'server');
 769     }
 770
 771     return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
 772 }
 773
 774 function common_date_string($dt)
 775 {
 776     // XXX: do some sexy date formatting
 777     // return date(DATE_RFC822, $dt);
 778     $t = strtotime($dt);
 779     $now = time();
 780     $diff = $now - $t;
 781
 782     if ($now < $t) { // that shouldn't happen!
 783         return common_exact_date($dt);
 784     } else if ($diff < 60) {
 785         return _('a few seconds ago');
 786     } else if ($diff < 92) {
 787         return _('about a minute ago');
 788     } else if ($diff < 3300) {
 789         return sprintf(_('about %d minutes ago'), round($diff/60));
 790     } else if ($diff < 5400) {
 791         return _('about an hour ago');
 792     } else if ($diff < 22 * 3600) {
 793         return sprintf(_('about %d hours ago'), round($diff/3600));
 794     } else if ($diff < 37 * 3600) {
 795         return _('about a day ago');
 796     } else if ($diff < 24 * 24 * 3600) {
 797         return sprintf(_('about %d days ago'), round($diff/(24*3600)));
 798     } else if ($diff < 46 * 24 * 3600) {
 799         return _('about a month ago');
 800     } else if ($diff < 330 * 24 * 3600) {
 801         return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
 802     } else if ($diff < 480 * 24 * 3600) {
 803         return _('about a year ago');
 804     } else {
 805         return common_exact_date($dt);
 806     }
 807 }
 808
 809 function common_exact_date($dt)
 810 {
 811     static $_utc;
 812     static $_siteTz;
 813
 814     if (!$_utc) {
 815         $_utc = new DateTimeZone('UTC');
 816         $_siteTz = new DateTimeZone(common_timezone());
 817     }
 818
 819     $dateStr = date('d F Y H:i:s', strtotime($dt));
 820     $d = new DateTime($dateStr, $_utc);
 821     $d->setTimezone($_siteTz);
 822     return $d->format(DATE_RFC850);
 823 }
 824
 825 function common_date_w3dtf($dt)
 826 {
 827     $dateStr = date('d F Y H:i:s', strtotime($dt));
 828     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 829     $d->setTimezone(new DateTimeZone(common_timezone()));
 830     return $d->format(DATE_W3C);
 831 }
 832
 833 function common_date_rfc2822($dt)
 834 {
 835     $dateStr = date('d F Y H:i:s', strtotime($dt));
 836     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 837     $d->setTimezone(new DateTimeZone(common_timezone()));
 838     return $d->format('r');
 839 }
 840
 841 function common_date_iso8601($dt)
 842 {
 843     $dateStr = date('d F Y H:i:s', strtotime($dt));
 844     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 845     $d->setTimezone(new DateTimeZone(common_timezone()));
 846     return $d->format('c');
 847 }
 848
 849 function common_sql_now()
 850 {
 851     return common_sql_date(time());
 852 }
 853
 854 function common_sql_date($datetime)
 855 {
 856     return strftime('%Y-%m-%d %H:%M:%S', $datetime);
 857 }
 858
 859 function common_redirect($url, $code=307)
 860 {
 861     static $status = array(301 => "Moved Permanently",
 862                            302 => "Found",
 863                            303 => "See Other",
 864                            307 => "Temporary Redirect");
 865
 866     header('HTTP/1.1 '.$code.' '.$status[$code]);
 867     header("Location: $url");
 868
 869     $xo = new XMLOutputter();
 870     $xo->startXML('a',
 871                   '-//W3C//DTD XHTML 1.0 Strict//EN',
 872                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
 873     $xo->element('a', array('href' => $url), $url);
 874     $xo->endXML();
 875     exit;
 876 }
 877
 878 function common_broadcast_notice($notice, $remote=false)
 879 {
 880     return common_enqueue_notice($notice);
 881 }
 882
 883 // Stick the notice on the queue
 884
 885 function common_enqueue_notice($notice)
 886 {
 887     static $localTransports = array('omb',
 888                                     'twitter',
 889                                     'facebook',
 890                                     'ping');
 891     static $allTransports = array('sms');
 892
 893     $transports = $allTransports;
 894
 895     $xmpp = common_config('xmpp', 'enabled');
 896
 897     if ($xmpp) {
 898         $transports[] = 'jabber';
 899     }
 900
 901     if ($notice->is_local == Notice::LOCAL_PUBLIC ||
 902         $notice->is_local == Notice::LOCAL_NONPUBLIC) {
 903         $transports = array_merge($transports, $localTransports);
 904         if ($xmpp) {
 905             $transports[] = 'public';
 906         }
 907     }
 908
 909     $qm = QueueManager::get();
 910
 911     foreach ($transports as $transport)
 912     {
 913         $qm->enqueue($notice, $transport);
 914     }
 915
 916     return true;
 917 }
 918
 919 function common_broadcast_profile($profile)
 920 {
 921     // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
 922     require_once(INSTALLDIR.'/lib/omb.php');
 923     omb_broadcast_profile($profile);
 924     // XXX: Other broadcasts...?
 925     return true;
 926 }
 927
 928 function common_profile_url($nickname)
 929 {
 930     return common_local_url('showstream', array('nickname' => $nickname));
 931 }
 932
 933 // Should make up a reasonable root URL
 934
 935 function common_root_url($ssl=false)
 936 {
 937     return common_path('', $ssl);
 938 }
 939
 940 // returns $bytes bytes of random data as a hexadecimal string
 941 // "good" here is a goal and not a guarantee
 942
 943 function common_good_rand($bytes)
 944 {
 945     // XXX: use random.org...?
 946     if (@file_exists('/dev/urandom')) {
 947         return common_urandom($bytes);
 948     } else { // FIXME: this is probably not good enough
 949         return common_mtrand($bytes);
 950     }
 951 }
 952
 953 function common_urandom($bytes)
 954 {
 955     $h = fopen('/dev/urandom', 'rb');
 956     // should not block
 957     $src = fread($h, $bytes);
 958     fclose($h);
 959     $enc = '';
 960     for ($i = 0; $i < $bytes; $i++) {
 961         $enc .= sprintf("%02x", (ord($src[$i])));
 962     }
 963     return $enc;
 964 }
 965
 966 function common_mtrand($bytes)
 967 {
 968     $enc = '';
 969     for ($i = 0; $i < $bytes; $i++) {
 970         $enc .= sprintf("%02x", mt_rand(0, 255));
 971     }
 972     return $enc;
 973 }
 974
 975 function common_set_returnto($url)
 976 {
 977     common_ensure_session();
 978     $_SESSION['returnto'] = $url;
 979 }
 980
 981 function common_get_returnto()
 982 {
 983     common_ensure_session();
 984     return $_SESSION['returnto'];
 985 }
 986
 987 function common_timestamp()
 988 {
 989     return date('YmdHis');
 990 }
 991
 992 function common_ensure_syslog()
 993 {
 994     static $initialized = false;
 995     if (!$initialized) {
 996         openlog(common_config('syslog', 'appname'), 0,
 997             common_config('syslog', 'facility'));
 998         $initialized = true;
 999     }
1000 }
1001
1002 function common_log_line($priority, $msg)
1003 {
1004     static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1005                                       'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1006     return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
1007 }
1008
1009 function common_log($priority, $msg, $filename=null)
1010 {
1011     $logfile = common_config('site', 'logfile');
1012     if ($logfile) {
1013         $log = fopen($logfile, "a");
1014         if ($log) {
1015             $output = common_log_line($priority, $msg);
1016             fwrite($log, $output);
1017             fclose($log);
1018         }
1019     } else {
1020         common_ensure_syslog();
1021         syslog($priority, $msg);
1022     }
1023 }
1024
1025 function common_debug($msg, $filename=null)
1026 {
1027     if ($filename) {
1028         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1029     } else {
1030         common_log(LOG_DEBUG, $msg);
1031     }
1032 }
1033
1034 function common_log_db_error(&$object, $verb, $filename=null)
1035 {
1036     $objstr = common_log_objstring($object);
1037     $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1038     common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1039 }
1040
1041 function common_log_objstring(&$object)
1042 {
1043     if (is_null($object)) {
1044         return "null";
1045     }
1046     if (!($object instanceof DB_DataObject)) {
1047         return "(unknown)";
1048     }
1049     $arr = $object->toArray();
1050     $fields = array();
1051     foreach ($arr as $k => $v) {
1052         $fields[] = "$k='$v'";
1053     }
1054     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1055     return $objstring;
1056 }
1057
1058 function common_valid_http_url($url)
1059 {
1060     return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1061 }
1062
1063 function common_valid_tag($tag)
1064 {
1065     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1066         return (Validate::email($matches[1]) ||
1067                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1068     }
1069     return false;
1070 }
1071
1072 /* Following functions are copied from MediaWiki GlobalFunctions.php
1073  * and written by Evan Prodromou. */
1074
1075 function common_accept_to_prefs($accept, $def = '*/*')
1076 {
1077     // No arg means accept anything (per HTTP spec)
1078     if(!$accept) {
1079         return array($def => 1);
1080     }
1081
1082     $prefs = array();
1083
1084     $parts = explode(',', $accept);
1085
1086     foreach($parts as $part) {
1087         // FIXME: doesn't deal with params like 'text/html; level=1'
1088         @list($value, $qpart) = explode(';', trim($part));
1089         $match = array();
1090         if(!isset($qpart)) {
1091             $prefs[$value] = 1;
1092         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1093             $prefs[$value] = $match[1];
1094         }
1095     }
1096
1097     return $prefs;
1098 }
1099
1100 function common_mime_type_match($type, $avail)
1101 {
1102     if(array_key_exists($type, $avail)) {
1103         return $type;
1104     } else {
1105         $parts = explode('/', $type);
1106         if(array_key_exists($parts[0] . '/*', $avail)) {
1107             return $parts[0] . '/*';
1108         } elseif(array_key_exists('*/*', $avail)) {
1109             return '*/*';
1110         } else {
1111             return null;
1112         }
1113     }
1114 }
1115
1116 function common_negotiate_type($cprefs, $sprefs)
1117 {
1118     $combine = array();
1119
1120     foreach(array_keys($sprefs) as $type) {
1121         $parts = explode('/', $type);
1122         if($parts[1] != '*') {
1123             $ckey = common_mime_type_match($type, $cprefs);
1124             if($ckey) {
1125                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1126             }
1127         }
1128     }
1129
1130     foreach(array_keys($cprefs) as $type) {
1131         $parts = explode('/', $type);
1132         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1133             $skey = common_mime_type_match($type, $sprefs);
1134             if($skey) {
1135                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1136             }
1137         }
1138     }
1139
1140     $bestq = 0;
1141     $besttype = 'text/html';
1142
1143     foreach(array_keys($combine) as $type) {
1144         if($combine[$type] > $bestq) {
1145             $besttype = $type;
1146             $bestq = $combine[$type];
1147         }
1148     }
1149
1150     if ('text/html' === $besttype) {
1151         return "text/html; charset=utf-8";
1152     }
1153     return $besttype;
1154 }
1155
1156 function common_config($main, $sub)
1157 {
1158     global $config;
1159     return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1160 }
1161
1162 function common_copy_args($from)
1163 {
1164     $to = array();
1165     $strip = get_magic_quotes_gpc();
1166     foreach ($from as $k => $v) {
1167         $to[$k] = ($strip) ? stripslashes($v) : $v;
1168     }
1169     return $to;
1170 }
1171
1172 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1173 // This is used before handing a request off to OAuthRequest::from_request.
1174 function common_remove_magic_from_request()
1175 {
1176     if(get_magic_quotes_gpc()) {
1177         $_POST=array_map('stripslashes',$_POST);
1178         $_GET=array_map('stripslashes',$_GET);
1179     }
1180 }
1181
1182 function common_user_uri(&$user)
1183 {
1184     return common_local_url('userbyid', array('id' => $user->id));
1185 }
1186
1187 function common_notice_uri(&$notice)
1188 {
1189     return common_local_url('shownotice',
1190                             array('notice' => $notice->id));
1191 }
1192
1193 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1194
1195 function common_confirmation_code($bits)
1196 {
1197     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1198     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1199     $chars = ceil($bits/5);
1200     $code = '';
1201     for ($i = 0; $i < $chars; $i++) {
1202         // XXX: convert to string and back
1203         $num = hexdec(common_good_rand(1));
1204         // XXX: randomness is too precious to throw away almost
1205         // 40% of the bits we get!
1206         $code .= $codechars[$num%32];
1207     }
1208     return $code;
1209 }
1210
1211 // convert markup to HTML
1212
1213 function common_markup_to_html($c)
1214 {
1215     $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1216     $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1217     $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1218     return Markdown($c);
1219 }
1220
1221 function common_profile_uri($profile)
1222 {
1223     if (!$profile) {
1224         return null;
1225     }
1226     $user = User::staticGet($profile->id);
1227     if ($user) {
1228         return $user->uri;
1229     }
1230
1231     $remote = Remote_profile::staticGet($profile->id);
1232     if ($remote) {
1233         return $remote->uri;
1234     }
1235     // XXX: this is a very bad profile!
1236     return null;
1237 }
1238
1239 function common_canonical_sms($sms)
1240 {
1241     // strip non-digits
1242     preg_replace('/\D/', '', $sms);
1243     return $sms;
1244 }
1245
1246 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1247 {
1248     switch ($errno) {
1249
1250      case E_ERROR:
1251      case E_COMPILE_ERROR:
1252      case E_CORE_ERROR:
1253      case E_USER_ERROR:
1254      case E_PARSE:
1255      case E_RECOVERABLE_ERROR:
1256         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
1257         die();
1258         break;
1259
1260      case E_WARNING:
1261      case E_COMPILE_WARNING:
1262      case E_CORE_WARNING:
1263      case E_USER_WARNING:
1264         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1265         break;
1266
1267      case E_NOTICE:
1268      case E_USER_NOTICE:
1269         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1270         break;
1271
1272      case E_STRICT:
1273      case E_DEPRECATED:
1274      case E_USER_DEPRECATED:
1275         // XXX: config variable to log this stuff, too
1276         break;
1277
1278      default:
1279         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
1280         die();
1281         break;
1282     }
1283
1284     // FIXME: show error page if we're on the Web
1285     /* Don't execute PHP internal error handler */
1286     return true;
1287 }
1288
1289 function common_session_token()
1290 {
1291     common_ensure_session();
1292     if (!array_key_exists('token', $_SESSION)) {
1293         $_SESSION['token'] = common_good_rand(64);
1294     }
1295     return $_SESSION['token'];
1296 }
1297
1298 function common_cache_key($extra)
1299 {
1300     $base_key = common_config('memcached', 'base');
1301
1302     if (empty($base_key)) {
1303         $base_key = common_keyize(common_config('site', 'name'));
1304     }
1305
1306     return 'statusnet:' . $base_key . ':' . $extra;
1307 }
1308
1309 function common_keyize($str)
1310 {
1311     $str = strtolower($str);
1312     $str = preg_replace('/\s/', '_', $str);
1313     return $str;
1314 }
1315
1316 function common_memcache()
1317 {
1318     static $cache = null;
1319     if (!common_config('memcached', 'enabled')) {
1320         return null;
1321     } else {
1322         if (!$cache) {
1323             $cache = new Memcache();
1324             $servers = common_config('memcached', 'server');
1325             if (is_array($servers)) {
1326                 foreach($servers as $server) {
1327                     $cache->addServer($server);
1328                 }
1329             } else {
1330                 $cache->addServer($servers);
1331             }
1332         }
1333         return $cache;
1334     }
1335 }
1336
1337 function common_compatible_license($from, $to)
1338 {
1339     // XXX: better compatibility check needed here!
1340     return ($from == $to);
1341 }
1342
1343 /**
1344  * returns a quoted table name, if required according to config
1345  */
1346 function common_database_tablename($tablename)
1347 {
1348
1349   if(common_config('db','quote_identifiers')) {
1350       $tablename = '"'. $tablename .'"';
1351   }
1352   //table prefixes could be added here later
1353   return $tablename;
1354 }
1355
1356 function common_shorten_url($long_url)
1357 {
1358     $user = common_current_user();
1359     if (empty($user)) {
1360         // common current user does not find a user when called from the XMPP daemon
1361         // therefore we'll set one here fix, so that XMPP given URLs may be shortened
1362         $svc = 'ur1.ca';
1363     } else {
1364         $svc = $user->urlshorteningservice;
1365     }
1366
1367     $curlh = curl_init();
1368     curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
1369     curl_setopt($curlh, CURLOPT_USERAGENT, 'StatusNet');
1370     curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
1371
1372     switch($svc) {
1373      case 'ur1.ca':
1374         require_once INSTALLDIR.'/lib/Shorturl_api.php';
1375         $short_url_service = new LilUrl;
1376         $short_url = $short_url_service->shorten($long_url);
1377         break;
1378
1379      case '2tu.us':
1380         $short_url_service = new TightUrl;
1381         require_once INSTALLDIR.'/lib/Shorturl_api.php';
1382         $short_url = $short_url_service->shorten($long_url);
1383         break;
1384
1385      case 'ptiturl.com':
1386         require_once INSTALLDIR.'/lib/Shorturl_api.php';
1387         $short_url_service = new PtitUrl;
1388         $short_url = $short_url_service->shorten($long_url);
1389         break;
1390
1391      case 'bit.ly':
1392         curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($long_url));
1393         $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
1394         break;
1395
1396      case 'is.gd':
1397         curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($long_url));
1398         $short_url = curl_exec($curlh);
1399         break;
1400      case 'snipr.com':
1401         curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($long_url));
1402         $short_url = curl_exec($curlh);
1403         break;
1404      case 'metamark.net':
1405         curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($long_url));
1406         $short_url = curl_exec($curlh);
1407         break;
1408      case 'tinyurl.com':
1409         curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($long_url));
1410         $short_url = curl_exec($curlh);
1411         break;
1412      default:
1413         $short_url = false;
1414     }
1415
1416     curl_close($curlh);
1417
1418     return $short_url;
1419 }
1420
1421 function common_client_ip()
1422 {
1423     if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
1424         return null;
1425     }
1426
1427     if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
1428         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1429             $proxy = $_SERVER['HTTP_CLIENT_IP'];
1430         } else {
1431             $proxy = $_SERVER['REMOTE_ADDR'];
1432         }
1433         $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
1434     } else {
1435         $proxy = null;
1436         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1437             $ip = $_SERVER['HTTP_CLIENT_IP'];
1438         } else {
1439             $ip = $_SERVER['REMOTE_ADDR'];
1440         }
1441     }
1442
1443     return array($proxy, $ip);
1444 }