lib/action.php

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