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