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         $this->showTitle();
 124         $this->showShortcutIcon();
 125         $this->showStylesheets();
 126         $this->showScripts();
 127         $this->showOpenSearch();
 128         $this->showFeeds();
 129         $this->showDescription();
 130         $this->extraHead();
 131         $this->elementEnd('head');
 132     }
 133
 134     /**
 135      * Show title, a template method.
 136      *
 137      * @return nothing
 138      */
 139     function showTitle()
 140     {
 141         $this->element('title', null,
 142                        sprintf(_("%s - %s"),
 143                                $this->title(),
 144                                common_config('site', 'name')));
 145     }
 146
 147     /**
 148      * Returns the page title
 149      *
 150      * SHOULD overload
 151      *
 152      * @return string page title
 153      */
 154
 155     function title()
 156     {
 157         return _("Untitled page");
 158     }
 159
 160     /**
 161      * Show themed shortcut icon
 162      *
 163      * @return nothing
 164      */
 165     function showShortcutIcon()
 166     {
 167         if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/favicon.ico')) {
 168             $this->element('link', array('rel' => 'shortcut icon',
 169                                          'href' => theme_path('favicon.ico')));
 170         } else {
 171             $this->element('link', array('rel' => 'shortcut icon',
 172                                          'href' => common_path('favicon.ico')));
 173         }
 174
 175         if (common_config('site', 'mobile')) {
 176             if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/apple-touch-icon.png')) {
 177                 $this->element('link', array('rel' => 'apple-touch-icon',
 178                                              'href' => theme_path('apple-touch-icon.png')));
 179             } else {
 180                 $this->element('link', array('rel' => 'apple-touch-icon',
 181                                              'href' => common_path('apple-touch-icon.png')));
 182             }
 183         }
 184     }
 185
 186     /**
 187      * Show stylesheets
 188      *
 189      * @return nothing
 190      */
 191     function showStylesheets()
 192     {
 193         if (Event::handle('StartShowStyles', array($this))) {
 194
 195             // Use old name for StatusNet for compatibility on events
 196
 197             if (Event::handle('StartShowStatusNetStyles', array($this)) &&
 198                 Event::handle('StartShowLaconicaStyles', array($this))) {
 199                 $this->cssLink('css/display.css',null,'screen, projection, tv');
 200                 if (common_config('site', 'mobile')) {
 201                     // TODO: "handheld" CSS for other mobile devices
 202                     $this->cssLink('css/mobile.css','base','only screen and (max-device-width: 480px)'); // Mobile WebKit
 203                 }
 204                 $this->cssLink('css/print.css','base','print');
 205                 Event::handle('EndShowStatusNetStyles', array($this));
 206                 Event::handle('EndShowLaconicaStyles', array($this));
 207             }
 208
 209             if (Event::handle('StartShowUAStyles', array($this))) {
 210                 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
 211                                'href="'.theme_path('css/ie.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
 212                 foreach (array(6,7) as $ver) {
 213                     if (file_exists(theme_file('css/ie'.$ver.'.css', 'base'))) {
 214                         // Yes, IE people should be put in jail.
 215                         $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
 216                                        'href="'.theme_path('css/ie'.$ver.'.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
 217                     }
 218                 }
 219                 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
 220                                'href="'.theme_path('css/ie.css', null).'?version='.STATUSNET_VERSION.'" /><![endif]');
 221                 Event::handle('EndShowUAStyles', array($this));
 222             }
 223
 224             if (Event::handle('StartShowDesign', array($this))) {
 225
 226                 $user = common_current_user();
 227
 228                 if (empty($user) || $user->viewdesigns) {
 229                     $design = $this->getDesign();
 230
 231                     if (!empty($design)) {
 232                         $design->showCSS($this);
 233                     }
 234                 }
 235
 236                 Event::handle('EndShowDesign', array($this));
 237             }
 238             Event::handle('EndShowStyles', array($this));
 239         }
 240     }
 241
 242     /**
 243      * Show javascript headers
 244      *
 245      * @return nothing
 246      */
 247     function showScripts()
 248     {
 249         if (Event::handle('StartShowScripts', array($this))) {
 250             if (Event::handle('StartShowJQueryScripts', array($this))) {
 251                 $this->script('js/jquery.min.js');
 252                 $this->script('js/jquery.form.js');
 253                 $this->script('js/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('js/xbImportNode.js');
 259                 $this->script('js/util.js');
 260                 // Frame-busting code to avoid clickjacking attacks.
 261                 $this->element('script', array('type' => 'text/javascript'),
 262                                '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->elementEnd('body');
 356     }
 357
 358     /**
 359      * Show header of the page.
 360      *
 361      * Calls template methods
 362      *
 363      * @return nothing
 364      */
 365     function showHeader()
 366     {
 367         $this->elementStart('div', array('id' => 'header'));
 368         $this->showLogo();
 369         $this->showPrimaryNav();
 370         $this->showSiteNotice();
 371         if (common_logged_in()) {
 372             $this->showNoticeForm();
 373         } else {
 374             $this->showAnonymousMessage();
 375         }
 376         $this->elementEnd('div');
 377     }
 378
 379     /**
 380      * Show configured logo.
 381      *
 382      * @return nothing
 383      */
 384     function showLogo()
 385     {
 386         $this->elementStart('address', array('id' => 'site_contact',
 387                                              'class' => 'vcard'));
 388         if (Event::handle('StartAddressData', array($this))) {
 389             $this->elementStart('a', array('class' => 'url home bookmark',
 390                                            'href' => common_local_url('public')));
 391             if (common_config('site', 'logo') || file_exists(theme_file('logo.png'))) {
 392                 $this->element('img', array('class' => 'logo photo',
 393                                             'src' => (common_config('site', 'logo')) ? common_config('site', 'logo') : theme_path('logo.png'),
 394                                             'alt' => common_config('site', 'name')));
 395             }
 396             $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
 397             $this->elementEnd('a');
 398             Event::handle('EndAddressData', array($this));
 399         }
 400         $this->elementEnd('address');
 401     }
 402
 403     /**
 404      * Show primary navigation.
 405      *
 406      * @return nothing
 407      */
 408     function showPrimaryNav()
 409     {
 410         $user = common_current_user();
 411         $connect = '';
 412         if (common_config('xmpp', 'enabled')) {
 413             $connect = 'imsettings';
 414         } else if (common_config('sms', 'enabled')) {
 415             $connect = 'smssettings';
 416         } else if (common_config('twitter', 'enabled')) {
 417             $connect = 'twittersettings';
 418         }
 419
 420         $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
 421         $this->element('dt', null, _('Primary site navigation'));
 422         $this->elementStart('dd');
 423         $this->elementStart('ul', array('class' => 'nav'));
 424         if (Event::handle('StartPrimaryNav', array($this))) {
 425             if ($user) {
 426                 $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
 427                                 _('Home'), _('Personal profile and friends timeline'), false, 'nav_home');
 428                 $this->menuItem(common_local_url('profilesettings'),
 429                                 _('Account'), _('Change your email, avatar, password, profile'), false, 'nav_account');
 430                 if ($connect) {
 431                     $this->menuItem(common_local_url($connect),
 432                                     _('Connect'), _('Connect to services'), false, 'nav_connect');
 433                 }
 434                 if (common_config('invite', 'enabled')) {
 435                     $this->menuItem(common_local_url('invite'),
 436                                     _('Invite'),
 437                                     sprintf(_('Invite friends and colleagues to join you on %s'),
 438                                             common_config('site', 'name')),
 439                                     false, 'nav_invitecontact');
 440                 }
 441                 $this->menuItem(common_local_url('logout'),
 442                                 _('Logout'), _('Logout from the site'), false, 'nav_logout');
 443             }
 444             else {
 445                 if (!common_config('site', 'openidonly')) {
 446                     if (!common_config('site', 'closed')) {
 447                         $this->menuItem(common_local_url('register'),
 448                                         _('Register'), _('Create an account'), false, 'nav_register');
 449                     }
 450                     $this->menuItem(common_local_url('login'),
 451                                     _('Login'), _('Login to the site'), false, 'nav_login');
 452                 } else {
 453                     $this->menuItem(common_local_url('openidlogin'),
 454                                     _('OpenID'), _('Login with OpenID'), false, 'nav_openid');
 455                 }
 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         $this->showAside();
 534         $this->elementEnd('div');
 535     }
 536
 537     /**
 538      * Show local navigation block.
 539      *
 540      * @return nothing
 541      */
 542     function showLocalNavBlock()
 543     {
 544         $this->elementStart('dl', array('id' => 'site_nav_local_views'));
 545         $this->element('dt', null, _('Local views'));
 546         $this->elementStart('dd');
 547         $this->showLocalNav();
 548         $this->elementEnd('dd');
 549         $this->elementEnd('dl');
 550     }
 551
 552     /**
 553      * Show local navigation.
 554      *
 555      * SHOULD overload
 556      *
 557      * @return nothing
 558      */
 559     function showLocalNav()
 560     {
 561         // does nothing by default
 562     }
 563
 564     /**
 565      * Show content block.
 566      *
 567      * @return nothing
 568      */
 569     function showContentBlock()
 570     {
 571         $this->elementStart('div', array('id' => 'content'));
 572         $this->showPageTitle();
 573         $this->showPageNoticeBlock();
 574         $this->elementStart('div', array('id' => 'content_inner'));
 575         // show the actual content (forms, lists, whatever)
 576         $this->showContent();
 577         $this->elementEnd('div');
 578         $this->elementEnd('div');
 579     }
 580
 581     /**
 582      * Show page title.
 583      *
 584      * @return nothing
 585      */
 586     function showPageTitle()
 587     {
 588         $this->element('h1', null, $this->title());
 589     }
 590
 591     /**
 592      * Show page notice block.
 593      *
 594      * Only show the block if a subclassed action has overrided
 595      * Action::showPageNotice(), or an event handler is registered for
 596      * the StartShowPageNotice event, in which case we assume the
 597      * 'page_notice' definition list is desired.  This is to prevent
 598      * empty 'page_notice' definition lists from being output everywhere.
 599      *
 600      * @return nothing
 601      */
 602     function showPageNoticeBlock()
 603     {
 604         $rmethod = new ReflectionMethod($this, 'showPageNotice');
 605         $dclass = $rmethod->getDeclaringClass()->getName();
 606
 607         if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
 608
 609             $this->elementStart('dl', array('id' => 'page_notice',
 610                                             'class' => 'system_notice'));
 611             $this->element('dt', null, _('Page notice'));
 612             $this->elementStart('dd');
 613             if (Event::handle('StartShowPageNotice', array($this))) {
 614                 $this->showPageNotice();
 615                 Event::handle('EndShowPageNotice', array($this));
 616             }
 617             $this->elementEnd('dd');
 618             $this->elementEnd('dl');
 619         }
 620     }
 621
 622     /**
 623      * Show page notice.
 624      *
 625      * SHOULD overload (unless there's not a notice)
 626      *
 627      * @return nothing
 628      */
 629     function showPageNotice()
 630     {
 631     }
 632
 633     /**
 634      * Show content.
 635      *
 636      * MUST overload (unless there's not a notice)
 637      *
 638      * @return nothing
 639      */
 640     function showContent()
 641     {
 642     }
 643
 644     /**
 645      * Show Aside.
 646      *
 647      * @return nothing
 648      */
 649
 650     function showAside()
 651     {
 652         $this->elementStart('div', array('id' => 'aside_primary',
 653                                          'class' => 'aside'));
 654         if (Event::handle('StartShowExportData', array($this))) {
 655             $this->showExportData();
 656             Event::handle('EndShowExportData', array($this));
 657         }
 658         if (Event::handle('StartShowSections', array($this))) {
 659             $this->showSections();
 660             Event::handle('EndShowSections', array($this));
 661         }
 662         $this->elementEnd('div');
 663     }
 664
 665     /**
 666      * Show export data feeds.
 667      *
 668      * @return void
 669      */
 670
 671     function showExportData()
 672     {
 673         $feeds = $this->getFeeds();
 674         if ($feeds) {
 675             $fl = new FeedList($this);
 676             $fl->show($feeds);
 677         }
 678     }
 679
 680     /**
 681      * Show sections.
 682      *
 683      * SHOULD overload
 684      *
 685      * @return nothing
 686      */
 687     function showSections()
 688     {
 689         // for each section, show it
 690     }
 691
 692     /**
 693      * Show footer.
 694      *
 695      * @return nothing
 696      */
 697     function showFooter()
 698     {
 699         $this->elementStart('div', array('id' => 'footer'));
 700         $this->showSecondaryNav();
 701         $this->showLicenses();
 702         $this->elementEnd('div');
 703     }
 704
 705     /**
 706      * Show secondary navigation.
 707      *
 708      * @return nothing
 709      */
 710     function showSecondaryNav()
 711     {
 712         $this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
 713         $this->element('dt', null, _('Secondary site navigation'));
 714         $this->elementStart('dd', null);
 715         $this->elementStart('ul', array('class' => 'nav'));
 716         if (Event::handle('StartSecondaryNav', array($this))) {
 717             $this->menuItem(common_local_url('doc', array('title' => 'help')),
 718                             _('Help'));
 719             $this->menuItem(common_local_url('doc', array('title' => 'about')),
 720                             _('About'));
 721             $this->menuItem(common_local_url('doc', array('title' => 'faq')),
 722                             _('FAQ'));
 723             $bb = common_config('site', 'broughtby');
 724             if (!empty($bb)) {
 725                 $this->menuItem(common_local_url('doc', array('title' => 'tos')),
 726                                 _('TOS'));
 727             }
 728             $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
 729                             _('Privacy'));
 730             $this->menuItem(common_local_url('doc', array('title' => 'source')),
 731                             _('Source'));
 732             $this->menuItem(common_local_url('doc', array('title' => 'contact')),
 733                             _('Contact'));
 734             $this->menuItem(common_local_url('doc', array('title' => 'badge')),
 735                             _('Badge'));
 736             Event::handle('EndSecondaryNav', array($this));
 737         }
 738         $this->elementEnd('ul');
 739         $this->elementEnd('dd');
 740         $this->elementEnd('dl');
 741     }
 742
 743     /**
 744      * Show licenses.
 745      *
 746      * @return nothing
 747      */
 748     function showLicenses()
 749     {
 750         $this->elementStart('dl', array('id' => 'licenses'));
 751         $this->showStatusNetLicense();
 752         $this->showContentLicense();
 753         $this->elementEnd('dl');
 754     }
 755
 756     /**
 757      * Show StatusNet license.
 758      *
 759      * @return nothing
 760      */
 761     function showStatusNetLicense()
 762     {
 763         $this->element('dt', array('id' => 'site_statusnet_license'), _('StatusNet software license'));
 764         $this->elementStart('dd', null);
 765         if (common_config('site', 'broughtby')) {
 766             $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
 767         } else {
 768             $instr = _('**%%site.name%%** is a microblogging service. ');
 769         }
 770         $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);
 771         $output = common_markup_to_html($instr);
 772         $this->raw($output);
 773         $this->elementEnd('dd');
 774         // do it
 775     }
 776
 777     /**
 778      * Show content license.
 779      *
 780      * @return nothing
 781      */
 782     function showContentLicense()
 783     {
 784         $this->element('dt', array('id' => 'site_content_license'), _('StatusNet software license'));
 785         $this->elementStart('dd', array('id' => 'site_content_license_cc'));
 786         $this->elementStart('p');
 787         $this->element('img', array('id' => 'license_cc',
 788                                     'src' => common_config('license', 'image'),
 789                                     'alt' => common_config('license', 'title'),
 790                                     'width' => '80',
 791                                     'height' => '15'));
 792         //TODO: This is dirty: i18n
 793         $this->text(_('All '.common_config('site', 'name').' content and data are available under the '));
 794         $this->element('a', array('class' => 'license',
 795                                   'rel' => 'external license',
 796                                   'href' => common_config('license', 'url')),
 797                        common_config('license', 'title'));
 798         $this->text(_('license.'));
 799         $this->elementEnd('p');
 800         $this->elementEnd('dd');
 801     }
 802
 803     /**
 804      * Return last modified, if applicable.
 805      *
 806      * MAY override
 807      *
 808      * @return string last modified http header
 809      */
 810     function lastModified()
 811     {
 812         // For comparison with If-Last-Modified
 813         // If not applicable, return null
 814         return null;
 815     }
 816
 817     /**
 818      * Return etag, if applicable.
 819      *
 820      * MAY override
 821      *
 822      * @return string etag http header
 823      */
 824     function etag()
 825     {
 826         return null;
 827     }
 828
 829     /**
 830      * Return true if read only.
 831      *
 832      * MAY override
 833      *
 834      * @param array $args other arguments
 835      *
 836      * @return boolean is read only action?
 837      */
 838
 839     function isReadOnly($args)
 840     {
 841         return false;
 842     }
 843
 844     /**
 845      * Returns query argument or default value if not found
 846      *
 847      * @param string $key requested argument
 848      * @param string $def default value to return if $key is not provided
 849      *
 850      * @return boolean is read only action?
 851      */
 852     function arg($key, $def=null)
 853     {
 854         if (array_key_exists($key, $this->args)) {
 855             return $this->args[$key];
 856         } else {
 857             return $def;
 858         }
 859     }
 860
 861     /**
 862      * Returns trimmed query argument or default value if not found
 863      *
 864      * @param string $key requested argument
 865      * @param string $def default value to return if $key is not provided
 866      *
 867      * @return boolean is read only action?
 868      */
 869     function trimmed($key, $def=null)
 870     {
 871         $arg = $this->arg($key, $def);
 872         return is_string($arg) ? trim($arg) : $arg;
 873     }
 874
 875     /**
 876      * Handler method
 877      *
 878      * @param array $argarray is ignored since it's now passed in in prepare()
 879      *
 880      * @return boolean is read only action?
 881      */
 882     function handle($argarray=null)
 883     {
 884         $lm   = $this->lastModified();
 885         $etag = $this->etag();
 886         if ($etag) {
 887             header('ETag: ' . $etag);
 888         }
 889         if ($lm) {
 890             header('Last-Modified: ' . date(DATE_RFC1123, $lm));
 891             if (array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
 892                 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
 893                 $ims = strtotime($if_modified_since);
 894                 if ($lm <= $ims) {
 895                     $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
 896                       $_SERVER['HTTP_IF_NONE_MATCH'] : null;
 897                     if (!$if_none_match ||
 898                         !$etag ||
 899                         $this->_hasEtag($etag, $if_none_match)) {
 900                         header('HTTP/1.1 304 Not Modified');
 901                         // Better way to do this?
 902                         exit(0);
 903                     }
 904                 }
 905             }
 906         }
 907     }
 908
 909     /**
 910      * Has etag? (private)
 911      *
 912      * @param string $etag          etag http header
 913      * @param string $if_none_match ifNoneMatch http header
 914      *
 915      * @return boolean
 916      */
 917
 918     function _hasEtag($etag, $if_none_match)
 919     {
 920         $etags = explode(',', $if_none_match);
 921         return in_array($etag, $etags) || in_array('*', $etags);
 922     }
 923
 924     /**
 925      * Boolean understands english (yes, no, true, false)
 926      *
 927      * @param string $key query key we're interested in
 928      * @param string $def default value
 929      *
 930      * @return boolean interprets yes/no strings as boolean
 931      */
 932     function boolean($key, $def=false)
 933     {
 934         $arg = strtolower($this->trimmed($key));
 935
 936         if (is_null($arg)) {
 937             return $def;
 938         } else if (in_array($arg, array('true', 'yes', '1'))) {
 939             return true;
 940         } else if (in_array($arg, array('false', 'no', '0'))) {
 941             return false;
 942         } else {
 943             return $def;
 944         }
 945     }
 946
 947     /**
 948      * Server error
 949      *
 950      * @param string  $msg  error message to display
 951      * @param integer $code http error code, 500 by default
 952      *
 953      * @return nothing
 954      */
 955
 956     function serverError($msg, $code=500)
 957     {
 958         $action = $this->trimmed('action');
 959         common_debug("Server error '$code' on '$action': $msg", __FILE__);
 960         throw new ServerException($msg, $code);
 961     }
 962
 963     /**
 964      * Client error
 965      *
 966      * @param string  $msg  error message to display
 967      * @param integer $code http error code, 400 by default
 968      *
 969      * @return nothing
 970      */
 971
 972     function clientError($msg, $code=400)
 973     {
 974         $action = $this->trimmed('action');
 975         common_debug("User error '$code' on '$action': $msg", __FILE__);
 976         throw new ClientException($msg, $code);
 977     }
 978
 979     /**
 980      * Returns the current URL
 981      *
 982      * @return string current URL
 983      */
 984
 985     function selfUrl()
 986     {
 987         $action = $this->trimmed('action');
 988         $args   = $this->args;
 989         unset($args['action']);
 990         if (common_config('site', 'fancy')) {
 991             unset($args['p']);
 992         }
 993         if (array_key_exists('submit', $args)) {
 994             unset($args['submit']);
 995         }
 996         foreach (array_keys($_COOKIE) as $cookie) {
 997             unset($args[$cookie]);
 998         }
 999
1000         return common_local_url($action, $args);
1001     }
1002
1003     /**
1004      * Generate a menu item
1005      *
1006      * @param string  $url         menu URL
1007      * @param string  $text        menu name
1008      * @param string  $title       title attribute, null by default
1009      * @param boolean $is_selected current menu item, false by default
1010      * @param string  $id          element id, null by default
1011      *
1012      * @return nothing
1013      */
1014     function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1015     {
1016         // Added @id to li for some control.
1017         // XXX: We might want to move this to htmloutputter.php
1018         $lattrs = array();
1019         if ($is_selected) {
1020             $lattrs['class'] = 'current';
1021         }
1022
1023         (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1024
1025         $this->elementStart('li', $lattrs);
1026         $attrs['href'] = $url;
1027         if ($title) {
1028             $attrs['title'] = $title;
1029         }
1030         $this->element('a', $attrs, $text);
1031         $this->elementEnd('li');
1032     }
1033
1034     /**
1035      * Generate pagination links
1036      *
1037      * @param boolean $have_before is there something before?
1038      * @param boolean $have_after  is there something after?
1039      * @param integer $page        current page
1040      * @param string  $action      current action
1041      * @param array   $args        rest of query arguments
1042      *
1043      * @return nothing
1044      */
1045     function pagination($have_before, $have_after, $page, $action, $args=null)
1046     {
1047         // Does a little before-after block for next/prev page
1048         if ($have_before || $have_after) {
1049             $this->elementStart('div', array('class' => 'pagination'));
1050             $this->elementStart('dl', null);
1051             $this->element('dt', null, _('Pagination'));
1052             $this->elementStart('dd', null);
1053             $this->elementStart('ul', array('class' => 'nav'));
1054         }
1055         if ($have_before) {
1056             $pargs   = array('page' => $page-1);
1057             $this->elementStart('li', array('class' => 'nav_prev'));
1058             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1059                                       'rel' => 'prev'),
1060                            _('After'));
1061             $this->elementEnd('li');
1062         }
1063         if ($have_after) {
1064             $pargs   = array('page' => $page+1);
1065             $this->elementStart('li', array('class' => 'nav_next'));
1066             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1067                                       'rel' => 'next'),
1068                            _('Before'));
1069             $this->elementEnd('li');
1070         }
1071         if ($have_before || $have_after) {
1072             $this->elementEnd('ul');
1073             $this->elementEnd('dd');
1074             $this->elementEnd('dl');
1075             $this->elementEnd('div');
1076         }
1077     }
1078
1079     /**
1080      * An array of feeds for this action.
1081      *
1082      * Returns an array of potential feeds for this action.
1083      *
1084      * @return array Feed object to show in head and links
1085      */
1086
1087     function getFeeds()
1088     {
1089         return null;
1090     }
1091
1092     /**
1093      * A design for this action
1094      *
1095      * @return Design a design object to use
1096      */
1097
1098     function getDesign()
1099     {
1100         return Design::siteDesign();
1101     }
1102 }