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