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 function common_show_header($pagetitle, $callable=NULL, $data=NULL, $notice=NULL) {
 127         global $config, $xw;
 128
 129         header('Content-Type: application/xhtml+xml');
 130
 131         common_start_xml('html',
 132                                          '-//W3C//DTD XHTML 1.0 Strict//EN',
 133                                          'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
 134
 135         # FIXME: correct language for interface
 136
 137         common_element_start('html', array('xmlns' => 'http://www.w3.org/1999/xhtml',
 138                                                                            'xml:lang' => 'en',
 139                                                                            'lang' => 'en'));
 140
 141         common_element_start('head');
 142         common_element('title', NULL,
 143                                    $pagetitle . " - " . $config['site']['name']);
 144         common_element('link', array('rel' => 'stylesheet',
 145                                                                  'type' => 'text/css',
 146                                                                  'href' => theme_path('display.css'),
 147                                                                  'media' => 'screen, projection, tv'));
 148         foreach (array(6,7) as $ver) {
 149                 if (file_exists(theme_file('ie'.$ver.'.css'))) {
 150                         # Yes, IE people should be put in jail.
 151                         $xw->writeComment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
 152                                                           'href="'.theme_path('ie'.$ver.'.css').' /><![endif]');
 153                 }
 154         }
 155         if ($callable) {
 156                 if ($data) {
 157                         call_user_func($callable, $data);
 158                 } else {
 159                         call_user_func($callable);
 160                 }
 161         }
 162         common_element_end('head');
 163         common_element_start('body');
 164         common_element_start('div', array('id' => 'wrap'));
 165         common_element_start('div', array('id' => 'header'));
 166         common_nav_menu();
 167         common_element_start('a', array('href' => common_local_url('public')));
 168         common_element('img', array('src' => ($config['site']['logo']) ?
 169                                                                 ($config['site']['logo']) : theme_path('logo.png'),
 170                                                                 'alt' => $config['site']['name'],
 171                                                                 'id' => 'logo'));
 172         common_element_end('a');
 173         if (common_logged_in()) {
 174                 common_notice_form();
 175         }
 176         common_element_end('div');
 177         common_element_start('div', array('id' => 'content'));
 178         if (common_logged_in()) {
 179                 common_views_menu();
 180         }
 181 }
 182
 183 function common_show_footer() {
 184         global $xw, $config;
 185         common_element_end('div'); # content div
 186         common_foot_menu();
 187         common_element_start('div', array('id' => 'footer'));
 188         common_element('img', array('id' => 'cc',
 189                                                                 'src' => $config['license']['image'],
 190                                                                 'alt' => $config['license']['title']));
 191         common_element_start('p');
 192         common_text(_t('Unless otherwise specified, contents of this site are copyright by the contributors and available under the '));
 193         common_element('a', array('class' => 'license',
 194                                                           'rel' => 'license',
 195                                                           href => $config['license']['url']),
 196                                    $config['license']['title']);
 197         common_text(_t('. Contributors should be attributed by full name or nickname.'));
 198         common_element_end('p');
 199         common_element_end('div');
 200         common_element_end('div');
 201         common_element_end('body');
 202         common_element_end('html');
 203         common_end_xml();
 204 }
 205
 206 function common_text($txt) {
 207         global $xw;
 208         $xw->text($txt);
 209 }
 210
 211 function common_raw($xml) {
 212         global $xw;
 213         $xw->writeRaw($xml);
 214 }
 215
 216 function common_nav_menu() {
 217         $user = common_current_user();
 218         common_element_start('ul', array('id' => 'nav'));
 219         common_menu_item(common_local_url('public'), _t('Public'));
 220         common_menu_item(common_local_url('doc', array('title' => 'help')),
 221                                          _t('Help'));
 222         if ($user) {
 223                 common_menu_item(common_local_url('profilesettings'),
 224                                                  _t('Settings'));
 225                 common_menu_item(common_local_url('logout'),
 226                                                  _t('Logout'));
 227         } else {
 228                 common_menu_item(common_local_url('login'), _t('Login'));
 229                 common_menu_item(common_local_url('register'), _t('Register'));
 230         }
 231         common_element_end('ul');
 232 }
 233
 234 function common_views_menu() {
 235         common_element_start('ul', array('id' => 'nav_views'));
 236         common_menu_item(common_local_url('all', array('nickname' =>
 237                                                                                                    $user->nickname)),
 238                                          _t('Home'));
 239         common_menu_item(common_local_url('showstream', array('nickname' =>
 240                                                                                                                   $user->nickname)),
 241                                          _t('Profile'),  $user->fullname || $user->nickname);
 242         common_element_end('ul');
 243 }
 244
 245 function common_foot_menu() {
 246         common_element_start('ul', array('id' => 'nav_sub'));
 247         common_menu_item(common_local_url('doc', array('title' => 'about')),
 248                                          _t('About'));
 249         common_menu_item(common_local_url('doc', array('title' => 'privacy')),
 250                                          _t('Privacy'));
 251         common_menu_item(common_local_url('doc', array('title' => 'source')),
 252                                          _t('Source'));
 253         common_element_end('ul');
 254 }
 255
 256 function common_menu_item($url, $text, $title=NULL) {
 257         $attrs['href'] = $url;
 258         if ($title) {
 259                 $attrs['title'] = $title;
 260         }
 261         common_element_start('li');
 262         common_element('a', $attrs, $text);
 263         common_element_end('li');
 264 }
 265
 266 function common_input($id, $label, $value=NULL) {
 267         common_element_start('p');
 268         common_element('label', array('for' => $id), $label);
 269         $attrs = array('name' => $id,
 270                                    'type' => 'text',
 271                                    'id' => $id);
 272         if ($value) {
 273                 $attrs['value'] = htmlspecialchars($value);
 274         }
 275         common_element('input', $attrs);
 276         common_element_end('p');
 277 }
 278
 279 function common_hidden($id, $value) {
 280         common_element('input', array('name' => $id,
 281                                                                   'type' => 'hidden',
 282                                                                   'id' => $id,
 283                                                                   'value' => $value));
 284 }
 285
 286 function common_password($id, $label) {
 287         common_element_start('p');
 288         common_element('label', array('for' => $id), $label);
 289         $attrs = array('name' => $id,
 290                                    'type' => 'password',
 291                                    'id' => $id);
 292         common_element('input', $attrs);
 293         common_element_end('p');
 294 }
 295
 296 function common_submit($id, $label) {
 297         global $xw;
 298         common_element_start('p');
 299         common_element_start('label', array('for' => $id));
 300         $xw->writeRaw('&nbsp;');
 301         common_element_end('label');
 302         common_element('input', array('type' => 'submit',
 303                                                                   'id' => $id,
 304                                                                   'name' => $id,
 305                                                                   'value' => $label,
 306                                                                   'class' => 'button'));
 307         common_element_end('p');
 308 }
 309
 310 function common_textarea($id, $label, $content=NULL) {
 311         common_element_start('p');
 312         common_element('label', array('for' => $id), $label);
 313         common_element('textarea', array('rows' => 3,
 314                                                                          'cols' => 40,
 315                                                                          'name' => $id,
 316                                                                          'id' => $id,
 317                                                                          'class' => 'width50'),
 318                                    ($content) ? $content : ' ');
 319         common_element_end('p');
 320 }
 321
 322 # salted, hashed passwords are stored in the DB
 323
 324 function common_munge_password($id, $password) {
 325         return md5($id . $password);
 326 }
 327
 328 # check if a username exists and has matching password
 329 function common_check_user($nickname, $password) {
 330         $user = User::staticGet('nickname', $nickname);
 331         if (is_null($user)) {
 332                 return false;
 333         } else {
 334                 return (0 == strcmp(common_munge_password($password, $user->id),
 335                                                         $user->password));
 336         }
 337 }
 338
 339 # is the current user logged in?
 340 function common_logged_in() {
 341         return (!is_null(common_current_user()));
 342 }
 343
 344 function common_have_session() {
 345         return (0 != strcmp(session_id(), ''));
 346 }
 347
 348 function common_ensure_session() {
 349         if (!common_have_session()) {
 350                 @session_start();
 351         }
 352 }
 353
 354 function common_set_user($nickname) {
 355         if (is_null($nickname) && common_have_session()) {
 356                 unset($_SESSION['userid']);
 357                 return true;
 358         } else {
 359                 $user = User::staticGet('nickname', $nickname);
 360                 if ($user) {
 361                         common_ensure_session();
 362                         $_SESSION['userid'] = $user->id;
 363                         return true;
 364                 } else {
 365                         return false;
 366                 }
 367         }
 368         return false;
 369 }
 370
 371 # who is the current user?
 372 function common_current_user() {
 373         static $user = NULL; # FIXME: global memcached
 374         if (is_null($user)) {
 375                 common_ensure_session();
 376                 $id = $_SESSION['userid'];
 377                 if ($id) {
 378                         $user = User::staticGet($id);
 379                 }
 380         }
 381         return $user;
 382 }
 383
 384 # get canonical version of nickname for comparison
 385 function common_canonical_nickname($nickname) {
 386         # XXX: UTF-8 canonicalization (like combining chars)
 387         return $nickname;
 388 }
 389
 390 # get canonical version of email for comparison
 391 function common_canonical_email($email) {
 392         # XXX: canonicalize UTF-8
 393         # XXX: lcase the domain part
 394         return $email;
 395 }
 396
 397 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$_+!*();/?:~-]))');
 398
 399 function common_render_content($text, $notice) {
 400         $r = htmlspecialchars($text);
 401         $id = $notice->profile_id;
 402         $r = preg_replace('@https?://\S+@', '<a href="\0" class="extlink">\0</a>', $r);
 403         $r = preg_replace('/(^|\b)@([\w-]+)($|\b)/e', "'\\1@'.common_at_link($id, '\\2').'\\3'", $r);
 404         # XXX: # tags
 405         # XXX: machine tags
 406         return $r;
 407 }
 408
 409 function common_at_link($sender_id, $nickname) {
 410         # Try to find profiles this profile is subscribed to that have this nickname
 411         $recipient = new Profile();
 412         # XXX: chokety and bad
 413         $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender_id.' and subscribed = id)', 'AND');
 414         $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
 415         if ($recipient->find(TRUE)) {
 416                 return '<a href="'.htmlspecialchars($recipient->profileurl).'" class="atlink tolistenee">'.$nickname.'</a>';
 417         }
 418         # Try to find profiles that listen to this profile and that have this nickname
 419         $recipient = new Profile();
 420         # XXX: chokety and bad
 421         $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender_id.' and subscriber = id)', 'AND');
 422         $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
 423         if ($recipient->find(TRUE)) {
 424                 return '<a href="'.htmlspecialchars($recipient->profileurl).'" class="atlink tolistener">'.$nickname.'</a>';
 425         }
 426         # If this is a local user, try to find a local user with that nickname.
 427         $sender = User::staticGet($sender_id);
 428         if ($sender) {
 429                 $recipient_user = User::staticGet('nickname', $nickname);
 430                 if ($recipient_user) {
 431                         $recipient = $recipient->getProfile();
 432                         return '<a href="'.htmlspecialchars($recipient->profileurl).'" class="atlink usertouser">'.$nickname.'</a>';
 433                 }
 434         }
 435         # Otherwise, no links. @messages from local users to remote users,
 436         # or from remote users to other remote users, are just
 437         # outside our ability to make intelligent guesses about
 438         return $nickname;
 439 }
 440
 441 // where should the avatar go for this user?
 442
 443 function common_avatar_filename($id, $extension, $size=NULL, $extra=NULL) {
 444         global $config;
 445
 446         if ($size) {
 447                 return $id . '-' . $size . (($extra) ? ('-' . $extra) : '') . $extension;
 448         } else {
 449                 return $id . '-original' . (($extra) ? ('-' . $extra) : '') . $extension;
 450         }
 451 }
 452
 453 function common_avatar_path($filename) {
 454         global $config;
 455         return INSTALLDIR . '/avatar/' . $filename;
 456 }
 457
 458 function common_avatar_url($filename) {
 459         return common_path('avatar/'.$filename);
 460 }
 461
 462 function common_default_avatar($size) {
 463         static $sizenames = array(AVATAR_PROFILE_SIZE => 'profile',
 464                                                           AVATAR_STREAM_SIZE => 'stream',
 465                                                           AVATAR_MINI_SIZE => 'mini');
 466         global $config;
 467
 468         return common_path($config['avatar']['default'][$sizenames[$size]]);
 469 }
 470
 471 function common_local_url($action, $args=NULL) {
 472         global $config;
 473         if ($config['site']['fancy']) {
 474                 return common_fancy_url($action, $args);
 475         } else {
 476                 return common_simple_url($action, $args);
 477         }
 478 }
 479
 480 function common_fancy_url($action, $args=NULL) {
 481         switch (strtolower($action)) {
 482          case 'public':
 483                 return common_path('');
 484          case 'publicrss':
 485                 return common_path('rss');
 486          case 'doc':
 487                 return common_path('doc/'.$args['title']);
 488          case 'login':
 489          case 'logout':
 490          case 'register':
 491          case 'subscribe':
 492          case 'unsubscribe':
 493                 return common_path('main/'.$action);
 494          case 'avatar':
 495          case 'password':
 496                 return common_path('settings/'.$action);
 497          case 'profilesettings':
 498                 return common_path('settings/profile');
 499          case 'newnotice':
 500                 return common_path('notice/new');
 501          case 'shownotice':
 502                 return common_path('notice/'.$args['notice']);
 503          case 'subscriptions':
 504          case 'subscribed':
 505          case 'xrds':
 506          case 'all':
 507          case 'foaf':
 508                 return common_path($args['nickname'].'/'.$action);
 509          case 'allrss':
 510                 return common_path($args['nickname'].'/all/rss');
 511          case 'userrss':
 512                 return common_path($args['nickname'].'/rss');
 513          case 'showstream':
 514                 return common_path($args['nickname']);
 515          default:
 516                 return common_simple_url($action, $args);
 517         }
 518 }
 519
 520 function common_simple_url($action, $args=NULL) {
 521         global $config;
 522         /* XXX: pretty URLs */
 523         $extra = '';
 524         if ($args) {
 525                 foreach ($args as $key => $value) {
 526                         $extra .= "&${key}=${value}";
 527                 }
 528         }
 529         return common_path("index.php?action=${action}${extra}");
 530 }
 531
 532 function common_path($relative) {
 533         global $config;
 534         $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
 535         return "http://".$config['site']['server'].'/'.$pathpart.$relative;
 536 }
 537
 538 function common_date_string($dt) {
 539         // XXX: do some sexy date formatting
 540         // return date(DATE_RFC822, $dt);
 541         return $dt;
 542 }
 543
 544 function common_date_w3dtf($dt) {
 545         $t = strtotime($dt);
 546         return date(DATE_W3C, $t);
 547 }
 548
 549 function common_redirect($url, $code=307) {
 550         static $status = array(301 => "Moved Permanently",
 551                                                    302 => "Found",
 552                                                    303 => "See Other",
 553                                                    307 => "Temporary Redirect");
 554         header("Status: ${code} $status[$code]");
 555         header("Location: $url");
 556         common_element('a', array('href' => $url), $url);
 557 }
 558
 559 function common_broadcast_notice($notice, $remote=false) {
 560         // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
 561         if (!$remote) {
 562                 # Make sure we have the OMB stuff
 563                 require_once(INSTALLDIR.'/lib/omb.php');
 564                 omb_broadcast_remote_subscribers($notice);
 565         }
 566         // XXX: broadcast notices to Jabber
 567         // XXX: broadcast notices to SMS
 568         // XXX: broadcast notices to other IM
 569         return true;
 570 }
 571
 572
 573 function common_profile_url($nickname) {
 574         return common_local_url('showstream', array('nickname' => $nickname));
 575 }
 576
 577 # Don't call if nobody's logged in
 578
 579 function common_notice_form() {
 580         $user = common_current_user();
 581         assert(!is_null($user));
 582         common_element_start('form', array('id' => 'status_form',
 583                                                                            'method' => 'POST',
 584                                                                            'action' => common_local_url('newnotice')));
 585         common_element_start('p');
 586         common_element('label', array('for' => 'status_update',
 587                                                                   'id' => 'status_label'),
 588                                    _t('What\'s up, ').$user->nickname.'?');
 589         common_element('textarea', array('id' => 'status_textarea'));
 590         common_element('input', array('id' => 'status_submit',
 591                                                                   'type' => 'submit',
 592                                                                   'value' => _t('Send')));
 593         common_element_end('p');
 594         common_element_end('form');
 595 }
 596
 597 function common_mint_tag($extra) {
 598         global $config;
 599         return
 600           'tag:'.$config['tag']['authority'].','.
 601           $config['tag']['date'].':'.$config['tag']['prefix'].$extra;
 602 }
 603
 604 # Should make up a reasonable root URL
 605
 606 function common_root_url() {
 607         return common_path('');
 608 }
 609
 610 # returns $bytes bytes of random data as a hexadecimal string
 611 # "good" here is a goal and not a guarantee
 612
 613 function common_good_rand($bytes) {
 614         # XXX: use random.org...?
 615         if (file_exists('/dev/urandom')) {
 616                 return common_urandom($bytes);
 617         } else { # FIXME: this is probably not good enough
 618                 return common_mtrand($bytes);
 619         }
 620 }
 621
 622 function common_urandom($bytes) {
 623         $h = fopen('/dev/urandom', 'rb');
 624         # should not block
 625         $src = fread($h, $bytes);
 626         fclose($h);
 627         $enc = '';
 628         for ($i = 0; $i < $bytes; $i++) {
 629                 $enc .= sprintf("%02x", (ord($src[$i])));
 630         }
 631         return $enc;
 632 }
 633
 634 function common_mtrand($bytes) {
 635         $enc = '';
 636         for ($i = 0; $i < $bytes; $i++) {
 637                 $enc .= sprintf("%02x", mt_rand(0, 255));
 638         }
 639         return $enc;
 640 }
 641
 642 function common_set_returnto($url) {
 643         common_ensure_session();
 644         $_SESSION['returnto'] = $url;
 645 }
 646
 647 function common_get_returnto() {
 648         common_ensure_session();
 649         return $_SESSION['returnto'];
 650 }
 651
 652 function common_timestamp() {
 653         return date('YmdHis');
 654 }
 655
 656 // XXX: set up gettext
 657
 658 function _t($str) {
 659         return $str;
 660 }
 661
 662 function common_ensure_syslog() {
 663         static $initialized = false;
 664         if (!$initialized) {
 665                 global $config;
 666                 define_syslog_variables();
 667                 openlog($config['syslog']['appname'], 0, LOG_USER);
 668                 $initialized = true;
 669         }
 670 }
 671
 672 function common_log($priority, $msg, $filename=NULL) {
 673         common_ensure_syslog();
 674         syslog($priority, $msg);
 675 }
 676
 677 function common_debug($msg, $filename=NULL) {
 678         if ($filename) {
 679                 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
 680         } else {
 681                 common_log(LOG_DEBUG, $msg);
 682         }
 683 }
 684
 685 function common_valid_http_url($url) {
 686         return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
 687 }
 688
 689 function common_valid_tag($tag) {
 690         if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
 691                 return (Validate::email($matches[1]) ||
 692                                 preg_match('/^([\w-\.]+)$/', $matches[1]));
 693         }
 694         return false;
 695 }
 696
 697 # Does a little before-after block for next/prev page
 698
 699 function common_pagination($have_before, $have_after, $page, $action, $args=NULL) {
 700
 701         if ($have_before || $have_after) {
 702                 common_element_start('div', array('id' => 'pagination'));
 703                 common_element_start('ul', array('id' => 'nav_pagination'));
 704         }
 705
 706         if ($have_before) {
 707                 $pargs = array('page' => $page-1);
 708                 $newargs = ($args) ? array_merge($args,$pargs) : $pargs;
 709
 710                 common_element_start('li', 'before');
 711                 common_element('a', array('href' => common_local_url($action, $newargs)),
 712                                            _t('« Before'));
 713                 common_element_end('li');
 714         }
 715
 716         if ($have_after) {
 717                 $pargs = array('page' => $page+1);
 718                 $newargs = ($args) ? array_merge($args,$pargs) : $pargs;
 719                 common_element_start('li', 'after');
 720                 common_element('a', array('href' => common_local_url($action, $newargs)),
 721                                                    _t('After »'));
 722                 common_element_end('li');
 723         }
 724
 725         if ($have_before || $have_after) {
 726                 common_element_end('ul');
 727                 common_element_end('div');
 728         }
 729 }