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