lib/util.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, StatusNet, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 /* XXX: break up into separate modules (HTTP, user, files) */
  21
  22 // Show a server error
  23
  24 function common_server_error($msg, $code=500)
  25 {
  26     $err = new ServerErrorAction($msg, $code);
  27     $err->showPage();
  28 }
  29
  30 // Show a user error
  31 function common_user_error($msg, $code=400)
  32 {
  33     $err = new ClientErrorAction($msg, $code);
  34     $err->showPage();
  35 }
  36
  37 function common_init_locale($language=null)
  38 {
  39     if(!$language) {
  40         $language = common_language();
  41     }
  42     putenv('LANGUAGE='.$language);
  43     putenv('LANG='.$language);
  44     return setlocale(LC_ALL, $language . ".utf8",
  45                      $language . ".UTF8",
  46                      $language . ".utf-8",
  47                      $language . ".UTF-8",
  48                      $language);
  49 }
  50
  51 function common_init_language()
  52 {
  53     mb_internal_encoding('UTF-8');
  54
  55     // gettext seems very picky... We first need to setlocale()
  56     // to a locale which _does_ exist on the system, and _then_
  57     // we can set in another locale that may not be set up
  58     // (say, ga_ES for Galego/Galician) it seems to take it.
  59     common_init_locale("en_US");
  60
  61     // Note that this setlocale() call may "fail" but this is harmless;
  62     // gettext will still select the right language.
  63     $language = common_language();
  64     $locale_set = common_init_locale($language);
  65
  66     setlocale(LC_CTYPE, 'C');
  67     // So we do not have to make people install the gettext locales
  68     $path = common_config('site','locale_path');
  69     bindtextdomain("statusnet", $path);
  70     bind_textdomain_codeset("statusnet", "UTF-8");
  71     textdomain("statusnet");
  72 }
  73
  74 function common_timezone()
  75 {
  76     if (common_logged_in()) {
  77         $user = common_current_user();
  78         if ($user->timezone) {
  79             return $user->timezone;
  80         }
  81     }
  82
  83     return common_config('site', 'timezone');
  84 }
  85
  86 function common_language()
  87 {
  88
  89     // If there is a user logged in and they've set a language preference
  90     // then return that one...
  91     if (_have_config() && common_logged_in()) {
  92         $user = common_current_user();
  93         $user_language = $user->language;
  94
  95         if ($user->language) {
  96             // Validate -- we don't want to end up with a bogus code
  97             // left over from some old junk.
  98             foreach (common_config('site', 'languages') as $code => $info) {
  99                 if ($info['lang'] == $user_language) {
 100                     return $user_language;
 101                 }
 102             }
 103         }
 104     }
 105
 106     // Otherwise, find the best match for the languages requested by the
 107     // user's browser...
 108     $httplang = isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? $_SERVER['HTTP_ACCEPT_LANGUAGE'] : null;
 109     if (!empty($httplang)) {
 110         $language = client_prefered_language($httplang);
 111         if ($language)
 112           return $language;
 113     }
 114
 115     // Finally, if none of the above worked, use the site's default...
 116     return common_config('site', 'language');
 117 }
 118 // salted, hashed passwords are stored in the DB
 119
 120 function common_munge_password($password, $id)
 121 {
 122     if (is_object($id) || is_object($password)) {
 123         $e = new Exception();
 124         common_log(LOG_ERR, __METHOD__ . ' object in param to common_munge_password ' .
 125                    str_replace("\n", " ", $e->getTraceAsString()));
 126     }
 127     return md5($password . $id);
 128 }
 129
 130 // check if a username exists and has matching password
 131
 132 function common_check_user($nickname, $password)
 133 {
 134     $authenticatedUser = false;
 135
 136     if (Event::handle('StartCheckPassword', array($nickname, $password, &$authenticatedUser))) {
 137         $user = User::staticGet('nickname', $nickname);
 138         if (!empty($user)) {
 139             if (!empty($password)) { // never allow login with blank password
 140                 if (0 == strcmp(common_munge_password($password, $user->id),
 141                                 $user->password)) {
 142                     //internal checking passed
 143                     $authenticatedUser = $user;
 144                 }
 145             }
 146         }
 147         Event::handle('EndCheckPassword', array($nickname, $password, $authenticatedUser));
 148     }
 149
 150     return $authenticatedUser;
 151 }
 152
 153 // is the current user logged in?
 154 function common_logged_in()
 155 {
 156     return (!is_null(common_current_user()));
 157 }
 158
 159 function common_have_session()
 160 {
 161     return (0 != strcmp(session_id(), ''));
 162 }
 163
 164 function common_ensure_session()
 165 {
 166     $c = null;
 167     if (array_key_exists(session_name(), $_COOKIE)) {
 168         $c = $_COOKIE[session_name()];
 169     }
 170     if (!common_have_session()) {
 171         if (common_config('sessions', 'handle')) {
 172             Session::setSaveHandler();
 173         }
 174         if (array_key_exists(session_name(), $_GET)) {
 175             $id = $_GET[session_name()];
 176         } else if (array_key_exists(session_name(), $_COOKIE)) {
 177             $id = $_COOKIE[session_name()];
 178         }
 179         if (isset($id)) {
 180             session_id($id);
 181         }
 182         @session_start();
 183         if (!isset($_SESSION['started'])) {
 184             $_SESSION['started'] = time();
 185             if (!empty($id)) {
 186                 common_log(LOG_WARNING, 'Session cookie "' . $_COOKIE[session_name()] . '" ' .
 187                            ' is set but started value is null');
 188             }
 189         }
 190     }
 191 }
 192
 193 // Three kinds of arguments:
 194 // 1) a user object
 195 // 2) a nickname
 196 // 3) null to clear
 197
 198 // Initialize to false; set to null if none found
 199
 200 $_cur = false;
 201
 202 function common_set_user($user)
 203 {
 204
 205     global $_cur;
 206
 207     if (is_null($user) && common_have_session()) {
 208         $_cur = null;
 209         unset($_SESSION['userid']);
 210         return true;
 211     } else if (is_string($user)) {
 212         $nickname = $user;
 213         $user = User::staticGet('nickname', $nickname);
 214     } else if (!($user instanceof User)) {
 215         return false;
 216     }
 217
 218     if ($user) {
 219         if (Event::handle('StartSetUser', array(&$user))) {
 220             if($user){
 221                 common_ensure_session();
 222                 $_SESSION['userid'] = $user->id;
 223                 $_cur = $user;
 224                 Event::handle('EndSetUser', array($user));
 225                 return $_cur;
 226             }
 227         }
 228     }
 229     return false;
 230 }
 231
 232 function common_set_cookie($key, $value, $expiration=0)
 233 {
 234     $path = common_config('site', 'path');
 235     $server = common_config('site', 'server');
 236
 237     if ($path && ($path != '/')) {
 238         $cookiepath = '/' . $path . '/';
 239     } else {
 240         $cookiepath = '/';
 241     }
 242     return setcookie($key,
 243                      $value,
 244                      $expiration,
 245                      $cookiepath,
 246                      $server);
 247 }
 248
 249 define('REMEMBERME', 'rememberme');
 250 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
 251
 252 function common_rememberme($user=null)
 253 {
 254     if (!$user) {
 255         $user = common_current_user();
 256         if (!$user) {
 257             return false;
 258         }
 259     }
 260
 261     $rm = new Remember_me();
 262
 263     $rm->code = common_good_rand(16);
 264     $rm->user_id = $user->id;
 265
 266     // Wrap the insert in some good ol' fashioned transaction code
 267
 268     $rm->query('BEGIN');
 269
 270     $result = $rm->insert();
 271
 272     if (!$result) {
 273         common_log_db_error($rm, 'INSERT', __FILE__);
 274         return false;
 275     }
 276
 277     $rm->query('COMMIT');
 278
 279     $cookieval = $rm->user_id . ':' . $rm->code;
 280
 281     common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
 282
 283     common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
 284
 285     return true;
 286 }
 287
 288 function common_remembered_user()
 289 {
 290
 291     $user = null;
 292
 293     $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
 294
 295     if (!$packed) {
 296         return null;
 297     }
 298
 299     list($id, $code) = explode(':', $packed);
 300
 301     if (!$id || !$code) {
 302         common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
 303         common_forgetme();
 304         return null;
 305     }
 306
 307     $rm = Remember_me::staticGet($code);
 308
 309     if (!$rm) {
 310         common_log(LOG_WARNING, 'No such remember code: ' . $code);
 311         common_forgetme();
 312         return null;
 313     }
 314
 315     if ($rm->user_id != $id) {
 316         common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
 317         common_forgetme();
 318         return null;
 319     }
 320
 321     $user = User::staticGet($rm->user_id);
 322
 323     if (!$user) {
 324         common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
 325         common_forgetme();
 326         return null;
 327     }
 328
 329     // successful!
 330     $result = $rm->delete();
 331
 332     if (!$result) {
 333         common_log_db_error($rm, 'DELETE', __FILE__);
 334         common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
 335         common_forgetme();
 336         return null;
 337     }
 338
 339     common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
 340
 341     common_set_user($user);
 342     common_real_login(false);
 343
 344     // We issue a new cookie, so they can log in
 345     // automatically again after this session
 346
 347     common_rememberme($user);
 348
 349     return $user;
 350 }
 351
 352 // must be called with a valid user!
 353
 354 function common_forgetme()
 355 {
 356     common_set_cookie(REMEMBERME, '', 0);
 357 }
 358
 359 // who is the current user?
 360 function common_current_user()
 361 {
 362     global $_cur;
 363
 364     if (!_have_config()) {
 365         return null;
 366     }
 367
 368     if ($_cur === false) {
 369
 370         if (isset($_REQUEST[session_name()]) || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
 371             common_ensure_session();
 372             $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
 373             if ($id) {
 374                 $user = User::staticGet($id);
 375                 if ($user) {
 376                         $_cur = $user;
 377                         return $_cur;
 378                 }
 379             }
 380         }
 381
 382         // that didn't work; try to remember; will init $_cur to null on failure
 383         $_cur = common_remembered_user();
 384
 385         if ($_cur) {
 386             // XXX: Is this necessary?
 387             $_SESSION['userid'] = $_cur->id;
 388         }
 389     }
 390
 391     return $_cur;
 392 }
 393
 394 // Logins that are 'remembered' aren't 'real' -- they're subject to
 395 // cookie-stealing. So, we don't let them do certain things. New reg,
 396 // OpenID, and password logins _are_ real.
 397
 398 function common_real_login($real=true)
 399 {
 400     common_ensure_session();
 401     $_SESSION['real_login'] = $real;
 402 }
 403
 404 function common_is_real_login()
 405 {
 406     return common_logged_in() && $_SESSION['real_login'];
 407 }
 408
 409 // get canonical version of nickname for comparison
 410 function common_canonical_nickname($nickname)
 411 {
 412     // XXX: UTF-8 canonicalization (like combining chars)
 413     return strtolower($nickname);
 414 }
 415
 416 // get canonical version of email for comparison
 417 function common_canonical_email($email)
 418 {
 419     // XXX: canonicalize UTF-8
 420     // XXX: lcase the domain part
 421     return $email;
 422 }
 423
 424 function common_render_content($text, $notice)
 425 {
 426     $r = common_render_text($text);
 427     $id = $notice->profile_id;
 428     $r = preg_replace('/(^|\s+)@(['.NICKNAME_FMT.']{1,64})/e', "'\\1@'.common_at_link($id, '\\2')", $r);
 429     $r = preg_replace('/^T ([A-Z0-9]{1,64}) /e', "'T '.common_at_link($id, '\\1').' '", $r);
 430     $r = preg_replace('/(^|[\s\.\,\:\;]+)@#([A-Za-z0-9]{1,64})/e', "'\\1@#'.common_at_hash_link($id, '\\2')", $r);
 431     $r = preg_replace('/(^|[\s\.\,\:\;]+)!([A-Za-z0-9]{1,64})/e', "'\\1!'.common_group_link($id, '\\2')", $r);
 432     return $r;
 433 }
 434
 435 function common_render_text($text)
 436 {
 437     $r = htmlspecialchars($text);
 438
 439     $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
 440     $r = common_replace_urls_callback($r, 'common_linkify');
 441     $r = preg_replace('/(^|\&quot\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/e', "'\\1#'.common_tag_link('\\2')", $r);
 442     // XXX: machine tags
 443     return $r;
 444 }
 445
 446 function common_replace_urls_callback($text, $callback, $notice_id = null) {
 447     // Start off with a regex
 448     $regex = '#'.
 449     '(?:^|[\s\<\>\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
 450     '('.
 451         '(?:'.
 452             '(?:'. //Known protocols
 453                 '(?:'.
 454                     '(?:(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|irc)://)'.
 455                     '|'.
 456                     '(?:(?:mailto|aim|tel|xmpp):)'.
 457                 ')'.
 458                 '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
 459                 '(?:'.
 460                     '(?:'.
 461                         '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
 462                     ')|(?:'.
 463                         '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
 464                     ')'.
 465                 ')'.
 466             ')'.
 467             '|(?:(?: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
 468             '|(?:'. //IPv6
 469                 '\[?(?:(?:(?:[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})))\]?(?<!:)'.
 470             ')|(?:'. //DNS
 471                 '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
 472                 '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
 473                 //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
 474                 '(?: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)'.
 475             ')(?![\pN\pL\-\_])'.
 476         ')'.
 477         '(?:'.
 478             '(?:\:\d+)?'. //:port
 479             '(?:/[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@]*)?'. // /path
 480             '(?:\?[\pN\pL\$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@\/]*)?'. // ?query string
 481             '(?:\#[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\@/\?\#]*)?'. // #fragment
 482         ')(?<![\?\.\,\#\,])'.
 483     ')'.
 484     '#ixu';
 485     //preg_match_all($regex,$text,$matches);
 486     //print_r($matches);
 487     return preg_replace_callback($regex, curry('callback_helper',$callback,$notice_id) ,$text);
 488 }
 489
 490 function callback_helper($matches, $callback, $notice_id) {
 491     $url=$matches[1];
 492     $left = strpos($matches[0],$url);
 493     $right = $left+strlen($url);
 494
 495     $groupSymbolSets=array(
 496         array(
 497             'left'=>'(',
 498             'right'=>')'
 499         ),
 500         array(
 501             'left'=>'[',
 502             'right'=>']'
 503         ),
 504         array(
 505             'left'=>'{',
 506             'right'=>'}'
 507         ),
 508         array(
 509             'left'=>'<',
 510             'right'=>'>'
 511         )
 512     );
 513     $cannotEndWith=array('.','?',',','#');
 514     $original_url=$url;
 515     do{
 516         $original_url=$url;
 517         foreach($groupSymbolSets as $groupSymbolSet){
 518             if(substr($url,-1)==$groupSymbolSet['right']){
 519                 $group_left_count = substr_count($url,$groupSymbolSet['left']);
 520                 $group_right_count = substr_count($url,$groupSymbolSet['right']);
 521                 if($group_left_count<$group_right_count){
 522                     $right-=1;
 523                     $url=substr($url,0,-1);
 524                 }
 525             }
 526         }
 527         if(in_array(substr($url,-1),$cannotEndWith)){
 528             $right-=1;
 529             $url=substr($url,0,-1);
 530         }
 531     }while($original_url!=$url);
 532
 533     if(empty($notice_id)){
 534         $result = call_user_func_array($callback, array($url));
 535     }else{
 536         $result = call_user_func_array($callback, array(array($url,$notice_id)) );
 537     }
 538     return substr($matches[0],0,$left) . $result . substr($matches[0],$right);
 539 }
 540
 541 if (version_compare(PHP_VERSION, '5.3.0', 'ge')) {
 542     // lambda implementation in a separate file; PHP 5.2 won't parse it.
 543     require_once INSTALLDIR . "/lib/curry.php";
 544 } else {
 545     function curry($fn) {
 546         $args = func_get_args();
 547         array_shift($args);
 548         $id = uniqid('_partial');
 549         $GLOBALS[$id] = array($fn, $args);
 550         return create_function('',
 551                                '$args = func_get_args(); '.
 552                                'return call_user_func_array('.
 553                                '$GLOBALS["'.$id.'"][0],'.
 554                                'array_merge('.
 555                                '$args,'.
 556                                '$GLOBALS["'.$id.'"][1]));');
 557     }
 558 }
 559
 560 function common_linkify($url) {
 561     // It comes in special'd, so we unspecial it before passing to the stringifying
 562     // functions
 563     $url = htmlspecialchars_decode($url);
 564
 565    if(strpos($url, '@') !== false && strpos($url, ':') === false) {
 566        //url is an email address without the mailto: protocol
 567        $canon = "mailto:$url";
 568        $longurl = "mailto:$url";
 569    }else{
 570
 571         $canon = File_redirection::_canonUrl($url);
 572
 573         $longurl_data = File_redirection::where($canon);
 574         if (is_array($longurl_data)) {
 575             $longurl = $longurl_data['url'];
 576         } elseif (is_string($longurl_data)) {
 577             $longurl = $longurl_data;
 578         } else {
 579             throw new ServerException("Can't linkify url '$url'");
 580         }
 581     }
 582     $attrs = array('href' => $canon, 'title' => $longurl, 'rel' => 'external');
 583
 584     $is_attachment = false;
 585     $attachment_id = null;
 586     $has_thumb = false;
 587
 588     // Check to see whether this is a known "attachment" URL.
 589
 590     $f = File::staticGet('url', $longurl);
 591
 592     if (empty($f)) {
 593         // XXX: this writes to the database. :<
 594         $f = File::processNew($longurl);
 595     }
 596
 597     if (!empty($f)) {
 598         if ($f->isEnclosure()) {
 599             $is_attachment = true;
 600             $attachment_id = $f->id;
 601         } else {
 602             $foe = File_oembed::staticGet('file_id', $f->id);
 603             if (!empty($foe)) {
 604                 // if it has OEmbed info, it's an attachment, too
 605                 $is_attachment = true;
 606                 $attachment_id = $f->id;
 607
 608                 $thumb = File_thumbnail::staticGet('file_id', $f->id);
 609                 if (!empty($thumb)) {
 610                     $has_thumb = true;
 611                 }
 612             }
 613         }
 614     }
 615
 616     // Add clippy
 617     if ($is_attachment) {
 618         $attrs['class'] = 'attachment';
 619         if ($has_thumb) {
 620             $attrs['class'] = 'attachment thumbnail';
 621         }
 622         $attrs['id'] = "attachment-{$attachment_id}";
 623     }
 624
 625     return XMLStringer::estring('a', $attrs, $url);
 626 }
 627
 628 function common_shorten_links($text)
 629 {
 630     $maxLength = Notice::maxContent();
 631     if ($maxLength == 0 || mb_strlen($text) <= $maxLength) return $text;
 632     return common_replace_urls_callback($text, array('File_redirection', 'makeShort'));
 633 }
 634
 635 function common_xml_safe_str($str)
 636 {
 637     // Neutralize control codes and surrogates
 638         return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
 639 }
 640
 641 function common_tag_link($tag)
 642 {
 643     $canonical = common_canonical_tag($tag);
 644     $url = common_local_url('tag', array('tag' => $canonical));
 645     $xs = new XMLStringer();
 646     $xs->elementStart('span', 'tag');
 647     $xs->element('a', array('href' => $url,
 648                             'rel' => 'tag'),
 649                  $tag);
 650     $xs->elementEnd('span');
 651     return $xs->getString();
 652 }
 653
 654 function common_canonical_tag($tag)
 655 {
 656   $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
 657   return str_replace(array('-', '_', '.'), '', $tag);
 658 }
 659
 660 function common_valid_profile_tag($str)
 661 {
 662     return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
 663 }
 664
 665 function common_at_link($sender_id, $nickname)
 666 {
 667     $sender = Profile::staticGet($sender_id);
 668     if (!$sender) {
 669         return $nickname;
 670     }
 671     $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
 672     if ($recipient) {
 673         $user = User::staticGet('id', $recipient->id);
 674         if ($user) {
 675             $url = common_local_url('userbyid', array('id' => $user->id));
 676         } else {
 677             $url = $recipient->profileurl;
 678         }
 679         $xs = new XMLStringer(false);
 680         $attrs = array('href' => $url,
 681                        'class' => 'url');
 682         if (!empty($recipient->fullname)) {
 683             $attrs['title'] = $recipient->fullname . ' (' . $recipient->nickname . ')';
 684         }
 685         $xs->elementStart('span', 'vcard');
 686         $xs->elementStart('a', $attrs);
 687         $xs->element('span', 'fn nickname', $nickname);
 688         $xs->elementEnd('a');
 689         $xs->elementEnd('span');
 690         return $xs->getString();
 691     } else {
 692         return $nickname;
 693     }
 694 }
 695
 696 function common_group_link($sender_id, $nickname)
 697 {
 698     $sender = Profile::staticGet($sender_id);
 699     $group = User_group::getForNickname($nickname);
 700     if ($group && $sender->isMember($group)) {
 701         $attrs = array('href' => $group->permalink(),
 702                        'class' => 'url');
 703         if (!empty($group->fullname)) {
 704             $attrs['title'] = $group->fullname . ' (' . $group->nickname . ')';
 705         }
 706         $xs = new XMLStringer();
 707         $xs->elementStart('span', 'vcard');
 708         $xs->elementStart('a', $attrs);
 709         $xs->element('span', 'fn nickname', $nickname);
 710         $xs->elementEnd('a');
 711         $xs->elementEnd('span');
 712         return $xs->getString();
 713     } else {
 714         return $nickname;
 715     }
 716 }
 717
 718 function common_at_hash_link($sender_id, $tag)
 719 {
 720     $user = User::staticGet($sender_id);
 721     if (!$user) {
 722         return $tag;
 723     }
 724     $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
 725     if ($tagged) {
 726         $url = common_local_url('subscriptions',
 727                                 array('nickname' => $user->nickname,
 728                                       'tag' => $tag));
 729         $xs = new XMLStringer();
 730         $xs->elementStart('span', 'tag');
 731         $xs->element('a', array('href' => $url,
 732                                 'rel' => $tag),
 733                      $tag);
 734         $xs->elementEnd('span');
 735         return $xs->getString();
 736     } else {
 737         return $tag;
 738     }
 739 }
 740
 741 function common_relative_profile($sender, $nickname, $dt=null)
 742 {
 743     // Try to find profiles this profile is subscribed to that have this nickname
 744     $recipient = new Profile();
 745     // XXX: use a join instead of a subquery
 746     $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
 747     $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
 748     if ($recipient->find(true)) {
 749         // XXX: should probably differentiate between profiles with
 750         // the same name by date of most recent update
 751         return $recipient;
 752     }
 753     // Try to find profiles that listen to this profile and that have this nickname
 754     $recipient = new Profile();
 755     // XXX: use a join instead of a subquery
 756     $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
 757     $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
 758     if ($recipient->find(true)) {
 759         // XXX: should probably differentiate between profiles with
 760         // the same name by date of most recent update
 761         return $recipient;
 762     }
 763     // If this is a local user, try to find a local user with that nickname.
 764     $sender = User::staticGet($sender->id);
 765     if ($sender) {
 766         $recipient_user = User::staticGet('nickname', $nickname);
 767         if ($recipient_user) {
 768             return $recipient_user->getProfile();
 769         }
 770     }
 771     // Otherwise, no links. @messages from local users to remote users,
 772     // or from remote users to other remote users, are just
 773     // outside our ability to make intelligent guesses about
 774     return null;
 775 }
 776
 777 function common_local_url($action, $args=null, $params=null, $fragment=null)
 778 {
 779     $r = Router::get();
 780     $path = $r->build($action, $args, $params, $fragment);
 781
 782     $ssl = common_is_sensitive($action);
 783
 784     if (common_config('site','fancy')) {
 785         $url = common_path(mb_substr($path, 1), $ssl);
 786     } else {
 787         if (mb_strpos($path, '/index.php') === 0) {
 788             $url = common_path(mb_substr($path, 1), $ssl);
 789         } else {
 790             $url = common_path('index.php'.$path, $ssl);
 791         }
 792     }
 793     return $url;
 794 }
 795
 796 function common_is_sensitive($action)
 797 {
 798     static $sensitive = array('login', 'register', 'passwordsettings',
 799                               'twittersettings', 'api');
 800     $ssl = null;
 801
 802     if (Event::handle('SensitiveAction', array($action, &$ssl))) {
 803         $ssl = in_array($action, $sensitive);
 804     }
 805
 806     return $ssl;
 807 }
 808
 809 function common_path($relative, $ssl=false)
 810 {
 811     $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
 812
 813     if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
 814         || common_config('site', 'ssl') === 'always') {
 815         $proto = 'https';
 816         if (is_string(common_config('site', 'sslserver')) &&
 817             mb_strlen(common_config('site', 'sslserver')) > 0) {
 818             $serverpart = common_config('site', 'sslserver');
 819         } else if (common_config('site', 'server')) {
 820             $serverpart = common_config('site', 'server');
 821         } else {
 822             common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
 823         }
 824     } else {
 825         $proto = 'http';
 826         if (common_config('site', 'server')) {
 827             $serverpart = common_config('site', 'server');
 828         } else {
 829             common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
 830         }
 831     }
 832
 833     $relative = common_inject_session($relative, $serverpart);
 834
 835     return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
 836 }
 837
 838 function common_inject_session($url, $serverpart = null)
 839 {
 840     if (common_have_session()) {
 841
 842         if (empty($serverpart)) {
 843             $serverpart = parse_url($url, PHP_URL_HOST);
 844         }
 845
 846         $currentServer = $_SERVER['HTTP_HOST'];
 847
 848         // Are we pointing to another server (like an SSL server?)
 849
 850         if (!empty($currentServer) &&
 851             0 != strcasecmp($currentServer, $serverpart)) {
 852             // Pass the session ID as a GET parameter
 853             $sesspart = session_name() . '=' . session_id();
 854             $i = strpos($url, '?');
 855             if ($i === false) { // no GET params, just append
 856                 $url .= '?' . $sesspart;
 857             } else {
 858                 $url = substr($url, 0, $i + 1).$sesspart.'&'.substr($url, $i + 1);
 859             }
 860         }
 861     }
 862
 863     return $url;
 864 }
 865
 866 function common_date_string($dt)
 867 {
 868     // XXX: do some sexy date formatting
 869     // return date(DATE_RFC822, $dt);
 870     $t = strtotime($dt);
 871     $now = time();
 872     $diff = $now - $t;
 873
 874     if ($now < $t) { // that shouldn't happen!
 875         return common_exact_date($dt);
 876     } else if ($diff < 60) {
 877         return _('a few seconds ago');
 878     } else if ($diff < 92) {
 879         return _('about a minute ago');
 880     } else if ($diff < 3300) {
 881         return sprintf(_('about %d minutes ago'), round($diff/60));
 882     } else if ($diff < 5400) {
 883         return _('about an hour ago');
 884     } else if ($diff < 22 * 3600) {
 885         return sprintf(_('about %d hours ago'), round($diff/3600));
 886     } else if ($diff < 37 * 3600) {
 887         return _('about a day ago');
 888     } else if ($diff < 24 * 24 * 3600) {
 889         return sprintf(_('about %d days ago'), round($diff/(24*3600)));
 890     } else if ($diff < 46 * 24 * 3600) {
 891         return _('about a month ago');
 892     } else if ($diff < 330 * 24 * 3600) {
 893         return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
 894     } else if ($diff < 480 * 24 * 3600) {
 895         return _('about a year ago');
 896     } else {
 897         return common_exact_date($dt);
 898     }
 899 }
 900
 901 function common_exact_date($dt)
 902 {
 903     static $_utc;
 904     static $_siteTz;
 905
 906     if (!$_utc) {
 907         $_utc = new DateTimeZone('UTC');
 908         $_siteTz = new DateTimeZone(common_timezone());
 909     }
 910
 911     $dateStr = date('d F Y H:i:s', strtotime($dt));
 912     $d = new DateTime($dateStr, $_utc);
 913     $d->setTimezone($_siteTz);
 914     return $d->format(DATE_RFC850);
 915 }
 916
 917 function common_date_w3dtf($dt)
 918 {
 919     $dateStr = date('d F Y H:i:s', strtotime($dt));
 920     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 921     $d->setTimezone(new DateTimeZone(common_timezone()));
 922     return $d->format(DATE_W3C);
 923 }
 924
 925 function common_date_rfc2822($dt)
 926 {
 927     $dateStr = date('d F Y H:i:s', strtotime($dt));
 928     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 929     $d->setTimezone(new DateTimeZone(common_timezone()));
 930     return $d->format('r');
 931 }
 932
 933 function common_date_iso8601($dt)
 934 {
 935     $dateStr = date('d F Y H:i:s', strtotime($dt));
 936     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 937     $d->setTimezone(new DateTimeZone(common_timezone()));
 938     return $d->format('c');
 939 }
 940
 941 function common_sql_now()
 942 {
 943     return common_sql_date(time());
 944 }
 945
 946 function common_sql_date($datetime)
 947 {
 948     return strftime('%Y-%m-%d %H:%M:%S', $datetime);
 949 }
 950
 951 /**
 952  * Return an SQL fragment to calculate an age-based weight from a given
 953  * timestamp or datetime column.
 954  *
 955  * @param string $column name of field we're comparing against current time
 956  * @param integer $dropoff divisor for age in seconds before exponentiation
 957  * @return string SQL fragment
 958  */
 959 function common_sql_weight($column, $dropoff)
 960 {
 961     if (common_config('db', 'type') == 'pgsql') {
 962         // PostgreSQL doesn't support timestampdiff function.
 963         // @fixme will this use the right time zone?
 964         // @fixme does this handle cross-year subtraction correctly?
 965         return "sum(exp(-extract(epoch from (now() - $column)) / $dropoff))";
 966     } else {
 967         return "sum(exp(timestampdiff(second, utc_timestamp(), $column) / $dropoff))";
 968     }
 969 }
 970
 971 function common_redirect($url, $code=307)
 972 {
 973     static $status = array(301 => "Moved Permanently",
 974                            302 => "Found",
 975                            303 => "See Other",
 976                            307 => "Temporary Redirect");
 977
 978     header('HTTP/1.1 '.$code.' '.$status[$code]);
 979     header("Location: $url");
 980
 981     $xo = new XMLOutputter();
 982     $xo->startXML('a',
 983                   '-//W3C//DTD XHTML 1.0 Strict//EN',
 984                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
 985     $xo->element('a', array('href' => $url), $url);
 986     $xo->endXML();
 987     exit;
 988 }
 989
 990 function common_broadcast_notice($notice, $remote=false)
 991 {
 992     // DO NOTHING!
 993 }
 994
 995 // Stick the notice on the queue
 996
 997 function common_enqueue_notice($notice)
 998 {
 999     static $localTransports = array('omb',
1000                                     'ping');
1001
1002     $transports = array();
1003     if (common_config('sms', 'enabled')) {
1004         $transports[] = 'sms';
1005     }
1006     if (Event::hasHandler('HandleQueuedNotice')) {
1007         $transports[] = 'plugin';
1008     }
1009
1010
1011     $xmpp = common_config('xmpp', 'enabled');
1012
1013     if ($xmpp) {
1014         $transports[] = 'jabber';
1015     }
1016
1017     // @fixme move these checks into QueueManager and/or individual handlers
1018     if ($notice->is_local == Notice::LOCAL_PUBLIC ||
1019         $notice->is_local == Notice::LOCAL_NONPUBLIC) {
1020         $transports = array_merge($transports, $localTransports);
1021         if ($xmpp) {
1022             $transports[] = 'public';
1023         }
1024     }
1025
1026     if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
1027
1028         $qm = QueueManager::get();
1029
1030         foreach ($transports as $transport)
1031         {
1032             $qm->enqueue($notice, $transport);
1033         }
1034
1035         Event::handle('EndEnqueueNotice', array($notice, $transports));
1036     }
1037
1038     return true;
1039 }
1040
1041 function common_broadcast_profile($profile)
1042 {
1043     // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
1044     require_once(INSTALLDIR.'/lib/omb.php');
1045     omb_broadcast_profile($profile);
1046     // XXX: Other broadcasts...?
1047     return true;
1048 }
1049
1050 function common_profile_url($nickname)
1051 {
1052     return common_local_url('showstream', array('nickname' => $nickname));
1053 }
1054
1055 // Should make up a reasonable root URL
1056
1057 function common_root_url($ssl=false)
1058 {
1059     $url = common_path('', $ssl);
1060     $i = strpos($url, '?');
1061     if ($i !== false) {
1062         $url = substr($url, 0, $i);
1063     }
1064     return $url;
1065 }
1066
1067 // returns $bytes bytes of random data as a hexadecimal string
1068 // "good" here is a goal and not a guarantee
1069
1070 function common_good_rand($bytes)
1071 {
1072     // XXX: use random.org...?
1073     if (@file_exists('/dev/urandom')) {
1074         return common_urandom($bytes);
1075     } else { // FIXME: this is probably not good enough
1076         return common_mtrand($bytes);
1077     }
1078 }
1079
1080 function common_urandom($bytes)
1081 {
1082     $h = fopen('/dev/urandom', 'rb');
1083     // should not block
1084     $src = fread($h, $bytes);
1085     fclose($h);
1086     $enc = '';
1087     for ($i = 0; $i < $bytes; $i++) {
1088         $enc .= sprintf("%02x", (ord($src[$i])));
1089     }
1090     return $enc;
1091 }
1092
1093 function common_mtrand($bytes)
1094 {
1095     $enc = '';
1096     for ($i = 0; $i < $bytes; $i++) {
1097         $enc .= sprintf("%02x", mt_rand(0, 255));
1098     }
1099     return $enc;
1100 }
1101
1102 function common_set_returnto($url)
1103 {
1104     common_ensure_session();
1105     $_SESSION['returnto'] = $url;
1106 }
1107
1108 function common_get_returnto()
1109 {
1110     common_ensure_session();
1111     return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
1112 }
1113
1114 function common_timestamp()
1115 {
1116     return date('YmdHis');
1117 }
1118
1119 function common_ensure_syslog()
1120 {
1121     static $initialized = false;
1122     if (!$initialized) {
1123         openlog(common_config('syslog', 'appname'), 0,
1124             common_config('syslog', 'facility'));
1125         $initialized = true;
1126     }
1127 }
1128
1129 function common_log_line($priority, $msg)
1130 {
1131     static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1132                                       'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1133     return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
1134 }
1135
1136 function common_request_id()
1137 {
1138     $pid = getmypid();
1139     $server = common_config('site', 'server');
1140     if (php_sapi_name() == 'cli') {
1141         $script = basename($_SERVER['PHP_SELF']);
1142         return "$server:$script:$pid";
1143     } else {
1144         static $req_id = null;
1145         if (!isset($req_id)) {
1146             $req_id = substr(md5(mt_rand()), 0, 8);
1147         }
1148         if (isset($_SERVER['REQUEST_URI'])) {
1149             $url = $_SERVER['REQUEST_URI'];
1150         }
1151         $method = $_SERVER['REQUEST_METHOD'];
1152         return "$server:$pid.$req_id $method $url";
1153     }
1154 }
1155
1156 function common_log($priority, $msg, $filename=null)
1157 {
1158     if(Event::handle('StartLog', array(&$priority, &$msg, &$filename))){
1159         $msg = '[' . common_request_id() . '] ' . $msg;
1160         $logfile = common_config('site', 'logfile');
1161         if ($logfile) {
1162             $log = fopen($logfile, "a");
1163             if ($log) {
1164                 $output = common_log_line($priority, $msg);
1165                 fwrite($log, $output);
1166                 fclose($log);
1167             }
1168         } else {
1169             common_ensure_syslog();
1170             syslog($priority, $msg);
1171         }
1172         Event::handle('EndLog', array($priority, $msg, $filename));
1173     }
1174 }
1175
1176 function common_debug($msg, $filename=null)
1177 {
1178     if ($filename) {
1179         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1180     } else {
1181         common_log(LOG_DEBUG, $msg);
1182     }
1183 }
1184
1185 function common_log_db_error(&$object, $verb, $filename=null)
1186 {
1187     $objstr = common_log_objstring($object);
1188     $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1189     common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1190 }
1191
1192 function common_log_objstring(&$object)
1193 {
1194     if (is_null($object)) {
1195         return "null";
1196     }
1197     if (!($object instanceof DB_DataObject)) {
1198         return "(unknown)";
1199     }
1200     $arr = $object->toArray();
1201     $fields = array();
1202     foreach ($arr as $k => $v) {
1203         if (is_object($v)) {
1204             $fields[] = "$k='".get_class($v)."'";
1205         } else {
1206             $fields[] = "$k='$v'";
1207         }
1208     }
1209     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1210     return $objstring;
1211 }
1212
1213 function common_valid_http_url($url)
1214 {
1215     return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1216 }
1217
1218 function common_valid_tag($tag)
1219 {
1220     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1221         return (Validate::email($matches[1]) ||
1222                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1223     }
1224     return false;
1225 }
1226
1227 /* Following functions are copied from MediaWiki GlobalFunctions.php
1228  * and written by Evan Prodromou. */
1229
1230 function common_accept_to_prefs($accept, $def = '*/*')
1231 {
1232     // No arg means accept anything (per HTTP spec)
1233     if(!$accept) {
1234         return array($def => 1);
1235     }
1236
1237     $prefs = array();
1238
1239     $parts = explode(',', $accept);
1240
1241     foreach($parts as $part) {
1242         // FIXME: doesn't deal with params like 'text/html; level=1'
1243         @list($value, $qpart) = explode(';', trim($part));
1244         $match = array();
1245         if(!isset($qpart)) {
1246             $prefs[$value] = 1;
1247         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1248             $prefs[$value] = $match[1];
1249         }
1250     }
1251
1252     return $prefs;
1253 }
1254
1255 function common_mime_type_match($type, $avail)
1256 {
1257     if(array_key_exists($type, $avail)) {
1258         return $type;
1259     } else {
1260         $parts = explode('/', $type);
1261         if(array_key_exists($parts[0] . '/*', $avail)) {
1262             return $parts[0] . '/*';
1263         } elseif(array_key_exists('*/*', $avail)) {
1264             return '*/*';
1265         } else {
1266             return null;
1267         }
1268     }
1269 }
1270
1271 function common_negotiate_type($cprefs, $sprefs)
1272 {
1273     $combine = array();
1274
1275     foreach(array_keys($sprefs) as $type) {
1276         $parts = explode('/', $type);
1277         if($parts[1] != '*') {
1278             $ckey = common_mime_type_match($type, $cprefs);
1279             if($ckey) {
1280                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1281             }
1282         }
1283     }
1284
1285     foreach(array_keys($cprefs) as $type) {
1286         $parts = explode('/', $type);
1287         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1288             $skey = common_mime_type_match($type, $sprefs);
1289             if($skey) {
1290                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1291             }
1292         }
1293     }
1294
1295     $bestq = 0;
1296     $besttype = 'text/html';
1297
1298     foreach(array_keys($combine) as $type) {
1299         if($combine[$type] > $bestq) {
1300             $besttype = $type;
1301             $bestq = $combine[$type];
1302         }
1303     }
1304
1305     if ('text/html' === $besttype) {
1306         return "text/html; charset=utf-8";
1307     }
1308     return $besttype;
1309 }
1310
1311 function common_config($main, $sub)
1312 {
1313     global $config;
1314     return (array_key_exists($main, $config) &&
1315             array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
1316 }
1317
1318 function common_copy_args($from)
1319 {
1320     $to = array();
1321     $strip = get_magic_quotes_gpc();
1322     foreach ($from as $k => $v) {
1323         $to[$k] = ($strip) ? stripslashes($v) : $v;
1324     }
1325     return $to;
1326 }
1327
1328 /**
1329  * Neutralise the evil effects of magic_quotes_gpc in the current request.
1330  * This is used before handing a request off to OAuthRequest::from_request.
1331  * @fixme Doesn't consider vars other than _POST and _GET?
1332  * @fixme Can't be undone and could corrupt data if run twice.
1333  */
1334 function common_remove_magic_from_request()
1335 {
1336     if(get_magic_quotes_gpc()) {
1337         $_POST=array_map('stripslashes',$_POST);
1338         $_GET=array_map('stripslashes',$_GET);
1339     }
1340 }
1341
1342 function common_user_uri(&$user)
1343 {
1344     return common_local_url('userbyid', array('id' => $user->id));
1345 }
1346
1347 function common_notice_uri(&$notice)
1348 {
1349     return common_local_url('shownotice',
1350                             array('notice' => $notice->id));
1351 }
1352
1353 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1354
1355 function common_confirmation_code($bits)
1356 {
1357     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1358     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1359     $chars = ceil($bits/5);
1360     $code = '';
1361     for ($i = 0; $i < $chars; $i++) {
1362         // XXX: convert to string and back
1363         $num = hexdec(common_good_rand(1));
1364         // XXX: randomness is too precious to throw away almost
1365         // 40% of the bits we get!
1366         $code .= $codechars[$num%32];
1367     }
1368     return $code;
1369 }
1370
1371 // convert markup to HTML
1372
1373 function common_markup_to_html($c)
1374 {
1375     $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1376     $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1377     $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1378     return Markdown($c);
1379 }
1380
1381 function common_profile_uri($profile)
1382 {
1383     if (!$profile) {
1384         return null;
1385     }
1386     $user = User::staticGet($profile->id);
1387     if ($user) {
1388         return $user->uri;
1389     }
1390
1391     $remote = Remote_profile::staticGet($profile->id);
1392     if ($remote) {
1393         return $remote->uri;
1394     }
1395     // XXX: this is a very bad profile!
1396     return null;
1397 }
1398
1399 function common_canonical_sms($sms)
1400 {
1401     // strip non-digits
1402     preg_replace('/\D/', '', $sms);
1403     return $sms;
1404 }
1405
1406 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1407 {
1408     switch ($errno) {
1409
1410      case E_ERROR:
1411      case E_COMPILE_ERROR:
1412      case E_CORE_ERROR:
1413      case E_USER_ERROR:
1414      case E_PARSE:
1415      case E_RECOVERABLE_ERROR:
1416         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
1417         die();
1418         break;
1419
1420      case E_WARNING:
1421      case E_COMPILE_WARNING:
1422      case E_CORE_WARNING:
1423      case E_USER_WARNING:
1424         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1425         break;
1426
1427      case E_NOTICE:
1428      case E_USER_NOTICE:
1429         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1430         break;
1431
1432      case E_STRICT:
1433      case E_DEPRECATED:
1434      case E_USER_DEPRECATED:
1435         // XXX: config variable to log this stuff, too
1436         break;
1437
1438      default:
1439         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
1440         die();
1441         break;
1442     }
1443
1444     // FIXME: show error page if we're on the Web
1445     /* Don't execute PHP internal error handler */
1446     return true;
1447 }
1448
1449 function common_session_token()
1450 {
1451     common_ensure_session();
1452     if (!array_key_exists('token', $_SESSION)) {
1453         $_SESSION['token'] = common_good_rand(64);
1454     }
1455     return $_SESSION['token'];
1456 }
1457
1458 function common_cache_key($extra)
1459 {
1460     return Cache::key($extra);
1461 }
1462
1463 function common_keyize($str)
1464 {
1465     return Cache::keyize($str);
1466 }
1467
1468 function common_memcache()
1469 {
1470     return Cache::instance();
1471 }
1472
1473 function common_license_terms($uri)
1474 {
1475     if(preg_match('/creativecommons.org\/licenses\/([^\/]+)/', $uri, $matches)) {
1476         return explode('-',$matches[1]);
1477     }
1478     return array($uri);
1479 }
1480
1481 function common_compatible_license($from, $to)
1482 {
1483     $from_terms = common_license_terms($from);
1484     // public domain and cc-by are compatible with everything
1485     if(count($from_terms) == 1 && ($from_terms[0] == 'publicdomain' || $from_terms[0] == 'by')) {
1486         return true;
1487     }
1488     $to_terms = common_license_terms($to);
1489     // sa is compatible across versions. IANAL
1490     if(in_array('sa',$from_terms) || in_array('sa',$to_terms)) {
1491         return count(array_diff($from_terms, $to_terms)) == 0;
1492     }
1493     // XXX: better compatibility check needed here!
1494     // Should at least normalise URIs
1495     return ($from == $to);
1496 }
1497
1498 /**
1499  * returns a quoted table name, if required according to config
1500  */
1501 function common_database_tablename($tablename)
1502 {
1503
1504   if(common_config('db','quote_identifiers')) {
1505       $tablename = '"'. $tablename .'"';
1506   }
1507   //table prefixes could be added here later
1508   return $tablename;
1509 }
1510
1511 /**
1512  * Shorten a URL with the current user's configured shortening service,
1513  * or ur1.ca if configured, or not at all if no shortening is set up.
1514  * Length is not considered.
1515  *
1516  * @param string $long_url
1517  * @return string may return the original URL if shortening failed
1518  *
1519  * @fixme provide a way to specify a particular shortener
1520  * @fixme provide a way to specify to use a given user's shortening preferences
1521  */
1522 function common_shorten_url($long_url)
1523 {
1524     $user = common_current_user();
1525     if (empty($user)) {
1526         // common current user does not find a user when called from the XMPP daemon
1527         // therefore we'll set one here fix, so that XMPP given URLs may be shortened
1528         $shortenerName = 'ur1.ca';
1529     } else {
1530         $shortenerName = $user->urlshorteningservice;
1531     }
1532
1533     if(Event::handle('StartShortenUrl', array($long_url,$shortenerName,&$shortenedUrl))){
1534         //URL wasn't shortened, so return the long url
1535         return $long_url;
1536     }else{
1537         //URL was shortened, so return the result
1538         return $shortenedUrl;
1539     }
1540 }
1541
1542 /**
1543  * @return mixed array($proxy, $ip) for web requests; proxy may be null
1544  *               null if not a web request
1545  *
1546  * @fixme X-Forwarded-For can be chained by multiple proxies;
1547           we should parse the list and provide a cleaner array
1548  * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
1549  * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
1550  *        use function to get exact request headers from Apache if possible.
1551  */
1552 function common_client_ip()
1553 {
1554     if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
1555         return null;
1556     }
1557
1558     if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
1559         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1560             $proxy = $_SERVER['HTTP_CLIENT_IP'];
1561         } else {
1562             $proxy = $_SERVER['REMOTE_ADDR'];
1563         }
1564         $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
1565     } else {
1566         $proxy = null;
1567         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1568             $ip = $_SERVER['HTTP_CLIENT_IP'];
1569         } else {
1570             $ip = $_SERVER['REMOTE_ADDR'];
1571         }
1572     }
1573
1574     return array($proxy, $ip);
1575 }