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($_COOKIE[session_name()]) || isset($_GET[session_name()])
 371             || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
 372             common_ensure_session();
 373             $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
 374             if ($id) {
 375                 $user = User::staticGet($id);
 376                 if ($user) {
 377                         $_cur = $user;
 378                         return $_cur;
 379                 }
 380             }
 381         }
 382
 383         // that didn't work; try to remember; will init $_cur to null on failure
 384         $_cur = common_remembered_user();
 385
 386         if ($_cur) {
 387             // XXX: Is this necessary?
 388             $_SESSION['userid'] = $_cur->id;
 389         }
 390     }
 391
 392     return $_cur;
 393 }
 394
 395 // Logins that are 'remembered' aren't 'real' -- they're subject to
 396 // cookie-stealing. So, we don't let them do certain things. New reg,
 397 // OpenID, and password logins _are_ real.
 398
 399 function common_real_login($real=true)
 400 {
 401     common_ensure_session();
 402     $_SESSION['real_login'] = $real;
 403 }
 404
 405 function common_is_real_login()
 406 {
 407     return common_logged_in() && $_SESSION['real_login'];
 408 }
 409
 410 // get canonical version of nickname for comparison
 411 function common_canonical_nickname($nickname)
 412 {
 413     // XXX: UTF-8 canonicalization (like combining chars)
 414     return strtolower($nickname);
 415 }
 416
 417 // get canonical version of email for comparison
 418 function common_canonical_email($email)
 419 {
 420     // XXX: canonicalize UTF-8
 421     // XXX: lcase the domain part
 422     return $email;
 423 }
 424
 425 function common_render_content($text, $notice)
 426 {
 427     $r = common_render_text($text);
 428     $id = $notice->profile_id;
 429     $r = preg_replace('/(^|\s+)@(['.NICKNAME_FMT.']{1,64})/e', "'\\1@'.common_at_link($id, '\\2')", $r);
 430     $r = preg_replace('/^T ([A-Z0-9]{1,64}) /e', "'T '.common_at_link($id, '\\1').' '", $r);
 431     $r = preg_replace('/(^|[\s\.\,\:\;]+)@#([A-Za-z0-9]{1,64})/e', "'\\1@#'.common_at_hash_link($id, '\\2')", $r);
 432     $r = preg_replace('/(^|[\s\.\,\:\;]+)!([A-Za-z0-9]{1,64})/e', "'\\1!'.common_group_link($id, '\\2')", $r);
 433     return $r;
 434 }
 435
 436 function common_render_text($text)
 437 {
 438     $r = htmlspecialchars($text);
 439
 440     $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
 441     $r = common_replace_urls_callback($r, 'common_linkify');
 442     $r = preg_replace('/(^|\&quot\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/e', "'\\1#'.common_tag_link('\\2')", $r);
 443     // XXX: machine tags
 444     return $r;
 445 }
 446
 447 function common_replace_urls_callback($text, $callback, $notice_id = null) {
 448     // Start off with a regex
 449     $regex = '#'.
 450     '(?:^|[\s\<\>\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
 451     '('.
 452         '(?:'.
 453             '(?:'. //Known protocols
 454                 '(?:'.
 455                     '(?:(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|irc)://)'.
 456                     '|'.
 457                     '(?:(?:mailto|aim|tel|xmpp):)'.
 458                 ')'.
 459                 '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
 460                 '(?:'.
 461                     '(?:'.
 462                         '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
 463                     ')|(?:'.
 464                         '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
 465                     ')'.
 466                 ')'.
 467             ')'.
 468             '|(?:(?: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
 469             '|(?:'. //IPv6
 470                 '\[?(?:(?:(?:[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})))\]?(?<!:)'.
 471             ')|(?:'. //DNS
 472                 '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
 473                 '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
 474                 //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
 475                 '(?: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)'.
 476             ')(?![\pN\pL\-\_])'.
 477         ')'.
 478         '(?:'.
 479             '(?:\:\d+)?'. //:port
 480             '(?:/[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@]*)?'. // /path
 481             '(?:\?[\pN\pL\$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@\/]*)?'. // ?query string
 482             '(?:\#[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\@/\?\#]*)?'. // #fragment
 483         ')(?<![\?\.\,\#\,])'.
 484     ')'.
 485     '#ixu';
 486     //preg_match_all($regex,$text,$matches);
 487     //print_r($matches);
 488     return preg_replace_callback($regex, curry('callback_helper',$callback,$notice_id) ,$text);
 489 }
 490
 491 function callback_helper($matches, $callback, $notice_id) {
 492     $url=$matches[1];
 493     $left = strpos($matches[0],$url);
 494     $right = $left+strlen($url);
 495
 496     $groupSymbolSets=array(
 497         array(
 498             'left'=>'(',
 499             'right'=>')'
 500         ),
 501         array(
 502             'left'=>'[',
 503             'right'=>']'
 504         ),
 505         array(
 506             'left'=>'{',
 507             'right'=>'}'
 508         ),
 509         array(
 510             'left'=>'<',
 511             'right'=>'>'
 512         )
 513     );
 514     $cannotEndWith=array('.','?',',','#');
 515     $original_url=$url;
 516     do{
 517         $original_url=$url;
 518         foreach($groupSymbolSets as $groupSymbolSet){
 519             if(substr($url,-1)==$groupSymbolSet['right']){
 520                 $group_left_count = substr_count($url,$groupSymbolSet['left']);
 521                 $group_right_count = substr_count($url,$groupSymbolSet['right']);
 522                 if($group_left_count<$group_right_count){
 523                     $right-=1;
 524                     $url=substr($url,0,-1);
 525                 }
 526             }
 527         }
 528         if(in_array(substr($url,-1),$cannotEndWith)){
 529             $right-=1;
 530             $url=substr($url,0,-1);
 531         }
 532     }while($original_url!=$url);
 533
 534     if(empty($notice_id)){
 535         $result = call_user_func_array($callback, array($url));
 536     }else{
 537         $result = call_user_func_array($callback, array(array($url,$notice_id)) );
 538     }
 539     return substr($matches[0],0,$left) . $result . substr($matches[0],$right);
 540 }
 541
 542 if (version_compare(PHP_VERSION, '5.3.0', 'ge')) {
 543     // lambda implementation in a separate file; PHP 5.2 won't parse it.
 544     require_once INSTALLDIR . "/lib/curry.php";
 545 } else {
 546     function curry($fn) {
 547         $args = func_get_args();
 548         array_shift($args);
 549         $id = uniqid('_partial');
 550         $GLOBALS[$id] = array($fn, $args);
 551         return create_function('',
 552                                '$args = func_get_args(); '.
 553                                'return call_user_func_array('.
 554                                '$GLOBALS["'.$id.'"][0],'.
 555                                'array_merge('.
 556                                '$args,'.
 557                                '$GLOBALS["'.$id.'"][1]));');
 558     }
 559 }
 560
 561 function common_linkify($url) {
 562     // It comes in special'd, so we unspecial it before passing to the stringifying
 563     // functions
 564     $url = htmlspecialchars_decode($url);
 565
 566    if(strpos($url, '@') !== false && strpos($url, ':') === false) {
 567        //url is an email address without the mailto: protocol
 568        $canon = "mailto:$url";
 569        $longurl = "mailto:$url";
 570    }else{
 571
 572         $canon = File_redirection::_canonUrl($url);
 573
 574         $longurl_data = File_redirection::where($canon);
 575         if (is_array($longurl_data)) {
 576             $longurl = $longurl_data['url'];
 577         } elseif (is_string($longurl_data)) {
 578             $longurl = $longurl_data;
 579         } else {
 580             throw new ServerException("Can't linkify url '$url'");
 581         }
 582     }
 583     $attrs = array('href' => $canon, 'title' => $longurl, 'rel' => 'external');
 584
 585     $is_attachment = false;
 586     $attachment_id = null;
 587     $has_thumb = false;
 588
 589     // Check to see whether this is a known "attachment" URL.
 590
 591     $f = File::staticGet('url', $longurl);
 592
 593     if (empty($f)) {
 594         // XXX: this writes to the database. :<
 595         $f = File::processNew($longurl);
 596     }
 597
 598     if (!empty($f)) {
 599         if ($f->getEnclosure()) {
 600             $is_attachment = true;
 601             $attachment_id = $f->id;
 602
 603             $thumb = File_thumbnail::staticGet('file_id', $f->id);
 604             if (!empty($thumb)) {
 605                 $has_thumb = true;
 606             }
 607         }
 608     }
 609
 610     // Add clippy
 611     if ($is_attachment) {
 612         $attrs['class'] = 'attachment';
 613         if ($has_thumb) {
 614             $attrs['class'] = 'attachment thumbnail';
 615         }
 616         $attrs['id'] = "attachment-{$attachment_id}";
 617     }
 618
 619     return XMLStringer::estring('a', $attrs, $url);
 620 }
 621
 622 function common_shorten_links($text)
 623 {
 624     $maxLength = Notice::maxContent();
 625     if ($maxLength == 0 || mb_strlen($text) <= $maxLength) return $text;
 626     return common_replace_urls_callback($text, array('File_redirection', 'makeShort'));
 627 }
 628
 629 function common_xml_safe_str($str)
 630 {
 631     // Neutralize control codes and surrogates
 632         return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
 633 }
 634
 635 function common_tag_link($tag)
 636 {
 637     $canonical = common_canonical_tag($tag);
 638     $url = common_local_url('tag', array('tag' => $canonical));
 639     $xs = new XMLStringer();
 640     $xs->elementStart('span', 'tag');
 641     $xs->element('a', array('href' => $url,
 642                             'rel' => 'tag'),
 643                  $tag);
 644     $xs->elementEnd('span');
 645     return $xs->getString();
 646 }
 647
 648 function common_canonical_tag($tag)
 649 {
 650   $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
 651   return str_replace(array('-', '_', '.'), '', $tag);
 652 }
 653
 654 function common_valid_profile_tag($str)
 655 {
 656     return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
 657 }
 658
 659 function common_at_link($sender_id, $nickname)
 660 {
 661     $sender = Profile::staticGet($sender_id);
 662     if (!$sender) {
 663         return $nickname;
 664     }
 665     $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
 666     if ($recipient) {
 667         $user = User::staticGet('id', $recipient->id);
 668         if ($user) {
 669             $url = common_local_url('userbyid', array('id' => $user->id));
 670         } else {
 671             $url = $recipient->profileurl;
 672         }
 673         $xs = new XMLStringer(false);
 674         $attrs = array('href' => $url,
 675                        'class' => 'url');
 676         if (!empty($recipient->fullname)) {
 677             $attrs['title'] = $recipient->fullname . ' (' . $recipient->nickname . ')';
 678         }
 679         $xs->elementStart('span', 'vcard');
 680         $xs->elementStart('a', $attrs);
 681         $xs->element('span', 'fn nickname', $nickname);
 682         $xs->elementEnd('a');
 683         $xs->elementEnd('span');
 684         return $xs->getString();
 685     } else {
 686         return $nickname;
 687     }
 688 }
 689
 690 function common_group_link($sender_id, $nickname)
 691 {
 692     $sender = Profile::staticGet($sender_id);
 693     $group = User_group::getForNickname($nickname);
 694     if ($sender && $group && $sender->isMember($group)) {
 695         $attrs = array('href' => $group->permalink(),
 696                        'class' => 'url');
 697         if (!empty($group->fullname)) {
 698             $attrs['title'] = $group->fullname . ' (' . $group->nickname . ')';
 699         }
 700         $xs = new XMLStringer();
 701         $xs->elementStart('span', 'vcard');
 702         $xs->elementStart('a', $attrs);
 703         $xs->element('span', 'fn nickname', $nickname);
 704         $xs->elementEnd('a');
 705         $xs->elementEnd('span');
 706         return $xs->getString();
 707     } else {
 708         return $nickname;
 709     }
 710 }
 711
 712 function common_at_hash_link($sender_id, $tag)
 713 {
 714     $user = User::staticGet($sender_id);
 715     if (!$user) {
 716         return $tag;
 717     }
 718     $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
 719     if ($tagged) {
 720         $url = common_local_url('subscriptions',
 721                                 array('nickname' => $user->nickname,
 722                                       'tag' => $tag));
 723         $xs = new XMLStringer();
 724         $xs->elementStart('span', 'tag');
 725         $xs->element('a', array('href' => $url,
 726                                 'rel' => $tag),
 727                      $tag);
 728         $xs->elementEnd('span');
 729         return $xs->getString();
 730     } else {
 731         return $tag;
 732     }
 733 }
 734
 735 function common_relative_profile($sender, $nickname, $dt=null)
 736 {
 737     // Try to find profiles this profile is subscribed to that have this nickname
 738     $recipient = new Profile();
 739     // XXX: use a join instead of a subquery
 740     $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
 741     $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
 742     if ($recipient->find(true)) {
 743         // XXX: should probably differentiate between profiles with
 744         // the same name by date of most recent update
 745         return $recipient;
 746     }
 747     // Try to find profiles that listen to this profile and that have this nickname
 748     $recipient = new Profile();
 749     // XXX: use a join instead of a subquery
 750     $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
 751     $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
 752     if ($recipient->find(true)) {
 753         // XXX: should probably differentiate between profiles with
 754         // the same name by date of most recent update
 755         return $recipient;
 756     }
 757     // If this is a local user, try to find a local user with that nickname.
 758     $sender = User::staticGet($sender->id);
 759     if ($sender) {
 760         $recipient_user = User::staticGet('nickname', $nickname);
 761         if ($recipient_user) {
 762             return $recipient_user->getProfile();
 763         }
 764     }
 765     // Otherwise, no links. @messages from local users to remote users,
 766     // or from remote users to other remote users, are just
 767     // outside our ability to make intelligent guesses about
 768     return null;
 769 }
 770
 771 function common_local_url($action, $args=null, $params=null, $fragment=null)
 772 {
 773     $r = Router::get();
 774     $path = $r->build($action, $args, $params, $fragment);
 775
 776     $ssl = common_is_sensitive($action);
 777
 778     if (common_config('site','fancy')) {
 779         $url = common_path(mb_substr($path, 1), $ssl);
 780     } else {
 781         if (mb_strpos($path, '/index.php') === 0) {
 782             $url = common_path(mb_substr($path, 1), $ssl);
 783         } else {
 784             $url = common_path('index.php'.$path, $ssl);
 785         }
 786     }
 787     return $url;
 788 }
 789
 790 function common_is_sensitive($action)
 791 {
 792     static $sensitive = array('login', 'register', 'passwordsettings',
 793                               'twittersettings', 'api');
 794     $ssl = null;
 795
 796     if (Event::handle('SensitiveAction', array($action, &$ssl))) {
 797         $ssl = in_array($action, $sensitive);
 798     }
 799
 800     return $ssl;
 801 }
 802
 803 function common_path($relative, $ssl=false)
 804 {
 805     $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
 806
 807     if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
 808         || common_config('site', 'ssl') === 'always') {
 809         $proto = 'https';
 810         if (is_string(common_config('site', 'sslserver')) &&
 811             mb_strlen(common_config('site', 'sslserver')) > 0) {
 812             $serverpart = common_config('site', 'sslserver');
 813         } else if (common_config('site', 'server')) {
 814             $serverpart = common_config('site', 'server');
 815         } else {
 816             common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
 817         }
 818     } else {
 819         $proto = 'http';
 820         if (common_config('site', 'server')) {
 821             $serverpart = common_config('site', 'server');
 822         } else {
 823             common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
 824         }
 825     }
 826
 827     $relative = common_inject_session($relative, $serverpart);
 828
 829     return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
 830 }
 831
 832 function common_inject_session($url, $serverpart = null)
 833 {
 834     if (common_have_session()) {
 835
 836         if (empty($serverpart)) {
 837             $serverpart = parse_url($url, PHP_URL_HOST);
 838         }
 839
 840         $currentServer = $_SERVER['HTTP_HOST'];
 841
 842         // Are we pointing to another server (like an SSL server?)
 843
 844         if (!empty($currentServer) &&
 845             0 != strcasecmp($currentServer, $serverpart)) {
 846             // Pass the session ID as a GET parameter
 847             $sesspart = session_name() . '=' . session_id();
 848             $i = strpos($url, '?');
 849             if ($i === false) { // no GET params, just append
 850                 $url .= '?' . $sesspart;
 851             } else {
 852                 $url = substr($url, 0, $i + 1).$sesspart.'&'.substr($url, $i + 1);
 853             }
 854         }
 855     }
 856
 857     return $url;
 858 }
 859
 860 function common_date_string($dt)
 861 {
 862     // XXX: do some sexy date formatting
 863     // return date(DATE_RFC822, $dt);
 864     $t = strtotime($dt);
 865     $now = time();
 866     $diff = $now - $t;
 867
 868     if ($now < $t) { // that shouldn't happen!
 869         return common_exact_date($dt);
 870     } else if ($diff < 60) {
 871         return _('a few seconds ago');
 872     } else if ($diff < 92) {
 873         return _('about a minute ago');
 874     } else if ($diff < 3300) {
 875         return sprintf(_('about %d minutes ago'), round($diff/60));
 876     } else if ($diff < 5400) {
 877         return _('about an hour ago');
 878     } else if ($diff < 22 * 3600) {
 879         return sprintf(_('about %d hours ago'), round($diff/3600));
 880     } else if ($diff < 37 * 3600) {
 881         return _('about a day ago');
 882     } else if ($diff < 24 * 24 * 3600) {
 883         return sprintf(_('about %d days ago'), round($diff/(24*3600)));
 884     } else if ($diff < 46 * 24 * 3600) {
 885         return _('about a month ago');
 886     } else if ($diff < 330 * 24 * 3600) {
 887         return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
 888     } else if ($diff < 480 * 24 * 3600) {
 889         return _('about a year ago');
 890     } else {
 891         return common_exact_date($dt);
 892     }
 893 }
 894
 895 function common_exact_date($dt)
 896 {
 897     static $_utc;
 898     static $_siteTz;
 899
 900     if (!$_utc) {
 901         $_utc = new DateTimeZone('UTC');
 902         $_siteTz = new DateTimeZone(common_timezone());
 903     }
 904
 905     $dateStr = date('d F Y H:i:s', strtotime($dt));
 906     $d = new DateTime($dateStr, $_utc);
 907     $d->setTimezone($_siteTz);
 908     return $d->format(DATE_RFC850);
 909 }
 910
 911 function common_date_w3dtf($dt)
 912 {
 913     $dateStr = date('d F Y H:i:s', strtotime($dt));
 914     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 915     $d->setTimezone(new DateTimeZone(common_timezone()));
 916     return $d->format(DATE_W3C);
 917 }
 918
 919 function common_date_rfc2822($dt)
 920 {
 921     $dateStr = date('d F Y H:i:s', strtotime($dt));
 922     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 923     $d->setTimezone(new DateTimeZone(common_timezone()));
 924     return $d->format('r');
 925 }
 926
 927 function common_date_iso8601($dt)
 928 {
 929     $dateStr = date('d F Y H:i:s', strtotime($dt));
 930     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 931     $d->setTimezone(new DateTimeZone(common_timezone()));
 932     return $d->format('c');
 933 }
 934
 935 function common_sql_now()
 936 {
 937     return common_sql_date(time());
 938 }
 939
 940 function common_sql_date($datetime)
 941 {
 942     return strftime('%Y-%m-%d %H:%M:%S', $datetime);
 943 }
 944
 945 /**
 946  * Return an SQL fragment to calculate an age-based weight from a given
 947  * timestamp or datetime column.
 948  *
 949  * @param string $column name of field we're comparing against current time
 950  * @param integer $dropoff divisor for age in seconds before exponentiation
 951  * @return string SQL fragment
 952  */
 953 function common_sql_weight($column, $dropoff)
 954 {
 955     if (common_config('db', 'type') == 'pgsql') {
 956         // PostgreSQL doesn't support timestampdiff function.
 957         // @fixme will this use the right time zone?
 958         // @fixme does this handle cross-year subtraction correctly?
 959         return "sum(exp(-extract(epoch from (now() - $column)) / $dropoff))";
 960     } else {
 961         return "sum(exp(timestampdiff(second, utc_timestamp(), $column) / $dropoff))";
 962     }
 963 }
 964
 965 function common_redirect($url, $code=307)
 966 {
 967     static $status = array(301 => "Moved Permanently",
 968                            302 => "Found",
 969                            303 => "See Other",
 970                            307 => "Temporary Redirect");
 971
 972     header('HTTP/1.1 '.$code.' '.$status[$code]);
 973     header("Location: $url");
 974
 975     $xo = new XMLOutputter();
 976     $xo->startXML('a',
 977                   '-//W3C//DTD XHTML 1.0 Strict//EN',
 978                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
 979     $xo->element('a', array('href' => $url), $url);
 980     $xo->endXML();
 981     exit;
 982 }
 983
 984 function common_broadcast_notice($notice, $remote=false)
 985 {
 986     // DO NOTHING!
 987 }
 988
 989 // Stick the notice on the queue
 990
 991 function common_enqueue_notice($notice)
 992 {
 993     static $localTransports = array('omb',
 994                                     'ping');
 995
 996     $transports = array();
 997     if (common_config('sms', 'enabled')) {
 998         $transports[] = 'sms';
 999     }
1000     if (Event::hasHandler('HandleQueuedNotice')) {
1001         $transports[] = 'plugin';
1002     }
1003
1004
1005     // @fixme move these checks into QueueManager and/or individual handlers
1006     if ($notice->is_local == Notice::LOCAL_PUBLIC ||
1007         $notice->is_local == Notice::LOCAL_NONPUBLIC) {
1008         $transports = array_merge($transports, $localTransports);
1009     }
1010
1011     if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
1012
1013         $qm = QueueManager::get();
1014
1015         foreach ($transports as $transport)
1016         {
1017             $qm->enqueue($notice, $transport);
1018         }
1019
1020         Event::handle('EndEnqueueNotice', array($notice, $transports));
1021     }
1022
1023     return true;
1024 }
1025
1026 function common_broadcast_profile($profile)
1027 {
1028     // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
1029     require_once(INSTALLDIR.'/lib/omb.php');
1030     omb_broadcast_profile($profile);
1031     // XXX: Other broadcasts...?
1032     return true;
1033 }
1034
1035 function common_profile_url($nickname)
1036 {
1037     return common_local_url('showstream', array('nickname' => $nickname));
1038 }
1039
1040 // Should make up a reasonable root URL
1041
1042 function common_root_url($ssl=false)
1043 {
1044     $url = common_path('', $ssl);
1045     $i = strpos($url, '?');
1046     if ($i !== false) {
1047         $url = substr($url, 0, $i);
1048     }
1049     return $url;
1050 }
1051
1052 // returns $bytes bytes of random data as a hexadecimal string
1053 // "good" here is a goal and not a guarantee
1054
1055 function common_good_rand($bytes)
1056 {
1057     // XXX: use random.org...?
1058     if (@file_exists('/dev/urandom')) {
1059         return common_urandom($bytes);
1060     } else { // FIXME: this is probably not good enough
1061         return common_mtrand($bytes);
1062     }
1063 }
1064
1065 function common_urandom($bytes)
1066 {
1067     $h = fopen('/dev/urandom', 'rb');
1068     // should not block
1069     $src = fread($h, $bytes);
1070     fclose($h);
1071     $enc = '';
1072     for ($i = 0; $i < $bytes; $i++) {
1073         $enc .= sprintf("%02x", (ord($src[$i])));
1074     }
1075     return $enc;
1076 }
1077
1078 function common_mtrand($bytes)
1079 {
1080     $enc = '';
1081     for ($i = 0; $i < $bytes; $i++) {
1082         $enc .= sprintf("%02x", mt_rand(0, 255));
1083     }
1084     return $enc;
1085 }
1086
1087 function common_set_returnto($url)
1088 {
1089     common_ensure_session();
1090     $_SESSION['returnto'] = $url;
1091 }
1092
1093 function common_get_returnto()
1094 {
1095     common_ensure_session();
1096     return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
1097 }
1098
1099 function common_timestamp()
1100 {
1101     return date('YmdHis');
1102 }
1103
1104 function common_ensure_syslog()
1105 {
1106     static $initialized = false;
1107     if (!$initialized) {
1108         openlog(common_config('syslog', 'appname'), 0,
1109             common_config('syslog', 'facility'));
1110         $initialized = true;
1111     }
1112 }
1113
1114 function common_log_line($priority, $msg)
1115 {
1116     static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1117                                       'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1118     return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
1119 }
1120
1121 function common_request_id()
1122 {
1123     $pid = getmypid();
1124     $server = common_config('site', 'server');
1125     if (php_sapi_name() == 'cli') {
1126         $script = basename($_SERVER['PHP_SELF']);
1127         return "$server:$script:$pid";
1128     } else {
1129         static $req_id = null;
1130         if (!isset($req_id)) {
1131             $req_id = substr(md5(mt_rand()), 0, 8);
1132         }
1133         if (isset($_SERVER['REQUEST_URI'])) {
1134             $url = $_SERVER['REQUEST_URI'];
1135         }
1136         $method = $_SERVER['REQUEST_METHOD'];
1137         return "$server:$pid.$req_id $method $url";
1138     }
1139 }
1140
1141 function common_log($priority, $msg, $filename=null)
1142 {
1143     if(Event::handle('StartLog', array(&$priority, &$msg, &$filename))){
1144         $msg = '[' . common_request_id() . '] ' . $msg;
1145         $logfile = common_config('site', 'logfile');
1146         if ($logfile) {
1147             $log = fopen($logfile, "a");
1148             if ($log) {
1149                 $output = common_log_line($priority, $msg);
1150                 fwrite($log, $output);
1151                 fclose($log);
1152             }
1153         } else {
1154             common_ensure_syslog();
1155             syslog($priority, $msg);
1156         }
1157         Event::handle('EndLog', array($priority, $msg, $filename));
1158     }
1159 }
1160
1161 function common_debug($msg, $filename=null)
1162 {
1163     if ($filename) {
1164         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1165     } else {
1166         common_log(LOG_DEBUG, $msg);
1167     }
1168 }
1169
1170 function common_log_db_error(&$object, $verb, $filename=null)
1171 {
1172     $objstr = common_log_objstring($object);
1173     $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1174     common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1175 }
1176
1177 function common_log_objstring(&$object)
1178 {
1179     if (is_null($object)) {
1180         return "null";
1181     }
1182     if (!($object instanceof DB_DataObject)) {
1183         return "(unknown)";
1184     }
1185     $arr = $object->toArray();
1186     $fields = array();
1187     foreach ($arr as $k => $v) {
1188         if (is_object($v)) {
1189             $fields[] = "$k='".get_class($v)."'";
1190         } else {
1191             $fields[] = "$k='$v'";
1192         }
1193     }
1194     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1195     return $objstring;
1196 }
1197
1198 function common_valid_http_url($url)
1199 {
1200     return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1201 }
1202
1203 function common_valid_tag($tag)
1204 {
1205     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1206         return (Validate::email($matches[1]) ||
1207                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1208     }
1209     return false;
1210 }
1211
1212 /* Following functions are copied from MediaWiki GlobalFunctions.php
1213  * and written by Evan Prodromou. */
1214
1215 function common_accept_to_prefs($accept, $def = '*/*')
1216 {
1217     // No arg means accept anything (per HTTP spec)
1218     if(!$accept) {
1219         return array($def => 1);
1220     }
1221
1222     $prefs = array();
1223
1224     $parts = explode(',', $accept);
1225
1226     foreach($parts as $part) {
1227         // FIXME: doesn't deal with params like 'text/html; level=1'
1228         @list($value, $qpart) = explode(';', trim($part));
1229         $match = array();
1230         if(!isset($qpart)) {
1231             $prefs[$value] = 1;
1232         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1233             $prefs[$value] = $match[1];
1234         }
1235     }
1236
1237     return $prefs;
1238 }
1239
1240 function common_mime_type_match($type, $avail)
1241 {
1242     if(array_key_exists($type, $avail)) {
1243         return $type;
1244     } else {
1245         $parts = explode('/', $type);
1246         if(array_key_exists($parts[0] . '/*', $avail)) {
1247             return $parts[0] . '/*';
1248         } elseif(array_key_exists('*/*', $avail)) {
1249             return '*/*';
1250         } else {
1251             return null;
1252         }
1253     }
1254 }
1255
1256 function common_negotiate_type($cprefs, $sprefs)
1257 {
1258     $combine = array();
1259
1260     foreach(array_keys($sprefs) as $type) {
1261         $parts = explode('/', $type);
1262         if($parts[1] != '*') {
1263             $ckey = common_mime_type_match($type, $cprefs);
1264             if($ckey) {
1265                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1266             }
1267         }
1268     }
1269
1270     foreach(array_keys($cprefs) as $type) {
1271         $parts = explode('/', $type);
1272         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1273             $skey = common_mime_type_match($type, $sprefs);
1274             if($skey) {
1275                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1276             }
1277         }
1278     }
1279
1280     $bestq = 0;
1281     $besttype = 'text/html';
1282
1283     foreach(array_keys($combine) as $type) {
1284         if($combine[$type] > $bestq) {
1285             $besttype = $type;
1286             $bestq = $combine[$type];
1287         }
1288     }
1289
1290     if ('text/html' === $besttype) {
1291         return "text/html; charset=utf-8";
1292     }
1293     return $besttype;
1294 }
1295
1296 function common_config($main, $sub)
1297 {
1298     global $config;
1299     return (array_key_exists($main, $config) &&
1300             array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
1301 }
1302
1303 function common_copy_args($from)
1304 {
1305     $to = array();
1306     $strip = get_magic_quotes_gpc();
1307     foreach ($from as $k => $v) {
1308         $to[$k] = ($strip) ? stripslashes($v) : $v;
1309     }
1310     return $to;
1311 }
1312
1313 /**
1314  * Neutralise the evil effects of magic_quotes_gpc in the current request.
1315  * This is used before handing a request off to OAuthRequest::from_request.
1316  * @fixme Doesn't consider vars other than _POST and _GET?
1317  * @fixme Can't be undone and could corrupt data if run twice.
1318  */
1319 function common_remove_magic_from_request()
1320 {
1321     if(get_magic_quotes_gpc()) {
1322         $_POST=array_map('stripslashes',$_POST);
1323         $_GET=array_map('stripslashes',$_GET);
1324     }
1325 }
1326
1327 function common_user_uri(&$user)
1328 {
1329     return common_local_url('userbyid', array('id' => $user->id));
1330 }
1331
1332 function common_notice_uri(&$notice)
1333 {
1334     return common_local_url('shownotice',
1335                             array('notice' => $notice->id));
1336 }
1337
1338 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1339
1340 function common_confirmation_code($bits)
1341 {
1342     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1343     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1344     $chars = ceil($bits/5);
1345     $code = '';
1346     for ($i = 0; $i < $chars; $i++) {
1347         // XXX: convert to string and back
1348         $num = hexdec(common_good_rand(1));
1349         // XXX: randomness is too precious to throw away almost
1350         // 40% of the bits we get!
1351         $code .= $codechars[$num%32];
1352     }
1353     return $code;
1354 }
1355
1356 // convert markup to HTML
1357
1358 function common_markup_to_html($c)
1359 {
1360     $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1361     $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1362     $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1363     return Markdown($c);
1364 }
1365
1366 function common_profile_uri($profile)
1367 {
1368     if (!$profile) {
1369         return null;
1370     }
1371     $user = User::staticGet($profile->id);
1372     if ($user) {
1373         return $user->uri;
1374     }
1375
1376     $remote = Remote_profile::staticGet($profile->id);
1377     if ($remote) {
1378         return $remote->uri;
1379     }
1380     // XXX: this is a very bad profile!
1381     return null;
1382 }
1383
1384 function common_canonical_sms($sms)
1385 {
1386     // strip non-digits
1387     preg_replace('/\D/', '', $sms);
1388     return $sms;
1389 }
1390
1391 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1392 {
1393     switch ($errno) {
1394
1395      case E_ERROR:
1396      case E_COMPILE_ERROR:
1397      case E_CORE_ERROR:
1398      case E_USER_ERROR:
1399      case E_PARSE:
1400      case E_RECOVERABLE_ERROR:
1401         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
1402         die();
1403         break;
1404
1405      case E_WARNING:
1406      case E_COMPILE_WARNING:
1407      case E_CORE_WARNING:
1408      case E_USER_WARNING:
1409         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1410         break;
1411
1412      case E_NOTICE:
1413      case E_USER_NOTICE:
1414         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1415         break;
1416
1417      case E_STRICT:
1418      case E_DEPRECATED:
1419      case E_USER_DEPRECATED:
1420         // XXX: config variable to log this stuff, too
1421         break;
1422
1423      default:
1424         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
1425         die();
1426         break;
1427     }
1428
1429     // FIXME: show error page if we're on the Web
1430     /* Don't execute PHP internal error handler */
1431     return true;
1432 }
1433
1434 function common_session_token()
1435 {
1436     common_ensure_session();
1437     if (!array_key_exists('token', $_SESSION)) {
1438         $_SESSION['token'] = common_good_rand(64);
1439     }
1440     return $_SESSION['token'];
1441 }
1442
1443 function common_cache_key($extra)
1444 {
1445     return Cache::key($extra);
1446 }
1447
1448 function common_keyize($str)
1449 {
1450     return Cache::keyize($str);
1451 }
1452
1453 function common_memcache()
1454 {
1455     return Cache::instance();
1456 }
1457
1458 function common_license_terms($uri)
1459 {
1460     if(preg_match('/creativecommons.org\/licenses\/([^\/]+)/', $uri, $matches)) {
1461         return explode('-',$matches[1]);
1462     }
1463     return array($uri);
1464 }
1465
1466 function common_compatible_license($from, $to)
1467 {
1468     $from_terms = common_license_terms($from);
1469     // public domain and cc-by are compatible with everything
1470     if(count($from_terms) == 1 && ($from_terms[0] == 'publicdomain' || $from_terms[0] == 'by')) {
1471         return true;
1472     }
1473     $to_terms = common_license_terms($to);
1474     // sa is compatible across versions. IANAL
1475     if(in_array('sa',$from_terms) || in_array('sa',$to_terms)) {
1476         return count(array_diff($from_terms, $to_terms)) == 0;
1477     }
1478     // XXX: better compatibility check needed here!
1479     // Should at least normalise URIs
1480     return ($from == $to);
1481 }
1482
1483 /**
1484  * returns a quoted table name, if required according to config
1485  */
1486 function common_database_tablename($tablename)
1487 {
1488
1489   if(common_config('db','quote_identifiers')) {
1490       $tablename = '"'. $tablename .'"';
1491   }
1492   //table prefixes could be added here later
1493   return $tablename;
1494 }
1495
1496 /**
1497  * Shorten a URL with the current user's configured shortening service,
1498  * or ur1.ca if configured, or not at all if no shortening is set up.
1499  * Length is not considered.
1500  *
1501  * @param string $long_url
1502  * @return string may return the original URL if shortening failed
1503  *
1504  * @fixme provide a way to specify a particular shortener
1505  * @fixme provide a way to specify to use a given user's shortening preferences
1506  */
1507 function common_shorten_url($long_url)
1508 {
1509     $user = common_current_user();
1510     if (empty($user)) {
1511         // common current user does not find a user when called from the XMPP daemon
1512         // therefore we'll set one here fix, so that XMPP given URLs may be shortened
1513         $shortenerName = 'ur1.ca';
1514     } else {
1515         $shortenerName = $user->urlshorteningservice;
1516     }
1517
1518     if(Event::handle('StartShortenUrl', array($long_url,$shortenerName,&$shortenedUrl))){
1519         //URL wasn't shortened, so return the long url
1520         return $long_url;
1521     }else{
1522         //URL was shortened, so return the result
1523         return $shortenedUrl;
1524     }
1525 }
1526
1527 /**
1528  * @return mixed array($proxy, $ip) for web requests; proxy may be null
1529  *               null if not a web request
1530  *
1531  * @fixme X-Forwarded-For can be chained by multiple proxies;
1532           we should parse the list and provide a cleaner array
1533  * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
1534  * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
1535  *        use function to get exact request headers from Apache if possible.
1536  */
1537 function common_client_ip()
1538 {
1539     if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
1540         return null;
1541     }
1542
1543     if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
1544         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1545             $proxy = $_SERVER['HTTP_CLIENT_IP'];
1546         } else {
1547             $proxy = $_SERVER['REMOTE_ADDR'];
1548         }
1549         $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
1550     } else {
1551         $proxy = null;
1552         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1553             $ip = $_SERVER['HTTP_CLIENT_IP'];
1554         } else {
1555             $ip = $_SERVER['REMOTE_ADDR'];
1556         }
1557     }
1558
1559     return array($proxy, $ip);
1560 }