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 $url) {
 416         $url = htmlspecialchars_decode($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 trailing punctuation
 422         $url = rtrim($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 = substr_replace($url, '', 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         // Call user specified func
 460         $modified_url = $callback($url);
 461
 462         // Replace it!
 463         $start = mb_strpos($text, $url, $offset);
 464         $text = mb_substr($text, 0, $start).$modified_url.mb_substr($text, $start + mb_strlen($url), mb_strlen($text));
 465         $offset = $start + mb_strlen($modified_url);
 466     }
 467
 468     return $text;
 469 }
 470
 471 function common_linkify($url) {
 472     $display = $url;
 473     $url = (!preg_match('#^([a-z]+://|(mailto|aim|tel):)#i', $url)) ? 'http://'.$url:$url;
 474
 475     if ($longurl = common_longurl($url)) {
 476         $longurl = htmlentities($longurl, ENT_QUOTES, 'UTF-8');
 477         $title = "title=\"$longurl\"";
 478     }
 479     else $title = '';
 480
 481     return "<a href=\"$url\" $title rel=\"external\">$display</a>";
 482 }
 483
 484 function common_longurl($short_url)
 485 {
 486     $long_url = common_shorten_link($short_url, true);
 487     if ($long_url === $short_url) return false;
 488     return $long_url;
 489 }
 490
 491 function common_longurl2($uri)
 492 {
 493     $uri_e = urlencode($uri);
 494     $longurl = unserialize(file_get_contents("http://api.longurl.org/v1/expand?format=php&url=$uri_e"));
 495     if (empty($longurl['long_url']) || $uri === $longurl['long_url']) return false;
 496     return stripslashes($longurl['long_url']);
 497 }
 498
 499 function common_shorten_links($text)
 500 {
 501     if (mb_strlen($text) <= 140) return $text;
 502     static $cache = array();
 503     if (isset($cache[$text])) return $cache[$text];
 504     // \s = not a horizontal whitespace character (since PHP 5.2.4)
 505     return $cache[$text] = common_replace_urls_callback($text, 'common_shorten_link');;
 506 }
 507
 508 function common_shorten_link($url, $reverse = false)
 509 {
 510     static $url_cache = array();
 511     if ($reverse) return isset($url_cache[$url]) ? $url_cache[$url] : $url;
 512
 513     $user = common_current_user();
 514
 515     $curlh = curl_init();
 516     curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
 517     curl_setopt($curlh, CURLOPT_USERAGENT, 'Laconica');
 518     curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
 519
 520     switch($user->urlshorteningservice) {
 521      case 'ur1.ca':
 522         $short_url_service = new LilUrl;
 523         $short_url = $short_url_service->shorten($url);
 524         break;
 525
 526      case '2tu.us':
 527         $short_url_service = new TightUrl;
 528         $short_url = $short_url_service->shorten($url);
 529         break;
 530
 531      case 'ptiturl.com':
 532         $short_url_service = new PtitUrl;
 533         $short_url = $short_url_service->shorten($url);
 534         break;
 535
 536      case 'bit.ly':
 537         curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($url));
 538         $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
 539         break;
 540
 541      case 'is.gd':
 542         curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($url));
 543         $short_url = curl_exec($curlh);
 544         break;
 545      case 'snipr.com':
 546         curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($url));
 547         $short_url = curl_exec($curlh);
 548         break;
 549      case 'metamark.net':
 550         curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($url));
 551         $short_url = curl_exec($curlh);
 552         break;
 553      case 'tinyurl.com':
 554         curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($url));
 555         $short_url = curl_exec($curlh);
 556         break;
 557      default:
 558         $short_url = false;
 559     }
 560
 561     curl_close($curlh);
 562
 563     if ($short_url) {
 564         $url_cache[(string)$short_url] = $url;
 565         return (string)$short_url;
 566     }
 567     return $url;
 568 }
 569
 570 function common_xml_safe_str($str)
 571 {
 572     $xmlStr = htmlentities(iconv('UTF-8', 'UTF-8//IGNORE', $str), ENT_NOQUOTES, 'UTF-8');
 573
 574     // Replace control, formatting, and surrogate characters with '*', ala Twitter
 575     return preg_replace('/[\p{Cc}\p{Cf}\p{Cs}]/u', '*', $str);
 576 }
 577
 578 function common_tag_link($tag)
 579 {
 580     $canonical = common_canonical_tag($tag);
 581     $url = common_local_url('tag', array('tag' => $canonical));
 582     return '<span class="tag"><a href="' . htmlspecialchars($url) . '" rel="tag">' . htmlspecialchars($tag) . '</a></span>';
 583 }
 584
 585 function common_canonical_tag($tag)
 586 {
 587     return strtolower(str_replace(array('-', '_', '.'), '', $tag));
 588 }
 589
 590 function common_valid_profile_tag($str)
 591 {
 592     return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
 593 }
 594
 595 function common_at_link($sender_id, $nickname)
 596 {
 597     $sender = Profile::staticGet($sender_id);
 598     $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
 599     if ($recipient) {
 600         return '<span class="vcard"><a href="'.htmlspecialchars($recipient->profileurl).'" class="url"><span class="fn nickname">'.$nickname.'</span></a></span>';
 601     } else {
 602         return $nickname;
 603     }
 604 }
 605
 606 function common_group_link($sender_id, $nickname)
 607 {
 608     $sender = Profile::staticGet($sender_id);
 609     $group = User_group::staticGet('nickname', common_canonical_nickname($nickname));
 610     if ($group && $sender->isMember($group)) {
 611         return '<span class="vcard"><a href="'.htmlspecialchars($group->permalink()).'" class="url"><span class="fn nickname">'.$nickname.'</span></a></span>';
 612     } else {
 613         return $nickname;
 614     }
 615 }
 616
 617 function common_at_hash_link($sender_id, $tag)
 618 {
 619     $user = User::staticGet($sender_id);
 620     if (!$user) {
 621         return $tag;
 622     }
 623     $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
 624     if ($tagged) {
 625         $url = common_local_url('subscriptions',
 626                                 array('nickname' => $user->nickname,
 627                                       'tag' => $tag));
 628         return '<span class="tag"><a href="'.htmlspecialchars($url).'" rel="tag">'.$tag.'</a></span>';
 629     } else {
 630         return $tag;
 631     }
 632 }
 633
 634 function common_relative_profile($sender, $nickname, $dt=null)
 635 {
 636     // Try to find profiles this profile is subscribed to that have this nickname
 637     $recipient = new Profile();
 638     // XXX: use a join instead of a subquery
 639     $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
 640     $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
 641     if ($recipient->find(true)) {
 642         // XXX: should probably differentiate between profiles with
 643         // the same name by date of most recent update
 644         return $recipient;
 645     }
 646     // Try to find profiles that listen to this profile and that have this nickname
 647     $recipient = new Profile();
 648     // XXX: use a join instead of a subquery
 649     $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
 650     $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
 651     if ($recipient->find(true)) {
 652         // XXX: should probably differentiate between profiles with
 653         // the same name by date of most recent update
 654         return $recipient;
 655     }
 656     // If this is a local user, try to find a local user with that nickname.
 657     $sender = User::staticGet($sender->id);
 658     if ($sender) {
 659         $recipient_user = User::staticGet('nickname', $nickname);
 660         if ($recipient_user) {
 661             return $recipient_user->getProfile();
 662         }
 663     }
 664     // Otherwise, no links. @messages from local users to remote users,
 665     // or from remote users to other remote users, are just
 666     // outside our ability to make intelligent guesses about
 667     return null;
 668 }
 669
 670 function common_local_url($action, $args=null, $fragment=null)
 671 {
 672     $url = null;
 673     if (common_config('site','fancy')) {
 674         $url = common_fancy_url($action, $args);
 675     } else {
 676         $url = common_simple_url($action, $args);
 677     }
 678     if (!is_null($fragment)) {
 679         $url .= '#'.$fragment;
 680     }
 681     return $url;
 682 }
 683
 684 function common_fancy_url($action, $args=null)
 685 {
 686     switch (strtolower($action)) {
 687      case 'public':
 688         if ($args && isset($args['page'])) {
 689             return common_path('?page=' . $args['page']);
 690         } else {
 691             return common_path('');
 692         }
 693      case 'featured':
 694         if ($args && isset($args['page'])) {
 695             return common_path('featured?page=' . $args['page']);
 696         } else {
 697             return common_path('featured');
 698         }
 699      case 'favorited':
 700         if ($args && isset($args['page'])) {
 701             return common_path('favorited?page=' . $args['page']);
 702         } else {
 703             return common_path('favorited');
 704         }
 705      case 'publicrss':
 706         return common_path('rss');
 707      case 'publicatom':
 708         return common_path("api/statuses/public_timeline.atom");
 709      case 'publicxrds':
 710         return common_path('xrds');
 711      case 'tagrss':
 712         return common_path('tag/' . $args['tag'] . '/rss');
 713      case 'featuredrss':
 714         return common_path('featuredrss');
 715      case 'favoritedrss':
 716         return common_path('favoritedrss');
 717      case 'opensearch':
 718         if ($args && $args['type']) {
 719             return common_path('opensearch/'.$args['type']);
 720         } else {
 721             return common_path('opensearch/people');
 722         }
 723      case 'doc':
 724         return common_path('doc/'.$args['title']);
 725      case 'block':
 726      case 'login':
 727      case 'logout':
 728      case 'subscribe':
 729      case 'unsubscribe':
 730      case 'invite':
 731         return common_path('main/'.$action);
 732      case 'tagother':
 733         return common_path('main/tagother?id='.$args['id']);
 734      case 'register':
 735         if ($args && $args['code']) {
 736             return common_path('main/register/'.$args['code']);
 737         } else {
 738             return common_path('main/register');
 739         }
 740      case 'remotesubscribe':
 741         if ($args && $args['nickname']) {
 742             return common_path('main/remote?nickname=' . $args['nickname']);
 743         } else {
 744             return common_path('main/remote');
 745         }
 746      case 'nudge':
 747         return common_path($args['nickname'].'/nudge');
 748      case 'openidlogin':
 749         return common_path('main/openid');
 750      case 'profilesettings':
 751         return common_path('settings/profile');
 752      case 'passwordsettings':
 753         return common_path('settings/password');
 754      case 'emailsettings':
 755         return common_path('settings/email');
 756      case 'openidsettings':
 757         return common_path('settings/openid');
 758      case 'smssettings':
 759         return common_path('settings/sms');
 760      case 'twittersettings':
 761         return common_path('settings/twitter');
 762      case 'othersettings':
 763         return common_path('settings/other');
 764      case 'deleteprofile':
 765         return common_path('settings/delete');
 766      case 'newnotice':
 767         if ($args && $args['replyto']) {
 768             return common_path('notice/new?replyto='.$args['replyto']);
 769         } else {
 770             return common_path('notice/new');
 771         }
 772      case 'shownotice':
 773         return common_path('notice/'.$args['notice']);
 774      case 'deletenotice':
 775         if ($args && $args['notice']) {
 776             return common_path('notice/delete/'.$args['notice']);
 777         } else {
 778             return common_path('notice/delete');
 779         }
 780      case 'microsummary':
 781      case 'xrds':
 782      case 'foaf':
 783         return common_path($args['nickname'].'/'.$action);
 784      case 'all':
 785      case 'replies':
 786      case 'inbox':
 787      case 'outbox':
 788         if ($args && isset($args['page'])) {
 789             return common_path($args['nickname'].'/'.$action.'?page=' . $args['page']);
 790         } else {
 791             return common_path($args['nickname'].'/'.$action);
 792         }
 793      case 'subscriptions':
 794      case 'subscribers':
 795         $nickname = $args['nickname'];
 796         unset($args['nickname']);
 797         if (isset($args['tag'])) {
 798             $tag = $args['tag'];
 799             unset($args['tag']);
 800         }
 801         $params = http_build_query($args);
 802         if ($params) {
 803             return common_path($nickname.'/'.$action . (($tag) ? '/' . $tag : '') . '?' . $params);
 804         } else {
 805             return common_path($nickname.'/'.$action . (($tag) ? '/' . $tag : ''));
 806         }
 807      case 'allrss':
 808         return common_path($args['nickname'].'/all/rss');
 809      case 'repliesrss':
 810         return common_path($args['nickname'].'/replies/rss');
 811      case 'userrss':
 812         if (isset($args['limit']))
 813           return common_path($args['nickname'].'/rss?limit=' . $args['limit']);
 814         return common_path($args['nickname'].'/rss');
 815      case 'showstream':
 816         if ($args && isset($args['page'])) {
 817             return common_path($args['nickname'].'?page=' . $args['page']);
 818         } else {
 819             return common_path($args['nickname']);
 820         }
 821
 822      case 'usertimeline':
 823         return common_path("api/statuses/user_timeline/".$args['nickname'].".atom");
 824      case 'confirmaddress':
 825         return common_path('main/confirmaddress/'.$args['code']);
 826      case 'userbyid':
 827         return common_path('user/'.$args['id']);
 828      case 'recoverpassword':
 829         $path = 'main/recoverpassword';
 830         if ($args['code']) {
 831             $path .= '/' . $args['code'];
 832         }
 833         return common_path($path);
 834      case 'imsettings':
 835         return common_path('settings/im');
 836      case 'avatarsettings':
 837         return common_path('settings/avatar');
 838      case 'groupsearch':
 839         return common_path('search/group' . (($args) ? ('?' . http_build_query($args)) : ''));
 840      case 'peoplesearch':
 841         return common_path('search/people' . (($args) ? ('?' . http_build_query($args)) : ''));
 842      case 'noticesearch':
 843         return common_path('search/notice' . (($args) ? ('?' . http_build_query($args)) : ''));
 844      case 'noticesearchrss':
 845         return common_path('search/notice/rss' . (($args) ? ('?' . http_build_query($args)) : ''));
 846      case 'avatarbynickname':
 847         return common_path($args['nickname'].'/avatar/'.$args['size']);
 848      case 'tag':
 849         $path = 'tag/' . $args['tag'];
 850         unset($args['tag']);
 851         return common_path($path . (($args) ? ('?' . http_build_query($args)) : ''));
 852      case 'publictagcloud':
 853         return common_path('tags');
 854      case 'peopletag':
 855         $path = 'peopletag/' . $args['tag'];
 856         unset($args['tag']);
 857         return common_path($path . (($args) ? ('?' . http_build_query($args)) : ''));
 858      case 'tags':
 859         return common_path('tags' . (($args) ? ('?' . http_build_query($args)) : ''));
 860      case 'favor':
 861         return common_path('main/favor');
 862      case 'disfavor':
 863         return common_path('main/disfavor');
 864      case 'showfavorites':
 865         if ($args && isset($args['page'])) {
 866             return common_path($args['nickname'].'/favorites?page=' . $args['page']);
 867         } else {
 868             return common_path($args['nickname'].'/favorites');
 869         }
 870      case 'favoritesrss':
 871         return common_path($args['nickname'].'/favorites/rss');
 872      case 'showmessage':
 873         return common_path('message/' . $args['message']);
 874      case 'newmessage':
 875         return common_path('message/new' . (($args) ? ('?' . http_build_query($args)) : ''));
 876      case 'api':
 877         // XXX: do fancy URLs for all the API methods
 878         switch (strtolower($args['apiaction'])) {
 879          case 'statuses':
 880             switch (strtolower($args['method'])) {
 881              case 'user_timeline.rss':
 882                 return common_path('api/statuses/user_timeline/'.$args['argument'].'.rss');
 883              case 'user_timeline.atom':
 884                 return common_path('api/statuses/user_timeline/'.$args['argument'].'.atom');
 885              case 'user_timeline.json':
 886                 return common_path('api/statuses/user_timeline/'.$args['argument'].'.json');
 887              case 'user_timeline.xml':
 888                 return common_path('api/statuses/user_timeline/'.$args['argument'].'.xml');
 889              default: return common_simple_url($action, $args);
 890             }
 891          default: return common_simple_url($action, $args);
 892         }
 893      case 'sup':
 894         if ($args && isset($args['seconds'])) {
 895             return common_path('main/sup?seconds='.$args['seconds']);
 896         } else {
 897             return common_path('main/sup');
 898         }
 899      case 'newgroup':
 900         return common_path('group/new');
 901      case 'showgroup':
 902         return common_path('group/'.$args['nickname'] . (($args['page']) ? ('?page=' . $args['page']) : ''));
 903      case 'editgroup':
 904         return common_path('group/'.$args['nickname'].'/edit');
 905      case 'joingroup':
 906         return common_path('group/'.$args['nickname'].'/join');
 907      case 'leavegroup':
 908         return common_path('group/'.$args['nickname'].'/leave');
 909      case 'groupbyid':
 910         return common_path('group/'.$args['id'].'/id');
 911      case 'grouprss':
 912         return common_path('group/'.$args['nickname'].'/rss');
 913      case 'groupmembers':
 914         return common_path('group/'.$args['nickname'].'/members' . (($args['page']) ? ('?page=' . $args['page']) : ''));
 915      case 'grouplogo':
 916         return common_path('group/'.$args['nickname'].'/logo');
 917      case 'usergroups':
 918         $nickname = $args['nickname'];
 919         unset($args['nickname']);
 920         return common_path($nickname.'/groups' . (($args) ? ('?' . http_build_query($args)) : ''));
 921      case 'groups':
 922         return common_path('group' . (($args) ? ('?' . http_build_query($args)) : ''));
 923      default:
 924         return common_simple_url($action, $args);
 925     }
 926 }
 927
 928 function common_simple_url($action, $args=null)
 929 {
 930     global $config;
 931     /* XXX: pretty URLs */
 932     $extra = '';
 933     if ($args) {
 934         foreach ($args as $key => $value) {
 935             $extra .= "&${key}=${value}";
 936         }
 937     }
 938     return common_path("index.php?action=${action}${extra}");
 939 }
 940
 941 function common_path($relative)
 942 {
 943     global $config;
 944     $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
 945     return "http://".$config['site']['server'].'/'.$pathpart.$relative;
 946 }
 947
 948 function common_date_string($dt)
 949 {
 950     // XXX: do some sexy date formatting
 951     // return date(DATE_RFC822, $dt);
 952     $t = strtotime($dt);
 953     $now = time();
 954     $diff = $now - $t;
 955
 956     if ($now < $t) { // that shouldn't happen!
 957         return common_exact_date($dt);
 958     } else if ($diff < 60) {
 959         return _('a few seconds ago');
 960     } else if ($diff < 92) {
 961         return _('about a minute ago');
 962     } else if ($diff < 3300) {
 963         return sprintf(_('about %d minutes ago'), round($diff/60));
 964     } else if ($diff < 5400) {
 965         return _('about an hour ago');
 966     } else if ($diff < 22 * 3600) {
 967         return sprintf(_('about %d hours ago'), round($diff/3600));
 968     } else if ($diff < 37 * 3600) {
 969         return _('about a day ago');
 970     } else if ($diff < 24 * 24 * 3600) {
 971         return sprintf(_('about %d days ago'), round($diff/(24*3600)));
 972     } else if ($diff < 46 * 24 * 3600) {
 973         return _('about a month ago');
 974     } else if ($diff < 330 * 24 * 3600) {
 975         return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
 976     } else if ($diff < 480 * 24 * 3600) {
 977         return _('about a year ago');
 978     } else {
 979         return common_exact_date($dt);
 980     }
 981 }
 982
 983 function common_exact_date($dt)
 984 {
 985     static $_utc;
 986     static $_siteTz;
 987
 988     if (!$_utc) {
 989         $_utc = new DateTimeZone('UTC');
 990         $_siteTz = new DateTimeZone(common_timezone());
 991     }
 992
 993     $dateStr = date('d F Y H:i:s', strtotime($dt));
 994     $d = new DateTime($dateStr, $_utc);
 995     $d->setTimezone($_siteTz);
 996     return $d->format(DATE_RFC850);
 997 }
 998
 999 function common_date_w3dtf($dt)
1000 {
1001     $dateStr = date('d F Y H:i:s', strtotime($dt));
1002     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1003     $d->setTimezone(new DateTimeZone(common_timezone()));
1004     return $d->format(DATE_W3C);
1005 }
1006
1007 function common_date_rfc2822($dt)
1008 {
1009     $dateStr = date('d F Y H:i:s', strtotime($dt));
1010     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1011     $d->setTimezone(new DateTimeZone(common_timezone()));
1012     return $d->format('r');
1013 }
1014
1015 function common_date_iso8601($dt)
1016 {
1017     $dateStr = date('d F Y H:i:s', strtotime($dt));
1018     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1019     $d->setTimezone(new DateTimeZone(common_timezone()));
1020     return $d->format('c');
1021 }
1022
1023 function common_sql_now()
1024 {
1025     return strftime('%Y-%m-%d %H:%M:%S', time());
1026 }
1027
1028 function common_redirect($url, $code=307)
1029 {
1030     static $status = array(301 => "Moved Permanently",
1031                            302 => "Found",
1032                            303 => "See Other",
1033                            307 => "Temporary Redirect");
1034
1035     header("Status: ${code} $status[$code]");
1036     header("Location: $url");
1037
1038     $xo = new XMLOutputter();
1039     $xo->startXML('a',
1040                   '-//W3C//DTD XHTML 1.0 Strict//EN',
1041                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1042     $xo->element('a', array('href' => $url), $url);
1043     $xo->endXML();
1044     exit;
1045 }
1046
1047 function common_broadcast_notice($notice, $remote=false)
1048 {
1049
1050     // Check to see if notice should go to Twitter
1051     $flink = Foreign_link::getByUserID($notice->profile_id, 1); // 1 == Twitter
1052     if (($flink->noticesync & FOREIGN_NOTICE_SEND) == FOREIGN_NOTICE_SEND) {
1053
1054         // If it's not a Twitter-style reply, or if the user WANTS to send replies...
1055
1056         if (!preg_match('/^@[a-zA-Z0-9_]{1,15}\b/u', $notice->content) ||
1057             (($flink->noticesync & FOREIGN_NOTICE_SEND_REPLY) == FOREIGN_NOTICE_SEND_REPLY)) {
1058
1059             $result = common_twitter_broadcast($notice, $flink);
1060
1061             if (!$result) {
1062                 common_debug('Unable to send notice: ' . $notice->id . ' to Twitter.', __FILE__);
1063             }
1064         }
1065     }
1066
1067     if (common_config('queue', 'enabled')) {
1068         // Do it later!
1069         return common_enqueue_notice($notice);
1070     } else {
1071         return common_real_broadcast($notice, $remote);
1072     }
1073 }
1074
1075 function common_twitter_broadcast($notice, $flink)
1076 {
1077     global $config;
1078     $success = true;
1079     $fuser = $flink->getForeignUser();
1080     $twitter_user = $fuser->nickname;
1081     $twitter_password = $flink->credentials;
1082     $uri = 'http://www.twitter.com/statuses/update.json';
1083
1084     // XXX: Hack to get around PHP cURL's use of @ being a a meta character
1085     $statustxt = preg_replace('/^@/', ' @', $notice->content);
1086
1087     $options = array(
1088                      CURLOPT_USERPWD         => "$twitter_user:$twitter_password",
1089                      CURLOPT_POST            => true,
1090                      CURLOPT_POSTFIELDS        => array(
1091                                                         'status'    => $statustxt,
1092                                                         'source'    => $config['integration']['source']
1093                                                         ),
1094                      CURLOPT_RETURNTRANSFER    => true,
1095                      CURLOPT_FAILONERROR        => true,
1096                      CURLOPT_HEADER            => false,
1097                      CURLOPT_FOLLOWLOCATION    => true,
1098                      CURLOPT_USERAGENT        => "Laconica",
1099                      CURLOPT_CONNECTTIMEOUT    => 120,  // XXX: Scary!!!! How long should this be?
1100                      CURLOPT_TIMEOUT            => 120,
1101
1102                      # Twitter is strict about accepting invalid "Expect" headers
1103                      CURLOPT_HTTPHEADER => array('Expect:')
1104                      );
1105
1106     $ch = curl_init($uri);
1107     curl_setopt_array($ch, $options);
1108     $data = curl_exec($ch);
1109     $errmsg = curl_error($ch);
1110
1111     if ($errmsg) {
1112         common_debug("cURL error: $errmsg - trying to send notice for $twitter_user.",
1113                      __FILE__);
1114         $success = false;
1115     }
1116
1117     curl_close($ch);
1118
1119     if (!$data) {
1120         common_debug("No data returned by Twitter's API trying to send update for $twitter_user",
1121                      __FILE__);
1122         $success = false;
1123     }
1124
1125     // Twitter should return a status
1126     $status = json_decode($data);
1127
1128     if (!$status->id) {
1129         common_debug("Unexpected data returned by Twitter API trying to send update for $twitter_user",
1130                      __FILE__);
1131         $success = false;
1132     }
1133
1134     return $success;
1135 }
1136
1137 // Stick the notice on the queue
1138
1139 function common_enqueue_notice($notice)
1140 {
1141     if (common_config('queue','subsystem') == 'stomp') {
1142         // use an external message queue system via STOMP
1143         require_once("Stomp.php");
1144         $con = new Stomp(common_config('queue','stomp_server'));
1145         if (!$con->connect()) {
1146                 common_log(LOG_ERR, 'Failed to connect to queue server');
1147                 return false;
1148         }
1149         $queue_basename = common_config('queue','queue_basename');
1150         foreach (array('jabber', 'omb', 'sms', 'public') as $transport) {
1151                 if (!$con->send(
1152                         '/queue/'.$queue_basename.'-'.$transport, // QUEUE
1153                         $notice->id,            // BODY of the message
1154                         array (                 // HEADERS of the msg
1155                         'created' => $notice->created
1156                         ))) {
1157                         common_log(LOG_ERR, 'Error sending to '.$transport.' queue');
1158                         return false;
1159                 }
1160         common_log(LOG_DEBUG, 'complete remote queueing notice ID = ' . $notice->id . ' for ' . $transport);
1161         }
1162         $con->send('/topic/laconica.'.$notice->profile_id,
1163                         $notice->content,
1164                         array(
1165                                 'profile_id' => $notice->profile_id,
1166                                 'created' => $notice->created
1167                                 )
1168                         );
1169         $con->send('/topic/laconica.allusers',
1170                         $notice->content,
1171                         array(
1172                                 'profile_id' => $notice->profile_id,
1173                                 'created' => $notice->created
1174                                 )
1175                         );
1176         $result = true;
1177     }
1178     else {
1179         // in any other case, 'internal'
1180         foreach (array('jabber', 'omb', 'sms', 'public') as $transport) {
1181                 $qi = new Queue_item();
1182                 $qi->notice_id = $notice->id;
1183                 $qi->transport = $transport;
1184                 $qi->created = $notice->created;
1185                 $result = $qi->insert();
1186                 if (!$result) {
1187                     $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1188                     common_log(LOG_ERR, 'DB error inserting queue item: ' . $last_error->message);
1189                     return false;
1190                 }
1191                 common_log(LOG_DEBUG, 'complete queueing notice ID = ' . $notice->id . ' for ' . $transport);
1192         }
1193     }
1194     return $result;
1195 }
1196
1197 function common_real_broadcast($notice, $remote=false)
1198 {
1199     $success = true;
1200     if (!$remote) {
1201         // Make sure we have the OMB stuff
1202         require_once(INSTALLDIR.'/lib/omb.php');
1203         $success = omb_broadcast_remote_subscribers($notice);
1204         if (!$success) {
1205             common_log(LOG_ERR, 'Error in OMB broadcast for notice ' . $notice->id);
1206         }
1207     }
1208     if ($success) {
1209         require_once(INSTALLDIR.'/lib/jabber.php');
1210         $success = jabber_broadcast_notice($notice);
1211         if (!$success) {
1212             common_log(LOG_ERR, 'Error in jabber broadcast for notice ' . $notice->id);
1213         }
1214     }
1215     if ($success) {
1216         require_once(INSTALLDIR.'/lib/mail.php');
1217         $success = mail_broadcast_notice_sms($notice);
1218         if (!$success) {
1219             common_log(LOG_ERR, 'Error in sms broadcast for notice ' . $notice->id);
1220         }
1221     }
1222     if ($success) {
1223         $success = jabber_public_notice($notice);
1224         if (!$success) {
1225             common_log(LOG_ERR, 'Error in public broadcast for notice ' . $notice->id);
1226         }
1227     }
1228     // XXX: broadcast notices to other IM
1229     return $success;
1230 }
1231
1232 function common_broadcast_profile($profile)
1233 {
1234     // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
1235     require_once(INSTALLDIR.'/lib/omb.php');
1236     omb_broadcast_profile($profile);
1237     // XXX: Other broadcasts...?
1238     return true;
1239 }
1240
1241 function common_profile_url($nickname)
1242 {
1243     return common_local_url('showstream', array('nickname' => $nickname));
1244 }
1245
1246 // Should make up a reasonable root URL
1247
1248 function common_root_url()
1249 {
1250     return common_path('');
1251 }
1252
1253 // returns $bytes bytes of random data as a hexadecimal string
1254 // "good" here is a goal and not a guarantee
1255
1256 function common_good_rand($bytes)
1257 {
1258     // XXX: use random.org...?
1259     if (file_exists('/dev/urandom')) {
1260         return common_urandom($bytes);
1261     } else { // FIXME: this is probably not good enough
1262         return common_mtrand($bytes);
1263     }
1264 }
1265
1266 function common_urandom($bytes)
1267 {
1268     $h = fopen('/dev/urandom', 'rb');
1269     // should not block
1270     $src = fread($h, $bytes);
1271     fclose($h);
1272     $enc = '';
1273     for ($i = 0; $i < $bytes; $i++) {
1274         $enc .= sprintf("%02x", (ord($src[$i])));
1275     }
1276     return $enc;
1277 }
1278
1279 function common_mtrand($bytes)
1280 {
1281     $enc = '';
1282     for ($i = 0; $i < $bytes; $i++) {
1283         $enc .= sprintf("%02x", mt_rand(0, 255));
1284     }
1285     return $enc;
1286 }
1287
1288 function common_set_returnto($url)
1289 {
1290     common_ensure_session();
1291     $_SESSION['returnto'] = $url;
1292 }
1293
1294 function common_get_returnto()
1295 {
1296     common_ensure_session();
1297     return $_SESSION['returnto'];
1298 }
1299
1300 function common_timestamp()
1301 {
1302     return date('YmdHis');
1303 }
1304
1305 function common_ensure_syslog()
1306 {
1307     static $initialized = false;
1308     if (!$initialized) {
1309         global $config;
1310         openlog($config['syslog']['appname'], 0, LOG_USER);
1311         $initialized = true;
1312     }
1313 }
1314
1315 function common_log($priority, $msg, $filename=null)
1316 {
1317     $logfile = common_config('site', 'logfile');
1318     if ($logfile) {
1319         $log = fopen($logfile, "a");
1320         if ($log) {
1321             static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1322                                               'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1323             $output = date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
1324             fwrite($log, $output);
1325             fclose($log);
1326         }
1327     } else {
1328         common_ensure_syslog();
1329         syslog($priority, $msg);
1330     }
1331 }
1332
1333 function common_debug($msg, $filename=null)
1334 {
1335     if ($filename) {
1336         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1337     } else {
1338         common_log(LOG_DEBUG, $msg);
1339     }
1340 }
1341
1342 function common_log_db_error(&$object, $verb, $filename=null)
1343 {
1344     $objstr = common_log_objstring($object);
1345     $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1346     common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1347 }
1348
1349 function common_log_objstring(&$object)
1350 {
1351     if (is_null($object)) {
1352         return "null";
1353     }
1354     $arr = $object->toArray();
1355     $fields = array();
1356     foreach ($arr as $k => $v) {
1357         $fields[] = "$k='$v'";
1358     }
1359     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1360     return $objstring;
1361 }
1362
1363 function common_valid_http_url($url)
1364 {
1365     return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1366 }
1367
1368 function common_valid_tag($tag)
1369 {
1370     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1371         return (Validate::email($matches[1]) ||
1372                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1373     }
1374     return false;
1375 }
1376
1377 /* Following functions are copied from MediaWiki GlobalFunctions.php
1378  * and written by Evan Prodromou. */
1379
1380 function common_accept_to_prefs($accept, $def = '*/*')
1381 {
1382     // No arg means accept anything (per HTTP spec)
1383     if(!$accept) {
1384         return array($def => 1);
1385     }
1386
1387     $prefs = array();
1388
1389     $parts = explode(',', $accept);
1390
1391     foreach($parts as $part) {
1392         // FIXME: doesn't deal with params like 'text/html; level=1'
1393         @list($value, $qpart) = explode(';', $part);
1394         $match = array();
1395         if(!isset($qpart)) {
1396             $prefs[$value] = 1;
1397         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1398             $prefs[$value] = $match[1];
1399         }
1400     }
1401
1402     return $prefs;
1403 }
1404
1405 function common_mime_type_match($type, $avail)
1406 {
1407     if(array_key_exists($type, $avail)) {
1408         return $type;
1409     } else {
1410         $parts = explode('/', $type);
1411         if(array_key_exists($parts[0] . '/*', $avail)) {
1412             return $parts[0] . '/*';
1413         } elseif(array_key_exists('*/*', $avail)) {
1414             return '*/*';
1415         } else {
1416             return null;
1417         }
1418     }
1419 }
1420
1421 function common_negotiate_type($cprefs, $sprefs)
1422 {
1423     $combine = array();
1424
1425     foreach(array_keys($sprefs) as $type) {
1426         $parts = explode('/', $type);
1427         if($parts[1] != '*') {
1428             $ckey = common_mime_type_match($type, $cprefs);
1429             if($ckey) {
1430                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1431             }
1432         }
1433     }
1434
1435     foreach(array_keys($cprefs) as $type) {
1436         $parts = explode('/', $type);
1437         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1438             $skey = common_mime_type_match($type, $sprefs);
1439             if($skey) {
1440                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1441             }
1442         }
1443     }
1444
1445     $bestq = 0;
1446     $besttype = 'text/html';
1447
1448     foreach(array_keys($combine) as $type) {
1449         if($combine[$type] > $bestq) {
1450             $besttype = $type;
1451             $bestq = $combine[$type];
1452         }
1453     }
1454
1455     if ('text/html' === $besttype) {
1456         return "text/html; charset=utf-8";
1457     }
1458     return $besttype;
1459 }
1460
1461 function common_config($main, $sub)
1462 {
1463     global $config;
1464     return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1465 }
1466
1467 function common_copy_args($from)
1468 {
1469     $to = array();
1470     $strip = get_magic_quotes_gpc();
1471     foreach ($from as $k => $v) {
1472         $to[$k] = ($strip) ? stripslashes($v) : $v;
1473     }
1474     return $to;
1475 }
1476
1477 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1478 // This is used before handing a request off to OAuthRequest::from_request.
1479 function common_remove_magic_from_request()
1480 {
1481     if(get_magic_quotes_gpc()) {
1482         $_POST=array_map('stripslashes',$_POST);
1483         $_GET=array_map('stripslashes',$_GET);
1484     }
1485 }
1486
1487 function common_user_uri(&$user)
1488 {
1489     return common_local_url('userbyid', array('id' => $user->id));
1490 }
1491
1492 function common_notice_uri(&$notice)
1493 {
1494     return common_local_url('shownotice',
1495                             array('notice' => $notice->id));
1496 }
1497
1498 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1499
1500 function common_confirmation_code($bits)
1501 {
1502     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1503     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1504     $chars = ceil($bits/5);
1505     $code = '';
1506     for ($i = 0; $i < $chars; $i++) {
1507         // XXX: convert to string and back
1508         $num = hexdec(common_good_rand(1));
1509         // XXX: randomness is too precious to throw away almost
1510         // 40% of the bits we get!
1511         $code .= $codechars[$num%32];
1512     }
1513     return $code;
1514 }
1515
1516 // convert markup to HTML
1517
1518 function common_markup_to_html($c)
1519 {
1520     $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1521     $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1522     $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1523     return Markdown($c);
1524 }
1525
1526 function common_profile_uri($profile)
1527 {
1528     if (!$profile) {
1529         return null;
1530     }
1531     $user = User::staticGet($profile->id);
1532     if ($user) {
1533         return $user->uri;
1534     }
1535
1536     $remote = Remote_profile::staticGet($profile->id);
1537     if ($remote) {
1538         return $remote->uri;
1539     }
1540     // XXX: this is a very bad profile!
1541     return null;
1542 }
1543
1544 function common_canonical_sms($sms)
1545 {
1546     // strip non-digits
1547     preg_replace('/\D/', '', $sms);
1548     return $sms;
1549 }
1550
1551 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1552 {
1553     switch ($errno) {
1554      case E_USER_ERROR:
1555         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline)");
1556         exit(1);
1557         break;
1558
1559      case E_USER_WARNING:
1560         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1561         break;
1562
1563      case E_USER_NOTICE:
1564         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1565         break;
1566     }
1567
1568     // FIXME: show error page if we're on the Web
1569     /* Don't execute PHP internal error handler */
1570     return true;
1571 }
1572
1573 function common_session_token()
1574 {
1575     common_ensure_session();
1576     if (!array_key_exists('token', $_SESSION)) {
1577         $_SESSION['token'] = common_good_rand(64);
1578     }
1579     return $_SESSION['token'];
1580 }
1581
1582 function common_cache_key($extra)
1583 {
1584     return 'laconica:' . common_keyize(common_config('site', 'name')) . ':' . $extra;
1585 }
1586
1587 function common_keyize($str)
1588 {
1589     $str = strtolower($str);
1590     $str = preg_replace('/\s/', '_', $str);
1591     return $str;
1592 }
1593
1594 function common_memcache()
1595 {
1596     static $cache = null;
1597     if (!common_config('memcached', 'enabled')) {
1598         return null;
1599     } else {
1600         if (!$cache) {
1601             $cache = new Memcache();
1602             $servers = common_config('memcached', 'server');
1603             if (is_array($servers)) {
1604                 foreach($servers as $server) {
1605                     $cache->addServer($server);
1606                 }
1607             } else {
1608                 $cache->addServer($servers);
1609             }
1610         }
1611         return $cache;
1612     }
1613 }
1614
1615 function common_compatible_license($from, $to)
1616 {
1617     // XXX: better compatibility check needed here!
1618     return ($from == $to);
1619 }