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