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