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