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