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