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