lib/action.php

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