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