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