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