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