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