lib/action.php

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