lib/util.php

   1 <?php
   2 /*
   3  * Laconica - a distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, Control Yourself, 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) || $user === false) {
 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     $c = null;
 143     if (array_key_exists(session_name, $_COOKIE)) {
 144         $c = $_COOKIE[session_name()];
 145     }
 146     if (!common_have_session()) {
 147         if (common_config('sessions', 'handle')) {
 148             Session::setSaveHandler();
 149         }
 150         @session_start();
 151         if (!isset($_SESSION['started'])) {
 152             $_SESSION['started'] = time();
 153             if (!empty($c)) {
 154                 common_log(LOG_WARNING, 'Session cookie "' . $_COOKIE[session_name()] . '" ' .
 155                            ' is set but started value is null');
 156             }
 157         }
 158     }
 159 }
 160
 161 // Three kinds of arguments:
 162 // 1) a user object
 163 // 2) a nickname
 164 // 3) null to clear
 165
 166 // Initialize to false; set to null if none found
 167
 168 $_cur = false;
 169
 170 function common_set_user($user)
 171 {
 172
 173     global $_cur;
 174
 175     if (is_null($user) && common_have_session()) {
 176         $_cur = null;
 177         unset($_SESSION['userid']);
 178         return true;
 179     } else if (is_string($user)) {
 180         $nickname = $user;
 181         $user = User::staticGet('nickname', $nickname);
 182     } else if (!($user instanceof User)) {
 183         return false;
 184     }
 185
 186     if ($user) {
 187         common_ensure_session();
 188         $_SESSION['userid'] = $user->id;
 189         $_cur = $user;
 190         return $_cur;
 191     }
 192     return false;
 193 }
 194
 195 function common_set_cookie($key, $value, $expiration=0)
 196 {
 197     $path = common_config('site', 'path');
 198     $server = common_config('site', 'server');
 199
 200     if ($path && ($path != '/')) {
 201         $cookiepath = '/' . $path . '/';
 202     } else {
 203         $cookiepath = '/';
 204     }
 205     return setcookie($key,
 206                      $value,
 207                      $expiration,
 208                      $cookiepath,
 209                      $server);
 210 }
 211
 212 define('REMEMBERME', 'rememberme');
 213 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
 214
 215 function common_rememberme($user=null)
 216 {
 217     if (!$user) {
 218         $user = common_current_user();
 219         if (!$user) {
 220             common_debug('No current user to remember', __FILE__);
 221             return false;
 222         }
 223     }
 224
 225     $rm = new Remember_me();
 226
 227     $rm->code = common_good_rand(16);
 228     $rm->user_id = $user->id;
 229
 230     // Wrap the insert in some good ol' fashioned transaction code
 231
 232     $rm->query('BEGIN');
 233
 234     $result = $rm->insert();
 235
 236     if (!$result) {
 237         common_log_db_error($rm, 'INSERT', __FILE__);
 238         common_debug('Error adding rememberme record for ' . $user->nickname, __FILE__);
 239         return false;
 240     }
 241
 242     $rm->query('COMMIT');
 243
 244     common_debug('Inserted rememberme record (' . $rm->code . ', ' . $rm->user_id . '); result = ' . $result . '.', __FILE__);
 245
 246     $cookieval = $rm->user_id . ':' . $rm->code;
 247
 248     common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
 249
 250     common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
 251
 252     return true;
 253 }
 254
 255 function common_remembered_user()
 256 {
 257
 258     $user = null;
 259
 260     $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
 261
 262     if (!$packed) {
 263         return null;
 264     }
 265
 266     list($id, $code) = explode(':', $packed);
 267
 268     if (!$id || !$code) {
 269         common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
 270         common_forgetme();
 271         return null;
 272     }
 273
 274     $rm = Remember_me::staticGet($code);
 275
 276     if (!$rm) {
 277         common_log(LOG_WARNING, 'No such remember code: ' . $code);
 278         common_forgetme();
 279         return null;
 280     }
 281
 282     if ($rm->user_id != $id) {
 283         common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
 284         common_forgetme();
 285         return null;
 286     }
 287
 288     $user = User::staticGet($rm->user_id);
 289
 290     if (!$user) {
 291         common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
 292         common_forgetme();
 293         return null;
 294     }
 295
 296     // successful!
 297     $result = $rm->delete();
 298
 299     if (!$result) {
 300         common_log_db_error($rm, 'DELETE', __FILE__);
 301         common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
 302         common_forgetme();
 303         return null;
 304     }
 305
 306     common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
 307
 308     common_set_user($user);
 309     common_real_login(false);
 310
 311     // We issue a new cookie, so they can log in
 312     // automatically again after this session
 313
 314     common_rememberme($user);
 315
 316     return $user;
 317 }
 318
 319 // must be called with a valid user!
 320
 321 function common_forgetme()
 322 {
 323     common_set_cookie(REMEMBERME, '', 0);
 324 }
 325
 326 // who is the current user?
 327 function common_current_user()
 328 {
 329     global $_cur;
 330
 331     if (!_have_config()) {
 332         return null;
 333     }
 334
 335     if ($_cur === false) {
 336
 337         if (isset($_REQUEST[session_name()]) || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
 338             common_ensure_session();
 339             $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
 340             if ($id) {
 341                 $_cur = User::staticGet($id);
 342                 return $_cur;
 343             }
 344         }
 345
 346         // that didn't work; try to remember; will init $_cur to null on failure
 347         $_cur = common_remembered_user();
 348
 349         if ($_cur) {
 350             common_debug("Got User " . $_cur->nickname);
 351             common_debug("Faking session on remembered user");
 352             // XXX: Is this necessary?
 353             $_SESSION['userid'] = $_cur->id;
 354         }
 355     }
 356
 357     return $_cur;
 358 }
 359
 360 // Logins that are 'remembered' aren't 'real' -- they're subject to
 361 // cookie-stealing. So, we don't let them do certain things. New reg,
 362 // OpenID, and password logins _are_ real.
 363
 364 function common_real_login($real=true)
 365 {
 366     common_ensure_session();
 367     $_SESSION['real_login'] = $real;
 368 }
 369
 370 function common_is_real_login()
 371 {
 372     return common_logged_in() && $_SESSION['real_login'];
 373 }
 374
 375 // get canonical version of nickname for comparison
 376 function common_canonical_nickname($nickname)
 377 {
 378     // XXX: UTF-8 canonicalization (like combining chars)
 379     return strtolower($nickname);
 380 }
 381
 382 // get canonical version of email for comparison
 383 function common_canonical_email($email)
 384 {
 385     // XXX: canonicalize UTF-8
 386     // XXX: lcase the domain part
 387     return $email;
 388 }
 389
 390 function common_render_content($text, $notice)
 391 {
 392     $r = common_render_text($text);
 393     $id = $notice->profile_id;
 394     $r = preg_replace('/(^|\s+)@([A-Za-z0-9]{1,64})/e', "'\\1@'.common_at_link($id, '\\2')", $r);
 395     $r = preg_replace('/^T ([A-Z0-9]{1,64}) /e', "'T '.common_at_link($id, '\\1').' '", $r);
 396     $r = preg_replace('/(^|\s+)@#([A-Za-z0-9]{1,64})/e', "'\\1@#'.common_at_hash_link($id, '\\2')", $r);
 397     $r = preg_replace('/(^|\s)!([A-Za-z0-9]{1,64})/e', "'\\1!'.common_group_link($id, '\\2')", $r);
 398     return $r;
 399 }
 400
 401 function common_render_text($text)
 402 {
 403     $r = htmlspecialchars($text);
 404
 405     $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
 406     $r = common_replace_urls_callback($r, 'common_linkify');
 407     $r = preg_replace('/(^|\(|\[|\s+)#([A-Za-z0-9_\-\.]{1,64})/e', "'\\1#'.common_tag_link('\\2')", $r);
 408     // XXX: machine tags
 409     return $r;
 410 }
 411
 412 function common_replace_urls_callback($text, $callback, $notice_id = null) {
 413     // Start off with a regex
 414     $regex = '#'.
 415     '(?:'.
 416         '(?:'.
 417             '(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|xmpp|irc)://'.
 418             '|'.
 419             '(?:mailto|aim|tel):'.
 420         ')'.
 421         '[^.\s]+\.[^\s]+'.
 422         '|'.
 423         '(?:[^.\s/:]+\.)+'.
 424         '(?:museum|travel|[a-z]{2,4})'.
 425         '(?:[:/][^\s]*)?'.
 426     ')'.
 427     '#ix';
 428     preg_match_all($regex, $text, $matches);
 429
 430     // Then clean up what the regex left behind
 431     $offset = 0;
 432     foreach($matches[0] as $orig_url) {
 433         $url = htmlspecialchars_decode($orig_url);
 434
 435         // Make sure we didn't pick up an email address
 436         if (preg_match('#^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}$#i', $url)) continue;
 437
 438         // Remove surrounding punctuation
 439         $url = trim($url, '.?!,;:\'"`([<');
 440
 441         // Remove surrounding parens and the like
 442         preg_match('/[)\]>]+$/', $url, $trailing);
 443         if (isset($trailing[0])) {
 444             preg_match_all('/[(\[<]/', $url, $opened);
 445             preg_match_all('/[)\]>]/', $url, $closed);
 446             $unopened = count($closed[0]) - count($opened[0]);
 447
 448             // Make sure not to take off more closing parens than there are at the end
 449             $unopened = ($unopened > mb_strlen($trailing[0])) ? mb_strlen($trailing[0]):$unopened;
 450
 451             $url = ($unopened > 0) ? mb_substr($url, 0, $unopened * -1):$url;
 452         }
 453
 454         // Remove trailing punctuation again (in case there were some inside parens)
 455         $url = rtrim($url, '.?!,;:\'"`');
 456
 457         // Make sure we didn't capture part of the next sentence
 458         preg_match('#((?:[^.\s/]+\.)+)(museum|travel|[a-z]{2,4})#i', $url, $url_parts);
 459
 460         // Were the parts capitalized any?
 461         $last_part = (mb_strtolower($url_parts[2]) !== $url_parts[2]) ? true:false;
 462         $prev_part = (mb_strtolower($url_parts[1]) !== $url_parts[1]) ? true:false;
 463
 464         // If the first part wasn't cap'd but the last part was, we captured too much
 465         if ((!$prev_part && $last_part)) {
 466             $url = mb_substr($url, 0 , mb_strpos($url, '.'.$url_parts['2'], 0));
 467         }
 468
 469         // Capture the new TLD
 470         preg_match('#((?:[^.\s/]+\.)+)(museum|travel|[a-z]{2,4})#i', $url, $url_parts);
 471
 472         $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');
 473
 474         if (!in_array($url_parts[2], $tlds)) continue;
 475
 476         // Make sure we didn't capture a hash tag
 477         if (strpos($url, '#') === 0) continue;
 478
 479         // Put the url back the way we found it.
 480         $url = (mb_strpos($orig_url, htmlspecialchars($url)) === FALSE) ? $url:htmlspecialchars($url);
 481
 482         // Call user specified func
 483         if (empty($notice_id)) {
 484             $modified_url = call_user_func($callback, $url);
 485         } else {
 486             $modified_url = call_user_func($callback, array($url, $notice_id));
 487         }
 488
 489         // Replace it!
 490         $start = mb_strpos($text, $url, $offset);
 491         $text = mb_substr($text, 0, $start).$modified_url.mb_substr($text, $start + mb_strlen($url), mb_strlen($text));
 492         $offset = $start + mb_strlen($modified_url);
 493     }
 494
 495     return $text;
 496 }
 497
 498 function common_linkify($url) {
 499     // It comes in special'd, so we unspecial it before passing to the stringifying
 500     // functions
 501     $url = htmlspecialchars_decode($url);
 502
 503     $canon = File_redirection::_canonUrl($url);
 504
 505     $longurl_data = File_redirection::where($url);
 506     if (is_array($longurl_data)) {
 507         $longurl = $longurl_data['url'];
 508     } elseif (is_string($longurl_data)) {
 509         $longurl = $longurl_data;
 510     } else {
 511         throw new ServerException("Can't linkify url '$url'");
 512     }
 513
 514     $attrs = array('href' => $canon, 'rel' => 'external');
 515
 516     $is_attachment = false;
 517     $attachment_id = null;
 518     $has_thumb = false;
 519
 520     // Check to see whether there's a filename associated with this URL.
 521     // If there is, it's an upload and qualifies as an attachment
 522
 523     $localfile = File::staticGet('url', $longurl);
 524
 525     if (!empty($localfile)) {
 526         if (isset($localfile->filename)) {
 527             $is_attachment = true;
 528             $attachment_id = $localfile->id;
 529         }
 530     }
 531
 532     // if this URL is an attachment, then we set class='attachment' and id='attahcment-ID'
 533     // where ID is the id of the attachment for the given URL.
 534     //
 535     // we need a better test telling what can be shown as an attachment
 536     // we're currently picking up oembeds only.
 537     // I think the best option is another file_view table in the db
 538     // and associated dbobject.
 539
 540     $query = "select file_oembed.file_id as file_id from file join file_oembed on file.id = file_oembed.file_id where file.url='$longurl'";
 541     $file = new File;
 542     $file->query($query);
 543     $file->fetch();
 544
 545     if (!empty($file->file_id)) {
 546         $is_attachment = true;
 547         $attachment_id = $file->file_id;
 548
 549         $query = "select file_thumbnail.file_id as file_id from file join file_thumbnail on file.id = file_thumbnail.file_id where file.url='$longurl'";
 550         $file2 = new File;
 551         $file2->query($query);
 552         $file2->fetch();
 553
 554         if (!empty($file2)) {
 555             $has_thumb = true;
 556         }
 557     }
 558
 559     // Add clippy
 560     if ($is_attachment) {
 561         $attrs['class'] = 'attachment';
 562         if ($has_thumb) {
 563             $attrs['class'] = 'attachment thumbnail';
 564         }
 565         $attrs['id'] = "attachment-{$attachment_id}";
 566     }
 567
 568     return XMLStringer::estring('a', $attrs, $url);
 569 }
 570
 571 function common_shorten_links($text)
 572 {
 573     if (mb_strlen($text) <= 140) return $text;
 574     return common_replace_urls_callback($text, array('File_redirection', 'makeShort'));
 575 }
 576
 577 function common_xml_safe_str($str)
 578 {
 579     // Neutralize control codes and surrogates
 580         return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
 581 }
 582
 583 function common_tag_link($tag)
 584 {
 585     $canonical = common_canonical_tag($tag);
 586     $url = common_local_url('tag', array('tag' => $canonical));
 587     $xs = new XMLStringer();
 588     $xs->elementStart('span', 'tag');
 589     $xs->element('a', array('href' => $url,
 590                             'rel' => 'tag'),
 591                  $tag);
 592     $xs->elementEnd('span');
 593     return $xs->getString();
 594 }
 595
 596 function common_canonical_tag($tag)
 597 {
 598     return strtolower(str_replace(array('-', '_', '.'), '', $tag));
 599 }
 600
 601 function common_valid_profile_tag($str)
 602 {
 603     return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
 604 }
 605
 606 function common_at_link($sender_id, $nickname)
 607 {
 608     $sender = Profile::staticGet($sender_id);
 609     $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
 610     if ($recipient) {
 611         $user = User::staticGet('id', $recipient->id);
 612         if ($user) {
 613             $url = common_local_url('userbyid', array('id' => $user->id));
 614         } else {
 615             $url = $recipient->profileurl;
 616         }
 617         $xs = new XMLStringer(false);
 618         $attrs = array('href' => $url,
 619                        'class' => 'url');
 620         if (!empty($recipient->fullname)) {
 621             $attrs['title'] = $recipient->fullname . ' (' . $recipient->nickname . ')';
 622         }
 623         $xs->elementStart('span', 'vcard');
 624         $xs->elementStart('a', $attrs);
 625         $xs->element('span', 'fn nickname', $nickname);
 626         $xs->elementEnd('a');
 627         $xs->elementEnd('span');
 628         return $xs->getString();
 629     } else {
 630         return $nickname;
 631     }
 632 }
 633
 634 function common_group_link($sender_id, $nickname)
 635 {
 636     $sender = Profile::staticGet($sender_id);
 637     $group = User_group::getForNickname($nickname);
 638     if ($group && $sender->isMember($group)) {
 639         $attrs = array('href' => $group->permalink(),
 640                        'class' => 'url');
 641         if (!empty($group->fullname)) {
 642             $attrs['title'] = $group->fullname . ' (' . $group->nickname . ')';
 643         }
 644         $xs = new XMLStringer();
 645         $xs->elementStart('span', 'vcard');
 646         $xs->elementStart('a', $attrs);
 647         $xs->element('span', 'fn nickname', $nickname);
 648         $xs->elementEnd('a');
 649         $xs->elementEnd('span');
 650         return $xs->getString();
 651     } else {
 652         return $nickname;
 653     }
 654 }
 655
 656 function common_at_hash_link($sender_id, $tag)
 657 {
 658     $user = User::staticGet($sender_id);
 659     if (!$user) {
 660         return $tag;
 661     }
 662     $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
 663     if ($tagged) {
 664         $url = common_local_url('subscriptions',
 665                                 array('nickname' => $user->nickname,
 666                                       'tag' => $tag));
 667         $xs = new XMLStringer();
 668         $xs->elementStart('span', 'tag');
 669         $xs->element('a', array('href' => $url,
 670                                 'rel' => $tag),
 671                      $tag);
 672         $xs->elementEnd('span');
 673         return $xs->getString();
 674     } else {
 675         return $tag;
 676     }
 677 }
 678
 679 function common_relative_profile($sender, $nickname, $dt=null)
 680 {
 681     // Try to find profiles this profile is subscribed to that have this nickname
 682     $recipient = new Profile();
 683     // XXX: use a join instead of a subquery
 684     $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
 685     $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
 686     if ($recipient->find(true)) {
 687         // XXX: should probably differentiate between profiles with
 688         // the same name by date of most recent update
 689         return $recipient;
 690     }
 691     // Try to find profiles that listen to this profile and that have this nickname
 692     $recipient = new Profile();
 693     // XXX: use a join instead of a subquery
 694     $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
 695     $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
 696     if ($recipient->find(true)) {
 697         // XXX: should probably differentiate between profiles with
 698         // the same name by date of most recent update
 699         return $recipient;
 700     }
 701     // If this is a local user, try to find a local user with that nickname.
 702     $sender = User::staticGet($sender->id);
 703     if ($sender) {
 704         $recipient_user = User::staticGet('nickname', $nickname);
 705         if ($recipient_user) {
 706             return $recipient_user->getProfile();
 707         }
 708     }
 709     // Otherwise, no links. @messages from local users to remote users,
 710     // or from remote users to other remote users, are just
 711     // outside our ability to make intelligent guesses about
 712     return null;
 713 }
 714
 715 function common_local_url($action, $args=null, $params=null, $fragment=null)
 716 {
 717     static $sensitive = array('login', 'register', 'passwordsettings',
 718                               'twittersettings', 'finishopenidlogin',
 719                               'finishaddopenid', 'api');
 720
 721     $r = Router::get();
 722     $path = $r->build($action, $args, $params, $fragment);
 723
 724     $ssl = in_array($action, $sensitive);
 725
 726     if (common_config('site','fancy')) {
 727         $url = common_path(mb_substr($path, 1), $ssl);
 728     } else {
 729         if (mb_strpos($path, '/index.php') === 0) {
 730             $url = common_path(mb_substr($path, 1), $ssl);
 731         } else {
 732             $url = common_path('index.php'.$path, $ssl);
 733         }
 734     }
 735     return $url;
 736 }
 737
 738 function common_path($relative, $ssl=false)
 739 {
 740     $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
 741
 742     if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
 743         || common_config('site', 'ssl') === 'always') {
 744         $proto = 'https';
 745         if (is_string(common_config('site', 'sslserver')) &&
 746             mb_strlen(common_config('site', 'sslserver')) > 0) {
 747             $serverpart = common_config('site', 'sslserver');
 748         } else {
 749             $serverpart = common_config('site', 'server');
 750         }
 751     } else {
 752         $proto = 'http';
 753         $serverpart = common_config('site', 'server');
 754     }
 755
 756     return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
 757 }
 758
 759 function common_date_string($dt)
 760 {
 761     // XXX: do some sexy date formatting
 762     // return date(DATE_RFC822, $dt);
 763     $t = strtotime($dt);
 764     $now = time();
 765     $diff = $now - $t;
 766
 767     if ($now < $t) { // that shouldn't happen!
 768         return common_exact_date($dt);
 769     } else if ($diff < 60) {
 770         return _('a few seconds ago');
 771     } else if ($diff < 92) {
 772         return _('about a minute ago');
 773     } else if ($diff < 3300) {
 774         return sprintf(_('about %d minutes ago'), round($diff/60));
 775     } else if ($diff < 5400) {
 776         return _('about an hour ago');
 777     } else if ($diff < 22 * 3600) {
 778         return sprintf(_('about %d hours ago'), round($diff/3600));
 779     } else if ($diff < 37 * 3600) {
 780         return _('about a day ago');
 781     } else if ($diff < 24 * 24 * 3600) {
 782         return sprintf(_('about %d days ago'), round($diff/(24*3600)));
 783     } else if ($diff < 46 * 24 * 3600) {
 784         return _('about a month ago');
 785     } else if ($diff < 330 * 24 * 3600) {
 786         return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
 787     } else if ($diff < 480 * 24 * 3600) {
 788         return _('about a year ago');
 789     } else {
 790         return common_exact_date($dt);
 791     }
 792 }
 793
 794 function common_exact_date($dt)
 795 {
 796     static $_utc;
 797     static $_siteTz;
 798
 799     if (!$_utc) {
 800         $_utc = new DateTimeZone('UTC');
 801         $_siteTz = new DateTimeZone(common_timezone());
 802     }
 803
 804     $dateStr = date('d F Y H:i:s', strtotime($dt));
 805     $d = new DateTime($dateStr, $_utc);
 806     $d->setTimezone($_siteTz);
 807     return $d->format(DATE_RFC850);
 808 }
 809
 810 function common_date_w3dtf($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(DATE_W3C);
 816 }
 817
 818 function common_date_rfc2822($dt)
 819 {
 820     $dateStr = date('d F Y H:i:s', strtotime($dt));
 821     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 822     $d->setTimezone(new DateTimeZone(common_timezone()));
 823     return $d->format('r');
 824 }
 825
 826 function common_date_iso8601($dt)
 827 {
 828     $dateStr = date('d F Y H:i:s', strtotime($dt));
 829     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
 830     $d->setTimezone(new DateTimeZone(common_timezone()));
 831     return $d->format('c');
 832 }
 833
 834 function common_sql_now()
 835 {
 836     return common_sql_date(time());
 837 }
 838
 839 function common_sql_date($datetime)
 840 {
 841     return strftime('%Y-%m-%d %H:%M:%S', $datetime);
 842 }
 843
 844 function common_redirect($url, $code=307)
 845 {
 846     static $status = array(301 => "Moved Permanently",
 847                            302 => "Found",
 848                            303 => "See Other",
 849                            307 => "Temporary Redirect");
 850
 851     header('HTTP/1.1 '.$code.' '.$status[$code]);
 852     header("Location: $url");
 853
 854     $xo = new XMLOutputter();
 855     $xo->startXML('a',
 856                   '-//W3C//DTD XHTML 1.0 Strict//EN',
 857                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
 858     $xo->element('a', array('href' => $url), $url);
 859     $xo->endXML();
 860     exit;
 861 }
 862
 863 function common_broadcast_notice($notice, $remote=false)
 864 {
 865     if (common_config('queue', 'enabled')) {
 866         // Do it later!
 867         return common_enqueue_notice($notice);
 868     } else {
 869         return common_real_broadcast($notice, $remote);
 870     }
 871 }
 872
 873 // Stick the notice on the queue
 874
 875 function common_enqueue_notice($notice)
 876 {
 877     $transports = array('omb', 'sms', 'public', 'twitter', 'facebook', 'ping');
 878
 879     if (common_config('xmpp', 'enabled'))
 880     {
 881         $transports[] = 'jabber';
 882     }
 883
 884     if (common_config('queue','subsystem') == 'stomp') {
 885         common_enqueue_notice_stomp($notice, $transports);
 886     }
 887     else {
 888         common_enqueue_notice_db($notice, $transports);
 889     }
 890     return $result;
 891 }
 892
 893 function common_enqueue_notice_stomp($notice, $transports)
 894 {
 895     // use an external message queue system via STOMP
 896     require_once("Stomp.php");
 897
 898     $server = common_config('queue','stomp_server');
 899     $username = common_config('queue', 'stomp_username');
 900     $password = common_config('queue', 'stomp_password');
 901
 902     $con = new Stomp($server);
 903
 904     if (!$con->connect($username, $password)) {
 905         common_log(LOG_ERR, 'Failed to connect to queue server');
 906         return false;
 907     }
 908
 909     $queue_basename = common_config('queue','queue_basename');
 910
 911     foreach ($transports as $transport) {
 912         $result = $con->send('/queue/'.$queue_basename.'-'.$transport, // QUEUE
 913                              $notice->id,               // BODY of the message
 914                              array ('created' => $notice->created));
 915         if (!$result) {
 916             common_log(LOG_ERR, 'Error sending to '.$transport.' queue');
 917             return false;
 918         }
 919         common_log(LOG_DEBUG, 'complete remote queueing notice ID = ' . $notice->id . ' for ' . $transport);
 920     }
 921
 922     //send tags as headers, so they can be used as JMS selectors
 923     common_log(LOG_DEBUG, 'searching for tags ' . $notice->id);
 924     $tags = array();
 925     $tag = new Notice_tag();
 926     $tag->notice_id = $notice->id;
 927     if ($tag->find()) {
 928         while ($tag->fetch()) {
 929             common_log(LOG_DEBUG, 'tag found = ' . $tag->tag);
 930             array_push($tags,$tag->tag);
 931         }
 932     }
 933     $tag->free();
 934
 935     $con->send('/topic/laconica.'.$notice->profile_id,
 936                $notice->content,
 937                array(
 938                      'profile_id' => $notice->profile_id,
 939                      'created' => $notice->created,
 940                      'tags' => implode($tags,' - ')
 941                      )
 942                );
 943     common_log(LOG_DEBUG, 'sent to personal topic ' . $notice->id);
 944     $con->send('/topic/laconica.allusers',
 945                $notice->content,
 946                array(
 947                      'profile_id' => $notice->profile_id,
 948                      'created' => $notice->created,
 949                      'tags' => implode($tags,' - ')
 950                      )
 951                );
 952     common_log(LOG_DEBUG, 'sent to catch-all topic ' . $notice->id);
 953     $result = true;
 954 }
 955
 956 function common_enqueue_notice_db($notice, $transports)
 957 {
 958     // in any other case, 'internal'
 959     foreach ($transports as $transport) {
 960         common_enqueue_notice_transport($notice, $transport);
 961     }
 962 }
 963
 964 function common_enqueue_notice_transport($notice, $transport)
 965 {
 966     $qi = new Queue_item();
 967     $qi->notice_id = $notice->id;
 968     $qi->transport = $transport;
 969     $qi->created = $notice->created;
 970     $result = $qi->insert();
 971     if (!$result) {
 972         $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
 973         common_log(LOG_ERR, 'DB error inserting queue item: ' . $last_error->message);
 974         throw new ServerException('DB error inserting queue item: ' . $last_error->message);
 975     }
 976     common_log(LOG_DEBUG, 'complete queueing notice ID = ' . $notice->id . ' for ' . $transport);
 977     return true;
 978 }
 979
 980 function common_real_broadcast($notice, $remote=false)
 981 {
 982     $success = true;
 983     if (!$remote) {
 984         // Make sure we have the OMB stuff
 985         require_once(INSTALLDIR.'/lib/omb.php');
 986         $success = omb_broadcast_remote_subscribers($notice);
 987         if (!$success) {
 988             common_log(LOG_ERR, 'Error in OMB broadcast for notice ' . $notice->id);
 989         }
 990     }
 991     if ($success) {
 992         require_once(INSTALLDIR.'/lib/jabber.php');
 993         $success = jabber_broadcast_notice($notice);
 994         if (!$success) {
 995             common_log(LOG_ERR, 'Error in jabber broadcast for notice ' . $notice->id);
 996         }
 997     }
 998     if ($success) {
 999         require_once(INSTALLDIR.'/lib/mail.php');
1000         $success = mail_broadcast_notice_sms($notice);
1001         if (!$success) {
1002             common_log(LOG_ERR, 'Error in sms broadcast for notice ' . $notice->id);
1003         }
1004     }
1005     if ($success) {
1006         $success = jabber_public_notice($notice);
1007         if (!$success) {
1008             common_log(LOG_ERR, 'Error in public broadcast for notice ' . $notice->id);
1009         }
1010     }
1011     if ($success) {
1012         $success = broadcast_twitter($notice);
1013         if (!$success) {
1014             common_log(LOG_ERR, 'Error in Twitter broadcast for notice ' . $notice->id);
1015         }
1016     }
1017
1018     // XXX: Do a real-time FB broadcast here?
1019
1020     // XXX: broadcast notices to other IM
1021     return $success;
1022 }
1023
1024 function common_broadcast_profile($profile)
1025 {
1026     // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
1027     require_once(INSTALLDIR.'/lib/omb.php');
1028     omb_broadcast_profile($profile);
1029     // XXX: Other broadcasts...?
1030     return true;
1031 }
1032
1033 function common_profile_url($nickname)
1034 {
1035     return common_local_url('showstream', array('nickname' => $nickname));
1036 }
1037
1038 // Should make up a reasonable root URL
1039
1040 function common_root_url($ssl=false)
1041 {
1042     return common_path('', $ssl);
1043 }
1044
1045 // returns $bytes bytes of random data as a hexadecimal string
1046 // "good" here is a goal and not a guarantee
1047
1048 function common_good_rand($bytes)
1049 {
1050     // XXX: use random.org...?
1051     if (@file_exists('/dev/urandom')) {
1052         return common_urandom($bytes);
1053     } else { // FIXME: this is probably not good enough
1054         return common_mtrand($bytes);
1055     }
1056 }
1057
1058 function common_urandom($bytes)
1059 {
1060     $h = fopen('/dev/urandom', 'rb');
1061     // should not block
1062     $src = fread($h, $bytes);
1063     fclose($h);
1064     $enc = '';
1065     for ($i = 0; $i < $bytes; $i++) {
1066         $enc .= sprintf("%02x", (ord($src[$i])));
1067     }
1068     return $enc;
1069 }
1070
1071 function common_mtrand($bytes)
1072 {
1073     $enc = '';
1074     for ($i = 0; $i < $bytes; $i++) {
1075         $enc .= sprintf("%02x", mt_rand(0, 255));
1076     }
1077     return $enc;
1078 }
1079
1080 function common_set_returnto($url)
1081 {
1082     common_ensure_session();
1083     $_SESSION['returnto'] = $url;
1084 }
1085
1086 function common_get_returnto()
1087 {
1088     common_ensure_session();
1089     return $_SESSION['returnto'];
1090 }
1091
1092 function common_timestamp()
1093 {
1094     return date('YmdHis');
1095 }
1096
1097 function common_ensure_syslog()
1098 {
1099     static $initialized = false;
1100     if (!$initialized) {
1101         openlog(common_config('syslog', 'appname'), 0, LOG_USER);
1102         $initialized = true;
1103     }
1104 }
1105
1106 function common_log_line($priority, $msg)
1107 {
1108     static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1109                                       'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1110     return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
1111 }
1112
1113 function common_log($priority, $msg, $filename=null)
1114 {
1115     $logfile = common_config('site', 'logfile');
1116     if ($logfile) {
1117         $log = fopen($logfile, "a");
1118         if ($log) {
1119             $output = common_log_line($priority, $msg);
1120             fwrite($log, $output);
1121             fclose($log);
1122         }
1123     } else {
1124         common_ensure_syslog();
1125         syslog($priority, $msg);
1126     }
1127 }
1128
1129 function common_debug($msg, $filename=null)
1130 {
1131     if ($filename) {
1132         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1133     } else {
1134         common_log(LOG_DEBUG, $msg);
1135     }
1136 }
1137
1138 function common_log_db_error(&$object, $verb, $filename=null)
1139 {
1140     $objstr = common_log_objstring($object);
1141     $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1142     common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1143 }
1144
1145 function common_log_objstring(&$object)
1146 {
1147     if (is_null($object)) {
1148         return "null";
1149     }
1150     $arr = $object->toArray();
1151     $fields = array();
1152     foreach ($arr as $k => $v) {
1153         $fields[] = "$k='$v'";
1154     }
1155     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1156     return $objstring;
1157 }
1158
1159 function common_valid_http_url($url)
1160 {
1161     return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1162 }
1163
1164 function common_valid_tag($tag)
1165 {
1166     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1167         return (Validate::email($matches[1]) ||
1168                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1169     }
1170     return false;
1171 }
1172
1173 /* Following functions are copied from MediaWiki GlobalFunctions.php
1174  * and written by Evan Prodromou. */
1175
1176 function common_accept_to_prefs($accept, $def = '*/*')
1177 {
1178     // No arg means accept anything (per HTTP spec)
1179     if(!$accept) {
1180         return array($def => 1);
1181     }
1182
1183     $prefs = array();
1184
1185     $parts = explode(',', $accept);
1186
1187     foreach($parts as $part) {
1188         // FIXME: doesn't deal with params like 'text/html; level=1'
1189         @list($value, $qpart) = explode(';', trim($part));
1190         $match = array();
1191         if(!isset($qpart)) {
1192             $prefs[$value] = 1;
1193         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1194             $prefs[$value] = $match[1];
1195         }
1196     }
1197
1198     return $prefs;
1199 }
1200
1201 function common_mime_type_match($type, $avail)
1202 {
1203     if(array_key_exists($type, $avail)) {
1204         return $type;
1205     } else {
1206         $parts = explode('/', $type);
1207         if(array_key_exists($parts[0] . '/*', $avail)) {
1208             return $parts[0] . '/*';
1209         } elseif(array_key_exists('*/*', $avail)) {
1210             return '*/*';
1211         } else {
1212             return null;
1213         }
1214     }
1215 }
1216
1217 function common_negotiate_type($cprefs, $sprefs)
1218 {
1219     $combine = array();
1220
1221     foreach(array_keys($sprefs) as $type) {
1222         $parts = explode('/', $type);
1223         if($parts[1] != '*') {
1224             $ckey = common_mime_type_match($type, $cprefs);
1225             if($ckey) {
1226                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1227             }
1228         }
1229     }
1230
1231     foreach(array_keys($cprefs) as $type) {
1232         $parts = explode('/', $type);
1233         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1234             $skey = common_mime_type_match($type, $sprefs);
1235             if($skey) {
1236                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1237             }
1238         }
1239     }
1240
1241     $bestq = 0;
1242     $besttype = 'text/html';
1243
1244     foreach(array_keys($combine) as $type) {
1245         if($combine[$type] > $bestq) {
1246             $besttype = $type;
1247             $bestq = $combine[$type];
1248         }
1249     }
1250
1251     if ('text/html' === $besttype) {
1252         return "text/html; charset=utf-8";
1253     }
1254     return $besttype;
1255 }
1256
1257 function common_config($main, $sub)
1258 {
1259     global $config;
1260     return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1261 }
1262
1263 function common_copy_args($from)
1264 {
1265     $to = array();
1266     $strip = get_magic_quotes_gpc();
1267     foreach ($from as $k => $v) {
1268         $to[$k] = ($strip) ? stripslashes($v) : $v;
1269     }
1270     return $to;
1271 }
1272
1273 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1274 // This is used before handing a request off to OAuthRequest::from_request.
1275 function common_remove_magic_from_request()
1276 {
1277     if(get_magic_quotes_gpc()) {
1278         $_POST=array_map('stripslashes',$_POST);
1279         $_GET=array_map('stripslashes',$_GET);
1280     }
1281 }
1282
1283 function common_user_uri(&$user)
1284 {
1285     return common_local_url('userbyid', array('id' => $user->id));
1286 }
1287
1288 function common_notice_uri(&$notice)
1289 {
1290     return common_local_url('shownotice',
1291                             array('notice' => $notice->id));
1292 }
1293
1294 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1295
1296 function common_confirmation_code($bits)
1297 {
1298     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1299     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1300     $chars = ceil($bits/5);
1301     $code = '';
1302     for ($i = 0; $i < $chars; $i++) {
1303         // XXX: convert to string and back
1304         $num = hexdec(common_good_rand(1));
1305         // XXX: randomness is too precious to throw away almost
1306         // 40% of the bits we get!
1307         $code .= $codechars[$num%32];
1308     }
1309     return $code;
1310 }
1311
1312 // convert markup to HTML
1313
1314 function common_markup_to_html($c)
1315 {
1316     $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1317     $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1318     $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1319     return Markdown($c);
1320 }
1321
1322 function common_profile_uri($profile)
1323 {
1324     if (!$profile) {
1325         return null;
1326     }
1327     $user = User::staticGet($profile->id);
1328     if ($user) {
1329         return $user->uri;
1330     }
1331
1332     $remote = Remote_profile::staticGet($profile->id);
1333     if ($remote) {
1334         return $remote->uri;
1335     }
1336     // XXX: this is a very bad profile!
1337     return null;
1338 }
1339
1340 function common_canonical_sms($sms)
1341 {
1342     // strip non-digits
1343     preg_replace('/\D/', '', $sms);
1344     return $sms;
1345 }
1346
1347 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1348 {
1349     switch ($errno) {
1350
1351      case E_ERROR:
1352      case E_COMPILE_ERROR:
1353      case E_CORE_ERROR:
1354      case E_USER_ERROR:
1355      case E_PARSE:
1356      case E_RECOVERABLE_ERROR:
1357         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
1358         die();
1359         break;
1360
1361      case E_WARNING:
1362      case E_COMPILE_WARNING:
1363      case E_CORE_WARNING:
1364      case E_USER_WARNING:
1365         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1366         break;
1367
1368      case E_NOTICE:
1369      case E_USER_NOTICE:
1370         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1371         break;
1372
1373      case E_STRICT:
1374      case E_DEPRECATED:
1375      case E_USER_DEPRECATED:
1376         // XXX: config variable to log this stuff, too
1377         break;
1378
1379      default:
1380         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
1381         die();
1382         break;
1383     }
1384
1385     // FIXME: show error page if we're on the Web
1386     /* Don't execute PHP internal error handler */
1387     return true;
1388 }
1389
1390 function common_session_token()
1391 {
1392     common_ensure_session();
1393     if (!array_key_exists('token', $_SESSION)) {
1394         $_SESSION['token'] = common_good_rand(64);
1395     }
1396     return $_SESSION['token'];
1397 }
1398
1399 function common_cache_key($extra)
1400 {
1401     $base_key = common_config('memcached', 'base');
1402
1403     if (empty($base_key)) {
1404         $base_key = common_keyize(common_config('site', 'name'));
1405     }
1406
1407     return 'laconica:' . $base_key . ':' . $extra;
1408 }
1409
1410 function common_keyize($str)
1411 {
1412     $str = strtolower($str);
1413     $str = preg_replace('/\s/', '_', $str);
1414     return $str;
1415 }
1416
1417 function common_memcache()
1418 {
1419     static $cache = null;
1420     if (!common_config('memcached', 'enabled')) {
1421         return null;
1422     } else {
1423         if (!$cache) {
1424             $cache = new Memcache();
1425             $servers = common_config('memcached', 'server');
1426             if (is_array($servers)) {
1427                 foreach($servers as $server) {
1428                     $cache->addServer($server);
1429                 }
1430             } else {
1431                 $cache->addServer($servers);
1432             }
1433         }
1434         return $cache;
1435     }
1436 }
1437
1438 function common_compatible_license($from, $to)
1439 {
1440     // XXX: better compatibility check needed here!
1441     return ($from == $to);
1442 }
1443
1444 /**
1445  * returns a quoted table name, if required according to config
1446  */
1447 function common_database_tablename($tablename)
1448 {
1449
1450   if(common_config('db','quote_identifiers')) {
1451       $tablename = '"'. $tablename .'"';
1452   }
1453   //table prefixes could be added here later
1454   return $tablename;
1455 }
1456
1457 function common_shorten_url($long_url)
1458 {
1459     $user = common_current_user();
1460     if (empty($user)) {
1461         // common current user does not find a user when called from the XMPP daemon
1462         // therefore we'll set one here fix, so that XMPP given URLs may be shortened
1463         $svc = 'ur1.ca';
1464     } else {
1465         $svc = $user->urlshorteningservice;
1466     }
1467
1468     $curlh = curl_init();
1469     curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
1470     curl_setopt($curlh, CURLOPT_USERAGENT, 'Laconica');
1471     curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
1472
1473     switch($svc) {
1474      case 'ur1.ca':
1475         require_once INSTALLDIR.'/lib/Shorturl_api.php';
1476         $short_url_service = new LilUrl;
1477         $short_url = $short_url_service->shorten($long_url);
1478         break;
1479
1480      case '2tu.us':
1481         $short_url_service = new TightUrl;
1482         require_once INSTALLDIR.'/lib/Shorturl_api.php';
1483         $short_url = $short_url_service->shorten($long_url);
1484         break;
1485
1486      case 'ptiturl.com':
1487         require_once INSTALLDIR.'/lib/Shorturl_api.php';
1488         $short_url_service = new PtitUrl;
1489         $short_url = $short_url_service->shorten($long_url);
1490         break;
1491
1492      case 'bit.ly':
1493         curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($long_url));
1494         $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
1495         break;
1496
1497      case 'is.gd':
1498         curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($long_url));
1499         $short_url = curl_exec($curlh);
1500         break;
1501      case 'snipr.com':
1502         curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($long_url));
1503         $short_url = curl_exec($curlh);
1504         break;
1505      case 'metamark.net':
1506         curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($long_url));
1507         $short_url = curl_exec($curlh);
1508         break;
1509      case 'tinyurl.com':
1510         curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($long_url));
1511         $short_url = curl_exec($curlh);
1512         break;
1513      default:
1514         $short_url = false;
1515     }
1516
1517     curl_close($curlh);
1518
1519     return $short_url;
1520 }
1521
1522 function common_client_ip()
1523 {
1524     if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
1525         return null;
1526     }
1527
1528     if ($_SERVER['HTTP_X_FORWARDED_FOR']) {
1529         if ($_SERVER['HTTP_CLIENT_IP']) {
1530             $proxy = $_SERVER['HTTP_CLIENT_IP'];
1531         } else {
1532             $proxy = $_SERVER['REMOTE_ADDR'];
1533         }
1534         $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
1535     } else {
1536         if ($_SERVER['HTTP_CLIENT_IP']) {
1537             $ip = $_SERVER['HTTP_CLIENT_IP'];
1538         } else {
1539             $ip = $_SERVER['REMOTE_ADDR'];
1540         }
1541     }
1542
1543     return array($ip, $proxy);
1544 }