lib/util.php

   1 <?php
   2 /*
   3  * Laconica - a distributed open-source microblogging tool
   4  * Copyright (C) 2008, Controlez-Vous, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 /* XXX: break up into separate modules (HTTP, user, files) */
  21
  22 // Show a server error
  23
  24 function common_server_error($msg, $code=500)
  25 {
  26     static $status = array(500 => 'Internal Server Error',
  27                            501 => 'Not Implemented',
  28                            502 => 'Bad Gateway',
  29                            503 => 'Service Unavailable',
  30                            504 => 'Gateway Timeout',
  31                            505 => 'HTTP Version Not Supported');
  32
  33     if (!array_key_exists($code, $status)) {
  34         $code = 500;
  35     }
  36
  37     $status_string = $status[$code];
  38
  39     header('HTTP/1.1 '.$code.' '.$status_string);
  40     header('Content-type: text/plain');
  41
  42     print $msg;
  43     print "\n";
  44     exit();
  45 }
  46
  47 // Show a user error
  48 function common_user_error($msg, $code=400)
  49 {
  50     static $status = array(400 => 'Bad Request',
  51                            401 => 'Unauthorized',
  52                            402 => 'Payment Required',
  53                            403 => 'Forbidden',
  54                            404 => 'Not Found',
  55                            405 => 'Method Not Allowed',
  56                            406 => 'Not Acceptable',
  57                            407 => 'Proxy Authentication Required',
  58                            408 => 'Request Timeout',
  59                            409 => 'Conflict',
  60                            410 => 'Gone',
  61                            411 => 'Length Required',
  62                            412 => 'Precondition Failed',
  63                            413 => 'Request Entity Too Large',
  64                            414 => 'Request-URI Too Long',
  65                            415 => 'Unsupported Media Type',
  66                            416 => 'Requested Range Not Satisfiable',
  67                            417 => 'Expectation Failed');
  68
  69     if (!array_key_exists($code, $status)) {
  70         $code = 400;
  71     }
  72
  73     $status_string = $status[$code];
  74
  75     header('HTTP/1.1 '.$code.' '.$status_string);
  76
  77     common_show_header('Error');
  78     common_element('div', array('class' => 'error'), $msg);
  79     common_show_footer();
  80 }
  81
  82 function common_init_locale($language=null)
  83 {
  84     if(!$language) {
  85         $language = common_language();
  86     }
  87     putenv('LANGUAGE='.$language);
  88     putenv('LANG='.$language);
  89     return setlocale(LC_ALL, $language . ".utf8",
  90                      $language . ".UTF8",
  91                      $language . ".utf-8",
  92                      $language . ".UTF-8",
  93                      $language);
  94 }
  95
  96 function common_init_language()
  97 {
  98     mb_internal_encoding('UTF-8');
  99     $language = common_language();
 100     // So we don't have to make people install the gettext locales
 101     $locale_set = common_init_locale($language);
 102     bindtextdomain("laconica", common_config('site','locale_path'));
 103     bind_textdomain_codeset("laconica", "UTF-8");
 104     textdomain("laconica");
 105     setlocale(LC_CTYPE, 'C');
 106     if(!$locale_set) {
 107         common_log(LOG_INFO,'Language requested:'.$language.' - locale could not be set:',__FILE__);
 108     }
 109 }
 110
 111 function common_timezone()
 112 {
 113     if (common_logged_in()) {
 114         $user = common_current_user();
 115         if ($user->timezone) {
 116             return $user->timezone;
 117         }
 118     }
 119
 120     global $config;
 121     return $config['site']['timezone'];
 122 }
 123
 124 function common_language()
 125 {
 126
 127     // If there is a user logged in and they've set a language preference
 128     // then return that one...
 129     if (common_logged_in()) {
 130         $user = common_current_user();
 131         $user_language = $user->language;
 132         if ($user_language)
 133           return $user_language;
 134     }
 135
 136     // Otherwise, find the best match for the languages requested by the
 137     // user's browser...
 138     $httplang = isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? $_SERVER['HTTP_ACCEPT_LANGUAGE'] : null;
 139     if (!empty($httplang)) {
 140         $language = client_prefered_language($httplang);
 141         if ($language)
 142           return $language;
 143     }
 144
 145     // Finally, if none of the above worked, use the site's default...
 146     return common_config('site', 'language');
 147 }
 148 // salted, hashed passwords are stored in the DB
 149
 150 function common_munge_password($password, $id)
 151 {
 152     return md5($password . $id);
 153 }
 154
 155 // check if a username exists and has matching password
 156 function common_check_user($nickname, $password)
 157 {
 158     // NEVER allow blank passwords, even if they match the DB
 159     if (mb_strlen($password) == 0) {
 160         return false;
 161     }
 162     $user = User::staticGet('nickname', $nickname);
 163     if (is_null($user)) {
 164         return false;
 165     } else {
 166         if (0 == strcmp(common_munge_password($password, $user->id),
 167                         $user->password)) {
 168             return $user;
 169         } else {
 170             return false;
 171         }
 172     }
 173 }
 174
 175 // is the current user logged in?
 176 function common_logged_in()
 177 {
 178     return (!is_null(common_current_user()));
 179 }
 180
 181 function common_have_session()
 182 {
 183     return (0 != strcmp(session_id(), ''));
 184 }
 185
 186 function common_ensure_session()
 187 {
 188     if (!common_have_session()) {
 189         @session_start();
 190     }
 191 }
 192
 193 // Three kinds of arguments:
 194 // 1) a user object
 195 // 2) a nickname
 196 // 3) null to clear
 197
 198 // Initialize to false; set to null if none found
 199
 200 $_cur = false;
 201
 202 function common_set_user($user)
 203 {
 204
 205     global $_cur;
 206
 207     if (is_null($user) && common_have_session()) {
 208         $_cur = null;
 209         unset($_SESSION['userid']);
 210         return true;
 211     } else if (is_string($user)) {
 212         $nickname = $user;
 213         $user = User::staticGet('nickname', $nickname);
 214     } else if (!($user instanceof User)) {
 215         return false;
 216     }
 217
 218     if ($user) {
 219         common_ensure_session();
 220         $_SESSION['userid'] = $user->id;
 221         $_cur = $user;
 222         return $_cur;
 223     }
 224     return false;
 225 }
 226
 227 function common_set_cookie($key, $value, $expiration=0)
 228 {
 229     $path = common_config('site', 'path');
 230     $server = common_config('site', 'server');
 231
 232     if ($path && ($path != '/')) {
 233         $cookiepath = '/' . $path . '/';
 234     } else {
 235         $cookiepath = '/';
 236     }
 237     return setcookie($key,
 238                      $value,
 239                      $expiration,
 240                      $cookiepath,
 241                      $server);
 242 }
 243
 244 define('REMEMBERME', 'rememberme');
 245 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
 246
 247 function common_rememberme($user=null)
 248 {
 249     if (!$user) {
 250         $user = common_current_user();
 251         if (!$user) {
 252             common_debug('No current user to remember', __FILE__);
 253             return false;
 254         }
 255     }
 256
 257     $rm = new Remember_me();
 258
 259     $rm->code = common_good_rand(16);
 260     $rm->user_id = $user->id;
 261
 262     // Wrap the insert in some good ol' fashioned transaction code
 263
 264     $rm->query('BEGIN');
 265
 266     $result = $rm->insert();
 267
 268     if (!$result) {
 269         common_log_db_error($rm, 'INSERT', __FILE__);
 270         common_debug('Error adding rememberme record for ' . $user->nickname, __FILE__);
 271         return false;
 272     }
 273
 274     $rm->query('COMMIT');
 275
 276     common_debug('Inserted rememberme record (' . $rm->code . ', ' . $rm->user_id . '); result = ' . $result . '.', __FILE__);
 277
 278     $cookieval = $rm->user_id . ':' . $rm->code;
 279
 280     common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
 281
 282     common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
 283
 284     return true;
 285 }
 286
 287 function common_remembered_user()
 288 {
 289
 290     $user = null;
 291
 292     $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
 293
 294     if (!$packed) {
 295         return null;
 296     }
 297
 298     list($id, $code) = explode(':', $packed);
 299
 300     if (!$id || !$code) {
 301         common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
 302         common_forgetme();
 303         return null;
 304     }
 305
 306     $rm = Remember_me::staticGet($code);
 307
 308     if (!$rm) {
 309         common_log(LOG_WARNING, 'No such remember code: ' . $code);
 310         common_forgetme();
 311         return null;
 312     }
 313
 314     if ($rm->user_id != $id) {
 315         common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
 316         common_forgetme();
 317         return null;
 318     }
 319
 320     $user = User::staticGet($rm->user_id);
 321
 322     if (!$user) {
 323         common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
 324         common_forgetme();
 325         return null;
 326     }
 327
 328     // successful!
 329     $result = $rm->delete();
 330
 331     if (!$result) {
 332         common_log_db_error($rm, 'DELETE', __FILE__);
 333         common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
 334         common_forgetme();
 335         return null;
 336     }
 337
 338     common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
 339
 340     common_set_user($user);
 341     common_real_login(false);
 342
 343     // We issue a new cookie, so they can log in
 344     // automatically again after this session
 345
 346     common_rememberme($user);
 347
 348     return $user;
 349 }
 350
 351 // must be called with a valid user!
 352
 353 function common_forgetme()
 354 {
 355     common_set_cookie(REMEMBERME, '', 0);
 356 }
 357
 358 // who is the current user?
 359 function common_current_user()
 360 {
 361     global $_cur;
 362
 363     if ($_cur === false) {
 364
 365         if (isset($_REQUEST[session_name()]) || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
 366             common_ensure_session();
 367             $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
 368             if ($id) {
 369                 $_cur = User::staticGet($id);
 370                 return $_cur;
 371             }
 372         }
 373
 374         // that didn't work; try to remember; will init $_cur to null on failure
 375         $_cur = common_remembered_user();
 376
 377         if ($_cur) {
 378             common_debug("Got User " . $_cur->nickname);
 379             common_debug("Faking session on remembered user");
 380             // XXX: Is this necessary?
 381             $_SESSION['userid'] = $_cur->id;
 382         }
 383     }
 384
 385     return $_cur;
 386 }
 387
 388 // Logins that are 'remembered' aren't 'real' -- they're subject to
 389 // cookie-stealing. So, we don't let them do certain things. New reg,
 390 // OpenID, and password logins _are_ real.
 391
 392 function common_real_login($real=true)
 393 {
 394     common_ensure_session();
 395     $_SESSION['real_login'] = $real;
 396 }
 397
 398 function common_is_real_login()
 399 {
 400     return common_logged_in() && $_SESSION['real_login'];
 401 }
 402
 403 // get canonical version of nickname for comparison
 404 function common_canonical_nickname($nickname)
 405 {
 406     // XXX: UTF-8 canonicalization (like combining chars)
 407     return strtolower($nickname);
 408 }
 409
 410 // get canonical version of email for comparison
 411 function common_canonical_email($email)
 412 {
 413     // XXX: canonicalize UTF-8
 414     // XXX: lcase the domain part
 415     return $email;
 416 }
 417
 418 define('URL_REGEX', '^|[ \t\r\n])((ftp|http|https|gopher|mailto|news|nntp|telnet|wais|file|prospero|aim|webcal):(([A-Za-z0-9$_.+!*(),;/?:@&~=-])|%[A-Fa-f0-9]{2}){2,}(#([a-zA-Z0-9][a-zA-Z0-9$_.+!*(),;/?:@&~=%-]*))?([A-Za-z0-9$_+!*();/?:~-]))');
 419
 420 function common_render_content($text, $notice)
 421 {
 422     $r = common_render_text($text);
 423     $id = $notice->profile_id;
 424     $r = preg_replace('/(^|\s+)@([A-Za-z0-9]{1,64})/e', "'\\1@'.common_at_link($id, '\\2')", $r);
 425     $r = preg_replace('/^T ([A-Z0-9]{1,64}) /e', "'T '.common_at_link($id, '\\1').' '", $r);
 426     $r = preg_replace('/(^|\s+)@#([A-Za-z0-9]{1,64})/e', "'\\1@#'.common_at_hash_link($id, '\\2')", $r);
 427     return $r;
 428 }
 429
 430 function common_render_text($text)
 431 {
 432     $r = htmlspecialchars($text);
 433
 434     $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
 435     $r = preg_replace_callback('@https?://[^\]>\s]+@', 'common_render_uri_thingy', $r);
 436     $r = preg_replace('/(^|\s+)#([A-Za-z0-9_\-\.]{1,64})/e', "'\\1#'.common_tag_link('\\2')", $r);
 437     // XXX: machine tags
 438     return $r;
 439 }
 440
 441 function common_render_uri_thingy($matches)
 442 {
 443     $uri = $matches[0];
 444     $trailer = '';
 445
 446     // Some heuristics for extracting URIs from surrounding punctuation
 447     // Strip from trailing text...
 448     if (preg_match('/^(.*)([,.:"\']+)$/', $uri, $matches)) {
 449         $uri = $matches[1];
 450         $trailer = $matches[2];
 451     }
 452
 453     $pairs = array(
 454                    ']' => '[', // technically disallowed in URIs, but used in Java docs
 455                    ')' => '(', // far too frequent in Wikipedia and MSDN
 456                    );
 457     $final = substr($uri, -1, 1);
 458     if (isset($pairs[$final])) {
 459         $openers = substr_count($uri, $pairs[$final]);
 460         $closers = substr_count($uri, $final);
 461         if ($closers > $openers) {
 462             // Assume the paren was opened outside the URI
 463             $uri = substr($uri, 0, -1);
 464             $trailer = $final . $trailer;
 465         }
 466     }
 467     if ($longurl = common_longurl($uri)) {
 468         $longurl = htmlentities($longurl, ENT_QUOTES, 'UTF-8');
 469         $title = " title='$longurl'";
 470     }
 471     else $title = '';
 472
 473     return '<a href="' . $uri . '"' . $title . ' class="extlink">' . $uri . '</a>' . $trailer;
 474 }
 475
 476 function common_longurl($short_url)
 477 {
 478     $long_url = common_shorten_link($short_url, true);
 479     if ($long_url === $short_url) return false;
 480     return $long_url;
 481 }
 482
 483 function common_longurl2($uri)
 484 {
 485     $uri_e = urlencode($uri);
 486     $longurl = unserialize(file_get_contents("http://api.longurl.org/v1/expand?format=php&url=$uri_e"));
 487     if (empty($longurl['long_url']) || $uri === $longurl['long_url']) return false;
 488     return stripslashes($longurl['long_url']);
 489 }
 490
 491 function common_shorten_links($text)
 492 {
 493     if (mb_strlen($text) <= 140) return $text;
 494     static $cache = array();
 495     if (isset($cache[$text])) return $cache[$text];
 496     // \s = not a horizontal whitespace character (since PHP 5.2.4)
 497     return $cache[$text] = preg_replace('@https?://[^)\]>\s]+@e', "common_shorten_link('\\0')", $text);
 498 }
 499
 500 function common_shorten_link($url, $reverse = false)
 501 {
 502     static $url_cache = array();
 503     if ($reverse) return isset($url_cache[$url]) ? $url_cache[$url] : $url;
 504
 505     $user = common_current_user();
 506
 507     $curlh = curl_init();
 508     curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
 509     curl_setopt($curlh, CURLOPT_USERAGENT, 'Laconica');
 510     curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
 511
 512     switch($user->urlshorteningservice) {
 513      case 'ur1.ca':
 514         $short_url_service = new LilUrl;
 515         $short_url = $short_url_service->shorten($url);
 516         break;
 517
 518      case '2tu.us':
 519         $short_url_service = new TightUrl;
 520         $short_url = $short_url_service->shorten($url);
 521         break;
 522
 523      case 'ptiturl.com':
 524         $short_url_service = new PtitUrl;
 525         $short_url = $short_url_service->shorten($url);
 526         break;
 527
 528      case 'bit.ly':
 529         curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($url));
 530         $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
 531         break;
 532
 533      case 'is.gd':
 534         curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($url));
 535         $short_url = curl_exec($curlh);
 536         break;
 537      case 'snipr.com':
 538         curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($url));
 539         $short_url = curl_exec($curlh);
 540         break;
 541      case 'metamark.net':
 542         curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($url));
 543         $short_url = curl_exec($curlh);
 544         break;
 545      case 'tinyurl.com':
 546         curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($url));
 547         $short_url = curl_exec($curlh);
 548         break;
 549      default:
 550         $short_url = false;
 551     }
 552
 553     curl_close($curlh);
 554
 555     if ($short_url) {
 556         $url_cache[(string)$short_url] = $url;
 557         return (string)$short_url;
 558     }
 559     return $url;
 560 }
 561
 562 function common_xml_safe_str($str)
 563 {
 564     $xmlStr = htmlentities(iconv('UTF-8', 'UTF-8//IGNORE', $str), ENT_NOQUOTES, 'UTF-8');
 565
 566     // Replace control, formatting, and surrogate characters with '*', ala Twitter
 567     return preg_replace('/[\p{Cc}\p{Cf}\p{Cs}]/u', '*', $str);
 568 }
 569
 570 function common_tag_link($tag)
 571 {
 572     $canonical = common_canonical_tag($tag);
 573     $url = common_local_url('tag', array('tag' => $canonical));
 574     return '<span class="tag"><a href="' . htmlspecialchars($url) . '" rel="tag">' . htmlspecialchars($tag) . '</a></span>';
 575 }
 576
 577 function common_canonical_tag($tag)
 578 {
 579     return strtolower(str_replace(array('-', '_', '.'), '', $tag));
 580 }
 581
 582 function common_valid_profile_tag($str)
 583 {
 584     return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
 585 }
 586
 587 function common_at_link($sender_id, $nickname)
 588 {
 589     $sender = Profile::staticGet($sender_id);
 590     $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
 591     if ($recipient) {
 592         return '<span class="vcard"><a href="'.htmlspecialchars($recipient->profileurl).'" class="url"><span class="fn nickname">'.$nickname.'</span></a></span>';
 593     } else {
 594         return $nickname;
 595     }
 596 }
 597
 598 function common_at_hash_link($sender_id, $tag)
 599 {
 600     $user = User::staticGet($sender_id);
 601     if (!$user) {
 602         return $tag;
 603     }
 604     $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
 605     if ($tagged) {
 606         $url = common_local_url('subscriptions',
 607                                 array('nickname' => $user->nickname,
 608                                       'tag' => $tag));
 609         return '<span class="tag"><a href="'.htmlspecialchars($url).'" rel="tag">'.$tag.'</a></span>';
 610     } else {
 611         return $tag;
 612     }
 613 }
 614
 615 function common_relative_profile($sender, $nickname, $dt=null)
 616 {
 617     // Try to find profiles this profile is subscribed to that have this nickname
 618     $recipient = new Profile();
 619     // XXX: use a join instead of a subquery
 620     $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
 621     $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
 622     if ($recipient->find(true)) {
 623         // XXX: should probably differentiate between profiles with
 624         // the same name by date of most recent update
 625         return $recipient;
 626     }
 627     // Try to find profiles that listen to this profile and that have this nickname
 628     $recipient = new Profile();
 629     // XXX: use a join instead of a subquery
 630     $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
 631     $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
 632     if ($recipient->find(true)) {
 633         // XXX: should probably differentiate between profiles with
 634         // the same name by date of most recent update
 635         return $recipient;
 636     }
 637     // If this is a local user, try to find a local user with that nickname.
 638     $sender = User::staticGet($sender->id);
 639     if ($sender) {
 640         $recipient_user = User::staticGet('nickname', $nickname);
 641         if ($recipient_user) {
 642             return $recipient_user->getProfile();
 643         }
 644     }
 645     // Otherwise, no links. @messages from local users to remote users,
 646     // or from remote users to other remote users, are just
 647     // outside our ability to make intelligent guesses about
 648     return null;
 649 }
 650
 651 // where should the avatar go for this user?
 652
 653 function common_avatar_filename($id, $extension, $size=null, $extra=null)
 654 {
 655     global $config;
 656
 657     if ($size) {
 658         return $id . '-' . $size . (($extra) ? ('-' . $extra) : '') . $extension;
 659     } else {
 660         return $id . '-original' . (($extra) ? ('-' . $extra) : '') . $extension;
 661     }
 662 }
 663
 664 function common_avatar_path($filename)
 665 {
 666     global $config;
 667     return INSTALLDIR . '/avatar/' . $filename;
 668 }
 669
 670 function common_avatar_url($filename)
 671 {
 672     return common_path('avatar/'.$filename);
 673 }
 674
 675 function common_avatar_display_url($avatar)
 676 {
 677     $server = common_config('avatar', 'server');
 678     if ($server) {
 679         return 'http://'.$server.'/'.$avatar->filename;
 680     } else {
 681         return $avatar->url;
 682     }
 683 }
 684
 685 function common_default_avatar($size)
 686 {
 687     static $sizenames = array(AVATAR_PROFILE_SIZE => 'profile',
 688                               AVATAR_STREAM_SIZE => 'stream',
 689                               AVATAR_MINI_SIZE => 'mini');
 690     return theme_path('default-avatar-'.$sizenames[$size].'.png');
 691 }
 692
 693 function common_local_url($action, $args=null, $fragment=null)
 694 {
 695     $url = null;
 696     if (common_config('site','fancy')) {
 697         $url = common_fancy_url($action, $args);
 698     } else {
 699         $url = common_simple_url($action, $args);
 700     }
 701     if (!is_null($fragment)) {
 702         $url .= '#'.$fragment;
 703     }
 704     return $url;
 705 }
 706
 707 function common_fancy_url($action, $args=null)
 708 {
 709     switch (strtolower($action)) {
 710      case 'public':
 711         if ($args && isset($args['page'])) {
 712             return common_path('?page=' . $args['page']);
 713         } else {
 714             return common_path('');
 715         }
 716      case 'featured':
 717         if ($args && isset($args['page'])) {
 718             return common_path('featured?page=' . $args['page']);
 719         } else {
 720             return common_path('featured');
 721         }
 722      case 'favorited':
 723         if ($args && isset($args['page'])) {
 724             return common_path('favorited?page=' . $args['page']);
 725         } else {
 726             return common_path('favorited');
 727         }
 728      case 'publicrss':
 729         return common_path('rss');
 730      case 'publicatom':
 731         return common_path("api/statuses/public_timeline.atom");
 732      case 'publicxrds':
 733         return common_path('xrds');
 734      case 'featuredrss':
 735         return common_path('featuredrss');
 736      case 'favoritedrss':
 737         return common_path('favoritedrss');
 738      case 'opensearch':
 739         if ($args && $args['type']) {
 740             return common_path('opensearch/'.$args['type']);
 741         } else {
 742             return common_path('opensearch/people');
 743         }
 744      case 'doc':
 745         return common_path('doc/'.$args['title']);
 746      case 'block':
 747      case 'login':
 748      case 'logout':
 749      case 'subscribe':
 750      case 'unsubscribe':
 751      case 'invite':
 752         return common_path('main/'.$action);
 753      case 'tagother':
 754         return common_path('main/tagother?id='.$args['id']);
 755      case 'register':
 756         if ($args && $args['code']) {
 757             return common_path('main/register/'.$args['code']);
 758         } else {
 759             return common_path('main/register');
 760         }
 761      case 'remotesubscribe':
 762         if ($args && $args['nickname']) {
 763             return common_path('main/remote?nickname=' . $args['nickname']);
 764         } else {
 765             return common_path('main/remote');
 766         }
 767      case 'nudge':
 768         return common_path($args['nickname'].'/nudge');
 769      case 'openidlogin':
 770         return common_path('main/openid');
 771      case 'profilesettings':
 772         return common_path('settings/profile');
 773      case 'passwordsettings':
 774         return common_path('settings/password');
 775      case 'emailsettings':
 776         return common_path('settings/email');
 777      case 'openidsettings':
 778         return common_path('settings/openid');
 779      case 'smssettings':
 780         return common_path('settings/sms');
 781      case 'twittersettings':
 782         return common_path('settings/twitter');
 783      case 'othersettings':
 784         return common_path('settings/other');
 785      case 'deleteprofile':
 786         return common_path('settings/delete');
 787      case 'newnotice':
 788         if ($args && $args['replyto']) {
 789             return common_path('notice/new?replyto='.$args['replyto']);
 790         } else {
 791             return common_path('notice/new');
 792         }
 793      case 'shownotice':
 794         return common_path('notice/'.$args['notice']);
 795      case 'deletenotice':
 796         if ($args && $args['notice']) {
 797             return common_path('notice/delete/'.$args['notice']);
 798         } else {
 799             return common_path('notice/delete');
 800         }
 801      case 'microsummary':
 802      case 'xrds':
 803      case 'foaf':
 804         return common_path($args['nickname'].'/'.$action);
 805      case 'all':
 806      case 'replies':
 807      case 'inbox':
 808      case 'outbox':
 809         if ($args && isset($args['page'])) {
 810             return common_path($args['nickname'].'/'.$action.'?page=' . $args['page']);
 811         } else {
 812             return common_path($args['nickname'].'/'.$action);
 813         }
 814      case 'subscriptions':
 815      case 'subscribers':
 816         $nickname = $args['nickname'];
 817         unset($args['nickname']);
 818         if (isset($args['tag'])) {
 819             $tag = $args['tag'];
 820             unset($args['tag']);
 821         }
 822         $params = http_build_query($args);
 823         if ($params) {
 824             return common_path($nickname.'/'.$action . (($tag) ? '/' . $tag : '') . '?' . $params);
 825         } else {
 826             return common_path($nickname.'/'.$action . (($tag) ? '/' . $tag : ''));
 827         }
 828      case 'allrss':
 829         return common_path($args['nickname'].'/all/rss');
 830      case 'repliesrss':
 831         return common_path($args['nickname'].'/replies/rss');
 832      case 'userrss':
 833         if (isset($args['limit']))
 834           return common_path($args['nickname'].'/rss?limit=' . $args['limit']);
 835         return common_path($args['nickname'].'/rss');
 836      case 'showstream':
 837         if ($args && isset($args['page'])) {
 838             return common_path($args['nickname'].'?page=' . $args['page']);
 839         } else {
 840             return common_path($args['nickname']);
 841         }
 842
 843      case 'usertimeline':
 844         return common_path("api/statuses/user_timeline/".$args['nickname'].".atom");
 845      case 'confirmaddress':
 846         return common_path('main/confirmaddress/'.$args['code']);
 847      case 'userbyid':
 848         return common_path('user/'.$args['id']);
 849      case 'recoverpassword':
 850         $path = 'main/recoverpassword';
 851         if ($args['code']) {
 852             $path .= '/' . $args['code'];
 853         }
 854         return common_path($path);
 855      case 'imsettings':
 856         return common_path('settings/im');
 857      case 'avatarsettings':
 858         return common_path('settings/avatar');
 859      case 'peoplesearch':
 860         return common_path('search/people' . (($args) ? ('?' . http_build_query($args)) : ''));
 861      case 'noticesearch':
 862         return common_path('search/notice' . (($args) ? ('?' . http_build_query($args)) : ''));
 863      case 'noticesearchrss':
 864         return common_path('search/notice/rss' . (($args) ? ('?' . http_build_query($args)) : ''));
 865      case 'avatarbynickname':
 866         return common_path($args['nickname'].'/avatar/'.$args['size']);
 867      case 'tag':
 868         if (isset($args['tag']) && $args['tag']) {
 869             $path = 'tag/' . $args['tag'];
 870             unset($args['tag']);
 871         } else {
 872             $path = 'tags';
 873         }
 874         return common_path($path . (($args) ? ('?' . http_build_query($args)) : ''));
 875      case 'peopletag':
 876         $path = 'peopletag/' . $args['tag'];
 877         unset($args['tag']);
 878         return common_path($path . (($args) ? ('?' . http_build_query($args)) : ''));
 879      case 'tags':
 880         return common_path('tags' . (($args) ? ('?' . http_build_query($args)) : ''));
 881      case 'favor':
 882         return common_path('main/favor');
 883      case 'disfavor':
 884         return common_path('main/disfavor');
 885      case 'showfavorites':
 886         if ($args && isset($args['page'])) {
 887             return common_path($args['nickname'].'/favorites?page=' . $args['page']);
 888         } else {
 889             return common_path($args['nickname'].'/favorites');
 890         }
 891      case 'favoritesrss':
 892         return common_path($args['nickname'].'/favorites/rss');
 893      case 'showmessage':
 894         return common_path('message/' . $args['message']);
 895      case 'newmessage':
 896         return common_path('message/new' . (($args) ? ('?' . http_build_query($args)) : ''));
 897      case 'api':
 898         // XXX: do fancy URLs for all the API methods
 899         switch (strtolower($args['apiaction'])) {
 900          case 'statuses':
 901             switch (strtolower($args['method'])) {
 902              case 'user_timeline.rss':
 903                 return common_path('api/statuses/user_timeline/'.$args['argument'].'.rss');
 904              case 'user_timeline.atom':
 905                 return common_path('api/statuses/user_timeline/'.$args['argument'].'.atom');
 906              case 'user_timeline.json':
 907                 return common_path('api/statuses/user_timeline/'.$args['argument'].'.json');
 908              case 'user_timeline.xml':
 909                 return common_path('api/statuses/user_timeline/'.$args['argument'].'.xml');
 910              default: return common_simple_url($action, $args);
 911             }
 912          default: return common_simple_url($action, $args);
 913         }
 914      case 'sup':
 915         if ($args && isset($args['seconds'])) {
 916             return common_path('main/sup?seconds='.$args['seconds']);
 917         } else {
 918             return common_path('main/sup');
 919         }
 920      default:
 921         return common_simple_url($action, $args);
 922     }
 923 }
 924
 925 function common_simple_url($action, $args=null)
 926 {
 927     global $config;
 928     /* XXX: pretty URLs */
 929     $extra = '';
 930     if ($args) {
 931         foreach ($args as $key => $value) {
 932             $extra .= "&${key}=${value}";
 933         }
 934     }
 935     return common_path("index.php?action=${action}${extra}");
 936 }
 937
 938 function common_path($relative)
 939 {
 940     global $config;
 941     $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
 942     return "http://".$config['site']['server'].'/'.$pathpart.$relative;
 943 }
 944
 945 function common_date_string($dt)
 946 {
 947     // XXX: do some sexy date formatting
 948     // return date(DATE_RFC822, $dt);
 949     $t = strtotime($dt);
 950     $now = time();
 951     $diff = $now - $t;
 952
 953     if ($now < $t) { // that shouldn't happen!
 954         return common_exact_date($dt);
 955     } else if ($diff < 60) {
 956         return _('a few seconds ago');
 957     } else if ($diff < 92) {
 958         return _('about a minute ago');
 959     } else if ($diff < 3300) {
 960         return sprintf(_('about %d minutes ago'), round($diff/60));
 961     } else if ($diff < 5400) {
 962         return _('about an hour ago');
 963     } else if ($diff < 22 * 3600) {
 964         return sprintf(_('about %d hours ago'), round($diff/3600));
 965     } else if ($diff < 37 * 3600) {
 966         return _('about a day ago');
 967     } else if ($diff < 24 * 24 * 3600) {
 968         return sprintf(_('about %d days ago'), round($diff/(24*3600)));
 969     } else if ($diff < 46 * 24 * 3600) {
 970         return _('about a month ago');
 971     } else if ($diff < 330 * 24 * 3600) {
 972         return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
 973     } else if ($diff < 480 * 24 * 3600) {
 974         return _('about a year ago');
 975     } else {
 976         return common_exact_date($dt);
 977     }
 978 }
 979
 980 function common_exact_date($dt)
 981 {
 982     static $_utc;
 983     static $_siteTz;
 984
 985     if (!$_utc) {
 986         $_utc = new DateTimeZone('UTC');
 987         $_siteTz = new DateTimeZone(common_timezone());
 988     }
 989
 990     $dateStr = date('d F Y H:i:s', strtotime($dt));
 991     $d = new DateTime($dateStr, $_utc);
 992     $d->setTimezone($_siteTz);
 993     return $d->format(DATE_RFC850);
 994 }
 995
 996 function common_date_w3dtf($dt)
 997 {
 998     $dateStr = date('d F Y H:i:s', strtotime($dt));
 999     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1000     $d->setTimezone(new DateTimeZone(common_timezone()));
1001     return $d->format(DATE_W3C);
1002 }
1003
1004 function common_date_rfc2822($dt)
1005 {
1006     $dateStr = date('d F Y H:i:s', strtotime($dt));
1007     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1008     $d->setTimezone(new DateTimeZone(common_timezone()));
1009     return $d->format('r');
1010 }
1011
1012 function common_date_iso8601($dt)
1013 {
1014     $dateStr = date('d F Y H:i:s', strtotime($dt));
1015     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1016     $d->setTimezone(new DateTimeZone(common_timezone()));
1017     return $d->format('c');
1018 }
1019
1020 function common_sql_now()
1021 {
1022     return strftime('%Y-%m-%d %H:%M:%S', time());
1023 }
1024
1025 function common_redirect($url, $code=307)
1026 {
1027     static $status = array(301 => "Moved Permanently",
1028                            302 => "Found",
1029                            303 => "See Other",
1030                            307 => "Temporary Redirect");
1031     header("Status: ${code} $status[$code]");
1032     header("Location: $url");
1033
1034     common_start_xml('a',
1035                      '-//W3C//DTD XHTML 1.0 Strict//EN',
1036                      'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1037     common_element('a', array('href' => $url), $url);
1038     common_end_xml();
1039     exit;
1040 }
1041
1042 function common_save_replies($notice)
1043 {
1044     // Alternative reply format
1045     $tname = false;
1046     if (preg_match('/^T ([A-Z0-9]{1,64}) /', $notice->content, $match)) {
1047         $tname = $match[1];
1048     }
1049     // extract all @messages
1050     $cnt = preg_match_all('/(?:^|\s)@([a-z0-9]{1,64})/', $notice->content, $match);
1051
1052     $names = array();
1053
1054     if ($cnt || $tname) {
1055         // XXX: is there another way to make an array copy?
1056         $names = ($tname) ? array_unique(array_merge(array(strtolower($tname)), $match[1])) : array_unique($match[1]);
1057     }
1058
1059     $sender = Profile::staticGet($notice->profile_id);
1060
1061     $replied = array();
1062
1063     // store replied only for first @ (what user/notice what the reply directed,
1064     // we assume first @ is it)
1065
1066     for ($i=0; $i<count($names); $i++) {
1067         $nickname = $names[$i];
1068         $recipient = common_relative_profile($sender, $nickname, $notice->created);
1069         if (!$recipient) {
1070             continue;
1071         }
1072         if ($i == 0 && ($recipient->id != $sender->id) && !$notice->reply_to) { // Don't save reply to self
1073             $reply_for = $recipient;
1074             $recipient_notice = $reply_for->getCurrentNotice();
1075             if ($recipient_notice) {
1076                 $orig = clone($notice);
1077                 $notice->reply_to = $recipient_notice->id;
1078                 $notice->update($orig);
1079             }
1080         }
1081         // Don't save replies from blocked profile to local user
1082         $recipient_user = User::staticGet('id', $recipient->id);
1083         if ($recipient_user && $recipient_user->hasBlocked($sender)) {
1084             continue;
1085         }
1086         $reply = new Reply();
1087         $reply->notice_id = $notice->id;
1088         $reply->profile_id = $recipient->id;
1089         $id = $reply->insert();
1090         if (!$id) {
1091             $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1092             common_log(LOG_ERR, 'DB error inserting reply: ' . $last_error->message);
1093             common_server_error(sprintf(_('DB error inserting reply: %s'), $last_error->message));
1094             return;
1095         } else {
1096             $replied[$recipient->id] = 1;
1097         }
1098     }
1099
1100     // Hash format replies, too
1101     $cnt = preg_match_all('/(?:^|\s)@#([a-z0-9]{1,64})/', $notice->content, $match);
1102     if ($cnt) {
1103         foreach ($match[1] as $tag) {
1104             $tagged = Profile_tag::getTagged($sender->id, $tag);
1105             foreach ($tagged as $t) {
1106                 if (!$replied[$t->id]) {
1107                     // Don't save replies from blocked profile to local user
1108                     $t_user = User::staticGet('id', $t->id);
1109                     if ($t_user && $t_user->hasBlocked($sender)) {
1110                         continue;
1111                     }
1112                     $reply = new Reply();
1113                     $reply->notice_id = $notice->id;
1114                     $reply->profile_id = $t->id;
1115                     $id = $reply->insert();
1116                     if (!$id) {
1117                         common_log_db_error($reply, 'INSERT', __FILE__);
1118                         return;
1119                     }
1120                 }
1121             }
1122         }
1123     }
1124 }
1125
1126 function common_broadcast_notice($notice, $remote=false)
1127 {
1128
1129     // Check to see if notice should go to Twitter
1130     $flink = Foreign_link::getByUserID($notice->profile_id, 1); // 1 == Twitter
1131     if (($flink->noticesync & FOREIGN_NOTICE_SEND) == FOREIGN_NOTICE_SEND) {
1132
1133         // If it's not a Twitter-style reply, or if the user WANTS to send replies...
1134
1135         if (!preg_match('/^@[a-zA-Z0-9_]{1,15}\b/u', $notice->content) ||
1136             (($flink->noticesync & FOREIGN_NOTICE_SEND_REPLY) == FOREIGN_NOTICE_SEND_REPLY)) {
1137
1138             $result = common_twitter_broadcast($notice, $flink);
1139
1140             if (!$result) {
1141                 common_debug('Unable to send notice: ' . $notice->id . ' to Twitter.', __FILE__);
1142             }
1143         }
1144     }
1145
1146     if (common_config('queue', 'enabled')) {
1147         // Do it later!
1148         return common_enqueue_notice($notice);
1149     } else {
1150         return common_real_broadcast($notice, $remote);
1151     }
1152 }
1153
1154 function common_twitter_broadcast($notice, $flink)
1155 {
1156     global $config;
1157     $success = true;
1158     $fuser = $flink->getForeignUser();
1159     $twitter_user = $fuser->nickname;
1160     $twitter_password = $flink->credentials;
1161     $uri = 'http://www.twitter.com/statuses/update.json';
1162
1163     // XXX: Hack to get around PHP cURL's use of @ being a a meta character
1164     $statustxt = preg_replace('/^@/', ' @', $notice->content);
1165
1166     $options = array(
1167                      CURLOPT_USERPWD         => "$twitter_user:$twitter_password",
1168                      CURLOPT_POST            => true,
1169                      CURLOPT_POSTFIELDS        => array(
1170                                                         'status'    => $statustxt,
1171                                                         'source'    => $config['integration']['source']
1172                                                         ),
1173                      CURLOPT_RETURNTRANSFER    => true,
1174                      CURLOPT_FAILONERROR        => true,
1175                      CURLOPT_HEADER            => false,
1176                      CURLOPT_FOLLOWLOCATION    => true,
1177                      CURLOPT_USERAGENT        => "Laconica",
1178                      CURLOPT_CONNECTTIMEOUT    => 120,  // XXX: Scary!!!! How long should this be?
1179                      CURLOPT_TIMEOUT            => 120,
1180
1181                      # Twitter is strict about accepting invalid "Expect" headers
1182                      CURLOPT_HTTPHEADER => array('Expect:')
1183                      );
1184
1185     $ch = curl_init($uri);
1186     curl_setopt_array($ch, $options);
1187     $data = curl_exec($ch);
1188     $errmsg = curl_error($ch);
1189
1190     if ($errmsg) {
1191         common_debug("cURL error: $errmsg - trying to send notice for $twitter_user.",
1192                      __FILE__);
1193         $success = false;
1194     }
1195
1196     curl_close($ch);
1197
1198     if (!$data) {
1199         common_debug("No data returned by Twitter's API trying to send update for $twitter_user",
1200                      __FILE__);
1201         $success = false;
1202     }
1203
1204     // Twitter should return a status
1205     $status = json_decode($data);
1206
1207     if (!$status->id) {
1208         common_debug("Unexpected data returned by Twitter API trying to send update for $twitter_user",
1209                      __FILE__);
1210         $success = false;
1211     }
1212
1213     return $success;
1214 }
1215
1216 // Stick the notice on the queue
1217
1218 function common_enqueue_notice($notice)
1219 {
1220     foreach (array('jabber', 'omb', 'sms', 'public') as $transport) {
1221         $qi = new Queue_item();
1222         $qi->notice_id = $notice->id;
1223         $qi->transport = $transport;
1224         $qi->created = $notice->created;
1225         $result = $qi->insert();
1226         if (!$result) {
1227             $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1228             common_log(LOG_ERR, 'DB error inserting queue item: ' . $last_error->message);
1229             return false;
1230         }
1231         common_log(LOG_DEBUG, 'complete queueing notice ID = ' . $notice->id . ' for ' . $transport);
1232     }
1233     return $result;
1234 }
1235
1236 function common_dequeue_notice($notice)
1237 {
1238     $qi = Queue_item::staticGet($notice->id);
1239     if ($qi) {
1240         $result = $qi->delete();
1241         if (!$result) {
1242             $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1243             common_log(LOG_ERR, 'DB error deleting queue item: ' . $last_error->message);
1244             return false;
1245         }
1246         common_log(LOG_DEBUG, 'complete dequeueing notice ID = ' . $notice->id);
1247         return $result;
1248     } else {
1249         return false;
1250     }
1251 }
1252
1253 function common_real_broadcast($notice, $remote=false)
1254 {
1255     $success = true;
1256     if (!$remote) {
1257         // Make sure we have the OMB stuff
1258         require_once(INSTALLDIR.'/lib/omb.php');
1259         $success = omb_broadcast_remote_subscribers($notice);
1260         if (!$success) {
1261             common_log(LOG_ERR, 'Error in OMB broadcast for notice ' . $notice->id);
1262         }
1263     }
1264     if ($success) {
1265         require_once(INSTALLDIR.'/lib/jabber.php');
1266         $success = jabber_broadcast_notice($notice);
1267         if (!$success) {
1268             common_log(LOG_ERR, 'Error in jabber broadcast for notice ' . $notice->id);
1269         }
1270     }
1271     if ($success) {
1272         require_once(INSTALLDIR.'/lib/mail.php');
1273         $success = mail_broadcast_notice_sms($notice);
1274         if (!$success) {
1275             common_log(LOG_ERR, 'Error in sms broadcast for notice ' . $notice->id);
1276         }
1277     }
1278     if ($success) {
1279         $success = jabber_public_notice($notice);
1280         if (!$success) {
1281             common_log(LOG_ERR, 'Error in public broadcast for notice ' . $notice->id);
1282         }
1283     }
1284     // XXX: broadcast notices to other IM
1285     return $success;
1286 }
1287
1288 function common_broadcast_profile($profile)
1289 {
1290     // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
1291     require_once(INSTALLDIR.'/lib/omb.php');
1292     omb_broadcast_profile($profile);
1293     // XXX: Other broadcasts...?
1294     return true;
1295 }
1296
1297 function common_profile_url($nickname)
1298 {
1299     return common_local_url('showstream', array('nickname' => $nickname));
1300 }
1301
1302 // Should make up a reasonable root URL
1303
1304 function common_root_url()
1305 {
1306     return common_path('');
1307 }
1308
1309 // returns $bytes bytes of random data as a hexadecimal string
1310 // "good" here is a goal and not a guarantee
1311
1312 function common_good_rand($bytes)
1313 {
1314     // XXX: use random.org...?
1315     if (file_exists('/dev/urandom')) {
1316         return common_urandom($bytes);
1317     } else { // FIXME: this is probably not good enough
1318         return common_mtrand($bytes);
1319     }
1320 }
1321
1322 function common_urandom($bytes)
1323 {
1324     $h = fopen('/dev/urandom', 'rb');
1325     // should not block
1326     $src = fread($h, $bytes);
1327     fclose($h);
1328     $enc = '';
1329     for ($i = 0; $i < $bytes; $i++) {
1330         $enc .= sprintf("%02x", (ord($src[$i])));
1331     }
1332     return $enc;
1333 }
1334
1335 function common_mtrand($bytes)
1336 {
1337     $enc = '';
1338     for ($i = 0; $i < $bytes; $i++) {
1339         $enc .= sprintf("%02x", mt_rand(0, 255));
1340     }
1341     return $enc;
1342 }
1343
1344 function common_set_returnto($url)
1345 {
1346     common_ensure_session();
1347     $_SESSION['returnto'] = $url;
1348 }
1349
1350 function common_get_returnto()
1351 {
1352     common_ensure_session();
1353     return $_SESSION['returnto'];
1354 }
1355
1356 function common_timestamp()
1357 {
1358     return date('YmdHis');
1359 }
1360
1361 function common_ensure_syslog()
1362 {
1363     static $initialized = false;
1364     if (!$initialized) {
1365         global $config;
1366         openlog($config['syslog']['appname'], 0, LOG_USER);
1367         $initialized = true;
1368     }
1369 }
1370
1371 function common_log($priority, $msg, $filename=null)
1372 {
1373     $logfile = common_config('site', 'logfile');
1374     if ($logfile) {
1375         $log = fopen($logfile, "a");
1376         if ($log) {
1377             static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1378                                               'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1379             $output = date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
1380             fwrite($log, $output);
1381             fclose($log);
1382         }
1383     } else {
1384         common_ensure_syslog();
1385         syslog($priority, $msg);
1386     }
1387 }
1388
1389 function common_debug($msg, $filename=null)
1390 {
1391     if ($filename) {
1392         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1393     } else {
1394         common_log(LOG_DEBUG, $msg);
1395     }
1396 }
1397
1398 function common_log_db_error(&$object, $verb, $filename=null)
1399 {
1400     $objstr = common_log_objstring($object);
1401     $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1402     common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1403 }
1404
1405 function common_log_objstring(&$object)
1406 {
1407     if (is_null($object)) {
1408         return "null";
1409     }
1410     $arr = $object->toArray();
1411     $fields = array();
1412     foreach ($arr as $k => $v) {
1413         $fields[] = "$k='$v'";
1414     }
1415     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1416     return $objstring;
1417 }
1418
1419 function common_valid_http_url($url)
1420 {
1421     return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1422 }
1423
1424 function common_valid_tag($tag)
1425 {
1426     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1427         return (Validate::email($matches[1]) ||
1428                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1429     }
1430     return false;
1431 }
1432
1433 /* Following functions are copied from MediaWiki GlobalFunctions.php
1434  * and written by Evan Prodromou. */
1435
1436 function common_accept_to_prefs($accept, $def = '*/*')
1437 {
1438     // No arg means accept anything (per HTTP spec)
1439     if(!$accept) {
1440         return array($def => 1);
1441     }
1442
1443     $prefs = array();
1444
1445     $parts = explode(',', $accept);
1446
1447     foreach($parts as $part) {
1448         // FIXME: doesn't deal with params like 'text/html; level=1'
1449         @list($value, $qpart) = explode(';', $part);
1450         $match = array();
1451         if(!isset($qpart)) {
1452             $prefs[$value] = 1;
1453         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1454             $prefs[$value] = $match[1];
1455         }
1456     }
1457
1458     return $prefs;
1459 }
1460
1461 function common_mime_type_match($type, $avail)
1462 {
1463     if(array_key_exists($type, $avail)) {
1464         return $type;
1465     } else {
1466         $parts = explode('/', $type);
1467         if(array_key_exists($parts[0] . '/*', $avail)) {
1468             return $parts[0] . '/*';
1469         } elseif(array_key_exists('*/*', $avail)) {
1470             return '*/*';
1471         } else {
1472             return null;
1473         }
1474     }
1475 }
1476
1477 function common_negotiate_type($cprefs, $sprefs)
1478 {
1479     $combine = array();
1480
1481     foreach(array_keys($sprefs) as $type) {
1482         $parts = explode('/', $type);
1483         if($parts[1] != '*') {
1484             $ckey = common_mime_type_match($type, $cprefs);
1485             if($ckey) {
1486                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1487             }
1488         }
1489     }
1490
1491     foreach(array_keys($cprefs) as $type) {
1492         $parts = explode('/', $type);
1493         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1494             $skey = common_mime_type_match($type, $sprefs);
1495             if($skey) {
1496                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1497             }
1498         }
1499     }
1500
1501     $bestq = 0;
1502     $besttype = "text/html";
1503
1504     foreach(array_keys($combine) as $type) {
1505         if($combine[$type] > $bestq) {
1506             $besttype = $type;
1507             $bestq = $combine[$type];
1508         }
1509     }
1510
1511     return $besttype;
1512 }
1513
1514 function common_config($main, $sub)
1515 {
1516     global $config;
1517     return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1518 }
1519
1520 function common_copy_args($from)
1521 {
1522     $to = array();
1523     $strip = get_magic_quotes_gpc();
1524     foreach ($from as $k => $v) {
1525         $to[$k] = ($strip) ? stripslashes($v) : $v;
1526     }
1527     return $to;
1528 }
1529
1530 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1531 // This is used before handing a request off to OAuthRequest::from_request.
1532 function common_remove_magic_from_request()
1533 {
1534     if(get_magic_quotes_gpc()) {
1535         $_POST=array_map('stripslashes',$_POST);
1536         $_GET=array_map('stripslashes',$_GET);
1537     }
1538 }
1539
1540 function common_user_uri(&$user)
1541 {
1542     return common_local_url('userbyid', array('id' => $user->id));
1543 }
1544
1545 function common_notice_uri(&$notice)
1546 {
1547     return common_local_url('shownotice',
1548                             array('notice' => $notice->id));
1549 }
1550
1551 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1552
1553 function common_confirmation_code($bits)
1554 {
1555     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1556     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1557     $chars = ceil($bits/5);
1558     $code = '';
1559     for ($i = 0; $i < $chars; $i++) {
1560         // XXX: convert to string and back
1561         $num = hexdec(common_good_rand(1));
1562         // XXX: randomness is too precious to throw away almost
1563         // 40% of the bits we get!
1564         $code .= $codechars[$num%32];
1565     }
1566     return $code;
1567 }
1568
1569 // convert markup to HTML
1570
1571 function common_markup_to_html($c)
1572 {
1573     $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1574     $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1575     $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1576     return Markdown($c);
1577 }
1578
1579 function common_profile_avatar_url($profile, $size=AVATAR_PROFILE_SIZE)
1580 {
1581     $avatar = $profile->getAvatar($size);
1582     if ($avatar) {
1583         return common_avatar_display_url($avatar);
1584     } else {
1585         return common_default_avatar($size);
1586     }
1587 }
1588
1589 function common_profile_uri($profile)
1590 {
1591     if (!$profile) {
1592         return null;
1593     }
1594     $user = User::staticGet($profile->id);
1595     if ($user) {
1596         return $user->uri;
1597     }
1598
1599     $remote = Remote_profile::staticGet($profile->id);
1600     if ($remote) {
1601         return $remote->uri;
1602     }
1603     // XXX: this is a very bad profile!
1604     return null;
1605 }
1606
1607 function common_canonical_sms($sms)
1608 {
1609     // strip non-digits
1610     preg_replace('/\D/', '', $sms);
1611     return $sms;
1612 }
1613
1614 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1615 {
1616     switch ($errno) {
1617      case E_USER_ERROR:
1618         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline)");
1619         exit(1);
1620         break;
1621
1622      case E_USER_WARNING:
1623         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1624         break;
1625
1626      case E_USER_NOTICE:
1627         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1628         break;
1629     }
1630
1631     // FIXME: show error page if we're on the Web
1632     /* Don't execute PHP internal error handler */
1633     return true;
1634 }
1635
1636 function common_session_token()
1637 {
1638     common_ensure_session();
1639     if (!array_key_exists('token', $_SESSION)) {
1640         $_SESSION['token'] = common_good_rand(64);
1641     }
1642     return $_SESSION['token'];
1643 }
1644
1645 function common_nudge_response()
1646 {
1647     common_element('p', array('id' => 'nudge_response'), _('Nudge sent!'));
1648 }
1649
1650 // XXX: Refactor this code
1651 function common_profile_new_message_nudge ($cur, $profile)
1652 {
1653     $user = User::staticGet('id', $profile->id);
1654
1655     if ($cur && $cur->id != $user->id && $cur->mutuallySubscribed($user)) {
1656         common_element_start('li', array('id' => 'profile_send_a_new_message'));
1657         common_element('a', array('href' => common_local_url('newmessage', array('to' => $user->id))),
1658                        _('Send a message'));
1659         common_element_end('li');
1660
1661         if ($user->email && $user->emailnotifynudge) {
1662             common_element_start('li', array('id' => 'profile_nudge'));
1663             common_nudge_form($user);
1664             common_element_end('li');
1665         }
1666     }
1667 }
1668
1669 function common_cache_key($extra)
1670 {
1671     return 'laconica:' . common_keyize(common_config('site', 'name')) . ':' . $extra;
1672 }
1673
1674 function common_keyize($str)
1675 {
1676     $str = strtolower($str);
1677     $str = preg_replace('/\s/', '_', $str);
1678     return $str;
1679 }
1680
1681 function common_memcache()
1682 {
1683     static $cache = null;
1684     if (!common_config('memcached', 'enabled')) {
1685         return null;
1686     } else {
1687         if (!$cache) {
1688             $cache = new Memcache();
1689             $servers = common_config('memcached', 'server');
1690             if (is_array($servers)) {
1691                 foreach($servers as $server) {
1692                     $cache->addServer($server);
1693                 }
1694             } else {
1695                 $cache->addServer($servers);
1696             }
1697         }
1698         return $cache;
1699     }
1700 }
1701
1702 function common_compatible_license($from, $to)
1703 {
1704     // XXX: better compatibility check needed here!
1705     return ($from == $to);
1706 }