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