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