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