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('STATUSNET') && !defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 require_once INSTALLDIR.'/lib/noticeform.php';
  36 require_once INSTALLDIR.'/lib/htmloutputter.php';
  37
  38 /**
  39  * Base class for all actions
  40  *
  41  * This is the base class for all actions in the package. An action is
  42  * more or less a "view" in an MVC framework.
  43  *
  44  * Actions are responsible for extracting and validating parameters; using
  45  * model classes to read and write to the database; and doing ouput.
  46  *
  47  * @category Output
  48  * @package  StatusNet
  49  * @author   Evan Prodromou <evan@status.net>
  50  * @author   Sarven Capadisli <csarven@status.net>
  51  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  52  * @link     http://status.net/
  53  *
  54  * @see      HTMLOutputter
  55  */
  56 class Action extends HTMLOutputter // lawsuit
  57 {
  58     var $args;
  59
  60     /**
  61      * Constructor
  62      *
  63      * Just wraps the HTMLOutputter constructor.
  64      *
  65      * @param string  $output URI to output to, default = stdout
  66      * @param boolean $indent Whether to indent output, default true
  67      *
  68      * @see XMLOutputter::__construct
  69      * @see HTMLOutputter::__construct
  70      */
  71     function __construct($output='php://output', $indent=null)
  72     {
  73         parent::__construct($output, $indent);
  74     }
  75
  76     /**
  77      * For initializing members of the class.
  78      *
  79      * @param array $argarray misc. arguments
  80      *
  81      * @return boolean true
  82      */
  83     function prepare($argarray)
  84     {
  85         $this->args =& common_copy_args($argarray);
  86         return true;
  87     }
  88
  89     /**
  90      * Show page, a template method.
  91      *
  92      * @return nothing
  93      */
  94     function showPage()
  95     {
  96         if (Event::handle('StartShowHTML', array($this))) {
  97             $this->startHTML();
  98             Event::handle('EndShowHTML', array($this));
  99         }
 100         if (Event::handle('StartShowHead', array($this))) {
 101             $this->showHead();
 102             Event::handle('EndShowHead', array($this));
 103         }
 104         if (Event::handle('StartShowBody', array($this))) {
 105             $this->showBody();
 106             Event::handle('EndShowBody', array($this));
 107         }
 108         if (Event::handle('StartEndHTML', array($this))) {
 109             $this->endHTML();
 110             Event::handle('EndEndHTML', array($this));
 111         }
 112     }
 113
 114     /**
 115      * Show head, a template method.
 116      *
 117      * @return nothing
 118      */
 119     function showHead()
 120     {
 121         // XXX: attributes (profile?)
 122         $this->elementStart('head');
 123         if (Event::handle('StartShowHeadElements', array($this))) {
 124             $this->showTitle();
 125             $this->showShortcutIcon();
 126             $this->showStylesheets();
 127             $this->showOpenSearch();
 128             $this->showFeeds();
 129             $this->showDescription();
 130             $this->extraHead();
 131             Event::handle('EndShowHeadElements', array($this));
 132         }
 133         $this->elementEnd('head');
 134     }
 135
 136     /**
 137      * Show title, a template method.
 138      *
 139      * @return nothing
 140      */
 141     function showTitle()
 142     {
 143         $this->element('title', null,
 144                        sprintf(_("%1\$s - %2\$s"),
 145                                $this->title(),
 146                                common_config('site', 'name')));
 147     }
 148
 149     /**
 150      * Returns the page title
 151      *
 152      * SHOULD overload
 153      *
 154      * @return string page title
 155      */
 156
 157     function title()
 158     {
 159         return _("Untitled page");
 160     }
 161
 162     /**
 163      * Show themed shortcut icon
 164      *
 165      * @return nothing
 166      */
 167     function showShortcutIcon()
 168     {
 169         if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/favicon.ico')) {
 170             $this->element('link', array('rel' => 'shortcut icon',
 171                                          'href' => Theme::path('favicon.ico')));
 172         } else {
 173             $this->element('link', array('rel' => 'shortcut icon',
 174                                          'href' => common_path('favicon.ico')));
 175         }
 176
 177         if (common_config('site', 'mobile')) {
 178             if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/apple-touch-icon.png')) {
 179                 $this->element('link', array('rel' => 'apple-touch-icon',
 180                                              'href' => Theme::path('apple-touch-icon.png')));
 181             } else {
 182                 $this->element('link', array('rel' => 'apple-touch-icon',
 183                                              'href' => common_path('apple-touch-icon.png')));
 184             }
 185         }
 186     }
 187
 188     /**
 189      * Show stylesheets
 190      *
 191      * @return nothing
 192      */
 193     function showStylesheets()
 194     {
 195         if (Event::handle('StartShowStyles', array($this))) {
 196
 197             // Use old name for StatusNet for compatibility on events
 198
 199             if (Event::handle('StartShowStatusNetStyles', array($this)) &&
 200                 Event::handle('StartShowLaconicaStyles', array($this))) {
 201                 $this->cssLink('css/display.css',null, 'screen, projection, tv, print');
 202                 Event::handle('EndShowStatusNetStyles', array($this));
 203                 Event::handle('EndShowLaconicaStyles', array($this));
 204             }
 205
 206             if (Event::handle('StartShowUAStyles', array($this))) {
 207                 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
 208                                'href="'.Theme::path('css/ie.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
 209                 foreach (array(6,7) as $ver) {
 210                     if (file_exists(Theme::file('css/ie'.$ver.'.css', 'base'))) {
 211                         // Yes, IE people should be put in jail.
 212                         $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
 213                                        'href="'.Theme::path('css/ie'.$ver.'.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
 214                     }
 215                 }
 216                 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
 217                                'href="'.Theme::path('css/ie.css', null).'?version='.STATUSNET_VERSION.'" /><![endif]');
 218                 Event::handle('EndShowUAStyles', array($this));
 219             }
 220
 221             if (Event::handle('StartShowDesign', array($this))) {
 222
 223                 $user = common_current_user();
 224
 225                 if (empty($user) || $user->viewdesigns) {
 226                     $design = $this->getDesign();
 227
 228                     if (!empty($design)) {
 229                         $design->showCSS($this);
 230                     }
 231                 }
 232
 233                 Event::handle('EndShowDesign', array($this));
 234             }
 235             Event::handle('EndShowStyles', array($this));
 236
 237             if (common_config('custom_css', 'enabled')) {
 238                 $css = common_config('custom_css', 'css');
 239                 if (Event::handle('StartShowCustomCss', array($this, &$css))) {
 240                     if (trim($css) != '') {
 241                         $this->style($css);
 242                     }
 243                     Event::handle('EndShowCustomCss', array($this));
 244                 }
 245             }
 246         }
 247     }
 248
 249     /**
 250      * Show javascript headers
 251      *
 252      * @return nothing
 253      */
 254     function showScripts()
 255     {
 256         if (Event::handle('StartShowScripts', array($this))) {
 257             if (Event::handle('StartShowJQueryScripts', array($this))) {
 258                 $this->script('jquery.min.js');
 259                 $this->script('jquery.form.js');
 260                 $this->script('jquery.cookie.js');
 261                 $this->inlineScript('if (typeof window.JSON !== "object") { $.getScript("'.common_path('js/json2.js').'"); }');
 262                 $this->script('jquery.joverlay.min.js');
 263                 Event::handle('EndShowJQueryScripts', array($this));
 264             }
 265             if (Event::handle('StartShowStatusNetScripts', array($this)) &&
 266                 Event::handle('StartShowLaconicaScripts', array($this))) {
 267                 $this->script('xbImportNode.js');
 268                 $this->script('util.js');
 269                 $this->script('geometa.js');
 270                 // Frame-busting code to avoid clickjacking attacks.
 271                 $this->inlineScript('if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
 272                 Event::handle('EndShowStatusNetScripts', array($this));
 273                 Event::handle('EndShowLaconicaScripts', array($this));
 274             }
 275             Event::handle('EndShowScripts', array($this));
 276         }
 277     }
 278
 279     /**
 280      * Show OpenSearch headers
 281      *
 282      * @return nothing
 283      */
 284     function showOpenSearch()
 285     {
 286         $this->element('link', array('rel' => 'search',
 287                                      'type' => 'application/opensearchdescription+xml',
 288                                      'href' =>  common_local_url('opensearch', array('type' => 'people')),
 289                                      'title' => common_config('site', 'name').' People Search'));
 290         $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
 291                                      'href' =>  common_local_url('opensearch', array('type' => 'notice')),
 292                                      'title' => common_config('site', 'name').' Notice Search'));
 293     }
 294
 295     /**
 296      * Show feed headers
 297      *
 298      * MAY overload
 299      *
 300      * @return nothing
 301      */
 302
 303     function showFeeds()
 304     {
 305         $feeds = $this->getFeeds();
 306
 307         if ($feeds) {
 308             foreach ($feeds as $feed) {
 309                 $this->element('link', array('rel' => $feed->rel(),
 310                                              'href' => $feed->url,
 311                                              'type' => $feed->mimeType(),
 312                                              'title' => $feed->title));
 313             }
 314         }
 315     }
 316
 317     /**
 318      * Show description.
 319      *
 320      * SHOULD overload
 321      *
 322      * @return nothing
 323      */
 324     function showDescription()
 325     {
 326         // does nothing by default
 327     }
 328
 329     /**
 330      * Show extra stuff in <head>.
 331      *
 332      * MAY overload
 333      *
 334      * @return nothing
 335      */
 336     function extraHead()
 337     {
 338         // does nothing by default
 339     }
 340
 341     /**
 342      * Show body.
 343      *
 344      * Calls template methods
 345      *
 346      * @return nothing
 347      */
 348     function showBody()
 349     {
 350         $this->elementStart('body', (common_current_user()) ? array('id' => $this->trimmed('action'),
 351                                                                     'class' => 'user_in')
 352                             : array('id' => $this->trimmed('action')));
 353         $this->elementStart('div', array('id' => 'wrap'));
 354         if (Event::handle('StartShowHeader', array($this))) {
 355             $this->showHeader();
 356             Event::handle('EndShowHeader', array($this));
 357         }
 358         $this->showCore();
 359         if (Event::handle('StartShowFooter', array($this))) {
 360             $this->showFooter();
 361             Event::handle('EndShowFooter', array($this));
 362         }
 363         $this->elementEnd('div');
 364         $this->showScripts();
 365         $this->elementEnd('body');
 366     }
 367
 368     /**
 369      * Show header of the page.
 370      *
 371      * Calls template methods
 372      *
 373      * @return nothing
 374      */
 375     function showHeader()
 376     {
 377         $this->elementStart('div', array('id' => 'header'));
 378         $this->showLogo();
 379         $this->showPrimaryNav();
 380         if (Event::handle('StartShowSiteNotice', array($this))) {
 381             $this->showSiteNotice();
 382
 383             Event::handle('EndShowSiteNotice', array($this));
 384         }
 385         if (common_logged_in()) {
 386             $this->showNoticeForm();
 387         } else {
 388             $this->showAnonymousMessage();
 389         }
 390         $this->elementEnd('div');
 391     }
 392
 393     /**
 394      * Show configured logo.
 395      *
 396      * @return nothing
 397      */
 398     function showLogo()
 399     {
 400         $this->elementStart('address', array('id' => 'site_contact',
 401                                              'class' => 'vcard'));
 402         if (Event::handle('StartAddressData', array($this))) {
 403             if (common_config('singleuser', 'enabled')) {
 404                 $url = common_local_url('showstream',
 405                                         array('nickname' => common_config('singleuser', 'nickname')));
 406             } else {
 407                 $url = common_local_url('public');
 408             }
 409             $this->elementStart('a', array('class' => 'url home bookmark',
 410                                            'href' => $url));
 411             if (common_config('site', 'logo') || file_exists(Theme::file('logo.png'))) {
 412                 $this->element('img', array('class' => 'logo photo',
 413                                             'src' => (common_config('site', 'logo')) ? common_config('site', 'logo') : Theme::path('logo.png'),
 414                                             'alt' => common_config('site', 'name')));
 415             }
 416             $this->text(' ');
 417             $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
 418             $this->elementEnd('a');
 419             Event::handle('EndAddressData', array($this));
 420         }
 421         $this->elementEnd('address');
 422     }
 423
 424     /**
 425      * Show primary navigation.
 426      *
 427      * @return nothing
 428      */
 429     function showPrimaryNav()
 430     {
 431         $user = common_current_user();
 432         $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
 433         $this->element('dt', null, _('Primary site navigation'));
 434         $this->elementStart('dd');
 435         $this->elementStart('ul', array('class' => 'nav'));
 436         if (Event::handle('StartPrimaryNav', array($this))) {
 437             if ($user) {
 438                 // TRANS: Tooltip for main menu option "Personal"
 439                 $tooltip = _m('TOOLTIP', 'Personal profile and friends timeline');
 440                 // TRANS: Main menu option when logged in for access to personal profile and friends timeline
 441                 $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
 442                                 _m('MENU', 'Personal'), $tooltip, false, 'nav_home');
 443                 // TRANS: Tooltip for main menu option "Account"
 444                 $tooltip = _m('TOOLTIP', 'Change your email, avatar, password, profile');
 445                 // TRANS: Main menu option when logged in for access to user settings
 446                 $this->menuItem(common_local_url('profilesettings'),
 447                                 _('Account'), $tooltip, false, 'nav_account');
 448                 // TRANS: Tooltip for main menu option "Services"
 449                 $tooltip = _m('TOOLTIP', 'Connect to services');
 450                 // TRANS: Main menu option when logged in and connection are possible for access to options to connect to other services
 451                 $this->menuItem(common_local_url('oauthconnectionssettings'),
 452                                 _('Connect'), $tooltip, false, 'nav_connect');
 453                 if ($user->hasRight(Right::CONFIGURESITE)) {
 454                     // TRANS: Tooltip for menu option "Admin"
 455                     $tooltip = _m('TOOLTIP', 'Change site configuration');
 456                     // TRANS: Main menu option when logged in and site admin for access to site configuration
 457                     $this->menuItem(common_local_url('siteadminpanel'),
 458                                     _m('MENU', 'Admin'), $tooltip, false, 'nav_admin');
 459                 }
 460                 if (common_config('invite', 'enabled')) {
 461                     // TRANS: Tooltip for main menu option "Invite"
 462                     $tooltip = _m('TOOLTIP', 'Invite friends and colleagues to join you on %s');
 463                     // TRANS: Main menu option when logged in and invitations are allowed for inviting new users
 464                     $this->menuItem(common_local_url('invite'),
 465                                     _m('MENU', 'Invite'),
 466                                     sprintf($tooltip,
 467                                             common_config('site', 'name')),
 468                                     false, 'nav_invitecontact');
 469                 }
 470                 // TRANS: Tooltip for main menu option "Logout"
 471                 $tooltip = _m('TOOLTIP', 'Logout from the site');
 472                 // TRANS: Main menu option when logged in to log out the current user
 473                 $this->menuItem(common_local_url('logout'),
 474                                 _m('MENU', 'Logout'), $tooltip, false, 'nav_logout');
 475             }
 476             else {
 477                 if (!common_config('site', 'closed') && !common_config('site', 'inviteonly')) {
 478                     // TRANS: Tooltip for main menu option "Register"
 479                     $tooltip = _m('TOOLTIP', 'Create an account');
 480                     // TRANS: Main menu option when not logged in to register a new account
 481                     $this->menuItem(common_local_url('register'),
 482                                     _m('MENU', 'Register'), $tooltip, false, 'nav_register');
 483                 }
 484                 // TRANS: Tooltip for main menu option "Login"
 485                 $tooltip = _m('TOOLTIP', 'Login to the site');
 486                 // TRANS: Main menu option when not logged in to log in
 487                 $this->menuItem(common_local_url('login'),
 488                                 _m('MENU', 'Login'), $tooltip, false, 'nav_login');
 489             }
 490             // TRANS: Tooltip for main menu option "Help"
 491             $tooltip = _m('TOOLTIP', 'Help me!');
 492             // TRANS: Main menu option for help on the StatusNet site
 493             $this->menuItem(common_local_url('doc', array('title' => 'help')),
 494                             _m('MENU', 'Help'), $tooltip, false, 'nav_help');
 495             if ($user || !common_config('site', 'private')) {
 496                 // TRANS: Tooltip for main menu option "Search"
 497                 $tooltip = _m('TOOLTIP', 'Search for people or text');
 498                 // TRANS: Main menu option when logged in or when the StatusNet instance is not private
 499                 $this->menuItem(common_local_url('peoplesearch'),
 500                                 _m('MENU', 'Search'), $tooltip, false, 'nav_search');
 501             }
 502             Event::handle('EndPrimaryNav', array($this));
 503         }
 504         $this->elementEnd('ul');
 505         $this->elementEnd('dd');
 506         $this->elementEnd('dl');
 507     }
 508
 509     /**
 510      * Show site notice.
 511      *
 512      * @return nothing
 513      */
 514     function showSiteNotice()
 515     {
 516         // Revist. Should probably do an hAtom pattern here
 517         $text = common_config('site', 'notice');
 518         if ($text) {
 519             $this->elementStart('dl', array('id' => 'site_notice',
 520                                             'class' => 'system_notice'));
 521             // TRANS: DT element for site notice. String is hidden in default CSS.
 522             $this->element('dt', null, _('Site notice'));
 523             $this->elementStart('dd', null);
 524             $this->raw($text);
 525             $this->elementEnd('dd');
 526             $this->elementEnd('dl');
 527         }
 528     }
 529
 530     /**
 531      * Show notice form.
 532      *
 533      * MAY overload if no notice form needed... or direct message box????
 534      *
 535      * @return nothing
 536      */
 537     function showNoticeForm()
 538     {
 539         $notice_form = new NoticeForm($this);
 540         $notice_form->show();
 541     }
 542
 543     /**
 544      * Show anonymous message.
 545      *
 546      * SHOULD overload
 547      *
 548      * @return nothing
 549      */
 550     function showAnonymousMessage()
 551     {
 552         // needs to be defined by the class
 553     }
 554
 555     /**
 556      * Show core.
 557      *
 558      * Shows local navigation, content block and aside.
 559      *
 560      * @return nothing
 561      */
 562     function showCore()
 563     {
 564         $this->elementStart('div', array('id' => 'core'));
 565         if (Event::handle('StartShowLocalNavBlock', array($this))) {
 566             $this->showLocalNavBlock();
 567             Event::handle('EndShowLocalNavBlock', array($this));
 568         }
 569         if (Event::handle('StartShowContentBlock', array($this))) {
 570             $this->showContentBlock();
 571             Event::handle('EndShowContentBlock', array($this));
 572         }
 573         if (Event::handle('StartShowAside', array($this))) {
 574             $this->showAside();
 575             Event::handle('EndShowAside', array($this));
 576         }
 577         $this->elementEnd('div');
 578     }
 579
 580     /**
 581      * Show local navigation block.
 582      *
 583      * @return nothing
 584      */
 585     function showLocalNavBlock()
 586     {
 587         $this->elementStart('dl', array('id' => 'site_nav_local_views'));
 588         $this->element('dt', null, _('Local views'));
 589         $this->elementStart('dd');
 590         $this->showLocalNav();
 591         $this->elementEnd('dd');
 592         $this->elementEnd('dl');
 593     }
 594
 595     /**
 596      * Show local navigation.
 597      *
 598      * SHOULD overload
 599      *
 600      * @return nothing
 601      */
 602     function showLocalNav()
 603     {
 604         // does nothing by default
 605     }
 606
 607     /**
 608      * Show content block.
 609      *
 610      * @return nothing
 611      */
 612     function showContentBlock()
 613     {
 614         $this->elementStart('div', array('id' => 'content'));
 615         $this->showPageTitle();
 616         $this->showPageNoticeBlock();
 617         $this->elementStart('div', array('id' => 'content_inner'));
 618         // show the actual content (forms, lists, whatever)
 619         $this->showContent();
 620         $this->elementEnd('div');
 621         $this->elementEnd('div');
 622     }
 623
 624     /**
 625      * Show page title.
 626      *
 627      * @return nothing
 628      */
 629     function showPageTitle()
 630     {
 631         $this->element('h1', null, $this->title());
 632     }
 633
 634     /**
 635      * Show page notice block.
 636      *
 637      * Only show the block if a subclassed action has overrided
 638      * Action::showPageNotice(), or an event handler is registered for
 639      * the StartShowPageNotice event, in which case we assume the
 640      * 'page_notice' definition list is desired.  This is to prevent
 641      * empty 'page_notice' definition lists from being output everywhere.
 642      *
 643      * @return nothing
 644      */
 645     function showPageNoticeBlock()
 646     {
 647         $rmethod = new ReflectionMethod($this, 'showPageNotice');
 648         $dclass = $rmethod->getDeclaringClass()->getName();
 649
 650         if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
 651
 652             $this->elementStart('dl', array('id' => 'page_notice',
 653                                             'class' => 'system_notice'));
 654             $this->element('dt', null, _('Page notice'));
 655             $this->elementStart('dd');
 656             if (Event::handle('StartShowPageNotice', array($this))) {
 657                 $this->showPageNotice();
 658                 Event::handle('EndShowPageNotice', array($this));
 659             }
 660             $this->elementEnd('dd');
 661             $this->elementEnd('dl');
 662         }
 663     }
 664
 665     /**
 666      * Show page notice.
 667      *
 668      * SHOULD overload (unless there's not a notice)
 669      *
 670      * @return nothing
 671      */
 672     function showPageNotice()
 673     {
 674     }
 675
 676     /**
 677      * Show content.
 678      *
 679      * MUST overload (unless there's not a notice)
 680      *
 681      * @return nothing
 682      */
 683     function showContent()
 684     {
 685     }
 686
 687     /**
 688      * Show Aside.
 689      *
 690      * @return nothing
 691      */
 692
 693     function showAside()
 694     {
 695         $this->elementStart('div', array('id' => 'aside_primary',
 696                                          'class' => 'aside'));
 697         if (Event::handle('StartShowExportData', array($this))) {
 698             $this->showExportData();
 699             Event::handle('EndShowExportData', array($this));
 700         }
 701         if (Event::handle('StartShowSections', array($this))) {
 702             $this->showSections();
 703             Event::handle('EndShowSections', array($this));
 704         }
 705         $this->elementEnd('div');
 706     }
 707
 708     /**
 709      * Show export data feeds.
 710      *
 711      * @return void
 712      */
 713
 714     function showExportData()
 715     {
 716         $feeds = $this->getFeeds();
 717         if ($feeds) {
 718             $fl = new FeedList($this);
 719             $fl->show($feeds);
 720         }
 721     }
 722
 723     /**
 724      * Show sections.
 725      *
 726      * SHOULD overload
 727      *
 728      * @return nothing
 729      */
 730     function showSections()
 731     {
 732         // for each section, show it
 733     }
 734
 735     /**
 736      * Show footer.
 737      *
 738      * @return nothing
 739      */
 740     function showFooter()
 741     {
 742         $this->elementStart('div', array('id' => 'footer'));
 743         $this->showSecondaryNav();
 744         $this->showLicenses();
 745         $this->elementEnd('div');
 746     }
 747
 748     /**
 749      * Show secondary navigation.
 750      *
 751      * @return nothing
 752      */
 753     function showSecondaryNav()
 754     {
 755         $this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
 756         $this->element('dt', null, _('Secondary site navigation'));
 757         $this->elementStart('dd', null);
 758         $this->elementStart('ul', array('class' => 'nav'));
 759         if (Event::handle('StartSecondaryNav', array($this))) {
 760             $this->menuItem(common_local_url('doc', array('title' => 'help')),
 761                             _('Help'));
 762             $this->menuItem(common_local_url('doc', array('title' => 'about')),
 763                             _('About'));
 764             $this->menuItem(common_local_url('doc', array('title' => 'faq')),
 765                             _('FAQ'));
 766             $bb = common_config('site', 'broughtby');
 767             if (!empty($bb)) {
 768                 $this->menuItem(common_local_url('doc', array('title' => 'tos')),
 769                                 _('TOS'));
 770             }
 771             $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
 772                             _('Privacy'));
 773             $this->menuItem(common_local_url('doc', array('title' => 'source')),
 774                             _('Source'));
 775             $this->menuItem(common_local_url('version'),
 776                             _('Version'));
 777             $this->menuItem(common_local_url('doc', array('title' => 'contact')),
 778                             _('Contact'));
 779             $this->menuItem(common_local_url('doc', array('title' => 'badge')),
 780                             _('Badge'));
 781             Event::handle('EndSecondaryNav', array($this));
 782         }
 783         $this->elementEnd('ul');
 784         $this->elementEnd('dd');
 785         $this->elementEnd('dl');
 786     }
 787
 788     /**
 789      * Show licenses.
 790      *
 791      * @return nothing
 792      */
 793     function showLicenses()
 794     {
 795         $this->elementStart('dl', array('id' => 'licenses'));
 796         $this->showStatusNetLicense();
 797         $this->showContentLicense();
 798         $this->elementEnd('dl');
 799     }
 800
 801     /**
 802      * Show StatusNet license.
 803      *
 804      * @return nothing
 805      */
 806     function showStatusNetLicense()
 807     {
 808         $this->element('dt', array('id' => 'site_statusnet_license'), _('StatusNet software license'));
 809         $this->elementStart('dd', null);
 810         // @fixme drop the final spaces in the messages when at good spot
 811         // to let translations get updated.
 812         if (common_config('site', 'broughtby')) {
 813             $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
 814         } else {
 815             $instr = _('**%%site.name%%** is a microblogging service. ');
 816         }
 817         $instr .= ' ';
 818         $instr .= sprintf(_('It runs the [StatusNet](http://status.net/) microblogging software, version %s, available under the [GNU Affero General Public License](http://www.fsf.org/licensing/licenses/agpl-3.0.html).'), STATUSNET_VERSION);
 819         $output = common_markup_to_html($instr);
 820         $this->raw($output);
 821         $this->elementEnd('dd');
 822         // do it
 823     }
 824
 825     /**
 826      * Show content license.
 827      *
 828      * @return nothing
 829      */
 830     function showContentLicense()
 831     {
 832         if (Event::handle('StartShowContentLicense', array($this))) {
 833             $this->element('dt', array('id' => 'site_content_license'), _('Site content license'));
 834             $this->elementStart('dd', array('id' => 'site_content_license_cc'));
 835
 836             switch (common_config('license', 'type')) {
 837             case 'private':
 838                 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
 839                                                   common_config('site', 'name')));
 840                 // fall through
 841             case 'allrightsreserved':
 842                 if (common_config('license', 'owner')) {
 843                     $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
 844                                                       common_config('license', 'owner')));
 845                 } else {
 846                     $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
 847                 }
 848                 break;
 849             case 'cc': // fall through
 850             default:
 851                 $this->elementStart('p');
 852                 $this->element('img', array('id' => 'license_cc',
 853                                             'src' => common_config('license', 'image'),
 854                                             'alt' => common_config('license', 'title'),
 855                                             'width' => '80',
 856                                             'height' => '15'));
 857                 $this->text(' ');
 858                 // TRANS: license message in footer. %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
 859                 $notice = _('All %1$s content and data are available under the %2$s license.');
 860                 $link = "<a class=\"license\" rel=\"external license\" href=\"" .
 861                         htmlspecialchars(common_config('license', 'url')) .
 862                         "\">" .
 863                         htmlspecialchars(common_config('license', 'title')) .
 864                         "</a>";
 865                 $this->raw(sprintf(htmlspecialchars($notice),
 866                                    htmlspecialchars(common_config('site', 'name')),
 867                                    $link));
 868                 $this->elementEnd('p');
 869                 break;
 870             }
 871
 872             $this->elementEnd('dd');
 873             Event::handle('EndShowContentLicense', array($this));
 874         }
 875     }
 876
 877     /**
 878      * Return last modified, if applicable.
 879      *
 880      * MAY override
 881      *
 882      * @return string last modified http header
 883      */
 884     function lastModified()
 885     {
 886         // For comparison with If-Last-Modified
 887         // If not applicable, return null
 888         return null;
 889     }
 890
 891     /**
 892      * Return etag, if applicable.
 893      *
 894      * MAY override
 895      *
 896      * @return string etag http header
 897      */
 898     function etag()
 899     {
 900         return null;
 901     }
 902
 903     /**
 904      * Return true if read only.
 905      *
 906      * MAY override
 907      *
 908      * @param array $args other arguments
 909      *
 910      * @return boolean is read only action?
 911      */
 912
 913     function isReadOnly($args)
 914     {
 915         return false;
 916     }
 917
 918     /**
 919      * Returns query argument or default value if not found
 920      *
 921      * @param string $key requested argument
 922      * @param string $def default value to return if $key is not provided
 923      *
 924      * @return boolean is read only action?
 925      */
 926     function arg($key, $def=null)
 927     {
 928         if (array_key_exists($key, $this->args)) {
 929             return $this->args[$key];
 930         } else {
 931             return $def;
 932         }
 933     }
 934
 935     /**
 936      * Returns trimmed query argument or default value if not found
 937      *
 938      * @param string $key requested argument
 939      * @param string $def default value to return if $key is not provided
 940      *
 941      * @return boolean is read only action?
 942      */
 943     function trimmed($key, $def=null)
 944     {
 945         $arg = $this->arg($key, $def);
 946         return is_string($arg) ? trim($arg) : $arg;
 947     }
 948
 949     /**
 950      * Handler method
 951      *
 952      * @param array $argarray is ignored since it's now passed in in prepare()
 953      *
 954      * @return boolean is read only action?
 955      */
 956     function handle($argarray=null)
 957     {
 958         header('Vary: Accept-Encoding,Cookie');
 959         $lm   = $this->lastModified();
 960         $etag = $this->etag();
 961         if ($etag) {
 962             header('ETag: ' . $etag);
 963         }
 964         if ($lm) {
 965             header('Last-Modified: ' . date(DATE_RFC1123, $lm));
 966             if (array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
 967                 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
 968                 $ims = strtotime($if_modified_since);
 969                 if ($lm <= $ims) {
 970                     $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
 971                       $_SERVER['HTTP_IF_NONE_MATCH'] : null;
 972                     if (!$if_none_match ||
 973                         !$etag ||
 974                         $this->_hasEtag($etag, $if_none_match)) {
 975                         header('HTTP/1.1 304 Not Modified');
 976                         // Better way to do this?
 977                         exit(0);
 978                     }
 979                 }
 980             }
 981         }
 982     }
 983
 984     /**
 985      * Has etag? (private)
 986      *
 987      * @param string $etag          etag http header
 988      * @param string $if_none_match ifNoneMatch http header
 989      *
 990      * @return boolean
 991      */
 992
 993     function _hasEtag($etag, $if_none_match)
 994     {
 995         $etags = explode(',', $if_none_match);
 996         return in_array($etag, $etags) || in_array('*', $etags);
 997     }
 998
 999     /**
1000      * Boolean understands english (yes, no, true, false)
1001      *
1002      * @param string $key query key we're interested in
1003      * @param string $def default value
1004      *
1005      * @return boolean interprets yes/no strings as boolean
1006      */
1007     function boolean($key, $def=false)
1008     {
1009         $arg = strtolower($this->trimmed($key));
1010
1011         if (is_null($arg)) {
1012             return $def;
1013         } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1014             return true;
1015         } else if (in_array($arg, array('false', 'no', '0'))) {
1016             return false;
1017         } else {
1018             return $def;
1019         }
1020     }
1021
1022     /**
1023      * Integer value of an argument
1024      *
1025      * @param string $key      query key we're interested in
1026      * @param string $defValue optional default value (default null)
1027      * @param string $maxValue optional max value (default null)
1028      * @param string $minValue optional min value (default null)
1029      *
1030      * @return integer integer value
1031      */
1032
1033     function int($key, $defValue=null, $maxValue=null, $minValue=null)
1034     {
1035         $arg = strtolower($this->trimmed($key));
1036
1037         if (is_null($arg) || !is_integer($arg)) {
1038             return $defValue;
1039         }
1040
1041         if (!is_null($maxValue)) {
1042             $arg = min($arg, $maxValue);
1043         }
1044
1045         if (!is_null($minValue)) {
1046             $arg = max($arg, $minValue);
1047         }
1048
1049         return $arg;
1050     }
1051
1052     /**
1053      * Server error
1054      *
1055      * @param string  $msg  error message to display
1056      * @param integer $code http error code, 500 by default
1057      *
1058      * @return nothing
1059      */
1060
1061     function serverError($msg, $code=500)
1062     {
1063         $action = $this->trimmed('action');
1064         common_debug("Server error '$code' on '$action': $msg", __FILE__);
1065         throw new ServerException($msg, $code);
1066     }
1067
1068     /**
1069      * Client error
1070      *
1071      * @param string  $msg  error message to display
1072      * @param integer $code http error code, 400 by default
1073      *
1074      * @return nothing
1075      */
1076
1077     function clientError($msg, $code=400)
1078     {
1079         $action = $this->trimmed('action');
1080         common_debug("User error '$code' on '$action': $msg", __FILE__);
1081         throw new ClientException($msg, $code);
1082     }
1083
1084     /**
1085      * Returns the current URL
1086      *
1087      * @return string current URL
1088      */
1089
1090     function selfUrl()
1091     {
1092         list($action, $args) = $this->returnToArgs();
1093         return common_local_url($action, $args);
1094     }
1095
1096     /**
1097      * Returns arguments sufficient for re-constructing URL
1098      *
1099      * @return array two elements: action, other args
1100      */
1101
1102     function returnToArgs()
1103     {
1104         $action = $this->trimmed('action');
1105         $args   = $this->args;
1106         unset($args['action']);
1107         if (common_config('site', 'fancy')) {
1108             unset($args['p']);
1109         }
1110         if (array_key_exists('submit', $args)) {
1111             unset($args['submit']);
1112         }
1113         foreach (array_keys($_COOKIE) as $cookie) {
1114             unset($args[$cookie]);
1115         }
1116         return array($action, $args);
1117     }
1118
1119     /**
1120      * Generate a menu item
1121      *
1122      * @param string  $url         menu URL
1123      * @param string  $text        menu name
1124      * @param string  $title       title attribute, null by default
1125      * @param boolean $is_selected current menu item, false by default
1126      * @param string  $id          element id, null by default
1127      *
1128      * @return nothing
1129      */
1130     function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1131     {
1132         // Added @id to li for some control.
1133         // XXX: We might want to move this to htmloutputter.php
1134         $lattrs = array();
1135         if ($is_selected) {
1136             $lattrs['class'] = 'current';
1137         }
1138
1139         (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1140
1141         $this->elementStart('li', $lattrs);
1142         $attrs['href'] = $url;
1143         if ($title) {
1144             $attrs['title'] = $title;
1145         }
1146         $this->element('a', $attrs, $text);
1147         $this->elementEnd('li');
1148     }
1149
1150     /**
1151      * Generate pagination links
1152      *
1153      * @param boolean $have_before is there something before?
1154      * @param boolean $have_after  is there something after?
1155      * @param integer $page        current page
1156      * @param string  $action      current action
1157      * @param array   $args        rest of query arguments
1158      *
1159      * @return nothing
1160      */
1161     function pagination($have_before, $have_after, $page, $action, $args=null)
1162     {
1163         // Does a little before-after block for next/prev page
1164         if ($have_before || $have_after) {
1165             $this->elementStart('dl', 'pagination');
1166             $this->element('dt', null, _('Pagination'));
1167             $this->elementStart('dd', null);
1168             $this->elementStart('ul', array('class' => 'nav'));
1169         }
1170         if ($have_before) {
1171             $pargs   = array('page' => $page-1);
1172             $this->elementStart('li', array('class' => 'nav_prev'));
1173             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1174                                       'rel' => 'prev'),
1175                            _('After'));
1176             $this->elementEnd('li');
1177         }
1178         if ($have_after) {
1179             $pargs   = array('page' => $page+1);
1180             $this->elementStart('li', array('class' => 'nav_next'));
1181             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1182                                       'rel' => 'next'),
1183                            _('Before'));
1184             $this->elementEnd('li');
1185         }
1186         if ($have_before || $have_after) {
1187             $this->elementEnd('ul');
1188             $this->elementEnd('dd');
1189             $this->elementEnd('dl');
1190         }
1191     }
1192
1193     /**
1194      * An array of feeds for this action.
1195      *
1196      * Returns an array of potential feeds for this action.
1197      *
1198      * @return array Feed object to show in head and links
1199      */
1200
1201     function getFeeds()
1202     {
1203         return null;
1204     }
1205
1206     /**
1207      * A design for this action
1208      *
1209      * @return Design a design object to use
1210      */
1211
1212     function getDesign()
1213     {
1214         return Design::siteDesign();
1215     }
1216
1217     /**
1218      * Check the session token.
1219      *
1220      * Checks that the current form has the correct session token,
1221      * and throw an exception if it does not.
1222      *
1223      * @return void
1224      */
1225
1226     function checkSessionToken()
1227     {
1228         // CSRF protection
1229         $token = $this->trimmed('token');
1230         if (empty($token) || $token != common_session_token()) {
1231             $this->clientError(_('There was a problem with your session token.'));
1232         }
1233     }
1234 }