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