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