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         $attrs = array('href' => $url,
 626                        'class' => 'url');
 627         if (!empty($recipient->fullname)) {
 628             $attrs['title'] = $recipient->fullname . ' (' . $recipient->nickname . ')';
 629         }
 630         $xs->elementStart('span', 'vcard');
 631         $xs->elementStart('a', $attrs);
 632         $xs->element('span', 'fn nickname', $nickname);
 633         $xs->elementEnd('a');
 634         $xs->elementEnd('span');
 635         return $xs->getString();
 636     } else {
 637         return $nickname;
 638     }
 639 }
 640
 641 function common_group_link($sender_id, $nickname)
 642 {
 643     $sender = Profile::staticGet($sender_id);
 644     $group = User_group::staticGet('nickname', common_canonical_nickname($nickname));
 645     if ($group && $sender->isMember($group)) {
 646         $attrs = array('href' => $group->permalink(),
 647                        'class' => 'url');
 648         if (!empty($group->fullname)) {
 649             $attrs['title'] = $group->fullname . ' (' . $group->nickname . ')';
 650         }
 651         $xs = new XMLStringer();
 652         $xs->elementStart('span', 'vcard');
 653         $xs->elementStart('a', $attrs);
 654         $xs->element('span', 'fn nickname', $nickname);
 655         $xs->elementEnd('a');
 656         $xs->elementEnd('span');
 657         return $xs->getString();
 658     } else {
 659         return $nickname;
 660     }
 661 }
 662
 663 function common_at_hash_link($sender_id, $tag)
 664 {
 665     $user = User::staticGet($sender_id);
 666     if (!$user) {
 667         return $tag;
 668     }
 669     $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
 670     if ($tagged) {
 671         $url = common_local_url('subscriptions',
 672                                 array('nickname' => $user->nickname,
 673                                       'tag' => $tag));
 674         $xs = new XMLStringer();
 675         $xs->elementStart('span', 'tag');
 676         $xs->element('a', array('href' => $url,
 677                                 'rel' => $tag),
 678                      $tag);
 679         $xs->elementEnd('span');
 680         return $xs->getString();
 681     } else {
 682         return $tag;
 683     }
 684 }
 685
 686 function common_relative_profile($sender, $nickname, $dt=null)
 687 {
 688     // Try to find profiles this profile is subscribed to that have this nickname
 689     $recipient = new Profile();
 690     // XXX: use a join instead of a subquery
 691     $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
 692     $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
 693     if ($recipient->find(true)) {
 694         // XXX: should probably differentiate between profiles with
 695         // the same name by date of most recent update
 696         return $recipient;
 697     }
 698     // Try to find profiles that listen to this profile and that have this nickname
 699     $recipient = new Profile();
 700     // XXX: use a join instead of a subquery
 701     $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
 702     $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
 703     if ($recipient->find(true)) {
 704         // XXX: should probably differentiate between profiles with
 705         // the same name by date of most recent update
 706         return $recipient;
 707     }
 708     // If this is a local user, try to find a local user with that nickname.
 709     $sender = User::staticGet($sender->id);
 710     if ($sender) {
 711         $recipient_user = User::staticGet('nickname', $nickname);
 712         if ($recipient_user) {
 713             return $recipient_user->getProfile();
 714         }
 715     }
 716     // Otherwise, no links. @messages from local users to remote users,
 717     // or from remote users to other remote users, are just
 718     // outside our ability to make intelligent guesses about
 719     return null;
 720 }
 721
 722 function common_local_url($action, $args=null, $params=null, $fragment=null)
 723 {
 724     static $sensitive = array('login', 'register', 'passwordsettings',
 725                               'twittersettings', 'finishopenidlogin',
 726                               'api');
 727
 728     $r = Router::get();
 729     $path = $r->build($action, $args, $params, $fragment);
 730
 731     $ssl = in_array($action, $sensitive);
 732
 733     if (common_config('site','fancy')) {
 734         $url = common_path(mb_substr($path, 1), $ssl);
 735     } else {
 736         if (mb_strpos($path, '/index.php') === 0) {
 737             $url = common_path(mb_substr($path, 1), $ssl);
 738         } else {
 739             $url = common_path('index.php'.$path, $ssl);
 740         }
 741     }
 742     return $url;
 743 }
 744
 745 function common_path($relative, $ssl=false)
 746 {
 747     $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
 748
 749     if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
 750         || common_config('site', 'ssl') === 'always') {
 751         $proto = 'https';
 752         if (is_string(common_config('site', 'sslserver')) &&
 753             mb_strlen(common_config('site', 'sslserver')) > 0) {
 754             $serverpart = common_config('site', 'sslserver');
 755         } else {
 756             $serverpart = common_config('site', 'server');
 757         }
 758     } else {
 759         $proto = 'http';
 760         $serverpart = common_config('site', 'server');
 761     }
 762
 763     return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
 764 }
 765
 766 function common_date_string($dt)
 767 {
 768     // XXX: do some sexy date formatting
 769     // return date(DATE_RFC822, $dt);
 770     $t = strtotime($dt);
 771     $now = time();
 772     $diff = $now - $t;
 773
 774     if ($now < $t) { // that shouldn't happen!
 775         return common_exact_date($dt);
 776     } else if ($diff < 60) {
 777         return _('a few seconds ago');
 778     } else if ($diff < 92) {
 779         return _('about a minute ago');
 780     } else if ($diff < 3300) {
 781         return sprintf(_('about %d minutes ago'), round($diff/60));
 782     } else if ($diff < 5400) {
 783         return _('about an hour ago');
 784     } else if ($diff < 22 * 3600) {
 785         return sprintf(_('about %d hours ago'), round($diff/3600));
 786     } else if ($diff < 37 * 3600) {
 787         return _('about a day ago');
 788     } else if ($diff < 24 * 24 * 3600) {
 789         return sprintf(_('about %d days ago'), round($diff/(24*3600)));
 790     } else if ($diff < 46 * 24 * 3600) {
 791         return _('about a month ago');
 792     } else if ($diff < 330 * 24 * 3600) {
 793         return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
 794     } else if ($diff < 480 * 24 * 3600) {
 795         return _('about a year ago');
 796     } else {
 797         return common_exact_date($dt);
 798     }
 799 }
 800
 801 function common_exact_date($dt)
 802 {
 803     static $_utc;
 804     static $_siteTz;
 805
 806     if (!$_utc) {
 807         $_utc = new DateTimeZone('UTC');
 808         $_siteTz = new DateTimeZone(common_timezone());
 809     }
 810
 811     $dateStr = date('d F Y H:i:s', strtotime($dt));
 812     $d = new DateTime($dateStr, $_utc);
 813     $d->setTimezone($_siteTz);
 814     return $d->format(DATE_RFC850);
 815 }
 816
 817 function common_date_w3dtf($dt)
 818 {
 819     $dateStr = date('d F Y H:i:s', strtotime($dt));
 820     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 821     $d->setTimezone(new DateTimeZone(common_timezone()));
 822     return $d->format(DATE_W3C);
 823 }
 824
 825 function common_date_rfc2822($dt)
 826 {
 827     $dateStr = date('d F Y H:i:s', strtotime($dt));
 828     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 829     $d->setTimezone(new DateTimeZone(common_timezone()));
 830     return $d->format('r');
 831 }
 832
 833 function common_date_iso8601($dt)
 834 {
 835     $dateStr = date('d F Y H:i:s', strtotime($dt));
 836     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 837     $d->setTimezone(new DateTimeZone(common_timezone()));
 838     return $d->format('c');
 839 }
 840
 841 function common_sql_now()
 842 {
 843     return strftime('%Y-%m-%d %H:%M:%S', time());
 844 }
 845
 846 function common_redirect($url, $code=307)
 847 {
 848     static $status = array(301 => "Moved Permanently",
 849                            302 => "Found",
 850                            303 => "See Other",
 851                            307 => "Temporary Redirect");
 852
 853     header("Status: ${code} $status[$code]");
 854     header("Location: $url");
 855
 856     $xo = new XMLOutputter();
 857     $xo->startXML('a',
 858                   '-//W3C//DTD XHTML 1.0 Strict//EN',
 859                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
 860     $xo->element('a', array('href' => $url), $url);
 861     $xo->endXML();
 862     exit;
 863 }
 864
 865 function common_broadcast_notice($notice, $remote=false)
 866 {
 867     if (common_config('queue', 'enabled')) {
 868         // Do it later!
 869         return common_enqueue_notice($notice);
 870     } else {
 871         return common_real_broadcast($notice, $remote);
 872     }
 873 }
 874
 875 // Stick the notice on the queue
 876
 877 function common_enqueue_notice($notice)
 878 {
 879     foreach (array('jabber', 'omb', 'sms', 'public', 'twitter', 'facebook', 'ping') as $transport) {
 880         $qi = new Queue_item();
 881         $qi->notice_id = $notice->id;
 882         $qi->transport = $transport;
 883         $qi->created = $notice->created;
 884         $result = $qi->insert();
 885         if (!$result) {
 886             $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
 887             common_log(LOG_ERR, 'DB error inserting queue item: ' . $last_error->message);
 888             return false;
 889         }
 890         common_log(LOG_DEBUG, 'complete queueing notice ID = ' . $notice->id . ' for ' . $transport);
 891     }
 892     return $result;
 893 }
 894
 895 function common_real_broadcast($notice, $remote=false)
 896 {
 897     $success = true;
 898     if (!$remote) {
 899         // Make sure we have the OMB stuff
 900         require_once(INSTALLDIR.'/lib/omb.php');
 901         $success = omb_broadcast_remote_subscribers($notice);
 902         if (!$success) {
 903             common_log(LOG_ERR, 'Error in OMB broadcast for notice ' . $notice->id);
 904         }
 905     }
 906     if ($success) {
 907         require_once(INSTALLDIR.'/lib/jabber.php');
 908         $success = jabber_broadcast_notice($notice);
 909         if (!$success) {
 910             common_log(LOG_ERR, 'Error in jabber broadcast for notice ' . $notice->id);
 911         }
 912     }
 913     if ($success) {
 914         require_once(INSTALLDIR.'/lib/mail.php');
 915         $success = mail_broadcast_notice_sms($notice);
 916         if (!$success) {
 917             common_log(LOG_ERR, 'Error in sms broadcast for notice ' . $notice->id);
 918         }
 919     }
 920     if ($success) {
 921         $success = jabber_public_notice($notice);
 922         if (!$success) {
 923             common_log(LOG_ERR, 'Error in public broadcast for notice ' . $notice->id);
 924         }
 925     }
 926     if ($success) {
 927         $success = broadcast_twitter($notice);
 928         if (!$success) {
 929             common_log(LOG_ERR, 'Error in Twitter broadcast for notice ' . $notice->id);
 930         }
 931     }
 932
 933     // XXX: Do a real-time FB broadcast here?
 934
 935     // XXX: broadcast notices to other IM
 936     return $success;
 937 }
 938
 939 function common_broadcast_profile($profile)
 940 {
 941     // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
 942     require_once(INSTALLDIR.'/lib/omb.php');
 943     omb_broadcast_profile($profile);
 944     // XXX: Other broadcasts...?
 945     return true;
 946 }
 947
 948 function common_profile_url($nickname)
 949 {
 950     return common_local_url('showstream', array('nickname' => $nickname));
 951 }
 952
 953 // Should make up a reasonable root URL
 954
 955 function common_root_url()
 956 {
 957     return common_path('');
 958 }
 959
 960 // returns $bytes bytes of random data as a hexadecimal string
 961 // "good" here is a goal and not a guarantee
 962
 963 function common_good_rand($bytes)
 964 {
 965     // XXX: use random.org...?
 966     if (file_exists('/dev/urandom')) {
 967         return common_urandom($bytes);
 968     } else { // FIXME: this is probably not good enough
 969         return common_mtrand($bytes);
 970     }
 971 }
 972
 973 function common_urandom($bytes)
 974 {
 975     $h = fopen('/dev/urandom', 'rb');
 976     // should not block
 977     $src = fread($h, $bytes);
 978     fclose($h);
 979     $enc = '';
 980     for ($i = 0; $i < $bytes; $i++) {
 981         $enc .= sprintf("%02x", (ord($src[$i])));
 982     }
 983     return $enc;
 984 }
 985
 986 function common_mtrand($bytes)
 987 {
 988     $enc = '';
 989     for ($i = 0; $i < $bytes; $i++) {
 990         $enc .= sprintf("%02x", mt_rand(0, 255));
 991     }
 992     return $enc;
 993 }
 994
 995 function common_set_returnto($url)
 996 {
 997     common_ensure_session();
 998     $_SESSION['returnto'] = $url;
 999 }
1000
1001 function common_get_returnto()
1002 {
1003     common_ensure_session();
1004     return $_SESSION['returnto'];
1005 }
1006
1007 function common_timestamp()
1008 {
1009     return date('YmdHis');
1010 }
1011
1012 function common_ensure_syslog()
1013 {
1014     static $initialized = false;
1015     if (!$initialized) {
1016         openlog(common_config('syslog', 'appname'), 0, LOG_USER);
1017         $initialized = true;
1018     }
1019 }
1020
1021 function common_log($priority, $msg, $filename=null)
1022 {
1023     $logfile = common_config('site', 'logfile');
1024     if ($logfile) {
1025         $log = fopen($logfile, "a");
1026         if ($log) {
1027             static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1028                                               'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1029             $output = date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
1030             fwrite($log, $output);
1031             fclose($log);
1032         }
1033     } else {
1034         common_ensure_syslog();
1035         syslog($priority, $msg);
1036     }
1037 }
1038
1039 function common_debug($msg, $filename=null)
1040 {
1041     if ($filename) {
1042         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1043     } else {
1044         common_log(LOG_DEBUG, $msg);
1045     }
1046 }
1047
1048 function common_log_db_error(&$object, $verb, $filename=null)
1049 {
1050     $objstr = common_log_objstring($object);
1051     $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1052     common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1053 }
1054
1055 function common_log_objstring(&$object)
1056 {
1057     if (is_null($object)) {
1058         return "null";
1059     }
1060     $arr = $object->toArray();
1061     $fields = array();
1062     foreach ($arr as $k => $v) {
1063         $fields[] = "$k='$v'";
1064     }
1065     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1066     return $objstring;
1067 }
1068
1069 function common_valid_http_url($url)
1070 {
1071     return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1072 }
1073
1074 function common_valid_tag($tag)
1075 {
1076     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1077         return (Validate::email($matches[1]) ||
1078                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1079     }
1080     return false;
1081 }
1082
1083 /* Following functions are copied from MediaWiki GlobalFunctions.php
1084  * and written by Evan Prodromou. */
1085
1086 function common_accept_to_prefs($accept, $def = '*/*')
1087 {
1088     // No arg means accept anything (per HTTP spec)
1089     if(!$accept) {
1090         return array($def => 1);
1091     }
1092
1093     $prefs = array();
1094
1095     $parts = explode(',', $accept);
1096
1097     foreach($parts as $part) {
1098         // FIXME: doesn't deal with params like 'text/html; level=1'
1099         @list($value, $qpart) = explode(';', $part);
1100         $match = array();
1101         if(!isset($qpart)) {
1102             $prefs[$value] = 1;
1103         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1104             $prefs[$value] = $match[1];
1105         }
1106     }
1107
1108     return $prefs;
1109 }
1110
1111 function common_mime_type_match($type, $avail)
1112 {
1113     if(array_key_exists($type, $avail)) {
1114         return $type;
1115     } else {
1116         $parts = explode('/', $type);
1117         if(array_key_exists($parts[0] . '/*', $avail)) {
1118             return $parts[0] . '/*';
1119         } elseif(array_key_exists('*/*', $avail)) {
1120             return '*/*';
1121         } else {
1122             return null;
1123         }
1124     }
1125 }
1126
1127 function common_negotiate_type($cprefs, $sprefs)
1128 {
1129     $combine = array();
1130
1131     foreach(array_keys($sprefs) as $type) {
1132         $parts = explode('/', $type);
1133         if($parts[1] != '*') {
1134             $ckey = common_mime_type_match($type, $cprefs);
1135             if($ckey) {
1136                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1137             }
1138         }
1139     }
1140
1141     foreach(array_keys($cprefs) as $type) {
1142         $parts = explode('/', $type);
1143         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1144             $skey = common_mime_type_match($type, $sprefs);
1145             if($skey) {
1146                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1147             }
1148         }
1149     }
1150
1151     $bestq = 0;
1152     $besttype = 'text/html';
1153
1154     foreach(array_keys($combine) as $type) {
1155         if($combine[$type] > $bestq) {
1156             $besttype = $type;
1157             $bestq = $combine[$type];
1158         }
1159     }
1160
1161     if ('text/html' === $besttype) {
1162         return "text/html; charset=utf-8";
1163     }
1164     return $besttype;
1165 }
1166
1167 function common_config($main, $sub)
1168 {
1169     global $config;
1170     return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1171 }
1172
1173 function common_copy_args($from)
1174 {
1175     $to = array();
1176     $strip = get_magic_quotes_gpc();
1177     foreach ($from as $k => $v) {
1178         $to[$k] = ($strip) ? stripslashes($v) : $v;
1179     }
1180     return $to;
1181 }
1182
1183 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1184 // This is used before handing a request off to OAuthRequest::from_request.
1185 function common_remove_magic_from_request()
1186 {
1187     if(get_magic_quotes_gpc()) {
1188         $_POST=array_map('stripslashes',$_POST);
1189         $_GET=array_map('stripslashes',$_GET);
1190     }
1191 }
1192
1193 function common_user_uri(&$user)
1194 {
1195     return common_local_url('userbyid', array('id' => $user->id));
1196 }
1197
1198 function common_notice_uri(&$notice)
1199 {
1200     return common_local_url('shownotice',
1201                             array('notice' => $notice->id));
1202 }
1203
1204 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1205
1206 function common_confirmation_code($bits)
1207 {
1208     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1209     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1210     $chars = ceil($bits/5);
1211     $code = '';
1212     for ($i = 0; $i < $chars; $i++) {
1213         // XXX: convert to string and back
1214         $num = hexdec(common_good_rand(1));
1215         // XXX: randomness is too precious to throw away almost
1216         // 40% of the bits we get!
1217         $code .= $codechars[$num%32];
1218     }
1219     return $code;
1220 }
1221
1222 // convert markup to HTML
1223
1224 function common_markup_to_html($c)
1225 {
1226     $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1227     $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1228     $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1229     return Markdown($c);
1230 }
1231
1232 function common_profile_uri($profile)
1233 {
1234     if (!$profile) {
1235         return null;
1236     }
1237     $user = User::staticGet($profile->id);
1238     if ($user) {
1239         return $user->uri;
1240     }
1241
1242     $remote = Remote_profile::staticGet($profile->id);
1243     if ($remote) {
1244         return $remote->uri;
1245     }
1246     // XXX: this is a very bad profile!
1247     return null;
1248 }
1249
1250 function common_canonical_sms($sms)
1251 {
1252     // strip non-digits
1253     preg_replace('/\D/', '', $sms);
1254     return $sms;
1255 }
1256
1257 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1258 {
1259     switch ($errno) {
1260      case E_USER_ERROR:
1261         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline)");
1262         exit(1);
1263         break;
1264
1265      case E_USER_WARNING:
1266         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1267         break;
1268
1269      case E_USER_NOTICE:
1270         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1271         break;
1272     }
1273
1274     // FIXME: show error page if we're on the Web
1275     /* Don't execute PHP internal error handler */
1276     return true;
1277 }
1278
1279 function common_session_token()
1280 {
1281     common_ensure_session();
1282     if (!array_key_exists('token', $_SESSION)) {
1283         $_SESSION['token'] = common_good_rand(64);
1284     }
1285     return $_SESSION['token'];
1286 }
1287
1288 function common_cache_key($extra)
1289 {
1290     return 'laconica:' . common_keyize(common_config('site', 'name')) . ':' . $extra;
1291 }
1292
1293 function common_keyize($str)
1294 {
1295     $str = strtolower($str);
1296     $str = preg_replace('/\s/', '_', $str);
1297     return $str;
1298 }
1299
1300 function common_memcache()
1301 {
1302     static $cache = null;
1303     if (!common_config('memcached', 'enabled')) {
1304         return null;
1305     } else {
1306         if (!$cache) {
1307             $cache = new Memcache();
1308             $servers = common_config('memcached', 'server');
1309             if (is_array($servers)) {
1310                 foreach($servers as $server) {
1311                     $cache->addServer($server);
1312                 }
1313             } else {
1314                 $cache->addServer($servers);
1315             }
1316         }
1317         return $cache;
1318     }
1319 }
1320
1321 function common_compatible_license($from, $to)
1322 {
1323     // XXX: better compatibility check needed here!
1324     return ($from == $to);
1325 }