lib/util.php

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