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