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