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) {
  25         header('Status: 500 Server Error');
  26         header('Content-type: text/plain');
  27
  28         print $msg;
  29         exit();
  30 }
  31
  32 # Show a user error
  33 function common_user_error($msg, $code=200) {
  34         common_show_header('Error');
  35         common_element('div', array('class' => 'error'), $msg);
  36         common_show_footer();
  37 }
  38
  39 $xw = null;
  40
  41 # Start an HTML element
  42 function common_element_start($tag, $attrs=NULL) {
  43         global $xw;
  44         $xw->startElement($tag);
  45         if (is_array($attrs)) {
  46                 foreach ($attrs as $name => $value) {
  47                         $xw->writeAttribute($name, $value);
  48                 }
  49         } else if (is_string($attrs)) {
  50                 $xw->writeAttribute('class', $attrs);
  51         }
  52 }
  53
  54 function common_element_end($tag) {
  55         global $xw;
  56         $xw->endElement();
  57 }
  58
  59 function common_element($tag, $attrs=NULL, $content=NULL) {
  60     common_element_start($tag, $attrs);
  61         if ($content) {
  62                 global $xw;
  63                 $xw->text($content);
  64         }
  65         common_element_end($tag);
  66 }
  67
  68 function common_start_xml($doc=NULL, $public=NULL, $system=NULL) {
  69         global $xw;
  70         $xw = new XMLWriter();
  71         $xw->openURI('php://output');
  72         $xw->setIndent(true);
  73         $xw->startDocument('1.0', 'UTF-8');
  74         if ($doc) {
  75                 $xw->writeDTD($doc, $public, $system);
  76         }
  77 }
  78
  79 function common_end_xml() {
  80         global $xw;
  81         $xw->endDocument();
  82         $xw->flush();
  83 }
  84
  85 function common_show_header($pagetitle, $callable=NULL, $data=NULL) {
  86         global $config, $xw;
  87
  88         header('Content-Type: application/xhtml+xml');
  89
  90         common_start_xml('html',
  91                                          '-//W3C//DTD XHTML 1.0 Strict//EN',
  92                                          'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
  93
  94         # FIXME: correct language for interface
  95
  96         common_element_start('html', array('xmlns' => 'http://www.w3.org/1999/xhtml',
  97                                                                            'xml:lang' => 'en',
  98                                                                            'lang' => 'en'));
  99
 100         common_element_start('head');
 101         common_element('title', NULL,
 102                                    $pagetitle . " - " . $config['site']['name']);
 103         common_element('link', array('rel' => 'stylesheet',
 104                                                                  'type' => 'text/css',
 105                                                                  'href' => $config['site']['path'] . 'theme/default/style/html.css',
 106                                                                  'media' => 'screen, projection, tv'));
 107         common_element('link', array('rel' => 'stylesheet',
 108                                                                  'type' => 'text/css',
 109                                                                  'href' => $config['site']['path'] . 'theme/default/style/layout.css',
 110                                                                  'media' => 'screen, projection, tv'));
 111         common_element('link', array('rel' => 'stylesheet',
 112                                                                  'type' => 'text/css',
 113                                                                  'href' => $config['site']['path'] . 'theme/default/style/print.css',
 114                                                                  'media' => 'print'));
 115         if ($callable) {
 116                 if ($data) {
 117                         call_user_func($callable, $data);
 118                 } else {
 119                         call_user_func($callable);
 120                 }
 121         }
 122         common_element_end('head');
 123         common_element_start('body');
 124         common_element_start('div', array('id' => 'wrapper'));
 125         common_element_start('div', array('id' => 'content'));
 126         common_element_start('div', array('id' => 'header'));
 127         common_element('h1', 'title', $pagetitle);
 128         common_element('h2', 'subtitle', $config['site']['name']);
 129         common_element_end('div');
 130         common_head_menu();
 131         common_element_start('div', array('id' => 'page'));
 132 }
 133
 134 function common_show_footer() {
 135         global $xw, $config;
 136         common_element_start('div', 'footer');
 137         common_foot_menu();
 138         common_license_block();
 139         common_element_end('div');
 140         common_element_end('div');
 141         common_element_end('div');
 142         common_element_end('div');
 143         common_element_end('body');
 144         common_element_end('html');
 145         common_end_xml();
 146 }
 147
 148 function common_text($txt) {
 149         global $xw;
 150         $xw->text($txt);
 151 }
 152
 153 function common_raw($xml) {
 154         global $xw;
 155         $xw->writeRaw($xml);
 156 }
 157
 158 function common_license_block() {
 159         global $config, $xw;
 160         common_element_start('p', 'license greenBg');
 161         common_element_start('span', 'floatLeft width25');
 162         common_element_start('a', array('class' => 'license',
 163                                                                         'rel' => 'license',
 164                                                                         href => $config['license']['url']));
 165         common_element('img', array('class' => 'license',
 166                                                                 'src' => $config['license']['image'],
 167                                                                 'alt' => $config['license']['title']));
 168         common_element_end('a');
 169         common_element_end('span');
 170         common_element_start('span', 'floatRight width75');
 171         common_text(_t('Unless otherwise specified, contents of this site are copyright by the contributors and available under the '));
 172         common_element('a', array('class' => 'license',
 173                                                           'rel' => 'license',
 174                                                           href => $config['license']['url']),
 175                                    $config['license']['title']);
 176         common_text(_t('. Contributors should be attributed by full name or nickname.'));
 177         common_element_end('span');
 178         common_element_end('p');
 179 }
 180
 181 function common_head_menu() {
 182         $user = common_current_user();
 183         common_element_start('ul', array('id' => 'menu', 'class' => ($user) ? 'five' : 'three'));
 184         common_menu_item(common_local_url('public'), _t('Public'));
 185         if ($user) {
 186                 common_menu_item(common_local_url('all', array('nickname' =>
 187                                                                                                            $user->nickname)),
 188                                                  _t('Home'));
 189                 common_menu_item(common_local_url('showstream', array('nickname' =>
 190                                                                                                                           $user->nickname)),
 191                                                  _t('Profile'),  $user->fullname || $user->nickname);
 192                 common_menu_item(common_local_url('profilesettings'),
 193                                                  _t('Settings'));
 194                 common_menu_item(common_local_url('logout'),
 195                                                  _t('Logout'));
 196         } else {
 197                 common_menu_item(common_local_url('login'),
 198                                                  _t('Login'));
 199                 common_menu_item(common_local_url('register'),
 200                                                  _t('Register'));
 201         }
 202         common_element_end('ul');
 203 }
 204
 205 function common_foot_menu() {
 206         common_element_start('ul', 'footmenu menuish');
 207         common_menu_item(common_local_url('doc', array('title' => 'about')),
 208                                          _t('About'));
 209         common_menu_item(common_local_url('doc', array('title' => 'help')),
 210                                          _t('Help'));
 211         common_menu_item(common_local_url('doc', array('title' => 'privacy')),
 212                                          _t('Privacy'));
 213         common_menu_item(common_local_url('doc', array('title' => 'source')),
 214                                          _t('Source'));
 215         common_element_end('ul');
 216 }
 217
 218 function common_menu_item($url, $text, $title=NULL) {
 219         $attrs['href'] = $url;
 220         if ($title) {
 221                 $attrs['title'] = $title;
 222         }
 223         common_element_start('li', 'menuitem');
 224         common_element('a', $attrs, $text);
 225         common_element_end('li');
 226 }
 227
 228 function common_input($id, $label, $value=NULL) {
 229         common_element_start('p');
 230         common_element('label', array('for' => $id), $label);
 231         $attrs = array('name' => $id,
 232                                    'type' => 'text',
 233                                    'id' => $id);
 234         if ($value) {
 235                 $attrs['value'] = htmlspecialchars($value);
 236         }
 237         common_element('input', $attrs);
 238         common_element_end('p');
 239 }
 240
 241 function common_password($id, $label) {
 242         common_element_start('p');
 243         common_element('label', array('for' => $id), $label);
 244         $attrs = array('name' => $id,
 245                                    'type' => 'password',
 246                                    'id' => $id);
 247         common_element('input', $attrs);
 248         common_element_end('p');
 249 }
 250
 251 function common_submit($id, $label) {
 252         global $xw;
 253         common_element_start('p');
 254         common_element_start('label', array('for' => $id));
 255         $xw->writeRaw('&nbsp;');
 256         common_element_end('label');
 257         common_element('input', array('type' => 'submit',
 258                                                                   'id' => $id,
 259                                                                   'name' => $id,
 260                                                                   'value' => $label,
 261                                                                   'class' => 'button'));
 262         common_element_end('p');
 263 }
 264
 265 function common_textarea($id, $label, $content=NULL) {
 266         common_element_start('p');
 267         common_element('label', array('for' => $id), $label);
 268         common_element('textarea', array('rows' => 3,
 269                                                                          'cols' => 40,
 270                                                                          'name' => $id,
 271                                                                          'id' => $id,
 272                                                                          'class' => 'width50'),
 273                                    ($content) ? $content : ' ');
 274         common_element_end('p');
 275 }
 276
 277 # salted, hashed passwords are stored in the DB
 278
 279 function common_munge_password($id, $password) {
 280         return md5($id . $password);
 281 }
 282
 283 # check if a username exists and has matching password
 284 function common_check_user($nickname, $password) {
 285         $user = User::staticGet('nickname', $nickname);
 286         if (is_null($user)) {
 287                 return false;
 288         } else {
 289                 return (0 == strcmp(common_munge_password($password, $user->id),
 290                                                         $user->password));
 291         }
 292 }
 293
 294 # is the current user logged in?
 295 function common_logged_in() {
 296         return (!is_null(common_current_user()));
 297 }
 298
 299 function common_have_session() {
 300         return (0 != strcmp(session_id(), ''));
 301 }
 302
 303 function common_ensure_session() {
 304         if (!common_have_session()) {
 305                 @session_start();
 306         }
 307 }
 308
 309 function common_set_user($nickname) {
 310         if (is_null($nickname) && common_have_session()) {
 311                 unset($_SESSION['userid']);
 312                 return true;
 313         } else {
 314                 $user = User::staticGet('nickname', $nickname);
 315                 if ($user) {
 316                         common_ensure_session();
 317                         $_SESSION['userid'] = $user->id;
 318                         return true;
 319                 } else {
 320                         return false;
 321                 }
 322         }
 323         return false;
 324 }
 325
 326 # who is the current user?
 327 function common_current_user() {
 328         static $user = NULL; # FIXME: global memcached
 329         if (is_null($user)) {
 330                 common_ensure_session();
 331                 $id = $_SESSION['userid'];
 332                 if ($id) {
 333                         $user = User::staticGet($id);
 334                 }
 335         }
 336         return $user;
 337 }
 338
 339 # get canonical version of nickname for comparison
 340 function common_canonical_nickname($nickname) {
 341         # XXX: UTF-8 canonicalization (like combining chars)
 342         return $nickname;
 343 }
 344
 345 # get canonical version of email for comparison
 346 function common_canonical_email($email) {
 347         # XXX: canonicalize UTF-8
 348         # XXX: lcase the domain part
 349         return $email;
 350 }
 351
 352 function common_render_content($text, $notice=NULL) {
 353         $r = htmlspecialchars($text);
 354         if ($notice) {
 355                 $id = $notice->profile_id;
 356                 $r = preg_replace('/\b@([\w-]{1-64})\b/e', "@common_at_link($id, '\\1')", $r);
 357         }
 358         # XXX: # tags
 359         # XXX: machine tags
 360         return $r;
 361 }
 362
 363 function common_at_link($profile_id, $nickname) {
 364         # Try to find profiles this profile is subscribed to that have this nickname
 365         $profile = new Profile();
 366         # XXX: chokety and bad
 367         $profile->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$profile_id.' and subscribed = id)', 'AND');
 368         $profile->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
 369         if ($profile->find(TRUE)) {
 370                 return '<a href="'.$profile->profileurl.'" class="atlink tolistenee">'.$nickname.'</a>';
 371         }
 372         # Try to find profiles that listen to this profile and that have this nickname
 373         $profile = new Profile();
 374         # XXX: chokety and bad
 375         $profile->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$profile_id.' and subscriber = id)', 'AND');
 376         $profile->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
 377         if ($profile->find(TRUE)) {
 378                 return '<a href="'.$profile->profileurl.'" class="atlink tolistener">'.$nickname.'</a>';
 379         }
 380         # If this is a local user, try to find a local user with that nickname.
 381         $sender = User::staticGet($profile_id);
 382         if ($sender) {
 383                 $recipient = User::staticGet('nickname', $nickname);
 384                 if ($recipient) {
 385                         $profile = $recipient->getProfile();
 386                         return '<a href="'.$profile->profileurl.'" class="atlink usertouser">'.$nickname.'</a>';
 387                 }
 388         }
 389         # Otherwise, no links. @messages from local users to remote users,
 390         # or from remote users to other remote users, are just
 391         # outside our ability to make intelligent guesses about
 392         return $nickname;
 393 }
 394
 395 // where should the avatar go for this user?
 396
 397 function common_avatar_filename($user, $extension, $size=NULL, $extra=NULL) {
 398         global $config;
 399
 400         if ($size) {
 401                 return $user->id . '-' . $size . (($extra) ? ('-' . $extra) : '') . $extension;
 402         } else {
 403                 return $user->id . '-original' . (($extra) ? ('-' . $extra) : '') . $extension;
 404         }
 405 }
 406
 407 function common_avatar_path($filename) {
 408         global $config;
 409         return $config['avatar']['directory'] . '/' . $filename;
 410 }
 411
 412 function common_avatar_url($filename) {
 413         global $config;
 414         return "http://".$config['site']['server'].$config['avatar']['path'].'/'.$filename;
 415 }
 416
 417 function common_default_avatar($size) {
 418         static $sizenames = array(AVATAR_PROFILE_SIZE => 'profile',
 419                                                           AVATAR_STREAM_SIZE => 'stream',
 420                                                           AVATAR_MINI_SIZE => 'mini');
 421         global $config;
 422         return "http://".$config['site']['server'].$config['site']['path'].'/'.$config['avatar']['default'][$sizenames[$size]];
 423 }
 424
 425 function common_local_url($action, $args=NULL) {
 426         global $config;
 427         /* XXX: pretty URLs */
 428         $extra = '';
 429         if ($args) {
 430                 foreach ($args as $key => $value) {
 431                         $extra .= "&${key}=${value}";
 432                 }
 433         }
 434         $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
 435         return "http://".$config['site']['server'].'/'.$pathpart."index.php?action=${action}${extra}";
 436 }
 437
 438 function common_date_string($dt) {
 439         // XXX: do some sexy date formatting
 440         // return date(DATE_RFC822, $dt);
 441         return $dt;
 442 }
 443
 444 function common_date_w3dtf($dt) {
 445         $t = strtotime($dt);
 446         return date(DATE_W3C, $t);
 447 }
 448
 449 function common_redirect($url, $code=307) {
 450         static $status = array(301 => "Moved Permanently",
 451                                                    302 => "Found",
 452                                                    303 => "See Other",
 453                                                    307 => "Temporary Redirect");
 454         header("Status: ${code} $status[$code]");
 455         header("Location: $url");
 456         common_element('a', array('href' => $url), $url);
 457 }
 458
 459 function common_broadcast_notice($notice) {
 460         // XXX: broadcast notices to remote subscribers
 461         // XXX: broadcast notices to SMS
 462         // XXX: broadcast notices to Jabber
 463         // XXX: broadcast notices to other IM
 464         // XXX: use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
 465         return true;
 466 }
 467
 468 function common_profile_url($nickname) {
 469         return common_local_url('showstream', array('nickname' => $nickname));
 470 }
 471
 472 function common_notice_form() {
 473         common_element_start('form', array('id' => 'newnotice', 'method' => 'POST',
 474                                                                            'action' => common_local_url('newnotice')));
 475         common_textarea('noticecontent', _t('What\'s up?'));
 476         common_submit('submit', _t('Send'));
 477         common_element_end('form');
 478 }
 479
 480 function common_mint_tag($extra) {
 481         global $config;
 482         return
 483           'tag:'.$config['tag']['authority'].','.
 484           $config['tag']['date'].':'.$config['tag']['prefix'].$extra;
 485 }
 486
 487 # Should make up a reasonable root URL
 488
 489 function common_root_url() {
 490         global $config;
 491         $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
 492         return "http://".$config['site']['server'].'/'.$pathpart;
 493 }
 494
 495 # returns $bytes bytes of random data as a hexadecimal string
 496 # "good" here is a goal and not a guarantee
 497
 498 function common_good_rand($bytes) {
 499         # XXX: use random.org...?
 500         if (file_exists('/dev/urandom')) {
 501                 return common_urandom($bytes);
 502         } else { # FIXME: this is probably not good enough
 503                 return common_mtrand($bytes);
 504         }
 505 }
 506
 507 function common_urandom($bytes) {
 508         $h = fopen('/dev/urandom', 'rb');
 509         # should not block
 510         $src = fread($h, $bytes);
 511         fclose($h);
 512         $enc = '';
 513         for ($i = 0; $i < $bytes; $i++) {
 514                 $enc .= sprintf("%02x", (ord($src[$i])));
 515         }
 516         return $enc;
 517 }
 518
 519 function common_mtrand($bytes) {
 520         $enc = '';
 521         for ($i = 0; $i < $bytes; $i++) {
 522                 $enc .= sprintf("%02x", mt_rand(0, 255));
 523         }
 524         return $enc;
 525 }
 526
 527 function common_timestamp() {
 528         return date('YmdHis');
 529 }
 530
 531 // XXX: set up gettext
 532
 533 function _t($str) {
 534         return $str;
 535 }