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