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