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('dl', array('id' => 'site_nav_global_primary'));
 530         // TRANS: DT element for primary navigation menu. String is hidden in default CSS.
 531         $this->element('dt', null, _('Primary site navigation'));
 532         $this->elementStart('dd');
 533         $this->elementStart('ul', array('class' => 'nav'));
 534         if (Event::handle('StartPrimaryNav', array($this))) {
 535             if ($user) {
 536                 // TRANS: Tooltip for main menu option "Personal"
 537                 $tooltip = _m('TOOLTIP', 'Personal profile and friends timeline');
 538                 $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
 539                                 // TRANS: Main menu option when logged in for access to personal profile and friends timeline
 540                                 _m('MENU', 'Personal'), $tooltip, false, 'nav_home');
 541                 // TRANS: Tooltip for main menu option "Account"
 542                 $tooltip = _m('TOOLTIP', 'Change your email, avatar, password, profile');
 543                 $this->menuItem(common_local_url('profilesettings'),
 544                                 // TRANS: Main menu option when logged in for access to user settings
 545                                 _('Account'), $tooltip, false, 'nav_account');
 546                 // TRANS: Tooltip for main menu option "Services"
 547                 $tooltip = _m('TOOLTIP', 'Connect to services');
 548                 $this->menuItem(common_local_url('oauthconnectionssettings'),
 549                                 // TRANS: Main menu option when logged in and connection are possible for access to options to connect to other services
 550                                 _('Connect'), $tooltip, false, 'nav_connect');
 551                 if ($user->hasRight(Right::CONFIGURESITE)) {
 552                     // TRANS: Tooltip for menu option "Admin"
 553                     $tooltip = _m('TOOLTIP', 'Change site configuration');
 554                     $this->menuItem(common_local_url('siteadminpanel'),
 555                                     // TRANS: Main menu option when logged in and site admin for access to site configuration
 556                                     _m('MENU', 'Admin'), $tooltip, false, 'nav_admin');
 557                 }
 558                 if (common_config('invite', 'enabled')) {
 559                     // TRANS: Tooltip for main menu option "Invite"
 560                     $tooltip = _m('TOOLTIP', 'Invite friends and colleagues to join you on %s');
 561                     $this->menuItem(common_local_url('invite'),
 562                                     // TRANS: Main menu option when logged in and invitations are allowed for inviting new users
 563                                     _m('MENU', 'Invite'),
 564                                     sprintf($tooltip,
 565                                             common_config('site', 'name')),
 566                                     false, 'nav_invitecontact');
 567                 }
 568                 // TRANS: Tooltip for main menu option "Logout"
 569                 $tooltip = _m('TOOLTIP', 'Logout from the site');
 570                 $this->menuItem(common_local_url('logout'),
 571                                 // TRANS: Main menu option when logged in to log out the current user
 572                                 _m('MENU', 'Logout'), $tooltip, false, 'nav_logout');
 573             }
 574             else {
 575                 if (!common_config('site', 'closed') && !common_config('site', 'inviteonly')) {
 576                     // TRANS: Tooltip for main menu option "Register"
 577                     $tooltip = _m('TOOLTIP', 'Create an account');
 578                     $this->menuItem(common_local_url('register'),
 579                                     // TRANS: Main menu option when not logged in to register a new account
 580                                     _m('MENU', 'Register'), $tooltip, false, 'nav_register');
 581                 }
 582                 // TRANS: Tooltip for main menu option "Login"
 583                 $tooltip = _m('TOOLTIP', 'Login to the site');
 584                 $this->menuItem(common_local_url('login'),
 585                                 // TRANS: Main menu option when not logged in to log in
 586                                 _m('MENU', 'Login'), $tooltip, false, 'nav_login');
 587             }
 588             // TRANS: Tooltip for main menu option "Help"
 589             $tooltip = _m('TOOLTIP', 'Help me!');
 590             $this->menuItem(common_local_url('doc', array('title' => 'help')),
 591                             // TRANS: Main menu option for help on the StatusNet site
 592                             _m('MENU', 'Help'), $tooltip, false, 'nav_help');
 593             if ($user || !common_config('site', 'private')) {
 594                 // TRANS: Tooltip for main menu option "Search"
 595                 $tooltip = _m('TOOLTIP', 'Search for people or text');
 596                 $this->menuItem(common_local_url('peoplesearch'),
 597                                 // TRANS: Main menu option when logged in or when the StatusNet instance is not private
 598                                 _m('MENU', 'Search'), $tooltip, false, 'nav_search');
 599             }
 600             Event::handle('EndPrimaryNav', array($this));
 601         }
 602         $this->elementEnd('ul');
 603         $this->elementEnd('dd');
 604         $this->elementEnd('dl');
 605     }
 606
 607     /**
 608      * Show site notice.
 609      *
 610      * @return nothing
 611      */
 612     function showSiteNotice()
 613     {
 614         // Revist. Should probably do an hAtom pattern here
 615         $text = common_config('site', 'notice');
 616         if ($text) {
 617             $this->elementStart('dl', array('id' => 'site_notice',
 618                                             'class' => 'system_notice'));
 619             // TRANS: DT element for site notice. String is hidden in default CSS.
 620             $this->element('dt', null, _('Site notice'));
 621             $this->elementStart('dd', null);
 622             $this->raw($text);
 623             $this->elementEnd('dd');
 624             $this->elementEnd('dl');
 625         }
 626     }
 627
 628     /**
 629      * Show notice form.
 630      *
 631      * MAY overload if no notice form needed... or direct message box????
 632      *
 633      * @return nothing
 634      */
 635     function showNoticeForm()
 636     {
 637         $notice_form = new NoticeForm($this);
 638         $notice_form->show();
 639     }
 640
 641     /**
 642      * Show anonymous message.
 643      *
 644      * SHOULD overload
 645      *
 646      * @return nothing
 647      */
 648     function showAnonymousMessage()
 649     {
 650         // needs to be defined by the class
 651     }
 652
 653     /**
 654      * Show core.
 655      *
 656      * Shows local navigation, content block and aside.
 657      *
 658      * @return nothing
 659      */
 660     function showCore()
 661     {
 662         $this->elementStart('div', array('id' => 'core'));
 663         if (Event::handle('StartShowLocalNavBlock', array($this))) {
 664             $this->showLocalNavBlock();
 665             Event::handle('EndShowLocalNavBlock', array($this));
 666         }
 667         if (Event::handle('StartShowContentBlock', array($this))) {
 668             $this->showContentBlock();
 669             Event::handle('EndShowContentBlock', array($this));
 670         }
 671         if (Event::handle('StartShowAside', array($this))) {
 672             $this->showAside();
 673             Event::handle('EndShowAside', array($this));
 674         }
 675         $this->elementEnd('div');
 676     }
 677
 678     /**
 679      * Show local navigation block.
 680      *
 681      * @return nothing
 682      */
 683     function showLocalNavBlock()
 684     {
 685         $this->elementStart('dl', array('id' => 'site_nav_local_views'));
 686         // TRANS: DT element for local views block. String is hidden in default CSS.
 687         $this->element('dt', null, _('Local views'));
 688         $this->elementStart('dd');
 689         $this->showLocalNav();
 690         $this->elementEnd('dd');
 691         $this->elementEnd('dl');
 692     }
 693
 694     /**
 695      * Show local navigation.
 696      *
 697      * SHOULD overload
 698      *
 699      * @return nothing
 700      */
 701     function showLocalNav()
 702     {
 703         // does nothing by default
 704     }
 705
 706     /**
 707      * Show content block.
 708      *
 709      * @return nothing
 710      */
 711     function showContentBlock()
 712     {
 713         $this->elementStart('div', array('id' => 'content'));
 714         if (Event::handle('StartShowPageTitle', array($this))) {
 715             $this->showPageTitle();
 716             Event::handle('EndShowPageTitle', array($this));
 717         }
 718         $this->showPageNoticeBlock();
 719         $this->elementStart('div', array('id' => 'content_inner'));
 720         // show the actual content (forms, lists, whatever)
 721         $this->showContent();
 722         $this->elementEnd('div');
 723         $this->elementEnd('div');
 724     }
 725
 726     /**
 727      * Show page title.
 728      *
 729      * @return nothing
 730      */
 731     function showPageTitle()
 732     {
 733         $this->element('h1', null, $this->title());
 734     }
 735
 736     /**
 737      * Show page notice block.
 738      *
 739      * Only show the block if a subclassed action has overrided
 740      * Action::showPageNotice(), or an event handler is registered for
 741      * the StartShowPageNotice event, in which case we assume the
 742      * 'page_notice' definition list is desired.  This is to prevent
 743      * empty 'page_notice' definition lists from being output everywhere.
 744      *
 745      * @return nothing
 746      */
 747     function showPageNoticeBlock()
 748     {
 749         $rmethod = new ReflectionMethod($this, 'showPageNotice');
 750         $dclass = $rmethod->getDeclaringClass()->getName();
 751
 752         if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
 753
 754             $this->elementStart('dl', array('id' => 'page_notice',
 755                                             'class' => 'system_notice'));
 756             // TRANS: DT element for page notice. String is hidden in default CSS.
 757             $this->element('dt', null, _('Page notice'));
 758             $this->elementStart('dd');
 759             if (Event::handle('StartShowPageNotice', array($this))) {
 760                 $this->showPageNotice();
 761                 Event::handle('EndShowPageNotice', array($this));
 762             }
 763             $this->elementEnd('dd');
 764             $this->elementEnd('dl');
 765         }
 766     }
 767
 768     /**
 769      * Show page notice.
 770      *
 771      * SHOULD overload (unless there's not a notice)
 772      *
 773      * @return nothing
 774      */
 775     function showPageNotice()
 776     {
 777     }
 778
 779     /**
 780      * Show content.
 781      *
 782      * MUST overload (unless there's not a notice)
 783      *
 784      * @return nothing
 785      */
 786     function showContent()
 787     {
 788     }
 789
 790     /**
 791      * Show Aside.
 792      *
 793      * @return nothing
 794      */
 795     function showAside()
 796     {
 797         $this->elementStart('div', array('id' => 'aside_primary',
 798                                          'class' => 'aside'));
 799         if (Event::handle('StartShowSections', array($this))) {
 800             $this->showSections();
 801             Event::handle('EndShowSections', array($this));
 802         }
 803         if (Event::handle('StartShowExportData', array($this))) {
 804             $this->showExportData();
 805             Event::handle('EndShowExportData', array($this));
 806         }
 807         $this->elementEnd('div');
 808     }
 809
 810     /**
 811      * Show export data feeds.
 812      *
 813      * @return void
 814      */
 815     function showExportData()
 816     {
 817         $feeds = $this->getFeeds();
 818         if ($feeds) {
 819             $fl = new FeedList($this);
 820             $fl->show($feeds);
 821         }
 822     }
 823
 824     /**
 825      * Show sections.
 826      *
 827      * SHOULD overload
 828      *
 829      * @return nothing
 830      */
 831     function showSections()
 832     {
 833         // for each section, show it
 834     }
 835
 836     /**
 837      * Show footer.
 838      *
 839      * @return nothing
 840      */
 841     function showFooter()
 842     {
 843         $this->elementStart('div', array('id' => 'footer'));
 844         $this->showSecondaryNav();
 845         $this->showLicenses();
 846         $this->elementEnd('div');
 847     }
 848
 849     /**
 850      * Show secondary navigation.
 851      *
 852      * @return nothing
 853      */
 854     function showSecondaryNav()
 855     {
 856         $this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
 857         // TRANS: DT element for secondary navigation menu. String is hidden in default CSS.
 858         $this->element('dt', null, _('Secondary site navigation'));
 859         $this->elementStart('dd', null);
 860         $this->elementStart('ul', array('class' => 'nav'));
 861         if (Event::handle('StartSecondaryNav', array($this))) {
 862             $this->menuItem(common_local_url('doc', array('title' => 'help')),
 863                             // TRANS: Secondary navigation menu option leading to help on StatusNet.
 864                             _('Help'));
 865             $this->menuItem(common_local_url('doc', array('title' => 'about')),
 866                             // TRANS: Secondary navigation menu option leading to text about StatusNet site.
 867                             _('About'));
 868             $this->menuItem(common_local_url('doc', array('title' => 'faq')),
 869                             // TRANS: Secondary navigation menu option leading to Frequently Asked Questions.
 870                             _('FAQ'));
 871             $bb = common_config('site', 'broughtby');
 872             if (!empty($bb)) {
 873                 $this->menuItem(common_local_url('doc', array('title' => 'tos')),
 874                                 // TRANS: Secondary navigation menu option leading to Terms of Service.
 875                                 _('TOS'));
 876             }
 877             $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
 878                             // TRANS: Secondary navigation menu option leading to privacy policy.
 879                             _('Privacy'));
 880             $this->menuItem(common_local_url('doc', array('title' => 'source')),
 881                             // TRANS: Secondary navigation menu option. Leads to information about StatusNet and its license.
 882                             _('Source'));
 883             $this->menuItem(common_local_url('version'),
 884                             // TRANS: Secondary navigation menu option leading to version information on the StatusNet site.
 885                             _('Version'));
 886             $this->menuItem(common_local_url('doc', array('title' => 'contact')),
 887                             // TRANS: Secondary navigation menu option leading to e-mail contact information on the
 888                             // TRANS: StatusNet site, where to report bugs, ...
 889                             _('Contact'));
 890             $this->menuItem(common_local_url('doc', array('title' => 'badge')),
 891                             // TRANS: Secondary navigation menu option. Leads to information about embedding a timeline widget.
 892                             _('Badge'));
 893             Event::handle('EndSecondaryNav', array($this));
 894         }
 895         $this->elementEnd('ul');
 896         $this->elementEnd('dd');
 897         $this->elementEnd('dl');
 898     }
 899
 900     /**
 901      * Show licenses.
 902      *
 903      * @return nothing
 904      */
 905     function showLicenses()
 906     {
 907         $this->elementStart('dl', array('id' => 'licenses'));
 908         $this->showStatusNetLicense();
 909         $this->showContentLicense();
 910         $this->elementEnd('dl');
 911     }
 912
 913     /**
 914      * Show StatusNet license.
 915      *
 916      * @return nothing
 917      */
 918     function showStatusNetLicense()
 919     {
 920         // TRANS: DT element for StatusNet software license.
 921         $this->element('dt', array('id' => 'site_statusnet_license'), _('StatusNet software license'));
 922         $this->elementStart('dd', null);
 923         if (common_config('site', 'broughtby')) {
 924             // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is set.
 925             // TRANS: Text between [] is a link description, text between () is the link itself.
 926             // TRANS: Make sure there is no whitespace between "]" and "(".
 927             // TRANS: "%%site.broughtby%%" is the value of the variable site.broughtby
 928             $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%).');
 929         } else {
 930             // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is not set.
 931             $instr = _('**%%site.name%%** is a microblogging service.');
 932         }
 933         $instr .= ' ';
 934         // TRANS: Second sentence of the StatusNet site license. Mentions the StatusNet source code license.
 935         // TRANS: Make sure there is no whitespace between "]" and "(".
 936         // TRANS: Text between [] is a link description, text between () is the link itself.
 937         // TRANS: %s is the version of StatusNet that is being used.
 938         $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);
 939         $output = common_markup_to_html($instr);
 940         $this->raw($output);
 941         $this->elementEnd('dd');
 942         // do it
 943     }
 944
 945     /**
 946      * Show content license.
 947      *
 948      * @return nothing
 949      */
 950     function showContentLicense()
 951     {
 952         if (Event::handle('StartShowContentLicense', array($this))) {
 953             // TRANS: DT element for StatusNet site content license.
 954             $this->element('dt', array('id' => 'site_content_license'), _('Site content license'));
 955             $this->elementStart('dd', array('id' => 'site_content_license_cc'));
 956
 957             switch (common_config('license', 'type')) {
 958             case 'private':
 959                 // TRANS: Content license displayed when license is set to 'private'.
 960                 // TRANS: %1$s is the site name.
 961                 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
 962                                                   common_config('site', 'name')));
 963                 // fall through
 964             case 'allrightsreserved':
 965                 if (common_config('license', 'owner')) {
 966                     // TRANS: Content license displayed when license is set to 'allrightsreserved'.
 967                     // TRANS: %1$s is the copyright owner.
 968                     $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
 969                                                       common_config('license', 'owner')));
 970                 } else {
 971                     // TRANS: Content license displayed when license is set to 'allrightsreserved' and no owner is set.
 972                     $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
 973                 }
 974                 break;
 975             case 'cc': // fall through
 976             default:
 977                 $this->elementStart('p');
 978
 979                 $image    = common_config('license', 'image');
 980                 $sslimage = common_config('license', 'sslimage');
 981
 982                 if (StatusNet::isHTTPS()) {
 983                     if (!empty($sslimage)) {
 984                         $url = $sslimage;
 985                     } else if (preg_match('#^http://i.creativecommons.org/#', $image)) {
 986                         // CC support HTTPS on their images
 987                         $url = preg_replace('/^http/', 'https', $image);
 988                     } else {
 989                         // Better to show mixed content than no content
 990                         $url = $image;
 991                     }
 992                 } else {
 993                     $url = $image;
 994                 }
 995
 996                 $this->element('img', array('id' => 'license_cc',
 997                                             'src' => $url,
 998                                             'alt' => common_config('license', 'title'),
 999                                             'width' => '80',
1000                                             'height' => '15'));
1001                 $this->text(' ');
1002                 // TRANS: license message in footer.
1003                 // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
1004                 $notice = _('All %1$s content and data are available under the %2$s license.');
1005                 $link = "<a class=\"license\" rel=\"external license\" href=\"" .
1006                         htmlspecialchars(common_config('license', 'url')) .
1007                         "\">" .
1008                         htmlspecialchars(common_config('license', 'title')) .
1009                         "</a>";
1010                 $this->raw(sprintf(htmlspecialchars($notice),
1011                                    htmlspecialchars(common_config('site', 'name')),
1012                                    $link));
1013                 $this->elementEnd('p');
1014                 break;
1015             }
1016
1017             $this->elementEnd('dd');
1018             Event::handle('EndShowContentLicense', array($this));
1019         }
1020     }
1021
1022     /**
1023      * Return last modified, if applicable.
1024      *
1025      * MAY override
1026      *
1027      * @return string last modified http header
1028      */
1029     function lastModified()
1030     {
1031         // For comparison with If-Last-Modified
1032         // If not applicable, return null
1033         return null;
1034     }
1035
1036     /**
1037      * Return etag, if applicable.
1038      *
1039      * MAY override
1040      *
1041      * @return string etag http header
1042      */
1043     function etag()
1044     {
1045         return null;
1046     }
1047
1048     /**
1049      * Return true if read only.
1050      *
1051      * MAY override
1052      *
1053      * @param array $args other arguments
1054      *
1055      * @return boolean is read only action?
1056      */
1057     function isReadOnly($args)
1058     {
1059         return false;
1060     }
1061
1062     /**
1063      * Returns query argument or default value if not found
1064      *
1065      * @param string $key requested argument
1066      * @param string $def default value to return if $key is not provided
1067      *
1068      * @return boolean is read only action?
1069      */
1070     function arg($key, $def=null)
1071     {
1072         if (array_key_exists($key, $this->args)) {
1073             return $this->args[$key];
1074         } else {
1075             return $def;
1076         }
1077     }
1078
1079     /**
1080      * Returns trimmed query argument or default value if not found
1081      *
1082      * @param string $key requested argument
1083      * @param string $def default value to return if $key is not provided
1084      *
1085      * @return boolean is read only action?
1086      */
1087     function trimmed($key, $def=null)
1088     {
1089         $arg = $this->arg($key, $def);
1090         return is_string($arg) ? trim($arg) : $arg;
1091     }
1092
1093     /**
1094      * Handler method
1095      *
1096      * @param array $argarray is ignored since it's now passed in in prepare()
1097      *
1098      * @return boolean is read only action?
1099      */
1100     function handle($argarray=null)
1101     {
1102         header('Vary: Accept-Encoding,Cookie');
1103
1104         $lm   = $this->lastModified();
1105         $etag = $this->etag();
1106
1107         if ($etag) {
1108             header('ETag: ' . $etag);
1109         }
1110
1111         if ($lm) {
1112             header('Last-Modified: ' . date(DATE_RFC1123, $lm));
1113             if ($this->isCacheable()) {
1114                 header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1115                 header( "Cache-Control: private, must-revalidate, max-age=0" );
1116                 header( "Pragma:");
1117             }
1118         }
1119
1120         $checked = false;
1121         if ($etag) {
1122             $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
1123               $_SERVER['HTTP_IF_NONE_MATCH'] : null;
1124             if ($if_none_match) {
1125                 // If this check fails, ignore the if-modified-since below.
1126                 $checked = true;
1127                 if ($this->_hasEtag($etag, $if_none_match)) {
1128                     header('HTTP/1.1 304 Not Modified');
1129                     // Better way to do this?
1130                     exit(0);
1131                 }
1132             }
1133         }
1134
1135         if (!$checked && $lm && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
1136             $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
1137             $ims = strtotime($if_modified_since);
1138             if ($lm <= $ims) {
1139                 header('HTTP/1.1 304 Not Modified');
1140                 // Better way to do this?
1141                 exit(0);
1142             }
1143         }
1144     }
1145
1146     /**
1147      * Is this action cacheable?
1148      *
1149      * If the action returns a last-modified
1150      *
1151      * @param array $argarray is ignored since it's now passed in in prepare()
1152      *
1153      * @return boolean is read only action?
1154      */
1155     function isCacheable()
1156     {
1157         return true;
1158     }
1159
1160     /**
1161      * Has etag? (private)
1162      *
1163      * @param string $etag          etag http header
1164      * @param string $if_none_match ifNoneMatch http header
1165      *
1166      * @return boolean
1167      */
1168     function _hasEtag($etag, $if_none_match)
1169     {
1170         $etags = explode(',', $if_none_match);
1171         return in_array($etag, $etags) || in_array('*', $etags);
1172     }
1173
1174     /**
1175      * Boolean understands english (yes, no, true, false)
1176      *
1177      * @param string $key query key we're interested in
1178      * @param string $def default value
1179      *
1180      * @return boolean interprets yes/no strings as boolean
1181      */
1182     function boolean($key, $def=false)
1183     {
1184         $arg = strtolower($this->trimmed($key));
1185
1186         if (is_null($arg)) {
1187             return $def;
1188         } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1189             return true;
1190         } else if (in_array($arg, array('false', 'no', '0'))) {
1191             return false;
1192         } else {
1193             return $def;
1194         }
1195     }
1196
1197     /**
1198      * Integer value of an argument
1199      *
1200      * @param string $key      query key we're interested in
1201      * @param string $defValue optional default value (default null)
1202      * @param string $maxValue optional max value (default null)
1203      * @param string $minValue optional min value (default null)
1204      *
1205      * @return integer integer value
1206      */
1207     function int($key, $defValue=null, $maxValue=null, $minValue=null)
1208     {
1209         $arg = strtolower($this->trimmed($key));
1210
1211         if (is_null($arg) || !is_integer($arg)) {
1212             return $defValue;
1213         }
1214
1215         if (!is_null($maxValue)) {
1216             $arg = min($arg, $maxValue);
1217         }
1218
1219         if (!is_null($minValue)) {
1220             $arg = max($arg, $minValue);
1221         }
1222
1223         return $arg;
1224     }
1225
1226     /**
1227      * Server error
1228      *
1229      * @param string  $msg  error message to display
1230      * @param integer $code http error code, 500 by default
1231      *
1232      * @return nothing
1233      */
1234     function serverError($msg, $code=500)
1235     {
1236         $action = $this->trimmed('action');
1237         common_debug("Server error '$code' on '$action': $msg", __FILE__);
1238         throw new ServerException($msg, $code);
1239     }
1240
1241     /**
1242      * Client error
1243      *
1244      * @param string  $msg  error message to display
1245      * @param integer $code http error code, 400 by default
1246      *
1247      * @return nothing
1248      */
1249     function clientError($msg, $code=400)
1250     {
1251         $action = $this->trimmed('action');
1252         common_debug("User error '$code' on '$action': $msg", __FILE__);
1253         throw new ClientException($msg, $code);
1254     }
1255
1256     /**
1257      * Returns the current URL
1258      *
1259      * @return string current URL
1260      */
1261     function selfUrl()
1262     {
1263         list($action, $args) = $this->returnToArgs();
1264         return common_local_url($action, $args);
1265     }
1266
1267     /**
1268      * Returns arguments sufficient for re-constructing URL
1269      *
1270      * @return array two elements: action, other args
1271      */
1272     function returnToArgs()
1273     {
1274         $action = $this->trimmed('action');
1275         $args   = $this->args;
1276         unset($args['action']);
1277         if (common_config('site', 'fancy')) {
1278             unset($args['p']);
1279         }
1280         if (array_key_exists('submit', $args)) {
1281             unset($args['submit']);
1282         }
1283         foreach (array_keys($_COOKIE) as $cookie) {
1284             unset($args[$cookie]);
1285         }
1286         return array($action, $args);
1287     }
1288
1289     /**
1290      * Generate a menu item
1291      *
1292      * @param string  $url         menu URL
1293      * @param string  $text        menu name
1294      * @param string  $title       title attribute, null by default
1295      * @param boolean $is_selected current menu item, false by default
1296      * @param string  $id          element id, null by default
1297      *
1298      * @return nothing
1299      */
1300     function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1301     {
1302         // Added @id to li for some control.
1303         // XXX: We might want to move this to htmloutputter.php
1304         $lattrs = array();
1305         if ($is_selected) {
1306             $lattrs['class'] = 'current';
1307         }
1308
1309         (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1310
1311         $this->elementStart('li', $lattrs);
1312         $attrs['href'] = $url;
1313         if ($title) {
1314             $attrs['title'] = $title;
1315         }
1316         $this->element('a', $attrs, $text);
1317         $this->elementEnd('li');
1318     }
1319
1320     /**
1321      * Generate pagination links
1322      *
1323      * @param boolean $have_before is there something before?
1324      * @param boolean $have_after  is there something after?
1325      * @param integer $page        current page
1326      * @param string  $action      current action
1327      * @param array   $args        rest of query arguments
1328      *
1329      * @return nothing
1330      */
1331     // XXX: The messages in this pagination method only tailor to navigating
1332     //      notices. In other lists, "Previous"/"Next" type navigation is
1333     //      desirable, but not available.
1334     function pagination($have_before, $have_after, $page, $action, $args=null)
1335     {
1336         // Does a little before-after block for next/prev page
1337         if ($have_before || $have_after) {
1338             $this->elementStart('dl', 'pagination');
1339             // TRANS: DT element for pagination (previous/next, etc.).
1340             $this->element('dt', null, _('Pagination'));
1341             $this->elementStart('dd', null);
1342             $this->elementStart('ul', array('class' => 'nav'));
1343         }
1344         if ($have_before) {
1345             $pargs   = array('page' => $page-1);
1346             $this->elementStart('li', array('class' => 'nav_prev'));
1347             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1348                                       'rel' => 'prev'),
1349                            // TRANS: Pagination message to go to a page displaying information more in the
1350                            // TRANS: present than the currently displayed information.
1351                            _('After'));
1352             $this->elementEnd('li');
1353         }
1354         if ($have_after) {
1355             $pargs   = array('page' => $page+1);
1356             $this->elementStart('li', array('class' => 'nav_next'));
1357             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1358                                       'rel' => 'next'),
1359                            // TRANS: Pagination message to go to a page displaying information more in the
1360                            // TRANS: past than the currently displayed information.
1361                            _('Before'));
1362             $this->elementEnd('li');
1363         }
1364         if ($have_before || $have_after) {
1365             $this->elementEnd('ul');
1366             $this->elementEnd('dd');
1367             $this->elementEnd('dl');
1368         }
1369     }
1370
1371     /**
1372      * An array of feeds for this action.
1373      *
1374      * Returns an array of potential feeds for this action.
1375      *
1376      * @return array Feed object to show in head and links
1377      */
1378     function getFeeds()
1379     {
1380         return null;
1381     }
1382
1383     /**
1384      * A design for this action
1385      *
1386      * @return Design a design object to use
1387      */
1388     function getDesign()
1389     {
1390         return Design::siteDesign();
1391     }
1392
1393     /**
1394      * Check the session token.
1395      *
1396      * Checks that the current form has the correct session token,
1397      * and throw an exception if it does not.
1398      *
1399      * @return void
1400      */
1401     // XXX: Finding this type of check with the same message about 50 times.
1402     //      Possible to refactor?
1403     function checkSessionToken()
1404     {
1405         // CSRF protection
1406         $token = $this->trimmed('token');
1407         if (empty($token) || $token != common_session_token()) {
1408             // TRANS: Client error text when there is a problem with the session token.
1409             $this->clientError(_('There was a problem with your session token.'));
1410         }
1411     }
1412
1413     /**
1414      * Check if the current request is a POST
1415      *
1416      * @return boolean true if POST; otherwise false.
1417      */
1418
1419     function isPost()
1420     {
1421         return ($_SERVER['REQUEST_METHOD'] == 'POST');
1422     }
1423 }