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