lib/action.php

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