lib/action.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Base class for all actions (~views)
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Action
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @author    Sarven Capadisli <csarven@status.net>
  26  * @copyright 2008 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('GNUSOCIAL')) { exit(1); }
  32
  33 /**
  34  * Base class for all actions
  35  *
  36  * This is the base class for all actions in the package. An action is
  37  * more or less a "view" in an MVC framework.
  38  *
  39  * Actions are responsible for extracting and validating parameters; using
  40  * model classes to read and write to the database; and doing ouput.
  41  *
  42  * @category Output
  43  * @package  StatusNet
  44  * @author   Evan Prodromou <evan@status.net>
  45  * @author   Sarven Capadisli <csarven@status.net>
  46  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  47  * @link     http://status.net/
  48  *
  49  * @see      HTMLOutputter
  50  */
  51 class Action extends HTMLOutputter // lawsuit
  52 {
  53     // This should be protected/private in the future
  54     public $args = array();
  55
  56     // Action properties, set per-class
  57     protected $action = false;
  58     protected $ajax   = false;
  59     protected $menus  = true;
  60     protected $needLogin = false;
  61     protected $needPost = false;
  62
  63     // The currently scoped profile (normally Profile::current; from $this->auth_user for API)
  64     protected $scoped = null;
  65
  66     // Related to front-end user representation
  67     protected $format = null;
  68     protected $error  = null;
  69     protected $msg    = null;
  70
  71     /**
  72      * Constructor
  73      *
  74      * Just wraps the HTMLOutputter constructor.
  75      *
  76      * @param string  $output URI to output to, default = stdout
  77      * @param boolean $indent Whether to indent output, default true
  78      *
  79      * @see XMLOutputter::__construct
  80      * @see HTMLOutputter::__construct
  81      */
  82     function __construct($output='php://output', $indent=null)
  83     {
  84         parent::__construct($output, $indent);
  85     }
  86
  87     function getError()
  88     {
  89         return $this->error;
  90     }
  91
  92     function getInfo()
  93     {
  94         return $this->msg;
  95     }
  96
  97     static public function run(array $args=array(), $output='php://output', $indent=null) {
  98         $class = get_called_class();
  99         $action = new $class($output, $indent);
 100         $action->execute($args);
 101         return $action;
 102     }
 103
 104     public function execute(array $args=array()) {
 105         // checkMirror stuff
 106         if (common_config('db', 'mirror') && $this->isReadOnly($args)) {
 107             if (is_array(common_config('db', 'mirror'))) {
 108                 // "load balancing", ha ha
 109                 $arr = common_config('db', 'mirror');
 110                 $k = array_rand($arr);
 111                 $mirror = $arr[$k];
 112             } else {
 113                 $mirror = common_config('db', 'mirror');
 114             }
 115
 116             // everyone else uses the mirror
 117             common_config_set('db', 'database', $mirror);
 118         }
 119
 120         if ($this->prepare($args)) {
 121             $this->handle($args);
 122         }
 123     }
 124
 125     /**
 126      * For initializing members of the class.
 127      *
 128      * @param array $argarray misc. arguments
 129      *
 130      * @return boolean true
 131      */
 132     protected function prepare(array $args=array())
 133     {
 134         if ($this->needPost && !$this->isPost()) {
 135             // TRANS: Client error. POST is a HTTP command. It should not be translated.
 136             $this->clientError(_('This method requires a POST.'), 405);
 137         }
 138
 139         $this->args = common_copy_args($args);
 140
 141         $this->action = $this->trimmed('action');
 142
 143         if ($this->ajax || $this->boolean('ajax')) {
 144             // check with StatusNet::isAjax()
 145             StatusNet::setAjax(true);
 146         }
 147
 148         if ($this->needLogin) {
 149             $this->checkLogin(); // if not logged in, this redirs/excepts
 150         }
 151
 152         $this->updateScopedProfile();
 153
 154         return true;
 155     }
 156
 157     function updateScopedProfile() {
 158         $this->scoped = Profile::current();
 159         return $this->scoped;
 160     }
 161
 162     /**
 163      * Show page, a template method.
 164      *
 165      * @return nothing
 166      */
 167     function showPage()
 168     {
 169         if (Event::handle('StartShowHTML', array($this))) {
 170             $this->startHTML();
 171             $this->flush();
 172             Event::handle('EndShowHTML', array($this));
 173         }
 174         if (Event::handle('StartShowHead', array($this))) {
 175             $this->showHead();
 176             $this->flush();
 177             Event::handle('EndShowHead', array($this));
 178         }
 179         if (Event::handle('StartShowBody', array($this))) {
 180             $this->showBody();
 181             Event::handle('EndShowBody', array($this));
 182         }
 183         if (Event::handle('StartEndHTML', array($this))) {
 184             $this->endHTML();
 185             Event::handle('EndEndHTML', array($this));
 186         }
 187     }
 188
 189     function endHTML()
 190     {
 191         global $_startTime;
 192
 193         if (isset($_startTime)) {
 194             $endTime = microtime(true);
 195             $diff = round(($endTime - $_startTime) * 1000);
 196             $this->raw("<!-- ${diff}ms -->");
 197         }
 198
 199         return parent::endHTML();
 200     }
 201
 202     /**
 203      * Show head, a template method.
 204      *
 205      * @return nothing
 206      */
 207     function showHead()
 208     {
 209         // XXX: attributes (profile?)
 210         $this->elementStart('head');
 211         if (Event::handle('StartShowHeadElements', array($this))) {
 212             if (Event::handle('StartShowHeadTitle', array($this))) {
 213                 $this->showTitle();
 214                 Event::handle('EndShowHeadTitle', array($this));
 215             }
 216             $this->showShortcutIcon();
 217             $this->showStylesheets();
 218             $this->showOpenSearch();
 219             $this->showFeeds();
 220             $this->showDescription();
 221             $this->extraHead();
 222             Event::handle('EndShowHeadElements', array($this));
 223         }
 224         $this->elementEnd('head');
 225     }
 226
 227     /**
 228      * Show title, a template method.
 229      *
 230      * @return nothing
 231      */
 232     function showTitle()
 233     {
 234         $this->element('title', null,
 235                        // TRANS: Page title. %1$s is the title, %2$s is the site name.
 236                        sprintf(_('%1$s - %2$s'),
 237                                $this->title(),
 238                                common_config('site', 'name')));
 239     }
 240
 241     /**
 242      * Returns the page title
 243      *
 244      * SHOULD overload
 245      *
 246      * @return string page title
 247      */
 248
 249     function title()
 250     {
 251         // TRANS: Page title for a page without a title set.
 252         return _('Untitled page');
 253     }
 254
 255     /**
 256      * Show themed shortcut icon
 257      *
 258      * @return nothing
 259      */
 260     function showShortcutIcon()
 261     {
 262         if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/favicon.ico')) {
 263             $this->element('link', array('rel' => 'shortcut icon',
 264                                          'href' => Theme::path('favicon.ico')));
 265         } else {
 266             // favicon.ico should be HTTPS if the rest of the page is
 267             $this->element('link', array('rel' => 'shortcut icon',
 268                                          'href' => common_path('favicon.ico', StatusNet::isHTTPS())));
 269         }
 270
 271         if (common_config('site', 'mobile')) {
 272             if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/apple-touch-icon.png')) {
 273                 $this->element('link', array('rel' => 'apple-touch-icon',
 274                                              'href' => Theme::path('apple-touch-icon.png')));
 275             } else {
 276                 $this->element('link', array('rel' => 'apple-touch-icon',
 277                                              'href' => common_path('apple-touch-icon.png')));
 278             }
 279         }
 280     }
 281
 282     /**
 283      * Show stylesheets
 284      *
 285      * @return nothing
 286      */
 287     function showStylesheets()
 288     {
 289         if (Event::handle('StartShowStyles', array($this))) {
 290
 291             // Use old name for StatusNet for compatibility on events
 292
 293             if (Event::handle('StartShowStylesheets', array($this))) {
 294                 $this->primaryCssLink(null, 'screen, projection, tv, print');
 295                 Event::handle('EndShowStylesheets', array($this));
 296             }
 297
 298             $this->cssLink('js/extlib/jquery-ui/css/smoothness/jquery-ui.css');
 299
 300             if (Event::handle('StartShowUAStyles', array($this))) {
 301                 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
 302                                'href="'.Theme::path('css/ie.css', 'base').'?version='.GNUSOCIAL_VERSION.'" /><![endif]');
 303                 foreach (array(6,7) as $ver) {
 304                     if (file_exists(Theme::file('css/ie'.$ver.'.css', 'base'))) {
 305                         // Yes, IE people should be put in jail.
 306                         $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
 307                                        'href="'.Theme::path('css/ie'.$ver.'.css', 'base').'?version='.GNUSOCIAL_VERSION.'" /><![endif]');
 308                     }
 309                 }
 310                 if (file_exists(Theme::file('css/ie.css'))) {
 311                     $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
 312                                'href="'.Theme::path('css/ie.css', null).'?version='.GNUSOCIAL_VERSION.'" /><![endif]');
 313                 }
 314                 Event::handle('EndShowUAStyles', array($this));
 315             }
 316
 317             Event::handle('EndShowStyles', array($this));
 318
 319             if (common_config('custom_css', 'enabled')) {
 320                 $css = common_config('custom_css', 'css');
 321                 if (Event::handle('StartShowCustomCss', array($this, &$css))) {
 322                     if (trim($css) != '') {
 323                         $this->style($css);
 324                     }
 325                     Event::handle('EndShowCustomCss', array($this));
 326                 }
 327             }
 328         }
 329     }
 330
 331     function primaryCssLink($mainTheme=null, $media=null)
 332     {
 333         $theme = new Theme($mainTheme);
 334
 335         // Some themes may have external stylesheets, such as using the
 336         // Google Font APIs to load webfonts.
 337         foreach ($theme->getExternals() as $url) {
 338             $this->cssLink($url, $mainTheme, $media);
 339         }
 340
 341         // If the currently-selected theme has dependencies on other themes,
 342         // we'll need to load their display.css files as well in order.
 343         $baseThemes = $theme->getDeps();
 344         foreach ($baseThemes as $baseTheme) {
 345             $this->cssLink('css/display.css', $baseTheme, $media);
 346         }
 347         $this->cssLink('css/display.css', $mainTheme, $media);
 348
 349         // Additional styles for RTL languages
 350         if (is_rtl(common_language())) {
 351             if (file_exists(Theme::file('css/rtl.css'))) {
 352                 $this->cssLink('css/rtl.css', $mainTheme, $media);
 353             }
 354         }
 355     }
 356
 357     /**
 358      * Show javascript headers
 359      *
 360      * @return nothing
 361      */
 362     function showScripts()
 363     {
 364         if (Event::handle('StartShowScripts', array($this))) {
 365             if (Event::handle('StartShowJQueryScripts', array($this))) {
 366                 if (common_config('site', 'minify')) {
 367                     $this->script('extlib/jquery.min.js');
 368                     $this->script('extlib/jquery.form.min.js');
 369                     $this->script('extlib/jquery-ui/jquery-ui.min.js');
 370                     $this->script('extlib/jquery.cookie.min.js');
 371                     $this->inlineScript('if (typeof window.JSON !== "object") { $.getScript("'.common_path('js/extlib/json2.min.js', StatusNet::isHTTPS()).'"); }');
 372                     $this->script('extlib/jquery.infieldlabel.min.js');
 373                 } else {
 374                     $this->script('extlib/jquery.js');
 375                     $this->script('extlib/jquery.form.js');
 376                     $this->script('extlib/jquery-ui/jquery-ui.js');
 377                     $this->script('extlib/jquery.cookie.js');
 378                     $this->inlineScript('if (typeof window.JSON !== "object") { $.getScript("'.common_path('js/extlib/json2.js', StatusNet::isHTTPS()).'"); }');
 379                     $this->script('extlib/jquery.infieldlabel.js');
 380                 }
 381
 382                 Event::handle('EndShowJQueryScripts', array($this));
 383             }
 384             if (Event::handle('StartShowStatusNetScripts', array($this))) {
 385                 if (common_config('site', 'minify')) {
 386                     $this->script('util.min.js');
 387                 } else {
 388                     $this->script('util.js');
 389                     $this->script('xbImportNode.js');
 390                     $this->script('geometa.js');
 391                 }
 392                 // This route isn't available in single-user mode.
 393                 // Not sure why, but it causes errors here.
 394                 $this->inlineScript('var _peopletagAC = "' .
 395                                     common_local_url('peopletagautocomplete') . '";');
 396                 $this->showScriptMessages();
 397                 // Anti-framing code to avoid clickjacking attacks in older browsers.
 398                 // This will show a blank page if the page is being framed, which is
 399                 // consistent with the behavior of the 'X-Frame-Options: SAMEORIGIN'
 400                 // header, which prevents framing in newer browser.
 401                 if (common_config('javascript', 'bustframes')) {
 402                     $this->inlineScript('if (window.top !== window.self) { document.write = ""; window.top.location = window.self.location; setTimeout(function () { document.body.innerHTML = ""; }, 1); window.self.onload = function () { document.body.innerHTML = ""; }; }');
 403                 }
 404                 Event::handle('EndShowStatusNetScripts', array($this));
 405             }
 406             Event::handle('EndShowScripts', array($this));
 407         }
 408     }
 409
 410     /**
 411      * Exports a map of localized text strings to JavaScript code.
 412      *
 413      * Plugins can add to what's exported by hooking the StartScriptMessages or EndScriptMessages
 414      * events and appending to the array. Try to avoid adding strings that won't be used, as
 415      * they'll be added to HTML output.
 416      */
 417     function showScriptMessages()
 418     {
 419         $messages = array();
 420
 421         if (Event::handle('StartScriptMessages', array($this, &$messages))) {
 422             // Common messages needed for timeline views etc...
 423
 424             // TRANS: Localized tooltip for '...' expansion button on overlong remote messages.
 425             $messages['showmore_tooltip'] = _m('TOOLTIP', 'Show more');
 426
 427             // TRANS: Inline reply form submit button: submits a reply comment.
 428             $messages['reply_submit'] = _m('BUTTON', 'Reply');
 429
 430             // TRANS: Placeholder text for inline reply form. Clicking in this box will turn it into a mini notice form.
 431             $messages['reply_placeholder'] = _m('Write a reply...');
 432
 433             $messages = array_merge($messages, $this->getScriptMessages());
 434
 435             Event::handle('EndScriptMessages', array($this, &$messages));
 436         }
 437
 438         if (!empty($messages)) {
 439             $this->inlineScript('SN.messages=' . json_encode($messages));
 440         }
 441
 442         return $messages;
 443     }
 444
 445     /**
 446      * If the action will need localizable text strings, export them here like so:
 447      *
 448      * return array('pool_deepend' => _('Deep end'),
 449      *              'pool_shallow' => _('Shallow end'));
 450      *
 451      * The exported map will be available via SN.msg() to JS code:
 452      *
 453      *   $('#pool').html('<div class="deepend"></div><div class="shallow"></div>');
 454      *   $('#pool .deepend').text(SN.msg('pool_deepend'));
 455      *   $('#pool .shallow').text(SN.msg('pool_shallow'));
 456      *
 457      * Exports a map of localized text strings to JavaScript code.
 458      *
 459      * Plugins can add to what's exported on any action by hooking the StartScriptMessages or
 460      * EndScriptMessages events and appending to the array. Try to avoid adding strings that won't
 461      * be used, as they'll be added to HTML output.
 462      */
 463     function getScriptMessages()
 464     {
 465         return array();
 466     }
 467
 468     /**
 469      * Show OpenSearch headers
 470      *
 471      * @return nothing
 472      */
 473     function showOpenSearch()
 474     {
 475         $this->element('link', array('rel' => 'search',
 476                                      'type' => 'application/opensearchdescription+xml',
 477                                      'href' =>  common_local_url('opensearch', array('type' => 'people')),
 478                                      'title' => common_config('site', 'name').' People Search'));
 479         $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
 480                                      'href' =>  common_local_url('opensearch', array('type' => 'notice')),
 481                                      'title' => common_config('site', 'name').' Notice Search'));
 482     }
 483
 484     /**
 485      * Show feed headers
 486      *
 487      * MAY overload
 488      *
 489      * @return nothing
 490      */
 491     function showFeeds()
 492     {
 493         $feeds = $this->getFeeds();
 494
 495         if ($feeds) {
 496             foreach ($feeds as $feed) {
 497                 $this->element('link', array('rel' => $feed->rel(),
 498                                              'href' => $feed->url,
 499                                              'type' => $feed->mimeType(),
 500                                              'title' => $feed->title));
 501             }
 502         }
 503     }
 504
 505     /**
 506      * Show description.
 507      *
 508      * SHOULD overload
 509      *
 510      * @return nothing
 511      */
 512     function showDescription()
 513     {
 514         // does nothing by default
 515     }
 516
 517     /**
 518      * Show extra stuff in <head>.
 519      *
 520      * MAY overload
 521      *
 522      * @return nothing
 523      */
 524     function extraHead()
 525     {
 526         // does nothing by default
 527     }
 528
 529     /**
 530      * Show body.
 531      *
 532      * Calls template methods
 533      *
 534      * @return nothing
 535      */
 536     function showBody()
 537     {
 538         $this->elementStart('body', (common_current_user()) ? array('id' => strtolower($this->trimmed('action')),
 539                                                                     'class' => 'user_in')
 540                             : array('id' => strtolower($this->trimmed('action'))));
 541         $this->elementStart('div', array('id' => 'wrap'));
 542         if (Event::handle('StartShowHeader', array($this))) {
 543             $this->showHeader();
 544             $this->flush();
 545             Event::handle('EndShowHeader', array($this));
 546         }
 547         $this->showCore();
 548         $this->flush();
 549         if (Event::handle('StartShowFooter', array($this))) {
 550             $this->showFooter();
 551             $this->flush();
 552             Event::handle('EndShowFooter', array($this));
 553         }
 554         $this->elementEnd('div');
 555         $this->showScripts();
 556         $this->elementEnd('body');
 557     }
 558
 559     /**
 560      * Show header of the page.
 561      *
 562      * Calls template methods
 563      *
 564      * @return nothing
 565      */
 566     function showHeader()
 567     {
 568         $this->elementStart('div', array('id' => 'header'));
 569         $this->showLogo();
 570         $this->showPrimaryNav();
 571         if (Event::handle('StartShowSiteNotice', array($this))) {
 572             $this->showSiteNotice();
 573
 574             Event::handle('EndShowSiteNotice', array($this));
 575         }
 576
 577         $this->elementEnd('div');
 578     }
 579
 580     /**
 581      * Show configured logo.
 582      *
 583      * @return nothing
 584      */
 585     function showLogo()
 586     {
 587         $this->elementStart('address', array('id' => 'site_contact',
 588                                              'class' => 'vcard'));
 589         if (Event::handle('StartAddressData', array($this))) {
 590             if (common_config('singleuser', 'enabled')) {
 591                 $user = User::singleUser();
 592                 $url = common_local_url('showstream',
 593                                         array('nickname' => $user->nickname));
 594             } else if (common_logged_in()) {
 595                 $cur = common_current_user();
 596                 $url = common_local_url('all', array('nickname' => $cur->nickname));
 597             } else {
 598                 $url = common_local_url('public');
 599             }
 600
 601             $this->elementStart('a', array('class' => 'url home bookmark',
 602                                            'href' => $url));
 603
 604             if (StatusNet::isHTTPS()) {
 605                 $logoUrl = common_config('site', 'ssllogo');
 606                 if (empty($logoUrl)) {
 607                     // if logo is an uploaded file, try to fall back to HTTPS file URL
 608                     $httpUrl = common_config('site', 'logo');
 609                     if (!empty($httpUrl)) {
 610                         $f = File::getKV('url', $httpUrl);
 611                         if (!empty($f) && !empty($f->filename)) {
 612                             // this will handle the HTTPS case
 613                             $logoUrl = File::url($f->filename);
 614                         }
 615                     }
 616                 }
 617             } else {
 618                 $logoUrl = common_config('site', 'logo');
 619             }
 620
 621             if (empty($logoUrl) && file_exists(Theme::file('logo.png'))) {
 622                 // This should handle the HTTPS case internally
 623                 $logoUrl = Theme::path('logo.png');
 624             }
 625
 626             if (!empty($logoUrl)) {
 627                 $this->element('img', array('class' => 'logo photo',
 628                                             'src' => $logoUrl,
 629                                             'alt' => common_config('site', 'name')));
 630             }
 631
 632             $this->text(' ');
 633             $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
 634             $this->elementEnd('a');
 635
 636             Event::handle('EndAddressData', array($this));
 637         }
 638         $this->elementEnd('address');
 639     }
 640
 641     /**
 642      * Show primary navigation.
 643      *
 644      * @return nothing
 645      */
 646     function showPrimaryNav()
 647     {
 648         $this->elementStart('div', array('id' => 'site_nav_global_primary'));
 649
 650         $user = common_current_user();
 651
 652         if (!empty($user) || !common_config('site', 'private')) {
 653             $form = new SearchForm($this);
 654             $form->show();
 655         }
 656
 657         $pn = new PrimaryNav($this);
 658         $pn->show();
 659         $this->elementEnd('div');
 660     }
 661
 662     /**
 663      * Show site notice.
 664      *
 665      * @return nothing
 666      */
 667     function showSiteNotice()
 668     {
 669         // Revist. Should probably do an hAtom pattern here
 670         $text = common_config('site', 'notice');
 671         if ($text) {
 672             $this->elementStart('div', array('id' => 'site_notice',
 673                                             'class' => 'system_notice'));
 674             $this->raw($text);
 675             $this->elementEnd('div');
 676         }
 677     }
 678
 679     /**
 680      * Show notice form.
 681      *
 682      * MAY overload if no notice form needed... or direct message box????
 683      *
 684      * @return nothing
 685      */
 686     function showNoticeForm()
 687     {
 688         // TRANS: Tab on the notice form.
 689         $tabs = array('status' => _m('TAB','Status'));
 690
 691         $this->elementStart('div', 'input_forms');
 692
 693         if (Event::handle('StartShowEntryForms', array(&$tabs))) {
 694             $this->elementStart('ul', array('class' => 'nav',
 695                                             'id' => 'input_form_nav'));
 696
 697             foreach ($tabs as $tag => $title) {
 698                 $attrs = array('id' => 'input_form_nav_'.$tag,
 699                                'class' => 'input_form_nav_tab');
 700
 701                 if ($tag == 'status') {
 702                     // We're actually showing the placeholder form,
 703                     // but we special-case the 'Status' tab as if
 704                     // it were a small version of it.
 705                     $attrs['class'] .= ' current';
 706                 }
 707                 $this->elementStart('li', $attrs);
 708
 709                 $this->element('a',
 710                                array('href' => 'javascript:SN.U.switchInputFormTab("'.$tag.'")'),
 711                                $title);
 712                 $this->elementEnd('li');
 713             }
 714
 715             $this->elementEnd('ul');
 716
 717             $attrs = array('class' => 'input_form current',
 718                            'id' => 'input_form_placeholder');
 719             $this->elementStart('div', $attrs);
 720             $form = new NoticePlaceholderForm($this);
 721             $form->show();
 722             $this->elementEnd('div');
 723
 724             foreach ($tabs as $tag => $title) {
 725                 $attrs = array('class' => 'input_form',
 726                                'id' => 'input_form_'.$tag);
 727
 728                 $this->elementStart('div', $attrs);
 729
 730                 $form = null;
 731
 732                 if (Event::handle('StartMakeEntryForm', array($tag, $this, &$form))) {
 733                     if ($tag == 'status') {
 734                         $options = $this->noticeFormOptions();
 735                         $form = new NoticeForm($this, $options);
 736                     }
 737                     Event::handle('EndMakeEntryForm', array($tag, $this, $form));
 738                 }
 739
 740                 if (!empty($form)) {
 741                     $form->show();
 742                 }
 743
 744                 $this->elementEnd('div');
 745             }
 746         }
 747
 748         $this->elementEnd('div');
 749     }
 750
 751     function noticeFormOptions()
 752     {
 753         return array();
 754     }
 755
 756     /**
 757      * Show anonymous message.
 758      *
 759      * SHOULD overload
 760      *
 761      * @return nothing
 762      */
 763     function showAnonymousMessage()
 764     {
 765         // needs to be defined by the class
 766     }
 767
 768     /**
 769      * Show core.
 770      *
 771      * Shows local navigation, content block and aside.
 772      *
 773      * @return nothing
 774      */
 775     function showCore()
 776     {
 777         $this->elementStart('div', array('id' => 'core'));
 778         $this->elementStart('div', array('id' => 'aside_primary_wrapper'));
 779         $this->elementStart('div', array('id' => 'content_wrapper'));
 780         $this->elementStart('div', array('id' => 'site_nav_local_views_wrapper'));
 781         if (Event::handle('StartShowLocalNavBlock', array($this))) {
 782             $this->showLocalNavBlock();
 783             $this->flush();
 784             Event::handle('EndShowLocalNavBlock', array($this));
 785         }
 786         if (Event::handle('StartShowContentBlock', array($this))) {
 787             $this->showContentBlock();
 788             $this->flush();
 789             Event::handle('EndShowContentBlock', array($this));
 790         }
 791         if (Event::handle('StartShowAside', array($this))) {
 792             $this->showAside();
 793             $this->flush();
 794             Event::handle('EndShowAside', array($this));
 795         }
 796         $this->elementEnd('div');
 797         $this->elementEnd('div');
 798         $this->elementEnd('div');
 799         $this->elementEnd('div');
 800     }
 801
 802     /**
 803      * Show local navigation block.
 804      *
 805      * @return nothing
 806      */
 807     function showLocalNavBlock()
 808     {
 809         // Need to have this ID for CSS; I'm too lazy to add it to
 810         // all menus
 811         $this->elementStart('div', array('id' => 'site_nav_local_views'));
 812         // Cheat cheat cheat!
 813         $this->showLocalNav();
 814         $this->elementEnd('div');
 815     }
 816
 817     /**
 818      * If there's a logged-in user, show a bit of login context
 819      *
 820      * @return nothing
 821      */
 822     function showProfileBlock()
 823     {
 824         if (common_logged_in()) {
 825             $block = new DefaultProfileBlock($this);
 826             $block->show();
 827         }
 828     }
 829
 830     /**
 831      * Show local navigation.
 832      *
 833      * SHOULD overload
 834      *
 835      * @return nothing
 836      */
 837     function showLocalNav()
 838     {
 839         $nav = new DefaultLocalNav($this);
 840         $nav->show();
 841     }
 842
 843     /**
 844      * Show menu for an object (group, profile)
 845      *
 846      * This block will only show if a subclass has overridden
 847      * the showObjectNav() method.
 848      *
 849      * @return nothing
 850      */
 851     function showObjectNavBlock()
 852     {
 853         $rmethod = new ReflectionMethod($this, 'showObjectNav');
 854         $dclass = $rmethod->getDeclaringClass()->getName();
 855
 856         if ($dclass != 'Action') {
 857             // Need to have this ID for CSS; I'm too lazy to add it to
 858             // all menus
 859             $this->elementStart('div', array('id' => 'site_nav_object',
 860                                              'class' => 'section'));
 861             $this->showObjectNav();
 862             $this->elementEnd('div');
 863         }
 864     }
 865
 866     /**
 867      * Show object navigation.
 868      *
 869      * If there are things to do with this object, show it here.
 870      *
 871      * @return nothing
 872      */
 873     function showObjectNav()
 874     {
 875         /* Nothing here. */
 876     }
 877
 878     /**
 879      * Show content block.
 880      *
 881      * @return nothing
 882      */
 883     function showContentBlock()
 884     {
 885         $this->elementStart('div', array('id' => 'content'));
 886         if (common_logged_in()) {
 887             if (Event::handle('StartShowNoticeForm', array($this))) {
 888                 $this->showNoticeForm();
 889                 Event::handle('EndShowNoticeForm', array($this));
 890             }
 891         }
 892         if (Event::handle('StartShowPageTitle', array($this))) {
 893             $this->showPageTitle();
 894             Event::handle('EndShowPageTitle', array($this));
 895         }
 896         $this->showPageNoticeBlock();
 897         $this->elementStart('div', array('id' => 'content_inner'));
 898         // show the actual content (forms, lists, whatever)
 899         $this->showContent();
 900         $this->elementEnd('div');
 901         $this->elementEnd('div');
 902     }
 903
 904     /**
 905      * Show page title.
 906      *
 907      * @return nothing
 908      */
 909     function showPageTitle()
 910     {
 911         $this->element('h1', null, $this->title());
 912     }
 913
 914     /**
 915      * Show page notice block.
 916      *
 917      * Only show the block if a subclassed action has overrided
 918      * Action::showPageNotice(), or an event handler is registered for
 919      * the StartShowPageNotice event, in which case we assume the
 920      * 'page_notice' definition list is desired.  This is to prevent
 921      * empty 'page_notice' definition lists from being output everywhere.
 922      *
 923      * @return nothing
 924      */
 925     function showPageNoticeBlock()
 926     {
 927         $rmethod = new ReflectionMethod($this, 'showPageNotice');
 928         $dclass = $rmethod->getDeclaringClass()->getName();
 929
 930         if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
 931
 932             $this->elementStart('div', array('id' => 'page_notice',
 933                                             'class' => 'system_notice'));
 934             if (Event::handle('StartShowPageNotice', array($this))) {
 935                 $this->showPageNotice();
 936                 Event::handle('EndShowPageNotice', array($this));
 937             }
 938             $this->elementEnd('div');
 939         }
 940     }
 941
 942     /**
 943      * Show page notice.
 944      *
 945      * SHOULD overload (unless there's not a notice)
 946      *
 947      * @return nothing
 948      */
 949     function showPageNotice()
 950     {
 951     }
 952
 953     /**
 954      * Show content.
 955      *
 956      * MUST overload (unless there's not a notice)
 957      *
 958      * @return nothing
 959      */
 960     function showContent()
 961     {
 962     }
 963
 964     /**
 965      * Show Aside.
 966      *
 967      * @return nothing
 968      */
 969     function showAside()
 970     {
 971         $this->elementStart('div', array('id' => 'aside_primary',
 972                                          'class' => 'aside'));
 973         $this->showProfileBlock();
 974         if (Event::handle('StartShowObjectNavBlock', array($this))) {
 975             $this->showObjectNavBlock();
 976             Event::handle('EndShowObjectNavBlock', array($this));
 977         }
 978         if (Event::handle('StartShowSections', array($this))) {
 979             $this->showSections();
 980             Event::handle('EndShowSections', array($this));
 981         }
 982         if (Event::handle('StartShowExportData', array($this))) {
 983             $this->showExportData();
 984             Event::handle('EndShowExportData', array($this));
 985         }
 986         $this->elementEnd('div');
 987     }
 988
 989     /**
 990      * Show export data feeds.
 991      *
 992      * @return void
 993      */
 994     function showExportData()
 995     {
 996         $feeds = $this->getFeeds();
 997         if ($feeds) {
 998             $fl = new FeedList($this);
 999             $fl->show($feeds);
1000         }
1001     }
1002
1003     /**
1004      * Show sections.
1005      *
1006      * SHOULD overload
1007      *
1008      * @return nothing
1009      */
1010     function showSections()
1011     {
1012         // for each section, show it
1013     }
1014
1015     /**
1016      * Show footer.
1017      *
1018      * @return nothing
1019      */
1020     function showFooter()
1021     {
1022         $this->elementStart('div', array('id' => 'footer'));
1023         if (Event::handle('StartShowInsideFooter', array($this))) {
1024             $this->showSecondaryNav();
1025             $this->showLicenses();
1026             Event::handle('EndShowInsideFooter', array($this));
1027         }
1028         $this->elementEnd('div');
1029     }
1030
1031     /**
1032      * Show secondary navigation.
1033      *
1034      * @return nothing
1035      */
1036     function showSecondaryNav()
1037     {
1038         $sn = new SecondaryNav($this);
1039         $sn->show();
1040     }
1041
1042     /**
1043      * Show licenses.
1044      *
1045      * @return nothing
1046      */
1047     function showLicenses()
1048     {
1049         $this->showGNUsocialLicense();
1050         $this->showContentLicense();
1051     }
1052
1053     /**
1054      * Show GNU social license.
1055      *
1056      * @return nothing
1057      */
1058     function showGNUsocialLicense()
1059     {
1060         if (common_config('site', 'broughtby')) {
1061             // TRANS: First sentence of the GNU social site license. Used if 'broughtby' is set.
1062             // TRANS: Text between [] is a link description, text between () is the link itself.
1063             // TRANS: Make sure there is no whitespace between "]" and "(".
1064             // TRANS: "%%site.broughtby%%" is the value of the variable site.broughtby
1065             $instr = _('**%%site.name%%** is a social network, courtesy of [%%site.broughtby%%](%%site.broughtbyurl%%).');
1066         } else {
1067             // TRANS: First sentence of the GNU social site license. Used if 'broughtby' is not set.
1068             $instr = _('**%%site.name%%** is a social network.');
1069         }
1070         $instr .= ' ';
1071         // TRANS: Second sentence of the GNU social site license. Mentions the GNU social source code license.
1072         // TRANS: Make sure there is no whitespace between "]" and "(".
1073         // TRANS: [%1$s](%2$s) is a link description followed by the link itself
1074         // TRANS: %3$s is the version of GNU social that is being used.
1075         $instr .= sprintf(_('It runs on [%1$s](%2$s), version %3$s, available under the [GNU Affero General Public License](http://www.fsf.org/licensing/licenses/agpl-3.0.html).'), GNUSOCIAL_ENGINE, GNUSOCIAL_ENGINE_URL, GNUSOCIAL_VERSION);
1076         $output = common_markup_to_html($instr);
1077         $this->raw($output);
1078         // do it
1079     }
1080
1081     /**
1082      * Show content license.
1083      *
1084      * @return nothing
1085      */
1086     function showContentLicense()
1087     {
1088         if (Event::handle('StartShowContentLicense', array($this))) {
1089             switch (common_config('license', 'type')) {
1090             case 'private':
1091                 // TRANS: Content license displayed when license is set to 'private'.
1092                 // TRANS: %1$s is the site name.
1093                 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
1094                                                   common_config('site', 'name')));
1095                 // fall through
1096             case 'allrightsreserved':
1097                 if (common_config('license', 'owner')) {
1098                     // TRANS: Content license displayed when license is set to 'allrightsreserved'.
1099                     // TRANS: %1$s is the copyright owner.
1100                     $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
1101                                                       common_config('license', 'owner')));
1102                 } else {
1103                     // TRANS: Content license displayed when license is set to 'allrightsreserved' and no owner is set.
1104                     $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
1105                 }
1106                 break;
1107             case 'cc': // fall through
1108             default:
1109                 $this->elementStart('p');
1110
1111                 $image    = common_config('license', 'image');
1112                 $sslimage = common_config('license', 'sslimage');
1113
1114                 if (StatusNet::isHTTPS()) {
1115                     if (!empty($sslimage)) {
1116                         $url = $sslimage;
1117                     } else if (preg_match('#^http://i.creativecommons.org/#', $image)) {
1118                         // CC support HTTPS on their images
1119                         $url = preg_replace('/^http/', 'https', $image);
1120                     } else {
1121                         // Better to show mixed content than no content
1122                         $url = $image;
1123                     }
1124                 } else {
1125                     $url = $image;
1126                 }
1127
1128                 $this->element('img', array('id' => 'license_cc',
1129                                             'src' => $url,
1130                                             'alt' => common_config('license', 'title'),
1131                                             'width' => '80',
1132                                             'height' => '15'));
1133                 $this->text(' ');
1134                 // TRANS: license message in footer.
1135                 // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
1136                 $notice = _('All %1$s content and data are available under the %2$s license.');
1137                 $link = "<a class=\"license\" rel=\"external license\" href=\"" .
1138                         htmlspecialchars(common_config('license', 'url')) .
1139                         "\">" .
1140                         htmlspecialchars(common_config('license', 'title')) .
1141                         "</a>";
1142                 $this->raw(sprintf(htmlspecialchars($notice),
1143                                    htmlspecialchars(common_config('site', 'name')),
1144                                    $link));
1145                 $this->elementEnd('p');
1146                 break;
1147             }
1148
1149             Event::handle('EndShowContentLicense', array($this));
1150         }
1151     }
1152
1153     /**
1154      * Return last modified, if applicable.
1155      *
1156      * MAY override
1157      *
1158      * @return string last modified http header
1159      */
1160     function lastModified()
1161     {
1162         // For comparison with If-Last-Modified
1163         // If not applicable, return null
1164         return null;
1165     }
1166
1167     /**
1168      * Return etag, if applicable.
1169      *
1170      * MAY override
1171      *
1172      * @return string etag http header
1173      */
1174     function etag()
1175     {
1176         return null;
1177     }
1178
1179     /**
1180      * Return true if read only.
1181      *
1182      * MAY override
1183      *
1184      * @param array $args other arguments
1185      *
1186      * @return boolean is read only action?
1187      */
1188     function isReadOnly($args)
1189     {
1190         return false;
1191     }
1192
1193     /**
1194      * Returns query argument or default value if not found
1195      *
1196      * @param string $key requested argument
1197      * @param string $def default value to return if $key is not provided
1198      *
1199      * @return boolean is read only action?
1200      */
1201     function arg($key, $def=null)
1202     {
1203         if (array_key_exists($key, $this->args)) {
1204             return $this->args[$key];
1205         } else {
1206             return $def;
1207         }
1208     }
1209
1210     /**
1211      * Returns trimmed query argument or default value if not found
1212      *
1213      * @param string $key requested argument
1214      * @param string $def default value to return if $key is not provided
1215      *
1216      * @return boolean is read only action?
1217      */
1218     function trimmed($key, $def=null)
1219     {
1220         $arg = $this->arg($key, $def);
1221         return is_string($arg) ? trim($arg) : $arg;
1222     }
1223
1224     /**
1225      * Handler method
1226      *
1227      * @return boolean is read only action?
1228      */
1229     protected function handle()
1230     {
1231         header('Vary: Accept-Encoding,Cookie');
1232
1233         $lm   = $this->lastModified();
1234         $etag = $this->etag();
1235
1236         if ($etag) {
1237             header('ETag: ' . $etag);
1238         }
1239
1240         if ($lm) {
1241             header('Last-Modified: ' . date(DATE_RFC1123, $lm));
1242             if ($this->isCacheable()) {
1243                 header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1244                 header( "Cache-Control: private, must-revalidate, max-age=0" );
1245                 header( "Pragma:");
1246             }
1247         }
1248
1249         $checked = false;
1250         if ($etag) {
1251             $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
1252               $_SERVER['HTTP_IF_NONE_MATCH'] : null;
1253             if ($if_none_match) {
1254                 // If this check fails, ignore the if-modified-since below.
1255                 $checked = true;
1256                 if ($this->_hasEtag($etag, $if_none_match)) {
1257                     header('HTTP/1.1 304 Not Modified');
1258                     // Better way to do this?
1259                     exit(0);
1260                 }
1261             }
1262         }
1263
1264         if (!$checked && $lm && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
1265             $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
1266             $ims = strtotime($if_modified_since);
1267             if ($lm <= $ims) {
1268                 header('HTTP/1.1 304 Not Modified');
1269                 // Better way to do this?
1270                 exit(0);
1271             }
1272         }
1273     }
1274
1275     /**
1276      * Is this action cacheable?
1277      *
1278      * If the action returns a last-modified
1279      *
1280      * @param array $argarray is ignored since it's now passed in in prepare()
1281      *
1282      * @return boolean is read only action?
1283      */
1284     function isCacheable()
1285     {
1286         return true;
1287     }
1288
1289     /**
1290      * Has etag? (private)
1291      *
1292      * @param string $etag          etag http header
1293      * @param string $if_none_match ifNoneMatch http header
1294      *
1295      * @return boolean
1296      */
1297     function _hasEtag($etag, $if_none_match)
1298     {
1299         $etags = explode(',', $if_none_match);
1300         return in_array($etag, $etags) || in_array('*', $etags);
1301     }
1302
1303     /**
1304      * Boolean understands english (yes, no, true, false)
1305      *
1306      * @param string $key query key we're interested in
1307      * @param string $def default value
1308      *
1309      * @return boolean interprets yes/no strings as boolean
1310      */
1311     function boolean($key, $def=false)
1312     {
1313         $arg = strtolower($this->trimmed($key));
1314
1315         if (is_null($arg)) {
1316             return $def;
1317         } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1318             return true;
1319         } else if (in_array($arg, array('false', 'no', '0'))) {
1320             return false;
1321         } else {
1322             return $def;
1323         }
1324     }
1325
1326     /**
1327      * Integer value of an argument
1328      *
1329      * @param string $key      query key we're interested in
1330      * @param string $defValue optional default value (default null)
1331      * @param string $maxValue optional max value (default null)
1332      * @param string $minValue optional min value (default null)
1333      *
1334      * @return integer integer value
1335      */
1336     function int($key, $defValue=null, $maxValue=null, $minValue=null)
1337     {
1338         $arg = strtolower($this->trimmed($key));
1339
1340         if (is_null($arg) || !is_integer($arg)) {
1341             return $defValue;
1342         }
1343
1344         if (!is_null($maxValue)) {
1345             $arg = min($arg, $maxValue);
1346         }
1347
1348         if (!is_null($minValue)) {
1349             $arg = max($arg, $minValue);
1350         }
1351
1352         return $arg;
1353     }
1354
1355     /**
1356      * Server error
1357      *
1358      * @param string  $msg  error message to display
1359      * @param integer $code http error code, 500 by default
1360      *
1361      * @return nothing
1362      */
1363     function serverError($msg, $code=500, $format=null)
1364     {
1365         if ($format === null) {
1366             $format = $this->format;
1367         }
1368
1369         common_debug("Server error '{$code}' on '{$this->action}': {$msg}", __FILE__);
1370
1371         if (!array_key_exists($code, ServerErrorAction::$status)) {
1372             $code = 500;
1373         }
1374
1375         $status_string = ServerErrorAction::$status[$code];
1376
1377         switch ($format) {
1378         case 'xml':
1379             header("HTTP/1.1 {$code} {$status_string}");
1380             $this->initDocument('xml');
1381             $this->elementStart('hash');
1382             $this->element('error', null, $msg);
1383             $this->element('request', null, $_SERVER['REQUEST_URI']);
1384             $this->elementEnd('hash');
1385             $this->endDocument('xml');
1386             break;
1387         case 'json':
1388             if (!isset($this->callback)) {
1389                 header("HTTP/1.1 {$code} {$status_string}");
1390             }
1391             $this->initDocument('json');
1392             $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
1393             print(json_encode($error_array));
1394             $this->endDocument('json');
1395             break;
1396         default:
1397             throw new ServerException($msg, $code);
1398         }
1399
1400         exit((int)$code);
1401     }
1402
1403     /**
1404      * Client error
1405      *
1406      * @param string  $msg    error message to display
1407      * @param integer $code   http error code, 400 by default
1408      * @param string  $format error format (json, xml, text) for ApiAction
1409      *
1410      * @return nothing
1411      * @throws ClientException always
1412      */
1413     function clientError($msg, $code=400, $format=null)
1414     {
1415         // $format is currently only relevant for an ApiAction anyway
1416         if ($format === null) {
1417             $format = $this->format;
1418         }
1419
1420         common_debug("User error '{$code}' on '{$this->action}': {$msg}", __FILE__);
1421
1422         if (!array_key_exists($code, ClientErrorAction::$status)) {
1423             $code = 400;
1424         }
1425
1426         $status_string = ClientErrorAction::$status[$code];
1427
1428         switch ($format) {
1429         case 'xml':
1430             header("HTTP/1.1 {$code} {$status_string}");
1431             $this->initDocument('xml');
1432             $this->elementStart('hash');
1433             $this->element('error', null, $msg);
1434             $this->element('request', null, $_SERVER['REQUEST_URI']);
1435             $this->elementEnd('hash');
1436             $this->endDocument('xml');
1437             break;
1438         case 'json':
1439             if (!isset($this->callback)) {
1440                 header("HTTP/1.1 {$code} {$status_string}");
1441             }
1442             $this->initDocument('json');
1443             $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
1444             $this->text(json_encode($error_array));
1445             $this->endDocument('json');
1446             break;
1447         case 'text':
1448             header("HTTP/1.1 {$code} {$status_string}");
1449             header('Content-Type: text/plain; charset=utf-8');
1450             echo $msg;
1451             break;
1452         default:
1453             throw new ClientException($msg, $code);
1454         }
1455         exit((int)$code);
1456     }
1457
1458     /**
1459      * If not logged in, take appropriate action (redir or exception)
1460      *
1461      * @param boolean $redir Redirect to login if not logged in
1462      *
1463      * @return boolean true if logged in (never returns if not)
1464      */
1465     public function checkLogin($redir=true)
1466     {
1467         if (common_logged_in()) {
1468             return true;
1469         }
1470
1471         if ($redir==true) {
1472             common_set_returnto($_SERVER['REQUEST_URI']);
1473             common_redirect(common_local_url('login'));
1474         }
1475
1476         // TRANS: Error message displayed when trying to perform an action that requires a logged in user.
1477         $this->clientError(_('Not logged in.'), 403);
1478     }
1479
1480     /**
1481      * Returns the current URL
1482      *
1483      * @return string current URL
1484      */
1485     function selfUrl()
1486     {
1487         list($action, $args) = $this->returnToArgs();
1488         return common_local_url($action, $args);
1489     }
1490
1491     /**
1492      * Returns arguments sufficient for re-constructing URL
1493      *
1494      * @return array two elements: action, other args
1495      */
1496     function returnToArgs()
1497     {
1498         $action = $this->trimmed('action');
1499         $args   = $this->args;
1500         unset($args['action']);
1501         if (common_config('site', 'fancy')) {
1502             unset($args['p']);
1503         }
1504         if (array_key_exists('submit', $args)) {
1505             unset($args['submit']);
1506         }
1507         foreach (array_keys($_COOKIE) as $cookie) {
1508             unset($args[$cookie]);
1509         }
1510         return array($action, $args);
1511     }
1512
1513     /**
1514      * Generate a menu item
1515      *
1516      * @param string  $url         menu URL
1517      * @param string  $text        menu name
1518      * @param string  $title       title attribute, null by default
1519      * @param boolean $is_selected current menu item, false by default
1520      * @param string  $id          element id, null by default
1521      *
1522      * @return nothing
1523      */
1524     function menuItem($url, $text, $title=null, $is_selected=false, $id=null, $class=null)
1525     {
1526         // Added @id to li for some control.
1527         // XXX: We might want to move this to htmloutputter.php
1528         $lattrs  = array();
1529         $classes = array();
1530         if ($class !== null) {
1531             $classes[] = trim($class);
1532         }
1533         if ($is_selected) {
1534             $classes[] = 'current';
1535         }
1536
1537         if (!empty($classes)) {
1538             $lattrs['class'] = implode(' ', $classes);
1539         }
1540
1541         if (!is_null($id)) {
1542             $lattrs['id'] = $id;
1543         }
1544
1545         $this->elementStart('li', $lattrs);
1546         $attrs['href'] = $url;
1547         if ($title) {
1548             $attrs['title'] = $title;
1549         }
1550         $this->element('a', $attrs, $text);
1551         $this->elementEnd('li');
1552     }
1553
1554     /**
1555      * Generate pagination links
1556      *
1557      * @param boolean $have_before is there something before?
1558      * @param boolean $have_after  is there something after?
1559      * @param integer $page        current page
1560      * @param string  $action      current action
1561      * @param array   $args        rest of query arguments
1562      *
1563      * @return nothing
1564      */
1565     // XXX: The messages in this pagination method only tailor to navigating
1566     //      notices. In other lists, "Previous"/"Next" type navigation is
1567     //      desirable, but not available.
1568     function pagination($have_before, $have_after, $page, $action, $args=null)
1569     {
1570         // Does a little before-after block for next/prev page
1571         if ($have_before || $have_after) {
1572             $this->elementStart('ul', array('class' => 'nav',
1573                                             'id' => 'pagination'));
1574         }
1575         if ($have_before) {
1576             $pargs   = array('page' => $page-1);
1577             $this->elementStart('li', array('class' => 'nav_prev'));
1578             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1579                                       'rel' => 'prev'),
1580                            // TRANS: Pagination message to go to a page displaying information more in the
1581                            // TRANS: present than the currently displayed information.
1582                            _('After'));
1583             $this->elementEnd('li');
1584         }
1585         if ($have_after) {
1586             $pargs   = array('page' => $page+1);
1587             $this->elementStart('li', array('class' => 'nav_next'));
1588             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1589                                       'rel' => 'next'),
1590                            // TRANS: Pagination message to go to a page displaying information more in the
1591                            // TRANS: past than the currently displayed information.
1592                            _('Before'));
1593             $this->elementEnd('li');
1594         }
1595         if ($have_before || $have_after) {
1596             $this->elementEnd('ul');
1597         }
1598     }
1599
1600     /**
1601      * An array of feeds for this action.
1602      *
1603      * Returns an array of potential feeds for this action.
1604      *
1605      * @return array Feed object to show in head and links
1606      */
1607     function getFeeds()
1608     {
1609         return null;
1610     }
1611
1612     /**
1613      * Check the session token.
1614      *
1615      * Checks that the current form has the correct session token,
1616      * and throw an exception if it does not.
1617      *
1618      * @return void
1619      */
1620     // XXX: Finding this type of check with the same message about 50 times.
1621     //      Possible to refactor?
1622     function checkSessionToken()
1623     {
1624         // CSRF protection
1625         $token = $this->trimmed('token');
1626         if (empty($token) || $token != common_session_token()) {
1627             // TRANS: Client error text when there is a problem with the session token.
1628             $this->clientError(_('There was a problem with your session token.'));
1629         }
1630     }
1631
1632     /**
1633      * Check if the current request is a POST
1634      *
1635      * @return boolean true if POST; otherwise false.
1636      */
1637
1638     function isPost()
1639     {
1640         return ($_SERVER['REQUEST_METHOD'] == 'POST');
1641     }
1642 }