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