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