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