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