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