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