lib/action.php

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