lib/action.php

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