lib/action.php

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