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