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