lib/action.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Base class for all actions (~views)
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Action
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @author    Sarven Capadisli <csarven@status.net>
  26  * @copyright 2008 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET') && !defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 require_once INSTALLDIR.'/lib/noticeform.php';
  36 require_once INSTALLDIR.'/lib/htmloutputter.php';
  37
  38 /**
  39  * Base class for all actions
  40  *
  41  * This is the base class for all actions in the package. An action is
  42  * more or less a "view" in an MVC framework.
  43  *
  44  * Actions are responsible for extracting and validating parameters; using
  45  * model classes to read and write to the database; and doing ouput.
  46  *
  47  * @category Output
  48  * @package  StatusNet
  49  * @author   Evan Prodromou <evan@status.net>
  50  * @author   Sarven Capadisli <csarven@status.net>
  51  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  52  * @link     http://status.net/
  53  *
  54  * @see      HTMLOutputter
  55  */
  56 class Action extends HTMLOutputter // lawsuit
  57 {
  58     var $args;
  59
  60     /**
  61      * Constructor
  62      *
  63      * Just wraps the HTMLOutputter constructor.
  64      *
  65      * @param string  $output URI to output to, default = stdout
  66      * @param boolean $indent Whether to indent output, default true
  67      *
  68      * @see XMLOutputter::__construct
  69      * @see HTMLOutputter::__construct
  70      */
  71     function __construct($output='php://output', $indent=true)
  72     {
  73         parent::__construct($output, $indent);
  74     }
  75
  76     /**
  77      * For initializing members of the class.
  78      *
  79      * @param array $argarray misc. arguments
  80      *
  81      * @return boolean true
  82      */
  83     function prepare($argarray)
  84     {
  85         $this->args =& common_copy_args($argarray);
  86         return true;
  87     }
  88
  89     /**
  90      * Show page, a template method.
  91      *
  92      * @return nothing
  93      */
  94     function showPage()
  95     {
  96         if (Event::handle('StartShowHTML', array($this))) {
  97             $this->startHTML();
  98             Event::handle('EndShowHTML', array($this));
  99         }
 100         if (Event::handle('StartShowHead', array($this))) {
 101             $this->showHead();
 102             Event::handle('EndShowHead', array($this));
 103         }
 104         if (Event::handle('StartShowBody', array($this))) {
 105             $this->showBody();
 106             Event::handle('EndShowBody', array($this));
 107         }
 108         if (Event::handle('StartEndHTML', array($this))) {
 109             $this->endHTML();
 110             Event::handle('EndEndHTML', array($this));
 111         }
 112     }
 113
 114     /**
 115      * Show head, a template method.
 116      *
 117      * @return nothing
 118      */
 119     function showHead()
 120     {
 121         // XXX: attributes (profile?)
 122         $this->elementStart('head');
 123         if (Event::handle('StartShowHeadElements', array($this))) {
 124             $this->showTitle();
 125             $this->showShortcutIcon();
 126             $this->showStylesheets();
 127             $this->showOpenSearch();
 128             $this->showFeeds();
 129             $this->showDescription();
 130             $this->extraHead();
 131             Event::handle('EndShowHeadElements', array($this));
 132         }
 133         $this->elementEnd('head');
 134     }
 135
 136     /**
 137      * Show title, a template method.
 138      *
 139      * @return nothing
 140      */
 141     function showTitle()
 142     {
 143         $this->element('title', null,
 144                        sprintf(_("%s - %s"),
 145                                $this->title(),
 146                                common_config('site', 'name')));
 147     }
 148
 149     /**
 150      * Returns the page title
 151      *
 152      * SHOULD overload
 153      *
 154      * @return string page title
 155      */
 156
 157     function title()
 158     {
 159         return _("Untitled page");
 160     }
 161
 162     /**
 163      * Show themed shortcut icon
 164      *
 165      * @return nothing
 166      */
 167     function showShortcutIcon()
 168     {
 169         if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/favicon.ico')) {
 170             $this->element('link', array('rel' => 'shortcut icon',
 171                                          'href' => theme_path('favicon.ico')));
 172         } else {
 173             $this->element('link', array('rel' => 'shortcut icon',
 174                                          'href' => common_path('favicon.ico')));
 175         }
 176
 177         if (common_config('site', 'mobile')) {
 178             if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/apple-touch-icon.png')) {
 179                 $this->element('link', array('rel' => 'apple-touch-icon',
 180                                              'href' => theme_path('apple-touch-icon.png')));
 181             } else {
 182                 $this->element('link', array('rel' => 'apple-touch-icon',
 183                                              'href' => common_path('apple-touch-icon.png')));
 184             }
 185         }
 186     }
 187
 188     /**
 189      * Show stylesheets
 190      *
 191      * @return nothing
 192      */
 193     function showStylesheets()
 194     {
 195         if (Event::handle('StartShowStyles', array($this))) {
 196
 197             // Use old name for StatusNet for compatibility on events
 198
 199             if (Event::handle('StartShowStatusNetStyles', array($this)) &&
 200                 Event::handle('StartShowLaconicaStyles', array($this))) {
 201                 $this->cssLink('css/display.css',null,'screen, projection, tv');
 202                 if (common_config('site', 'mobile')) {
 203                     // TODO: "handheld" CSS for other mobile devices
 204                     $this->cssLink('css/mobile.css','base','only screen and (max-device-width: 480px)'); // Mobile WebKit
 205                 }
 206                 $this->cssLink('css/print.css','base','print');
 207                 Event::handle('EndShowStatusNetStyles', array($this));
 208                 Event::handle('EndShowLaconicaStyles', array($this));
 209             }
 210
 211             if (Event::handle('StartShowUAStyles', array($this))) {
 212                 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
 213                                'href="'.theme_path('css/ie.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
 214                 foreach (array(6,7) as $ver) {
 215                     if (file_exists(theme_file('css/ie'.$ver.'.css', 'base'))) {
 216                         // Yes, IE people should be put in jail.
 217                         $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
 218                                        'href="'.theme_path('css/ie'.$ver.'.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
 219                     }
 220                 }
 221                 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
 222                                'href="'.theme_path('css/ie.css', null).'?version='.STATUSNET_VERSION.'" /><![endif]');
 223                 Event::handle('EndShowUAStyles', array($this));
 224             }
 225
 226             if (Event::handle('StartShowDesign', array($this))) {
 227
 228                 $user = common_current_user();
 229
 230                 if (empty($user) || $user->viewdesigns) {
 231                     $design = $this->getDesign();
 232
 233                     if (!empty($design)) {
 234                         $design->showCSS($this);
 235                     }
 236                 }
 237
 238                 Event::handle('EndShowDesign', array($this));
 239             }
 240             Event::handle('EndShowStyles', array($this));
 241         }
 242     }
 243
 244     /**
 245      * Show javascript headers
 246      *
 247      * @return nothing
 248      */
 249     function showScripts()
 250     {
 251         if (Event::handle('StartShowScripts', array($this))) {
 252             if (Event::handle('StartShowJQueryScripts', array($this))) {
 253                 $this->script('js/jquery.min.js');
 254                 $this->script('js/jquery.form.js');
 255                 $this->script('js/jquery.joverlay.min.js');
 256                 Event::handle('EndShowJQueryScripts', array($this));
 257             }
 258             if (Event::handle('StartShowStatusNetScripts', array($this)) &&
 259                 Event::handle('StartShowLaconicaScripts', array($this))) {
 260                 $this->script('js/xbImportNode.js');
 261                 $this->script('js/util.js');
 262                 // Frame-busting code to avoid clickjacking attacks.
 263                 $this->element('script', array('type' => 'text/javascript'),
 264                                'if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
 265                 Event::handle('EndShowStatusNetScripts', array($this));
 266                 Event::handle('EndShowLaconicaScripts', array($this));
 267             }
 268             Event::handle('EndShowScripts', array($this));
 269         }
 270     }
 271
 272     /**
 273      * Show OpenSearch headers
 274      *
 275      * @return nothing
 276      */
 277     function showOpenSearch()
 278     {
 279         $this->element('link', array('rel' => 'search',
 280                                      'type' => 'application/opensearchdescription+xml',
 281                                      'href' =>  common_local_url('opensearch', array('type' => 'people')),
 282                                      'title' => common_config('site', 'name').' People Search'));
 283         $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
 284                                      'href' =>  common_local_url('opensearch', array('type' => 'notice')),
 285                                      'title' => common_config('site', 'name').' Notice Search'));
 286     }
 287
 288     /**
 289      * Show feed headers
 290      *
 291      * MAY overload
 292      *
 293      * @return nothing
 294      */
 295
 296     function showFeeds()
 297     {
 298         $feeds = $this->getFeeds();
 299
 300         if ($feeds) {
 301             foreach ($feeds as $feed) {
 302                 $this->element('link', array('rel' => $feed->rel(),
 303                                              'href' => $feed->url,
 304                                              'type' => $feed->mimeType(),
 305                                              'title' => $feed->title));
 306             }
 307         }
 308     }
 309
 310     /**
 311      * Show description.
 312      *
 313      * SHOULD overload
 314      *
 315      * @return nothing
 316      */
 317     function showDescription()
 318     {
 319         // does nothing by default
 320     }
 321
 322     /**
 323      * Show extra stuff in <head>.
 324      *
 325      * MAY overload
 326      *
 327      * @return nothing
 328      */
 329     function extraHead()
 330     {
 331         // does nothing by default
 332     }
 333
 334     /**
 335      * Show body.
 336      *
 337      * Calls template methods
 338      *
 339      * @return nothing
 340      */
 341     function showBody()
 342     {
 343         $this->elementStart('body', (common_current_user()) ? array('id' => $this->trimmed('action'),
 344                                                                     'class' => 'user_in')
 345                             : array('id' => $this->trimmed('action')));
 346         $this->elementStart('div', array('id' => 'wrap'));
 347         if (Event::handle('StartShowHeader', array($this))) {
 348             $this->showHeader();
 349             Event::handle('EndShowHeader', array($this));
 350         }
 351         $this->showCore();
 352         if (Event::handle('StartShowFooter', array($this))) {
 353             $this->showFooter();
 354             Event::handle('EndShowFooter', array($this));
 355         }
 356         $this->elementEnd('div');
 357         $this->showScripts();
 358         $this->elementEnd('body');
 359     }
 360
 361     /**
 362      * Show header of the page.
 363      *
 364      * Calls template methods
 365      *
 366      * @return nothing
 367      */
 368     function showHeader()
 369     {
 370         $this->elementStart('div', array('id' => 'header'));
 371         $this->showLogo();
 372         $this->showPrimaryNav();
 373         $this->showSiteNotice();
 374         if (common_logged_in()) {
 375             $this->showNoticeForm();
 376         } else {
 377             $this->showAnonymousMessage();
 378         }
 379         $this->elementEnd('div');
 380     }
 381
 382     /**
 383      * Show configured logo.
 384      *
 385      * @return nothing
 386      */
 387     function showLogo()
 388     {
 389         $this->elementStart('address', array('id' => 'site_contact',
 390                                              'class' => 'vcard'));
 391         if (Event::handle('StartAddressData', array($this))) {
 392             $this->elementStart('a', array('class' => 'url home bookmark',
 393                                            'href' => common_local_url('public')));
 394             if (common_config('site', 'logo') || file_exists(theme_file('logo.png'))) {
 395                 $this->element('img', array('class' => 'logo photo',
 396                                             'src' => (common_config('site', 'logo')) ? common_config('site', 'logo') : theme_path('logo.png'),
 397                                             'alt' => common_config('site', 'name')));
 398             }
 399             $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
 400             $this->elementEnd('a');
 401             Event::handle('EndAddressData', array($this));
 402         }
 403         $this->elementEnd('address');
 404     }
 405
 406     /**
 407      * Show primary navigation.
 408      *
 409      * @return nothing
 410      */
 411     function showPrimaryNav()
 412     {
 413         $user = common_current_user();
 414         $connect = '';
 415         if (common_config('xmpp', 'enabled')) {
 416             $connect = 'imsettings';
 417         } else if (common_config('sms', 'enabled')) {
 418             $connect = 'smssettings';
 419         } else if (common_config('twitter', 'enabled')) {
 420             $connect = 'twittersettings';
 421         }
 422
 423         $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
 424         $this->element('dt', null, _('Primary site navigation'));
 425         $this->elementStart('dd');
 426         $this->elementStart('ul', array('class' => 'nav'));
 427         if (Event::handle('StartPrimaryNav', array($this))) {
 428             if ($user) {
 429                 $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
 430                                 _('Home'), _('Personal profile and friends timeline'), false, 'nav_home');
 431                 $this->menuItem(common_local_url('profilesettings'),
 432                                 _('Account'), _('Change your email, avatar, password, profile'), false, 'nav_account');
 433                 if ($connect) {
 434                     $this->menuItem(common_local_url($connect),
 435                                     _('Connect'), _('Connect to services'), false, 'nav_connect');
 436                 }
 437                 if (common_config('invite', 'enabled')) {
 438                     $this->menuItem(common_local_url('invite'),
 439                                     _('Invite'),
 440                                     sprintf(_('Invite friends and colleagues to join you on %s'),
 441                                             common_config('site', 'name')),
 442                                     false, 'nav_invitecontact');
 443                 }
 444                 $this->menuItem(common_local_url('logout'),
 445                                 _('Logout'), _('Logout from the site'), false, 'nav_logout');
 446             }
 447             else {
 448                 if (!common_config('site', '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         if (Event::handle('StartShowAside', array($this))) {
 532             $this->showAside();
 533             Event::handle('EndShowAside', array($this));
 534         }
 535         $this->elementEnd('div');
 536     }
 537
 538     /**
 539      * Show local navigation block.
 540      *
 541      * @return nothing
 542      */
 543     function showLocalNavBlock()
 544     {
 545         $this->elementStart('dl', array('id' => 'site_nav_local_views'));
 546         $this->element('dt', null, _('Local views'));
 547         $this->elementStart('dd');
 548         $this->showLocalNav();
 549         $this->elementEnd('dd');
 550         $this->elementEnd('dl');
 551     }
 552
 553     /**
 554      * Show local navigation.
 555      *
 556      * SHOULD overload
 557      *
 558      * @return nothing
 559      */
 560     function showLocalNav()
 561     {
 562         // does nothing by default
 563     }
 564
 565     /**
 566      * Show content block.
 567      *
 568      * @return nothing
 569      */
 570     function showContentBlock()
 571     {
 572         $this->elementStart('div', array('id' => 'content'));
 573         $this->showPageTitle();
 574         $this->showPageNoticeBlock();
 575         $this->elementStart('div', array('id' => 'content_inner'));
 576         // show the actual content (forms, lists, whatever)
 577         $this->showContent();
 578         $this->elementEnd('div');
 579         $this->elementEnd('div');
 580     }
 581
 582     /**
 583      * Show page title.
 584      *
 585      * @return nothing
 586      */
 587     function showPageTitle()
 588     {
 589         $this->element('h1', null, $this->title());
 590     }
 591
 592     /**
 593      * Show page notice block.
 594      *
 595      * Only show the block if a subclassed action has overrided
 596      * Action::showPageNotice(), or an event handler is registered for
 597      * the StartShowPageNotice event, in which case we assume the
 598      * 'page_notice' definition list is desired.  This is to prevent
 599      * empty 'page_notice' definition lists from being output everywhere.
 600      *
 601      * @return nothing
 602      */
 603     function showPageNoticeBlock()
 604     {
 605         $rmethod = new ReflectionMethod($this, 'showPageNotice');
 606         $dclass = $rmethod->getDeclaringClass()->getName();
 607
 608         if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
 609
 610             $this->elementStart('dl', array('id' => 'page_notice',
 611                                             'class' => 'system_notice'));
 612             $this->element('dt', null, _('Page notice'));
 613             $this->elementStart('dd');
 614             if (Event::handle('StartShowPageNotice', array($this))) {
 615                 $this->showPageNotice();
 616                 Event::handle('EndShowPageNotice', array($this));
 617             }
 618             $this->elementEnd('dd');
 619             $this->elementEnd('dl');
 620         }
 621     }
 622
 623     /**
 624      * Show page notice.
 625      *
 626      * SHOULD overload (unless there's not a notice)
 627      *
 628      * @return nothing
 629      */
 630     function showPageNotice()
 631     {
 632     }
 633
 634     /**
 635      * Show content.
 636      *
 637      * MUST overload (unless there's not a notice)
 638      *
 639      * @return nothing
 640      */
 641     function showContent()
 642     {
 643     }
 644
 645     /**
 646      * Show Aside.
 647      *
 648      * @return nothing
 649      */
 650
 651     function showAside()
 652     {
 653         $this->elementStart('div', array('id' => 'aside_primary',
 654                                          'class' => 'aside'));
 655         if (Event::handle('StartShowExportData', array($this))) {
 656             $this->showExportData();
 657             Event::handle('EndShowExportData', array($this));
 658         }
 659         if (Event::handle('StartShowSections', array($this))) {
 660             $this->showSections();
 661             Event::handle('EndShowSections', array($this));
 662         }
 663         $this->elementEnd('div');
 664     }
 665
 666     /**
 667      * Show export data feeds.
 668      *
 669      * @return void
 670      */
 671
 672     function showExportData()
 673     {
 674         $feeds = $this->getFeeds();
 675         if ($feeds) {
 676             $fl = new FeedList($this);
 677             $fl->show($feeds);
 678         }
 679     }
 680
 681     /**
 682      * Show sections.
 683      *
 684      * SHOULD overload
 685      *
 686      * @return nothing
 687      */
 688     function showSections()
 689     {
 690         // for each section, show it
 691     }
 692
 693     /**
 694      * Show footer.
 695      *
 696      * @return nothing
 697      */
 698     function showFooter()
 699     {
 700         $this->elementStart('div', array('id' => 'footer'));
 701         $this->showSecondaryNav();
 702         $this->showLicenses();
 703         $this->elementEnd('div');
 704     }
 705
 706     /**
 707      * Show secondary navigation.
 708      *
 709      * @return nothing
 710      */
 711     function showSecondaryNav()
 712     {
 713         $this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
 714         $this->element('dt', null, _('Secondary site navigation'));
 715         $this->elementStart('dd', null);
 716         $this->elementStart('ul', array('class' => 'nav'));
 717         if (Event::handle('StartSecondaryNav', array($this))) {
 718             $this->menuItem(common_local_url('doc', array('title' => 'help')),
 719                             _('Help'));
 720             $this->menuItem(common_local_url('doc', array('title' => 'about')),
 721                             _('About'));
 722             $this->menuItem(common_local_url('doc', array('title' => 'faq')),
 723                             _('FAQ'));
 724             $bb = common_config('site', 'broughtby');
 725             if (!empty($bb)) {
 726                 $this->menuItem(common_local_url('doc', array('title' => 'tos')),
 727                                 _('TOS'));
 728             }
 729             $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
 730                             _('Privacy'));
 731             $this->menuItem(common_local_url('doc', array('title' => 'source')),
 732                             _('Source'));
 733             $this->menuItem(common_local_url('doc', array('title' => 'contact')),
 734                             _('Contact'));
 735             $this->menuItem(common_local_url('doc', array('title' => 'badge')),
 736                             _('Badge'));
 737             Event::handle('EndSecondaryNav', array($this));
 738         }
 739         $this->elementEnd('ul');
 740         $this->elementEnd('dd');
 741         $this->elementEnd('dl');
 742     }
 743
 744     /**
 745      * Show licenses.
 746      *
 747      * @return nothing
 748      */
 749     function showLicenses()
 750     {
 751         $this->elementStart('dl', array('id' => 'licenses'));
 752         $this->showStatusNetLicense();
 753         $this->showContentLicense();
 754         $this->elementEnd('dl');
 755     }
 756
 757     /**
 758      * Show StatusNet license.
 759      *
 760      * @return nothing
 761      */
 762     function showStatusNetLicense()
 763     {
 764         $this->element('dt', array('id' => 'site_statusnet_license'), _('StatusNet software license'));
 765         $this->elementStart('dd', null);
 766         if (common_config('site', 'broughtby')) {
 767             $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
 768         } else {
 769             $instr = _('**%%site.name%%** is a microblogging service. ');
 770         }
 771         $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);
 772         $output = common_markup_to_html($instr);
 773         $this->raw($output);
 774         $this->elementEnd('dd');
 775         // do it
 776     }
 777
 778     /**
 779      * Show content license.
 780      *
 781      * @return nothing
 782      */
 783     function showContentLicense()
 784     {
 785         $this->element('dt', array('id' => 'site_content_license'), _('Site content license'));
 786         $this->elementStart('dd', array('id' => 'site_content_license_cc'));
 787         $this->elementStart('p');
 788         $this->element('img', array('id' => 'license_cc',
 789                                     'src' => common_config('license', 'image'),
 790                                     'alt' => common_config('license', 'title'),
 791                                     'width' => '80',
 792                                     'height' => '15'));
 793         //TODO: This is dirty: i18n
 794         $this->text(_('All '.common_config('site', 'name').' content and data are available under the '));
 795         $this->element('a', array('class' => 'license',
 796                                   'rel' => 'external license',
 797                                   'href' => common_config('license', 'url')),
 798                        common_config('license', 'title'));
 799         $this->text(_('license.'));
 800         $this->elementEnd('p');
 801         $this->elementEnd('dd');
 802     }
 803
 804     /**
 805      * Return last modified, if applicable.
 806      *
 807      * MAY override
 808      *
 809      * @return string last modified http header
 810      */
 811     function lastModified()
 812     {
 813         // For comparison with If-Last-Modified
 814         // If not applicable, return null
 815         return null;
 816     }
 817
 818     /**
 819      * Return etag, if applicable.
 820      *
 821      * MAY override
 822      *
 823      * @return string etag http header
 824      */
 825     function etag()
 826     {
 827         return null;
 828     }
 829
 830     /**
 831      * Return true if read only.
 832      *
 833      * MAY override
 834      *
 835      * @param array $args other arguments
 836      *
 837      * @return boolean is read only action?
 838      */
 839
 840     function isReadOnly($args)
 841     {
 842         return false;
 843     }
 844
 845     /**
 846      * Returns query argument or default value if not found
 847      *
 848      * @param string $key requested argument
 849      * @param string $def default value to return if $key is not provided
 850      *
 851      * @return boolean is read only action?
 852      */
 853     function arg($key, $def=null)
 854     {
 855         if (array_key_exists($key, $this->args)) {
 856             return $this->args[$key];
 857         } else {
 858             return $def;
 859         }
 860     }
 861
 862     /**
 863      * Returns trimmed query argument or default value if not found
 864      *
 865      * @param string $key requested argument
 866      * @param string $def default value to return if $key is not provided
 867      *
 868      * @return boolean is read only action?
 869      */
 870     function trimmed($key, $def=null)
 871     {
 872         $arg = $this->arg($key, $def);
 873         return is_string($arg) ? trim($arg) : $arg;
 874     }
 875
 876     /**
 877      * Handler method
 878      *
 879      * @param array $argarray is ignored since it's now passed in in prepare()
 880      *
 881      * @return boolean is read only action?
 882      */
 883     function handle($argarray=null)
 884     {
 885         header('Vary: Accept-Encoding,Cookie');
 886         $lm   = $this->lastModified();
 887         $etag = $this->etag();
 888         if ($etag) {
 889             header('ETag: ' . $etag);
 890         }
 891         if ($lm) {
 892             header('Last-Modified: ' . date(DATE_RFC1123, $lm));
 893             if (array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
 894                 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
 895                 $ims = strtotime($if_modified_since);
 896                 if ($lm <= $ims) {
 897                     $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
 898                       $_SERVER['HTTP_IF_NONE_MATCH'] : null;
 899                     if (!$if_none_match ||
 900                         !$etag ||
 901                         $this->_hasEtag($etag, $if_none_match)) {
 902                         header('HTTP/1.1 304 Not Modified');
 903                         // Better way to do this?
 904                         exit(0);
 905                     }
 906                 }
 907             }
 908         }
 909     }
 910
 911     /**
 912      * Has etag? (private)
 913      *
 914      * @param string $etag          etag http header
 915      * @param string $if_none_match ifNoneMatch http header
 916      *
 917      * @return boolean
 918      */
 919
 920     function _hasEtag($etag, $if_none_match)
 921     {
 922         $etags = explode(',', $if_none_match);
 923         return in_array($etag, $etags) || in_array('*', $etags);
 924     }
 925
 926     /**
 927      * Boolean understands english (yes, no, true, false)
 928      *
 929      * @param string $key query key we're interested in
 930      * @param string $def default value
 931      *
 932      * @return boolean interprets yes/no strings as boolean
 933      */
 934     function boolean($key, $def=false)
 935     {
 936         $arg = strtolower($this->trimmed($key));
 937
 938         if (is_null($arg)) {
 939             return $def;
 940         } else if (in_array($arg, array('true', 'yes', '1'))) {
 941             return true;
 942         } else if (in_array($arg, array('false', 'no', '0'))) {
 943             return false;
 944         } else {
 945             return $def;
 946         }
 947     }
 948
 949     /**
 950      * Server error
 951      *
 952      * @param string  $msg  error message to display
 953      * @param integer $code http error code, 500 by default
 954      *
 955      * @return nothing
 956      */
 957
 958     function serverError($msg, $code=500)
 959     {
 960         $action = $this->trimmed('action');
 961         common_debug("Server error '$code' on '$action': $msg", __FILE__);
 962         throw new ServerException($msg, $code);
 963     }
 964
 965     /**
 966      * Client error
 967      *
 968      * @param string  $msg  error message to display
 969      * @param integer $code http error code, 400 by default
 970      *
 971      * @return nothing
 972      */
 973
 974     function clientError($msg, $code=400)
 975     {
 976         $action = $this->trimmed('action');
 977         common_debug("User error '$code' on '$action': $msg", __FILE__);
 978         throw new ClientException($msg, $code);
 979     }
 980
 981     /**
 982      * Returns the current URL
 983      *
 984      * @return string current URL
 985      */
 986
 987     function selfUrl()
 988     {
 989         $action = $this->trimmed('action');
 990         $args   = $this->args;
 991         unset($args['action']);
 992         if (common_config('site', 'fancy')) {
 993             unset($args['p']);
 994         }
 995         if (array_key_exists('submit', $args)) {
 996             unset($args['submit']);
 997         }
 998         foreach (array_keys($_COOKIE) as $cookie) {
 999             unset($args[$cookie]);
1000         }
1001
1002         return common_local_url($action, $args);
1003     }
1004
1005     /**
1006      * Generate a menu item
1007      *
1008      * @param string  $url         menu URL
1009      * @param string  $text        menu name
1010      * @param string  $title       title attribute, null by default
1011      * @param boolean $is_selected current menu item, false by default
1012      * @param string  $id          element id, null by default
1013      *
1014      * @return nothing
1015      */
1016     function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1017     {
1018         // Added @id to li for some control.
1019         // XXX: We might want to move this to htmloutputter.php
1020         $lattrs = array();
1021         if ($is_selected) {
1022             $lattrs['class'] = 'current';
1023         }
1024
1025         (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1026
1027         $this->elementStart('li', $lattrs);
1028         $attrs['href'] = $url;
1029         if ($title) {
1030             $attrs['title'] = $title;
1031         }
1032         $this->element('a', $attrs, $text);
1033         $this->elementEnd('li');
1034     }
1035
1036     /**
1037      * Generate pagination links
1038      *
1039      * @param boolean $have_before is there something before?
1040      * @param boolean $have_after  is there something after?
1041      * @param integer $page        current page
1042      * @param string  $action      current action
1043      * @param array   $args        rest of query arguments
1044      *
1045      * @return nothing
1046      */
1047     function pagination($have_before, $have_after, $page, $action, $args=null)
1048     {
1049         // Does a little before-after block for next/prev page
1050         if ($have_before || $have_after) {
1051             $this->elementStart('div', array('class' => 'pagination'));
1052             $this->elementStart('dl', null);
1053             $this->element('dt', null, _('Pagination'));
1054             $this->elementStart('dd', null);
1055             $this->elementStart('ul', array('class' => 'nav'));
1056         }
1057         if ($have_before) {
1058             $pargs   = array('page' => $page-1);
1059             $this->elementStart('li', array('class' => 'nav_prev'));
1060             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1061                                       'rel' => 'prev'),
1062                            _('After'));
1063             $this->elementEnd('li');
1064         }
1065         if ($have_after) {
1066             $pargs   = array('page' => $page+1);
1067             $this->elementStart('li', array('class' => 'nav_next'));
1068             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1069                                       'rel' => 'next'),
1070                            _('Before'));
1071             $this->elementEnd('li');
1072         }
1073         if ($have_before || $have_after) {
1074             $this->elementEnd('ul');
1075             $this->elementEnd('dd');
1076             $this->elementEnd('dl');
1077             $this->elementEnd('div');
1078         }
1079     }
1080
1081     /**
1082      * An array of feeds for this action.
1083      *
1084      * Returns an array of potential feeds for this action.
1085      *
1086      * @return array Feed object to show in head and links
1087      */
1088
1089     function getFeeds()
1090     {
1091         return null;
1092     }
1093
1094     /**
1095      * A design for this action
1096      *
1097      * @return Design a design object to use
1098      */
1099
1100     function getDesign()
1101     {
1102         return Design::siteDesign();
1103     }
1104
1105     /**
1106      * Check the session token.
1107      *
1108      * Checks that the current form has the correct session token,
1109      * and throw an exception if it does not.
1110      *
1111      * @return void
1112      */
1113
1114     function checkSessionToken()
1115     {
1116         // CSRF protection
1117         $token = $this->trimmed('token');
1118         if (empty($token) || $token != common_session_token()) {
1119             $this->clientError(_('There was a problem with your session token.'));
1120         }
1121     }
1122 }