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             $this->showTitle();
 125             $this->showShortcutIcon();
 126             $this->showStylesheets();
 127             $this->showOpenSearch();
 128             $this->showFeeds();
 129             $this->showDescription();
 130             $this->extraHead();
 131             Event::handle('EndShowHeadElements', array($this));
 132         }
 133         $this->elementEnd('head');
 134     }
 135
 136     /**
 137      * Show title, a template method.
 138      *
 139      * @return nothing
 140      */
 141     function showTitle()
 142     {
 143         $this->element('title', null,
 144                        sprintf(_("%1\$s - %2\$s"),
 145                                $this->title(),
 146                                common_config('site', 'name')));
 147     }
 148
 149     /**
 150      * Returns the page title
 151      *
 152      * SHOULD overload
 153      *
 154      * @return string page title
 155      */
 156
 157     function title()
 158     {
 159         return _("Untitled page");
 160     }
 161
 162     /**
 163      * Show themed shortcut icon
 164      *
 165      * @return nothing
 166      */
 167     function showShortcutIcon()
 168     {
 169         if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/favicon.ico')) {
 170             $this->element('link', array('rel' => 'shortcut icon',
 171                                          'href' => Theme::path('favicon.ico')));
 172         } else {
 173             $this->element('link', array('rel' => 'shortcut icon',
 174                                          'href' => common_path('favicon.ico')));
 175         }
 176
 177         if (common_config('site', 'mobile')) {
 178             if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/apple-touch-icon.png')) {
 179                 $this->element('link', array('rel' => 'apple-touch-icon',
 180                                              'href' => Theme::path('apple-touch-icon.png')));
 181             } else {
 182                 $this->element('link', array('rel' => 'apple-touch-icon',
 183                                              'href' => common_path('apple-touch-icon.png')));
 184             }
 185         }
 186     }
 187
 188     /**
 189      * Show stylesheets
 190      *
 191      * @return nothing
 192      */
 193     function showStylesheets()
 194     {
 195         if (Event::handle('StartShowStyles', array($this))) {
 196
 197             // Use old name for StatusNet for compatibility on events
 198
 199             if (Event::handle('StartShowStatusNetStyles', array($this)) &&
 200                 Event::handle('StartShowLaconicaStyles', array($this))) {
 201                 $this->cssLink('css/display.css',null,'screen, projection, tv');
 202                 $this->cssLink('css/print.css','base','print');
 203                 Event::handle('EndShowStatusNetStyles', array($this));
 204                 Event::handle('EndShowLaconicaStyles', array($this));
 205             }
 206
 207             if (Event::handle('StartShowUAStyles', array($this))) {
 208                 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
 209                                'href="'.Theme::path('css/ie.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
 210                 foreach (array(6,7) as $ver) {
 211                     if (file_exists(Theme::file('css/ie'.$ver.'.css', 'base'))) {
 212                         // Yes, IE people should be put in jail.
 213                         $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
 214                                        'href="'.Theme::path('css/ie'.$ver.'.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
 215                     }
 216                 }
 217                 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
 218                                'href="'.Theme::path('css/ie.css', null).'?version='.STATUSNET_VERSION.'" /><![endif]');
 219                 Event::handle('EndShowUAStyles', array($this));
 220             }
 221
 222             if (Event::handle('StartShowDesign', array($this))) {
 223
 224                 $user = common_current_user();
 225
 226                 if (empty($user) || $user->viewdesigns) {
 227                     $design = $this->getDesign();
 228
 229                     if (!empty($design)) {
 230                         $design->showCSS($this);
 231                     }
 232                 }
 233
 234                 Event::handle('EndShowDesign', array($this));
 235             }
 236             Event::handle('EndShowStyles', array($this));
 237         }
 238     }
 239
 240     /**
 241      * Show javascript headers
 242      *
 243      * @return nothing
 244      */
 245     function showScripts()
 246     {
 247         if (Event::handle('StartShowScripts', array($this))) {
 248             if (Event::handle('StartShowJQueryScripts', array($this))) {
 249                 $this->script('jquery.min.js');
 250                 $this->script('jquery.form.js');
 251                 $this->script('jquery.cookie.js');
 252                 $this->inlineScript('if (typeof window.JSON !== "object") { $.getScript("'.common_path('js/json2.js').'"); }');
 253                 $this->script('jquery.joverlay.min.js');
 254                 Event::handle('EndShowJQueryScripts', array($this));
 255             }
 256             if (Event::handle('StartShowStatusNetScripts', array($this)) &&
 257                 Event::handle('StartShowLaconicaScripts', array($this))) {
 258                 $this->script('xbImportNode.js');
 259                 $this->script('util.js');
 260                 $this->script('geometa.js');
 261                 // Frame-busting code to avoid clickjacking attacks.
 262                 $this->inlineScript('if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
 263                 Event::handle('EndShowStatusNetScripts', array($this));
 264                 Event::handle('EndShowLaconicaScripts', array($this));
 265             }
 266             Event::handle('EndShowScripts', array($this));
 267         }
 268     }
 269
 270     /**
 271      * Show OpenSearch headers
 272      *
 273      * @return nothing
 274      */
 275     function showOpenSearch()
 276     {
 277         $this->element('link', array('rel' => 'search',
 278                                      'type' => 'application/opensearchdescription+xml',
 279                                      'href' =>  common_local_url('opensearch', array('type' => 'people')),
 280                                      'title' => common_config('site', 'name').' People Search'));
 281         $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
 282                                      'href' =>  common_local_url('opensearch', array('type' => 'notice')),
 283                                      'title' => common_config('site', 'name').' Notice Search'));
 284     }
 285
 286     /**
 287      * Show feed headers
 288      *
 289      * MAY overload
 290      *
 291      * @return nothing
 292      */
 293
 294     function showFeeds()
 295     {
 296         $feeds = $this->getFeeds();
 297
 298         if ($feeds) {
 299             foreach ($feeds as $feed) {
 300                 $this->element('link', array('rel' => $feed->rel(),
 301                                              'href' => $feed->url,
 302                                              'type' => $feed->mimeType(),
 303                                              'title' => $feed->title));
 304             }
 305         }
 306     }
 307
 308     /**
 309      * Show description.
 310      *
 311      * SHOULD overload
 312      *
 313      * @return nothing
 314      */
 315     function showDescription()
 316     {
 317         // does nothing by default
 318     }
 319
 320     /**
 321      * Show extra stuff in <head>.
 322      *
 323      * MAY overload
 324      *
 325      * @return nothing
 326      */
 327     function extraHead()
 328     {
 329         // does nothing by default
 330     }
 331
 332     /**
 333      * Show body.
 334      *
 335      * Calls template methods
 336      *
 337      * @return nothing
 338      */
 339     function showBody()
 340     {
 341         $this->elementStart('body', (common_current_user()) ? array('id' => $this->trimmed('action'),
 342                                                                     'class' => 'user_in')
 343                             : array('id' => $this->trimmed('action')));
 344         $this->elementStart('div', array('id' => 'wrap'));
 345         if (Event::handle('StartShowHeader', array($this))) {
 346             $this->showHeader();
 347             Event::handle('EndShowHeader', array($this));
 348         }
 349         $this->showCore();
 350         if (Event::handle('StartShowFooter', array($this))) {
 351             $this->showFooter();
 352             Event::handle('EndShowFooter', array($this));
 353         }
 354         $this->elementEnd('div');
 355         $this->showScripts();
 356         $this->elementEnd('body');
 357     }
 358
 359     /**
 360      * Show header of the page.
 361      *
 362      * Calls template methods
 363      *
 364      * @return nothing
 365      */
 366     function showHeader()
 367     {
 368         $this->elementStart('div', array('id' => 'header'));
 369         $this->showLogo();
 370         $this->showPrimaryNav();
 371         if (Event::handle('StartShowSiteNotice', array($this))) {
 372             $this->showSiteNotice();
 373
 374             Event::handle('EndShowSiteNotice', array($this));
 375         }
 376         if (common_logged_in()) {
 377             $this->showNoticeForm();
 378         } else {
 379             $this->showAnonymousMessage();
 380         }
 381         $this->elementEnd('div');
 382     }
 383
 384     /**
 385      * Show configured logo.
 386      *
 387      * @return nothing
 388      */
 389     function showLogo()
 390     {
 391         $this->elementStart('address', array('id' => 'site_contact',
 392                                              'class' => 'vcard'));
 393         if (Event::handle('StartAddressData', array($this))) {
 394             if (common_config('singleuser', 'enabled')) {
 395                 $url = common_local_url('showstream',
 396                                         array('nickname' => common_config('singleuser', 'nickname')));
 397             } else {
 398                 $url = common_local_url('public');
 399             }
 400             $this->elementStart('a', array('class' => 'url home bookmark',
 401                                            'href' => $url));
 402             if (common_config('site', 'logo') || file_exists(Theme::file('logo.png'))) {
 403                 $this->element('img', array('class' => 'logo photo',
 404                                             'src' => (common_config('site', 'logo')) ? common_config('site', 'logo') : Theme::path('logo.png'),
 405                                             'alt' => common_config('site', 'name')));
 406             }
 407             $this->text(' ');
 408             $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
 409             $this->elementEnd('a');
 410             Event::handle('EndAddressData', array($this));
 411         }
 412         $this->elementEnd('address');
 413     }
 414
 415     /**
 416      * Show primary navigation.
 417      *
 418      * @return nothing
 419      */
 420     function showPrimaryNav()
 421     {
 422         $user = common_current_user();
 423         $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
 424         $this->element('dt', null, _('Primary site navigation'));
 425         $this->elementStart('dd');
 426         $this->elementStart('ul', array('class' => 'nav'));
 427         if (Event::handle('StartPrimaryNav', array($this))) {
 428             if ($user) {
 429                 $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
 430                                 _('Home'), _('Personal profile and friends timeline'), false, 'nav_home');
 431                 $this->menuItem(common_local_url('profilesettings'),
 432                                 _('Account'), _('Change your email, avatar, password, profile'), false, 'nav_account');
 433                 $this->menuItem(common_local_url('oauthconnectionssettings'),
 434                                 _('Connect'), _('Connect to services'), false, 'nav_connect');
 435                 if ($user->hasRight(Right::CONFIGURESITE)) {
 436                     $this->menuItem(common_local_url('siteadminpanel'),
 437                                     _('Admin'), _('Change site configuration'), false, 'nav_admin');
 438                 }
 439                 if (common_config('invite', 'enabled')) {
 440                     $this->menuItem(common_local_url('invite'),
 441                                     _('Invite'),
 442                                     sprintf(_('Invite friends and colleagues to join you on %s'),
 443                                             common_config('site', 'name')),
 444                                     false, 'nav_invitecontact');
 445                 }
 446                 $this->menuItem(common_local_url('logout'),
 447                                 _('Logout'), _('Logout from the site'), false, 'nav_logout');
 448             }
 449             else {
 450                 if (!common_config('site', 'closed')) {
 451                     $this->menuItem(common_local_url('register'),
 452                                     _('Register'), _('Create an account'), false, 'nav_register');
 453                 }
 454                 $this->menuItem(common_local_url('login'),
 455                                 _('Login'), _('Login to the site'), false, 'nav_login');
 456             }
 457             $this->menuItem(common_local_url('doc', array('title' => 'help')),
 458                             _('Help'), _('Help me!'), false, 'nav_help');
 459             if ($user || !common_config('site', 'private')) {
 460                 $this->menuItem(common_local_url('peoplesearch'),
 461                                 _('Search'), _('Search for people or text'), false, 'nav_search');
 462             }
 463             Event::handle('EndPrimaryNav', array($this));
 464         }
 465         $this->elementEnd('ul');
 466         $this->elementEnd('dd');
 467         $this->elementEnd('dl');
 468     }
 469
 470     /**
 471      * Show site notice.
 472      *
 473      * @return nothing
 474      */
 475     function showSiteNotice()
 476     {
 477         // Revist. Should probably do an hAtom pattern here
 478         $text = common_config('site', 'notice');
 479         if ($text) {
 480             $this->elementStart('dl', array('id' => 'site_notice',
 481                                             'class' => 'system_notice'));
 482             $this->element('dt', null, _('Site notice'));
 483             $this->elementStart('dd', null);
 484             $this->raw($text);
 485             $this->elementEnd('dd');
 486             $this->elementEnd('dl');
 487         }
 488     }
 489
 490     /**
 491      * Show notice form.
 492      *
 493      * MAY overload if no notice form needed... or direct message box????
 494      *
 495      * @return nothing
 496      */
 497     function showNoticeForm()
 498     {
 499         $notice_form = new NoticeForm($this);
 500         $notice_form->show();
 501     }
 502
 503     /**
 504      * Show anonymous message.
 505      *
 506      * SHOULD overload
 507      *
 508      * @return nothing
 509      */
 510     function showAnonymousMessage()
 511     {
 512         // needs to be defined by the class
 513     }
 514
 515     /**
 516      * Show core.
 517      *
 518      * Shows local navigation, content block and aside.
 519      *
 520      * @return nothing
 521      */
 522     function showCore()
 523     {
 524         $this->elementStart('div', array('id' => 'core'));
 525         if (Event::handle('StartShowLocalNavBlock', array($this))) {
 526             $this->showLocalNavBlock();
 527             Event::handle('EndShowLocalNavBlock', array($this));
 528         }
 529         if (Event::handle('StartShowContentBlock', array($this))) {
 530             $this->showContentBlock();
 531             Event::handle('EndShowContentBlock', array($this));
 532         }
 533         if (Event::handle('StartShowAside', array($this))) {
 534             $this->showAside();
 535             Event::handle('EndShowAside', array($this));
 536         }
 537         $this->elementEnd('div');
 538     }
 539
 540     /**
 541      * Show local navigation block.
 542      *
 543      * @return nothing
 544      */
 545     function showLocalNavBlock()
 546     {
 547         $this->elementStart('dl', array('id' => 'site_nav_local_views'));
 548         $this->element('dt', null, _('Local views'));
 549         $this->elementStart('dd');
 550         $this->showLocalNav();
 551         $this->elementEnd('dd');
 552         $this->elementEnd('dl');
 553     }
 554
 555     /**
 556      * Show local navigation.
 557      *
 558      * SHOULD overload
 559      *
 560      * @return nothing
 561      */
 562     function showLocalNav()
 563     {
 564         // does nothing by default
 565     }
 566
 567     /**
 568      * Show content block.
 569      *
 570      * @return nothing
 571      */
 572     function showContentBlock()
 573     {
 574         $this->elementStart('div', array('id' => 'content'));
 575         $this->showPageTitle();
 576         $this->showPageNoticeBlock();
 577         $this->elementStart('div', array('id' => 'content_inner'));
 578         // show the actual content (forms, lists, whatever)
 579         $this->showContent();
 580         $this->elementEnd('div');
 581         $this->elementEnd('div');
 582     }
 583
 584     /**
 585      * Show page title.
 586      *
 587      * @return nothing
 588      */
 589     function showPageTitle()
 590     {
 591         $this->element('h1', null, $this->title());
 592     }
 593
 594     /**
 595      * Show page notice block.
 596      *
 597      * Only show the block if a subclassed action has overrided
 598      * Action::showPageNotice(), or an event handler is registered for
 599      * the StartShowPageNotice event, in which case we assume the
 600      * 'page_notice' definition list is desired.  This is to prevent
 601      * empty 'page_notice' definition lists from being output everywhere.
 602      *
 603      * @return nothing
 604      */
 605     function showPageNoticeBlock()
 606     {
 607         $rmethod = new ReflectionMethod($this, 'showPageNotice');
 608         $dclass = $rmethod->getDeclaringClass()->getName();
 609
 610         if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
 611
 612             $this->elementStart('dl', array('id' => 'page_notice',
 613                                             'class' => 'system_notice'));
 614             $this->element('dt', null, _('Page notice'));
 615             $this->elementStart('dd');
 616             if (Event::handle('StartShowPageNotice', array($this))) {
 617                 $this->showPageNotice();
 618                 Event::handle('EndShowPageNotice', array($this));
 619             }
 620             $this->elementEnd('dd');
 621             $this->elementEnd('dl');
 622         }
 623     }
 624
 625     /**
 626      * Show page notice.
 627      *
 628      * SHOULD overload (unless there's not a notice)
 629      *
 630      * @return nothing
 631      */
 632     function showPageNotice()
 633     {
 634     }
 635
 636     /**
 637      * Show content.
 638      *
 639      * MUST overload (unless there's not a notice)
 640      *
 641      * @return nothing
 642      */
 643     function showContent()
 644     {
 645     }
 646
 647     /**
 648      * Show Aside.
 649      *
 650      * @return nothing
 651      */
 652
 653     function showAside()
 654     {
 655         $this->elementStart('div', array('id' => 'aside_primary',
 656                                          'class' => 'aside'));
 657         if (Event::handle('StartShowExportData', array($this))) {
 658             $this->showExportData();
 659             Event::handle('EndShowExportData', array($this));
 660         }
 661         if (Event::handle('StartShowSections', array($this))) {
 662             $this->showSections();
 663             Event::handle('EndShowSections', array($this));
 664         }
 665         $this->elementEnd('div');
 666     }
 667
 668     /**
 669      * Show export data feeds.
 670      *
 671      * @return void
 672      */
 673
 674     function showExportData()
 675     {
 676         $feeds = $this->getFeeds();
 677         if ($feeds) {
 678             $fl = new FeedList($this);
 679             $fl->show($feeds);
 680         }
 681     }
 682
 683     /**
 684      * Show sections.
 685      *
 686      * SHOULD overload
 687      *
 688      * @return nothing
 689      */
 690     function showSections()
 691     {
 692         // for each section, show it
 693     }
 694
 695     /**
 696      * Show footer.
 697      *
 698      * @return nothing
 699      */
 700     function showFooter()
 701     {
 702         $this->elementStart('div', array('id' => 'footer'));
 703         $this->showSecondaryNav();
 704         $this->showLicenses();
 705         $this->elementEnd('div');
 706     }
 707
 708     /**
 709      * Show secondary navigation.
 710      *
 711      * @return nothing
 712      */
 713     function showSecondaryNav()
 714     {
 715         $this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
 716         $this->element('dt', null, _('Secondary site navigation'));
 717         $this->elementStart('dd', null);
 718         $this->elementStart('ul', array('class' => 'nav'));
 719         if (Event::handle('StartSecondaryNav', array($this))) {
 720             $this->menuItem(common_local_url('doc', array('title' => 'help')),
 721                             _('Help'));
 722             $this->menuItem(common_local_url('doc', array('title' => 'about')),
 723                             _('About'));
 724             $this->menuItem(common_local_url('doc', array('title' => 'faq')),
 725                             _('FAQ'));
 726             $bb = common_config('site', 'broughtby');
 727             if (!empty($bb)) {
 728                 $this->menuItem(common_local_url('doc', array('title' => 'tos')),
 729                                 _('TOS'));
 730             }
 731             $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
 732                             _('Privacy'));
 733             $this->menuItem(common_local_url('doc', array('title' => 'source')),
 734                             _('Source'));
 735             $this->menuItem(common_local_url('version'),
 736                             _('Version'));
 737             $this->menuItem(common_local_url('doc', array('title' => 'contact')),
 738                             _('Contact'));
 739             $this->menuItem(common_local_url('doc', array('title' => 'badge')),
 740                             _('Badge'));
 741             Event::handle('EndSecondaryNav', array($this));
 742         }
 743         $this->elementEnd('ul');
 744         $this->elementEnd('dd');
 745         $this->elementEnd('dl');
 746     }
 747
 748     /**
 749      * Show licenses.
 750      *
 751      * @return nothing
 752      */
 753     function showLicenses()
 754     {
 755         $this->elementStart('dl', array('id' => 'licenses'));
 756         $this->showStatusNetLicense();
 757         $this->showContentLicense();
 758         $this->elementEnd('dl');
 759     }
 760
 761     /**
 762      * Show StatusNet license.
 763      *
 764      * @return nothing
 765      */
 766     function showStatusNetLicense()
 767     {
 768         $this->element('dt', array('id' => 'site_statusnet_license'), _('StatusNet software license'));
 769         $this->elementStart('dd', null);
 770         if (common_config('site', 'broughtby')) {
 771             $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
 772         } else {
 773             $instr = _('**%%site.name%%** is a microblogging service. ');
 774         }
 775         $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);
 776         $output = common_markup_to_html($instr);
 777         $this->raw($output);
 778         $this->elementEnd('dd');
 779         // do it
 780     }
 781
 782     /**
 783      * Show content license.
 784      *
 785      * @return nothing
 786      */
 787     function showContentLicense()
 788     {
 789         if (Event::handle('StartShowContentLicense', array($this))) {
 790             $this->element('dt', array('id' => 'site_content_license'), _('Site content license'));
 791             $this->elementStart('dd', array('id' => 'site_content_license_cc'));
 792
 793             switch (common_config('license', 'type')) {
 794             case 'private':
 795                 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
 796                                                   common_config('site', 'name')));
 797                 // fall through
 798             case 'allrightsreserved':
 799                 if (common_config('license', 'owner')) {
 800                     $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
 801                                                       common_config('license', 'owner')));
 802                 } else {
 803                     $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
 804                 }
 805                 break;
 806             case 'cc': // fall through
 807             default:
 808                 $this->elementStart('p');
 809                 $this->element('img', array('id' => 'license_cc',
 810                                             'src' => common_config('license', 'image'),
 811                                             'alt' => common_config('license', 'title'),
 812                                             'width' => '80',
 813                                             'height' => '15'));
 814                 $this->text(' ');
 815                 //TODO: This is dirty: i18n
 816                 $this->text(_('All '.common_config('site', 'name').' content and data are available under the '));
 817                 $this->element('a', array('class' => 'license',
 818                                           'rel' => 'external license',
 819                                           'href' => common_config('license', 'url')),
 820                                common_config('license', 'title'));
 821                 $this->text(' ');
 822                 $this->text(_('license.'));
 823                 $this->elementEnd('p');
 824                 break;
 825             }
 826
 827             $this->elementEnd('dd');
 828             Event::handle('EndShowContentLicense', array($this));
 829         }
 830     }
 831
 832     /**
 833      * Return last modified, if applicable.
 834      *
 835      * MAY override
 836      *
 837      * @return string last modified http header
 838      */
 839     function lastModified()
 840     {
 841         // For comparison with If-Last-Modified
 842         // If not applicable, return null
 843         return null;
 844     }
 845
 846     /**
 847      * Return etag, if applicable.
 848      *
 849      * MAY override
 850      *
 851      * @return string etag http header
 852      */
 853     function etag()
 854     {
 855         return null;
 856     }
 857
 858     /**
 859      * Return true if read only.
 860      *
 861      * MAY override
 862      *
 863      * @param array $args other arguments
 864      *
 865      * @return boolean is read only action?
 866      */
 867
 868     function isReadOnly($args)
 869     {
 870         return false;
 871     }
 872
 873     /**
 874      * Returns query argument or default value if not found
 875      *
 876      * @param string $key requested argument
 877      * @param string $def default value to return if $key is not provided
 878      *
 879      * @return boolean is read only action?
 880      */
 881     function arg($key, $def=null)
 882     {
 883         if (array_key_exists($key, $this->args)) {
 884             return $this->args[$key];
 885         } else {
 886             return $def;
 887         }
 888     }
 889
 890     /**
 891      * Returns trimmed query argument or default value if not found
 892      *
 893      * @param string $key requested argument
 894      * @param string $def default value to return if $key is not provided
 895      *
 896      * @return boolean is read only action?
 897      */
 898     function trimmed($key, $def=null)
 899     {
 900         $arg = $this->arg($key, $def);
 901         return is_string($arg) ? trim($arg) : $arg;
 902     }
 903
 904     /**
 905      * Handler method
 906      *
 907      * @param array $argarray is ignored since it's now passed in in prepare()
 908      *
 909      * @return boolean is read only action?
 910      */
 911     function handle($argarray=null)
 912     {
 913         header('Vary: Accept-Encoding,Cookie');
 914         $lm   = $this->lastModified();
 915         $etag = $this->etag();
 916         if ($etag) {
 917             header('ETag: ' . $etag);
 918         }
 919         if ($lm) {
 920             header('Last-Modified: ' . date(DATE_RFC1123, $lm));
 921             if (array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
 922                 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
 923                 $ims = strtotime($if_modified_since);
 924                 if ($lm <= $ims) {
 925                     $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
 926                       $_SERVER['HTTP_IF_NONE_MATCH'] : null;
 927                     if (!$if_none_match ||
 928                         !$etag ||
 929                         $this->_hasEtag($etag, $if_none_match)) {
 930                         header('HTTP/1.1 304 Not Modified');
 931                         // Better way to do this?
 932                         exit(0);
 933                     }
 934                 }
 935             }
 936         }
 937     }
 938
 939     /**
 940      * Has etag? (private)
 941      *
 942      * @param string $etag          etag http header
 943      * @param string $if_none_match ifNoneMatch http header
 944      *
 945      * @return boolean
 946      */
 947
 948     function _hasEtag($etag, $if_none_match)
 949     {
 950         $etags = explode(',', $if_none_match);
 951         return in_array($etag, $etags) || in_array('*', $etags);
 952     }
 953
 954     /**
 955      * Boolean understands english (yes, no, true, false)
 956      *
 957      * @param string $key query key we're interested in
 958      * @param string $def default value
 959      *
 960      * @return boolean interprets yes/no strings as boolean
 961      */
 962     function boolean($key, $def=false)
 963     {
 964         $arg = strtolower($this->trimmed($key));
 965
 966         if (is_null($arg)) {
 967             return $def;
 968         } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
 969             return true;
 970         } else if (in_array($arg, array('false', 'no', '0'))) {
 971             return false;
 972         } else {
 973             return $def;
 974         }
 975     }
 976
 977     /**
 978      * Integer value of an argument
 979      *
 980      * @param string $key      query key we're interested in
 981      * @param string $defValue optional default value (default null)
 982      * @param string $maxValue optional max value (default null)
 983      * @param string $minValue optional min value (default null)
 984      *
 985      * @return integer integer value
 986      */
 987
 988     function int($key, $defValue=null, $maxValue=null, $minValue=null)
 989     {
 990         $arg = strtolower($this->trimmed($key));
 991
 992         if (is_null($arg) || !is_integer($arg)) {
 993             return $defValue;
 994         }
 995
 996         if (!is_null($maxValue)) {
 997             $arg = min($arg, $maxValue);
 998         }
 999
1000         if (!is_null($minValue)) {
1001             $arg = max($arg, $minValue);
1002         }
1003
1004         return $arg;
1005     }
1006
1007     /**
1008      * Server error
1009      *
1010      * @param string  $msg  error message to display
1011      * @param integer $code http error code, 500 by default
1012      *
1013      * @return nothing
1014      */
1015
1016     function serverError($msg, $code=500)
1017     {
1018         $action = $this->trimmed('action');
1019         common_debug("Server error '$code' on '$action': $msg", __FILE__);
1020         throw new ServerException($msg, $code);
1021     }
1022
1023     /**
1024      * Client error
1025      *
1026      * @param string  $msg  error message to display
1027      * @param integer $code http error code, 400 by default
1028      *
1029      * @return nothing
1030      */
1031
1032     function clientError($msg, $code=400)
1033     {
1034         $action = $this->trimmed('action');
1035         common_debug("User error '$code' on '$action': $msg", __FILE__);
1036         throw new ClientException($msg, $code);
1037     }
1038
1039     /**
1040      * Returns the current URL
1041      *
1042      * @return string current URL
1043      */
1044
1045     function selfUrl()
1046     {
1047         list($action, $args) = $this->returnToArgs();
1048         return common_local_url($action, $args);
1049     }
1050
1051     /**
1052      * Returns arguments sufficient for re-constructing URL
1053      *
1054      * @return array two elements: action, other args
1055      */
1056
1057     function returnToArgs()
1058     {
1059         $action = $this->trimmed('action');
1060         $args   = $this->args;
1061         unset($args['action']);
1062         if (common_config('site', 'fancy')) {
1063             unset($args['p']);
1064         }
1065         if (array_key_exists('submit', $args)) {
1066             unset($args['submit']);
1067         }
1068         foreach (array_keys($_COOKIE) as $cookie) {
1069             unset($args[$cookie]);
1070         }
1071         return array($action, $args);
1072     }
1073
1074     /**
1075      * Generate a menu item
1076      *
1077      * @param string  $url         menu URL
1078      * @param string  $text        menu name
1079      * @param string  $title       title attribute, null by default
1080      * @param boolean $is_selected current menu item, false by default
1081      * @param string  $id          element id, null by default
1082      *
1083      * @return nothing
1084      */
1085     function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1086     {
1087         // Added @id to li for some control.
1088         // XXX: We might want to move this to htmloutputter.php
1089         $lattrs = array();
1090         if ($is_selected) {
1091             $lattrs['class'] = 'current';
1092         }
1093
1094         (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1095
1096         $this->elementStart('li', $lattrs);
1097         $attrs['href'] = $url;
1098         if ($title) {
1099             $attrs['title'] = $title;
1100         }
1101         $this->element('a', $attrs, $text);
1102         $this->elementEnd('li');
1103     }
1104
1105     /**
1106      * Generate pagination links
1107      *
1108      * @param boolean $have_before is there something before?
1109      * @param boolean $have_after  is there something after?
1110      * @param integer $page        current page
1111      * @param string  $action      current action
1112      * @param array   $args        rest of query arguments
1113      *
1114      * @return nothing
1115      */
1116     function pagination($have_before, $have_after, $page, $action, $args=null)
1117     {
1118         // Does a little before-after block for next/prev page
1119         if ($have_before || $have_after) {
1120             $this->elementStart('dl', 'pagination');
1121             $this->element('dt', null, _('Pagination'));
1122             $this->elementStart('dd', null);
1123             $this->elementStart('ul', array('class' => 'nav'));
1124         }
1125         if ($have_before) {
1126             $pargs   = array('page' => $page-1);
1127             $this->elementStart('li', array('class' => 'nav_prev'));
1128             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1129                                       'rel' => 'prev'),
1130                            _('After'));
1131             $this->elementEnd('li');
1132         }
1133         if ($have_after) {
1134             $pargs   = array('page' => $page+1);
1135             $this->elementStart('li', array('class' => 'nav_next'));
1136             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1137                                       'rel' => 'next'),
1138                            _('Before'));
1139             $this->elementEnd('li');
1140         }
1141         if ($have_before || $have_after) {
1142             $this->elementEnd('ul');
1143             $this->elementEnd('dd');
1144             $this->elementEnd('dl');
1145         }
1146     }
1147
1148     /**
1149      * An array of feeds for this action.
1150      *
1151      * Returns an array of potential feeds for this action.
1152      *
1153      * @return array Feed object to show in head and links
1154      */
1155
1156     function getFeeds()
1157     {
1158         return null;
1159     }
1160
1161     /**
1162      * A design for this action
1163      *
1164      * @return Design a design object to use
1165      */
1166
1167     function getDesign()
1168     {
1169         return Design::siteDesign();
1170     }
1171
1172     /**
1173      * Check the session token.
1174      *
1175      * Checks that the current form has the correct session token,
1176      * and throw an exception if it does not.
1177      *
1178      * @return void
1179      */
1180
1181     function checkSessionToken()
1182     {
1183         // CSRF protection
1184         $token = $this->trimmed('token');
1185         if (empty($token) || $token != common_session_token()) {
1186             $this->clientError(_('There was a problem with your session token.'));
1187         }
1188     }
1189 }