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=true)
  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(_("%s - %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                 if (common_config('site', 'mobile')) {
 203                     // TODO: "handheld" CSS for other mobile devices
 204                     $this->cssLink('css/mobile.css','base','only screen and (max-device-width: 480px)'); // Mobile WebKit
 205                 }
 206                 $this->cssLink('css/print.css','base','print');
 207                 Event::handle('EndShowStatusNetStyles', array($this));
 208                 Event::handle('EndShowLaconicaStyles', array($this));
 209             }
 210
 211             if (Event::handle('StartShowUAStyles', array($this))) {
 212                 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
 213                                'href="'.theme_path('css/ie.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
 214                 foreach (array(6,7) as $ver) {
 215                     if (file_exists(theme_file('css/ie'.$ver.'.css', 'base'))) {
 216                         // Yes, IE people should be put in jail.
 217                         $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
 218                                        'href="'.theme_path('css/ie'.$ver.'.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
 219                     }
 220                 }
 221                 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
 222                                'href="'.theme_path('css/ie.css', null).'?version='.STATUSNET_VERSION.'" /><![endif]');
 223                 Event::handle('EndShowUAStyles', array($this));
 224             }
 225
 226             if (Event::handle('StartShowDesign', array($this))) {
 227
 228                 $user = common_current_user();
 229
 230                 if (empty($user) || $user->viewdesigns) {
 231                     $design = $this->getDesign();
 232
 233                     if (!empty($design)) {
 234                         $design->showCSS($this);
 235                     }
 236                 }
 237
 238                 Event::handle('EndShowDesign', array($this));
 239             }
 240             Event::handle('EndShowStyles', array($this));
 241         }
 242     }
 243
 244     /**
 245      * Show javascript headers
 246      *
 247      * @return nothing
 248      */
 249     function showScripts()
 250     {
 251         if (Event::handle('StartShowScripts', array($this))) {
 252             if (Event::handle('StartShowJQueryScripts', array($this))) {
 253                 $this->script('js/jquery.min.js');
 254                 $this->script('js/jquery.form.js');
 255                 $this->script('js/jquery.joverlay.min.js');
 256                 Event::handle('EndShowJQueryScripts', array($this));
 257             }
 258             if (Event::handle('StartShowStatusNetScripts', array($this)) &&
 259                 Event::handle('StartShowLaconicaScripts', array($this))) {
 260                 $this->script('js/xbImportNode.js');
 261                 $this->script('js/util.js');
 262                 // Frame-busting code to avoid clickjacking attacks.
 263                 $this->element('script', array('type' => 'text/javascript'),
 264                                'if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
 265                 Event::handle('EndShowStatusNetScripts', array($this));
 266                 Event::handle('EndShowLaconicaScripts', array($this));
 267             }
 268             Event::handle('EndShowScripts', array($this));
 269         }
 270     }
 271
 272     /**
 273      * Show OpenSearch headers
 274      *
 275      * @return nothing
 276      */
 277     function showOpenSearch()
 278     {
 279         $this->element('link', array('rel' => 'search',
 280                                      'type' => 'application/opensearchdescription+xml',
 281                                      'href' =>  common_local_url('opensearch', array('type' => 'people')),
 282                                      'title' => common_config('site', 'name').' People Search'));
 283         $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
 284                                      'href' =>  common_local_url('opensearch', array('type' => 'notice')),
 285                                      'title' => common_config('site', 'name').' Notice Search'));
 286     }
 287
 288     /**
 289      * Show feed headers
 290      *
 291      * MAY overload
 292      *
 293      * @return nothing
 294      */
 295
 296     function showFeeds()
 297     {
 298         $feeds = $this->getFeeds();
 299
 300         if ($feeds) {
 301             foreach ($feeds as $feed) {
 302                 $this->element('link', array('rel' => $feed->rel(),
 303                                              'href' => $feed->url,
 304                                              'type' => $feed->mimeType(),
 305                                              'title' => $feed->title));
 306             }
 307         }
 308     }
 309
 310     /**
 311      * Show description.
 312      *
 313      * SHOULD overload
 314      *
 315      * @return nothing
 316      */
 317     function showDescription()
 318     {
 319         // does nothing by default
 320     }
 321
 322     /**
 323      * Show extra stuff in <head>.
 324      *
 325      * MAY overload
 326      *
 327      * @return nothing
 328      */
 329     function extraHead()
 330     {
 331         // does nothing by default
 332     }
 333
 334     /**
 335      * Show body.
 336      *
 337      * Calls template methods
 338      *
 339      * @return nothing
 340      */
 341     function showBody()
 342     {
 343         $this->elementStart('body', (common_current_user()) ? array('id' => $this->trimmed('action'),
 344                                                                     'class' => 'user_in')
 345                             : array('id' => $this->trimmed('action')));
 346         $this->elementStart('div', array('id' => 'wrap'));
 347         if (Event::handle('StartShowHeader', array($this))) {
 348             $this->showHeader();
 349             Event::handle('EndShowHeader', array($this));
 350         }
 351         $this->showCore();
 352         if (Event::handle('StartShowFooter', array($this))) {
 353             $this->showFooter();
 354             Event::handle('EndShowFooter', array($this));
 355         }
 356         $this->elementEnd('div');
 357         $this->showScripts();
 358         $this->elementEnd('body');
 359     }
 360
 361     /**
 362      * Show header of the page.
 363      *
 364      * Calls template methods
 365      *
 366      * @return nothing
 367      */
 368     function showHeader()
 369     {
 370         $this->elementStart('div', array('id' => 'header'));
 371         $this->showLogo();
 372         $this->showPrimaryNav();
 373         $this->showSiteNotice();
 374         if (common_logged_in()) {
 375             $this->showNoticeForm();
 376         } else {
 377             $this->showAnonymousMessage();
 378         }
 379         $this->elementEnd('div');
 380     }
 381
 382     /**
 383      * Show configured logo.
 384      *
 385      * @return nothing
 386      */
 387     function showLogo()
 388     {
 389         $this->elementStart('address', array('id' => 'site_contact',
 390                                              'class' => 'vcard'));
 391         if (Event::handle('StartAddressData', array($this))) {
 392             $this->elementStart('a', array('class' => 'url home bookmark',
 393                                            'href' => common_local_url('public')));
 394             if (common_config('site', 'logo') || file_exists(theme_file('logo.png'))) {
 395                 $this->element('img', array('class' => 'logo photo',
 396                                             'src' => (common_config('site', 'logo')) ? common_config('site', 'logo') : theme_path('logo.png'),
 397                                             'alt' => common_config('site', 'name')));
 398             }
 399             $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
 400             $this->elementEnd('a');
 401             Event::handle('EndAddressData', array($this));
 402         }
 403         $this->elementEnd('address');
 404     }
 405
 406     /**
 407      * Show primary navigation.
 408      *
 409      * @return nothing
 410      */
 411     function showPrimaryNav()
 412     {
 413         $user = common_current_user();
 414         $connect = '';
 415         if (common_config('xmpp', 'enabled')) {
 416             $connect = 'imsettings';
 417         } else if (common_config('sms', 'enabled')) {
 418             $connect = 'smssettings';
 419         } else if (common_config('twitter', 'enabled')) {
 420             $connect = 'twittersettings';
 421         }
 422
 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                 if ($connect) {
 434                     $this->menuItem(common_local_url($connect),
 435                                     _('Connect'), _('Connect to services'), false, 'nav_connect');
 436                 }
 437                 if (common_config('invite', 'enabled')) {
 438                     $this->menuItem(common_local_url('invite'),
 439                                     _('Invite'),
 440                                     sprintf(_('Invite friends and colleagues to join you on %s'),
 441                                             common_config('site', 'name')),
 442                                     false, 'nav_invitecontact');
 443                 }
 444                 $this->menuItem(common_local_url('logout'),
 445                                 _('Logout'), _('Logout from the site'), false, 'nav_logout');
 446             }
 447             else {
 448                 if (!common_config('site', 'openidonly')) {
 449                     if (!common_config('site', 'closed')) {
 450                         $this->menuItem(common_local_url('register'),
 451                                         _('Register'), _('Create an account'), false, 'nav_register');
 452                     }
 453                     $this->menuItem(common_local_url('login'),
 454                                     _('Login'), _('Login to the site'), false, 'nav_login');
 455                 } else {
 456                     $this->menuItem(common_local_url('openidlogin'),
 457                                     _('OpenID'), _('Login with OpenID'), false, 'nav_openid');
 458                 }
 459             }
 460             $this->menuItem(common_local_url('doc', array('title' => 'help')),
 461                             _('Help'), _('Help me!'), false, 'nav_help');
 462             if ($user || !common_config('site', 'private')) {
 463                 $this->menuItem(common_local_url('peoplesearch'),
 464                                 _('Search'), _('Search for people or text'), false, 'nav_search');
 465             }
 466             Event::handle('EndPrimaryNav', array($this));
 467         }
 468         $this->elementEnd('ul');
 469         $this->elementEnd('dd');
 470         $this->elementEnd('dl');
 471     }
 472
 473     /**
 474      * Show site notice.
 475      *
 476      * @return nothing
 477      */
 478     function showSiteNotice()
 479     {
 480         // Revist. Should probably do an hAtom pattern here
 481         $text = common_config('site', 'notice');
 482         if ($text) {
 483             $this->elementStart('dl', array('id' => 'site_notice',
 484                                             'class' => 'system_notice'));
 485             $this->element('dt', null, _('Site notice'));
 486             $this->elementStart('dd', null);
 487             $this->raw($text);
 488             $this->elementEnd('dd');
 489             $this->elementEnd('dl');
 490         }
 491     }
 492
 493     /**
 494      * Show notice form.
 495      *
 496      * MAY overload if no notice form needed... or direct message box????
 497      *
 498      * @return nothing
 499      */
 500     function showNoticeForm()
 501     {
 502         $notice_form = new NoticeForm($this);
 503         $notice_form->show();
 504     }
 505
 506     /**
 507      * Show anonymous message.
 508      *
 509      * SHOULD overload
 510      *
 511      * @return nothing
 512      */
 513     function showAnonymousMessage()
 514     {
 515         // needs to be defined by the class
 516     }
 517
 518     /**
 519      * Show core.
 520      *
 521      * Shows local navigation, content block and aside.
 522      *
 523      * @return nothing
 524      */
 525     function showCore()
 526     {
 527         $this->elementStart('div', array('id' => 'core'));
 528         if (Event::handle('StartShowLocalNavBlock', array($this))) {
 529             $this->showLocalNavBlock();
 530             Event::handle('EndShowLocalNavBlock', array($this));
 531         }
 532         if (Event::handle('StartShowContentBlock', array($this))) {
 533             $this->showContentBlock();
 534             Event::handle('EndShowContentBlock', array($this));
 535         }
 536         $this->showAside();
 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('doc', array('title' => 'contact')),
 736                             _('Contact'));
 737             $this->menuItem(common_local_url('doc', array('title' => 'badge')),
 738                             _('Badge'));
 739             Event::handle('EndSecondaryNav', array($this));
 740         }
 741         $this->elementEnd('ul');
 742         $this->elementEnd('dd');
 743         $this->elementEnd('dl');
 744     }
 745
 746     /**
 747      * Show licenses.
 748      *
 749      * @return nothing
 750      */
 751     function showLicenses()
 752     {
 753         $this->elementStart('dl', array('id' => 'licenses'));
 754         $this->showStatusNetLicense();
 755         $this->showContentLicense();
 756         $this->elementEnd('dl');
 757     }
 758
 759     /**
 760      * Show StatusNet license.
 761      *
 762      * @return nothing
 763      */
 764     function showStatusNetLicense()
 765     {
 766         $this->element('dt', array('id' => 'site_statusnet_license'), _('StatusNet software license'));
 767         $this->elementStart('dd', null);
 768         if (common_config('site', 'broughtby')) {
 769             $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
 770         } else {
 771             $instr = _('**%%site.name%%** is a microblogging service. ');
 772         }
 773         $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);
 774         $output = common_markup_to_html($instr);
 775         $this->raw($output);
 776         $this->elementEnd('dd');
 777         // do it
 778     }
 779
 780     /**
 781      * Show content license.
 782      *
 783      * @return nothing
 784      */
 785     function showContentLicense()
 786     {
 787         $this->element('dt', array('id' => 'site_content_license'), _('Site content license'));
 788         $this->elementStart('dd', array('id' => 'site_content_license_cc'));
 789         $this->elementStart('p');
 790         $this->element('img', array('id' => 'license_cc',
 791                                     'src' => common_config('license', 'image'),
 792                                     'alt' => common_config('license', 'title'),
 793                                     'width' => '80',
 794                                     'height' => '15'));
 795         //TODO: This is dirty: i18n
 796         $this->text(_('All '.common_config('site', 'name').' content and data are available under the '));
 797         $this->element('a', array('class' => 'license',
 798                                   'rel' => 'external license',
 799                                   'href' => common_config('license', 'url')),
 800                        common_config('license', 'title'));
 801         $this->text(_('license.'));
 802         $this->elementEnd('p');
 803         $this->elementEnd('dd');
 804     }
 805
 806     /**
 807      * Return last modified, if applicable.
 808      *
 809      * MAY override
 810      *
 811      * @return string last modified http header
 812      */
 813     function lastModified()
 814     {
 815         // For comparison with If-Last-Modified
 816         // If not applicable, return null
 817         return null;
 818     }
 819
 820     /**
 821      * Return etag, if applicable.
 822      *
 823      * MAY override
 824      *
 825      * @return string etag http header
 826      */
 827     function etag()
 828     {
 829         return null;
 830     }
 831
 832     /**
 833      * Return true if read only.
 834      *
 835      * MAY override
 836      *
 837      * @param array $args other arguments
 838      *
 839      * @return boolean is read only action?
 840      */
 841
 842     function isReadOnly($args)
 843     {
 844         return false;
 845     }
 846
 847     /**
 848      * Returns query argument or default value if not found
 849      *
 850      * @param string $key requested argument
 851      * @param string $def default value to return if $key is not provided
 852      *
 853      * @return boolean is read only action?
 854      */
 855     function arg($key, $def=null)
 856     {
 857         if (array_key_exists($key, $this->args)) {
 858             return $this->args[$key];
 859         } else {
 860             return $def;
 861         }
 862     }
 863
 864     /**
 865      * Returns trimmed query argument or default value if not found
 866      *
 867      * @param string $key requested argument
 868      * @param string $def default value to return if $key is not provided
 869      *
 870      * @return boolean is read only action?
 871      */
 872     function trimmed($key, $def=null)
 873     {
 874         $arg = $this->arg($key, $def);
 875         return is_string($arg) ? trim($arg) : $arg;
 876     }
 877
 878     /**
 879      * Handler method
 880      *
 881      * @param array $argarray is ignored since it's now passed in in prepare()
 882      *
 883      * @return boolean is read only action?
 884      */
 885     function handle($argarray=null)
 886     {
 887         header('Vary: Accept-Encoding,Cookie');
 888         $lm   = $this->lastModified();
 889         $etag = $this->etag();
 890         if ($etag) {
 891             header('ETag: ' . $etag);
 892         }
 893         if ($lm) {
 894             header('Last-Modified: ' . date(DATE_RFC1123, $lm));
 895             if (array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
 896                 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
 897                 $ims = strtotime($if_modified_since);
 898                 if ($lm <= $ims) {
 899                     $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
 900                       $_SERVER['HTTP_IF_NONE_MATCH'] : null;
 901                     if (!$if_none_match ||
 902                         !$etag ||
 903                         $this->_hasEtag($etag, $if_none_match)) {
 904                         header('HTTP/1.1 304 Not Modified');
 905                         // Better way to do this?
 906                         exit(0);
 907                     }
 908                 }
 909             }
 910         }
 911     }
 912
 913     /**
 914      * Has etag? (private)
 915      *
 916      * @param string $etag          etag http header
 917      * @param string $if_none_match ifNoneMatch http header
 918      *
 919      * @return boolean
 920      */
 921
 922     function _hasEtag($etag, $if_none_match)
 923     {
 924         $etags = explode(',', $if_none_match);
 925         return in_array($etag, $etags) || in_array('*', $etags);
 926     }
 927
 928     /**
 929      * Boolean understands english (yes, no, true, false)
 930      *
 931      * @param string $key query key we're interested in
 932      * @param string $def default value
 933      *
 934      * @return boolean interprets yes/no strings as boolean
 935      */
 936     function boolean($key, $def=false)
 937     {
 938         $arg = strtolower($this->trimmed($key));
 939
 940         if (is_null($arg)) {
 941             return $def;
 942         } else if (in_array($arg, array('true', 'yes', '1'))) {
 943             return true;
 944         } else if (in_array($arg, array('false', 'no', '0'))) {
 945             return false;
 946         } else {
 947             return $def;
 948         }
 949     }
 950
 951     /**
 952      * Server error
 953      *
 954      * @param string  $msg  error message to display
 955      * @param integer $code http error code, 500 by default
 956      *
 957      * @return nothing
 958      */
 959
 960     function serverError($msg, $code=500)
 961     {
 962         $action = $this->trimmed('action');
 963         common_debug("Server error '$code' on '$action': $msg", __FILE__);
 964         throw new ServerException($msg, $code);
 965     }
 966
 967     /**
 968      * Client error
 969      *
 970      * @param string  $msg  error message to display
 971      * @param integer $code http error code, 400 by default
 972      *
 973      * @return nothing
 974      */
 975
 976     function clientError($msg, $code=400)
 977     {
 978         $action = $this->trimmed('action');
 979         common_debug("User error '$code' on '$action': $msg", __FILE__);
 980         throw new ClientException($msg, $code);
 981     }
 982
 983     /**
 984      * Returns the current URL
 985      *
 986      * @return string current URL
 987      */
 988
 989     function selfUrl()
 990     {
 991         $action = $this->trimmed('action');
 992         $args   = $this->args;
 993         unset($args['action']);
 994         if (common_config('site', 'fancy')) {
 995             unset($args['p']);
 996         }
 997         if (array_key_exists('submit', $args)) {
 998             unset($args['submit']);
 999         }
1000         foreach (array_keys($_COOKIE) as $cookie) {
1001             unset($args[$cookie]);
1002         }
1003
1004         return common_local_url($action, $args);
1005     }
1006
1007     /**
1008      * Generate a menu item
1009      *
1010      * @param string  $url         menu URL
1011      * @param string  $text        menu name
1012      * @param string  $title       title attribute, null by default
1013      * @param boolean $is_selected current menu item, false by default
1014      * @param string  $id          element id, null by default
1015      *
1016      * @return nothing
1017      */
1018     function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1019     {
1020         // Added @id to li for some control.
1021         // XXX: We might want to move this to htmloutputter.php
1022         $lattrs = array();
1023         if ($is_selected) {
1024             $lattrs['class'] = 'current';
1025         }
1026
1027         (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1028
1029         $this->elementStart('li', $lattrs);
1030         $attrs['href'] = $url;
1031         if ($title) {
1032             $attrs['title'] = $title;
1033         }
1034         $this->element('a', $attrs, $text);
1035         $this->elementEnd('li');
1036     }
1037
1038     /**
1039      * Generate pagination links
1040      *
1041      * @param boolean $have_before is there something before?
1042      * @param boolean $have_after  is there something after?
1043      * @param integer $page        current page
1044      * @param string  $action      current action
1045      * @param array   $args        rest of query arguments
1046      *
1047      * @return nothing
1048      */
1049     function pagination($have_before, $have_after, $page, $action, $args=null)
1050     {
1051         // Does a little before-after block for next/prev page
1052         if ($have_before || $have_after) {
1053             $this->elementStart('div', array('class' => 'pagination'));
1054             $this->elementStart('dl', null);
1055             $this->element('dt', null, _('Pagination'));
1056             $this->elementStart('dd', null);
1057             $this->elementStart('ul', array('class' => 'nav'));
1058         }
1059         if ($have_before) {
1060             $pargs   = array('page' => $page-1);
1061             $this->elementStart('li', array('class' => 'nav_prev'));
1062             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1063                                       'rel' => 'prev'),
1064                            _('After'));
1065             $this->elementEnd('li');
1066         }
1067         if ($have_after) {
1068             $pargs   = array('page' => $page+1);
1069             $this->elementStart('li', array('class' => 'nav_next'));
1070             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1071                                       'rel' => 'next'),
1072                            _('Before'));
1073             $this->elementEnd('li');
1074         }
1075         if ($have_before || $have_after) {
1076             $this->elementEnd('ul');
1077             $this->elementEnd('dd');
1078             $this->elementEnd('dl');
1079             $this->elementEnd('div');
1080         }
1081     }
1082
1083     /**
1084      * An array of feeds for this action.
1085      *
1086      * Returns an array of potential feeds for this action.
1087      *
1088      * @return array Feed object to show in head and links
1089      */
1090
1091     function getFeeds()
1092     {
1093         return null;
1094     }
1095
1096     /**
1097      * A design for this action
1098      *
1099      * @return Design a design object to use
1100      */
1101
1102     function getDesign()
1103     {
1104         return Design::siteDesign();
1105     }
1106 }