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