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