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