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