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');
 202                 $this->cssLink('css/print.css','base','print');
 203                 Event::handle('EndShowStatusNetStyles', array($this));
 204                 Event::handle('EndShowLaconicaStyles', array($this));
 205             }
 206
 207             if (Event::handle('StartShowUAStyles', array($this))) {
 208                 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
 209                                'href="'.Theme::path('css/ie.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
 210                 foreach (array(6,7) as $ver) {
 211                     if (file_exists(Theme::file('css/ie'.$ver.'.css', 'base'))) {
 212                         // Yes, IE people should be put in jail.
 213                         $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
 214                                        'href="'.Theme::path('css/ie'.$ver.'.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
 215                     }
 216                 }
 217                 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
 218                                'href="'.Theme::path('css/ie.css', null).'?version='.STATUSNET_VERSION.'" /><![endif]');
 219                 Event::handle('EndShowUAStyles', array($this));
 220             }
 221
 222             if (Event::handle('StartShowDesign', array($this))) {
 223
 224                 $user = common_current_user();
 225
 226                 if (empty($user) || $user->viewdesigns) {
 227                     $design = $this->getDesign();
 228
 229                     if (!empty($design)) {
 230                         $design->showCSS($this);
 231                     }
 232                 }
 233
 234                 Event::handle('EndShowDesign', array($this));
 235             }
 236             Event::handle('EndShowStyles', array($this));
 237         }
 238     }
 239
 240     /**
 241      * Show javascript headers
 242      *
 243      * @return nothing
 244      */
 245     function showScripts()
 246     {
 247         if (Event::handle('StartShowScripts', array($this))) {
 248             if (Event::handle('StartShowJQueryScripts', array($this))) {
 249                 $this->script('jquery.min.js');
 250                 $this->script('jquery.form.js');
 251                 $this->script('jquery.cookie.js');
 252                 $this->inlineScript('if (typeof window.JSON !== "object") { $.getScript("'.common_path('js/json2.js').'"); }');
 253                 $this->script('jquery.joverlay.min.js');
 254                 Event::handle('EndShowJQueryScripts', array($this));
 255             }
 256             if (Event::handle('StartShowStatusNetScripts', array($this)) &&
 257                 Event::handle('StartShowLaconicaScripts', array($this))) {
 258                 $this->script('xbImportNode.js');
 259                 $this->script('util.js');
 260                 $this->script('geometa.js');
 261                 // Frame-busting code to avoid clickjacking attacks.
 262                 $this->inlineScript('if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
 263                 Event::handle('EndShowStatusNetScripts', array($this));
 264                 Event::handle('EndShowLaconicaScripts', array($this));
 265             }
 266             Event::handle('EndShowScripts', array($this));
 267         }
 268     }
 269
 270     /**
 271      * Show OpenSearch headers
 272      *
 273      * @return nothing
 274      */
 275     function showOpenSearch()
 276     {
 277         $this->element('link', array('rel' => 'search',
 278                                      'type' => 'application/opensearchdescription+xml',
 279                                      'href' =>  common_local_url('opensearch', array('type' => 'people')),
 280                                      'title' => common_config('site', 'name').' People Search'));
 281         $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
 282                                      'href' =>  common_local_url('opensearch', array('type' => 'notice')),
 283                                      'title' => common_config('site', 'name').' Notice Search'));
 284     }
 285
 286     /**
 287      * Show feed headers
 288      *
 289      * MAY overload
 290      *
 291      * @return nothing
 292      */
 293
 294     function showFeeds()
 295     {
 296         $feeds = $this->getFeeds();
 297
 298         if ($feeds) {
 299             foreach ($feeds as $feed) {
 300                 $this->element('link', array('rel' => $feed->rel(),
 301                                              'href' => $feed->url,
 302                                              'type' => $feed->mimeType(),
 303                                              'title' => $feed->title));
 304             }
 305         }
 306     }
 307
 308     /**
 309      * Show description.
 310      *
 311      * SHOULD overload
 312      *
 313      * @return nothing
 314      */
 315     function showDescription()
 316     {
 317         // does nothing by default
 318     }
 319
 320     /**
 321      * Show extra stuff in <head>.
 322      *
 323      * MAY overload
 324      *
 325      * @return nothing
 326      */
 327     function extraHead()
 328     {
 329         // does nothing by default
 330     }
 331
 332     /**
 333      * Show body.
 334      *
 335      * Calls template methods
 336      *
 337      * @return nothing
 338      */
 339     function showBody()
 340     {
 341         $this->elementStart('body', (common_current_user()) ? array('id' => $this->trimmed('action'),
 342                                                                     'class' => 'user_in')
 343                             : array('id' => $this->trimmed('action')));
 344         $this->elementStart('div', array('id' => 'wrap'));
 345         if (Event::handle('StartShowHeader', array($this))) {
 346             $this->showHeader();
 347             Event::handle('EndShowHeader', array($this));
 348         }
 349         $this->showCore();
 350         if (Event::handle('StartShowFooter', array($this))) {
 351             $this->showFooter();
 352             Event::handle('EndShowFooter', array($this));
 353         }
 354         $this->elementEnd('div');
 355         $this->showScripts();
 356         $this->elementEnd('body');
 357     }
 358
 359     /**
 360      * Show header of the page.
 361      *
 362      * Calls template methods
 363      *
 364      * @return nothing
 365      */
 366     function showHeader()
 367     {
 368         $this->elementStart('div', array('id' => 'header'));
 369         $this->showLogo();
 370         $this->showPrimaryNav();
 371         if (Event::handle('StartShowSiteNotice', array($this))) {
 372             $this->showSiteNotice();
 373
 374             Event::handle('EndShowSiteNotice', array($this));
 375         }
 376         if (common_logged_in()) {
 377             $this->showNoticeForm();
 378         } else {
 379             $this->showAnonymousMessage();
 380         }
 381         $this->elementEnd('div');
 382     }
 383
 384     /**
 385      * Show configured logo.
 386      *
 387      * @return nothing
 388      */
 389     function showLogo()
 390     {
 391         $this->elementStart('address', array('id' => 'site_contact',
 392                                              'class' => 'vcard'));
 393         if (Event::handle('StartAddressData', array($this))) {
 394             if (common_config('singleuser', 'enabled')) {
 395                 $url = common_local_url('showstream',
 396                                         array('nickname' => common_config('singleuser', 'nickname')));
 397             } else {
 398                 $url = common_local_url('public');
 399             }
 400             $this->elementStart('a', array('class' => 'url home bookmark',
 401                                            'href' => $url));
 402             if (common_config('site', 'logo') || file_exists(Theme::file('logo.png'))) {
 403                 $this->element('img', array('class' => 'logo photo',
 404                                             'src' => (common_config('site', 'logo')) ? common_config('site', 'logo') : Theme::path('logo.png'),
 405                                             'alt' => common_config('site', 'name')));
 406             }
 407             $this->text(' ');
 408             $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
 409             $this->elementEnd('a');
 410             Event::handle('EndAddressData', array($this));
 411         }
 412         $this->elementEnd('address');
 413     }
 414
 415     /**
 416      * Show primary navigation.
 417      *
 418      * @return nothing
 419      */
 420     function showPrimaryNav()
 421     {
 422         $user = common_current_user();
 423         $connect = '';
 424         if (common_config('xmpp', 'enabled')) {
 425             $connect = 'imsettings';
 426         } else if (common_config('sms', 'enabled')) {
 427             $connect = 'smssettings';
 428         }
 429
 430         $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
 431         $this->element('dt', null, _('Primary site navigation'));
 432         $this->elementStart('dd');
 433         $this->elementStart('ul', array('class' => 'nav'));
 434         if (Event::handle('StartPrimaryNav', array($this))) {
 435             if ($user) {
 436                 // TRANS: Tooltip for main menu option "Personal"
 437                 $tooltip = _m('TOOLTIP', 'Personal profile and friends timeline');
 438                 // TRANS: Main menu option when logged in for access to personal profile and friends timeline
 439                 $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
 440                                 _m('MENU', 'Personal'), $tooltip, false, 'nav_home');
 441                 // TRANS: Tooltip for main menu option "Account"
 442                 $tooltip = _m('TOOLTIP', 'Change your email, avatar, password, profile');
 443                 // TRANS: Main menu option when logged in for access to user settings
 444                 $this->menuItem(common_local_url('profilesettings'),
 445                                 _m('MENU', 'Account'), $tooltip, false, 'nav_account');
 446                 if ($connect) {
 447                     // TRANS: Tooltip for main menu option "Services"
 448                     $tooltip = _m('TOOLTIP', 'Connect to services');
 449                     // TRANS: Main menu option when logged in and connection are possible for access to options to connect to other services
 450                     $this->menuItem(common_local_url($connect),
 451                                     _m('MENU', 'Connect'), $tooltip, false, 'nav_connect');
 452                 }
 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')) {
 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         if (common_config('site', 'broughtby')) {
 811             $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
 812         } else {
 813             $instr = _('**%%site.name%%** is a microblogging service. ');
 814         }
 815         $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);
 816         $output = common_markup_to_html($instr);
 817         $this->raw($output);
 818         $this->elementEnd('dd');
 819         // do it
 820     }
 821
 822     /**
 823      * Show content license.
 824      *
 825      * @return nothing
 826      */
 827     function showContentLicense()
 828     {
 829         if (Event::handle('StartShowContentLicense', array($this))) {
 830             $this->element('dt', array('id' => 'site_content_license'), _('Site content license'));
 831             $this->elementStart('dd', array('id' => 'site_content_license_cc'));
 832
 833             switch (common_config('license', 'type')) {
 834             case 'private':
 835                 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
 836                                                   common_config('site', 'name')));
 837                 // fall through
 838             case 'allrightsreserved':
 839                 if (common_config('license', 'owner')) {
 840                     $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
 841                                                       common_config('license', 'owner')));
 842                 } else {
 843                     $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
 844                 }
 845                 break;
 846             case 'cc': // fall through
 847             default:
 848                 $this->elementStart('p');
 849                 $this->element('img', array('id' => 'license_cc',
 850                                             'src' => common_config('license', 'image'),
 851                                             'alt' => common_config('license', 'title'),
 852                                             'width' => '80',
 853                                             'height' => '15'));
 854                 $this->text(' ');
 855                 //TODO: This is dirty: i18n
 856                 $this->text(_('All '.common_config('site', 'name').' content and data are available under the '));
 857                 $this->element('a', array('class' => 'license',
 858                                           'rel' => 'external license',
 859                                           'href' => common_config('license', 'url')),
 860                                common_config('license', 'title'));
 861                 $this->text(' ');
 862                 $this->text(_('license.'));
 863                 $this->elementEnd('p');
 864                 break;
 865             }
 866
 867             $this->elementEnd('dd');
 868             Event::handle('EndShowContentLicense', array($this));
 869         }
 870     }
 871
 872     /**
 873      * Return last modified, if applicable.
 874      *
 875      * MAY override
 876      *
 877      * @return string last modified http header
 878      */
 879     function lastModified()
 880     {
 881         // For comparison with If-Last-Modified
 882         // If not applicable, return null
 883         return null;
 884     }
 885
 886     /**
 887      * Return etag, if applicable.
 888      *
 889      * MAY override
 890      *
 891      * @return string etag http header
 892      */
 893     function etag()
 894     {
 895         return null;
 896     }
 897
 898     /**
 899      * Return true if read only.
 900      *
 901      * MAY override
 902      *
 903      * @param array $args other arguments
 904      *
 905      * @return boolean is read only action?
 906      */
 907
 908     function isReadOnly($args)
 909     {
 910         return false;
 911     }
 912
 913     /**
 914      * Returns query argument or default value if not found
 915      *
 916      * @param string $key requested argument
 917      * @param string $def default value to return if $key is not provided
 918      *
 919      * @return boolean is read only action?
 920      */
 921     function arg($key, $def=null)
 922     {
 923         if (array_key_exists($key, $this->args)) {
 924             return $this->args[$key];
 925         } else {
 926             return $def;
 927         }
 928     }
 929
 930     /**
 931      * Returns trimmed query argument or default value if not found
 932      *
 933      * @param string $key requested argument
 934      * @param string $def default value to return if $key is not provided
 935      *
 936      * @return boolean is read only action?
 937      */
 938     function trimmed($key, $def=null)
 939     {
 940         $arg = $this->arg($key, $def);
 941         return is_string($arg) ? trim($arg) : $arg;
 942     }
 943
 944     /**
 945      * Handler method
 946      *
 947      * @param array $argarray is ignored since it's now passed in in prepare()
 948      *
 949      * @return boolean is read only action?
 950      */
 951     function handle($argarray=null)
 952     {
 953         header('Vary: Accept-Encoding,Cookie');
 954         $lm   = $this->lastModified();
 955         $etag = $this->etag();
 956         if ($etag) {
 957             header('ETag: ' . $etag);
 958         }
 959         if ($lm) {
 960             header('Last-Modified: ' . date(DATE_RFC1123, $lm));
 961             if (array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
 962                 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
 963                 $ims = strtotime($if_modified_since);
 964                 if ($lm <= $ims) {
 965                     $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
 966                       $_SERVER['HTTP_IF_NONE_MATCH'] : null;
 967                     if (!$if_none_match ||
 968                         !$etag ||
 969                         $this->_hasEtag($etag, $if_none_match)) {
 970                         header('HTTP/1.1 304 Not Modified');
 971                         // Better way to do this?
 972                         exit(0);
 973                     }
 974                 }
 975             }
 976         }
 977     }
 978
 979     /**
 980      * Has etag? (private)
 981      *
 982      * @param string $etag          etag http header
 983      * @param string $if_none_match ifNoneMatch http header
 984      *
 985      * @return boolean
 986      */
 987
 988     function _hasEtag($etag, $if_none_match)
 989     {
 990         $etags = explode(',', $if_none_match);
 991         return in_array($etag, $etags) || in_array('*', $etags);
 992     }
 993
 994     /**
 995      * Boolean understands english (yes, no, true, false)
 996      *
 997      * @param string $key query key we're interested in
 998      * @param string $def default value
 999      *
1000      * @return boolean interprets yes/no strings as boolean
1001      */
1002     function boolean($key, $def=false)
1003     {
1004         $arg = strtolower($this->trimmed($key));
1005
1006         if (is_null($arg)) {
1007             return $def;
1008         } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1009             return true;
1010         } else if (in_array($arg, array('false', 'no', '0'))) {
1011             return false;
1012         } else {
1013             return $def;
1014         }
1015     }
1016
1017     /**
1018      * Integer value of an argument
1019      *
1020      * @param string $key      query key we're interested in
1021      * @param string $defValue optional default value (default null)
1022      * @param string $maxValue optional max value (default null)
1023      * @param string $minValue optional min value (default null)
1024      *
1025      * @return integer integer value
1026      */
1027
1028     function int($key, $defValue=null, $maxValue=null, $minValue=null)
1029     {
1030         $arg = strtolower($this->trimmed($key));
1031
1032         if (is_null($arg) || !is_integer($arg)) {
1033             return $defValue;
1034         }
1035
1036         if (!is_null($maxValue)) {
1037             $arg = min($arg, $maxValue);
1038         }
1039
1040         if (!is_null($minValue)) {
1041             $arg = max($arg, $minValue);
1042         }
1043
1044         return $arg;
1045     }
1046
1047     /**
1048      * Server error
1049      *
1050      * @param string  $msg  error message to display
1051      * @param integer $code http error code, 500 by default
1052      *
1053      * @return nothing
1054      */
1055
1056     function serverError($msg, $code=500)
1057     {
1058         $action = $this->trimmed('action');
1059         common_debug("Server error '$code' on '$action': $msg", __FILE__);
1060         throw new ServerException($msg, $code);
1061     }
1062
1063     /**
1064      * Client error
1065      *
1066      * @param string  $msg  error message to display
1067      * @param integer $code http error code, 400 by default
1068      *
1069      * @return nothing
1070      */
1071
1072     function clientError($msg, $code=400)
1073     {
1074         $action = $this->trimmed('action');
1075         common_debug("User error '$code' on '$action': $msg", __FILE__);
1076         throw new ClientException($msg, $code);
1077     }
1078
1079     /**
1080      * Returns the current URL
1081      *
1082      * @return string current URL
1083      */
1084
1085     function selfUrl()
1086     {
1087         list($action, $args) = $this->returnToArgs();
1088         return common_local_url($action, $args);
1089     }
1090
1091     /**
1092      * Returns arguments sufficient for re-constructing URL
1093      *
1094      * @return array two elements: action, other args
1095      */
1096
1097     function returnToArgs()
1098     {
1099         $action = $this->trimmed('action');
1100         $args   = $this->args;
1101         unset($args['action']);
1102         if (common_config('site', 'fancy')) {
1103             unset($args['p']);
1104         }
1105         if (array_key_exists('submit', $args)) {
1106             unset($args['submit']);
1107         }
1108         foreach (array_keys($_COOKIE) as $cookie) {
1109             unset($args[$cookie]);
1110         }
1111         return array($action, $args);
1112     }
1113
1114     /**
1115      * Generate a menu item
1116      *
1117      * @param string  $url         menu URL
1118      * @param string  $text        menu name
1119      * @param string  $title       title attribute, null by default
1120      * @param boolean $is_selected current menu item, false by default
1121      * @param string  $id          element id, null by default
1122      *
1123      * @return nothing
1124      */
1125     function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1126     {
1127         // Added @id to li for some control.
1128         // XXX: We might want to move this to htmloutputter.php
1129         $lattrs = array();
1130         if ($is_selected) {
1131             $lattrs['class'] = 'current';
1132         }
1133
1134         (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1135
1136         $this->elementStart('li', $lattrs);
1137         $attrs['href'] = $url;
1138         if ($title) {
1139             $attrs['title'] = $title;
1140         }
1141         $this->element('a', $attrs, $text);
1142         $this->elementEnd('li');
1143     }
1144
1145     /**
1146      * Generate pagination links
1147      *
1148      * @param boolean $have_before is there something before?
1149      * @param boolean $have_after  is there something after?
1150      * @param integer $page        current page
1151      * @param string  $action      current action
1152      * @param array   $args        rest of query arguments
1153      *
1154      * @return nothing
1155      */
1156     function pagination($have_before, $have_after, $page, $action, $args=null)
1157     {
1158         // Does a little before-after block for next/prev page
1159         if ($have_before || $have_after) {
1160             $this->elementStart('dl', 'pagination');
1161             $this->element('dt', null, _('Pagination'));
1162             $this->elementStart('dd', null);
1163             $this->elementStart('ul', array('class' => 'nav'));
1164         }
1165         if ($have_before) {
1166             $pargs   = array('page' => $page-1);
1167             $this->elementStart('li', array('class' => 'nav_prev'));
1168             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1169                                       'rel' => 'prev'),
1170                            _('After'));
1171             $this->elementEnd('li');
1172         }
1173         if ($have_after) {
1174             $pargs   = array('page' => $page+1);
1175             $this->elementStart('li', array('class' => 'nav_next'));
1176             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1177                                       'rel' => 'next'),
1178                            _('Before'));
1179             $this->elementEnd('li');
1180         }
1181         if ($have_before || $have_after) {
1182             $this->elementEnd('ul');
1183             $this->elementEnd('dd');
1184             $this->elementEnd('dl');
1185         }
1186     }
1187
1188     /**
1189      * An array of feeds for this action.
1190      *
1191      * Returns an array of potential feeds for this action.
1192      *
1193      * @return array Feed object to show in head and links
1194      */
1195
1196     function getFeeds()
1197     {
1198         return null;
1199     }
1200
1201     /**
1202      * A design for this action
1203      *
1204      * @return Design a design object to use
1205      */
1206
1207     function getDesign()
1208     {
1209         return Design::siteDesign();
1210     }
1211
1212     /**
1213      * Check the session token.
1214      *
1215      * Checks that the current form has the correct session token,
1216      * and throw an exception if it does not.
1217      *
1218      * @return void
1219      */
1220
1221     function checkSessionToken()
1222     {
1223         // CSRF protection
1224         $token = $this->trimmed('token');
1225         if (empty($token) || $token != common_session_token()) {
1226             $this->clientError(_('There was a problem with your session token.'));
1227         }
1228     }
1229 }