lib/action.php

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