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