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