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