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