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         $status = $this->prepare($args);
 121         if ($status) {
 122             $this->handle($args);
 123         } else {
 124             common_debug('Prepare failed for Action.');
 125         }
 126
 127         $this->flush();
 128
 129         Event::handle('EndActionExecute', array($status, $this));
 130     }
 131
 132     /**
 133      * For initializing members of the class.
 134      *
 135      * @param array $argarray misc. arguments
 136      *
 137      * @return boolean true
 138      */
 139     protected function prepare(array $args=array())
 140     {
 141         if ($this->needPost && !$this->isPost()) {
 142             // TRANS: Client error. POST is a HTTP command. It should not be translated.
 143             $this->clientError(_('This method requires a POST.'), 405);
 144         }
 145
 146         $this->args = common_copy_args($args);
 147
 148         $this->action = $this->trimmed('action');
 149
 150         if ($this->ajax || $this->boolean('ajax')) {
 151             // check with StatusNet::isAjax()
 152             StatusNet::setAjax(true);
 153         }
 154
 155         if ($this->needLogin) {
 156             $this->checkLogin(); // if not logged in, this redirs/excepts
 157         }
 158
 159         $this->updateScopedProfile();
 160
 161         return true;
 162     }
 163
 164     function updateScopedProfile() {
 165         $this->scoped = Profile::current();
 166         return $this->scoped;
 167     }
 168
 169     public function getActionName()
 170     {
 171         return $this->action;
 172     }
 173
 174     /**
 175      * Show page, a template method.
 176      *
 177      * @return nothing
 178      */
 179     function showPage()
 180     {
 181         if (Event::handle('StartShowHTML', array($this))) {
 182             $this->startHTML();
 183             $this->flush();
 184             Event::handle('EndShowHTML', array($this));
 185         }
 186         if (Event::handle('StartShowHead', array($this))) {
 187             $this->showHead();
 188             $this->flush();
 189             Event::handle('EndShowHead', array($this));
 190         }
 191         if (Event::handle('StartShowBody', array($this))) {
 192             $this->showBody();
 193             Event::handle('EndShowBody', array($this));
 194         }
 195         if (Event::handle('StartEndHTML', array($this))) {
 196             $this->endHTML();
 197             Event::handle('EndEndHTML', array($this));
 198         }
 199     }
 200
 201     function endHTML()
 202     {
 203         global $_startTime;
 204
 205         if (isset($_startTime)) {
 206             $endTime = microtime(true);
 207             $diff = round(($endTime - $_startTime) * 1000);
 208             $this->raw("<!-- ${diff}ms -->");
 209         }
 210
 211         return parent::endHTML();
 212     }
 213
 214     /**
 215      * Show head, a template method.
 216      *
 217      * @return nothing
 218      */
 219     function showHead()
 220     {
 221         // XXX: attributes (profile?)
 222         $this->elementStart('head');
 223         if (Event::handle('StartShowHeadElements', array($this))) {
 224             if (Event::handle('StartShowHeadTitle', array($this))) {
 225                 $this->showTitle();
 226                 Event::handle('EndShowHeadTitle', array($this));
 227             }
 228             $this->showShortcutIcon();
 229             $this->showStylesheets();
 230             $this->showOpenSearch();
 231             $this->showFeeds();
 232             $this->showDescription();
 233             $this->extraHead();
 234             Event::handle('EndShowHeadElements', array($this));
 235         }
 236         $this->elementEnd('head');
 237     }
 238
 239     /**
 240      * Show title, a template method.
 241      *
 242      * @return nothing
 243      */
 244     function showTitle()
 245     {
 246         $this->element('title', null,
 247                        // TRANS: Page title. %1$s is the title, %2$s is the site name.
 248                        sprintf(_('%1$s - %2$s'),
 249                                $this->title(),
 250                                common_config('site', 'name')));
 251     }
 252
 253     /**
 254      * Returns the page title
 255      *
 256      * SHOULD overload
 257      *
 258      * @return string page title
 259      */
 260
 261     function title()
 262     {
 263         // TRANS: Page title for a page without a title set.
 264         return _('Untitled page');
 265     }
 266
 267     /**
 268      * Show themed shortcut icon
 269      *
 270      * @return nothing
 271      */
 272     function showShortcutIcon()
 273     {
 274         if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/favicon.ico')) {
 275             $this->element('link', array('rel' => 'shortcut icon',
 276                                          'href' => Theme::path('favicon.ico')));
 277         } else {
 278             // favicon.ico should be HTTPS if the rest of the page is
 279             $this->element('link', array('rel' => 'shortcut icon',
 280                                          'href' => common_path('favicon.ico', StatusNet::isHTTPS())));
 281         }
 282
 283         if (common_config('site', 'mobile')) {
 284             if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/apple-touch-icon.png')) {
 285                 $this->element('link', array('rel' => 'apple-touch-icon',
 286                                              'href' => Theme::path('apple-touch-icon.png')));
 287             } else {
 288                 $this->element('link', array('rel' => 'apple-touch-icon',
 289                                              'href' => common_path('apple-touch-icon.png')));
 290             }
 291         }
 292     }
 293
 294     /**
 295      * Show stylesheets
 296      *
 297      * @return nothing
 298      */
 299     function showStylesheets()
 300     {
 301         if (Event::handle('StartShowStyles', array($this))) {
 302
 303             // Use old name for StatusNet for compatibility on events
 304
 305             if (Event::handle('StartShowStylesheets', array($this))) {
 306                 $this->primaryCssLink(null, 'screen, projection, tv, print');
 307                 Event::handle('EndShowStylesheets', array($this));
 308             }
 309
 310             $this->cssLink('js/extlib/jquery-ui/css/smoothness/jquery-ui.css');
 311
 312             if (Event::handle('StartShowUAStyles', array($this))) {
 313                 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
 314                                'href="'.Theme::path('css/ie.css', 'base').'?version='.GNUSOCIAL_VERSION.'" /><![endif]');
 315                 foreach (array(6,7) as $ver) {
 316                     if (file_exists(Theme::file('css/ie'.$ver.'.css', 'base'))) {
 317                         // Yes, IE people should be put in jail.
 318                         $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
 319                                        'href="'.Theme::path('css/ie'.$ver.'.css', 'base').'?version='.GNUSOCIAL_VERSION.'" /><![endif]');
 320                     }
 321                 }
 322                 if (file_exists(Theme::file('css/ie.css'))) {
 323                     $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
 324                                'href="'.Theme::path('css/ie.css', null).'?version='.GNUSOCIAL_VERSION.'" /><![endif]');
 325                 }
 326                 Event::handle('EndShowUAStyles', array($this));
 327             }
 328
 329             Event::handle('EndShowStyles', array($this));
 330
 331             if (common_config('custom_css', 'enabled')) {
 332                 $css = common_config('custom_css', 'css');
 333                 if (Event::handle('StartShowCustomCss', array($this, &$css))) {
 334                     if (trim($css) != '') {
 335                         $this->style($css);
 336                     }
 337                     Event::handle('EndShowCustomCss', array($this));
 338                 }
 339             }
 340         }
 341     }
 342
 343     function primaryCssLink($mainTheme=null, $media=null)
 344     {
 345         $theme = new Theme($mainTheme);
 346
 347         // Some themes may have external stylesheets, such as using the
 348         // Google Font APIs to load webfonts.
 349         foreach ($theme->getExternals() as $url) {
 350             $this->cssLink($url, $mainTheme, $media);
 351         }
 352
 353         // If the currently-selected theme has dependencies on other themes,
 354         // we'll need to load their display.css files as well in order.
 355         $baseThemes = $theme->getDeps();
 356         foreach ($baseThemes as $baseTheme) {
 357             $this->cssLink('css/display.css', $baseTheme, $media);
 358         }
 359         $this->cssLink('css/display.css', $mainTheme, $media);
 360
 361         // Additional styles for RTL languages
 362         if (is_rtl(common_language())) {
 363             if (file_exists(Theme::file('css/rtl.css'))) {
 364                 $this->cssLink('css/rtl.css', $mainTheme, $media);
 365             }
 366         }
 367     }
 368
 369     /**
 370      * Show javascript headers
 371      *
 372      * @return nothing
 373      */
 374     function showScripts()
 375     {
 376         if (Event::handle('StartShowScripts', array($this))) {
 377             if (Event::handle('StartShowJQueryScripts', array($this))) {
 378                 $this->script('extlib/jquery.js');
 379                 $this->script('extlib/jquery.form.js');
 380                 $this->script('extlib/jquery-ui/jquery-ui.js');
 381                 $this->script('extlib/jquery.cookie.js');
 382                 $this->inlineScript('if (typeof window.JSON !== "object") { $.getScript("'.common_path('js/extlib/json2.js', StatusNet::isHTTPS()).'"); }');
 383                 $this->script('extlib/jquery.infieldlabel.js');
 384
 385                 Event::handle('EndShowJQueryScripts', array($this));
 386             }
 387             if (Event::handle('StartShowStatusNetScripts', array($this))) {
 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' => array('title' => _m('TAB','Status'),
 690                                         'href'  => common_local_url('newnotice')));
 691
 692         $this->elementStart('div', 'input_forms');
 693
 694         if (Event::handle('StartShowEntryForms', array(&$tabs))) {
 695             $this->elementStart('ul', array('class' => 'nav',
 696                                             'id' => 'input_form_nav'));
 697
 698             foreach ($tabs as $tag => $data) {
 699                 $tag = htmlspecialchars($tag);
 700                 $attrs = array('id' => 'input_form_nav_'.$tag,
 701                                'class' => 'input_form_nav_tab');
 702
 703                 if ($tag == 'status') {
 704                     // We're actually showing the placeholder form,
 705                     // but we special-case the 'Status' tab as if
 706                     // it were a small version of it.
 707                     $attrs['class'] .= ' current';
 708                 }
 709                 $this->elementStart('li', $attrs);
 710
 711                 $this->element('a',
 712                                array('onclick' => 'return SN.U.switchInputFormTab("'.$tag.'");',
 713                                      'href' => $data['href']),
 714                                $data['title']);
 715                 $this->elementEnd('li');
 716             }
 717
 718             $this->elementEnd('ul');
 719
 720             $attrs = array('class' => 'input_form current',
 721                            'id' => 'input_form_placeholder');
 722             $this->elementStart('div', $attrs);
 723             $form = new NoticePlaceholderForm($this);
 724             $form->show();
 725             $this->elementEnd('div');
 726
 727             foreach ($tabs as $tag => $data) {
 728                 $attrs = array('class' => 'input_form',
 729                                'id' => 'input_form_'.$tag);
 730
 731                 $this->elementStart('div', $attrs);
 732
 733                 $form = null;
 734
 735                 if (Event::handle('StartMakeEntryForm', array($tag, $this, &$form))) {
 736                     if ($tag == 'status') {
 737                         $options = $this->noticeFormOptions();
 738                         $form = new NoticeForm($this, $options);
 739                     }
 740                     Event::handle('EndMakeEntryForm', array($tag, $this, $form));
 741                 }
 742
 743                 if (!empty($form)) {
 744                     $form->show();
 745                 }
 746
 747                 $this->elementEnd('div');
 748             }
 749         }
 750
 751         $this->elementEnd('div');
 752     }
 753
 754     function noticeFormOptions()
 755     {
 756         return array();
 757     }
 758
 759     /**
 760      * Show anonymous message.
 761      *
 762      * SHOULD overload
 763      *
 764      * @return nothing
 765      */
 766     function showAnonymousMessage()
 767     {
 768         // needs to be defined by the class
 769     }
 770
 771     /**
 772      * Show core.
 773      *
 774      * Shows local navigation, content block and aside.
 775      *
 776      * @return nothing
 777      */
 778     function showCore()
 779     {
 780         $this->elementStart('div', array('id' => 'core'));
 781         $this->elementStart('div', array('id' => 'aside_primary_wrapper'));
 782         $this->elementStart('div', array('id' => 'content_wrapper'));
 783         $this->elementStart('div', array('id' => 'site_nav_local_views_wrapper'));
 784         if (Event::handle('StartShowLocalNavBlock', array($this))) {
 785             $this->showLocalNavBlock();
 786             $this->flush();
 787             Event::handle('EndShowLocalNavBlock', array($this));
 788         }
 789         if (Event::handle('StartShowContentBlock', array($this))) {
 790             $this->showContentBlock();
 791             $this->flush();
 792             Event::handle('EndShowContentBlock', array($this));
 793         }
 794         if (Event::handle('StartShowAside', array($this))) {
 795             $this->showAside();
 796             $this->flush();
 797             Event::handle('EndShowAside', array($this));
 798         }
 799         $this->elementEnd('div');
 800         $this->elementEnd('div');
 801         $this->elementEnd('div');
 802         $this->elementEnd('div');
 803     }
 804
 805     /**
 806      * Show local navigation block.
 807      *
 808      * @return nothing
 809      */
 810     function showLocalNavBlock()
 811     {
 812         // Need to have this ID for CSS; I'm too lazy to add it to
 813         // all menus
 814         $this->elementStart('div', array('id' => 'site_nav_local_views'));
 815         // Cheat cheat cheat!
 816         $this->showLocalNav();
 817         $this->elementEnd('div');
 818     }
 819
 820     /**
 821      * If there's a logged-in user, show a bit of login context
 822      *
 823      * @return nothing
 824      */
 825     function showProfileBlock()
 826     {
 827         if (common_logged_in()) {
 828             $block = new DefaultProfileBlock($this);
 829             $block->show();
 830         }
 831     }
 832
 833     /**
 834      * Show local navigation.
 835      *
 836      * SHOULD overload
 837      *
 838      * @return nothing
 839      */
 840     function showLocalNav()
 841     {
 842         $nav = new DefaultLocalNav($this);
 843         $nav->show();
 844     }
 845
 846     /**
 847      * Show menu for an object (group, profile)
 848      *
 849      * This block will only show if a subclass has overridden
 850      * the showObjectNav() method.
 851      *
 852      * @return nothing
 853      */
 854     function showObjectNavBlock()
 855     {
 856         $rmethod = new ReflectionMethod($this, 'showObjectNav');
 857         $dclass = $rmethod->getDeclaringClass()->getName();
 858
 859         if ($dclass != 'Action') {
 860             // Need to have this ID for CSS; I'm too lazy to add it to
 861             // all menus
 862             $this->elementStart('div', array('id' => 'site_nav_object',
 863                                              'class' => 'section'));
 864             $this->showObjectNav();
 865             $this->elementEnd('div');
 866         }
 867     }
 868
 869     /**
 870      * Show object navigation.
 871      *
 872      * If there are things to do with this object, show it here.
 873      *
 874      * @return nothing
 875      */
 876     function showObjectNav()
 877     {
 878         /* Nothing here. */
 879     }
 880
 881     /**
 882      * Show content block.
 883      *
 884      * @return nothing
 885      */
 886     function showContentBlock()
 887     {
 888         $this->elementStart('div', array('id' => 'content'));
 889         if (common_logged_in()) {
 890             if (Event::handle('StartShowNoticeForm', array($this))) {
 891                 $this->showNoticeForm();
 892                 Event::handle('EndShowNoticeForm', array($this));
 893             }
 894         }
 895         if (Event::handle('StartShowPageTitle', array($this))) {
 896             $this->showPageTitle();
 897             Event::handle('EndShowPageTitle', array($this));
 898         }
 899         $this->showPageNoticeBlock();
 900         $this->elementStart('div', array('id' => 'content_inner'));
 901         // show the actual content (forms, lists, whatever)
 902         $this->showContent();
 903         $this->elementEnd('div');
 904         $this->elementEnd('div');
 905     }
 906
 907     /**
 908      * Show page title.
 909      *
 910      * @return nothing
 911      */
 912     function showPageTitle()
 913     {
 914         $this->element('h1', null, $this->title());
 915     }
 916
 917     /**
 918      * Show page notice block.
 919      *
 920      * Only show the block if a subclassed action has overrided
 921      * Action::showPageNotice(), or an event handler is registered for
 922      * the StartShowPageNotice event, in which case we assume the
 923      * 'page_notice' definition list is desired.  This is to prevent
 924      * empty 'page_notice' definition lists from being output everywhere.
 925      *
 926      * @return nothing
 927      */
 928     function showPageNoticeBlock()
 929     {
 930         $rmethod = new ReflectionMethod($this, 'showPageNotice');
 931         $dclass = $rmethod->getDeclaringClass()->getName();
 932
 933         if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
 934
 935             $this->elementStart('div', array('id' => 'page_notice',
 936                                             'class' => 'system_notice'));
 937             if (Event::handle('StartShowPageNotice', array($this))) {
 938                 $this->showPageNotice();
 939                 Event::handle('EndShowPageNotice', array($this));
 940             }
 941             $this->elementEnd('div');
 942         }
 943     }
 944
 945     /**
 946      * Show page notice.
 947      *
 948      * SHOULD overload (unless there's not a notice)
 949      *
 950      * @return nothing
 951      */
 952     function showPageNotice()
 953     {
 954     }
 955
 956     /**
 957      * Show content.
 958      *
 959      * MUST overload (unless there's not a notice)
 960      *
 961      * @return nothing
 962      */
 963     function showContent()
 964     {
 965     }
 966
 967     /**
 968      * Show Aside.
 969      *
 970      * @return nothing
 971      */
 972     function showAside()
 973     {
 974         $this->elementStart('div', array('id' => 'aside_primary',
 975                                          'class' => 'aside'));
 976         $this->showProfileBlock();
 977         if (Event::handle('StartShowObjectNavBlock', array($this))) {
 978             $this->showObjectNavBlock();
 979             Event::handle('EndShowObjectNavBlock', array($this));
 980         }
 981         if (Event::handle('StartShowSections', array($this))) {
 982             $this->showSections();
 983             Event::handle('EndShowSections', array($this));
 984         }
 985         if (Event::handle('StartShowExportData', array($this))) {
 986             $this->showExportData();
 987             Event::handle('EndShowExportData', array($this));
 988         }
 989         $this->elementEnd('div');
 990     }
 991
 992     /**
 993      * Show export data feeds.
 994      *
 995      * @return void
 996      */
 997     function showExportData()
 998     {
 999         $feeds = $this->getFeeds();
1000         if ($feeds) {
1001             $fl = new FeedList($this);
1002             $fl->show($feeds);
1003         }
1004     }
1005
1006     /**
1007      * Show sections.
1008      *
1009      * SHOULD overload
1010      *
1011      * @return nothing
1012      */
1013     function showSections()
1014     {
1015         // for each section, show it
1016     }
1017
1018     /**
1019      * Show footer.
1020      *
1021      * @return nothing
1022      */
1023     function showFooter()
1024     {
1025         $this->elementStart('div', array('id' => 'footer'));
1026         if (Event::handle('StartShowInsideFooter', array($this))) {
1027             $this->showSecondaryNav();
1028             $this->showLicenses();
1029             Event::handle('EndShowInsideFooter', array($this));
1030         }
1031         $this->elementEnd('div');
1032     }
1033
1034     /**
1035      * Show secondary navigation.
1036      *
1037      * @return nothing
1038      */
1039     function showSecondaryNav()
1040     {
1041         $sn = new SecondaryNav($this);
1042         $sn->show();
1043     }
1044
1045     /**
1046      * Show licenses.
1047      *
1048      * @return nothing
1049      */
1050     function showLicenses()
1051     {
1052         $this->showGNUsocialLicense();
1053         $this->showContentLicense();
1054     }
1055
1056     /**
1057      * Show GNU social license.
1058      *
1059      * @return nothing
1060      */
1061     function showGNUsocialLicense()
1062     {
1063         if (common_config('site', 'broughtby')) {
1064             // TRANS: First sentence of the GNU social site license. Used if 'broughtby' is set.
1065             // TRANS: Text between [] is a link description, text between () is the link itself.
1066             // TRANS: Make sure there is no whitespace between "]" and "(".
1067             // TRANS: "%%site.broughtby%%" is the value of the variable site.broughtby
1068             $instr = _('**%%site.name%%** is a social network, courtesy of [%%site.broughtby%%](%%site.broughtbyurl%%).');
1069         } else {
1070             // TRANS: First sentence of the GNU social site license. Used if 'broughtby' is not set.
1071             $instr = _('**%%site.name%%** is a social network.');
1072         }
1073         $instr .= ' ';
1074         // TRANS: Second sentence of the GNU social site license. Mentions the GNU social source code license.
1075         // TRANS: Make sure there is no whitespace between "]" and "(".
1076         // TRANS: [%1$s](%2$s) is a link description followed by the link itself
1077         // TRANS: %3$s is the version of GNU social that is being used.
1078         $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);
1079         $output = common_markup_to_html($instr);
1080         $this->raw($output);
1081         // do it
1082     }
1083
1084     /**
1085      * Show content license.
1086      *
1087      * @return nothing
1088      */
1089     function showContentLicense()
1090     {
1091         if (Event::handle('StartShowContentLicense', array($this))) {
1092             switch (common_config('license', 'type')) {
1093             case 'private':
1094                 // TRANS: Content license displayed when license is set to 'private'.
1095                 // TRANS: %1$s is the site name.
1096                 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
1097                                                   common_config('site', 'name')));
1098                 // fall through
1099             case 'allrightsreserved':
1100                 if (common_config('license', 'owner')) {
1101                     // TRANS: Content license displayed when license is set to 'allrightsreserved'.
1102                     // TRANS: %1$s is the copyright owner.
1103                     $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
1104                                                       common_config('license', 'owner')));
1105                 } else {
1106                     // TRANS: Content license displayed when license is set to 'allrightsreserved' and no owner is set.
1107                     $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
1108                 }
1109                 break;
1110             case 'cc': // fall through
1111             default:
1112                 $this->elementStart('p');
1113
1114                 $image    = common_config('license', 'image');
1115                 $sslimage = common_config('license', 'sslimage');
1116
1117                 if (StatusNet::isHTTPS()) {
1118                     if (!empty($sslimage)) {
1119                         $url = $sslimage;
1120                     } else if (preg_match('#^http://i.creativecommons.org/#', $image)) {
1121                         // CC support HTTPS on their images
1122                         $url = preg_replace('/^http/', 'https', $image);
1123                     } else {
1124                         // Better to show mixed content than no content
1125                         $url = $image;
1126                     }
1127                 } else {
1128                     $url = $image;
1129                 }
1130
1131                 $this->element('img', array('id' => 'license_cc',
1132                                             'src' => $url,
1133                                             'alt' => common_config('license', 'title'),
1134                                             'width' => '80',
1135                                             'height' => '15'));
1136                 $this->text(' ');
1137                 // TRANS: license message in footer.
1138                 // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
1139                 $notice = _('All %1$s content and data are available under the %2$s license.');
1140                 $link = "<a class=\"license\" rel=\"external license\" href=\"" .
1141                         htmlspecialchars(common_config('license', 'url')) .
1142                         "\">" .
1143                         htmlspecialchars(common_config('license', 'title')) .
1144                         "</a>";
1145                 $this->raw(sprintf(htmlspecialchars($notice),
1146                                    htmlspecialchars(common_config('site', 'name')),
1147                                    $link));
1148                 $this->elementEnd('p');
1149                 break;
1150             }
1151
1152             Event::handle('EndShowContentLicense', array($this));
1153         }
1154     }
1155
1156     /**
1157      * Return last modified, if applicable.
1158      *
1159      * MAY override
1160      *
1161      * @return string last modified http header
1162      */
1163     function lastModified()
1164     {
1165         // For comparison with If-Last-Modified
1166         // If not applicable, return null
1167         return null;
1168     }
1169
1170     /**
1171      * Return etag, if applicable.
1172      *
1173      * MAY override
1174      *
1175      * @return string etag http header
1176      */
1177     function etag()
1178     {
1179         return null;
1180     }
1181
1182     /**
1183      * Return true if read only.
1184      *
1185      * MAY override
1186      *
1187      * @param array $args other arguments
1188      *
1189      * @return boolean is read only action?
1190      */
1191     function isReadOnly($args)
1192     {
1193         return false;
1194     }
1195
1196     /**
1197      * Returns query argument or default value if not found
1198      *
1199      * @param string $key requested argument
1200      * @param string $def default value to return if $key is not provided
1201      *
1202      * @return boolean is read only action?
1203      */
1204     function arg($key, $def=null)
1205     {
1206         if (array_key_exists($key, $this->args)) {
1207             return $this->args[$key];
1208         } else {
1209             return $def;
1210         }
1211     }
1212
1213     /**
1214      * Returns trimmed query argument or default value if not found
1215      *
1216      * @param string $key requested argument
1217      * @param string $def default value to return if $key is not provided
1218      *
1219      * @return boolean is read only action?
1220      */
1221     function trimmed($key, $def=null)
1222     {
1223         $arg = $this->arg($key, $def);
1224         return is_string($arg) ? trim($arg) : $arg;
1225     }
1226
1227     /**
1228      * Handler method
1229      *
1230      * @return boolean is read only action?
1231      */
1232     protected function handle()
1233     {
1234         header('Vary: Accept-Encoding,Cookie');
1235
1236         $lm   = $this->lastModified();
1237         $etag = $this->etag();
1238
1239         if ($etag) {
1240             header('ETag: ' . $etag);
1241         }
1242
1243         if ($lm) {
1244             header('Last-Modified: ' . date(DATE_RFC1123, $lm));
1245             if ($this->isCacheable()) {
1246                 header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1247                 header( "Cache-Control: private, must-revalidate, max-age=0" );
1248                 header( "Pragma:");
1249             }
1250         }
1251
1252         $checked = false;
1253         if ($etag) {
1254             $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
1255               $_SERVER['HTTP_IF_NONE_MATCH'] : null;
1256             if ($if_none_match) {
1257                 // If this check fails, ignore the if-modified-since below.
1258                 $checked = true;
1259                 if ($this->_hasEtag($etag, $if_none_match)) {
1260                     header('HTTP/1.1 304 Not Modified');
1261                     // Better way to do this?
1262                     exit(0);
1263                 }
1264             }
1265         }
1266
1267         if (!$checked && $lm && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
1268             $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
1269             $ims = strtotime($if_modified_since);
1270             if ($lm <= $ims) {
1271                 header('HTTP/1.1 304 Not Modified');
1272                 // Better way to do this?
1273                 exit(0);
1274             }
1275         }
1276     }
1277
1278     /**
1279      * Is this action cacheable?
1280      *
1281      * If the action returns a last-modified
1282      *
1283      * @param array $argarray is ignored since it's now passed in in prepare()
1284      *
1285      * @return boolean is read only action?
1286      */
1287     function isCacheable()
1288     {
1289         return true;
1290     }
1291
1292     /**
1293      * Has etag? (private)
1294      *
1295      * @param string $etag          etag http header
1296      * @param string $if_none_match ifNoneMatch http header
1297      *
1298      * @return boolean
1299      */
1300     function _hasEtag($etag, $if_none_match)
1301     {
1302         $etags = explode(',', $if_none_match);
1303         return in_array($etag, $etags) || in_array('*', $etags);
1304     }
1305
1306     /**
1307      * Boolean understands english (yes, no, true, false)
1308      *
1309      * @param string $key query key we're interested in
1310      * @param string $def default value
1311      *
1312      * @return boolean interprets yes/no strings as boolean
1313      */
1314     function boolean($key, $def=false)
1315     {
1316         $arg = strtolower($this->trimmed($key));
1317
1318         if (is_null($arg)) {
1319             return $def;
1320         } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1321             return true;
1322         } else if (in_array($arg, array('false', 'no', '0'))) {
1323             return false;
1324         } else {
1325             return $def;
1326         }
1327     }
1328
1329     /**
1330      * Integer value of an argument
1331      *
1332      * @param string $key      query key we're interested in
1333      * @param string $defValue optional default value (default null)
1334      * @param string $maxValue optional max value (default null)
1335      * @param string $minValue optional min value (default null)
1336      *
1337      * @return integer integer value
1338      */
1339     function int($key, $defValue=null, $maxValue=null, $minValue=null)
1340     {
1341         $arg = intval($this->arg($key));
1342
1343         if (!is_numeric($this->arg($key)) || $arg != $this->arg($key)) {
1344             return $defValue;
1345         }
1346
1347         if (!is_null($maxValue)) {
1348             $arg = min($arg, $maxValue);
1349         }
1350
1351         if (!is_null($minValue)) {
1352             $arg = max($arg, $minValue);
1353         }
1354
1355         return $arg;
1356     }
1357
1358     /**
1359      * Server error
1360      *
1361      * @param string  $msg  error message to display
1362      * @param integer $code http error code, 500 by default
1363      *
1364      * @return nothing
1365      */
1366     function serverError($msg, $code=500, $format=null)
1367     {
1368         if ($format === null) {
1369             $format = $this->format;
1370         }
1371
1372         common_debug("Server error '{$code}' on '{$this->action}': {$msg}", __FILE__);
1373
1374         if (!array_key_exists($code, ServerErrorAction::$status)) {
1375             $code = 500;
1376         }
1377
1378         $status_string = ServerErrorAction::$status[$code];
1379
1380         switch ($format) {
1381         case 'xml':
1382             header("HTTP/1.1 {$code} {$status_string}");
1383             $this->initDocument('xml');
1384             $this->elementStart('hash');
1385             $this->element('error', null, $msg);
1386             $this->element('request', null, $_SERVER['REQUEST_URI']);
1387             $this->elementEnd('hash');
1388             $this->endDocument('xml');
1389             break;
1390         case 'json':
1391             if (!isset($this->callback)) {
1392                 header("HTTP/1.1 {$code} {$status_string}");
1393             }
1394             $this->initDocument('json');
1395             $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
1396             print(json_encode($error_array));
1397             $this->endDocument('json');
1398             break;
1399         default:
1400             throw new ServerException($msg, $code);
1401         }
1402
1403         exit((int)$code);
1404     }
1405
1406     /**
1407      * Client error
1408      *
1409      * @param string  $msg    error message to display
1410      * @param integer $code   http error code, 400 by default
1411      * @param string  $format error format (json, xml, text) for ApiAction
1412      *
1413      * @return nothing
1414      * @throws ClientException always
1415      */
1416     function clientError($msg, $code=400, $format=null)
1417     {
1418         // $format is currently only relevant for an ApiAction anyway
1419         if ($format === null) {
1420             $format = $this->format;
1421         }
1422
1423         common_debug("User error '{$code}' on '{$this->action}': {$msg}", __FILE__);
1424
1425         if (!array_key_exists($code, ClientErrorAction::$status)) {
1426             $code = 400;
1427         }
1428
1429         $status_string = ClientErrorAction::$status[$code];
1430
1431         switch ($format) {
1432         case 'xml':
1433             header("HTTP/1.1 {$code} {$status_string}");
1434             $this->initDocument('xml');
1435             $this->elementStart('hash');
1436             $this->element('error', null, $msg);
1437             $this->element('request', null, $_SERVER['REQUEST_URI']);
1438             $this->elementEnd('hash');
1439             $this->endDocument('xml');
1440             break;
1441         case 'json':
1442             if (!isset($this->callback)) {
1443                 header("HTTP/1.1 {$code} {$status_string}");
1444             }
1445             $this->initDocument('json');
1446             $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
1447             $this->text(json_encode($error_array));
1448             $this->endDocument('json');
1449             break;
1450         case 'text':
1451             header("HTTP/1.1 {$code} {$status_string}");
1452             header('Content-Type: text/plain; charset=utf-8');
1453             echo $msg;
1454             break;
1455         default:
1456             throw new ClientException($msg, $code);
1457         }
1458         exit((int)$code);
1459     }
1460
1461     /**
1462      * If not logged in, take appropriate action (redir or exception)
1463      *
1464      * @param boolean $redir Redirect to login if not logged in
1465      *
1466      * @return boolean true if logged in (never returns if not)
1467      */
1468     public function checkLogin($redir=true)
1469     {
1470         if (common_logged_in()) {
1471             return true;
1472         }
1473
1474         if ($redir==true) {
1475             common_set_returnto($_SERVER['REQUEST_URI']);
1476             common_redirect(common_local_url('login'));
1477         }
1478
1479         // TRANS: Error message displayed when trying to perform an action that requires a logged in user.
1480         $this->clientError(_('Not logged in.'), 403);
1481     }
1482
1483     /**
1484      * Returns the current URL
1485      *
1486      * @return string current URL
1487      */
1488     function selfUrl()
1489     {
1490         list($action, $args) = $this->returnToArgs();
1491         return common_local_url($action, $args);
1492     }
1493
1494     /**
1495      * Returns arguments sufficient for re-constructing URL
1496      *
1497      * @return array two elements: action, other args
1498      */
1499     function returnToArgs()
1500     {
1501         $action = $this->trimmed('action');
1502         $args   = $this->args;
1503         unset($args['action']);
1504         if (common_config('site', 'fancy')) {
1505             unset($args['p']);
1506         }
1507         if (array_key_exists('submit', $args)) {
1508             unset($args['submit']);
1509         }
1510         foreach (array_keys($_COOKIE) as $cookie) {
1511             unset($args[$cookie]);
1512         }
1513         return array($action, $args);
1514     }
1515
1516     /**
1517      * Generate a menu item
1518      *
1519      * @param string  $url         menu URL
1520      * @param string  $text        menu name
1521      * @param string  $title       title attribute, null by default
1522      * @param boolean $is_selected current menu item, false by default
1523      * @param string  $id          element id, null by default
1524      *
1525      * @return nothing
1526      */
1527     function menuItem($url, $text, $title=null, $is_selected=false, $id=null, $class=null)
1528     {
1529         // Added @id to li for some control.
1530         // XXX: We might want to move this to htmloutputter.php
1531         $lattrs  = array();
1532         $classes = array();
1533         if ($class !== null) {
1534             $classes[] = trim($class);
1535         }
1536         if ($is_selected) {
1537             $classes[] = 'current';
1538         }
1539
1540         if (!empty($classes)) {
1541             $lattrs['class'] = implode(' ', $classes);
1542         }
1543
1544         if (!is_null($id)) {
1545             $lattrs['id'] = $id;
1546         }
1547
1548         $this->elementStart('li', $lattrs);
1549         $attrs['href'] = $url;
1550         if ($title) {
1551             $attrs['title'] = $title;
1552         }
1553         $this->element('a', $attrs, $text);
1554         $this->elementEnd('li');
1555     }
1556
1557     /**
1558      * Generate pagination links
1559      *
1560      * @param boolean $have_before is there something before?
1561      * @param boolean $have_after  is there something after?
1562      * @param integer $page        current page
1563      * @param string  $action      current action
1564      * @param array   $args        rest of query arguments
1565      *
1566      * @return nothing
1567      */
1568     // XXX: The messages in this pagination method only tailor to navigating
1569     //      notices. In other lists, "Previous"/"Next" type navigation is
1570     //      desirable, but not available.
1571     function pagination($have_before, $have_after, $page, $action, $args=null)
1572     {
1573         // Does a little before-after block for next/prev page
1574         if ($have_before || $have_after) {
1575             $this->elementStart('ul', array('class' => 'nav',
1576                                             'id' => 'pagination'));
1577         }
1578         if ($have_before) {
1579             $pargs   = array('page' => $page-1);
1580             $this->elementStart('li', array('class' => 'nav_prev'));
1581             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1582                                       'rel' => 'prev'),
1583                            // TRANS: Pagination message to go to a page displaying information more in the
1584                            // TRANS: present than the currently displayed information.
1585                            _('After'));
1586             $this->elementEnd('li');
1587         }
1588         if ($have_after) {
1589             $pargs   = array('page' => $page+1);
1590             $this->elementStart('li', array('class' => 'nav_next'));
1591             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1592                                       'rel' => 'next'),
1593                            // TRANS: Pagination message to go to a page displaying information more in the
1594                            // TRANS: past than the currently displayed information.
1595                            _('Before'));
1596             $this->elementEnd('li');
1597         }
1598         if ($have_before || $have_after) {
1599             $this->elementEnd('ul');
1600         }
1601     }
1602
1603     /**
1604      * An array of feeds for this action.
1605      *
1606      * Returns an array of potential feeds for this action.
1607      *
1608      * @return array Feed object to show in head and links
1609      */
1610     function getFeeds()
1611     {
1612         return null;
1613     }
1614
1615     /**
1616      * Check the session token.
1617      *
1618      * Checks that the current form has the correct session token,
1619      * and throw an exception if it does not.
1620      *
1621      * @return void
1622      */
1623     // XXX: Finding this type of check with the same message about 50 times.
1624     //      Possible to refactor?
1625     function checkSessionToken()
1626     {
1627         // CSRF protection
1628         $token = $this->trimmed('token');
1629         if (empty($token) || $token != common_session_token()) {
1630             // TRANS: Client error text when there is a problem with the session token.
1631             $this->clientError(_('There was a problem with your session token.'));
1632         }
1633     }
1634
1635     /**
1636      * Check if the current request is a POST
1637      *
1638      * @return boolean true if POST; otherwise false.
1639      */
1640
1641     function isPost()
1642     {
1643         return ($_SERVER['REQUEST_METHOD'] == 'POST');
1644     }
1645 }