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, HTML, user, files) */
  21
  22 # Show a server error
  23
  24 function common_server_error($msg, $code=500) {
  25         static $status = array(500 => 'Internal Server Error',
  26                                                    501 => 'Not Implemented',
  27                                                    502 => 'Bad Gateway',
  28                                                    503 => 'Service Unavailable',
  29                                                    504 => 'Gateway Timeout',
  30                                                    505 => 'HTTP Version Not Supported');
  31
  32         if (!array_key_exists($code, $status)) {
  33                 $code = 500;
  34         }
  35
  36         $status_string = $status[$code];
  37
  38         header('HTTP/1.1 '.$code.' '.$status_string);
  39         header('Content-type: text/plain');
  40
  41         print $msg;
  42         print "\n";
  43         exit();
  44 }
  45
  46 # Show a user error
  47 function common_user_error($msg, $code=400) {
  48         static $status = array(400 => 'Bad Request',
  49                                                    401 => 'Unauthorized',
  50                                                    402 => 'Payment Required',
  51                                                    403 => 'Forbidden',
  52                                                    404 => 'Not Found',
  53                                                    405 => 'Method Not Allowed',
  54                                                    406 => 'Not Acceptable',
  55                                                    407 => 'Proxy Authentication Required',
  56                                                    408 => 'Request Timeout',
  57                                                    409 => 'Conflict',
  58                                                    410 => 'Gone',
  59                                                    411 => 'Length Required',
  60                                                    412 => 'Precondition Failed',
  61                                                    413 => 'Request Entity Too Large',
  62                                                    414 => 'Request-URI Too Long',
  63                                                    415 => 'Unsupported Media Type',
  64                                                    416 => 'Requested Range Not Satisfiable',
  65                                                    417 => 'Expectation Failed');
  66
  67         if (!array_key_exists($code, $status)) {
  68                 $code = 400;
  69         }
  70
  71         $status_string = $status[$code];
  72
  73         header('HTTP/1.1 '.$code.' '.$status_string);
  74
  75         common_show_header('Error');
  76         common_element('div', array('class' => 'error'), $msg);
  77         common_show_footer();
  78 }
  79
  80 $xw = null;
  81
  82 # Start an HTML element
  83 function common_element_start($tag, $attrs=NULL) {
  84         global $xw;
  85         $xw->startElement($tag);
  86         if (is_array($attrs)) {
  87                 foreach ($attrs as $name => $value) {
  88                         $xw->writeAttribute($name, $value);
  89                 }
  90         } else if (is_string($attrs)) {
  91                 $xw->writeAttribute('class', $attrs);
  92         }
  93 }
  94
  95 function common_element_end($tag) {
  96         global $xw;
  97         # TODO: switch based on $tag
  98         $xw->fullEndElement();
  99 }
 100
 101 function common_element($tag, $attrs=NULL, $content=NULL) {
 102     common_element_start($tag, $attrs);
 103     global $xw;
 104     $xw->text($content);
 105     common_element_end($tag);
 106 }
 107
 108 function common_start_xml($doc=NULL, $public=NULL, $system=NULL) {
 109         global $xw;
 110         $xw = new XMLWriter();
 111         $xw->openURI('php://output');
 112         $xw->setIndent(true);
 113         $xw->startDocument('1.0', 'UTF-8');
 114         if ($doc) {
 115                 $xw->writeDTD($doc, $public, $system);
 116         }
 117 }
 118
 119 function common_end_xml() {
 120         global $xw;
 121         $xw->endDocument();
 122         $xw->flush();
 123 }
 124
 125 define('PAGE_TYPE_PREFS', 'application/xhtml+xml,text/html;q=0.7,application/xml;q=0.3,text/xml;q=0.2');
 126
 127 function common_show_header($pagetitle, $callable=NULL, $data=NULL, $headercall=NULL) {
 128         global $config, $xw;
 129
 130         $httpaccept = isset($_SERVER['HTTP_ACCEPT']) ? $_SERVER['HTTP_ACCEPT'] : NULL;
 131
 132         # XXX: allow content negotiation for RDF, RSS, or XRDS
 133
 134         $type = common_negotiate_type(common_accept_to_prefs($httpaccept),
 135                                                                   common_accept_to_prefs(PAGE_TYPE_PREFS));
 136
 137         if (!$type) {
 138                 common_user_error(_t('This page is not available in a media type you accept'), 406);
 139                 exit(0);
 140         }
 141
 142         header('Content-Type: '.$type);
 143
 144         common_start_xml('html',
 145                                          '-//W3C//DTD XHTML 1.0 Strict//EN',
 146                                          'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
 147
 148         # FIXME: correct language for interface
 149
 150         common_element_start('html', array('xmlns' => 'http://www.w3.org/1999/xhtml',
 151                                                                            'xml:lang' => 'en',
 152                                                                            'lang' => 'en'));
 153
 154         common_element_start('head');
 155         common_element('title', NULL,
 156                                    $pagetitle . " - " . $config['site']['name']);
 157         common_element('link', array('rel' => 'stylesheet',
 158                                                                  'type' => 'text/css',
 159                                                                  'href' => theme_path('display.css'),
 160                                                                  'media' => 'screen, projection, tv'));
 161         foreach (array(6,7) as $ver) {
 162                 if (file_exists(theme_file('ie'.$ver.'.css'))) {
 163                         # Yes, IE people should be put in jail.
 164                         $xw->writeComment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
 165                                                           'href="'.theme_path('ie'.$ver.'.css').'" /><![endif]');
 166                 }
 167         }
 168
 169         common_element('script', array('type' => 'text/javascript',
 170                                                                    'src' => common_path('js/jquery.min.js')),
 171                                    ' ');
 172         common_element('script', array('type' => 'text/javascript',
 173                                                                    'src' => common_path('js/util.js')),
 174                                    ' ');
 175
 176         if ($callable) {
 177                 if ($data) {
 178                         call_user_func($callable, $data);
 179                 } else {
 180                         call_user_func($callable);
 181                 }
 182         }
 183         common_element_end('head');
 184         common_element_start('body');
 185         common_element_start('div', array('id' => 'wrap'));
 186         common_element_start('div', array('id' => 'header'));
 187         common_nav_menu();
 188         if ((is_string($config['site']['logo']) && (strlen($config['site']['logo']) > 0))
 189                 || file_exists(theme_file('logo.png')))
 190         {
 191                 common_element_start('a', array('href' => common_local_url('public')));
 192                 common_element('img', array('src' => ($config['site']['logo']) ?
 193                                                                         ($config['site']['logo']) : theme_path('logo.png'),
 194                                                                         'alt' => $config['site']['name'],
 195                                                                         'id' => 'logo'));
 196                 common_element_end('a');
 197         } else {
 198                 common_element_start('p', array('id' => 'branding'));
 199                 common_element('a', array('href' => common_local_url('public')),
 200                                            $config['site']['name']);
 201                 common_element_end('p');
 202         }
 203
 204         common_element('h1', 'pagetitle', $pagetitle);
 205
 206         if ($headercall) {
 207                 if ($data) {
 208                         call_user_func($headercall, $data);
 209                 } else {
 210                         call_user_func($headercall);
 211                 }
 212         }
 213         common_element_end('div');
 214         common_element_start('div', array('id' => 'content'));
 215 }
 216
 217 function common_show_footer() {
 218         global $xw, $config;
 219         common_element_end('div'); # content div
 220         common_foot_menu();
 221         common_element_start('div', array('id' => 'footer'));
 222         common_element_start('div', 'laconica');
 223         if (common_config('site', 'broughtby')) {
 224                 $instr = _t('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
 225         } else {
 226                 $instr = _t('**%%site.name%%** is a microblogging service. ');
 227         }
 228         $instr .= _t('It runs the [Laconica](http://laconi.ca/) ' .
 229                          'microblogging software, version ' . LACONICA_VERSION . ', ' .
 230                          'available under the ' .
 231                          '[GNU Affero General Public License]' .
 232                          '(http://www.fsf.org/licensing/licenses/agpl-3.0.html).');
 233     $output = common_markup_to_html($instr);
 234     common_raw($output);
 235         common_element_end('div');
 236         common_element('img', array('id' => 'cc',
 237                                                                 'src' => $config['license']['image'],
 238                                                                 'alt' => $config['license']['title']));
 239         common_element_start('p');
 240         common_text(_t('Unless otherwise specified, contents of this site are copyright by the contributors and available under the '));
 241         common_element('a', array('class' => 'license',
 242                                                           'rel' => 'license',
 243                                                           href => $config['license']['url']),
 244                                    $config['license']['title']);
 245         common_text(_t('. Contributors should be attributed by full name or nickname.'));
 246         common_element_end('p');
 247         common_element_end('div');
 248         common_element_end('div');
 249         common_element_end('body');
 250         common_element_end('html');
 251         common_end_xml();
 252 }
 253
 254 function common_text($txt) {
 255         global $xw;
 256         $xw->text($txt);
 257 }
 258
 259 function common_raw($xml) {
 260         global $xw;
 261         $xw->writeRaw($xml);
 262 }
 263
 264 function common_nav_menu() {
 265         $user = common_current_user();
 266         common_element_start('ul', array('id' => 'nav'));
 267         if ($user) {
 268                 common_menu_item(common_local_url('all', array('nickname' => $user->nickname)),
 269                                                  _t('Home'));
 270         }
 271         common_menu_item(common_local_url('public'), _t('Public'));
 272         common_menu_item(common_local_url('doc', array('title' => 'help')),
 273                                          _t('Help'));
 274         if ($user) {
 275                 common_menu_item(common_local_url('profilesettings'),
 276                                                  _t('Settings'));
 277                 common_menu_item(common_local_url('logout'),
 278                                                  _t('Logout'));
 279         } else {
 280                 common_menu_item(common_local_url('login'), _t('Login'));
 281                 common_menu_item(common_local_url('register'), _t('Register'));
 282                 common_menu_item(common_local_url('openidlogin'), _t('OpenID'));
 283         }
 284         common_element_end('ul');
 285 }
 286
 287 function common_foot_menu() {
 288         common_element_start('ul', array('id' => 'nav_sub'));
 289         common_menu_item(common_local_url('doc', array('title' => 'about')),
 290                                          _t('About'));
 291         common_menu_item(common_local_url('doc', array('title' => 'faq')),
 292                                          _t('FAQ'));
 293         common_menu_item(common_local_url('doc', array('title' => 'privacy')),
 294                                          _t('Privacy'));
 295         common_menu_item(common_local_url('doc', array('title' => 'source')),
 296                                          _t('Source'));
 297         common_menu_item(common_local_url('doc', array('title' => 'contact')),
 298                                          _t('Contact'));
 299         common_element_end('ul');
 300 }
 301
 302 function common_menu_item($url, $text, $title=NULL, $is_selected=false) {
 303         $lattrs = array();
 304         if ($is_selected) {
 305                 $lattrs['class'] = 'current';
 306         }
 307         common_element_start('li', $lattrs);
 308         $attrs['href'] = $url;
 309         if ($title) {
 310                 $attrs['title'] = $title;
 311         }
 312         common_element('a', $attrs, $text);
 313         common_element_end('li');
 314 }
 315
 316 function common_input($id, $label, $value=NULL,$instructions=NULL) {
 317         common_element_start('p');
 318         common_element('label', array('for' => $id), $label);
 319         $attrs = array('name' => $id,
 320                                    'type' => 'text',
 321                                    'class' => 'input_text',
 322                                    'id' => $id);
 323         if ($value) {
 324                 $attrs['value'] = htmlspecialchars($value);
 325         }
 326         common_element('input', $attrs);
 327         if ($instructions) {
 328                 common_element('span', 'input_instructions', $instructions);
 329         }
 330         common_element_end('p');
 331 }
 332
 333 function common_checkbox($id, $label, $checked=false, $instructions=NULL, $value='true')
 334 {
 335         common_element_start('p');
 336         $attrs = array('name' => $id,
 337                                    'type' => 'checkbox',
 338                                    'class' => 'checkbox',
 339                                    'id' => $id);
 340         if ($value) {
 341                 $attrs['value'] = htmlspecialchars($value);
 342         }
 343         if ($checked) {
 344                 $attrs['checked'] = 'checked';
 345         }
 346         common_element('input', $attrs);
 347         # XXX: use a <label>
 348         common_text(' ');
 349         common_element('span', 'checkbox_label', $label);
 350         common_text(' ');
 351         if ($instructions) {
 352                 common_element('span', 'input_instructions', $instructions);
 353         }
 354         common_element_end('p');
 355 }
 356
 357 function common_hidden($id, $value) {
 358         common_element('input', array('name' => $id,
 359                                                                   'type' => 'hidden',
 360                                                                   'id' => $id,
 361                                                                   'value' => $value));
 362 }
 363
 364 function common_password($id, $label, $instructions=NULL) {
 365         common_element_start('p');
 366         common_element('label', array('for' => $id), $label);
 367         $attrs = array('name' => $id,
 368                                    'type' => 'password',
 369                                    'class' => 'password',
 370                                    'id' => $id);
 371         common_element('input', $attrs);
 372         if ($instructions) {
 373                 common_element('span', 'input_instructions', $instructions);
 374         }
 375         common_element_end('p');
 376 }
 377
 378 function common_submit($id, $label) {
 379         global $xw;
 380         common_element_start('p');
 381         common_element('input', array('type' => 'submit',
 382                                                                   'id' => $id,
 383                                                                   'name' => $id,
 384                                                                   'class' => 'submit',
 385                                                                   'value' => $label));
 386         common_element_end('p');
 387 }
 388
 389 function common_textarea($id, $label, $content=NULL, $instructions=NULL) {
 390         common_element_start('p');
 391         common_element('label', array('for' => $id), $label);
 392         common_element('textarea', array('rows' => 3,
 393                                                                          'cols' => 40,
 394                                                                          'name' => $id,
 395                                                                          'id' => $id),
 396                                    ($content) ? $content : '');
 397         if ($instructions) {
 398                 common_element('span', 'input_instructions', $instructions);
 399         }
 400         common_element_end('p');
 401 }
 402
 403 # salted, hashed passwords are stored in the DB
 404
 405 function common_munge_password($password, $id) {
 406         return md5($password . $id);
 407 }
 408
 409 # check if a username exists and has matching password
 410 function common_check_user($nickname, $password) {
 411         $user = User::staticGet('nickname', $nickname);
 412         if (is_null($user)) {
 413                 return false;
 414         } else {
 415                 return (0 == strcmp(common_munge_password($password, $user->id),
 416                                                         $user->password));
 417         }
 418 }
 419
 420 # is the current user logged in?
 421 function common_logged_in() {
 422         return (!is_null(common_current_user()));
 423 }
 424
 425 function common_have_session() {
 426         return (0 != strcmp(session_id(), ''));
 427 }
 428
 429 function common_ensure_session() {
 430         if (!common_have_session()) {
 431                 @session_start();
 432         }
 433 }
 434
 435 function common_set_user($nickname) {
 436         if (is_null($nickname) && common_have_session()) {
 437                 unset($_SESSION['userid']);
 438                 return true;
 439         } else {
 440                 $user = User::staticGet('nickname', $nickname);
 441                 if ($user) {
 442                         common_ensure_session();
 443                         $_SESSION['userid'] = $user->id;
 444                         return true;
 445                 } else {
 446                         return false;
 447                 }
 448         }
 449         return false;
 450 }
 451
 452 function common_set_cookie($key, $value, $expiration=0) {
 453         $path = common_config('site', 'path');
 454         $server = common_config('site', 'server');
 455
 456         if ($path && ($path != '/')) {
 457                 $cookiepath = '/' . $path . '/';
 458         } else {
 459                 $cookiepath = '/';
 460         }
 461         return setcookie($key,
 462                          $value,
 463                                  $expiration,
 464                                          $cookiepath,
 465                                      $server);
 466 }
 467
 468 define('REMEMBERME', 'rememberme');
 469 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60);
 470
 471 function common_rememberme() {
 472         $user = common_current_user();
 473         if (!$user) {
 474                 return false;
 475         }
 476         $rm = new Remember_me();
 477         $rm->code = common_good_rand(16);
 478         $rm->user_id = $user->id;
 479         $result = $rm->insert();
 480         if (!$result) {
 481                 common_log_db_error($rm, 'INSERT', __FILE__);
 482                 return false;
 483         }
 484         common_set_cookie(REMEMBERME,
 485                                           implode(':', array($rm->user_id, $rm->code)),
 486                                           time() + REMEMBERME_EXPIRY);
 487 }
 488
 489 function common_remembered_user() {
 490         $user = NULL;
 491         # Try to remember
 492         $packed = $_COOKIE[REMEMBERME];
 493         if ($packed) {
 494                 list($id, $code) = explode(':', $packed);
 495                 if ($id && $code) {
 496                         $rm = Remember_me::staticGet($code);
 497                         if ($rm && ($rm->user_id == $id)) {
 498                                 $user = User::staticGet($rm->user_id);
 499                                 if ($user) {
 500                                         # successful!
 501                                         $result = $rm->delete();
 502                                         if (!$result) {
 503                                                 common_log_db_error($rm, 'DELETE', __FILE__);
 504                                                 $user = NULL;
 505                                         } else {
 506                                                 common_set_user($user->nickname);
 507                                                 common_real_login(false);
 508                                                 # We issue a new cookie, so they can log in
 509                                                 # automatically again after this session
 510                                                 common_rememberme();
 511                                         }
 512                                 }
 513                         }
 514                 }
 515         }
 516         return $user;
 517 }
 518
 519 # must be called with a valid user!
 520
 521 function common_forgetme() {
 522         common_set_cookie(REMEMBERME, '', 0);
 523 }
 524
 525 # who is the current user?
 526 function common_current_user() {
 527         if ($_REQUEST[session_name()]) {
 528                 common_ensure_session();
 529                 $id = $_SESSION['userid'];
 530                 if ($id) {
 531                         # note: this should cache
 532                         $user = User::staticGet($id);
 533                         return $user;
 534                 }
 535         }
 536         # that didn't work; try to remember
 537         $user = common_remembered_user();
 538         return $user;
 539 }
 540
 541 # Logins that are 'remembered' aren't 'real' -- they're subject to
 542 # cookie-stealing. So, we don't let them do certain things. New reg,
 543 # OpenID, and password logins _are_ real.
 544
 545 function common_real_login($real=true) {
 546         common_ensure_session();
 547         $_SESSION['real_login'] = $real;
 548 }
 549
 550 function common_is_real_login() {
 551         return common_logged_in() && $_SESSION['real_login'];
 552 }
 553
 554 # get canonical version of nickname for comparison
 555 function common_canonical_nickname($nickname) {
 556         # XXX: UTF-8 canonicalization (like combining chars)
 557         return strtolower($nickname);
 558 }
 559
 560 # get canonical version of email for comparison
 561 function common_canonical_email($email) {
 562         # XXX: canonicalize UTF-8
 563         # XXX: lcase the domain part
 564         return $email;
 565 }
 566
 567 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$_+!*();/?:~-]))');
 568
 569 function common_render_content($text, $notice) {
 570         $r = htmlspecialchars($text);
 571         $id = $notice->profile_id;
 572         $r = preg_replace('@https?://\S+@', '<a href="\0" class="extlink">\0</a>', $r);
 573         $r = preg_replace('/(^|\s+)@([a-z0-9]{1,64})/e', "'\\1@'.common_at_link($id, '\\2')", $r);
 574         # XXX: # tags
 575         # XXX: machine tags
 576         return $r;
 577 }
 578
 579 function common_at_link($sender_id, $nickname) {
 580         # Try to find profiles this profile is subscribed to that have this nickname
 581         $recipient = new Profile();
 582         # XXX: chokety and bad
 583         $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender_id.' and subscribed = id)', 'AND');
 584         $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
 585         if ($recipient->find(TRUE)) {
 586                 return '<a href="'.htmlspecialchars($recipient->profileurl).'" class="atlink tolistenee">'.$nickname.'</a>';
 587         }
 588         # Try to find profiles that listen to this profile and that have this nickname
 589         $recipient = new Profile();
 590         # XXX: chokety and bad
 591         $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender_id.' and subscriber = id)', 'AND');
 592         $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
 593         if ($recipient->find(TRUE)) {
 594                 return '<a href="'.htmlspecialchars($recipient->profileurl).'" class="atlink tolistener">'.$nickname.'</a>';
 595         }
 596         # If this is a local user, try to find a local user with that nickname.
 597         $sender = User::staticGet($sender_id);
 598         if ($sender) {
 599                 $recipient_user = User::staticGet('nickname', $nickname);
 600                 if ($recipient_user) {
 601                         return '<a href="'.htmlspecialchars(common_profile_url($nickname)).'" class="atlink usertouser">'.$nickname.'</a>';
 602                 }
 603         }
 604         # Otherwise, no links. @messages from local users to remote users,
 605         # or from remote users to other remote users, are just
 606         # outside our ability to make intelligent guesses about
 607         return $nickname;
 608 }
 609
 610 // where should the avatar go for this user?
 611
 612 function common_avatar_filename($id, $extension, $size=NULL, $extra=NULL) {
 613         global $config;
 614
 615         if ($size) {
 616                 return $id . '-' . $size . (($extra) ? ('-' . $extra) : '') . $extension;
 617         } else {
 618                 return $id . '-original' . (($extra) ? ('-' . $extra) : '') . $extension;
 619         }
 620 }
 621
 622 function common_avatar_path($filename) {
 623         global $config;
 624         return INSTALLDIR . '/avatar/' . $filename;
 625 }
 626
 627 function common_avatar_url($filename) {
 628         return common_path('avatar/'.$filename);
 629 }
 630
 631 function common_avatar_display_url($avatar) {
 632         $server = common_config('avatar', 'server');
 633         if ($server) {
 634                 return 'http://'.$server.'/'.$avatar->filename;
 635         } else {
 636                 return $avatar->url;
 637         }
 638 }
 639
 640 function common_default_avatar($size) {
 641         static $sizenames = array(AVATAR_PROFILE_SIZE => 'profile',
 642                                                           AVATAR_STREAM_SIZE => 'stream',
 643                                                           AVATAR_MINI_SIZE => 'mini');
 644         return theme_path('default-avatar-'.$sizenames[$size].'.png');
 645 }
 646
 647 function common_local_url($action, $args=NULL) {
 648         global $config;
 649         if ($config['site']['fancy']) {
 650                 return common_fancy_url($action, $args);
 651         } else {
 652                 return common_simple_url($action, $args);
 653         }
 654 }
 655
 656 function common_fancy_url($action, $args=NULL) {
 657         switch (strtolower($action)) {
 658          case 'public':
 659                 if ($args && $args['page']) {
 660                         return common_path('?page=' . $args['page']);
 661                 } else {
 662                         return common_path('');
 663                 }
 664          case 'publicrss':
 665                 return common_path('rss');
 666          case 'publicxrds':
 667                 return common_path('xrds');
 668          case 'doc':
 669                 return common_path('doc/'.$args['title']);
 670          case 'login':
 671          case 'logout':
 672          case 'register':
 673          case 'subscribe':
 674          case 'unsubscribe':
 675                 return common_path('main/'.$action);
 676          case 'remotesubscribe':
 677                 if ($args && $args['nickname']) {
 678                         return common_path('main/remote?nickname=' . $args['nickname']);
 679                 } else {
 680                         return common_path('main/remote');
 681                 }
 682          case 'openidlogin':
 683                 return common_path('main/openid');
 684          case 'avatar':
 685          case 'password':
 686                 return common_path('settings/'.$action);
 687          case 'profilesettings':
 688                 return common_path('settings/profile');
 689          case 'openidsettings':
 690                 return common_path('settings/openid');
 691          case 'newnotice':
 692                 return common_path('notice/new');
 693          case 'shownotice':
 694                 return common_path('notice/'.$args['notice']);
 695          case 'xrds':
 696          case 'foaf':
 697                 return common_path($args['nickname'].'/'.$action);
 698          case 'subscriptions':
 699          case 'subscribers':
 700          case 'all':
 701                 if ($args && $args['page']) {
 702                         return common_path($args['nickname'].'/'.$action.'?page=' . $args['page']);
 703                 } else {
 704                         return common_path($args['nickname'].'/'.$action);
 705                 }
 706          case 'allrss':
 707                 return common_path($args['nickname'].'/all/rss');
 708          case 'userrss':
 709                 return common_path($args['nickname'].'/rss');
 710          case 'showstream':
 711                 if ($args && $args['page']) {
 712                         return common_path($args['nickname'].'?page=' . $args['page']);
 713                 } else {
 714                         return common_path($args['nickname']);
 715                 }
 716          case 'confirmaddress':
 717                 return common_path('main/confirmaddress/'.$args['code']);
 718          case 'userbyid':
 719                 return common_path('user/'.$args['id']);
 720          case 'recoverpassword':
 721             $path = 'main/recoverpassword';
 722             if ($args['code']) {
 723                 $path .= '/' . $args['code'];
 724                 }
 725             return common_path($path);
 726          case 'imsettings':
 727                 return common_path('settings/im');
 728          default:
 729                 return common_simple_url($action, $args);
 730         }
 731 }
 732
 733 function common_simple_url($action, $args=NULL) {
 734         global $config;
 735         /* XXX: pretty URLs */
 736         $extra = '';
 737         if ($args) {
 738                 foreach ($args as $key => $value) {
 739                         $extra .= "&${key}=${value}";
 740                 }
 741         }
 742         return common_path("index.php?action=${action}${extra}");
 743 }
 744
 745 function common_path($relative) {
 746         global $config;
 747         $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
 748         return "http://".$config['site']['server'].'/'.$pathpart.$relative;
 749 }
 750
 751 function common_date_string($dt) {
 752         // XXX: do some sexy date formatting
 753         // return date(DATE_RFC822, $dt);
 754         $t = strtotime($dt);
 755         $now = time();
 756         $diff = $now - $t;
 757
 758         if ($now < $t) { # that shouldn't happen!
 759                 return common_exact_date($dt);
 760         } else if ($diff < 60) {
 761                 return _t('a few seconds ago');
 762         } else if ($diff < 92) {
 763                 return _t('about a minute ago');
 764         } else if ($diff < 3300) {
 765                 return _t('about ') . round($diff/60) . _t(' minutes ago');
 766         } else if ($diff < 5400) {
 767                 return _t('about an hour ago');
 768         } else if ($diff < 22 * 3600) {
 769                 return _t('about ') . round($diff/3600) . _t(' hours ago');
 770         } else if ($diff < 37 * 3600) {
 771                 return _t('about a day ago');
 772         } else if ($diff < 24 * 24 * 3600) {
 773                 return _t('about ') . round($diff/(24*3600)) . _t(' days ago');
 774         } else if ($diff < 46 * 24 * 3600) {
 775                 return _t('about a month ago');
 776         } else if ($diff < 330 * 24 * 3600) {
 777                 return _t('about ') . round($diff/(30*24*3600)) . _t(' months ago');
 778         } else if ($diff < 480 * 24 * 3600) {
 779                 return _t('about a year ago');
 780         } else {
 781                 return common_exact_date($dt);
 782         }
 783 }
 784
 785 function common_exact_date($dt) {
 786         $t = strtotime($dt);
 787         return date(DATE_RFC850, $t);
 788 }
 789
 790 function common_date_w3dtf($dt) {
 791         $t = strtotime($dt);
 792         return date(DATE_W3C, $t);
 793 }
 794
 795 function common_redirect($url, $code=307) {
 796         static $status = array(301 => "Moved Permanently",
 797                                                    302 => "Found",
 798                                                    303 => "See Other",
 799                                                    307 => "Temporary Redirect");
 800         header("Status: ${code} $status[$code]");
 801         header("Location: $url");
 802
 803         common_start_xml('a',
 804                                          '-//W3C//DTD XHTML 1.0 Strict//EN',
 805                                          'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
 806         common_element('a', array('href' => $url), $url);
 807         common_end_xml();
 808 }
 809
 810 function common_broadcast_notice($notice, $remote=false) {
 811         if (common_config('queue', 'enabled')) {
 812                 # Do it later!
 813                 return common_enqueue_notice($notice);
 814         } else {
 815                 return common_real_broadcast($notice, $remote);
 816         }
 817 }
 818
 819 # Stick the notice on the queue
 820
 821 function common_enqueue_notice($notice) {
 822         common_log(LOG_INFO, 'start queueing notice ID = ' . $notice->id);
 823         $qi = new Queue_item();
 824         $qi->notice_id = $notice->id;
 825         $qi->created = DB_DataObject_Cast::dateTime();
 826         $result = $qi->insert();
 827         if ($result === FALSE) {
 828             $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
 829             common_log(LOG_ERROR, 'DB error inserting queue item: ' . $last_error->message);
 830             return false;
 831         }
 832         common_log(LOG_INFO, 'complete queueing notice ID = ' . $notice->id);
 833         return $result;
 834 }
 835
 836 function common_real_broadcast($notice, $remote=false) {
 837         $success = true;
 838         if (!$remote) {
 839                 # Make sure we have the OMB stuff
 840                 require_once(INSTALLDIR.'/lib/omb.php');
 841                 $success = omb_broadcast_remote_subscribers($notice);
 842                 if (!$success) {
 843                         common_log(LOG_ERROR, 'Error in OMB broadcast for notice ' . $notice->id);
 844                 }
 845         }
 846         if ($success) {
 847                 require_once(INSTALLDIR.'/lib/jabber.php');
 848                 $success = jabber_broadcast_notice($notice);
 849                 if (!$success) {
 850                         common_log(LOG_ERROR, 'Error in jabber broadcast for notice ' . $notice->id);
 851                 }
 852         }
 853         // XXX: broadcast notices to SMS
 854         // XXX: broadcast notices to other IM
 855         return $success;
 856 }
 857
 858 function common_broadcast_profile($profile) {
 859         // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
 860         require_once(INSTALLDIR.'/lib/omb.php');
 861         omb_broadcast_profile($profile);
 862         // XXX: Other broadcasts...?
 863         return true;
 864 }
 865
 866 function common_profile_url($nickname) {
 867         return common_local_url('showstream', array('nickname' => $nickname));
 868 }
 869
 870 # Don't call if nobody's logged in
 871
 872 function common_notice_form($action=NULL, $content=NULL) {
 873         $user = common_current_user();
 874         assert(!is_null($user));
 875         common_element_start('form', array('id' => 'status_form',
 876                                                                            'method' => 'post',
 877                                                                            'action' => common_local_url('newnotice')));
 878         common_element_start('p');
 879         common_element('label', array('for' => 'status_textarea',
 880                                                                   'id' => 'status_label'),
 881                                    _t('What\'s up, ').$user->nickname.'?');
 882         common_element('span', array('id' => 'counter', 'class' => 'counter'), '140');
 883         common_element('textarea', array('id' => 'status_textarea',
 884                                                                          'cols' => 60,
 885                                                                          'rows' => 3,
 886                                                                          'name' => 'status_textarea'),
 887                                    ($content) ? $content : '');
 888         if ($action) {
 889                 common_hidden('returnto', $action);
 890         }
 891         common_element('input', array('id' => 'status_submit',
 892                                                                   'name' => 'status_submit',
 893                                                                   'type' => 'submit',
 894                                                                   'value' => _t('Send')));
 895         common_element_end('p');
 896         common_element_end('form');
 897 }
 898
 899 function common_mint_tag($extra) {
 900         global $config;
 901         return
 902           'tag:'.$config['tag']['authority'].','.
 903           $config['tag']['date'].':'.$config['tag']['prefix'].$extra;
 904 }
 905
 906 # Should make up a reasonable root URL
 907
 908 function common_root_url() {
 909         return common_path('');
 910 }
 911
 912 # returns $bytes bytes of random data as a hexadecimal string
 913 # "good" here is a goal and not a guarantee
 914
 915 function common_good_rand($bytes) {
 916         # XXX: use random.org...?
 917         if (file_exists('/dev/urandom')) {
 918                 return common_urandom($bytes);
 919         } else { # FIXME: this is probably not good enough
 920                 return common_mtrand($bytes);
 921         }
 922 }
 923
 924 function common_urandom($bytes) {
 925         $h = fopen('/dev/urandom', 'rb');
 926         # should not block
 927         $src = fread($h, $bytes);
 928         fclose($h);
 929         $enc = '';
 930         for ($i = 0; $i < $bytes; $i++) {
 931                 $enc .= sprintf("%02x", (ord($src[$i])));
 932         }
 933         return $enc;
 934 }
 935
 936 function common_mtrand($bytes) {
 937         $enc = '';
 938         for ($i = 0; $i < $bytes; $i++) {
 939                 $enc .= sprintf("%02x", mt_rand(0, 255));
 940         }
 941         return $enc;
 942 }
 943
 944 function common_set_returnto($url) {
 945         common_ensure_session();
 946         $_SESSION['returnto'] = $url;
 947 }
 948
 949 function common_get_returnto() {
 950         common_ensure_session();
 951         return $_SESSION['returnto'];
 952 }
 953
 954 function common_timestamp() {
 955         return date('YmdHis');
 956 }
 957
 958 // XXX: set up gettext
 959
 960 function _t($str) {
 961         return $str;
 962 }
 963
 964 function common_ensure_syslog() {
 965         static $initialized = false;
 966         if (!$initialized) {
 967                 global $config;
 968                 define_syslog_variables();
 969                 openlog($config['syslog']['appname'], 0, LOG_USER);
 970                 $initialized = true;
 971         }
 972 }
 973
 974 function common_log($priority, $msg, $filename=NULL) {
 975         common_ensure_syslog();
 976         syslog($priority, $msg);
 977 }
 978
 979 function common_debug($msg, $filename=NULL) {
 980         if ($filename) {
 981                 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
 982         } else {
 983                 common_log(LOG_DEBUG, $msg);
 984         }
 985 }
 986
 987 function common_log_db_error(&$object, $verb, $filename=NULL) {
 988         $objstr = common_log_objstring($object);
 989         $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
 990         common_log(LOG_ERROR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
 991 }
 992
 993 function common_log_objstring(&$object) {
 994         if (is_null($object)) {
 995                 return "NULL";
 996         }
 997         $arr = $object->toArray();
 998         $fields = array();
 999         foreach ($arr as $k => $v) {
1000                 $fields[] = "$k='$v'";
1001         }
1002         $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1003         return $objstring;
1004 }
1005
1006 function common_valid_http_url($url) {
1007         return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1008 }
1009
1010 function common_valid_tag($tag) {
1011         if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1012                 return (Validate::email($matches[1]) ||
1013                                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1014         }
1015         return false;
1016 }
1017
1018 # Does a little before-after block for next/prev page
1019
1020 function common_pagination($have_before, $have_after, $page, $action, $args=NULL) {
1021
1022         if ($have_before || $have_after) {
1023                 common_element_start('div', array('id' => 'pagination'));
1024                 common_element_start('ul', array('id' => 'nav_pagination'));
1025         }
1026
1027         if ($have_before) {
1028                 $pargs = array('page' => $page-1);
1029                 $newargs = ($args) ? array_merge($args,$pargs) : $pargs;
1030
1031                 common_element_start('li', 'before');
1032                 common_element('a', array('href' => common_local_url($action, $newargs)),
1033                                            _t('« After'));
1034                 common_element_end('li');
1035         }
1036
1037         if ($have_after) {
1038                 $pargs = array('page' => $page+1);
1039                 $newargs = ($args) ? array_merge($args,$pargs) : $pargs;
1040                 common_element_start('li', 'after');
1041                 common_element('a', array('href' => common_local_url($action, $newargs)),
1042                                                    _t('Before »'));
1043                 common_element_end('li');
1044         }
1045
1046         if ($have_before || $have_after) {
1047                 common_element_end('ul');
1048                 common_element_end('div');
1049         }
1050 }
1051
1052 /* Following functions are copied from MediaWiki GlobalFunctions.php
1053  * and written by Evan Prodromou. */
1054
1055 function common_accept_to_prefs($accept, $def = '*/*') {
1056         # No arg means accept anything (per HTTP spec)
1057         if(!$accept) {
1058                 return array($def => 1);
1059         }
1060
1061         $prefs = array();
1062
1063         $parts = explode(',', $accept);
1064
1065         foreach($parts as $part) {
1066                 # FIXME: doesn't deal with params like 'text/html; level=1'
1067                 @list($value, $qpart) = explode(';', $part);
1068                 $match = array();
1069                 if(!isset($qpart)) {
1070                         $prefs[$value] = 1;
1071                 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1072                         $prefs[$value] = $match[1];
1073                 }
1074         }
1075
1076         return $prefs;
1077 }
1078
1079 function common_mime_type_match($type, $avail) {
1080         if(array_key_exists($type, $avail)) {
1081                 return $type;
1082         } else {
1083                 $parts = explode('/', $type);
1084                 if(array_key_exists($parts[0] . '/*', $avail)) {
1085                         return $parts[0] . '/*';
1086                 } elseif(array_key_exists('*/*', $avail)) {
1087                         return '*/*';
1088                 } else {
1089                         return NULL;
1090                 }
1091         }
1092 }
1093
1094 function common_negotiate_type($cprefs, $sprefs) {
1095         $combine = array();
1096
1097         foreach(array_keys($sprefs) as $type) {
1098                 $parts = explode('/', $type);
1099                 if($parts[1] != '*') {
1100                         $ckey = common_mime_type_match($type, $cprefs);
1101                         if($ckey) {
1102                                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1103                         }
1104                 }
1105         }
1106
1107         foreach(array_keys($cprefs) as $type) {
1108                 $parts = explode('/', $type);
1109                 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1110                         $skey = common_mime_type_match($type, $sprefs);
1111                         if($skey) {
1112                                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1113                         }
1114                 }
1115         }
1116
1117         $bestq = 0;
1118         $besttype = "text/html";
1119
1120         foreach(array_keys($combine) as $type) {
1121                 if($combine[$type] > $bestq) {
1122                         $besttype = $type;
1123                         $bestq = $combine[$type];
1124                 }
1125         }
1126
1127         return $besttype;
1128 }
1129
1130 function common_config($main, $sub) {
1131         global $config;
1132         return $config[$main][$sub];
1133 }
1134
1135 function common_copy_args($from) {
1136         $to = array();
1137         $strip = get_magic_quotes_gpc();
1138         foreach ($from as $k => $v) {
1139                 $to[$k] = ($strip) ? stripslashes($v) : $v;
1140         }
1141         return $to;
1142 }
1143
1144 function common_user_uri(&$user) {
1145         return common_local_url('userbyid', array('id' => $user->id));
1146 }
1147
1148 function common_notice_uri(&$notice) {
1149         return common_local_url('shownotice',
1150                 array('notice' => $notice->id));
1151 }
1152
1153 # 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1154
1155 function common_confirmation_code($bits) {
1156         # 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1157         static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1158         $chars = ceil($bits/5);
1159         $code = '';
1160         for ($i = 0; $i < $chars; $i++) {
1161                 # XXX: convert to string and back
1162                 $num = hexdec(common_good_rand(1));
1163                 # XXX: randomness is too precious to throw away almost
1164                 # 40% of the bits we get!
1165                 $code .= $codechars[$num%32];
1166         }
1167         return $code;
1168 }
1169
1170 # convert markup to HTML
1171
1172 function common_markup_to_html($c) {
1173         $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1174         $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1175         $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1176         return Markdown($c);
1177 }