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 ($config['site']['logo'] || file_exists(theme_file('logo.png'))) {
 187                 common_element_start('a', array('href' => common_local_url('public')));
 188                 common_element('img', array('src' => ($config['site']['logo']) ?
 189                                                                         ($config['site']['logo']) : theme_path('logo.png'),
 190                                                                         'alt' => $config['site']['name'],
 191                                                                         'id' => 'logo'));
 192                 common_element_end('a');
 193         }
 194         common_element('h1', 'pagetitle', $pagetitle);
 195         common_element('h2', 'sitename', $config['site']['name']);
 196
 197         if ($headercall) {
 198                 if ($data) {
 199                         call_user_func($headercall, $data);
 200                 } else {
 201                         call_user_func($headercall);
 202                 }
 203         }
 204         common_element_end('div');
 205         common_element_start('div', array('id' => 'content'));
 206 }
 207
 208 function common_show_footer() {
 209         global $xw, $config;
 210         common_element_end('div'); # content div
 211         common_foot_menu();
 212         common_element_start('div', array('id' => 'footer'));
 213         common_element_start('p', 'laconica');
 214         common_text(_t('This site is running the '));
 215         common_element('a', array('class' => 'software',
 216                                                           href => 'http://laconi.ca/'),
 217                                    'Laconica');
 218         common_text(_t('microblogging tool, version ' . LACONICA_VERSION . ', available under the '));
 219         common_element('a', array(href => 'http://www.fsf.org/licensing/licenses/agpl-3.0.html'),
 220                                    'GNU Affero General Public License');
 221         common_text(_t('.'));
 222         common_element_end('p');
 223         common_element('img', array('id' => 'cc',
 224                                                                 'src' => $config['license']['image'],
 225                                                                 'alt' => $config['license']['title']));
 226         common_element_start('p');
 227         common_text(_t('Unless otherwise specified, contents of this site are copyright by the contributors and available under the '));
 228         common_element('a', array('class' => 'license',
 229                                                           'rel' => 'license',
 230                                                           href => $config['license']['url']),
 231                                    $config['license']['title']);
 232         common_text(_t('. Contributors should be attributed by full name or nickname.'));
 233         common_element_end('p');
 234         common_element_end('div');
 235         common_element_end('div');
 236         common_element_end('body');
 237         common_element_end('html');
 238         common_end_xml();
 239 }
 240
 241 function common_text($txt) {
 242         global $xw;
 243         $xw->text($txt);
 244 }
 245
 246 function common_raw($xml) {
 247         global $xw;
 248         $xw->writeRaw($xml);
 249 }
 250
 251 function common_nav_menu() {
 252         $user = common_current_user();
 253         common_element_start('ul', array('id' => 'nav'));
 254         if ($user) {
 255                 common_menu_item(common_local_url('all', array('nickname' => $user->nickname)),
 256                                                  _t('Home'));
 257         }
 258         common_menu_item(common_local_url('public'), _t('Public'));
 259         common_menu_item(common_local_url('doc', array('title' => 'help')),
 260                                          _t('Help'));
 261         if ($user) {
 262                 common_menu_item(common_local_url('profilesettings'),
 263                                                  _t('Settings'));
 264                 common_menu_item(common_local_url('logout'),
 265                                                  _t('Logout'));
 266         } else {
 267                 common_menu_item(common_local_url('login'), _t('Login'));
 268                 common_menu_item(common_local_url('register'), _t('Register'));
 269                 common_menu_item(common_local_url('openidlogin'), _t('OpenID'));
 270         }
 271         common_element_end('ul');
 272 }
 273
 274 function common_foot_menu() {
 275         common_element_start('ul', array('id' => 'nav_sub'));
 276         common_menu_item(common_local_url('doc', array('title' => 'about')),
 277                                          _t('About'));
 278         common_menu_item(common_local_url('doc', array('title' => 'privacy')),
 279                                          _t('Privacy'));
 280         common_menu_item(common_local_url('doc', array('title' => 'source')),
 281                                          _t('Source'));
 282         common_element_end('ul');
 283 }
 284
 285 function common_menu_item($url, $text, $title=NULL, $is_selected=false) {
 286         $lattrs = array();
 287         if ($is_selected) {
 288                 $lattrs['class'] = 'current';
 289         }
 290         common_element_start('li', $lattrs);
 291         $attrs['href'] = $url;
 292         if ($title) {
 293                 $attrs['title'] = $title;
 294         }
 295         common_element('a', $attrs, $text);
 296         common_element_end('li');
 297 }
 298
 299 function common_input($id, $label, $value=NULL,$instructions=NULL) {
 300         common_element_start('p');
 301         common_element('label', array('for' => $id), $label);
 302         $attrs = array('name' => $id,
 303                                    'type' => 'text',
 304                                    'id' => $id);
 305         if ($value) {
 306                 $attrs['value'] = htmlspecialchars($value);
 307         }
 308         common_element('input', $attrs);
 309         if ($instructions) {
 310                 common_element('span', 'input_instructions', $instructions);
 311         }
 312         common_element_end('p');
 313 }
 314
 315 function common_hidden($id, $value) {
 316         common_element('input', array('name' => $id,
 317                                                                   'type' => 'hidden',
 318                                                                   'id' => $id,
 319                                                                   'value' => $value));
 320 }
 321
 322 function common_password($id, $label, $instructions=NULL) {
 323         common_element_start('p');
 324         common_element('label', array('for' => $id), $label);
 325         $attrs = array('name' => $id,
 326                                    'type' => 'password',
 327                                    'id' => $id);
 328         common_element('input', $attrs);
 329         if ($instructions) {
 330                 common_element('span', 'input_instructions', $instructions);
 331         }
 332         common_element_end('p');
 333 }
 334
 335 function common_submit($id, $label) {
 336         global $xw;
 337         common_element_start('p');
 338         common_element('input', array('type' => 'submit',
 339                                                                   'id' => $id,
 340                                                                   'name' => $id,
 341                                                                   'value' => $label));
 342         common_element_end('p');
 343 }
 344
 345 function common_textarea($id, $label, $content=NULL, $instructions=NULL) {
 346         common_element_start('p');
 347         common_element('label', array('for' => $id), $label);
 348         common_element('textarea', array('rows' => 3,
 349                                                                          'cols' => 40,
 350                                                                          'name' => $id,
 351                                                                          'id' => $id),
 352                                    ($content) ? $content : ' ');
 353         if ($instructions) {
 354                 common_element('span', 'input_instructions', $instructions);
 355         }
 356         common_element_end('p');
 357 }
 358
 359 # salted, hashed passwords are stored in the DB
 360
 361 function common_munge_password($id, $password) {
 362         return md5($id . $password);
 363 }
 364
 365 # check if a username exists and has matching password
 366 function common_check_user($nickname, $password) {
 367         $user = User::staticGet('nickname', $nickname);
 368         if (is_null($user)) {
 369                 return false;
 370         } else {
 371                 return (0 == strcmp(common_munge_password($password, $user->id),
 372                                                         $user->password));
 373         }
 374 }
 375
 376 # is the current user logged in?
 377 function common_logged_in() {
 378         return (!is_null(common_current_user()));
 379 }
 380
 381 function common_have_session() {
 382         return (0 != strcmp(session_id(), ''));
 383 }
 384
 385 function common_ensure_session() {
 386         if (!common_have_session()) {
 387                 @session_start();
 388         }
 389 }
 390
 391 function common_set_user($nickname) {
 392         if (is_null($nickname) && common_have_session()) {
 393                 unset($_SESSION['userid']);
 394                 return true;
 395         } else {
 396                 $user = User::staticGet('nickname', $nickname);
 397                 if ($user) {
 398                         common_ensure_session();
 399                         $_SESSION['userid'] = $user->id;
 400                         return true;
 401                 } else {
 402                         return false;
 403                 }
 404         }
 405         return false;
 406 }
 407
 408 # who is the current user?
 409 function common_current_user() {
 410         static $user = NULL; # FIXME: global memcached
 411         if (is_null($user)) {
 412                 common_ensure_session();
 413                 $id = $_SESSION['userid'];
 414                 if ($id) {
 415                         $user = User::staticGet($id);
 416                 }
 417         }
 418         return $user;
 419 }
 420
 421 # get canonical version of nickname for comparison
 422 function common_canonical_nickname($nickname) {
 423         # XXX: UTF-8 canonicalization (like combining chars)
 424         return strtolower($nickname);
 425 }
 426
 427 # get canonical version of email for comparison
 428 function common_canonical_email($email) {
 429         # XXX: canonicalize UTF-8
 430         # XXX: lcase the domain part
 431         return $email;
 432 }
 433
 434 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$_+!*();/?:~-]))');
 435
 436 function common_render_content($text, $notice) {
 437         $r = htmlspecialchars($text);
 438         $id = $notice->profile_id;
 439         $r = preg_replace('@https?://\S+@', '<a href="\0" class="extlink">\0</a>', $r);
 440         $r = preg_replace('/(^|\b)@([\w-]+)($|\b)/e', "'\\1@'.common_at_link($id, '\\2').'\\3'", $r);
 441         # XXX: # tags
 442         # XXX: machine tags
 443         return $r;
 444 }
 445
 446 function common_at_link($sender_id, $nickname) {
 447         # Try to find profiles this profile is subscribed to that have this nickname
 448         $recipient = new Profile();
 449         # XXX: chokety and bad
 450         $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender_id.' and subscribed = id)', 'AND');
 451         $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
 452         if ($recipient->find(TRUE)) {
 453                 return '<a href="'.htmlspecialchars($recipient->profileurl).'" class="atlink tolistenee">'.$nickname.'</a>';
 454         }
 455         # Try to find profiles that listen to this profile and that have this nickname
 456         $recipient = new Profile();
 457         # XXX: chokety and bad
 458         $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender_id.' and subscriber = id)', 'AND');
 459         $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
 460         if ($recipient->find(TRUE)) {
 461                 return '<a href="'.htmlspecialchars($recipient->profileurl).'" class="atlink tolistener">'.$nickname.'</a>';
 462         }
 463         # If this is a local user, try to find a local user with that nickname.
 464         $sender = User::staticGet($sender_id);
 465         if ($sender) {
 466                 $recipient_user = User::staticGet('nickname', $nickname);
 467                 if ($recipient_user) {
 468                         $recipient = $recipient->getProfile();
 469                         return '<a href="'.htmlspecialchars($recipient->profileurl).'" class="atlink usertouser">'.$nickname.'</a>';
 470                 }
 471         }
 472         # Otherwise, no links. @messages from local users to remote users,
 473         # or from remote users to other remote users, are just
 474         # outside our ability to make intelligent guesses about
 475         return $nickname;
 476 }
 477
 478 // where should the avatar go for this user?
 479
 480 function common_avatar_filename($id, $extension, $size=NULL, $extra=NULL) {
 481         global $config;
 482
 483         if ($size) {
 484                 return $id . '-' . $size . (($extra) ? ('-' . $extra) : '') . $extension;
 485         } else {
 486                 return $id . '-original' . (($extra) ? ('-' . $extra) : '') . $extension;
 487         }
 488 }
 489
 490 function common_avatar_path($filename) {
 491         global $config;
 492         return INSTALLDIR . '/avatar/' . $filename;
 493 }
 494
 495 function common_avatar_url($filename) {
 496         return common_path('avatar/'.$filename);
 497 }
 498
 499 function common_default_avatar($size) {
 500         static $sizenames = array(AVATAR_PROFILE_SIZE => 'profile',
 501                                                           AVATAR_STREAM_SIZE => 'stream',
 502                                                           AVATAR_MINI_SIZE => 'mini');
 503         return theme_path('default-avatar-'.$sizenames[$size].'.png');
 504 }
 505
 506 function common_local_url($action, $args=NULL) {
 507         global $config;
 508         if ($config['site']['fancy']) {
 509                 return common_fancy_url($action, $args);
 510         } else {
 511                 return common_simple_url($action, $args);
 512         }
 513 }
 514
 515 function common_fancy_url($action, $args=NULL) {
 516         switch (strtolower($action)) {
 517          case 'public':
 518                 if ($args && $args['page']) {
 519                         return common_path('?page=' . $args['page']);
 520                 } else {
 521                         return common_path('');
 522                 }
 523          case 'publicrss':
 524                 return common_path('rss');
 525          case 'doc':
 526                 return common_path('doc/'.$args['title']);
 527          case 'login':
 528          case 'logout':
 529          case 'register':
 530          case 'subscribe':
 531          case 'unsubscribe':
 532                 return common_path('main/'.$action);
 533          case 'openidlogin':
 534                 return common_path('main/openid');
 535          case 'avatar':
 536          case 'password':
 537                 return common_path('settings/'.$action);
 538          case 'profilesettings':
 539                 return common_path('settings/profile');
 540          case 'openidsettings':
 541                 return common_path('settings/openid');
 542          case 'newnotice':
 543                 return common_path('notice/new');
 544          case 'shownotice':
 545                 return common_path('notice/'.$args['notice']);
 546          case 'xrds':
 547          case 'foaf':
 548                 return common_path($args['nickname'].'/'.$action);
 549          case 'subscriptions':
 550          case 'subscribed':
 551          case 'all':
 552                 if ($args && $args['page']) {
 553                         return common_path($args['nickname'].'/'.$action.'?page=' . $args['page']);
 554                 } else {
 555                         return common_path($args['nickname'].'/'.$action);
 556                 }
 557          case 'allrss':
 558                 return common_path($args['nickname'].'/all/rss');
 559          case 'userrss':
 560                 return common_path($args['nickname'].'/rss');
 561          case 'showstream':
 562                 if ($args && $args['page']) {
 563                         return common_path($args['nickname'].'?page=' . $args['page']);
 564                 } else {
 565                         return common_path($args['nickname']);
 566                 }
 567          default:
 568                 return common_simple_url($action, $args);
 569         }
 570 }
 571
 572 function common_simple_url($action, $args=NULL) {
 573         global $config;
 574         /* XXX: pretty URLs */
 575         $extra = '';
 576         if ($args) {
 577                 foreach ($args as $key => $value) {
 578                         $extra .= "&${key}=${value}";
 579                 }
 580         }
 581         return common_path("index.php?action=${action}${extra}");
 582 }
 583
 584 function common_path($relative) {
 585         global $config;
 586         $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
 587         return "http://".$config['site']['server'].'/'.$pathpart.$relative;
 588 }
 589
 590 function common_date_string($dt) {
 591         // XXX: do some sexy date formatting
 592         // return date(DATE_RFC822, $dt);
 593         return $dt;
 594 }
 595
 596 function common_date_w3dtf($dt) {
 597         $t = strtotime($dt);
 598         return date(DATE_W3C, $t);
 599 }
 600
 601 function common_redirect($url, $code=307) {
 602         static $status = array(301 => "Moved Permanently",
 603                                                    302 => "Found",
 604                                                    303 => "See Other",
 605                                                    307 => "Temporary Redirect");
 606         header("Status: ${code} $status[$code]");
 607         header("Location: $url");
 608         common_element('a', array('href' => $url), $url);
 609 }
 610
 611 function common_broadcast_notice($notice, $remote=false) {
 612         // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
 613         if (!$remote) {
 614                 # Make sure we have the OMB stuff
 615                 require_once(INSTALLDIR.'/lib/omb.php');
 616                 omb_broadcast_remote_subscribers($notice);
 617         }
 618         // XXX: broadcast notices to Jabber
 619         // XXX: broadcast notices to SMS
 620         // XXX: broadcast notices to other IM
 621         return true;
 622 }
 623
 624 function common_broadcast_profile($profile) {
 625         // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
 626         require_once(INSTALLDIR.'/lib/omb.php');
 627         omb_broadcast_profile($profile);
 628         // XXX: Other broadcasts...?
 629         return true;
 630 }
 631
 632 function common_profile_url($nickname) {
 633         return common_local_url('showstream', array('nickname' => $nickname));
 634 }
 635
 636 # Don't call if nobody's logged in
 637
 638 function common_notice_form() {
 639         $user = common_current_user();
 640         assert(!is_null($user));
 641         common_element_start('form', array('id' => 'status_form',
 642                                                                            'method' => 'POST',
 643                                                                            'action' => common_local_url('newnotice')));
 644         common_element_start('p');
 645         common_element('label', array('for' => 'status_update',
 646                                                                   'id' => 'status_label'),
 647                                    _t('What\'s up, ').$user->nickname.'?');
 648         common_element('textarea', array('id' => 'status_textarea',
 649                                                                          'name' => 'status_textarea'));
 650         common_element('input', array('id' => 'status_submit',
 651                                                                   'name' => 'status_submit',
 652                                                                   'type' => 'submit',
 653                                                                   'value' => _t('Send')));
 654         common_element_end('p');
 655         common_element_end('form');
 656 }
 657
 658 function common_mint_tag($extra) {
 659         global $config;
 660         return
 661           'tag:'.$config['tag']['authority'].','.
 662           $config['tag']['date'].':'.$config['tag']['prefix'].$extra;
 663 }
 664
 665 # Should make up a reasonable root URL
 666
 667 function common_root_url() {
 668         return common_path('');
 669 }
 670
 671 # returns $bytes bytes of random data as a hexadecimal string
 672 # "good" here is a goal and not a guarantee
 673
 674 function common_good_rand($bytes) {
 675         # XXX: use random.org...?
 676         if (file_exists('/dev/urandom')) {
 677                 return common_urandom($bytes);
 678         } else { # FIXME: this is probably not good enough
 679                 return common_mtrand($bytes);
 680         }
 681 }
 682
 683 function common_urandom($bytes) {
 684         $h = fopen('/dev/urandom', 'rb');
 685         # should not block
 686         $src = fread($h, $bytes);
 687         fclose($h);
 688         $enc = '';
 689         for ($i = 0; $i < $bytes; $i++) {
 690                 $enc .= sprintf("%02x", (ord($src[$i])));
 691         }
 692         return $enc;
 693 }
 694
 695 function common_mtrand($bytes) {
 696         $enc = '';
 697         for ($i = 0; $i < $bytes; $i++) {
 698                 $enc .= sprintf("%02x", mt_rand(0, 255));
 699         }
 700         return $enc;
 701 }
 702
 703 function common_set_returnto($url) {
 704         common_ensure_session();
 705         $_SESSION['returnto'] = $url;
 706 }
 707
 708 function common_get_returnto() {
 709         common_ensure_session();
 710         return $_SESSION['returnto'];
 711 }
 712
 713 function common_timestamp() {
 714         return date('YmdHis');
 715 }
 716
 717 // XXX: set up gettext
 718
 719 function _t($str) {
 720         return $str;
 721 }
 722
 723 function common_ensure_syslog() {
 724         static $initialized = false;
 725         if (!$initialized) {
 726                 global $config;
 727                 define_syslog_variables();
 728                 openlog($config['syslog']['appname'], 0, LOG_USER);
 729                 $initialized = true;
 730         }
 731 }
 732
 733 function common_log($priority, $msg, $filename=NULL) {
 734         common_ensure_syslog();
 735         syslog($priority, $msg);
 736 }
 737
 738 function common_debug($msg, $filename=NULL) {
 739         if ($filename) {
 740                 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
 741         } else {
 742                 common_log(LOG_DEBUG, $msg);
 743         }
 744 }
 745
 746 function common_valid_http_url($url) {
 747         return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
 748 }
 749
 750 function common_valid_tag($tag) {
 751         if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
 752                 return (Validate::email($matches[1]) ||
 753                                 preg_match('/^([\w-\.]+)$/', $matches[1]));
 754         }
 755         return false;
 756 }
 757
 758 # Does a little before-after block for next/prev page
 759
 760 function common_pagination($have_before, $have_after, $page, $action, $args=NULL) {
 761
 762         if ($have_before || $have_after) {
 763                 common_element_start('div', array('id' => 'pagination'));
 764                 common_element_start('ul', array('id' => 'nav_pagination'));
 765         }
 766
 767         if ($have_before) {
 768                 $pargs = array('page' => $page-1);
 769                 $newargs = ($args) ? array_merge($args,$pargs) : $pargs;
 770
 771                 common_element_start('li', 'before');
 772                 common_element('a', array('href' => common_local_url($action, $newargs)),
 773                                            _t('« After'));
 774                 common_element_end('li');
 775         }
 776
 777         if ($have_after) {
 778                 $pargs = array('page' => $page+1);
 779                 $newargs = ($args) ? array_merge($args,$pargs) : $pargs;
 780                 common_element_start('li', 'after');
 781                 common_element('a', array('href' => common_local_url($action, $newargs)),
 782                                                    _t('Before »'));
 783                 common_element_end('li');
 784         }
 785
 786         if ($have_before || $have_after) {
 787                 common_element_end('ul');
 788                 common_element_end('div');
 789         }
 790 }
 791
 792 /* Following functions are copied from MediaWiki GlobalFunctions.php
 793  * and written by Evan Prodromou. */
 794
 795 function common_accept_to_prefs($accept, $def = '*/*') {
 796         # No arg means accept anything (per HTTP spec)
 797         if(!$accept) {
 798                 return array($def => 1);
 799         }
 800
 801         $prefs = array();
 802
 803         $parts = explode(',', $accept);
 804
 805         foreach($parts as $part) {
 806                 # FIXME: doesn't deal with params like 'text/html; level=1'
 807                 @list($value, $qpart) = explode(';', $part);
 808                 $match = array();
 809                 if(!isset($qpart)) {
 810                         $prefs[$value] = 1;
 811                 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
 812                         $prefs[$value] = $match[1];
 813                 }
 814         }
 815
 816         return $prefs;
 817 }
 818
 819 function common_mime_type_match($type, $avail) {
 820         if(array_key_exists($type, $avail)) {
 821                 return $type;
 822         } else {
 823                 $parts = explode('/', $type);
 824                 if(array_key_exists($parts[0] . '/*', $avail)) {
 825                         return $parts[0] . '/*';
 826                 } elseif(array_key_exists('*/*', $avail)) {
 827                         return '*/*';
 828                 } else {
 829                         return NULL;
 830                 }
 831         }
 832 }
 833
 834 function common_negotiate_type($cprefs, $sprefs) {
 835         $combine = array();
 836
 837         foreach(array_keys($sprefs) as $type) {
 838                 $parts = explode('/', $type);
 839                 if($parts[1] != '*') {
 840                         $ckey = common_mime_type_match($type, $cprefs);
 841                         if($ckey) {
 842                                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
 843                         }
 844                 }
 845         }
 846
 847         foreach(array_keys($cprefs) as $type) {
 848                 $parts = explode('/', $type);
 849                 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
 850                         $skey = common_mime_type_match($type, $sprefs);
 851                         if($skey) {
 852                                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
 853                         }
 854                 }
 855         }
 856
 857         $bestq = 0;
 858         $besttype = NULL;
 859
 860         foreach(array_keys($combine) as $type) {
 861                 if($combine[$type] > $bestq) {
 862                         $besttype = $type;
 863                         $bestq = $combine[$type];
 864                 }
 865         }
 866
 867         return $besttype;
 868 }
 869
 870 function common_config($main, $sub) {
 871         global $config;
 872         return $config[$main][$sub];
 873 }