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