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