lib/util.php

   1 <?php
   2 /*
   3  * Laconica - a distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, Control Yourself, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 /* XXX: break up into separate modules (HTTP, user, files) */
  21
  22 // Show a server error
  23
  24 function common_server_error($msg, $code=500)
  25 {
  26     $err = new ServerErrorAction($msg, $code);
  27     $err->showPage();
  28 }
  29
  30 // Show a user error
  31 function common_user_error($msg, $code=400)
  32 {
  33     $err = new ClientErrorAction($msg, $code);
  34     $err->showPage();
  35 }
  36
  37 function common_init_locale($language=null)
  38 {
  39     if(!$language) {
  40         $language = common_language();
  41     }
  42     putenv('LANGUAGE='.$language);
  43     putenv('LANG='.$language);
  44     return setlocale(LC_ALL, $language . ".utf8",
  45                      $language . ".UTF8",
  46                      $language . ".utf-8",
  47                      $language . ".UTF-8",
  48                      $language);
  49 }
  50
  51 function common_init_language()
  52 {
  53     mb_internal_encoding('UTF-8');
  54     $language = common_language();
  55     // So we don't have to make people install the gettext locales
  56     $locale_set = common_init_locale($language);
  57     bindtextdomain("laconica", common_config('site','locale_path'));
  58     bind_textdomain_codeset("laconica", "UTF-8");
  59     textdomain("laconica");
  60     setlocale(LC_CTYPE, 'C');
  61     if(!$locale_set) {
  62         common_log(LOG_INFO,'Language requested:'.$language.' - locale could not be set:',__FILE__);
  63     }
  64 }
  65
  66 function common_timezone()
  67 {
  68     if (common_logged_in()) {
  69         $user = common_current_user();
  70         if ($user->timezone) {
  71             return $user->timezone;
  72         }
  73     }
  74
  75     return common_config('site', 'timezone');
  76 }
  77
  78 function common_language()
  79 {
  80
  81     // If there is a user logged in and they've set a language preference
  82     // then return that one...
  83     if (_have_config() && common_logged_in()) {
  84         $user = common_current_user();
  85         $user_language = $user->language;
  86         if ($user_language)
  87           return $user_language;
  88     }
  89
  90     // Otherwise, find the best match for the languages requested by the
  91     // user's browser...
  92     $httplang = isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? $_SERVER['HTTP_ACCEPT_LANGUAGE'] : null;
  93     if (!empty($httplang)) {
  94         $language = client_prefered_language($httplang);
  95         if ($language)
  96           return $language;
  97     }
  98
  99     // Finally, if none of the above worked, use the site's default...
 100     return common_config('site', 'language');
 101 }
 102 // salted, hashed passwords are stored in the DB
 103
 104 function common_munge_password($password, $id)
 105 {
 106     return md5($password . $id);
 107 }
 108
 109 // check if a username exists and has matching password
 110 function common_check_user($nickname, $password)
 111 {
 112     // NEVER allow blank passwords, even if they match the DB
 113     if (mb_strlen($password) == 0) {
 114         return false;
 115     }
 116     $user = User::staticGet('nickname', $nickname);
 117     if (is_null($user) || $user === false) {
 118         return false;
 119     } else {
 120         if (0 == strcmp(common_munge_password($password, $user->id),
 121                         $user->password)) {
 122             return $user;
 123         } else {
 124             return false;
 125         }
 126     }
 127 }
 128
 129 // is the current user logged in?
 130 function common_logged_in()
 131 {
 132     return (!is_null(common_current_user()));
 133 }
 134
 135 function common_have_session()
 136 {
 137     return (0 != strcmp(session_id(), ''));
 138 }
 139
 140 function common_ensure_session()
 141 {
 142     $c = null;
 143     if (array_key_exists(session_name(), $_COOKIE)) {
 144         $c = $_COOKIE[session_name()];
 145     }
 146     if (!common_have_session()) {
 147         if (common_config('sessions', 'handle')) {
 148             Session::setSaveHandler();
 149         }
 150         @session_start();
 151         if (!isset($_SESSION['started'])) {
 152             $_SESSION['started'] = time();
 153             if (!empty($c)) {
 154                 common_log(LOG_WARNING, 'Session cookie "' . $_COOKIE[session_name()] . '" ' .
 155                            ' is set but started value is null');
 156             }
 157         }
 158     }
 159 }
 160
 161 // Three kinds of arguments:
 162 // 1) a user object
 163 // 2) a nickname
 164 // 3) null to clear
 165
 166 // Initialize to false; set to null if none found
 167
 168 $_cur = false;
 169
 170 function common_set_user($user)
 171 {
 172
 173     global $_cur;
 174
 175     if (is_null($user) && common_have_session()) {
 176         $_cur = null;
 177         unset($_SESSION['userid']);
 178         return true;
 179     } else if (is_string($user)) {
 180         $nickname = $user;
 181         $user = User::staticGet('nickname', $nickname);
 182     } else if (!($user instanceof User)) {
 183         return false;
 184     }
 185
 186     if ($user) {
 187         common_ensure_session();
 188         $_SESSION['userid'] = $user->id;
 189         $_cur = $user;
 190         return $_cur;
 191     }
 192     return false;
 193 }
 194
 195 function common_set_cookie($key, $value, $expiration=0)
 196 {
 197     $path = common_config('site', 'path');
 198     $server = common_config('site', 'server');
 199
 200     if ($path && ($path != '/')) {
 201         $cookiepath = '/' . $path . '/';
 202     } else {
 203         $cookiepath = '/';
 204     }
 205     return setcookie($key,
 206                      $value,
 207                      $expiration,
 208                      $cookiepath,
 209                      $server);
 210 }
 211
 212 define('REMEMBERME', 'rememberme');
 213 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
 214
 215 function common_rememberme($user=null)
 216 {
 217     if (!$user) {
 218         $user = common_current_user();
 219         if (!$user) {
 220             common_debug('No current user to remember', __FILE__);
 221             return false;
 222         }
 223     }
 224
 225     $rm = new Remember_me();
 226
 227     $rm->code = common_good_rand(16);
 228     $rm->user_id = $user->id;
 229
 230     // Wrap the insert in some good ol' fashioned transaction code
 231
 232     $rm->query('BEGIN');
 233
 234     $result = $rm->insert();
 235
 236     if (!$result) {
 237         common_log_db_error($rm, 'INSERT', __FILE__);
 238         common_debug('Error adding rememberme record for ' . $user->nickname, __FILE__);
 239         return false;
 240     }
 241
 242     $rm->query('COMMIT');
 243
 244     common_debug('Inserted rememberme record (' . $rm->code . ', ' . $rm->user_id . '); result = ' . $result . '.', __FILE__);
 245
 246     $cookieval = $rm->user_id . ':' . $rm->code;
 247
 248     common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
 249
 250     common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
 251
 252     return true;
 253 }
 254
 255 function common_remembered_user()
 256 {
 257
 258     $user = null;
 259
 260     $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
 261
 262     if (!$packed) {
 263         return null;
 264     }
 265
 266     list($id, $code) = explode(':', $packed);
 267
 268     if (!$id || !$code) {
 269         common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
 270         common_forgetme();
 271         return null;
 272     }
 273
 274     $rm = Remember_me::staticGet($code);
 275
 276     if (!$rm) {
 277         common_log(LOG_WARNING, 'No such remember code: ' . $code);
 278         common_forgetme();
 279         return null;
 280     }
 281
 282     if ($rm->user_id != $id) {
 283         common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
 284         common_forgetme();
 285         return null;
 286     }
 287
 288     $user = User::staticGet($rm->user_id);
 289
 290     if (!$user) {
 291         common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
 292         common_forgetme();
 293         return null;
 294     }
 295
 296     // successful!
 297     $result = $rm->delete();
 298
 299     if (!$result) {
 300         common_log_db_error($rm, 'DELETE', __FILE__);
 301         common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
 302         common_forgetme();
 303         return null;
 304     }
 305
 306     common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
 307
 308     common_set_user($user);
 309     common_real_login(false);
 310
 311     // We issue a new cookie, so they can log in
 312     // automatically again after this session
 313
 314     common_rememberme($user);
 315
 316     return $user;
 317 }
 318
 319 // must be called with a valid user!
 320
 321 function common_forgetme()
 322 {
 323     common_set_cookie(REMEMBERME, '', 0);
 324 }
 325
 326 // who is the current user?
 327 function common_current_user()
 328 {
 329     global $_cur;
 330
 331     if (!_have_config()) {
 332         return null;
 333     }
 334
 335     if ($_cur === false) {
 336
 337         if (isset($_REQUEST[session_name()]) || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
 338             common_ensure_session();
 339             $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
 340             if ($id) {
 341                 $_cur = User::staticGet($id);
 342                 return $_cur;
 343             }
 344         }
 345
 346         // that didn't work; try to remember; will init $_cur to null on failure
 347         $_cur = common_remembered_user();
 348
 349         if ($_cur) {
 350             common_debug("Got User " . $_cur->nickname);
 351             common_debug("Faking session on remembered user");
 352             // XXX: Is this necessary?
 353             $_SESSION['userid'] = $_cur->id;
 354         }
 355     }
 356
 357     return $_cur;
 358 }
 359
 360 // Logins that are 'remembered' aren't 'real' -- they're subject to
 361 // cookie-stealing. So, we don't let them do certain things. New reg,
 362 // OpenID, and password logins _are_ real.
 363
 364 function common_real_login($real=true)
 365 {
 366     common_ensure_session();
 367     $_SESSION['real_login'] = $real;
 368 }
 369
 370 function common_is_real_login()
 371 {
 372     return common_logged_in() && $_SESSION['real_login'];
 373 }
 374
 375 // get canonical version of nickname for comparison
 376 function common_canonical_nickname($nickname)
 377 {
 378     // XXX: UTF-8 canonicalization (like combining chars)
 379     return strtolower($nickname);
 380 }
 381
 382 // get canonical version of email for comparison
 383 function common_canonical_email($email)
 384 {
 385     // XXX: canonicalize UTF-8
 386     // XXX: lcase the domain part
 387     return $email;
 388 }
 389
 390 function common_render_content($text, $notice)
 391 {
 392     $r = common_render_text($text);
 393     $id = $notice->profile_id;
 394     $r = preg_replace('/(^|\s+)@([A-Za-z0-9]{1,64})/e', "'\\1@'.common_at_link($id, '\\2')", $r);
 395     $r = preg_replace('/^T ([A-Z0-9]{1,64}) /e', "'T '.common_at_link($id, '\\1').' '", $r);
 396     $r = preg_replace('/(^|\s+)@#([A-Za-z0-9]{1,64})/e', "'\\1@#'.common_at_hash_link($id, '\\2')", $r);
 397     $r = preg_replace('/(^|\s)!([A-Za-z0-9]{1,64})/e', "'\\1!'.common_group_link($id, '\\2')", $r);
 398     return $r;
 399 }
 400
 401 function common_render_text($text)
 402 {
 403     $r = htmlspecialchars($text);
 404
 405     $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
 406     $r = common_replace_urls_callback($r, 'common_linkify');
 407     $r = preg_replace('/(^|\(|\[|\s+)#([\pL\pN_\-\.]{1,64})/e', "'\\1#'.common_tag_link('\\2')", $r);
 408     // XXX: machine tags
 409     return $r;
 410 }
 411
 412 function common_replace_urls_callback($text, $callback, $notice_id = null) {
 413     // Start off with a regex
 414     $regex = '#'.
 415     '(?:^|[\s\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
 416     '(?P<url>'.
 417         '(?:'.
 418             '(?:'. //Known protocols
 419                 '(?:'.
 420                     '(?:(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|irc)://)'.
 421                     '|'.
 422                     '(?:(?:mailto|aim|tel|xmpp):)'.
 423                 ')'.
 424                 '(?:[\pN\pL\-\_\+]+(?::[\pN\pL\-\_\+]+)?\@)?'. //user:pass@
 425                 '(?:'.
 426                     '(?:'.
 427                         '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
 428                     ')|(?:'.
 429                         '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
 430                     ')'.
 431                 ')'.
 432             ')'.
 433             '|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)'. //IPv4
 434             '|(?:'. //IPv6
 435                 '\[?(?:(?:(?:[0-9A-Fa-f]{1,4}:){7}(?:(?:[0-9A-Fa-f]{1,4})|:))|(?:(?:[0-9A-Fa-f]{1,4}:){6}(?::|(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})|(?::[0-9A-Fa-f]{1,4})))|(?:(?:[0-9A-Fa-f]{1,4}:){5}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:){4}(?::[0-9A-Fa-f]{1,4}){0,1}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:){3}(?::[0-9A-Fa-f]{1,4}){0,2}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:){2}(?::[0-9A-Fa-f]{1,4}){0,3}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:)(?::[0-9A-Fa-f]{1,4}){0,4}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?::(?::[0-9A-Fa-f]{1,4}){0,5}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})))\]?'.
 436             ')|(?:'. //DNS
 437                 '(?:[\pN\pL\-\_\+]+(?:\:[\pN\pL\-\_\+]+)?\@)?'. //user:pass@
 438                 '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
 439                 //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
 440                 '(?:AC|AD|AE|AERO|AF|AG|AI|AL|AM|AN|AO|AQ|AR|ARPA|AS|ASIA|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BIZ|BJ|BM|BN|BO|BR|BS|BT|BV|BW|BY|BZ|CA|CAT|CC|CD|CF|CG|CH|CI|CK|CL|CM|CN|CO|COM|COOP|CR|CU|CV|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EDU|EE|EG|ER|ES|ET|EU|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GOV|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HT|HU|ID|IE|IL|IM|IN|INFO|INT|IO|IQ|IR|IS|IT|JE|JM|JO|JOBS|JP|KE|KG|KH|KI|KM|KN|KP|KR|KW|KY|KZ|LA|LB|LC|LI|LK|LR|LS|LT|LU|LV|LY|MA|MC|MD|ME|MG|MH|MIL|MK|ML|MM|MN|MO|MOBI|MP|MQ|MR|MS|MT|MU|MUSEUM|MV|MW|MX|MY|MZ|NA|NAME|NC|NE|NET|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|ORG|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PRO|PS|PT|PW|PY|QA|RE|RO|RS|RU|RW|SA|SB|SC|SD|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SO|SR|ST|SU|SV|SY|SZ|TC|TD|TEL|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TP|TR|TRAVEL|TT|TV|TW|TZ|UA|UG|UK|US|UY|UZ|VA|VC|VE|VG|VI|VN|VU|WF|WS|XN--0ZWM56D|XN--11B5BS3A9AJ6G|XN--80AKHBYKNJ4F|XN--9T4B11YI5A|XN--DEBA0AD|XN--G6W251D|XN--HGBK6AJ7F53BBA|XN--HLCJ6AYA9ESC7A|XN--JXALPDLP|XN--KGBECHTV|XN--ZCKZAH|YE|YT|YU|ZA|ZM|ZW|local|loc|onion)'.
 441             ')(?![\pN\pL\-\_])'.
 442         ')'.
 443         '(?:'.
 444             '(?:\:\d+)?'. //:port
 445             '(?:/[\pN\pL$\[\]\,\!\(\)\.\-\_\+\/\=\&\;]*)?'. // /path
 446             '(?:\?[\pN\pL\$\[\]\,\!\(\)\.\-\_\+\/\=\&\;\/]*)?'. // ?query string
 447             '(?:\#[\pN\pL$\[\]\,\!\(\)\.\-\_\+\/\=\&\;\/\?\#]*)?'. // #fragment
 448         ')(?<![\?\.\,\#\)\]\,])'.
 449     ')'.
 450     '#ixu';
 451     preg_match_all($regex,$text,$matches);
 452     //print_r($matches);
 453     return preg_replace_callback($regex, curry(callback_helper,$callback,$notice_id) ,$text);
 454 }
 455
 456 function callback_helper($matches, $callback, $notice_id) {
 457     $pos = strpos($matches[0],$matches['url']);
 458     $left = substr($matches[0],0,$pos);
 459     $right = substr($matches[0],$pos+strlen($matches['url']));
 460
 461     if(empty($notice_id)){
 462         $result = call_user_func_array($callback,$matches['url']);
 463     }else{
 464         $result = call_user_func_array($callback, array($matches['url'],$notice_id) );
 465     }
 466     return $left . $result . $right;
 467 }
 468
 469 function curry($fn) {
 470     //TODO switch to a PHP 5.3 function closure based approach if PHP 5.3 is used
 471     $args = func_get_args();
 472     array_shift($args);
 473     $id = uniqid('_partial');
 474     $GLOBALS[$id] = array($fn, $args);
 475     return create_function(
 476         '',
 477         '
 478         $args = func_get_args();
 479         return call_user_func_array(
 480         $GLOBALS["'.$id.'"][0],
 481         array_merge(
 482             $args,
 483             $GLOBALS["'.$id.'"][1]));
 484     ');
 485 }
 486
 487 function common_linkify($url) {
 488     // It comes in special'd, so we unspecial it before passing to the stringifying
 489     // functions
 490     $url = htmlspecialchars_decode($url);
 491
 492    if(strpos($url, '@')!==false && strpos($url, ':')===false){
 493        //url is an email address without the mailto: protocol
 494        return XMLStringer::estring('a', array('href' => "mailto:$url", 'rel' => 'external'), $url);
 495    }
 496
 497     $canon = File_redirection::_canonUrl($url);
 498
 499     $longurl_data = File_redirection::where($url);
 500     if (is_array($longurl_data)) {
 501         $longurl = $longurl_data['url'];
 502     } elseif (is_string($longurl_data)) {
 503         $longurl = $longurl_data;
 504     } else {
 505         throw new ServerException("Can't linkify url '$url'");
 506     }
 507
 508     $attrs = array('href' => $canon, 'rel' => 'external');
 509
 510     $is_attachment = false;
 511     $attachment_id = null;
 512     $has_thumb = false;
 513
 514     // Check to see whether there's a filename associated with this URL.
 515     // If there is, it's an upload and qualifies as an attachment
 516
 517     $localfile = File::staticGet('url', $longurl);
 518
 519     if (!empty($localfile)) {
 520         if (isset($localfile->filename)) {
 521             $is_attachment = true;
 522             $attachment_id = $localfile->id;
 523         }
 524     }
 525
 526     // if this URL is an attachment, then we set class='attachment' and id='attahcment-ID'
 527     // where ID is the id of the attachment for the given URL.
 528     //
 529     // we need a better test telling what can be shown as an attachment
 530     // we're currently picking up oembeds only.
 531     // I think the best option is another file_view table in the db
 532     // and associated dbobject.
 533
 534     $query = "select file_oembed.file_id as file_id from file join file_oembed on file.id = file_oembed.file_id where file.url='$longurl'";
 535     $file = new File;
 536     $file->query($query);
 537     $file->fetch();
 538
 539     if (!empty($file->file_id)) {
 540         $is_attachment = true;
 541         $attachment_id = $file->file_id;
 542
 543         $query = "select file_thumbnail.file_id as file_id from file join file_thumbnail on file.id = file_thumbnail.file_id where file.url='$longurl'";
 544         $file2 = new File;
 545         $file2->query($query);
 546         $file2->fetch();
 547
 548         if (!empty($file2)) {
 549             $has_thumb = true;
 550         }
 551     }
 552
 553     // Add clippy
 554     if ($is_attachment) {
 555         $attrs['class'] = 'attachment';
 556         if ($has_thumb) {
 557             $attrs['class'] = 'attachment thumbnail';
 558         }
 559         $attrs['id'] = "attachment-{$attachment_id}";
 560     }
 561
 562     return XMLStringer::estring('a', $attrs, $url);
 563 }
 564
 565 function common_shorten_links($text)
 566 {
 567     if (mb_strlen($text) <= 140) return $text;
 568     return common_replace_urls_callback($text, array('File_redirection', 'makeShort'));
 569 }
 570
 571 function common_xml_safe_str($str)
 572 {
 573     // Neutralize control codes and surrogates
 574         return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
 575 }
 576
 577 function common_tag_link($tag)
 578 {
 579     $canonical = common_canonical_tag($tag);
 580     $url = common_local_url('tag', array('tag' => $canonical));
 581     $xs = new XMLStringer();
 582     $xs->elementStart('span', 'tag');
 583     $xs->element('a', array('href' => $url,
 584                             'rel' => 'tag'),
 585                  $tag);
 586     $xs->elementEnd('span');
 587     return $xs->getString();
 588 }
 589
 590 function common_canonical_tag($tag)
 591 {
 592   $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
 593   return str_replace(array('-', '_', '.'), '', $tag);
 594 }
 595
 596 function common_valid_profile_tag($str)
 597 {
 598     return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
 599 }
 600
 601 function common_at_link($sender_id, $nickname)
 602 {
 603     $sender = Profile::staticGet($sender_id);
 604     $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
 605     if ($recipient) {
 606         $user = User::staticGet('id', $recipient->id);
 607         if ($user) {
 608             $url = common_local_url('userbyid', array('id' => $user->id));
 609         } else {
 610             $url = $recipient->profileurl;
 611         }
 612         $xs = new XMLStringer(false);
 613         $attrs = array('href' => $url,
 614                        'class' => 'url');
 615         if (!empty($recipient->fullname)) {
 616             $attrs['title'] = $recipient->fullname . ' (' . $recipient->nickname . ')';
 617         }
 618         $xs->elementStart('span', 'vcard');
 619         $xs->elementStart('a', $attrs);
 620         $xs->element('span', 'fn nickname', $nickname);
 621         $xs->elementEnd('a');
 622         $xs->elementEnd('span');
 623         return $xs->getString();
 624     } else {
 625         return $nickname;
 626     }
 627 }
 628
 629 function common_group_link($sender_id, $nickname)
 630 {
 631     $sender = Profile::staticGet($sender_id);
 632     $group = User_group::getForNickname($nickname);
 633     if ($group && $sender->isMember($group)) {
 634         $attrs = array('href' => $group->permalink(),
 635                        'class' => 'url');
 636         if (!empty($group->fullname)) {
 637             $attrs['title'] = $group->fullname . ' (' . $group->nickname . ')';
 638         }
 639         $xs = new XMLStringer();
 640         $xs->elementStart('span', 'vcard');
 641         $xs->elementStart('a', $attrs);
 642         $xs->element('span', 'fn nickname', $nickname);
 643         $xs->elementEnd('a');
 644         $xs->elementEnd('span');
 645         return $xs->getString();
 646     } else {
 647         return $nickname;
 648     }
 649 }
 650
 651 function common_at_hash_link($sender_id, $tag)
 652 {
 653     $user = User::staticGet($sender_id);
 654     if (!$user) {
 655         return $tag;
 656     }
 657     $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
 658     if ($tagged) {
 659         $url = common_local_url('subscriptions',
 660                                 array('nickname' => $user->nickname,
 661                                       'tag' => $tag));
 662         $xs = new XMLStringer();
 663         $xs->elementStart('span', 'tag');
 664         $xs->element('a', array('href' => $url,
 665                                 'rel' => $tag),
 666                      $tag);
 667         $xs->elementEnd('span');
 668         return $xs->getString();
 669     } else {
 670         return $tag;
 671     }
 672 }
 673
 674 function common_relative_profile($sender, $nickname, $dt=null)
 675 {
 676     // Try to find profiles this profile is subscribed to that have this nickname
 677     $recipient = new Profile();
 678     // XXX: use a join instead of a subquery
 679     $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
 680     $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
 681     if ($recipient->find(true)) {
 682         // XXX: should probably differentiate between profiles with
 683         // the same name by date of most recent update
 684         return $recipient;
 685     }
 686     // Try to find profiles that listen to this profile and that have this nickname
 687     $recipient = new Profile();
 688     // XXX: use a join instead of a subquery
 689     $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
 690     $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
 691     if ($recipient->find(true)) {
 692         // XXX: should probably differentiate between profiles with
 693         // the same name by date of most recent update
 694         return $recipient;
 695     }
 696     // If this is a local user, try to find a local user with that nickname.
 697     $sender = User::staticGet($sender->id);
 698     if ($sender) {
 699         $recipient_user = User::staticGet('nickname', $nickname);
 700         if ($recipient_user) {
 701             return $recipient_user->getProfile();
 702         }
 703     }
 704     // Otherwise, no links. @messages from local users to remote users,
 705     // or from remote users to other remote users, are just
 706     // outside our ability to make intelligent guesses about
 707     return null;
 708 }
 709
 710 function common_local_url($action, $args=null, $params=null, $fragment=null)
 711 {
 712     static $sensitive = array('login', 'register', 'passwordsettings',
 713                               'twittersettings', 'finishopenidlogin',
 714                               'finishaddopenid', 'api');
 715
 716     $r = Router::get();
 717     $path = $r->build($action, $args, $params, $fragment);
 718
 719     $ssl = in_array($action, $sensitive);
 720
 721     if (common_config('site','fancy')) {
 722         $url = common_path(mb_substr($path, 1), $ssl);
 723     } else {
 724         if (mb_strpos($path, '/index.php') === 0) {
 725             $url = common_path(mb_substr($path, 1), $ssl);
 726         } else {
 727             $url = common_path('index.php'.$path, $ssl);
 728         }
 729     }
 730     return $url;
 731 }
 732
 733 function common_path($relative, $ssl=false)
 734 {
 735     $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
 736
 737     if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
 738         || common_config('site', 'ssl') === 'always') {
 739         $proto = 'https';
 740         if (is_string(common_config('site', 'sslserver')) &&
 741             mb_strlen(common_config('site', 'sslserver')) > 0) {
 742             $serverpart = common_config('site', 'sslserver');
 743         } else {
 744             $serverpart = common_config('site', 'server');
 745         }
 746     } else {
 747         $proto = 'http';
 748         $serverpart = common_config('site', 'server');
 749     }
 750
 751     return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
 752 }
 753
 754 function common_date_string($dt)
 755 {
 756     // XXX: do some sexy date formatting
 757     // return date(DATE_RFC822, $dt);
 758     $t = strtotime($dt);
 759     $now = time();
 760     $diff = $now - $t;
 761
 762     if ($now < $t) { // that shouldn't happen!
 763         return common_exact_date($dt);
 764     } else if ($diff < 60) {
 765         return _('a few seconds ago');
 766     } else if ($diff < 92) {
 767         return _('about a minute ago');
 768     } else if ($diff < 3300) {
 769         return sprintf(_('about %d minutes ago'), round($diff/60));
 770     } else if ($diff < 5400) {
 771         return _('about an hour ago');
 772     } else if ($diff < 22 * 3600) {
 773         return sprintf(_('about %d hours ago'), round($diff/3600));
 774     } else if ($diff < 37 * 3600) {
 775         return _('about a day ago');
 776     } else if ($diff < 24 * 24 * 3600) {
 777         return sprintf(_('about %d days ago'), round($diff/(24*3600)));
 778     } else if ($diff < 46 * 24 * 3600) {
 779         return _('about a month ago');
 780     } else if ($diff < 330 * 24 * 3600) {
 781         return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
 782     } else if ($diff < 480 * 24 * 3600) {
 783         return _('about a year ago');
 784     } else {
 785         return common_exact_date($dt);
 786     }
 787 }
 788
 789 function common_exact_date($dt)
 790 {
 791     static $_utc;
 792     static $_siteTz;
 793
 794     if (!$_utc) {
 795         $_utc = new DateTimeZone('UTC');
 796         $_siteTz = new DateTimeZone(common_timezone());
 797     }
 798
 799     $dateStr = date('d F Y H:i:s', strtotime($dt));
 800     $d = new DateTime($dateStr, $_utc);
 801     $d->setTimezone($_siteTz);
 802     return $d->format(DATE_RFC850);
 803 }
 804
 805 function common_date_w3dtf($dt)
 806 {
 807     $dateStr = date('d F Y H:i:s', strtotime($dt));
 808     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 809     $d->setTimezone(new DateTimeZone(common_timezone()));
 810     return $d->format(DATE_W3C);
 811 }
 812
 813 function common_date_rfc2822($dt)
 814 {
 815     $dateStr = date('d F Y H:i:s', strtotime($dt));
 816     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 817     $d->setTimezone(new DateTimeZone(common_timezone()));
 818     return $d->format('r');
 819 }
 820
 821 function common_date_iso8601($dt)
 822 {
 823     $dateStr = date('d F Y H:i:s', strtotime($dt));
 824     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 825     $d->setTimezone(new DateTimeZone(common_timezone()));
 826     return $d->format('c');
 827 }
 828
 829 function common_sql_now()
 830 {
 831     return common_sql_date(time());
 832 }
 833
 834 function common_sql_date($datetime)
 835 {
 836     return strftime('%Y-%m-%d %H:%M:%S', $datetime);
 837 }
 838
 839 function common_redirect($url, $code=307)
 840 {
 841     static $status = array(301 => "Moved Permanently",
 842                            302 => "Found",
 843                            303 => "See Other",
 844                            307 => "Temporary Redirect");
 845
 846     header('HTTP/1.1 '.$code.' '.$status[$code]);
 847     header("Location: $url");
 848
 849     $xo = new XMLOutputter();
 850     $xo->startXML('a',
 851                   '-//W3C//DTD XHTML 1.0 Strict//EN',
 852                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
 853     $xo->element('a', array('href' => $url), $url);
 854     $xo->endXML();
 855     exit;
 856 }
 857
 858 function common_broadcast_notice($notice, $remote=false)
 859 {
 860     return common_enqueue_notice($notice);
 861 }
 862
 863 // Stick the notice on the queue
 864
 865 function common_enqueue_notice($notice)
 866 {
 867     static $localTransports = array('omb',
 868                                     'twitter',
 869                                     'facebook',
 870                                     'ping');
 871     static $allTransports = array('sms');
 872
 873     $transports = $allTransports;
 874
 875     $xmpp = common_config('xmpp', 'enabled');
 876
 877     if ($xmpp) {
 878         $transports[] = 'jabber';
 879     }
 880
 881     if ($notice->is_local == Notice::LOCAL_PUBLIC ||
 882         $notice->is_local == Notice::LOCAL_NONPUBLIC) {
 883         $transports = array_merge($transports, $localTransports);
 884         if ($xmpp) {
 885             $transports[] = 'public';
 886         }
 887     }
 888
 889     $qm = QueueManager::get();
 890
 891     foreach ($transports as $transport)
 892     {
 893         $qm->enqueue($notice, $transport);
 894     }
 895
 896     return true;
 897 }
 898
 899 function common_broadcast_profile($profile)
 900 {
 901     // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
 902     require_once(INSTALLDIR.'/lib/omb.php');
 903     omb_broadcast_profile($profile);
 904     // XXX: Other broadcasts...?
 905     return true;
 906 }
 907
 908 function common_profile_url($nickname)
 909 {
 910     return common_local_url('showstream', array('nickname' => $nickname));
 911 }
 912
 913 // Should make up a reasonable root URL
 914
 915 function common_root_url($ssl=false)
 916 {
 917     return common_path('', $ssl);
 918 }
 919
 920 // returns $bytes bytes of random data as a hexadecimal string
 921 // "good" here is a goal and not a guarantee
 922
 923 function common_good_rand($bytes)
 924 {
 925     // XXX: use random.org...?
 926     if (@file_exists('/dev/urandom')) {
 927         return common_urandom($bytes);
 928     } else { // FIXME: this is probably not good enough
 929         return common_mtrand($bytes);
 930     }
 931 }
 932
 933 function common_urandom($bytes)
 934 {
 935     $h = fopen('/dev/urandom', 'rb');
 936     // should not block
 937     $src = fread($h, $bytes);
 938     fclose($h);
 939     $enc = '';
 940     for ($i = 0; $i < $bytes; $i++) {
 941         $enc .= sprintf("%02x", (ord($src[$i])));
 942     }
 943     return $enc;
 944 }
 945
 946 function common_mtrand($bytes)
 947 {
 948     $enc = '';
 949     for ($i = 0; $i < $bytes; $i++) {
 950         $enc .= sprintf("%02x", mt_rand(0, 255));
 951     }
 952     return $enc;
 953 }
 954
 955 function common_set_returnto($url)
 956 {
 957     common_ensure_session();
 958     $_SESSION['returnto'] = $url;
 959 }
 960
 961 function common_get_returnto()
 962 {
 963     common_ensure_session();
 964     return $_SESSION['returnto'];
 965 }
 966
 967 function common_timestamp()
 968 {
 969     return date('YmdHis');
 970 }
 971
 972 function common_ensure_syslog()
 973 {
 974     static $initialized = false;
 975     if (!$initialized) {
 976         openlog(common_config('syslog', 'appname'), 0,
 977             common_config('syslog', 'facility'));
 978         $initialized = true;
 979     }
 980 }
 981
 982 function common_log_line($priority, $msg)
 983 {
 984     static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
 985                                       'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
 986     return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
 987 }
 988
 989 function common_log($priority, $msg, $filename=null)
 990 {
 991     $logfile = common_config('site', 'logfile');
 992     if ($logfile) {
 993         $log = fopen($logfile, "a");
 994         if ($log) {
 995             $output = common_log_line($priority, $msg);
 996             fwrite($log, $output);
 997             fclose($log);
 998         }
 999     } else {
1000         common_ensure_syslog();
1001         syslog($priority, $msg);
1002     }
1003 }
1004
1005 function common_debug($msg, $filename=null)
1006 {
1007     if ($filename) {
1008         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1009     } else {
1010         common_log(LOG_DEBUG, $msg);
1011     }
1012 }
1013
1014 function common_log_db_error(&$object, $verb, $filename=null)
1015 {
1016     $objstr = common_log_objstring($object);
1017     $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1018     common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1019 }
1020
1021 function common_log_objstring(&$object)
1022 {
1023     if (is_null($object)) {
1024         return "null";
1025     }
1026     if (!($object instanceof DB_DataObject)) {
1027         return "(unknown)";
1028     }
1029     $arr = $object->toArray();
1030     $fields = array();
1031     foreach ($arr as $k => $v) {
1032         $fields[] = "$k='$v'";
1033     }
1034     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1035     return $objstring;
1036 }
1037
1038 function common_valid_http_url($url)
1039 {
1040     return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1041 }
1042
1043 function common_valid_tag($tag)
1044 {
1045     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1046         return (Validate::email($matches[1]) ||
1047                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1048     }
1049     return false;
1050 }
1051
1052 /* Following functions are copied from MediaWiki GlobalFunctions.php
1053  * and written by Evan Prodromou. */
1054
1055 function common_accept_to_prefs($accept, $def = '*/*')
1056 {
1057     // No arg means accept anything (per HTTP spec)
1058     if(!$accept) {
1059         return array($def => 1);
1060     }
1061
1062     $prefs = array();
1063
1064     $parts = explode(',', $accept);
1065
1066     foreach($parts as $part) {
1067         // FIXME: doesn't deal with params like 'text/html; level=1'
1068         @list($value, $qpart) = explode(';', trim($part));
1069         $match = array();
1070         if(!isset($qpart)) {
1071             $prefs[$value] = 1;
1072         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1073             $prefs[$value] = $match[1];
1074         }
1075     }
1076
1077     return $prefs;
1078 }
1079
1080 function common_mime_type_match($type, $avail)
1081 {
1082     if(array_key_exists($type, $avail)) {
1083         return $type;
1084     } else {
1085         $parts = explode('/', $type);
1086         if(array_key_exists($parts[0] . '/*', $avail)) {
1087             return $parts[0] . '/*';
1088         } elseif(array_key_exists('*/*', $avail)) {
1089             return '*/*';
1090         } else {
1091             return null;
1092         }
1093     }
1094 }
1095
1096 function common_negotiate_type($cprefs, $sprefs)
1097 {
1098     $combine = array();
1099
1100     foreach(array_keys($sprefs) as $type) {
1101         $parts = explode('/', $type);
1102         if($parts[1] != '*') {
1103             $ckey = common_mime_type_match($type, $cprefs);
1104             if($ckey) {
1105                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1106             }
1107         }
1108     }
1109
1110     foreach(array_keys($cprefs) as $type) {
1111         $parts = explode('/', $type);
1112         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1113             $skey = common_mime_type_match($type, $sprefs);
1114             if($skey) {
1115                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1116             }
1117         }
1118     }
1119
1120     $bestq = 0;
1121     $besttype = 'text/html';
1122
1123     foreach(array_keys($combine) as $type) {
1124         if($combine[$type] > $bestq) {
1125             $besttype = $type;
1126             $bestq = $combine[$type];
1127         }
1128     }
1129
1130     if ('text/html' === $besttype) {
1131         return "text/html; charset=utf-8";
1132     }
1133     return $besttype;
1134 }
1135
1136 function common_config($main, $sub)
1137 {
1138     global $config;
1139     return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1140 }
1141
1142 function common_copy_args($from)
1143 {
1144     $to = array();
1145     $strip = get_magic_quotes_gpc();
1146     foreach ($from as $k => $v) {
1147         $to[$k] = ($strip) ? stripslashes($v) : $v;
1148     }
1149     return $to;
1150 }
1151
1152 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1153 // This is used before handing a request off to OAuthRequest::from_request.
1154 function common_remove_magic_from_request()
1155 {
1156     if(get_magic_quotes_gpc()) {
1157         $_POST=array_map('stripslashes',$_POST);
1158         $_GET=array_map('stripslashes',$_GET);
1159     }
1160 }
1161
1162 function common_user_uri(&$user)
1163 {
1164     return common_local_url('userbyid', array('id' => $user->id));
1165 }
1166
1167 function common_notice_uri(&$notice)
1168 {
1169     return common_local_url('shownotice',
1170                             array('notice' => $notice->id));
1171 }
1172
1173 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1174
1175 function common_confirmation_code($bits)
1176 {
1177     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1178     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1179     $chars = ceil($bits/5);
1180     $code = '';
1181     for ($i = 0; $i < $chars; $i++) {
1182         // XXX: convert to string and back
1183         $num = hexdec(common_good_rand(1));
1184         // XXX: randomness is too precious to throw away almost
1185         // 40% of the bits we get!
1186         $code .= $codechars[$num%32];
1187     }
1188     return $code;
1189 }
1190
1191 // convert markup to HTML
1192
1193 function common_markup_to_html($c)
1194 {
1195     $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1196     $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1197     $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1198     return Markdown($c);
1199 }
1200
1201 function common_profile_uri($profile)
1202 {
1203     if (!$profile) {
1204         return null;
1205     }
1206     $user = User::staticGet($profile->id);
1207     if ($user) {
1208         return $user->uri;
1209     }
1210
1211     $remote = Remote_profile::staticGet($profile->id);
1212     if ($remote) {
1213         return $remote->uri;
1214     }
1215     // XXX: this is a very bad profile!
1216     return null;
1217 }
1218
1219 function common_canonical_sms($sms)
1220 {
1221     // strip non-digits
1222     preg_replace('/\D/', '', $sms);
1223     return $sms;
1224 }
1225
1226 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1227 {
1228     switch ($errno) {
1229
1230      case E_ERROR:
1231      case E_COMPILE_ERROR:
1232      case E_CORE_ERROR:
1233      case E_USER_ERROR:
1234      case E_PARSE:
1235      case E_RECOVERABLE_ERROR:
1236         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
1237         die();
1238         break;
1239
1240      case E_WARNING:
1241      case E_COMPILE_WARNING:
1242      case E_CORE_WARNING:
1243      case E_USER_WARNING:
1244         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1245         break;
1246
1247      case E_NOTICE:
1248      case E_USER_NOTICE:
1249         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1250         break;
1251
1252      case E_STRICT:
1253      case E_DEPRECATED:
1254      case E_USER_DEPRECATED:
1255         // XXX: config variable to log this stuff, too
1256         break;
1257
1258      default:
1259         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
1260         die();
1261         break;
1262     }
1263
1264     // FIXME: show error page if we're on the Web
1265     /* Don't execute PHP internal error handler */
1266     return true;
1267 }
1268
1269 function common_session_token()
1270 {
1271     common_ensure_session();
1272     if (!array_key_exists('token', $_SESSION)) {
1273         $_SESSION['token'] = common_good_rand(64);
1274     }
1275     return $_SESSION['token'];
1276 }
1277
1278 function common_cache_key($extra)
1279 {
1280     $base_key = common_config('memcached', 'base');
1281
1282     if (empty($base_key)) {
1283         $base_key = common_keyize(common_config('site', 'name'));
1284     }
1285
1286     return 'laconica:' . $base_key . ':' . $extra;
1287 }
1288
1289 function common_keyize($str)
1290 {
1291     $str = strtolower($str);
1292     $str = preg_replace('/\s/', '_', $str);
1293     return $str;
1294 }
1295
1296 function common_memcache()
1297 {
1298     static $cache = null;
1299     if (!common_config('memcached', 'enabled')) {
1300         return null;
1301     } else {
1302         if (!$cache) {
1303             $cache = new Memcache();
1304             $servers = common_config('memcached', 'server');
1305             if (is_array($servers)) {
1306                 foreach($servers as $server) {
1307                     $cache->addServer($server);
1308                 }
1309             } else {
1310                 $cache->addServer($servers);
1311             }
1312         }
1313         return $cache;
1314     }
1315 }
1316
1317 function common_compatible_license($from, $to)
1318 {
1319     // XXX: better compatibility check needed here!
1320     return ($from == $to);
1321 }
1322
1323 /**
1324  * returns a quoted table name, if required according to config
1325  */
1326 function common_database_tablename($tablename)
1327 {
1328
1329   if(common_config('db','quote_identifiers')) {
1330       $tablename = '"'. $tablename .'"';
1331   }
1332   //table prefixes could be added here later
1333   return $tablename;
1334 }
1335
1336 function common_shorten_url($long_url)
1337 {
1338     $user = common_current_user();
1339     if (empty($user)) {
1340         // common current user does not find a user when called from the XMPP daemon
1341         // therefore we'll set one here fix, so that XMPP given URLs may be shortened
1342         $svc = 'ur1.ca';
1343     } else {
1344         $svc = $user->urlshorteningservice;
1345     }
1346
1347     $curlh = curl_init();
1348     curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
1349     curl_setopt($curlh, CURLOPT_USERAGENT, 'Laconica');
1350     curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
1351
1352     switch($svc) {
1353      case 'ur1.ca':
1354         require_once INSTALLDIR.'/lib/Shorturl_api.php';
1355         $short_url_service = new LilUrl;
1356         $short_url = $short_url_service->shorten($long_url);
1357         break;
1358
1359      case '2tu.us':
1360         $short_url_service = new TightUrl;
1361         require_once INSTALLDIR.'/lib/Shorturl_api.php';
1362         $short_url = $short_url_service->shorten($long_url);
1363         break;
1364
1365      case 'ptiturl.com':
1366         require_once INSTALLDIR.'/lib/Shorturl_api.php';
1367         $short_url_service = new PtitUrl;
1368         $short_url = $short_url_service->shorten($long_url);
1369         break;
1370
1371      case 'bit.ly':
1372         curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($long_url));
1373         $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
1374         break;
1375
1376      case 'is.gd':
1377         curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($long_url));
1378         $short_url = curl_exec($curlh);
1379         break;
1380      case 'snipr.com':
1381         curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($long_url));
1382         $short_url = curl_exec($curlh);
1383         break;
1384      case 'metamark.net':
1385         curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($long_url));
1386         $short_url = curl_exec($curlh);
1387         break;
1388      case 'tinyurl.com':
1389         curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($long_url));
1390         $short_url = curl_exec($curlh);
1391         break;
1392      default:
1393         $short_url = false;
1394     }
1395
1396     curl_close($curlh);
1397
1398     return $short_url;
1399 }
1400
1401 function common_client_ip()
1402 {
1403     if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
1404         return null;
1405     }
1406
1407     if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
1408         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1409             $proxy = $_SERVER['HTTP_CLIENT_IP'];
1410         } else {
1411             $proxy = $_SERVER['REMOTE_ADDR'];
1412         }
1413         $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
1414     } else {
1415         $proxy = null;
1416         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1417             $ip = $_SERVER['HTTP_CLIENT_IP'];
1418         } else {
1419             $ip = $_SERVER['REMOTE_ADDR'];
1420         }
1421     }
1422
1423     return array($proxy, $ip);
1424 }