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