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