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