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