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 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         // 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     $url = null;
 676     if (common_config('site','fancy')) {
 677         $url = common_fancy_url($action, $args);
 678     } else {
 679         $url = common_simple_url($action, $args);
 680     }
 681     if (!is_null($fragment)) {
 682         $url .= '#'.$fragment;
 683     }
 684     return $url;
 685 }
 686
 687 function common_fancy_url($action, $args=null)
 688 {
 689     switch (strtolower($action)) {
 690      case 'public':
 691         if ($args && isset($args['page'])) {
 692             return common_path('?page=' . $args['page']);
 693         } else {
 694             return common_path('');
 695         }
 696      case 'featured':
 697         if ($args && isset($args['page'])) {
 698             return common_path('featured?page=' . $args['page']);
 699         } else {
 700             return common_path('featured');
 701         }
 702      case 'favorited':
 703         if ($args && isset($args['page'])) {
 704             return common_path('favorited?page=' . $args['page']);
 705         } else {
 706             return common_path('favorited');
 707         }
 708      case 'publicrss':
 709         return common_path('rss');
 710      case 'publicatom':
 711         return common_path("api/statuses/public_timeline.atom");
 712      case 'publicxrds':
 713         return common_path('xrds');
 714      case 'tagrss':
 715         return common_path('tag/' . $args['tag'] . '/rss');
 716      case 'featuredrss':
 717         return common_path('featuredrss');
 718      case 'favoritedrss':
 719         return common_path('favoritedrss');
 720      case 'opensearch':
 721         if ($args && $args['type']) {
 722             return common_path('opensearch/'.$args['type']);
 723         } else {
 724             return common_path('opensearch/people');
 725         }
 726      case 'doc':
 727         return common_path('doc/'.$args['title']);
 728      case 'block':
 729      case 'login':
 730      case 'logout':
 731      case 'subscribe':
 732      case 'unsubscribe':
 733      case 'invite':
 734         return common_path('main/'.$action);
 735      case 'tagother':
 736         return common_path('main/tagother?id='.$args['id']);
 737      case 'register':
 738         if ($args && $args['code']) {
 739             return common_path('main/register/'.$args['code']);
 740         } else {
 741             return common_path('main/register');
 742         }
 743      case 'remotesubscribe':
 744         if ($args && $args['nickname']) {
 745             return common_path('main/remote?nickname=' . $args['nickname']);
 746         } else {
 747             return common_path('main/remote');
 748         }
 749      case 'nudge':
 750         return common_path($args['nickname'].'/nudge');
 751      case 'openidlogin':
 752         return common_path('main/openid');
 753      case 'profilesettings':
 754         return common_path('settings/profile');
 755      case 'passwordsettings':
 756         return common_path('settings/password');
 757      case 'emailsettings':
 758         return common_path('settings/email');
 759      case 'openidsettings':
 760         return common_path('settings/openid');
 761      case 'smssettings':
 762         return common_path('settings/sms');
 763      case 'twittersettings':
 764         return common_path('settings/twitter');
 765      case 'othersettings':
 766         return common_path('settings/other');
 767      case 'deleteprofile':
 768         return common_path('settings/delete');
 769      case 'newnotice':
 770         if ($args && $args['replyto']) {
 771             return common_path('notice/new?replyto='.$args['replyto']);
 772         } else {
 773             return common_path('notice/new');
 774         }
 775      case 'shownotice':
 776         return common_path('notice/'.$args['notice']);
 777      case 'deletenotice':
 778         if ($args && $args['notice']) {
 779             return common_path('notice/delete/'.$args['notice']);
 780         } else {
 781             return common_path('notice/delete');
 782         }
 783      case 'microsummary':
 784      case 'xrds':
 785      case 'foaf':
 786         return common_path($args['nickname'].'/'.$action);
 787      case 'all':
 788      case 'replies':
 789      case 'inbox':
 790      case 'outbox':
 791         if ($args && isset($args['page'])) {
 792             return common_path($args['nickname'].'/'.$action.'?page=' . $args['page']);
 793         } else {
 794             return common_path($args['nickname'].'/'.$action);
 795         }
 796      case 'subscriptions':
 797      case 'subscribers':
 798         $nickname = $args['nickname'];
 799         unset($args['nickname']);
 800         if (isset($args['tag'])) {
 801             $tag = $args['tag'];
 802             unset($args['tag']);
 803         }
 804         $params = http_build_query($args);
 805         if ($params) {
 806             return common_path($nickname.'/'.$action . (($tag) ? '/' . $tag : '') . '?' . $params);
 807         } else {
 808             return common_path($nickname.'/'.$action . (($tag) ? '/' . $tag : ''));
 809         }
 810      case 'allrss':
 811         return common_path($args['nickname'].'/all/rss');
 812      case 'repliesrss':
 813         return common_path($args['nickname'].'/replies/rss');
 814      case 'userrss':
 815         if (isset($args['limit']))
 816           return common_path($args['nickname'].'/rss?limit=' . $args['limit']);
 817         return common_path($args['nickname'].'/rss');
 818      case 'showstream':
 819         if ($args && isset($args['page'])) {
 820             return common_path($args['nickname'].'?page=' . $args['page']);
 821         } else {
 822             return common_path($args['nickname']);
 823         }
 824
 825      case 'usertimeline':
 826         return common_path("api/statuses/user_timeline/".$args['nickname'].".atom");
 827      case 'confirmaddress':
 828         return common_path('main/confirmaddress/'.$args['code']);
 829      case 'userbyid':
 830         return common_path('user/'.$args['id']);
 831      case 'recoverpassword':
 832         $path = 'main/recoverpassword';
 833         if ($args['code']) {
 834             $path .= '/' . $args['code'];
 835         }
 836         return common_path($path);
 837      case 'imsettings':
 838         return common_path('settings/im');
 839      case 'avatarsettings':
 840         return common_path('settings/avatar');
 841      case 'groupsearch':
 842         return common_path('search/group' . (($args) ? ('?' . http_build_query($args)) : ''));
 843      case 'peoplesearch':
 844         return common_path('search/people' . (($args) ? ('?' . http_build_query($args)) : ''));
 845      case 'noticesearch':
 846         return common_path('search/notice' . (($args) ? ('?' . http_build_query($args)) : ''));
 847      case 'noticesearchrss':
 848         return common_path('search/notice/rss' . (($args) ? ('?' . http_build_query($args)) : ''));
 849      case 'avatarbynickname':
 850         return common_path($args['nickname'].'/avatar/'.$args['size']);
 851      case 'tag':
 852         $path = 'tag/' . $args['tag'];
 853         unset($args['tag']);
 854         return common_path($path . (($args) ? ('?' . http_build_query($args)) : ''));
 855      case 'publictagcloud':
 856         return common_path('tags');
 857      case 'peopletag':
 858         $path = 'peopletag/' . $args['tag'];
 859         unset($args['tag']);
 860         return common_path($path . (($args) ? ('?' . http_build_query($args)) : ''));
 861      case 'tags':
 862         return common_path('tags' . (($args) ? ('?' . http_build_query($args)) : ''));
 863      case 'favor':
 864         return common_path('main/favor');
 865      case 'disfavor':
 866         return common_path('main/disfavor');
 867      case 'showfavorites':
 868         if ($args && isset($args['page'])) {
 869             return common_path($args['nickname'].'/favorites?page=' . $args['page']);
 870         } else {
 871             return common_path($args['nickname'].'/favorites');
 872         }
 873      case 'favoritesrss':
 874         return common_path($args['nickname'].'/favorites/rss');
 875      case 'showmessage':
 876         return common_path('message/' . $args['message']);
 877      case 'newmessage':
 878         return common_path('message/new' . (($args) ? ('?' . http_build_query($args)) : ''));
 879      case 'api':
 880         // XXX: do fancy URLs for all the API methods
 881         switch (strtolower($args['apiaction'])) {
 882          case 'statuses':
 883             switch (strtolower($args['method'])) {
 884              case 'user_timeline.rss':
 885                 return common_path('api/statuses/user_timeline/'.$args['argument'].'.rss');
 886              case 'user_timeline.atom':
 887                 return common_path('api/statuses/user_timeline/'.$args['argument'].'.atom');
 888              case 'user_timeline.json':
 889                 return common_path('api/statuses/user_timeline/'.$args['argument'].'.json');
 890              case 'user_timeline.xml':
 891                 return common_path('api/statuses/user_timeline/'.$args['argument'].'.xml');
 892              default: return common_simple_url($action, $args);
 893             }
 894          default: return common_simple_url($action, $args);
 895         }
 896      case 'sup':
 897         if ($args && isset($args['seconds'])) {
 898             return common_path('main/sup?seconds='.$args['seconds']);
 899         } else {
 900             return common_path('main/sup');
 901         }
 902      case 'newgroup':
 903         return common_path('group/new');
 904      case 'showgroup':
 905         return common_path('group/'.$args['nickname'] . (($args['page']) ? ('?page=' . $args['page']) : ''));
 906      case 'editgroup':
 907         return common_path('group/'.$args['nickname'].'/edit');
 908      case 'joingroup':
 909         return common_path('group/'.$args['nickname'].'/join');
 910      case 'leavegroup':
 911         return common_path('group/'.$args['nickname'].'/leave');
 912      case 'groupbyid':
 913         return common_path('group/'.$args['id'].'/id');
 914      case 'grouprss':
 915         return common_path('group/'.$args['nickname'].'/rss');
 916      case 'groupmembers':
 917         return common_path('group/'.$args['nickname'].'/members' . (($args['page']) ? ('?page=' . $args['page']) : ''));
 918      case 'grouplogo':
 919         return common_path('group/'.$args['nickname'].'/logo');
 920      case 'usergroups':
 921         $nickname = $args['nickname'];
 922         unset($args['nickname']);
 923         return common_path($nickname.'/groups' . (($args) ? ('?' . http_build_query($args)) : ''));
 924      case 'groups':
 925         return common_path('group' . (($args) ? ('?' . http_build_query($args)) : ''));
 926      default:
 927         return common_simple_url($action, $args);
 928     }
 929 }
 930
 931 function common_simple_url($action, $args=null)
 932 {
 933     global $config;
 934     /* XXX: pretty URLs */
 935     $extra = '';
 936     if ($args) {
 937         foreach ($args as $key => $value) {
 938             $extra .= "&${key}=${value}";
 939         }
 940     }
 941     return common_path("index.php?action=${action}${extra}");
 942 }
 943
 944 function common_path($relative)
 945 {
 946     global $config;
 947     $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
 948     return "http://".$config['site']['server'].'/'.$pathpart.$relative;
 949 }
 950
 951 function common_date_string($dt)
 952 {
 953     // XXX: do some sexy date formatting
 954     // return date(DATE_RFC822, $dt);
 955     $t = strtotime($dt);
 956     $now = time();
 957     $diff = $now - $t;
 958
 959     if ($now < $t) { // that shouldn't happen!
 960         return common_exact_date($dt);
 961     } else if ($diff < 60) {
 962         return _('a few seconds ago');
 963     } else if ($diff < 92) {
 964         return _('about a minute ago');
 965     } else if ($diff < 3300) {
 966         return sprintf(_('about %d minutes ago'), round($diff/60));
 967     } else if ($diff < 5400) {
 968         return _('about an hour ago');
 969     } else if ($diff < 22 * 3600) {
 970         return sprintf(_('about %d hours ago'), round($diff/3600));
 971     } else if ($diff < 37 * 3600) {
 972         return _('about a day ago');
 973     } else if ($diff < 24 * 24 * 3600) {
 974         return sprintf(_('about %d days ago'), round($diff/(24*3600)));
 975     } else if ($diff < 46 * 24 * 3600) {
 976         return _('about a month ago');
 977     } else if ($diff < 330 * 24 * 3600) {
 978         return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
 979     } else if ($diff < 480 * 24 * 3600) {
 980         return _('about a year ago');
 981     } else {
 982         return common_exact_date($dt);
 983     }
 984 }
 985
 986 function common_exact_date($dt)
 987 {
 988     static $_utc;
 989     static $_siteTz;
 990
 991     if (!$_utc) {
 992         $_utc = new DateTimeZone('UTC');
 993         $_siteTz = new DateTimeZone(common_timezone());
 994     }
 995
 996     $dateStr = date('d F Y H:i:s', strtotime($dt));
 997     $d = new DateTime($dateStr, $_utc);
 998     $d->setTimezone($_siteTz);
 999     return $d->format(DATE_RFC850);
1000 }
1001
1002 function common_date_w3dtf($dt)
1003 {
1004     $dateStr = date('d F Y H:i:s', strtotime($dt));
1005     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1006     $d->setTimezone(new DateTimeZone(common_timezone()));
1007     return $d->format(DATE_W3C);
1008 }
1009
1010 function common_date_rfc2822($dt)
1011 {
1012     $dateStr = date('d F Y H:i:s', strtotime($dt));
1013     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1014     $d->setTimezone(new DateTimeZone(common_timezone()));
1015     return $d->format('r');
1016 }
1017
1018 function common_date_iso8601($dt)
1019 {
1020     $dateStr = date('d F Y H:i:s', strtotime($dt));
1021     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1022     $d->setTimezone(new DateTimeZone(common_timezone()));
1023     return $d->format('c');
1024 }
1025
1026 function common_sql_now()
1027 {
1028     return strftime('%Y-%m-%d %H:%M:%S', time());
1029 }
1030
1031 function common_redirect($url, $code=307)
1032 {
1033     static $status = array(301 => "Moved Permanently",
1034                            302 => "Found",
1035                            303 => "See Other",
1036                            307 => "Temporary Redirect");
1037
1038     header("Status: ${code} $status[$code]");
1039     header("Location: $url");
1040
1041     $xo = new XMLOutputter();
1042     $xo->startXML('a',
1043                   '-//W3C//DTD XHTML 1.0 Strict//EN',
1044                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1045     $xo->element('a', array('href' => $url), $url);
1046     $xo->endXML();
1047     exit;
1048 }
1049
1050 function common_broadcast_notice($notice, $remote=false)
1051 {
1052
1053     // Check to see if notice should go to Twitter
1054     $flink = Foreign_link::getByUserID($notice->profile_id, 1); // 1 == Twitter
1055     if (($flink->noticesync & FOREIGN_NOTICE_SEND) == FOREIGN_NOTICE_SEND) {
1056
1057         // If it's not a Twitter-style reply, or if the user WANTS to send replies...
1058
1059         if (!preg_match('/^@[a-zA-Z0-9_]{1,15}\b/u', $notice->content) ||
1060             (($flink->noticesync & FOREIGN_NOTICE_SEND_REPLY) == FOREIGN_NOTICE_SEND_REPLY)) {
1061
1062             $result = common_twitter_broadcast($notice, $flink);
1063
1064             if (!$result) {
1065                 common_debug('Unable to send notice: ' . $notice->id . ' to Twitter.', __FILE__);
1066             }
1067         }
1068     }
1069
1070     if (common_config('queue', 'enabled')) {
1071         // Do it later!
1072         return common_enqueue_notice($notice);
1073     } else {
1074         return common_real_broadcast($notice, $remote);
1075     }
1076 }
1077
1078 function common_twitter_broadcast($notice, $flink)
1079 {
1080     global $config;
1081     $success = true;
1082     $fuser = $flink->getForeignUser();
1083     $twitter_user = $fuser->nickname;
1084     $twitter_password = $flink->credentials;
1085     $uri = 'http://www.twitter.com/statuses/update.json';
1086
1087     // XXX: Hack to get around PHP cURL's use of @ being a a meta character
1088     $statustxt = preg_replace('/^@/', ' @', $notice->content);
1089
1090     $options = array(
1091                      CURLOPT_USERPWD         => "$twitter_user:$twitter_password",
1092                      CURLOPT_POST            => true,
1093                      CURLOPT_POSTFIELDS        => array(
1094                                                         'status'    => $statustxt,
1095                                                         'source'    => $config['integration']['source']
1096                                                         ),
1097                      CURLOPT_RETURNTRANSFER    => true,
1098                      CURLOPT_FAILONERROR        => true,
1099                      CURLOPT_HEADER            => false,
1100                      CURLOPT_FOLLOWLOCATION    => true,
1101                      CURLOPT_USERAGENT        => "Laconica",
1102                      CURLOPT_CONNECTTIMEOUT    => 120,  // XXX: Scary!!!! How long should this be?
1103                      CURLOPT_TIMEOUT            => 120,
1104
1105                      # Twitter is strict about accepting invalid "Expect" headers
1106                      CURLOPT_HTTPHEADER => array('Expect:')
1107                      );
1108
1109     $ch = curl_init($uri);
1110     curl_setopt_array($ch, $options);
1111     $data = curl_exec($ch);
1112     $errmsg = curl_error($ch);
1113
1114     if ($errmsg) {
1115         common_debug("cURL error: $errmsg - trying to send notice for $twitter_user.",
1116                      __FILE__);
1117         $success = false;
1118     }
1119
1120     curl_close($ch);
1121
1122     if (!$data) {
1123         common_debug("No data returned by Twitter's API trying to send update for $twitter_user",
1124                      __FILE__);
1125         $success = false;
1126     }
1127
1128     // Twitter should return a status
1129     $status = json_decode($data);
1130
1131     if (!$status->id) {
1132         common_debug("Unexpected data returned by Twitter API trying to send update for $twitter_user",
1133                      __FILE__);
1134         $success = false;
1135     }
1136
1137     return $success;
1138 }
1139
1140 // Stick the notice on the queue
1141
1142 function common_enqueue_notice($notice)
1143 {
1144     foreach (array('jabber', 'omb', 'sms', 'public') as $transport) {
1145         $qi = new Queue_item();
1146         $qi->notice_id = $notice->id;
1147         $qi->transport = $transport;
1148         $qi->created = $notice->created;
1149         $result = $qi->insert();
1150         if (!$result) {
1151             $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1152             common_log(LOG_ERR, 'DB error inserting queue item: ' . $last_error->message);
1153             return false;
1154         }
1155         common_log(LOG_DEBUG, 'complete queueing notice ID = ' . $notice->id . ' for ' . $transport);
1156     }
1157     return $result;
1158 }
1159
1160 function common_real_broadcast($notice, $remote=false)
1161 {
1162     $success = true;
1163     if (!$remote) {
1164         // Make sure we have the OMB stuff
1165         require_once(INSTALLDIR.'/lib/omb.php');
1166         $success = omb_broadcast_remote_subscribers($notice);
1167         if (!$success) {
1168             common_log(LOG_ERR, 'Error in OMB broadcast for notice ' . $notice->id);
1169         }
1170     }
1171     if ($success) {
1172         require_once(INSTALLDIR.'/lib/jabber.php');
1173         $success = jabber_broadcast_notice($notice);
1174         if (!$success) {
1175             common_log(LOG_ERR, 'Error in jabber broadcast for notice ' . $notice->id);
1176         }
1177     }
1178     if ($success) {
1179         require_once(INSTALLDIR.'/lib/mail.php');
1180         $success = mail_broadcast_notice_sms($notice);
1181         if (!$success) {
1182             common_log(LOG_ERR, 'Error in sms broadcast for notice ' . $notice->id);
1183         }
1184     }
1185     if ($success) {
1186         $success = jabber_public_notice($notice);
1187         if (!$success) {
1188             common_log(LOG_ERR, 'Error in public broadcast for notice ' . $notice->id);
1189         }
1190     }
1191     // XXX: broadcast notices to other IM
1192     return $success;
1193 }
1194
1195 function common_broadcast_profile($profile)
1196 {
1197     // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
1198     require_once(INSTALLDIR.'/lib/omb.php');
1199     omb_broadcast_profile($profile);
1200     // XXX: Other broadcasts...?
1201     return true;
1202 }
1203
1204 function common_profile_url($nickname)
1205 {
1206     return common_local_url('showstream', array('nickname' => $nickname));
1207 }
1208
1209 // Should make up a reasonable root URL
1210
1211 function common_root_url()
1212 {
1213     return common_path('');
1214 }
1215
1216 // returns $bytes bytes of random data as a hexadecimal string
1217 // "good" here is a goal and not a guarantee
1218
1219 function common_good_rand($bytes)
1220 {
1221     // XXX: use random.org...?
1222     if (file_exists('/dev/urandom')) {
1223         return common_urandom($bytes);
1224     } else { // FIXME: this is probably not good enough
1225         return common_mtrand($bytes);
1226     }
1227 }
1228
1229 function common_urandom($bytes)
1230 {
1231     $h = fopen('/dev/urandom', 'rb');
1232     // should not block
1233     $src = fread($h, $bytes);
1234     fclose($h);
1235     $enc = '';
1236     for ($i = 0; $i < $bytes; $i++) {
1237         $enc .= sprintf("%02x", (ord($src[$i])));
1238     }
1239     return $enc;
1240 }
1241
1242 function common_mtrand($bytes)
1243 {
1244     $enc = '';
1245     for ($i = 0; $i < $bytes; $i++) {
1246         $enc .= sprintf("%02x", mt_rand(0, 255));
1247     }
1248     return $enc;
1249 }
1250
1251 function common_set_returnto($url)
1252 {
1253     common_ensure_session();
1254     $_SESSION['returnto'] = $url;
1255 }
1256
1257 function common_get_returnto()
1258 {
1259     common_ensure_session();
1260     return $_SESSION['returnto'];
1261 }
1262
1263 function common_timestamp()
1264 {
1265     return date('YmdHis');
1266 }
1267
1268 function common_ensure_syslog()
1269 {
1270     static $initialized = false;
1271     if (!$initialized) {
1272         global $config;
1273         openlog($config['syslog']['appname'], 0, LOG_USER);
1274         $initialized = true;
1275     }
1276 }
1277
1278 function common_log($priority, $msg, $filename=null)
1279 {
1280     $logfile = common_config('site', 'logfile');
1281     if ($logfile) {
1282         $log = fopen($logfile, "a");
1283         if ($log) {
1284             static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1285                                               'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1286             $output = date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
1287             fwrite($log, $output);
1288             fclose($log);
1289         }
1290     } else {
1291         common_ensure_syslog();
1292         syslog($priority, $msg);
1293     }
1294 }
1295
1296 function common_debug($msg, $filename=null)
1297 {
1298     if ($filename) {
1299         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1300     } else {
1301         common_log(LOG_DEBUG, $msg);
1302     }
1303 }
1304
1305 function common_log_db_error(&$object, $verb, $filename=null)
1306 {
1307     $objstr = common_log_objstring($object);
1308     $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1309     common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1310 }
1311
1312 function common_log_objstring(&$object)
1313 {
1314     if (is_null($object)) {
1315         return "null";
1316     }
1317     $arr = $object->toArray();
1318     $fields = array();
1319     foreach ($arr as $k => $v) {
1320         $fields[] = "$k='$v'";
1321     }
1322     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1323     return $objstring;
1324 }
1325
1326 function common_valid_http_url($url)
1327 {
1328     return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1329 }
1330
1331 function common_valid_tag($tag)
1332 {
1333     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1334         return (Validate::email($matches[1]) ||
1335                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1336     }
1337     return false;
1338 }
1339
1340 /* Following functions are copied from MediaWiki GlobalFunctions.php
1341  * and written by Evan Prodromou. */
1342
1343 function common_accept_to_prefs($accept, $def = '*/*')
1344 {
1345     // No arg means accept anything (per HTTP spec)
1346     if(!$accept) {
1347         return array($def => 1);
1348     }
1349
1350     $prefs = array();
1351
1352     $parts = explode(',', $accept);
1353
1354     foreach($parts as $part) {
1355         // FIXME: doesn't deal with params like 'text/html; level=1'
1356         @list($value, $qpart) = explode(';', $part);
1357         $match = array();
1358         if(!isset($qpart)) {
1359             $prefs[$value] = 1;
1360         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1361             $prefs[$value] = $match[1];
1362         }
1363     }
1364
1365     return $prefs;
1366 }
1367
1368 function common_mime_type_match($type, $avail)
1369 {
1370     if(array_key_exists($type, $avail)) {
1371         return $type;
1372     } else {
1373         $parts = explode('/', $type);
1374         if(array_key_exists($parts[0] . '/*', $avail)) {
1375             return $parts[0] . '/*';
1376         } elseif(array_key_exists('*/*', $avail)) {
1377             return '*/*';
1378         } else {
1379             return null;
1380         }
1381     }
1382 }
1383
1384 function common_negotiate_type($cprefs, $sprefs)
1385 {
1386     $combine = array();
1387
1388     foreach(array_keys($sprefs) as $type) {
1389         $parts = explode('/', $type);
1390         if($parts[1] != '*') {
1391             $ckey = common_mime_type_match($type, $cprefs);
1392             if($ckey) {
1393                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1394             }
1395         }
1396     }
1397
1398     foreach(array_keys($cprefs) as $type) {
1399         $parts = explode('/', $type);
1400         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1401             $skey = common_mime_type_match($type, $sprefs);
1402             if($skey) {
1403                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1404             }
1405         }
1406     }
1407
1408     $bestq = 0;
1409     $besttype = 'text/html';
1410
1411     foreach(array_keys($combine) as $type) {
1412         if($combine[$type] > $bestq) {
1413             $besttype = $type;
1414             $bestq = $combine[$type];
1415         }
1416     }
1417
1418     if ('text/html' === $besttype) {
1419         return "text/html; charset=utf-8";
1420     }
1421     return $besttype;
1422 }
1423
1424 function common_config($main, $sub)
1425 {
1426     global $config;
1427     return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1428 }
1429
1430 function common_copy_args($from)
1431 {
1432     $to = array();
1433     $strip = get_magic_quotes_gpc();
1434     foreach ($from as $k => $v) {
1435         $to[$k] = ($strip) ? stripslashes($v) : $v;
1436     }
1437     return $to;
1438 }
1439
1440 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1441 // This is used before handing a request off to OAuthRequest::from_request.
1442 function common_remove_magic_from_request()
1443 {
1444     if(get_magic_quotes_gpc()) {
1445         $_POST=array_map('stripslashes',$_POST);
1446         $_GET=array_map('stripslashes',$_GET);
1447     }
1448 }
1449
1450 function common_user_uri(&$user)
1451 {
1452     return common_local_url('userbyid', array('id' => $user->id));
1453 }
1454
1455 function common_notice_uri(&$notice)
1456 {
1457     return common_local_url('shownotice',
1458                             array('notice' => $notice->id));
1459 }
1460
1461 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1462
1463 function common_confirmation_code($bits)
1464 {
1465     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1466     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1467     $chars = ceil($bits/5);
1468     $code = '';
1469     for ($i = 0; $i < $chars; $i++) {
1470         // XXX: convert to string and back
1471         $num = hexdec(common_good_rand(1));
1472         // XXX: randomness is too precious to throw away almost
1473         // 40% of the bits we get!
1474         $code .= $codechars[$num%32];
1475     }
1476     return $code;
1477 }
1478
1479 // convert markup to HTML
1480
1481 function common_markup_to_html($c)
1482 {
1483     $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1484     $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1485     $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1486     return Markdown($c);
1487 }
1488
1489 function common_profile_uri($profile)
1490 {
1491     if (!$profile) {
1492         return null;
1493     }
1494     $user = User::staticGet($profile->id);
1495     if ($user) {
1496         return $user->uri;
1497     }
1498
1499     $remote = Remote_profile::staticGet($profile->id);
1500     if ($remote) {
1501         return $remote->uri;
1502     }
1503     // XXX: this is a very bad profile!
1504     return null;
1505 }
1506
1507 function common_canonical_sms($sms)
1508 {
1509     // strip non-digits
1510     preg_replace('/\D/', '', $sms);
1511     return $sms;
1512 }
1513
1514 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1515 {
1516     switch ($errno) {
1517      case E_USER_ERROR:
1518         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline)");
1519         exit(1);
1520         break;
1521
1522      case E_USER_WARNING:
1523         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1524         break;
1525
1526      case E_USER_NOTICE:
1527         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1528         break;
1529     }
1530
1531     // FIXME: show error page if we're on the Web
1532     /* Don't execute PHP internal error handler */
1533     return true;
1534 }
1535
1536 function common_session_token()
1537 {
1538     common_ensure_session();
1539     if (!array_key_exists('token', $_SESSION)) {
1540         $_SESSION['token'] = common_good_rand(64);
1541     }
1542     return $_SESSION['token'];
1543 }
1544
1545 function common_cache_key($extra)
1546 {
1547     return 'laconica:' . common_keyize(common_config('site', 'name')) . ':' . $extra;
1548 }
1549
1550 function common_keyize($str)
1551 {
1552     $str = strtolower($str);
1553     $str = preg_replace('/\s/', '_', $str);
1554     return $str;
1555 }
1556
1557 function common_memcache()
1558 {
1559     static $cache = null;
1560     if (!common_config('memcached', 'enabled')) {
1561         return null;
1562     } else {
1563         if (!$cache) {
1564             $cache = new Memcache();
1565             $servers = common_config('memcached', 'server');
1566             if (is_array($servers)) {
1567                 foreach($servers as $server) {
1568                     $cache->addServer($server);
1569                 }
1570             } else {
1571                 $cache->addServer($servers);
1572             }
1573         }
1574         return $cache;
1575     }
1576 }
1577
1578 function common_compatible_license($from, $to)
1579 {
1580     // XXX: better compatibility check needed here!
1581     return ($from == $to);
1582 }