lib/util.php

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