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