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