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         $this->showPageNotice();
 601         $this->elementEnd('dd');
 602         $this->elementEnd('dl');
 603     }
 604
 605     /**
 606      * Show page notice.
 607      *
 608      * SHOULD overload (unless there's not a notice)
 609      *
 610      * @return nothing
 611      */
 612     function showPageNotice()
 613     {
 614     }
 615
 616     /**
 617      * Show content.
 618      *
 619      * MUST overload (unless there's not a notice)
 620      *
 621      * @return nothing
 622      */
 623     function showContent()
 624     {
 625     }
 626
 627     /**
 628      * Show Aside.
 629      *
 630      * @return nothing
 631      */
 632
 633     function showAside()
 634     {
 635         $this->elementStart('div', array('id' => 'aside_primary',
 636                                          'class' => 'aside'));
 637         if (Event::handle('StartShowExportData', array($this))) {
 638         $this->showExportData();
 639             Event::handle('EndShowExportData', array($this));
 640         }
 641         if (Event::handle('StartShowSections', array($this))) {
 642             $this->showSections();
 643             Event::handle('EndShowSections', array($this));
 644         }
 645         $this->elementEnd('div');
 646     }
 647
 648     /**
 649      * Show export data feeds.
 650      *
 651      * @return void
 652      */
 653
 654     function showExportData()
 655     {
 656         $feeds = $this->getFeeds();
 657         if ($feeds) {
 658             $fl = new FeedList($this);
 659             $fl->show($feeds);
 660         }
 661     }
 662
 663     /**
 664      * Show sections.
 665      *
 666      * SHOULD overload
 667      *
 668      * @return nothing
 669      */
 670     function showSections()
 671     {
 672         // for each section, show it
 673     }
 674
 675     /**
 676      * Show footer.
 677      *
 678      * @return nothing
 679      */
 680     function showFooter()
 681     {
 682         $this->elementStart('div', array('id' => 'footer'));
 683         $this->showSecondaryNav();
 684         $this->showLicenses();
 685         $this->elementEnd('div');
 686     }
 687
 688     /**
 689      * Show secondary navigation.
 690      *
 691      * @return nothing
 692      */
 693     function showSecondaryNav()
 694     {
 695         $this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
 696         $this->element('dt', null, _('Secondary site navigation'));
 697         $this->elementStart('dd', null);
 698         $this->elementStart('ul', array('class' => 'nav'));
 699         if (Event::handle('StartSecondaryNav', array($this))) {
 700             $this->menuItem(common_local_url('doc', array('title' => 'help')),
 701                             _('Help'));
 702             $this->menuItem(common_local_url('doc', array('title' => 'about')),
 703                             _('About'));
 704             $this->menuItem(common_local_url('doc', array('title' => 'faq')),
 705                             _('FAQ'));
 706             $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
 707                             _('Privacy'));
 708             $this->menuItem(common_local_url('doc', array('title' => 'source')),
 709                             _('Source'));
 710             $this->menuItem(common_local_url('doc', array('title' => 'contact')),
 711                             _('Contact'));
 712             $this->menuItem(common_local_url('doc', array('title' => 'badge')),
 713                             _('Badge'));
 714             Event::handle('EndSecondaryNav', array($this));
 715         }
 716         $this->elementEnd('ul');
 717         $this->elementEnd('dd');
 718         $this->elementEnd('dl');
 719     }
 720
 721     /**
 722      * Show licenses.
 723      *
 724      * @return nothing
 725      */
 726     function showLicenses()
 727     {
 728         $this->elementStart('dl', array('id' => 'licenses'));
 729         $this->showLaconicaLicense();
 730         $this->showContentLicense();
 731         $this->elementEnd('dl');
 732     }
 733
 734     /**
 735      * Show Laconica license.
 736      *
 737      * @return nothing
 738      */
 739     function showLaconicaLicense()
 740     {
 741         $this->element('dt', array('id' => 'site_laconica_license'), _('Laconica software license'));
 742         $this->elementStart('dd', null);
 743         if (common_config('site', 'broughtby')) {
 744             $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
 745         } else {
 746             $instr = _('**%%site.name%%** is a microblogging service. ');
 747         }
 748         $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);
 749         $output = common_markup_to_html($instr);
 750         $this->raw($output);
 751         $this->elementEnd('dd');
 752         // do it
 753     }
 754
 755     /**
 756      * Show content license.
 757      *
 758      * @return nothing
 759      */
 760     function showContentLicense()
 761     {
 762         $this->element('dt', array('id' => 'site_content_license'), _('Laconica software license'));
 763         $this->elementStart('dd', array('id' => 'site_content_license_cc'));
 764         $this->elementStart('p');
 765         $this->element('img', array('id' => 'license_cc',
 766                                     'src' => common_config('license', 'image'),
 767                                     'alt' => common_config('license', 'title')));
 768         //TODO: This is dirty: i18n
 769         $this->text(_('All '.common_config('site', 'name').' content and data are available under the '));
 770         $this->element('a', array('class' => 'license',
 771                                   'rel' => 'external license',
 772                                   'href' => common_config('license', 'url')),
 773                        common_config('license', 'title'));
 774         $this->text(_('license.'));
 775         $this->elementEnd('p');
 776         $this->elementEnd('dd');
 777     }
 778
 779     /**
 780      * Return last modified, if applicable.
 781      *
 782      * MAY override
 783      *
 784      * @return string last modified http header
 785      */
 786     function lastModified()
 787     {
 788         // For comparison with If-Last-Modified
 789         // If not applicable, return null
 790         return null;
 791     }
 792
 793     /**
 794      * Return etag, if applicable.
 795      *
 796      * MAY override
 797      *
 798      * @return string etag http header
 799      */
 800     function etag()
 801     {
 802         return null;
 803     }
 804
 805     /**
 806      * Return true if read only.
 807      *
 808      * MAY override
 809      *
 810      * @param array $args other arguments
 811      *
 812      * @return boolean is read only action?
 813      */
 814
 815     function isReadOnly($args)
 816     {
 817         return false;
 818     }
 819
 820     /**
 821      * Returns query argument or default value if not found
 822      *
 823      * @param string $key requested argument
 824      * @param string $def default value to return if $key is not provided
 825      *
 826      * @return boolean is read only action?
 827      */
 828     function arg($key, $def=null)
 829     {
 830         if (array_key_exists($key, $this->args)) {
 831             return $this->args[$key];
 832         } else {
 833             return $def;
 834         }
 835     }
 836
 837     /**
 838      * Returns trimmed query argument or default value if not found
 839      *
 840      * @param string $key requested argument
 841      * @param string $def default value to return if $key is not provided
 842      *
 843      * @return boolean is read only action?
 844      */
 845     function trimmed($key, $def=null)
 846     {
 847         $arg = $this->arg($key, $def);
 848         return is_string($arg) ? trim($arg) : $arg;
 849     }
 850
 851     /**
 852      * Handler method
 853      *
 854      * @param array $argarray is ignored since it's now passed in in prepare()
 855      *
 856      * @return boolean is read only action?
 857      */
 858     function handle($argarray=null)
 859     {
 860         $lm   = $this->lastModified();
 861         $etag = $this->etag();
 862         if ($etag) {
 863             header('ETag: ' . $etag);
 864         }
 865         if ($lm) {
 866             header('Last-Modified: ' . date(DATE_RFC1123, $lm));
 867             if (array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
 868                 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
 869                 $ims = strtotime($if_modified_since);
 870                 if ($lm <= $ims) {
 871                     $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
 872                       $_SERVER['HTTP_IF_NONE_MATCH'] : null;
 873                     if (!$if_none_match ||
 874                         !$etag ||
 875                         $this->_hasEtag($etag, $if_none_match)) {
 876                         header('HTTP/1.1 304 Not Modified');
 877                         // Better way to do this?
 878                         exit(0);
 879                     }
 880                 }
 881             }
 882         }
 883     }
 884
 885     /**
 886      * Has etag? (private)
 887      *
 888      * @param string $etag          etag http header
 889      * @param string $if_none_match ifNoneMatch http header
 890      *
 891      * @return boolean
 892      */
 893
 894     function _hasEtag($etag, $if_none_match)
 895     {
 896         $etags = explode(',', $if_none_match);
 897         return in_array($etag, $etags) || in_array('*', $etags);
 898     }
 899
 900     /**
 901      * Boolean understands english (yes, no, true, false)
 902      *
 903      * @param string $key query key we're interested in
 904      * @param string $def default value
 905      *
 906      * @return boolean interprets yes/no strings as boolean
 907      */
 908     function boolean($key, $def=false)
 909     {
 910         $arg = strtolower($this->trimmed($key));
 911
 912         if (is_null($arg)) {
 913             return $def;
 914         } else if (in_array($arg, array('true', 'yes', '1'))) {
 915             return true;
 916         } else if (in_array($arg, array('false', 'no', '0'))) {
 917             return false;
 918         } else {
 919             return $def;
 920         }
 921     }
 922
 923     /**
 924      * Server error
 925      *
 926      * @param string  $msg  error message to display
 927      * @param integer $code http error code, 500 by default
 928      *
 929      * @return nothing
 930      */
 931
 932     function serverError($msg, $code=500)
 933     {
 934         $action = $this->trimmed('action');
 935         common_debug("Server error '$code' on '$action': $msg", __FILE__);
 936         throw new ServerException($msg, $code);
 937     }
 938
 939     /**
 940      * Client error
 941      *
 942      * @param string  $msg  error message to display
 943      * @param integer $code http error code, 400 by default
 944      *
 945      * @return nothing
 946      */
 947
 948     function clientError($msg, $code=400)
 949     {
 950         $action = $this->trimmed('action');
 951         common_debug("User error '$code' on '$action': $msg", __FILE__);
 952         throw new ClientException($msg, $code);
 953     }
 954
 955     /**
 956      * Returns the current URL
 957      *
 958      * @return string current URL
 959      */
 960
 961     function selfUrl()
 962     {
 963         $action = $this->trimmed('action');
 964         $args   = $this->args;
 965         unset($args['action']);
 966         if (array_key_exists('submit', $args)) {
 967             unset($args['submit']);
 968         }
 969         foreach (array_keys($_COOKIE) as $cookie) {
 970             unset($args[$cookie]);
 971         }
 972         return common_local_url($action, $args);
 973     }
 974
 975     /**
 976      * Generate a menu item
 977      *
 978      * @param string  $url         menu URL
 979      * @param string  $text        menu name
 980      * @param string  $title       title attribute, null by default
 981      * @param boolean $is_selected current menu item, false by default
 982      * @param string  $id          element id, null by default
 983      *
 984      * @return nothing
 985      */
 986     function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
 987     {
 988         // Added @id to li for some control.
 989         // XXX: We might want to move this to htmloutputter.php
 990         $lattrs = array();
 991         if ($is_selected) {
 992             $lattrs['class'] = 'current';
 993         }
 994
 995         (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
 996
 997         $this->elementStart('li', $lattrs);
 998         $attrs['href'] = $url;
 999         if ($title) {
1000             $attrs['title'] = $title;
1001         }
1002         $this->element('a', $attrs, $text);
1003         $this->elementEnd('li');
1004     }
1005
1006     /**
1007      * Generate pagination links
1008      *
1009      * @param boolean $have_before is there something before?
1010      * @param boolean $have_after  is there something after?
1011      * @param integer $page        current page
1012      * @param string  $action      current action
1013      * @param array   $args        rest of query arguments
1014      *
1015      * @return nothing
1016      */
1017     function pagination($have_before, $have_after, $page, $action, $args=null)
1018     {
1019         // Does a little before-after block for next/prev page
1020         if ($have_before || $have_after) {
1021             $this->elementStart('div', array('class' => 'pagination'));
1022             $this->elementStart('dl', null);
1023             $this->element('dt', null, _('Pagination'));
1024             $this->elementStart('dd', null);
1025             $this->elementStart('ul', array('class' => 'nav'));
1026         }
1027         if ($have_before) {
1028             $pargs   = array('page' => $page-1);
1029             $this->elementStart('li', array('class' => 'nav_prev'));
1030             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1031                                       'rel' => 'prev'),
1032                            _('After'));
1033             $this->elementEnd('li');
1034         }
1035         if ($have_after) {
1036             $pargs   = array('page' => $page+1);
1037             $this->elementStart('li', array('class' => 'nav_next'));
1038             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1039                                       'rel' => 'next'),
1040                            _('Before'));
1041             $this->elementEnd('li');
1042         }
1043         if ($have_before || $have_after) {
1044             $this->elementEnd('ul');
1045             $this->elementEnd('dd');
1046             $this->elementEnd('dl');
1047             $this->elementEnd('div');
1048         }
1049     }
1050
1051     /**
1052      * An array of feeds for this action.
1053      *
1054      * Returns an array of potential feeds for this action.
1055      *
1056      * @return array Feed object to show in head and links
1057      */
1058
1059     function getFeeds()
1060     {
1061         return null;
1062     }
1063
1064     /**
1065      * Generate document metadata for sequential navigation
1066      *
1067      * @param boolean $have_before is there something before?
1068      * @param boolean $have_after  is there something after?
1069      * @param integer $page        current page
1070      * @param string  $action      current action
1071      * @param array   $args        rest of query arguments
1072      *
1073      * @return nothing
1074      */
1075     function sequenceRelationships($have_next, $have_previous, $page, $action, $args=null)
1076     {
1077         // Outputs machine-readable pagination in <link> elements.
1078         // Pattern taken from $this->pagination() method.
1079
1080         // "next" is equivalent to "after"
1081         if ($have_next) {
1082             $pargs   = array('page' => $page-1);
1083             $this->element('link', array('rel' => 'next',
1084                                          'href' => common_local_url($action, $args, $pargs),
1085                                          'title' => _('Next')));
1086         }
1087         // "previous" is equivalent to "before"
1088         if ($have_previous=true) { // FIXME
1089             $pargs   = array('page' => $page+1);
1090             $this->element('link', array('rel' => 'prev',
1091                                          'href' => common_local_url($action, $args, $pargs),
1092                                          'title' => _('Previous')));
1093         }
1094     }
1095 }