lib/util.php

   1 <?php
   2 /*
   3  * Laconica - a distributed open-source microblogging tool
   4  * Copyright (C) 2008, Controlez-Vous, 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     global $config;
  76     return $config['site']['timezone'];
  77 }
  78
  79 function common_language()
  80 {
  81
  82     // If there is a user logged in and they've set a language preference
  83     // then return that one...
  84     if (common_logged_in()) {
  85         $user = common_current_user();
  86         $user_language = $user->language;
  87         if ($user_language)
  88           return $user_language;
  89     }
  90
  91     // Otherwise, find the best match for the languages requested by the
  92     // user's browser...
  93     $httplang = isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? $_SERVER['HTTP_ACCEPT_LANGUAGE'] : null;
  94     if (!empty($httplang)) {
  95         $language = client_prefered_language($httplang);
  96         if ($language)
  97           return $language;
  98     }
  99
 100     // Finally, if none of the above worked, use the site's default...
 101     return common_config('site', 'language');
 102 }
 103 // salted, hashed passwords are stored in the DB
 104
 105 function common_munge_password($password, $id)
 106 {
 107     return md5($password . $id);
 108 }
 109
 110 // check if a username exists and has matching password
 111 function common_check_user($nickname, $password)
 112 {
 113     // NEVER allow blank passwords, even if they match the DB
 114     if (mb_strlen($password) == 0) {
 115         return false;
 116     }
 117     $user = User::staticGet('nickname', $nickname);
 118     if (is_null($user)) {
 119         return false;
 120     } else {
 121         if (0 == strcmp(common_munge_password($password, $user->id),
 122                         $user->password)) {
 123             return $user;
 124         } else {
 125             return false;
 126         }
 127     }
 128 }
 129
 130 // is the current user logged in?
 131 function common_logged_in()
 132 {
 133     return (!is_null(common_current_user()));
 134 }
 135
 136 function common_have_session()
 137 {
 138     return (0 != strcmp(session_id(), ''));
 139 }
 140
 141 function common_ensure_session()
 142 {
 143     if (!common_have_session()) {
 144         @session_start();
 145     }
 146 }
 147
 148 // Three kinds of arguments:
 149 // 1) a user object
 150 // 2) a nickname
 151 // 3) null to clear
 152
 153 // Initialize to false; set to null if none found
 154
 155 $_cur = false;
 156
 157 function common_set_user($user)
 158 {
 159
 160     global $_cur;
 161
 162     if (is_null($user) && common_have_session()) {
 163         $_cur = null;
 164         unset($_SESSION['userid']);
 165         return true;
 166     } else if (is_string($user)) {
 167         $nickname = $user;
 168         $user = User::staticGet('nickname', $nickname);
 169     } else if (!($user instanceof User)) {
 170         return false;
 171     }
 172
 173     if ($user) {
 174         common_ensure_session();
 175         $_SESSION['userid'] = $user->id;
 176         $_cur = $user;
 177         return $_cur;
 178     }
 179     return false;
 180 }
 181
 182 function common_set_cookie($key, $value, $expiration=0)
 183 {
 184     $path = common_config('site', 'path');
 185     $server = common_config('site', 'server');
 186
 187     if ($path && ($path != '/')) {
 188         $cookiepath = '/' . $path . '/';
 189     } else {
 190         $cookiepath = '/';
 191     }
 192     return setcookie($key,
 193                      $value,
 194                      $expiration,
 195                      $cookiepath,
 196                      $server);
 197 }
 198
 199 define('REMEMBERME', 'rememberme');
 200 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
 201
 202 function common_rememberme($user=null)
 203 {
 204     if (!$user) {
 205         $user = common_current_user();
 206         if (!$user) {
 207             common_debug('No current user to remember', __FILE__);
 208             return false;
 209         }
 210     }
 211
 212     $rm = new Remember_me();
 213
 214     $rm->code = common_good_rand(16);
 215     $rm->user_id = $user->id;
 216
 217     // Wrap the insert in some good ol' fashioned transaction code
 218
 219     $rm->query('BEGIN');
 220
 221     $result = $rm->insert();
 222
 223     if (!$result) {
 224         common_log_db_error($rm, 'INSERT', __FILE__);
 225         common_debug('Error adding rememberme record for ' . $user->nickname, __FILE__);
 226         return false;
 227     }
 228
 229     $rm->query('COMMIT');
 230
 231     common_debug('Inserted rememberme record (' . $rm->code . ', ' . $rm->user_id . '); result = ' . $result . '.', __FILE__);
 232
 233     $cookieval = $rm->user_id . ':' . $rm->code;
 234
 235     common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
 236
 237     common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
 238
 239     return true;
 240 }
 241
 242 function common_remembered_user()
 243 {
 244
 245     $user = null;
 246
 247     $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
 248
 249     if (!$packed) {
 250         return null;
 251     }
 252
 253     list($id, $code) = explode(':', $packed);
 254
 255     if (!$id || !$code) {
 256         common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
 257         common_forgetme();
 258         return null;
 259     }
 260
 261     $rm = Remember_me::staticGet($code);
 262
 263     if (!$rm) {
 264         common_log(LOG_WARNING, 'No such remember code: ' . $code);
 265         common_forgetme();
 266         return null;
 267     }
 268
 269     if ($rm->user_id != $id) {
 270         common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
 271         common_forgetme();
 272         return null;
 273     }
 274
 275     $user = User::staticGet($rm->user_id);
 276
 277     if (!$user) {
 278         common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
 279         common_forgetme();
 280         return null;
 281     }
 282
 283     // successful!
 284     $result = $rm->delete();
 285
 286     if (!$result) {
 287         common_log_db_error($rm, 'DELETE', __FILE__);
 288         common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
 289         common_forgetme();
 290         return null;
 291     }
 292
 293     common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
 294
 295     common_set_user($user);
 296     common_real_login(false);
 297
 298     // We issue a new cookie, so they can log in
 299     // automatically again after this session
 300
 301     common_rememberme($user);
 302
 303     return $user;
 304 }
 305
 306 // must be called with a valid user!
 307
 308 function common_forgetme()
 309 {
 310     common_set_cookie(REMEMBERME, '', 0);
 311 }
 312
 313 // who is the current user?
 314 function common_current_user()
 315 {
 316     global $_cur;
 317
 318     if ($_cur === false) {
 319
 320         if (isset($_REQUEST[session_name()]) || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
 321             common_ensure_session();
 322             $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
 323             if ($id) {
 324                 $_cur = User::staticGet($id);
 325                 return $_cur;
 326             }
 327         }
 328
 329         // that didn't work; try to remember; will init $_cur to null on failure
 330         $_cur = common_remembered_user();
 331
 332         if ($_cur) {
 333             common_debug("Got User " . $_cur->nickname);
 334             common_debug("Faking session on remembered user");
 335             // XXX: Is this necessary?
 336             $_SESSION['userid'] = $_cur->id;
 337         }
 338     }
 339
 340     return $_cur;
 341 }
 342
 343 // Logins that are 'remembered' aren't 'real' -- they're subject to
 344 // cookie-stealing. So, we don't let them do certain things. New reg,
 345 // OpenID, and password logins _are_ real.
 346
 347 function common_real_login($real=true)
 348 {
 349     common_ensure_session();
 350     $_SESSION['real_login'] = $real;
 351 }
 352
 353 function common_is_real_login()
 354 {
 355     return common_logged_in() && $_SESSION['real_login'];
 356 }
 357
 358 // get canonical version of nickname for comparison
 359 function common_canonical_nickname($nickname)
 360 {
 361     // XXX: UTF-8 canonicalization (like combining chars)
 362     return strtolower($nickname);
 363 }
 364
 365 // get canonical version of email for comparison
 366 function common_canonical_email($email)
 367 {
 368     // XXX: canonicalize UTF-8
 369     // XXX: lcase the domain part
 370     return $email;
 371 }
 372
 373 function common_render_content($text, $notice)
 374 {
 375     $r = common_render_text($text);
 376     $id = $notice->profile_id;
 377     $r = preg_replace('/(^|\s+)@([A-Za-z0-9]{1,64})/e', "'\\1@'.common_at_link($id, '\\2')", $r);
 378     $r = preg_replace('/^T ([A-Z0-9]{1,64}) /e', "'T '.common_at_link($id, '\\1').' '", $r);
 379     $r = preg_replace('/(^|\s+)@#([A-Za-z0-9]{1,64})/e', "'\\1@#'.common_at_hash_link($id, '\\2')", $r);
 380     $r = preg_replace('/(^|\s)!([A-Za-z0-9]{1,64})/e', "'\\1!'.common_group_link($id, '\\2')", $r);
 381     return $r;
 382 }
 383
 384 function common_render_text($text)
 385 {
 386     $r = htmlspecialchars($text);
 387
 388     $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
 389     $r = common_replace_urls_callback($r, 'common_linkify');
 390     $r = preg_replace('/(^|\(|\[|\s+)#([A-Za-z0-9_\-\.]{1,64})/e', "'\\1#'.common_tag_link('\\2')", $r);
 391     // XXX: machine tags
 392     return $r;
 393 }
 394
 395 function common_replace_urls_callback($text, $callback) {
 396     // Start off with a regex
 397     $regex = '#'.
 398     '(?:'.
 399         '(?:'.
 400             '(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|xmpp|irc)://'.
 401             '|'.
 402             '(?:mailto|aim|tel):'.
 403         ')'.
 404         '[^.\s]+\.[^\s]+'.
 405         '|'.
 406         '(?:[^.\s/:]+\.)+'.
 407         '(?:museum|travel|[a-z]{2,4})'.
 408         '(?:[:/][^\s]*)?'.
 409     ')'.
 410     '#ix';
 411     preg_match_all($regex, $text, $matches);
 412
 413     // Then clean up what the regex left behind
 414     $offset = 0;
 415     foreach($matches[0] as $orig_url) {
 416         $url = htmlspecialchars_decode($orig_url);
 417
 418         // Make sure we didn't pick up an email address
 419         if (preg_match('#^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}$#i', $url)) continue;
 420
 421         // Remove surrounding punctuation
 422         $url = trim($url, '.?!,;:\'"`([<');
 423
 424         // Remove surrounding parens and the like
 425         preg_match('/[)\]>]+$/', $url, $trailing);
 426         if (isset($trailing[0])) {
 427             preg_match_all('/[(\[<]/', $url, $opened);
 428             preg_match_all('/[)\]>]/', $url, $closed);
 429             $unopened = count($closed[0]) - count($opened[0]);
 430
 431             // Make sure not to take off more closing parens than there are at the end
 432             $unopened = ($unopened > mb_strlen($trailing[0])) ? mb_strlen($trailing[0]):$unopened;
 433
 434             $url = ($unopened > 0) ? mb_substr($url, 0, $unopened * -1):$url;
 435         }
 436
 437         // Remove trailing punctuation again (in case there were some inside parens)
 438         $url = rtrim($url, '.?!,;:\'"`');
 439
 440         // Make sure we didn't capture part of the next sentence
 441         preg_match('#((?:[^.\s/]+\.)+)(museum|travel|[a-z]{2,4})#i', $url, $url_parts);
 442
 443         // Were the parts capitalized any?
 444         $last_part = (mb_strtolower($url_parts[2]) !== $url_parts[2]) ? true:false;
 445         $prev_part = (mb_strtolower($url_parts[1]) !== $url_parts[1]) ? true:false;
 446
 447         // If the first part wasn't cap'd but the last part was, we captured too much
 448         if ((!$prev_part && $last_part)) {
 449             $url = mb_substr($url, 0 , mb_strpos($url, '.'.$url_parts['2'], 0));
 450         }
 451
 452         // Capture the new TLD
 453         preg_match('#((?:[^.\s/]+\.)+)(museum|travel|[a-z]{2,4})#i', $url, $url_parts);
 454
 455         $tlds = array('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', 'ye', 'yt', 'yu', 'za', 'zm', 'zw');
 456
 457         if (!in_array($url_parts[2], $tlds)) continue;
 458
 459         // Put the url back the way we found it.
 460         $url = (mb_strpos($orig_url, htmlspecialchars($url)) === FALSE) ? $url:htmlspecialchars($url);
 461
 462         // Call user specified func
 463         $modified_url = $callback($url);
 464
 465         // Replace it!
 466         $start = mb_strpos($text, $url, $offset);
 467         $text = mb_substr($text, 0, $start).$modified_url.mb_substr($text, $start + mb_strlen($url), mb_strlen($text));
 468         $offset = $start + mb_strlen($modified_url);
 469     }
 470
 471     return $text;
 472 }
 473
 474 function common_linkify($url) {
 475     // It comes in special'd, so we unspecial it before passing to the stringifying
 476     // functions
 477     $ext = pathinfo($url, PATHINFO_EXTENSION);
 478     $url = htmlspecialchars_decode($url);
 479     $video_ext = array('mp4', 'flv', 'avi', 'mpg', 'mp3', 'ogg');
 480     $display = $url;
 481     $url = (!preg_match('#^([a-z]+://|(mailto|aim|tel):)#i', $url)) ? 'http://'.$url : $url;
 482
 483     $attrs = array('href' => $url, 'rel' => 'external');
 484
 485     if (in_array($ext, $video_ext)) {
 486         $attrs['class'] = 'media';
 487     }
 488
 489     if ($longurl = common_longurl($url)) {
 490         $attrs['title'] = $longurl;
 491     }
 492
 493     return XMLStringer::estring('a', $attrs, $display);
 494 }
 495
 496 function common_longurl($short_url)
 497 {
 498     $long_url = common_shorten_link($short_url, true);
 499     if ($long_url === $short_url) return false;
 500     return $long_url;
 501 }
 502
 503 function common_longurl2($uri)
 504 {
 505     $uri_e = urlencode($uri);
 506     $longurl = unserialize(file_get_contents("http://api.longurl.org/v1/expand?format=php&url=$uri_e"));
 507     if (empty($longurl['long_url']) || $uri === $longurl['long_url']) return false;
 508     return stripslashes($longurl['long_url']);
 509 }
 510
 511 function common_shorten_links($text)
 512 {
 513     if (mb_strlen($text) <= 140) return $text;
 514     static $cache = array();
 515     if (isset($cache[$text])) return $cache[$text];
 516     // \s = not a horizontal whitespace character (since PHP 5.2.4)
 517     return $cache[$text] = common_replace_urls_callback($text, 'common_shorten_link');;
 518 }
 519
 520 function common_shorten_link($url, $reverse = false)
 521 {
 522     static $url_cache = array();
 523     if ($reverse) return isset($url_cache[$url]) ? $url_cache[$url] : $url;
 524
 525     $user = common_current_user();
 526
 527     $curlh = curl_init();
 528     curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
 529     curl_setopt($curlh, CURLOPT_USERAGENT, 'Laconica');
 530     curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
 531
 532     switch($user->urlshorteningservice) {
 533      case 'ur1.ca':
 534         $short_url_service = new LilUrl;
 535         $short_url = $short_url_service->shorten($url);
 536         break;
 537
 538      case '2tu.us':
 539         $short_url_service = new TightUrl;
 540         $short_url = $short_url_service->shorten($url);
 541         break;
 542
 543      case 'ptiturl.com':
 544         $short_url_service = new PtitUrl;
 545         $short_url = $short_url_service->shorten($url);
 546         break;
 547
 548      case 'bit.ly':
 549         curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($url));
 550         $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
 551         break;
 552
 553      case 'is.gd':
 554         curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($url));
 555         $short_url = curl_exec($curlh);
 556         break;
 557      case 'snipr.com':
 558         curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($url));
 559         $short_url = curl_exec($curlh);
 560         break;
 561      case 'metamark.net':
 562         curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($url));
 563         $short_url = curl_exec($curlh);
 564         break;
 565      case 'tinyurl.com':
 566         curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($url));
 567         $short_url = curl_exec($curlh);
 568         break;
 569      default:
 570         $short_url = false;
 571     }
 572
 573     curl_close($curlh);
 574
 575     if ($short_url) {
 576         $url_cache[(string)$short_url] = $url;
 577         return (string)$short_url;
 578     }
 579     return $url;
 580 }
 581
 582 function common_xml_safe_str($str)
 583 {
 584     $xmlStr = htmlentities(iconv('UTF-8', 'UTF-8//IGNORE', $str), ENT_NOQUOTES, 'UTF-8');
 585
 586     // Replace control, formatting, and surrogate characters with '*', ala Twitter
 587     return preg_replace('/[\p{Cc}\p{Cf}\p{Cs}]/u', '*', $str);
 588 }
 589
 590 function common_tag_link($tag)
 591 {
 592     $canonical = common_canonical_tag($tag);
 593     $url = common_local_url('tag', array('tag' => $canonical));
 594     $xs = new XMLStringer();
 595     $xs->elementStart('span', 'tag');
 596     $xs->element('a', array('href' => $url,
 597                             'rel' => 'tag'),
 598                  $tag);
 599     $xs->elementEnd();
 600     return $xs->getString();
 601 }
 602
 603 function common_canonical_tag($tag)
 604 {
 605     return strtolower(str_replace(array('-', '_', '.'), '', $tag));
 606 }
 607
 608 function common_valid_profile_tag($str)
 609 {
 610     return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
 611 }
 612
 613 function common_at_link($sender_id, $nickname)
 614 {
 615     $sender = Profile::staticGet($sender_id);
 616     $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
 617     if ($recipient) {
 618         $xs = new XMLStringer(false);
 619         $xs->elementStart('span', 'vcard');
 620         $xs->elementStart('a', array('href' => $recipient->profileurl,
 621                                      'class' => 'url'));
 622         $xs->element('span', 'fn nickname', $nickname);
 623         $xs->elementEnd('a');
 624         $xs->elementEnd('span');
 625         return $xs->getString();
 626     } else {
 627         return $nickname;
 628     }
 629 }
 630
 631 function common_group_link($sender_id, $nickname)
 632 {
 633     $sender = Profile::staticGet($sender_id);
 634     $group = User_group::staticGet('nickname', common_canonical_nickname($nickname));
 635     if ($group && $sender->isMember($group)) {
 636         $xs = new XMLStringer();
 637         $xs->elementStart('span', 'vcard');
 638         $xs->elementStart('a', array('href' => $group->permalink(),
 639                                      'class' => 'url'));
 640         $xs->element('span', 'fn nickname', $nickname);
 641         $xs->elementEnd('a');
 642         $xs->elementEnd('span');
 643         return $xs->getString();
 644     } else {
 645         return $nickname;
 646     }
 647 }
 648
 649 function common_at_hash_link($sender_id, $tag)
 650 {
 651     $user = User::staticGet($sender_id);
 652     if (!$user) {
 653         return $tag;
 654     }
 655     $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
 656     if ($tagged) {
 657         $url = common_local_url('subscriptions',
 658                                 array('nickname' => $user->nickname,
 659                                       'tag' => $tag));
 660         $xs = new XMLStringer();
 661         $xs->elementStart('span', 'tag');
 662         $xs->element('a', array('href' => $url,
 663                                 'rel' => $tag),
 664                      $tag);
 665         $xs->elementEnd('span');
 666         return $xs->getString();
 667     } else {
 668         return $tag;
 669     }
 670 }
 671
 672 function common_relative_profile($sender, $nickname, $dt=null)
 673 {
 674     // Try to find profiles this profile is subscribed to that have this nickname
 675     $recipient = new Profile();
 676     // XXX: use a join instead of a subquery
 677     $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
 678     $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
 679     if ($recipient->find(true)) {
 680         // XXX: should probably differentiate between profiles with
 681         // the same name by date of most recent update
 682         return $recipient;
 683     }
 684     // Try to find profiles that listen to this profile and that have this nickname
 685     $recipient = new Profile();
 686     // XXX: use a join instead of a subquery
 687     $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
 688     $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
 689     if ($recipient->find(true)) {
 690         // XXX: should probably differentiate between profiles with
 691         // the same name by date of most recent update
 692         return $recipient;
 693     }
 694     // If this is a local user, try to find a local user with that nickname.
 695     $sender = User::staticGet($sender->id);
 696     if ($sender) {
 697         $recipient_user = User::staticGet('nickname', $nickname);
 698         if ($recipient_user) {
 699             return $recipient_user->getProfile();
 700         }
 701     }
 702     // Otherwise, no links. @messages from local users to remote users,
 703     // or from remote users to other remote users, are just
 704     // outside our ability to make intelligent guesses about
 705     return null;
 706 }
 707
 708 function common_local_url($action, $args=null, $fragment=null)
 709 {
 710     $r = Router::get();
 711     $path = $r->build($action, $args, $fragment);
 712     if ($path) {
 713     }
 714     if (common_config('site','fancy')) {
 715         $url = common_path(mb_substr($path, 1));
 716     } else {
 717         $url = common_path('index.php'.$path);
 718     }
 719     return $url;
 720 }
 721
 722 function common_path($relative)
 723 {
 724     global $config;
 725     $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
 726     return "http://".$config['site']['server'].'/'.$pathpart.$relative;
 727 }
 728
 729 function common_date_string($dt)
 730 {
 731     // XXX: do some sexy date formatting
 732     // return date(DATE_RFC822, $dt);
 733     $t = strtotime($dt);
 734     $now = time();
 735     $diff = $now - $t;
 736
 737     if ($now < $t) { // that shouldn't happen!
 738         return common_exact_date($dt);
 739     } else if ($diff < 60) {
 740         return _('a few seconds ago');
 741     } else if ($diff < 92) {
 742         return _('about a minute ago');
 743     } else if ($diff < 3300) {
 744         return sprintf(_('about %d minutes ago'), round($diff/60));
 745     } else if ($diff < 5400) {
 746         return _('about an hour ago');
 747     } else if ($diff < 22 * 3600) {
 748         return sprintf(_('about %d hours ago'), round($diff/3600));
 749     } else if ($diff < 37 * 3600) {
 750         return _('about a day ago');
 751     } else if ($diff < 24 * 24 * 3600) {
 752         return sprintf(_('about %d days ago'), round($diff/(24*3600)));
 753     } else if ($diff < 46 * 24 * 3600) {
 754         return _('about a month ago');
 755     } else if ($diff < 330 * 24 * 3600) {
 756         return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
 757     } else if ($diff < 480 * 24 * 3600) {
 758         return _('about a year ago');
 759     } else {
 760         return common_exact_date($dt);
 761     }
 762 }
 763
 764 function common_exact_date($dt)
 765 {
 766     static $_utc;
 767     static $_siteTz;
 768
 769     if (!$_utc) {
 770         $_utc = new DateTimeZone('UTC');
 771         $_siteTz = new DateTimeZone(common_timezone());
 772     }
 773
 774     $dateStr = date('d F Y H:i:s', strtotime($dt));
 775     $d = new DateTime($dateStr, $_utc);
 776     $d->setTimezone($_siteTz);
 777     return $d->format(DATE_RFC850);
 778 }
 779
 780 function common_date_w3dtf($dt)
 781 {
 782     $dateStr = date('d F Y H:i:s', strtotime($dt));
 783     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 784     $d->setTimezone(new DateTimeZone(common_timezone()));
 785     return $d->format(DATE_W3C);
 786 }
 787
 788 function common_date_rfc2822($dt)
 789 {
 790     $dateStr = date('d F Y H:i:s', strtotime($dt));
 791     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 792     $d->setTimezone(new DateTimeZone(common_timezone()));
 793     return $d->format('r');
 794 }
 795
 796 function common_date_iso8601($dt)
 797 {
 798     $dateStr = date('d F Y H:i:s', strtotime($dt));
 799     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 800     $d->setTimezone(new DateTimeZone(common_timezone()));
 801     return $d->format('c');
 802 }
 803
 804 function common_sql_now()
 805 {
 806     return strftime('%Y-%m-%d %H:%M:%S', time());
 807 }
 808
 809 function common_redirect($url, $code=307)
 810 {
 811     static $status = array(301 => "Moved Permanently",
 812                            302 => "Found",
 813                            303 => "See Other",
 814                            307 => "Temporary Redirect");
 815
 816     header("Status: ${code} $status[$code]");
 817     header("Location: $url");
 818
 819     $xo = new XMLOutputter();
 820     $xo->startXML('a',
 821                   '-//W3C//DTD XHTML 1.0 Strict//EN',
 822                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
 823     $xo->element('a', array('href' => $url), $url);
 824     $xo->endXML();
 825     exit;
 826 }
 827
 828 function common_broadcast_notice($notice, $remote=false)
 829 {
 830     if (common_config('queue', 'enabled')) {
 831         // Do it later!
 832         return common_enqueue_notice($notice);
 833     } else {
 834         return common_real_broadcast($notice, $remote);
 835     }
 836 }
 837
 838 // Stick the notice on the queue
 839
 840 function common_enqueue_notice($notice)
 841 {
 842     foreach (array('jabber', 'omb', 'sms', 'public', 'twitter', 'facebook') as $transport) {
 843         $qi = new Queue_item();
 844         $qi->notice_id = $notice->id;
 845         $qi->transport = $transport;
 846         $qi->created = $notice->created;
 847         $result = $qi->insert();
 848         if (!$result) {
 849             $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
 850             common_log(LOG_ERR, 'DB error inserting queue item: ' . $last_error->message);
 851             return false;
 852         }
 853         common_log(LOG_DEBUG, 'complete queueing notice ID = ' . $notice->id . ' for ' . $transport);
 854     }
 855     return $result;
 856 }
 857
 858 function common_real_broadcast($notice, $remote=false)
 859 {
 860     $success = true;
 861     if (!$remote) {
 862         // Make sure we have the OMB stuff
 863         require_once(INSTALLDIR.'/lib/omb.php');
 864         $success = omb_broadcast_remote_subscribers($notice);
 865         if (!$success) {
 866             common_log(LOG_ERR, 'Error in OMB broadcast for notice ' . $notice->id);
 867         }
 868     }
 869     if ($success) {
 870         require_once(INSTALLDIR.'/lib/jabber.php');
 871         $success = jabber_broadcast_notice($notice);
 872         if (!$success) {
 873             common_log(LOG_ERR, 'Error in jabber broadcast for notice ' . $notice->id);
 874         }
 875     }
 876     if ($success) {
 877         require_once(INSTALLDIR.'/lib/mail.php');
 878         $success = mail_broadcast_notice_sms($notice);
 879         if (!$success) {
 880             common_log(LOG_ERR, 'Error in sms broadcast for notice ' . $notice->id);
 881         }
 882     }
 883     if ($success) {
 884         $success = jabber_public_notice($notice);
 885         if (!$success) {
 886             common_log(LOG_ERR, 'Error in public broadcast for notice ' . $notice->id);
 887         }
 888     }
 889     if ($success) {
 890         $success = broadcast_twitter($notice);
 891         if (!$success) {
 892             common_log(LOG_ERR, 'Error in Twitter broadcast for notice ' . $notice->id);
 893         }
 894     }
 895
 896     // XXX: Do a real-time FB broadcast here?
 897
 898     // XXX: broadcast notices to other IM
 899     return $success;
 900 }
 901
 902 function common_broadcast_profile($profile)
 903 {
 904     // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
 905     require_once(INSTALLDIR.'/lib/omb.php');
 906     omb_broadcast_profile($profile);
 907     // XXX: Other broadcasts...?
 908     return true;
 909 }
 910
 911 function common_profile_url($nickname)
 912 {
 913     return common_local_url('showstream', array('nickname' => $nickname));
 914 }
 915
 916 // Should make up a reasonable root URL
 917
 918 function common_root_url()
 919 {
 920     return common_path('');
 921 }
 922
 923 // returns $bytes bytes of random data as a hexadecimal string
 924 // "good" here is a goal and not a guarantee
 925
 926 function common_good_rand($bytes)
 927 {
 928     // XXX: use random.org...?
 929     if (file_exists('/dev/urandom')) {
 930         return common_urandom($bytes);
 931     } else { // FIXME: this is probably not good enough
 932         return common_mtrand($bytes);
 933     }
 934 }
 935
 936 function common_urandom($bytes)
 937 {
 938     $h = fopen('/dev/urandom', 'rb');
 939     // should not block
 940     $src = fread($h, $bytes);
 941     fclose($h);
 942     $enc = '';
 943     for ($i = 0; $i < $bytes; $i++) {
 944         $enc .= sprintf("%02x", (ord($src[$i])));
 945     }
 946     return $enc;
 947 }
 948
 949 function common_mtrand($bytes)
 950 {
 951     $enc = '';
 952     for ($i = 0; $i < $bytes; $i++) {
 953         $enc .= sprintf("%02x", mt_rand(0, 255));
 954     }
 955     return $enc;
 956 }
 957
 958 function common_set_returnto($url)
 959 {
 960     common_ensure_session();
 961     $_SESSION['returnto'] = $url;
 962 }
 963
 964 function common_get_returnto()
 965 {
 966     common_ensure_session();
 967     return $_SESSION['returnto'];
 968 }
 969
 970 function common_timestamp()
 971 {
 972     return date('YmdHis');
 973 }
 974
 975 function common_ensure_syslog()
 976 {
 977     static $initialized = false;
 978     if (!$initialized) {
 979         global $config;
 980         openlog($config['syslog']['appname'], 0, LOG_USER);
 981         $initialized = true;
 982     }
 983 }
 984
 985 function common_log($priority, $msg, $filename=null)
 986 {
 987     $logfile = common_config('site', 'logfile');
 988     if ($logfile) {
 989         $log = fopen($logfile, "a");
 990         if ($log) {
 991             static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
 992                                               'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
 993             $output = date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
 994             fwrite($log, $output);
 995             fclose($log);
 996         }
 997     } else {
 998         common_ensure_syslog();
 999         syslog($priority, $msg);
1000     }
1001 }
1002
1003 function common_debug($msg, $filename=null)
1004 {
1005     if ($filename) {
1006         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1007     } else {
1008         common_log(LOG_DEBUG, $msg);
1009     }
1010 }
1011
1012 function common_log_db_error(&$object, $verb, $filename=null)
1013 {
1014     $objstr = common_log_objstring($object);
1015     $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1016     common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1017 }
1018
1019 function common_log_objstring(&$object)
1020 {
1021     if (is_null($object)) {
1022         return "null";
1023     }
1024     $arr = $object->toArray();
1025     $fields = array();
1026     foreach ($arr as $k => $v) {
1027         $fields[] = "$k='$v'";
1028     }
1029     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1030     return $objstring;
1031 }
1032
1033 function common_valid_http_url($url)
1034 {
1035     return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1036 }
1037
1038 function common_valid_tag($tag)
1039 {
1040     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1041         return (Validate::email($matches[1]) ||
1042                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1043     }
1044     return false;
1045 }
1046
1047 /* Following functions are copied from MediaWiki GlobalFunctions.php
1048  * and written by Evan Prodromou. */
1049
1050 function common_accept_to_prefs($accept, $def = '*/*')
1051 {
1052     // No arg means accept anything (per HTTP spec)
1053     if(!$accept) {
1054         return array($def => 1);
1055     }
1056
1057     $prefs = array();
1058
1059     $parts = explode(',', $accept);
1060
1061     foreach($parts as $part) {
1062         // FIXME: doesn't deal with params like 'text/html; level=1'
1063         @list($value, $qpart) = explode(';', $part);
1064         $match = array();
1065         if(!isset($qpart)) {
1066             $prefs[$value] = 1;
1067         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1068             $prefs[$value] = $match[1];
1069         }
1070     }
1071
1072     return $prefs;
1073 }
1074
1075 function common_mime_type_match($type, $avail)
1076 {
1077     if(array_key_exists($type, $avail)) {
1078         return $type;
1079     } else {
1080         $parts = explode('/', $type);
1081         if(array_key_exists($parts[0] . '/*', $avail)) {
1082             return $parts[0] . '/*';
1083         } elseif(array_key_exists('*/*', $avail)) {
1084             return '*/*';
1085         } else {
1086             return null;
1087         }
1088     }
1089 }
1090
1091 function common_negotiate_type($cprefs, $sprefs)
1092 {
1093     $combine = array();
1094
1095     foreach(array_keys($sprefs) as $type) {
1096         $parts = explode('/', $type);
1097         if($parts[1] != '*') {
1098             $ckey = common_mime_type_match($type, $cprefs);
1099             if($ckey) {
1100                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1101             }
1102         }
1103     }
1104
1105     foreach(array_keys($cprefs) as $type) {
1106         $parts = explode('/', $type);
1107         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1108             $skey = common_mime_type_match($type, $sprefs);
1109             if($skey) {
1110                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1111             }
1112         }
1113     }
1114
1115     $bestq = 0;
1116     $besttype = 'text/html';
1117
1118     foreach(array_keys($combine) as $type) {
1119         if($combine[$type] > $bestq) {
1120             $besttype = $type;
1121             $bestq = $combine[$type];
1122         }
1123     }
1124
1125     if ('text/html' === $besttype) {
1126         return "text/html; charset=utf-8";
1127     }
1128     return $besttype;
1129 }
1130
1131 function common_config($main, $sub)
1132 {
1133     global $config;
1134     return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1135 }
1136
1137 function common_copy_args($from)
1138 {
1139     $to = array();
1140     $strip = get_magic_quotes_gpc();
1141     foreach ($from as $k => $v) {
1142         $to[$k] = ($strip) ? stripslashes($v) : $v;
1143     }
1144     return $to;
1145 }
1146
1147 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1148 // This is used before handing a request off to OAuthRequest::from_request.
1149 function common_remove_magic_from_request()
1150 {
1151     if(get_magic_quotes_gpc()) {
1152         $_POST=array_map('stripslashes',$_POST);
1153         $_GET=array_map('stripslashes',$_GET);
1154     }
1155 }
1156
1157 function common_user_uri(&$user)
1158 {
1159     return common_local_url('userbyid', array('id' => $user->id));
1160 }
1161
1162 function common_notice_uri(&$notice)
1163 {
1164     return common_local_url('shownotice',
1165                             array('notice' => $notice->id));
1166 }
1167
1168 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1169
1170 function common_confirmation_code($bits)
1171 {
1172     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1173     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1174     $chars = ceil($bits/5);
1175     $code = '';
1176     for ($i = 0; $i < $chars; $i++) {
1177         // XXX: convert to string and back
1178         $num = hexdec(common_good_rand(1));
1179         // XXX: randomness is too precious to throw away almost
1180         // 40% of the bits we get!
1181         $code .= $codechars[$num%32];
1182     }
1183     return $code;
1184 }
1185
1186 // convert markup to HTML
1187
1188 function common_markup_to_html($c)
1189 {
1190     $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1191     $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1192     $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1193     return Markdown($c);
1194 }
1195
1196 function common_profile_uri($profile)
1197 {
1198     if (!$profile) {
1199         return null;
1200     }
1201     $user = User::staticGet($profile->id);
1202     if ($user) {
1203         return $user->uri;
1204     }
1205
1206     $remote = Remote_profile::staticGet($profile->id);
1207     if ($remote) {
1208         return $remote->uri;
1209     }
1210     // XXX: this is a very bad profile!
1211     return null;
1212 }
1213
1214 function common_canonical_sms($sms)
1215 {
1216     // strip non-digits
1217     preg_replace('/\D/', '', $sms);
1218     return $sms;
1219 }
1220
1221 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1222 {
1223     switch ($errno) {
1224      case E_USER_ERROR:
1225         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline)");
1226         exit(1);
1227         break;
1228
1229      case E_USER_WARNING:
1230         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1231         break;
1232
1233      case E_USER_NOTICE:
1234         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1235         break;
1236     }
1237
1238     // FIXME: show error page if we're on the Web
1239     /* Don't execute PHP internal error handler */
1240     return true;
1241 }
1242
1243 function common_session_token()
1244 {
1245     common_ensure_session();
1246     if (!array_key_exists('token', $_SESSION)) {
1247         $_SESSION['token'] = common_good_rand(64);
1248     }
1249     return $_SESSION['token'];
1250 }
1251
1252 function common_cache_key($extra)
1253 {
1254     return 'laconica:' . common_keyize(common_config('site', 'name')) . ':' . $extra;
1255 }
1256
1257 function common_keyize($str)
1258 {
1259     $str = strtolower($str);
1260     $str = preg_replace('/\s/', '_', $str);
1261     return $str;
1262 }
1263
1264 function common_memcache()
1265 {
1266     static $cache = null;
1267     if (!common_config('memcached', 'enabled')) {
1268         return null;
1269     } else {
1270         if (!$cache) {
1271             $cache = new Memcache();
1272             $servers = common_config('memcached', 'server');
1273             if (is_array($servers)) {
1274                 foreach($servers as $server) {
1275                     $cache->addServer($server);
1276                 }
1277             } else {
1278                 $cache->addServer($servers);
1279             }
1280         }
1281         return $cache;
1282     }
1283 }
1284
1285 function common_compatible_license($from, $to)
1286 {
1287     // XXX: better compatibility check needed here!
1288     return ($from == $to);
1289 }