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