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     $display = $url;
 476     $url = (!preg_match('#^([a-z]+://|(mailto|aim|tel):)#i', $url)) ? 'http://'.$url:$url;
 477
 478     if ($longurl = common_longurl($url)) {
 479         $longurl = htmlentities($longurl, ENT_QUOTES, 'UTF-8');
 480         $title = "title=\"$longurl\"";
 481     }
 482     else $title = '';
 483
 484     return "<a href=\"$url\" $title rel=\"external\">$display</a>";
 485 }
 486
 487 function common_longurl($short_url)
 488 {
 489     $long_url = common_shorten_link($short_url, true);
 490     if ($long_url === $short_url) return false;
 491     return $long_url;
 492 }
 493
 494 function common_longurl2($uri)
 495 {
 496     $uri_e = urlencode($uri);
 497     $longurl = unserialize(file_get_contents("http://api.longurl.org/v1/expand?format=php&url=$uri_e"));
 498     if (empty($longurl['long_url']) || $uri === $longurl['long_url']) return false;
 499     return stripslashes($longurl['long_url']);
 500 }
 501
 502 function common_shorten_links($text)
 503 {
 504     if (mb_strlen($text) <= 140) return $text;
 505     static $cache = array();
 506     if (isset($cache[$text])) return $cache[$text];
 507     // \s = not a horizontal whitespace character (since PHP 5.2.4)
 508     return $cache[$text] = common_replace_urls_callback($text, 'common_shorten_link');;
 509 }
 510
 511 function common_shorten_link($url, $reverse = false)
 512 {
 513     static $url_cache = array();
 514     if ($reverse) return isset($url_cache[$url]) ? $url_cache[$url] : $url;
 515
 516     $user = common_current_user();
 517
 518     $curlh = curl_init();
 519     curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
 520     curl_setopt($curlh, CURLOPT_USERAGENT, 'Laconica');
 521     curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
 522
 523     switch($user->urlshorteningservice) {
 524      case 'ur1.ca':
 525         $short_url_service = new LilUrl;
 526         $short_url = $short_url_service->shorten($url);
 527         break;
 528
 529      case '2tu.us':
 530         $short_url_service = new TightUrl;
 531         $short_url = $short_url_service->shorten($url);
 532         break;
 533
 534      case 'ptiturl.com':
 535         $short_url_service = new PtitUrl;
 536         $short_url = $short_url_service->shorten($url);
 537         break;
 538
 539      case 'bit.ly':
 540         curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($url));
 541         $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
 542         break;
 543
 544      case 'is.gd':
 545         curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($url));
 546         $short_url = curl_exec($curlh);
 547         break;
 548      case 'snipr.com':
 549         curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($url));
 550         $short_url = curl_exec($curlh);
 551         break;
 552      case 'metamark.net':
 553         curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($url));
 554         $short_url = curl_exec($curlh);
 555         break;
 556      case 'tinyurl.com':
 557         curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($url));
 558         $short_url = curl_exec($curlh);
 559         break;
 560      default:
 561         $short_url = false;
 562     }
 563
 564     curl_close($curlh);
 565
 566     if ($short_url) {
 567         $url_cache[(string)$short_url] = $url;
 568         return (string)$short_url;
 569     }
 570     return $url;
 571 }
 572
 573 function common_xml_safe_str($str)
 574 {
 575     $xmlStr = htmlentities(iconv('UTF-8', 'UTF-8//IGNORE', $str), ENT_NOQUOTES, 'UTF-8');
 576
 577     // Replace control, formatting, and surrogate characters with '*', ala Twitter
 578     return preg_replace('/[\p{Cc}\p{Cf}\p{Cs}]/u', '*', $str);
 579 }
 580
 581 function common_tag_link($tag)
 582 {
 583     $canonical = common_canonical_tag($tag);
 584     $url = common_local_url('tag', array('tag' => $canonical));
 585     return '<span class="tag"><a href="' . htmlspecialchars($url) . '" rel="tag">' . htmlspecialchars($tag) . '</a></span>';
 586 }
 587
 588 function common_canonical_tag($tag)
 589 {
 590     return strtolower(str_replace(array('-', '_', '.'), '', $tag));
 591 }
 592
 593 function common_valid_profile_tag($str)
 594 {
 595     return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
 596 }
 597
 598 function common_at_link($sender_id, $nickname)
 599 {
 600     $sender = Profile::staticGet($sender_id);
 601     $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
 602     if ($recipient) {
 603         return '<span class="vcard"><a href="'.htmlspecialchars($recipient->profileurl).'" class="url"><span class="fn nickname">'.$nickname.'</span></a></span>';
 604     } else {
 605         return $nickname;
 606     }
 607 }
 608
 609 function common_group_link($sender_id, $nickname)
 610 {
 611     $sender = Profile::staticGet($sender_id);
 612     $group = User_group::staticGet('nickname', common_canonical_nickname($nickname));
 613     if ($group && $sender->isMember($group)) {
 614         return '<span class="vcard"><a href="'.htmlspecialchars($group->permalink()).'" class="url"><span class="fn nickname">'.$nickname.'</span></a></span>';
 615     } else {
 616         return $nickname;
 617     }
 618 }
 619
 620 function common_at_hash_link($sender_id, $tag)
 621 {
 622     $user = User::staticGet($sender_id);
 623     if (!$user) {
 624         return $tag;
 625     }
 626     $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
 627     if ($tagged) {
 628         $url = common_local_url('subscriptions',
 629                                 array('nickname' => $user->nickname,
 630                                       'tag' => $tag));
 631         return '<span class="tag"><a href="'.htmlspecialchars($url).'" rel="tag">'.$tag.'</a></span>';
 632     } else {
 633         return $tag;
 634     }
 635 }
 636
 637 function common_relative_profile($sender, $nickname, $dt=null)
 638 {
 639     // Try to find profiles this profile is subscribed to that have this nickname
 640     $recipient = new Profile();
 641     // XXX: use a join instead of a subquery
 642     $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
 643     $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
 644     if ($recipient->find(true)) {
 645         // XXX: should probably differentiate between profiles with
 646         // the same name by date of most recent update
 647         return $recipient;
 648     }
 649     // Try to find profiles that listen to this profile and that have this nickname
 650     $recipient = new Profile();
 651     // XXX: use a join instead of a subquery
 652     $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
 653     $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
 654     if ($recipient->find(true)) {
 655         // XXX: should probably differentiate between profiles with
 656         // the same name by date of most recent update
 657         return $recipient;
 658     }
 659     // If this is a local user, try to find a local user with that nickname.
 660     $sender = User::staticGet($sender->id);
 661     if ($sender) {
 662         $recipient_user = User::staticGet('nickname', $nickname);
 663         if ($recipient_user) {
 664             return $recipient_user->getProfile();
 665         }
 666     }
 667     // Otherwise, no links. @messages from local users to remote users,
 668     // or from remote users to other remote users, are just
 669     // outside our ability to make intelligent guesses about
 670     return null;
 671 }
 672
 673 function common_local_url($action, $args=null, $fragment=null)
 674 {
 675     common_debug("Action = $action, args = " . (($args) ? '(' . implode($args, ',') . ')' : $args) . ", fragment = $fragment");
 676     $r = Router::get();
 677     $start = microtime();
 678     $path = $r->build($action, $args, $fragment);
 679     $end = microtime();
 680     common_debug("Pathbuilding took " . ($end - $start));
 681     if ($path) {
 682     }
 683     if (common_config('site','fancy')) {
 684         $url = common_path(mb_substr($path, 1));
 685     } else {
 686         $url = common_path('index.php'.$path);
 687     }
 688     return $url;
 689 }
 690
 691 function common_path($relative)
 692 {
 693     global $config;
 694     $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
 695     return "http://".$config['site']['server'].'/'.$pathpart.$relative;
 696 }
 697
 698 function common_date_string($dt)
 699 {
 700     // XXX: do some sexy date formatting
 701     // return date(DATE_RFC822, $dt);
 702     $t = strtotime($dt);
 703     $now = time();
 704     $diff = $now - $t;
 705
 706     if ($now < $t) { // that shouldn't happen!
 707         return common_exact_date($dt);
 708     } else if ($diff < 60) {
 709         return _('a few seconds ago');
 710     } else if ($diff < 92) {
 711         return _('about a minute ago');
 712     } else if ($diff < 3300) {
 713         return sprintf(_('about %d minutes ago'), round($diff/60));
 714     } else if ($diff < 5400) {
 715         return _('about an hour ago');
 716     } else if ($diff < 22 * 3600) {
 717         return sprintf(_('about %d hours ago'), round($diff/3600));
 718     } else if ($diff < 37 * 3600) {
 719         return _('about a day ago');
 720     } else if ($diff < 24 * 24 * 3600) {
 721         return sprintf(_('about %d days ago'), round($diff/(24*3600)));
 722     } else if ($diff < 46 * 24 * 3600) {
 723         return _('about a month ago');
 724     } else if ($diff < 330 * 24 * 3600) {
 725         return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
 726     } else if ($diff < 480 * 24 * 3600) {
 727         return _('about a year ago');
 728     } else {
 729         return common_exact_date($dt);
 730     }
 731 }
 732
 733 function common_exact_date($dt)
 734 {
 735     static $_utc;
 736     static $_siteTz;
 737
 738     if (!$_utc) {
 739         $_utc = new DateTimeZone('UTC');
 740         $_siteTz = new DateTimeZone(common_timezone());
 741     }
 742
 743     $dateStr = date('d F Y H:i:s', strtotime($dt));
 744     $d = new DateTime($dateStr, $_utc);
 745     $d->setTimezone($_siteTz);
 746     return $d->format(DATE_RFC850);
 747 }
 748
 749 function common_date_w3dtf($dt)
 750 {
 751     $dateStr = date('d F Y H:i:s', strtotime($dt));
 752     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 753     $d->setTimezone(new DateTimeZone(common_timezone()));
 754     return $d->format(DATE_W3C);
 755 }
 756
 757 function common_date_rfc2822($dt)
 758 {
 759     $dateStr = date('d F Y H:i:s', strtotime($dt));
 760     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 761     $d->setTimezone(new DateTimeZone(common_timezone()));
 762     return $d->format('r');
 763 }
 764
 765 function common_date_iso8601($dt)
 766 {
 767     $dateStr = date('d F Y H:i:s', strtotime($dt));
 768     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 769     $d->setTimezone(new DateTimeZone(common_timezone()));
 770     return $d->format('c');
 771 }
 772
 773 function common_sql_now()
 774 {
 775     return strftime('%Y-%m-%d %H:%M:%S', time());
 776 }
 777
 778 function common_redirect($url, $code=307)
 779 {
 780     static $status = array(301 => "Moved Permanently",
 781                            302 => "Found",
 782                            303 => "See Other",
 783                            307 => "Temporary Redirect");
 784
 785     header("Status: ${code} $status[$code]");
 786     header("Location: $url");
 787
 788     $xo = new XMLOutputter();
 789     $xo->startXML('a',
 790                   '-//W3C//DTD XHTML 1.0 Strict//EN',
 791                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
 792     $xo->element('a', array('href' => $url), $url);
 793     $xo->endXML();
 794     exit;
 795 }
 796
 797 function common_broadcast_notice($notice, $remote=false)
 798 {
 799     if (common_config('queue', 'enabled')) {
 800         // Do it later!
 801         return common_enqueue_notice($notice);
 802     } else {
 803         return common_real_broadcast($notice, $remote);
 804     }
 805 }
 806
 807 // Stick the notice on the queue
 808
 809 function common_enqueue_notice($notice)
 810 {
 811     foreach (array('jabber', 'omb', 'sms', 'public', 'twitter') as $transport) {
 812         $qi = new Queue_item();
 813         $qi->notice_id = $notice->id;
 814         $qi->transport = $transport;
 815         $qi->created = $notice->created;
 816         $result = $qi->insert();
 817         if (!$result) {
 818             $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
 819             common_log(LOG_ERR, 'DB error inserting queue item: ' . $last_error->message);
 820             return false;
 821         }
 822         common_log(LOG_DEBUG, 'complete queueing notice ID = ' . $notice->id . ' for ' . $transport);
 823     }
 824     return $result;
 825 }
 826
 827 function common_real_broadcast($notice, $remote=false)
 828 {
 829     $success = true;
 830     if (!$remote) {
 831         // Make sure we have the OMB stuff
 832         require_once(INSTALLDIR.'/lib/omb.php');
 833         $success = omb_broadcast_remote_subscribers($notice);
 834         if (!$success) {
 835             common_log(LOG_ERR, 'Error in OMB broadcast for notice ' . $notice->id);
 836         }
 837     }
 838     if ($success) {
 839         require_once(INSTALLDIR.'/lib/jabber.php');
 840         $success = jabber_broadcast_notice($notice);
 841         if (!$success) {
 842             common_log(LOG_ERR, 'Error in jabber broadcast for notice ' . $notice->id);
 843         }
 844     }
 845     if ($success) {
 846         require_once(INSTALLDIR.'/lib/mail.php');
 847         $success = mail_broadcast_notice_sms($notice);
 848         if (!$success) {
 849             common_log(LOG_ERR, 'Error in sms broadcast for notice ' . $notice->id);
 850         }
 851     }
 852     if ($success) {
 853         $success = jabber_public_notice($notice);
 854         if (!$success) {
 855             common_log(LOG_ERR, 'Error in public broadcast for notice ' . $notice->id);
 856         }
 857     }
 858     if ($success) {
 859         $success = broadcast_twitter($notice);
 860         if (!$success) {
 861             common_log(LOG_ERR, 'Error in Twitter broadcast for notice ' . $notice->id);
 862         }
 863     }
 864
 865     // XXX: broadcast notices to other IM
 866     return $success;
 867 }
 868
 869 function common_broadcast_profile($profile)
 870 {
 871     // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
 872     require_once(INSTALLDIR.'/lib/omb.php');
 873     omb_broadcast_profile($profile);
 874     // XXX: Other broadcasts...?
 875     return true;
 876 }
 877
 878 function common_profile_url($nickname)
 879 {
 880     return common_local_url('showstream', array('nickname' => $nickname));
 881 }
 882
 883 // Should make up a reasonable root URL
 884
 885 function common_root_url()
 886 {
 887     return common_path('');
 888 }
 889
 890 // returns $bytes bytes of random data as a hexadecimal string
 891 // "good" here is a goal and not a guarantee
 892
 893 function common_good_rand($bytes)
 894 {
 895     // XXX: use random.org...?
 896     if (file_exists('/dev/urandom')) {
 897         return common_urandom($bytes);
 898     } else { // FIXME: this is probably not good enough
 899         return common_mtrand($bytes);
 900     }
 901 }
 902
 903 function common_urandom($bytes)
 904 {
 905     $h = fopen('/dev/urandom', 'rb');
 906     // should not block
 907     $src = fread($h, $bytes);
 908     fclose($h);
 909     $enc = '';
 910     for ($i = 0; $i < $bytes; $i++) {
 911         $enc .= sprintf("%02x", (ord($src[$i])));
 912     }
 913     return $enc;
 914 }
 915
 916 function common_mtrand($bytes)
 917 {
 918     $enc = '';
 919     for ($i = 0; $i < $bytes; $i++) {
 920         $enc .= sprintf("%02x", mt_rand(0, 255));
 921     }
 922     return $enc;
 923 }
 924
 925 function common_set_returnto($url)
 926 {
 927     common_ensure_session();
 928     $_SESSION['returnto'] = $url;
 929 }
 930
 931 function common_get_returnto()
 932 {
 933     common_ensure_session();
 934     return $_SESSION['returnto'];
 935 }
 936
 937 function common_timestamp()
 938 {
 939     return date('YmdHis');
 940 }
 941
 942 function common_ensure_syslog()
 943 {
 944     static $initialized = false;
 945     if (!$initialized) {
 946         global $config;
 947         openlog($config['syslog']['appname'], 0, LOG_USER);
 948         $initialized = true;
 949     }
 950 }
 951
 952 function common_log($priority, $msg, $filename=null)
 953 {
 954     $logfile = common_config('site', 'logfile');
 955     if ($logfile) {
 956         $log = fopen($logfile, "a");
 957         if ($log) {
 958             static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
 959                                               'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
 960             $output = date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
 961             fwrite($log, $output);
 962             fclose($log);
 963         }
 964     } else {
 965         common_ensure_syslog();
 966         syslog($priority, $msg);
 967     }
 968 }
 969
 970 function common_debug($msg, $filename=null)
 971 {
 972     if ($filename) {
 973         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
 974     } else {
 975         common_log(LOG_DEBUG, $msg);
 976     }
 977 }
 978
 979 function common_log_db_error(&$object, $verb, $filename=null)
 980 {
 981     $objstr = common_log_objstring($object);
 982     $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
 983     common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
 984 }
 985
 986 function common_log_objstring(&$object)
 987 {
 988     if (is_null($object)) {
 989         return "null";
 990     }
 991     $arr = $object->toArray();
 992     $fields = array();
 993     foreach ($arr as $k => $v) {
 994         $fields[] = "$k='$v'";
 995     }
 996     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
 997     return $objstring;
 998 }
 999
1000 function common_valid_http_url($url)
1001 {
1002     return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1003 }
1004
1005 function common_valid_tag($tag)
1006 {
1007     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1008         return (Validate::email($matches[1]) ||
1009                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1010     }
1011     return false;
1012 }
1013
1014 /* Following functions are copied from MediaWiki GlobalFunctions.php
1015  * and written by Evan Prodromou. */
1016
1017 function common_accept_to_prefs($accept, $def = '*/*')
1018 {
1019     // No arg means accept anything (per HTTP spec)
1020     if(!$accept) {
1021         return array($def => 1);
1022     }
1023
1024     $prefs = array();
1025
1026     $parts = explode(',', $accept);
1027
1028     foreach($parts as $part) {
1029         // FIXME: doesn't deal with params like 'text/html; level=1'
1030         @list($value, $qpart) = explode(';', $part);
1031         $match = array();
1032         if(!isset($qpart)) {
1033             $prefs[$value] = 1;
1034         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1035             $prefs[$value] = $match[1];
1036         }
1037     }
1038
1039     return $prefs;
1040 }
1041
1042 function common_mime_type_match($type, $avail)
1043 {
1044     if(array_key_exists($type, $avail)) {
1045         return $type;
1046     } else {
1047         $parts = explode('/', $type);
1048         if(array_key_exists($parts[0] . '/*', $avail)) {
1049             return $parts[0] . '/*';
1050         } elseif(array_key_exists('*/*', $avail)) {
1051             return '*/*';
1052         } else {
1053             return null;
1054         }
1055     }
1056 }
1057
1058 function common_negotiate_type($cprefs, $sprefs)
1059 {
1060     $combine = array();
1061
1062     foreach(array_keys($sprefs) as $type) {
1063         $parts = explode('/', $type);
1064         if($parts[1] != '*') {
1065             $ckey = common_mime_type_match($type, $cprefs);
1066             if($ckey) {
1067                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1068             }
1069         }
1070     }
1071
1072     foreach(array_keys($cprefs) as $type) {
1073         $parts = explode('/', $type);
1074         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1075             $skey = common_mime_type_match($type, $sprefs);
1076             if($skey) {
1077                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1078             }
1079         }
1080     }
1081
1082     $bestq = 0;
1083     $besttype = 'text/html';
1084
1085     foreach(array_keys($combine) as $type) {
1086         if($combine[$type] > $bestq) {
1087             $besttype = $type;
1088             $bestq = $combine[$type];
1089         }
1090     }
1091
1092     if ('text/html' === $besttype) {
1093         return "text/html; charset=utf-8";
1094     }
1095     return $besttype;
1096 }
1097
1098 function common_config($main, $sub)
1099 {
1100     global $config;
1101     return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1102 }
1103
1104 function common_copy_args($from)
1105 {
1106     $to = array();
1107     $strip = get_magic_quotes_gpc();
1108     foreach ($from as $k => $v) {
1109         $to[$k] = ($strip) ? stripslashes($v) : $v;
1110     }
1111     return $to;
1112 }
1113
1114 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1115 // This is used before handing a request off to OAuthRequest::from_request.
1116 function common_remove_magic_from_request()
1117 {
1118     if(get_magic_quotes_gpc()) {
1119         $_POST=array_map('stripslashes',$_POST);
1120         $_GET=array_map('stripslashes',$_GET);
1121     }
1122 }
1123
1124 function common_user_uri(&$user)
1125 {
1126     return common_local_url('userbyid', array('id' => $user->id));
1127 }
1128
1129 function common_notice_uri(&$notice)
1130 {
1131     return common_local_url('shownotice',
1132                             array('notice' => $notice->id));
1133 }
1134
1135 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1136
1137 function common_confirmation_code($bits)
1138 {
1139     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1140     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1141     $chars = ceil($bits/5);
1142     $code = '';
1143     for ($i = 0; $i < $chars; $i++) {
1144         // XXX: convert to string and back
1145         $num = hexdec(common_good_rand(1));
1146         // XXX: randomness is too precious to throw away almost
1147         // 40% of the bits we get!
1148         $code .= $codechars[$num%32];
1149     }
1150     return $code;
1151 }
1152
1153 // convert markup to HTML
1154
1155 function common_markup_to_html($c)
1156 {
1157     $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1158     $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1159     $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1160     return Markdown($c);
1161 }
1162
1163 function common_profile_uri($profile)
1164 {
1165     if (!$profile) {
1166         return null;
1167     }
1168     $user = User::staticGet($profile->id);
1169     if ($user) {
1170         return $user->uri;
1171     }
1172
1173     $remote = Remote_profile::staticGet($profile->id);
1174     if ($remote) {
1175         return $remote->uri;
1176     }
1177     // XXX: this is a very bad profile!
1178     return null;
1179 }
1180
1181 function common_canonical_sms($sms)
1182 {
1183     // strip non-digits
1184     preg_replace('/\D/', '', $sms);
1185     return $sms;
1186 }
1187
1188 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1189 {
1190     switch ($errno) {
1191      case E_USER_ERROR:
1192         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline)");
1193         exit(1);
1194         break;
1195
1196      case E_USER_WARNING:
1197         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1198         break;
1199
1200      case E_USER_NOTICE:
1201         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1202         break;
1203     }
1204
1205     // FIXME: show error page if we're on the Web
1206     /* Don't execute PHP internal error handler */
1207     return true;
1208 }
1209
1210 function common_session_token()
1211 {
1212     common_ensure_session();
1213     if (!array_key_exists('token', $_SESSION)) {
1214         $_SESSION['token'] = common_good_rand(64);
1215     }
1216     return $_SESSION['token'];
1217 }
1218
1219 function common_cache_key($extra)
1220 {
1221     return 'laconica:' . common_keyize(common_config('site', 'name')) . ':' . $extra;
1222 }
1223
1224 function common_keyize($str)
1225 {
1226     $str = strtolower($str);
1227     $str = preg_replace('/\s/', '_', $str);
1228     return $str;
1229 }
1230
1231 function common_memcache()
1232 {
1233     static $cache = null;
1234     if (!common_config('memcached', 'enabled')) {
1235         return null;
1236     } else {
1237         if (!$cache) {
1238             $cache = new Memcache();
1239             $servers = common_config('memcached', 'server');
1240             if (is_array($servers)) {
1241                 foreach($servers as $server) {
1242                     $cache->addServer($server);
1243                 }
1244             } else {
1245                 $cache->addServer($servers);
1246             }
1247         }
1248         return $cache;
1249     }
1250 }
1251
1252 function common_compatible_license($from, $to)
1253 {
1254     // XXX: better compatibility check needed here!
1255     return ($from == $to);
1256 }