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->script('json2.js');
 253                 $this->script('jquery.joverlay.min.js');
 254                 Event::handle('EndShowJQueryScripts', array($this));
 255             }
 256             if (Event::handle('StartShowStatusNetScripts', array($this)) &&
 257                 Event::handle('StartShowLaconicaScripts', array($this))) {
 258                 $this->script('xbImportNode.js');
 259                 $this->script('util.js');
 260                 $this->script('geometa.js');
 261                 // Frame-busting code to avoid clickjacking attacks.
 262                 $this->element('script', array('type' => 'text/javascript'),
 263                                'if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
 264                 Event::handle('EndShowStatusNetScripts', array($this));
 265                 Event::handle('EndShowLaconicaScripts', array($this));
 266             }
 267             Event::handle('EndShowScripts', array($this));
 268         }
 269     }
 270
 271     /**
 272      * Show OpenSearch headers
 273      *
 274      * @return nothing
 275      */
 276     function showOpenSearch()
 277     {
 278         $this->element('link', array('rel' => 'search',
 279                                      'type' => 'application/opensearchdescription+xml',
 280                                      'href' =>  common_local_url('opensearch', array('type' => 'people')),
 281                                      'title' => common_config('site', 'name').' People Search'));
 282         $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
 283                                      'href' =>  common_local_url('opensearch', array('type' => 'notice')),
 284                                      'title' => common_config('site', 'name').' Notice Search'));
 285     }
 286
 287     /**
 288      * Show feed headers
 289      *
 290      * MAY overload
 291      *
 292      * @return nothing
 293      */
 294
 295     function showFeeds()
 296     {
 297         $feeds = $this->getFeeds();
 298
 299         if ($feeds) {
 300             foreach ($feeds as $feed) {
 301                 $this->element('link', array('rel' => $feed->rel(),
 302                                              'href' => $feed->url,
 303                                              'type' => $feed->mimeType(),
 304                                              'title' => $feed->title));
 305             }
 306         }
 307     }
 308
 309     /**
 310      * Show description.
 311      *
 312      * SHOULD overload
 313      *
 314      * @return nothing
 315      */
 316     function showDescription()
 317     {
 318         // does nothing by default
 319     }
 320
 321     /**
 322      * Show extra stuff in <head>.
 323      *
 324      * MAY overload
 325      *
 326      * @return nothing
 327      */
 328     function extraHead()
 329     {
 330         // does nothing by default
 331     }
 332
 333     /**
 334      * Show body.
 335      *
 336      * Calls template methods
 337      *
 338      * @return nothing
 339      */
 340     function showBody()
 341     {
 342         $this->elementStart('body', (common_current_user()) ? array('id' => $this->trimmed('action'),
 343                                                                     'class' => 'user_in')
 344                             : array('id' => $this->trimmed('action')));
 345         $this->elementStart('div', array('id' => 'wrap'));
 346         if (Event::handle('StartShowHeader', array($this))) {
 347             $this->showHeader();
 348             Event::handle('EndShowHeader', array($this));
 349         }
 350         $this->showCore();
 351         if (Event::handle('StartShowFooter', array($this))) {
 352             $this->showFooter();
 353             Event::handle('EndShowFooter', array($this));
 354         }
 355         $this->elementEnd('div');
 356         $this->showScripts();
 357         $this->elementEnd('body');
 358     }
 359
 360     /**
 361      * Show header of the page.
 362      *
 363      * Calls template methods
 364      *
 365      * @return nothing
 366      */
 367     function showHeader()
 368     {
 369         $this->elementStart('div', array('id' => 'header'));
 370         $this->showLogo();
 371         $this->showPrimaryNav();
 372         if (Event::handle('StartShowSiteNotice', array($this))) {
 373             $this->showSiteNotice();
 374
 375             Event::handle('EndShowSiteNotice', array($this));
 376         }
 377         if (common_logged_in()) {
 378             $this->showNoticeForm();
 379         } else {
 380             $this->showAnonymousMessage();
 381         }
 382         $this->elementEnd('div');
 383     }
 384
 385     /**
 386      * Show configured logo.
 387      *
 388      * @return nothing
 389      */
 390     function showLogo()
 391     {
 392         $this->elementStart('address', array('id' => 'site_contact',
 393                                              'class' => 'vcard'));
 394         if (Event::handle('StartAddressData', array($this))) {
 395             if (common_config('singleuser', 'enabled')) {
 396                 $url = common_local_url('showstream',
 397                                         array('nickname' => common_config('singleuser', 'nickname')));
 398             } else {
 399                 $url = common_local_url('public');
 400             }
 401             $this->elementStart('a', array('class' => 'url home bookmark',
 402                                            'href' => $url));
 403             if (common_config('site', 'logo') || file_exists(Theme::file('logo.png'))) {
 404                 $this->element('img', array('class' => 'logo photo',
 405                                             'src' => (common_config('site', 'logo')) ? common_config('site', 'logo') : Theme::path('logo.png'),
 406                                             'alt' => common_config('site', 'name')));
 407             }
 408             $this->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                 //TODO: This is dirty: i18n
 826                 $this->text(_('All '.common_config('site', 'name').' content and data are available under the '));
 827                 $this->element('a', array('class' => 'license',
 828                                           'rel' => 'external license',
 829                                           'href' => common_config('license', 'url')),
 830                                common_config('license', 'title'));
 831                 $this->text(_('license.'));
 832                 $this->elementEnd('p');
 833                 break;
 834             }
 835
 836             $this->elementEnd('dd');
 837             Event::handle('EndShowContentLicense', array($this));
 838         }
 839     }
 840
 841     /**
 842      * Return last modified, if applicable.
 843      *
 844      * MAY override
 845      *
 846      * @return string last modified http header
 847      */
 848     function lastModified()
 849     {
 850         // For comparison with If-Last-Modified
 851         // If not applicable, return null
 852         return null;
 853     }
 854
 855     /**
 856      * Return etag, if applicable.
 857      *
 858      * MAY override
 859      *
 860      * @return string etag http header
 861      */
 862     function etag()
 863     {
 864         return null;
 865     }
 866
 867     /**
 868      * Return true if read only.
 869      *
 870      * MAY override
 871      *
 872      * @param array $args other arguments
 873      *
 874      * @return boolean is read only action?
 875      */
 876
 877     function isReadOnly($args)
 878     {
 879         return false;
 880     }
 881
 882     /**
 883      * Returns query argument or default value if not found
 884      *
 885      * @param string $key requested argument
 886      * @param string $def default value to return if $key is not provided
 887      *
 888      * @return boolean is read only action?
 889      */
 890     function arg($key, $def=null)
 891     {
 892         if (array_key_exists($key, $this->args)) {
 893             return $this->args[$key];
 894         } else {
 895             return $def;
 896         }
 897     }
 898
 899     /**
 900      * Returns trimmed query argument or default value if not found
 901      *
 902      * @param string $key requested argument
 903      * @param string $def default value to return if $key is not provided
 904      *
 905      * @return boolean is read only action?
 906      */
 907     function trimmed($key, $def=null)
 908     {
 909         $arg = $this->arg($key, $def);
 910         return is_string($arg) ? trim($arg) : $arg;
 911     }
 912
 913     /**
 914      * Handler method
 915      *
 916      * @param array $argarray is ignored since it's now passed in in prepare()
 917      *
 918      * @return boolean is read only action?
 919      */
 920     function handle($argarray=null)
 921     {
 922         header('Vary: Accept-Encoding,Cookie');
 923         $lm   = $this->lastModified();
 924         $etag = $this->etag();
 925         if ($etag) {
 926             header('ETag: ' . $etag);
 927         }
 928         if ($lm) {
 929             header('Last-Modified: ' . date(DATE_RFC1123, $lm));
 930             if (array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
 931                 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
 932                 $ims = strtotime($if_modified_since);
 933                 if ($lm <= $ims) {
 934                     $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
 935                       $_SERVER['HTTP_IF_NONE_MATCH'] : null;
 936                     if (!$if_none_match ||
 937                         !$etag ||
 938                         $this->_hasEtag($etag, $if_none_match)) {
 939                         header('HTTP/1.1 304 Not Modified');
 940                         // Better way to do this?
 941                         exit(0);
 942                     }
 943                 }
 944             }
 945         }
 946     }
 947
 948     /**
 949      * Has etag? (private)
 950      *
 951      * @param string $etag          etag http header
 952      * @param string $if_none_match ifNoneMatch http header
 953      *
 954      * @return boolean
 955      */
 956
 957     function _hasEtag($etag, $if_none_match)
 958     {
 959         $etags = explode(',', $if_none_match);
 960         return in_array($etag, $etags) || in_array('*', $etags);
 961     }
 962
 963     /**
 964      * Boolean understands english (yes, no, true, false)
 965      *
 966      * @param string $key query key we're interested in
 967      * @param string $def default value
 968      *
 969      * @return boolean interprets yes/no strings as boolean
 970      */
 971     function boolean($key, $def=false)
 972     {
 973         $arg = strtolower($this->trimmed($key));
 974
 975         if (is_null($arg)) {
 976             return $def;
 977         } else if (in_array($arg, array('true', 'yes', '1'))) {
 978             return true;
 979         } else if (in_array($arg, array('false', 'no', '0'))) {
 980             return false;
 981         } else {
 982             return $def;
 983         }
 984     }
 985
 986     /**
 987      * Integer value of an argument
 988      *
 989      * @param string $key      query key we're interested in
 990      * @param string $defValue optional default value (default null)
 991      * @param string $maxValue optional max value (default null)
 992      * @param string $minValue optional min value (default null)
 993      *
 994      * @return integer integer value
 995      */
 996
 997     function int($key, $defValue=null, $maxValue=null, $minValue=null)
 998     {
 999         $arg = strtolower($this->trimmed($key));
1000
1001         if (is_null($arg) || !is_integer($arg)) {
1002             return $defValue;
1003         }
1004
1005         if (!is_null($maxValue)) {
1006             $arg = min($arg, $maxValue);
1007         }
1008
1009         if (!is_null($minValue)) {
1010             $arg = max($arg, $minValue);
1011         }
1012
1013         return $arg;
1014     }
1015
1016     /**
1017      * Server error
1018      *
1019      * @param string  $msg  error message to display
1020      * @param integer $code http error code, 500 by default
1021      *
1022      * @return nothing
1023      */
1024
1025     function serverError($msg, $code=500)
1026     {
1027         $action = $this->trimmed('action');
1028         common_debug("Server error '$code' on '$action': $msg", __FILE__);
1029         throw new ServerException($msg, $code);
1030     }
1031
1032     /**
1033      * Client error
1034      *
1035      * @param string  $msg  error message to display
1036      * @param integer $code http error code, 400 by default
1037      *
1038      * @return nothing
1039      */
1040
1041     function clientError($msg, $code=400)
1042     {
1043         $action = $this->trimmed('action');
1044         common_debug("User error '$code' on '$action': $msg", __FILE__);
1045         throw new ClientException($msg, $code);
1046     }
1047
1048     /**
1049      * Returns the current URL
1050      *
1051      * @return string current URL
1052      */
1053
1054     function selfUrl()
1055     {
1056         list($action, $args) = $this->returnToArgs();
1057         return common_local_url($action, $args);
1058     }
1059
1060     /**
1061      * Returns arguments sufficient for re-constructing URL
1062      *
1063      * @return array two elements: action, other args
1064      */
1065
1066     function returnToArgs()
1067     {
1068         $action = $this->trimmed('action');
1069         $args   = $this->args;
1070         unset($args['action']);
1071         if (common_config('site', 'fancy')) {
1072             unset($args['p']);
1073         }
1074         if (array_key_exists('submit', $args)) {
1075             unset($args['submit']);
1076         }
1077         foreach (array_keys($_COOKIE) as $cookie) {
1078             unset($args[$cookie]);
1079         }
1080         return array($action, $args);
1081     }
1082
1083     /**
1084      * Generate a menu item
1085      *
1086      * @param string  $url         menu URL
1087      * @param string  $text        menu name
1088      * @param string  $title       title attribute, null by default
1089      * @param boolean $is_selected current menu item, false by default
1090      * @param string  $id          element id, null by default
1091      *
1092      * @return nothing
1093      */
1094     function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1095     {
1096         // Added @id to li for some control.
1097         // XXX: We might want to move this to htmloutputter.php
1098         $lattrs = array();
1099         if ($is_selected) {
1100             $lattrs['class'] = 'current';
1101         }
1102
1103         (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1104
1105         $this->elementStart('li', $lattrs);
1106         $attrs['href'] = $url;
1107         if ($title) {
1108             $attrs['title'] = $title;
1109         }
1110         $this->element('a', $attrs, $text);
1111         $this->elementEnd('li');
1112     }
1113
1114     /**
1115      * Generate pagination links
1116      *
1117      * @param boolean $have_before is there something before?
1118      * @param boolean $have_after  is there something after?
1119      * @param integer $page        current page
1120      * @param string  $action      current action
1121      * @param array   $args        rest of query arguments
1122      *
1123      * @return nothing
1124      */
1125     function pagination($have_before, $have_after, $page, $action, $args=null)
1126     {
1127         // Does a little before-after block for next/prev page
1128         if ($have_before || $have_after) {
1129             $this->elementStart('dl', 'pagination');
1130             $this->element('dt', null, _('Pagination'));
1131             $this->elementStart('dd', null);
1132             $this->elementStart('ul', array('class' => 'nav'));
1133         }
1134         if ($have_before) {
1135             $pargs   = array('page' => $page-1);
1136             $this->elementStart('li', array('class' => 'nav_prev'));
1137             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1138                                       'rel' => 'prev'),
1139                            _('After'));
1140             $this->elementEnd('li');
1141         }
1142         if ($have_after) {
1143             $pargs   = array('page' => $page+1);
1144             $this->elementStart('li', array('class' => 'nav_next'));
1145             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1146                                       'rel' => 'next'),
1147                            _('Before'));
1148             $this->elementEnd('li');
1149         }
1150         if ($have_before || $have_after) {
1151             $this->elementEnd('ul');
1152             $this->elementEnd('dd');
1153             $this->elementEnd('dl');
1154         }
1155     }
1156
1157     /**
1158      * An array of feeds for this action.
1159      *
1160      * Returns an array of potential feeds for this action.
1161      *
1162      * @return array Feed object to show in head and links
1163      */
1164
1165     function getFeeds()
1166     {
1167         return null;
1168     }
1169
1170     /**
1171      * A design for this action
1172      *
1173      * @return Design a design object to use
1174      */
1175
1176     function getDesign()
1177     {
1178         return Design::siteDesign();
1179     }
1180
1181     /**
1182      * Check the session token.
1183      *
1184      * Checks that the current form has the correct session token,
1185      * and throw an exception if it does not.
1186      *
1187      * @return void
1188      */
1189
1190     function checkSessionToken()
1191     {
1192         // CSRF protection
1193         $token = $this->trimmed('token');
1194         if (empty($token) || $token != common_session_token()) {
1195             $this->clientError(_('There was a problem with your session token.'));
1196         }
1197     }
1198 }