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
 468         $this->elementEnd('div');
 469     }
 470
 471     /**
 472      * Show configured logo.
 473      *
 474      * @return nothing
 475      */
 476     function showLogo()
 477     {
 478         $this->elementStart('address', array('id' => 'site_contact',
 479                                              'class' => 'vcard'));
 480         if (Event::handle('StartAddressData', array($this))) {
 481             if (common_config('singleuser', 'enabled')) {
 482                 $user = User::singleUser();
 483                 $url = common_local_url('showstream',
 484                                         array('nickname' => $user->nickname));
 485             } else if (common_logged_in()) {
 486                 $cur = common_current_user();
 487                 $url = common_local_url('all', array('nickname' => $cur->nickname));
 488             } else {
 489                 $url = common_local_url('public');
 490             }
 491
 492             $this->elementStart('a', array('class' => 'url home bookmark',
 493                                            'href' => $url));
 494
 495             if (StatusNet::isHTTPS()) {
 496                 $logoUrl = common_config('site', 'ssllogo');
 497                 if (empty($logoUrl)) {
 498                     // if logo is an uploaded file, try to fall back to HTTPS file URL
 499                     $httpUrl = common_config('site', 'logo');
 500                     if (!empty($httpUrl)) {
 501                         $f = File::staticGet('url', $httpUrl);
 502                         if (!empty($f) && !empty($f->filename)) {
 503                             // this will handle the HTTPS case
 504                             $logoUrl = File::url($f->filename);
 505                         }
 506                     }
 507                 }
 508             } else {
 509                 $logoUrl = common_config('site', 'logo');
 510             }
 511
 512             if (empty($logoUrl) && file_exists(Theme::file('logo.png'))) {
 513                 // This should handle the HTTPS case internally
 514                 $logoUrl = Theme::path('logo.png');
 515             }
 516
 517             if (!empty($logoUrl)) {
 518                 $this->element('img', array('class' => 'logo photo',
 519                                             'src' => $logoUrl,
 520                                             'alt' => common_config('site', 'name')));
 521             }
 522
 523             $this->text(' ');
 524             $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
 525             $this->elementEnd('a');
 526
 527             Event::handle('EndAddressData', array($this));
 528         }
 529         $this->elementEnd('address');
 530     }
 531
 532     /**
 533      * Show primary navigation.
 534      *
 535      * @return nothing
 536      */
 537     function showPrimaryNav()
 538     {
 539         $this->elementStart('div', array('id' => 'site_nav_global_primary'));
 540         $pn = new PrimaryNav($this);
 541         $pn->show();
 542         $this->elementEnd('div');
 543     }
 544
 545     /**
 546      * Show site notice.
 547      *
 548      * @return nothing
 549      */
 550     function showSiteNotice()
 551     {
 552         // Revist. Should probably do an hAtom pattern here
 553         $text = common_config('site', 'notice');
 554         if ($text) {
 555             $this->elementStart('div', array('id' => 'site_notice',
 556                                             'class' => 'system_notice'));
 557             $this->raw($text);
 558             $this->elementEnd('div');
 559         }
 560     }
 561
 562     /**
 563      * Show notice form.
 564      *
 565      * MAY overload if no notice form needed... or direct message box????
 566      *
 567      * @return nothing
 568      */
 569     function showNoticeForm()
 570     {
 571         $notice_form = new NoticeForm($this);
 572         $notice_form->show();
 573     }
 574
 575     /**
 576      * Show anonymous message.
 577      *
 578      * SHOULD overload
 579      *
 580      * @return nothing
 581      */
 582     function showAnonymousMessage()
 583     {
 584         // needs to be defined by the class
 585     }
 586
 587     /**
 588      * Show core.
 589      *
 590      * Shows local navigation, content block and aside.
 591      *
 592      * @return nothing
 593      */
 594     function showCore()
 595     {
 596         $this->elementStart('div', array('id' => 'core'));
 597         if (Event::handle('StartShowLocalNavBlock', array($this))) {
 598             $this->showLocalNavBlock();
 599             Event::handle('EndShowLocalNavBlock', array($this));
 600         }
 601         if (Event::handle('StartShowContentBlock', array($this))) {
 602             $this->showContentBlock();
 603             Event::handle('EndShowContentBlock', array($this));
 604         }
 605         if (Event::handle('StartShowObjectNavBlock', array($this))) {
 606             $this->showObjectNavBlock();
 607             Event::handle('EndShowObjectNavBlock', array($this));
 608         }
 609         if (Event::handle('StartShowAside', array($this))) {
 610             $this->showAside();
 611             Event::handle('EndShowAside', array($this));
 612         }
 613         $this->elementEnd('div');
 614     }
 615
 616     /**
 617      * Show local navigation block.
 618      *
 619      * @return nothing
 620      */
 621     function showLocalNavBlock()
 622     {
 623         // Need to have this ID for CSS; I'm too lazy to add it to
 624         // all menus
 625         $this->elementStart('div', array('id' => 'site_nav_local_views'));
 626         $this->showLocalNav();
 627         $this->elementEnd('div');
 628     }
 629
 630     /**
 631      * Show local navigation.
 632      *
 633      * SHOULD overload
 634      *
 635      * @return nothing
 636      */
 637     function showLocalNav()
 638     {
 639         $nav = new DefaultLocalNav($this);
 640         $nav->show();
 641     }
 642
 643     /**
 644      * Show menu for an object (group, profile)
 645      *
 646      * @return nothing
 647      */
 648     function showObjectNavBlock()
 649     {
 650         // Need to have this ID for CSS; I'm too lazy to add it to
 651         // all menus
 652         $this->elementStart('div', array('id' => 'site_nav_object'));
 653         $this->showObjectNav();
 654         $this->elementEnd('div');
 655     }
 656
 657     /**
 658      * Show object navigation.
 659      *
 660      * If there are things to do with this object, show it here.
 661      *
 662      * @return nothing
 663      */
 664     function showObjectNav()
 665     {
 666         /* Nothing here. */
 667     }
 668
 669     /**
 670      * Show content block.
 671      *
 672      * @return nothing
 673      */
 674     function showContentBlock()
 675     {
 676         $this->elementStart('div', array('id' => 'content'));
 677         if (common_logged_in()) {
 678             if (Event::handle('StartShowNoticeForm', array($this))) {
 679                 $this->showNoticeForm();
 680                 Event::handle('EndShowNoticeForm', array($this));
 681             }
 682         }
 683         if (Event::handle('StartShowPageTitle', array($this))) {
 684             $this->showPageTitle();
 685             Event::handle('EndShowPageTitle', array($this));
 686         }
 687         $this->showPageNoticeBlock();
 688         $this->elementStart('div', array('id' => 'content_inner'));
 689         // show the actual content (forms, lists, whatever)
 690         $this->showContent();
 691         $this->elementEnd('div');
 692         $this->elementEnd('div');
 693     }
 694
 695     /**
 696      * Show page title.
 697      *
 698      * @return nothing
 699      */
 700     function showPageTitle()
 701     {
 702         $this->element('h1', null, $this->title());
 703     }
 704
 705     /**
 706      * Show page notice block.
 707      *
 708      * Only show the block if a subclassed action has overrided
 709      * Action::showPageNotice(), or an event handler is registered for
 710      * the StartShowPageNotice event, in which case we assume the
 711      * 'page_notice' definition list is desired.  This is to prevent
 712      * empty 'page_notice' definition lists from being output everywhere.
 713      *
 714      * @return nothing
 715      */
 716     function showPageNoticeBlock()
 717     {
 718         $rmethod = new ReflectionMethod($this, 'showPageNotice');
 719         $dclass = $rmethod->getDeclaringClass()->getName();
 720
 721         if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
 722
 723             $this->elementStart('div', array('id' => 'page_notice',
 724                                             'class' => 'system_notice'));
 725             if (Event::handle('StartShowPageNotice', array($this))) {
 726                 $this->showPageNotice();
 727                 Event::handle('EndShowPageNotice', array($this));
 728             }
 729             $this->elementEnd('div');
 730         }
 731     }
 732
 733     /**
 734      * Show page notice.
 735      *
 736      * SHOULD overload (unless there's not a notice)
 737      *
 738      * @return nothing
 739      */
 740     function showPageNotice()
 741     {
 742     }
 743
 744     /**
 745      * Show content.
 746      *
 747      * MUST overload (unless there's not a notice)
 748      *
 749      * @return nothing
 750      */
 751     function showContent()
 752     {
 753     }
 754
 755     /**
 756      * Show Aside.
 757      *
 758      * @return nothing
 759      */
 760     function showAside()
 761     {
 762         $this->elementStart('div', array('id' => 'aside_primary',
 763                                          'class' => 'aside'));
 764         if (Event::handle('StartShowSections', array($this))) {
 765             $this->showSections();
 766             Event::handle('EndShowSections', array($this));
 767         }
 768         if (Event::handle('StartShowExportData', array($this))) {
 769             $this->showExportData();
 770             Event::handle('EndShowExportData', array($this));
 771         }
 772         $this->elementEnd('div');
 773     }
 774
 775     /**
 776      * Show export data feeds.
 777      *
 778      * @return void
 779      */
 780     function showExportData()
 781     {
 782         $feeds = $this->getFeeds();
 783         if ($feeds) {
 784             $fl = new FeedList($this);
 785             $fl->show($feeds);
 786         }
 787     }
 788
 789     /**
 790      * Show sections.
 791      *
 792      * SHOULD overload
 793      *
 794      * @return nothing
 795      */
 796     function showSections()
 797     {
 798         // for each section, show it
 799     }
 800
 801     /**
 802      * Show footer.
 803      *
 804      * @return nothing
 805      */
 806     function showFooter()
 807     {
 808         $this->elementStart('div', array('id' => 'footer'));
 809         if (Event::handle('StartShowInsideFooter', array($this))) {
 810             $this->showSecondaryNav();
 811             $this->showLicenses();
 812             Event::handle('EndShowInsideFooter', array($this));
 813         }
 814         $this->elementEnd('div');
 815     }
 816
 817     /**
 818      * Show secondary navigation.
 819      *
 820      * @return nothing
 821      */
 822     function showSecondaryNav()
 823     {
 824         $sn = new SecondaryNav($this);
 825         $sn->show();
 826     }
 827
 828     /**
 829      * Show licenses.
 830      *
 831      * @return nothing
 832      */
 833     function showLicenses()
 834     {
 835         $this->showStatusNetLicense();
 836         $this->showContentLicense();
 837     }
 838
 839     /**
 840      * Show StatusNet license.
 841      *
 842      * @return nothing
 843      */
 844     function showStatusNetLicense()
 845     {
 846         if (common_config('site', 'broughtby')) {
 847             // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is set.
 848             // TRANS: Text between [] is a link description, text between () is the link itself.
 849             // TRANS: Make sure there is no whitespace between "]" and "(".
 850             // TRANS: "%%site.broughtby%%" is the value of the variable site.broughtby
 851             $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%).');
 852         } else {
 853             // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is not set.
 854             $instr = _('**%%site.name%%** is a microblogging service.');
 855         }
 856         $instr .= ' ';
 857         // TRANS: Second sentence of the StatusNet site license. Mentions the StatusNet source code license.
 858         // TRANS: Make sure there is no whitespace between "]" and "(".
 859         // TRANS: Text between [] is a link description, text between () is the link itself.
 860         // TRANS: %s is the version of StatusNet that is being used.
 861         $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);
 862         $output = common_markup_to_html($instr);
 863         $this->raw($output);
 864         // do it
 865     }
 866
 867     /**
 868      * Show content license.
 869      *
 870      * @return nothing
 871      */
 872     function showContentLicense()
 873     {
 874         if (Event::handle('StartShowContentLicense', array($this))) {
 875             switch (common_config('license', 'type')) {
 876             case 'private':
 877                 // TRANS: Content license displayed when license is set to 'private'.
 878                 // TRANS: %1$s is the site name.
 879                 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
 880                                                   common_config('site', 'name')));
 881                 // fall through
 882             case 'allrightsreserved':
 883                 if (common_config('license', 'owner')) {
 884                     // TRANS: Content license displayed when license is set to 'allrightsreserved'.
 885                     // TRANS: %1$s is the copyright owner.
 886                     $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
 887                                                       common_config('license', 'owner')));
 888                 } else {
 889                     // TRANS: Content license displayed when license is set to 'allrightsreserved' and no owner is set.
 890                     $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
 891                 }
 892                 break;
 893             case 'cc': // fall through
 894             default:
 895                 $this->elementStart('p');
 896
 897                 $image    = common_config('license', 'image');
 898                 $sslimage = common_config('license', 'sslimage');
 899
 900                 if (StatusNet::isHTTPS()) {
 901                     if (!empty($sslimage)) {
 902                         $url = $sslimage;
 903                     } else if (preg_match('#^http://i.creativecommons.org/#', $image)) {
 904                         // CC support HTTPS on their images
 905                         $url = preg_replace('/^http/', 'https', $image);
 906                     } else {
 907                         // Better to show mixed content than no content
 908                         $url = $image;
 909                     }
 910                 } else {
 911                     $url = $image;
 912                 }
 913
 914                 $this->element('img', array('id' => 'license_cc',
 915                                             'src' => $url,
 916                                             'alt' => common_config('license', 'title'),
 917                                             'width' => '80',
 918                                             'height' => '15'));
 919                 $this->text(' ');
 920                 // TRANS: license message in footer.
 921                 // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
 922                 $notice = _('All %1$s content and data are available under the %2$s license.');
 923                 $link = "<a class=\"license\" rel=\"external license\" href=\"" .
 924                         htmlspecialchars(common_config('license', 'url')) .
 925                         "\">" .
 926                         htmlspecialchars(common_config('license', 'title')) .
 927                         "</a>";
 928                 $this->raw(sprintf(htmlspecialchars($notice),
 929                                    htmlspecialchars(common_config('site', 'name')),
 930                                    $link));
 931                 $this->elementEnd('p');
 932                 break;
 933             }
 934
 935             Event::handle('EndShowContentLicense', array($this));
 936         }
 937     }
 938
 939     /**
 940      * Return last modified, if applicable.
 941      *
 942      * MAY override
 943      *
 944      * @return string last modified http header
 945      */
 946     function lastModified()
 947     {
 948         // For comparison with If-Last-Modified
 949         // If not applicable, return null
 950         return null;
 951     }
 952
 953     /**
 954      * Return etag, if applicable.
 955      *
 956      * MAY override
 957      *
 958      * @return string etag http header
 959      */
 960     function etag()
 961     {
 962         return null;
 963     }
 964
 965     /**
 966      * Return true if read only.
 967      *
 968      * MAY override
 969      *
 970      * @param array $args other arguments
 971      *
 972      * @return boolean is read only action?
 973      */
 974     function isReadOnly($args)
 975     {
 976         return false;
 977     }
 978
 979     /**
 980      * Returns query argument or default value if not found
 981      *
 982      * @param string $key requested argument
 983      * @param string $def default value to return if $key is not provided
 984      *
 985      * @return boolean is read only action?
 986      */
 987     function arg($key, $def=null)
 988     {
 989         if (array_key_exists($key, $this->args)) {
 990             return $this->args[$key];
 991         } else {
 992             return $def;
 993         }
 994     }
 995
 996     /**
 997      * Returns trimmed query argument or default value if not found
 998      *
 999      * @param string $key requested argument
1000      * @param string $def default value to return if $key is not provided
1001      *
1002      * @return boolean is read only action?
1003      */
1004     function trimmed($key, $def=null)
1005     {
1006         $arg = $this->arg($key, $def);
1007         return is_string($arg) ? trim($arg) : $arg;
1008     }
1009
1010     /**
1011      * Handler method
1012      *
1013      * @param array $argarray is ignored since it's now passed in in prepare()
1014      *
1015      * @return boolean is read only action?
1016      */
1017     function handle($argarray=null)
1018     {
1019         header('Vary: Accept-Encoding,Cookie');
1020
1021         $lm   = $this->lastModified();
1022         $etag = $this->etag();
1023
1024         if ($etag) {
1025             header('ETag: ' . $etag);
1026         }
1027
1028         if ($lm) {
1029             header('Last-Modified: ' . date(DATE_RFC1123, $lm));
1030             if ($this->isCacheable()) {
1031                 header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1032                 header( "Cache-Control: private, must-revalidate, max-age=0" );
1033                 header( "Pragma:");
1034             }
1035         }
1036
1037         $checked = false;
1038         if ($etag) {
1039             $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
1040               $_SERVER['HTTP_IF_NONE_MATCH'] : null;
1041             if ($if_none_match) {
1042                 // If this check fails, ignore the if-modified-since below.
1043                 $checked = true;
1044                 if ($this->_hasEtag($etag, $if_none_match)) {
1045                     header('HTTP/1.1 304 Not Modified');
1046                     // Better way to do this?
1047                     exit(0);
1048                 }
1049             }
1050         }
1051
1052         if (!$checked && $lm && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
1053             $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
1054             $ims = strtotime($if_modified_since);
1055             if ($lm <= $ims) {
1056                 header('HTTP/1.1 304 Not Modified');
1057                 // Better way to do this?
1058                 exit(0);
1059             }
1060         }
1061     }
1062
1063     /**
1064      * Is this action cacheable?
1065      *
1066      * If the action returns a last-modified
1067      *
1068      * @param array $argarray is ignored since it's now passed in in prepare()
1069      *
1070      * @return boolean is read only action?
1071      */
1072     function isCacheable()
1073     {
1074         return true;
1075     }
1076
1077     /**
1078      * Has etag? (private)
1079      *
1080      * @param string $etag          etag http header
1081      * @param string $if_none_match ifNoneMatch http header
1082      *
1083      * @return boolean
1084      */
1085     function _hasEtag($etag, $if_none_match)
1086     {
1087         $etags = explode(',', $if_none_match);
1088         return in_array($etag, $etags) || in_array('*', $etags);
1089     }
1090
1091     /**
1092      * Boolean understands english (yes, no, true, false)
1093      *
1094      * @param string $key query key we're interested in
1095      * @param string $def default value
1096      *
1097      * @return boolean interprets yes/no strings as boolean
1098      */
1099     function boolean($key, $def=false)
1100     {
1101         $arg = strtolower($this->trimmed($key));
1102
1103         if (is_null($arg)) {
1104             return $def;
1105         } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1106             return true;
1107         } else if (in_array($arg, array('false', 'no', '0'))) {
1108             return false;
1109         } else {
1110             return $def;
1111         }
1112     }
1113
1114     /**
1115      * Integer value of an argument
1116      *
1117      * @param string $key      query key we're interested in
1118      * @param string $defValue optional default value (default null)
1119      * @param string $maxValue optional max value (default null)
1120      * @param string $minValue optional min value (default null)
1121      *
1122      * @return integer integer value
1123      */
1124     function int($key, $defValue=null, $maxValue=null, $minValue=null)
1125     {
1126         $arg = strtolower($this->trimmed($key));
1127
1128         if (is_null($arg) || !is_integer($arg)) {
1129             return $defValue;
1130         }
1131
1132         if (!is_null($maxValue)) {
1133             $arg = min($arg, $maxValue);
1134         }
1135
1136         if (!is_null($minValue)) {
1137             $arg = max($arg, $minValue);
1138         }
1139
1140         return $arg;
1141     }
1142
1143     /**
1144      * Server error
1145      *
1146      * @param string  $msg  error message to display
1147      * @param integer $code http error code, 500 by default
1148      *
1149      * @return nothing
1150      */
1151     function serverError($msg, $code=500)
1152     {
1153         $action = $this->trimmed('action');
1154         common_debug("Server error '$code' on '$action': $msg", __FILE__);
1155         throw new ServerException($msg, $code);
1156     }
1157
1158     /**
1159      * Client error
1160      *
1161      * @param string  $msg  error message to display
1162      * @param integer $code http error code, 400 by default
1163      *
1164      * @return nothing
1165      */
1166     function clientError($msg, $code=400)
1167     {
1168         $action = $this->trimmed('action');
1169         common_debug("User error '$code' on '$action': $msg", __FILE__);
1170         throw new ClientException($msg, $code);
1171     }
1172
1173     /**
1174      * Returns the current URL
1175      *
1176      * @return string current URL
1177      */
1178     function selfUrl()
1179     {
1180         list($action, $args) = $this->returnToArgs();
1181         return common_local_url($action, $args);
1182     }
1183
1184     /**
1185      * Returns arguments sufficient for re-constructing URL
1186      *
1187      * @return array two elements: action, other args
1188      */
1189     function returnToArgs()
1190     {
1191         $action = $this->trimmed('action');
1192         $args   = $this->args;
1193         unset($args['action']);
1194         if (common_config('site', 'fancy')) {
1195             unset($args['p']);
1196         }
1197         if (array_key_exists('submit', $args)) {
1198             unset($args['submit']);
1199         }
1200         foreach (array_keys($_COOKIE) as $cookie) {
1201             unset($args[$cookie]);
1202         }
1203         return array($action, $args);
1204     }
1205
1206     /**
1207      * Generate a menu item
1208      *
1209      * @param string  $url         menu URL
1210      * @param string  $text        menu name
1211      * @param string  $title       title attribute, null by default
1212      * @param boolean $is_selected current menu item, false by default
1213      * @param string  $id          element id, null by default
1214      *
1215      * @return nothing
1216      */
1217     function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1218     {
1219         // Added @id to li for some control.
1220         // XXX: We might want to move this to htmloutputter.php
1221         $lattrs = array();
1222         if ($is_selected) {
1223             $lattrs['class'] = 'current';
1224         }
1225
1226         (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1227
1228         $this->elementStart('li', $lattrs);
1229         $attrs['href'] = $url;
1230         if ($title) {
1231             $attrs['title'] = $title;
1232         }
1233         $this->element('a', $attrs, $text);
1234         $this->elementEnd('li');
1235     }
1236
1237     /**
1238      * Generate pagination links
1239      *
1240      * @param boolean $have_before is there something before?
1241      * @param boolean $have_after  is there something after?
1242      * @param integer $page        current page
1243      * @param string  $action      current action
1244      * @param array   $args        rest of query arguments
1245      *
1246      * @return nothing
1247      */
1248     // XXX: The messages in this pagination method only tailor to navigating
1249     //      notices. In other lists, "Previous"/"Next" type navigation is
1250     //      desirable, but not available.
1251     function pagination($have_before, $have_after, $page, $action, $args=null)
1252     {
1253         // Does a little before-after block for next/prev page
1254         if ($have_before || $have_after) {
1255             $this->elementStart('ul', array('class' => 'nav',
1256                                             'id' => 'pagination'));
1257         }
1258         if ($have_before) {
1259             $pargs   = array('page' => $page-1);
1260             $this->elementStart('li', array('class' => 'nav_prev'));
1261             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1262                                       'rel' => 'prev'),
1263                            // TRANS: Pagination message to go to a page displaying information more in the
1264                            // TRANS: present than the currently displayed information.
1265                            _('After'));
1266             $this->elementEnd('li');
1267         }
1268         if ($have_after) {
1269             $pargs   = array('page' => $page+1);
1270             $this->elementStart('li', array('class' => 'nav_next'));
1271             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1272                                       'rel' => 'next'),
1273                            // TRANS: Pagination message to go to a page displaying information more in the
1274                            // TRANS: past than the currently displayed information.
1275                            _('Before'));
1276             $this->elementEnd('li');
1277         }
1278         if ($have_before || $have_after) {
1279             $this->elementEnd('ul');
1280         }
1281     }
1282
1283     /**
1284      * An array of feeds for this action.
1285      *
1286      * Returns an array of potential feeds for this action.
1287      *
1288      * @return array Feed object to show in head and links
1289      */
1290     function getFeeds()
1291     {
1292         return null;
1293     }
1294
1295     /**
1296      * A design for this action
1297      *
1298      * @return Design a design object to use
1299      */
1300     function getDesign()
1301     {
1302         return Design::siteDesign();
1303     }
1304
1305     /**
1306      * Check the session token.
1307      *
1308      * Checks that the current form has the correct session token,
1309      * and throw an exception if it does not.
1310      *
1311      * @return void
1312      */
1313     // XXX: Finding this type of check with the same message about 50 times.
1314     //      Possible to refactor?
1315     function checkSessionToken()
1316     {
1317         // CSRF protection
1318         $token = $this->trimmed('token');
1319         if (empty($token) || $token != common_session_token()) {
1320             // TRANS: Client error text when there is a problem with the session token.
1321             $this->clientError(_('There was a problem with your session token.'));
1322         }
1323     }
1324
1325     /**
1326      * Check if the current request is a POST
1327      *
1328      * @return boolean true if POST; otherwise false.
1329      */
1330
1331     function isPost()
1332     {
1333         return ($_SERVER['REQUEST_METHOD'] == 'POST');
1334     }
1335 }