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