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