lib/action.php

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