lib/action.php

   1 <?php
   2 /**
   3  * Laconica, 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   Laconica
  24  * @author    Evan Prodromou <evan@controlyourself.ca>
  25  * @author    Sarven Capadisli <csarven@controlyourself.ca>
  26  * @copyright 2008 Control Yourself, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://laconi.ca/
  29  */
  30
  31 if (!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  Laconica
  49  * @author   Evan Prodromou <evan@controlyourself.ca>
  50  * @author   Sarven Capadisli <csarven@controlyourself.ca>
  51  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  52  * @link     http://laconi.ca/
  53  *
  54  * @see      HTMLOutputter
  55  */
  56 class Action extends HTMLOutputter // lawsuit
  57 {
  58     var $args;
  59
  60     /**
  61      * Constructor
  62      *
  63      * Just wraps the HTMLOutputter constructor.
  64      *
  65      * @param string  $output URI to output to, default = stdout
  66      * @param boolean $indent Whether to indent output, default true
  67      *
  68      * @see XMLOutputter::__construct
  69      * @see HTMLOutputter::__construct
  70      */
  71     function __construct($output='php://output', $indent=true)
  72     {
  73         parent::__construct($output, $indent);
  74     }
  75
  76     /**
  77      * For initializing members of the class.
  78      *
  79      * @param array $argarray misc. arguments
  80      *
  81      * @return boolean true
  82      */
  83     function prepare($argarray)
  84     {
  85         $this->args =& common_copy_args($argarray);
  86         return true;
  87     }
  88
  89     /**
  90      * Show page, a template method.
  91      *
  92      * @return nothing
  93      */
  94     function showPage()
  95     {
  96         $this->startHTML();
  97         $this->showHead();
  98         $this->showBody();
  99         $this->endHTML();
 100     }
 101
 102     /**
 103      * Show head, a template method.
 104      *
 105      * @return nothing
 106      */
 107     function showHead()
 108     {
 109         // XXX: attributes (profile?)
 110         $this->elementStart('head');
 111         $this->showTitle();
 112         $this->showStylesheets();
 113         $this->showScripts();
 114         $this->showOpenSearch();
 115         $this->showFeeds();
 116         $this->showDescription();
 117         $this->extraHead();
 118         $this->elementEnd('head');
 119     }
 120
 121     /**
 122      * Show title, a template method.
 123      *
 124      * @return nothing
 125      */
 126     function showTitle()
 127     {
 128         $this->element('title', null,
 129                        sprintf(_("%s - %s"),
 130                                $this->title(),
 131                                common_config('site', 'name')));
 132     }
 133
 134     /**
 135      * Returns the page title
 136      *
 137      * SHOULD overload
 138      *
 139      * @return string page title
 140      */
 141
 142     function title()
 143     {
 144         return _("Untitled page");
 145     }
 146
 147     /**
 148      * Show stylesheets
 149      *
 150      * @return nothing
 151      */
 152     function showStylesheets()
 153     {
 154         if (Event::handle('StartShowStyles', array($this))) {
 155             if (Event::handle('StartShowLaconicaStyles', array($this))) {
 156
 157                 $this->element('link', array('rel' => 'stylesheet',
 158                                              'type' => 'text/css',
 159                                              'href' => theme_path('css/display.css', 'base') . '?version=' . LACONICA_VERSION,
 160                                              'media' => 'screen, projection, tv'));
 161                 $this->element('link', array('rel' => 'stylesheet',
 162                                              'type' => 'text/css',
 163                                              'href' => theme_path('css/modal.css', 'base') . '?version=' . LACONICA_VERSION,
 164                                              'media' => 'screen, projection, tv'));
 165                 $this->element('link', array('rel' => 'stylesheet',
 166                                              'type' => 'text/css',
 167                                              'href' => theme_path('css/display.css', null) . '?version=' . LACONICA_VERSION,
 168                                              'media' => 'screen, projection, tv'));
 169                 if (common_config('site', 'mobile')) {
 170                     $this->element('link', array('rel' => 'stylesheet',
 171                                                  'type' => 'text/css',
 172                                                  'href' => theme_path('css/mobile.css', 'base') . '?version=' . LACONICA_VERSION,
 173                                                  // TODO: "handheld" CSS for other mobile devices
 174                                                  'media' => 'only screen and (max-device-width: 480px)')); // Mobile WebKit
 175                 }
 176                 Event::handle('EndShowLaconicaStyles', array($this));
 177             }
 178             if (Event::handle('StartShowUAStyles', array($this))) {
 179                 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
 180                                'href="'.theme_path('css/ie.css', 'base').'?version='.LACONICA_VERSION.'" /><![endif]');
 181                 foreach (array(6,7) as $ver) {
 182                     if (file_exists(theme_file('css/ie'.$ver.'.css', 'base'))) {
 183                         // Yes, IE people should be put in jail.
 184                         $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
 185                                        'href="'.theme_path('css/ie'.$ver.'.css', 'base').'?version='.LACONICA_VERSION.'" /><![endif]');
 186                     }
 187                 }
 188                 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
 189                                'href="'.theme_path('css/ie.css', null).'?version='.LACONICA_VERSION.'" /><![endif]');
 190                 Event::handle('EndShowUAStyles', array($this));
 191             }
 192             Event::handle('EndShowStyles', array($this));
 193         }
 194     }
 195
 196     /**
 197      * Show javascript headers
 198      *
 199      * @return nothing
 200      */
 201     function showScripts()
 202     {
 203         if (Event::handle('StartShowScripts', array($this))) {
 204             if (Event::handle('StartShowJQueryScripts', array($this))) {
 205                 $this->element('script', array('type' => 'text/javascript',
 206                                                'src' => common_path('js/jquery.min.js')),
 207                                ' ');
 208                 $this->element('script', array('type' => 'text/javascript',
 209                                                'src' => common_path('js/jquery.form.js')),
 210                                ' ');
 211
 212                 $this->element('script', array('type' => 'text/javascript',
 213                                                'src' => common_path('js/jquery.simplemodal-1.2.2.pack.js')),
 214                                ' ');
 215
 216                 Event::handle('EndShowJQueryScripts', array($this));
 217             }
 218             if (Event::handle('StartShowLaconicaScripts', array($this))) {
 219                 $this->element('script', array('type' => 'text/javascript',
 220                                                'src' => common_path('js/xbImportNode.js')),
 221                                ' ');
 222                 $this->element('script', array('type' => 'text/javascript',
 223                                                'src' => common_path('js/util.js?version='.LACONICA_VERSION)),
 224                                ' ');
 225                 // Frame-busting code to avoid clickjacking attacks.
 226                 $this->element('script', array('type' => 'text/javascript'),
 227                                'if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
 228
 229                 $this->element('script', array('type' => 'text/javascript',
 230                                                'src' => common_path('js/flowplayer-3.0.5.min.js')),
 231                                ' ');
 232
 233                 $this->element('script', array('type' => 'text/javascript',
 234                                                'src' => common_path('js/video.js')),
 235                                ' ');
 236                 Event::handle('EndShowLaconicaScripts', array($this));
 237             }
 238             Event::handle('EndShowScripts', array($this));
 239         }
 240     }
 241
 242     /**
 243      * Show OpenSearch headers
 244      *
 245      * @return nothing
 246      */
 247     function showOpenSearch()
 248     {
 249         $this->element('link', array('rel' => 'search',
 250                                      'type' => 'application/opensearchdescription+xml',
 251                                      'href' =>  common_local_url('opensearch', array('type' => 'people')),
 252                                      'title' => common_config('site', 'name').' People Search'));
 253         $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
 254                                      'href' =>  common_local_url('opensearch', array('type' => 'notice')),
 255                                      'title' => common_config('site', 'name').' Notice Search'));
 256     }
 257
 258     /**
 259      * Show feed headers
 260      *
 261      * MAY overload
 262      *
 263      * @return nothing
 264      */
 265
 266     function showFeeds()
 267     {
 268         $feeds = $this->getFeeds();
 269
 270         if ($feeds) {
 271             foreach ($feeds as $feed) {
 272                 $this->element('link', array('rel' => $feed->rel(),
 273                                              'href' => $feed->url,
 274                                              'type' => $feed->mimeType(),
 275                                              'title' => $feed->title));
 276             }
 277         }
 278     }
 279
 280     /**
 281      * Show description.
 282      *
 283      * SHOULD overload
 284      *
 285      * @return nothing
 286      */
 287     function showDescription()
 288     {
 289         // does nothing by default
 290     }
 291
 292     /**
 293      * Show extra stuff in <head>.
 294      *
 295      * MAY overload
 296      *
 297      * @return nothing
 298      */
 299     function extraHead()
 300     {
 301         // does nothing by default
 302     }
 303
 304     /**
 305      * Show body.
 306      *
 307      * Calls template methods
 308      *
 309      * @return nothing
 310      */
 311     function showBody()
 312     {
 313         $this->elementStart('body', array('id' => $this->trimmed('action')));
 314         $this->elementStart('div', array('id' => 'wrap'));
 315         if (Event::handle('StartShowHeader', array($this))) {
 316             $this->showHeader();
 317             Event::handle('EndShowHeader', array($this));
 318         }
 319         $this->showCore();
 320         if (Event::handle('StartShowFooter', array($this))) {
 321             $this->showFooter();
 322             Event::handle('EndShowFooter', array($this));
 323         }
 324         $this->elementEnd('div');
 325         $this->elementEnd('body');
 326     }
 327
 328     /**
 329      * Show header of the page.
 330      *
 331      * Calls template methods
 332      *
 333      * @return nothing
 334      */
 335     function showHeader()
 336     {
 337         $this->elementStart('div', array('id' => 'header'));
 338         $this->showLogo();
 339         $this->showPrimaryNav();
 340         $this->showSiteNotice();
 341         if (common_logged_in()) {
 342             $this->showNoticeForm();
 343         } else {
 344             $this->showAnonymousMessage();
 345         }
 346         $this->elementEnd('div');
 347     }
 348
 349     /**
 350      * Show configured logo.
 351      *
 352      * @return nothing
 353      */
 354     function showLogo()
 355     {
 356         $this->elementStart('address', array('id' => 'site_contact',
 357                                              'class' => 'vcard'));
 358         $this->elementStart('a', array('class' => 'url home bookmark',
 359                                        'href' => common_local_url('public')));
 360         if (common_config('site', 'logo') || file_exists(theme_file('logo.png'))) {
 361             $this->element('img', array('class' => 'logo photo',
 362                                         'src' => (common_config('site', 'logo')) ? common_config('site', 'logo') : theme_path('logo.png'),
 363                                         'alt' => common_config('site', 'name')));
 364         }
 365         $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
 366         $this->elementEnd('a');
 367         $this->elementEnd('address');
 368     }
 369
 370     /**
 371      * Show primary navigation.
 372      *
 373      * @return nothing
 374      */
 375     function showPrimaryNav()
 376     {
 377         $user = common_current_user();
 378
 379         $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
 380         $this->element('dt', null, _('Primary site navigation'));
 381         $this->elementStart('dd');
 382         $this->elementStart('ul', array('class' => 'nav'));
 383         if (Event::handle('StartPrimaryNav', array($this))) {
 384             if ($user) {
 385                 $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
 386                                 _('Home'), _('Personal profile and friends timeline'), false, 'nav_home');
 387             }
 388             $this->menuItem(common_local_url('peoplesearch'),
 389                             _('Search'), _('Search for people or text'), false, 'nav_search');
 390             if ($user) {
 391                 $this->menuItem(common_local_url('profilesettings'),
 392                                 _('Account'), _('Change your email, avatar, password, profile'), false, 'nav_account');
 393
 394                 if (common_config('xmpp', 'enabled')) {
 395                     $this->menuItem(common_local_url('imsettings'),
 396                                     _('Connect'), _('Connect to IM, SMS, Twitter'), false, 'nav_connect');
 397                 } else {
 398                     $this->menuItem(common_local_url('smssettings'),
 399                                     _('Connect'), _('Connect to SMS, Twitter'), false, 'nav_connect');
 400                 }
 401                 $this->menuItem(common_local_url('logout'),
 402                                 _('Logout'), _('Logout from the site'), false, 'nav_logout');
 403             } else {
 404                 $this->menuItem(common_local_url('login'),
 405                                 _('Login'), _('Login to the site'), false, 'nav_login');
 406                 if (!common_config('site', 'closed')) {
 407                     $this->menuItem(common_local_url('register'),
 408                                     _('Register'), _('Create an account'), false, 'nav_register');
 409                 }
 410                 $this->menuItem(common_local_url('openidlogin'),
 411                                 _('OpenID'), _('Login with OpenID'), false, 'nav_openid');
 412             }
 413             $this->menuItem(common_local_url('doc', array('title' => 'help')),
 414                             _('Help'), _('Help me!'), false, 'nav_help');
 415             Event::handle('EndPrimaryNav', array($this));
 416         }
 417         $this->elementEnd('ul');
 418         $this->elementEnd('dd');
 419         $this->elementEnd('dl');
 420     }
 421
 422     /**
 423      * Show site notice.
 424      *
 425      * @return nothing
 426      */
 427     function showSiteNotice()
 428     {
 429         // Revist. Should probably do an hAtom pattern here
 430         $text = common_config('site', 'notice');
 431         if ($text) {
 432             $this->elementStart('dl', array('id' => 'site_notice',
 433                                             'class' => 'system_notice'));
 434             $this->element('dt', null, _('Site notice'));
 435             $this->elementStart('dd', null);
 436             $this->raw($text);
 437             $this->elementEnd('dd');
 438             $this->elementEnd('dl');
 439         }
 440     }
 441
 442     /**
 443      * Show notice form.
 444      *
 445      * MAY overload if no notice form needed... or direct message box????
 446      *
 447      * @return nothing
 448      */
 449     function showNoticeForm()
 450     {
 451         $notice_form = new NoticeForm($this);
 452         $notice_form->show();
 453     }
 454
 455     /**
 456      * Show anonymous message.
 457      *
 458      * SHOULD overload
 459      *
 460      * @return nothing
 461      */
 462     function showAnonymousMessage()
 463     {
 464         // needs to be defined by the class
 465     }
 466
 467     /**
 468      * Show core.
 469      *
 470      * Shows local navigation, content block and aside.
 471      *
 472      * @return nothing
 473      */
 474     function showCore()
 475     {
 476         $this->elementStart('div', array('id' => 'core'));
 477         if (Event::handle('StartShowLocalNavBlock', array($this))) {
 478             $this->showLocalNavBlock();
 479             Event::handle('EndShowLocalNavBlock', array($this));
 480         }
 481         if (Event::handle('StartShowContentBlock', array($this))) {
 482             $this->showContentBlock();
 483             Event::handle('EndShowContentBlock', array($this));
 484         }
 485         $this->showAside();
 486         $this->elementEnd('div');
 487     }
 488
 489     /**
 490      * Show local navigation block.
 491      *
 492      * @return nothing
 493      */
 494     function showLocalNavBlock()
 495     {
 496         $this->elementStart('dl', array('id' => 'site_nav_local_views'));
 497         $this->element('dt', null, _('Local views'));
 498         $this->elementStart('dd');
 499         $this->showLocalNav();
 500         $this->elementEnd('dd');
 501         $this->elementEnd('dl');
 502     }
 503
 504     /**
 505      * Show local navigation.
 506      *
 507      * SHOULD overload
 508      *
 509      * @return nothing
 510      */
 511     function showLocalNav()
 512     {
 513         // does nothing by default
 514     }
 515
 516     /**
 517      * Show content block.
 518      *
 519      * @return nothing
 520      */
 521     function showContentBlock()
 522     {
 523         $this->elementStart('div', array('id' => 'content'));
 524         $this->showPageTitle();
 525         $this->showPageNoticeBlock();
 526         $this->elementStart('div', array('id' => 'content_inner'));
 527         // show the actual content (forms, lists, whatever)
 528         $this->showContent();
 529         $this->elementEnd('div');
 530         $this->elementEnd('div');
 531     }
 532
 533     /**
 534      * Show page title.
 535      *
 536      * @return nothing
 537      */
 538     function showPageTitle()
 539     {
 540         $this->element('h1', null, $this->title());
 541     }
 542
 543     /**
 544      * Show page notice block.
 545      *
 546      * @return nothing
 547      */
 548     function showPageNoticeBlock()
 549     {
 550         $this->elementStart('dl', array('id' => 'page_notice',
 551                                         'class' => 'system_notice'));
 552         $this->element('dt', null, _('Page notice'));
 553         $this->elementStart('dd');
 554         $this->showPageNotice();
 555         $this->elementEnd('dd');
 556         $this->elementEnd('dl');
 557     }
 558
 559     /**
 560      * Show page notice.
 561      *
 562      * SHOULD overload (unless there's not a notice)
 563      *
 564      * @return nothing
 565      */
 566     function showPageNotice()
 567     {
 568     }
 569
 570     /**
 571      * Show content.
 572      *
 573      * MUST overload (unless there's not a notice)
 574      *
 575      * @return nothing
 576      */
 577     function showContent()
 578     {
 579     }
 580
 581     /**
 582      * Show Aside.
 583      *
 584      * @return nothing
 585      */
 586
 587     function showAside()
 588     {
 589         $this->elementStart('div', array('id' => 'aside_primary',
 590                                          'class' => 'aside'));
 591         $this->showExportData();
 592         if (Event::handle('StartShowSections', array($this))) {
 593             $this->showSections();
 594             Event::handle('EndShowSections', array($this));
 595         }
 596         $this->elementEnd('div');
 597     }
 598
 599     /**
 600      * Show export data feeds.
 601      *
 602      * @return void
 603      */
 604
 605     function showExportData()
 606     {
 607         $feeds = $this->getFeeds();
 608         if ($feeds) {
 609             $fl = new FeedList($this);
 610             $fl->show($feeds);
 611         }
 612     }
 613
 614     /**
 615      * Show sections.
 616      *
 617      * SHOULD overload
 618      *
 619      * @return nothing
 620      */
 621     function showSections()
 622     {
 623         // for each section, show it
 624     }
 625
 626     /**
 627      * Show footer.
 628      *
 629      * @return nothing
 630      */
 631     function showFooter()
 632     {
 633         $this->elementStart('div', array('id' => 'footer'));
 634         $this->showSecondaryNav();
 635         $this->showLicenses();
 636         $this->elementEnd('div');
 637     }
 638
 639     /**
 640      * Show secondary navigation.
 641      *
 642      * @return nothing
 643      */
 644     function showSecondaryNav()
 645     {
 646         $this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
 647         $this->element('dt', null, _('Secondary site navigation'));
 648         $this->elementStart('dd', null);
 649         $this->elementStart('ul', array('class' => 'nav'));
 650         if (Event::handle('StartSecondaryNav', array($this))) {
 651             $this->menuItem(common_local_url('doc', array('title' => 'help')),
 652                             _('Help'));
 653             $this->menuItem(common_local_url('doc', array('title' => 'about')),
 654                             _('About'));
 655             $this->menuItem(common_local_url('doc', array('title' => 'faq')),
 656                             _('FAQ'));
 657             $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
 658                             _('Privacy'));
 659             $this->menuItem(common_local_url('doc', array('title' => 'source')),
 660                             _('Source'));
 661             $this->menuItem(common_local_url('doc', array('title' => 'contact')),
 662                             _('Contact'));
 663             $this->menuItem(common_local_url('doc', array('title' => 'badge')),
 664                             _('Badge'));
 665             Event::handle('EndSecondaryNav', array($this));
 666         }
 667         $this->elementEnd('ul');
 668         $this->elementEnd('dd');
 669         $this->elementEnd('dl');
 670     }
 671
 672     /**
 673      * Show licenses.
 674      *
 675      * @return nothing
 676      */
 677     function showLicenses()
 678     {
 679         $this->elementStart('dl', array('id' => 'licenses'));
 680         $this->showLaconicaLicense();
 681         $this->showContentLicense();
 682         $this->elementEnd('dl');
 683     }
 684
 685     /**
 686      * Show Laconica license.
 687      *
 688      * @return nothing
 689      */
 690     function showLaconicaLicense()
 691     {
 692         $this->element('dt', array('id' => 'site_laconica_license'), _('Laconica software license'));
 693         $this->elementStart('dd', null);
 694         if (common_config('site', 'broughtby')) {
 695             $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
 696         } else {
 697             $instr = _('**%%site.name%%** is a microblogging service. ');
 698         }
 699         $instr .= sprintf(_('It runs the [Laconica](http://laconi.ca/) microblogging software, version %s, available under the [GNU Affero General Public License](http://www.fsf.org/licensing/licenses/agpl-3.0.html).'), LACONICA_VERSION);
 700         $output = common_markup_to_html($instr);
 701         $this->raw($output);
 702         $this->elementEnd('dd');
 703         // do it
 704     }
 705
 706     /**
 707      * Show content license.
 708      *
 709      * @return nothing
 710      */
 711     function showContentLicense()
 712     {
 713         $this->element('dt', array('id' => 'site_content_license'), _('Laconica software license'));
 714         $this->elementStart('dd', array('id' => 'site_content_license_cc'));
 715         $this->elementStart('p');
 716         $this->element('img', array('id' => 'license_cc',
 717                                     'src' => common_config('license', 'image'),
 718                                     'alt' => common_config('license', 'title')));
 719         //TODO: This is dirty: i18n
 720         $this->text(_('All '.common_config('site', 'name').' content and data are available under the '));
 721         $this->element('a', array('class' => 'license',
 722                                   'rel' => 'external license',
 723                                   'href' => common_config('license', 'url')),
 724                        common_config('license', 'title'));
 725         $this->text(_('license.'));
 726         $this->elementEnd('p');
 727         $this->elementEnd('dd');
 728     }
 729
 730     /**
 731      * Return last modified, if applicable.
 732      *
 733      * MAY override
 734      *
 735      * @return string last modified http header
 736      */
 737     function lastModified()
 738     {
 739         // For comparison with If-Last-Modified
 740         // If not applicable, return null
 741         return null;
 742     }
 743
 744     /**
 745      * Return etag, if applicable.
 746      *
 747      * MAY override
 748      *
 749      * @return string etag http header
 750      */
 751     function etag()
 752     {
 753         return null;
 754     }
 755
 756     /**
 757      * Return true if read only.
 758      *
 759      * MAY override
 760      *
 761      * @return boolean is read only action?
 762      */
 763     function isReadOnly()
 764     {
 765         return false;
 766     }
 767
 768     /**
 769      * Returns query argument or default value if not found
 770      *
 771      * @param string $key requested argument
 772      * @param string $def default value to return if $key is not provided
 773      *
 774      * @return boolean is read only action?
 775      */
 776     function arg($key, $def=null)
 777     {
 778         if (array_key_exists($key, $this->args)) {
 779             return $this->args[$key];
 780         } else {
 781             return $def;
 782         }
 783     }
 784
 785     /**
 786      * Returns trimmed query argument or default value if not found
 787      *
 788      * @param string $key requested argument
 789      * @param string $def default value to return if $key is not provided
 790      *
 791      * @return boolean is read only action?
 792      */
 793     function trimmed($key, $def=null)
 794     {
 795         $arg = $this->arg($key, $def);
 796         return is_string($arg) ? trim($arg) : $arg;
 797     }
 798
 799     /**
 800      * Handler method
 801      *
 802      * @param array $argarray is ignored since it's now passed in in prepare()
 803      *
 804      * @return boolean is read only action?
 805      */
 806     function handle($argarray=null)
 807     {
 808         $lm   = $this->lastModified();
 809         $etag = $this->etag();
 810         if ($etag) {
 811             header('ETag: ' . $etag);
 812         }
 813         if ($lm) {
 814             header('Last-Modified: ' . date(DATE_RFC1123, $lm));
 815             if (array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
 816                 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
 817                 $ims = strtotime($if_modified_since);
 818                 if ($lm <= $ims) {
 819                     $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
 820                       $_SERVER['HTTP_IF_NONE_MATCH'] : null;
 821                     if (!$if_none_match ||
 822                         !$etag ||
 823                         $this->_hasEtag($etag, $if_none_match)) {
 824                         header('HTTP/1.1 304 Not Modified');
 825                         // Better way to do this?
 826                         exit(0);
 827                     }
 828                 }
 829             }
 830         }
 831     }
 832
 833     /**
 834      * Has etag? (private)
 835      *
 836      * @param string $etag          etag http header
 837      * @param string $if_none_match ifNoneMatch http header
 838      *
 839      * @return boolean
 840      */
 841
 842     function _hasEtag($etag, $if_none_match)
 843     {
 844         $etags = explode(',', $if_none_match);
 845         return in_array($etag, $etags) || in_array('*', $etags);
 846     }
 847
 848     /**
 849      * Boolean understands english (yes, no, true, false)
 850      *
 851      * @param string $key query key we're interested in
 852      * @param string $def default value
 853      *
 854      * @return boolean interprets yes/no strings as boolean
 855      */
 856     function boolean($key, $def=false)
 857     {
 858         $arg = strtolower($this->trimmed($key));
 859
 860         if (is_null($arg)) {
 861             return $def;
 862         } else if (in_array($arg, array('true', 'yes', '1'))) {
 863             return true;
 864         } else if (in_array($arg, array('false', 'no', '0'))) {
 865             return false;
 866         } else {
 867             return $def;
 868         }
 869     }
 870
 871     /**
 872      * Server error
 873      *
 874      * @param string  $msg  error message to display
 875      * @param integer $code http error code, 500 by default
 876      *
 877      * @return nothing
 878      */
 879
 880     function serverError($msg, $code=500)
 881     {
 882         $action = $this->trimmed('action');
 883         common_debug("Server error '$code' on '$action': $msg", __FILE__);
 884         throw new ServerException($msg, $code);
 885     }
 886
 887     /**
 888      * Client error
 889      *
 890      * @param string  $msg  error message to display
 891      * @param integer $code http error code, 400 by default
 892      *
 893      * @return nothing
 894      */
 895
 896     function clientError($msg, $code=400)
 897     {
 898         $action = $this->trimmed('action');
 899         common_debug("User error '$code' on '$action': $msg", __FILE__);
 900         throw new ClientException($msg, $code);
 901     }
 902
 903     /**
 904      * Returns the current URL
 905      *
 906      * @return string current URL
 907      */
 908     function selfUrl()
 909     {
 910         $action = $this->trimmed('action');
 911         $args   = $this->args;
 912         unset($args['action']);
 913         foreach (array_keys($_COOKIE) as $cookie) {
 914             unset($args[$cookie]);
 915         }
 916         return common_local_url($action, $args);
 917     }
 918
 919     /**
 920      * Generate a menu item
 921      *
 922      * @param string  $url         menu URL
 923      * @param string  $text        menu name
 924      * @param string  $title       title attribute, null by default
 925      * @param boolean $is_selected current menu item, false by default
 926      * @param string  $id          element id, null by default
 927      *
 928      * @return nothing
 929      */
 930     function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
 931     {
 932         // Added @id to li for some control.
 933         // XXX: We might want to move this to htmloutputter.php
 934         $lattrs = array();
 935         if ($is_selected) {
 936             $lattrs['class'] = 'current';
 937         }
 938
 939         (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
 940
 941         $this->elementStart('li', $lattrs);
 942         $attrs['href'] = $url;
 943         if ($title) {
 944             $attrs['title'] = $title;
 945         }
 946         $this->element('a', $attrs, $text);
 947         $this->elementEnd('li');
 948     }
 949
 950     /**
 951      * Generate pagination links
 952      *
 953      * @param boolean $have_before is there something before?
 954      * @param boolean $have_after  is there something after?
 955      * @param integer $page        current page
 956      * @param string  $action      current action
 957      * @param array   $args        rest of query arguments
 958      *
 959      * @return nothing
 960      */
 961     function pagination($have_before, $have_after, $page, $action, $args=null)
 962     {
 963         // Does a little before-after block for next/prev page
 964         if ($have_before || $have_after) {
 965             $this->elementStart('div', array('class' => 'pagination'));
 966             $this->elementStart('dl', null);
 967             $this->element('dt', null, _('Pagination'));
 968             $this->elementStart('dd', null);
 969             $this->elementStart('ul', array('class' => 'nav'));
 970         }
 971         if ($have_before) {
 972             $pargs   = array('page' => $page-1);
 973             $newargs = $args ? array_merge($args, $pargs) : $pargs;
 974             $this->elementStart('li', array('class' => 'nav_prev'));
 975             $this->element('a', array('href' => common_local_url($action, $newargs), 'rel' => 'prev'),
 976                            _('After'));
 977             $this->elementEnd('li');
 978         }
 979         if ($have_after) {
 980             $pargs   = array('page' => $page+1);
 981             $newargs = $args ? array_merge($args, $pargs) : $pargs;
 982             $this->elementStart('li', array('class' => 'nav_next'));
 983             $this->element('a', array('href' => common_local_url($action, $newargs), 'rel' => 'next'),
 984                            _('Before'));
 985             $this->elementEnd('li');
 986         }
 987         if ($have_before || $have_after) {
 988             $this->elementEnd('ul');
 989             $this->elementEnd('dd');
 990             $this->elementEnd('dl');
 991             $this->elementEnd('div');
 992         }
 993     }
 994
 995     /**
 996      * An array of feeds for this action.
 997      *
 998      * Returns an array of potential feeds for this action.
 999      *
1000      * @return array Feed object to show in head and links
1001      */
1002
1003     function getFeeds()
1004     {
1005         return null;
1006     }
1007 }