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