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