lib/action.php

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