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