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