lib/action.php

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