lib/action.php

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