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
  57 class Action extends HTMLOutputter // lawsuit
  58 {
  59     var $args;
  60
  61     /**
  62      * Constructor
  63      *
  64      * Just wraps the HTMLOutputter constructor.
  65      *
  66      * @param string  $output URI to output to, default = stdout
  67      * @param boolean $indent Whether to indent output, default true
  68      *
  69      * @see XMLOutputter::__construct
  70      * @see HTMLOutputter::__construct
  71      */
  72
  73     function __construct($output='php://output', $indent=true)
  74     {
  75         parent::__construct($output, $indent);
  76     }
  77
  78     // For initializing members of the class
  79
  80     function prepare($argarray)
  81     {
  82         $this->args =& common_copy_args($argarray);
  83         return true;
  84     }
  85
  86     function showPage()
  87     {
  88         $this->startHTML();
  89         $this->showHead();
  90         $this->showBody();
  91         $this->endHTML();
  92     }
  93
  94     function showHead()
  95     {
  96         // XXX: attributes (profile?)
  97         $this->elementStart('head');
  98         $this->showTitle();
  99         $this->showStylesheets();
 100         $this->showScripts();
 101         $this->showOpenSearch();
 102         $this->showFeeds();
 103         $this->showDescription();
 104         $this->extraHead();
 105         $this->elementEnd('head');
 106     }
 107
 108     function showTitle()
 109     {
 110         $this->element('title', null,
 111                        sprintf(_("%s - %s"),
 112                                $this->title(),
 113                                common_config('site', 'name')));
 114     }
 115
 116     // SHOULD overload
 117
 118     function title()
 119     {
 120         return _("Untitled page");
 121     }
 122
 123     function showStylesheets()
 124     {
 125         $this->element('link', array('rel' => 'stylesheet',
 126                                      'type' => 'text/css',
 127                                      'href' => theme_path('css/display.css', 'base') . '?version=' . LACONICA_VERSION,
 128                                      'media' => 'screen, projection, tv'));
 129         $this->element('link', array('rel' => 'stylesheet',
 130                                      'type' => 'text/css',
 131                                      'href' => theme_path('css/thickbox.css', 'base') . '?version=' . LACONICA_VERSION,
 132                                      'media' => 'screen, projection, tv'));
 133         $this->element('link', array('rel' => 'stylesheet',
 134                                      'type' => 'text/css',
 135                                      'href' => theme_path('css/display.css', null) . '?version=' . LACONICA_VERSION,
 136                                      'media' => 'screen, projection, tv'));
 137         foreach (array(6,7) as $ver) {
 138             if (file_exists(theme_file('ie'.$ver.'.css'))) {
 139                 // Yes, IE people should be put in jail.
 140                 $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
 141                                'href="'.theme_path('ie'.$ver.'.css').'?version='.LACONICA_VERSION.'" /><![endif]');
 142             }
 143         }
 144     }
 145
 146     function showScripts()
 147     {
 148         $this->element('script', array('type' => 'text/javascript',
 149                                        'src' => common_path('js/jquery.min.js')),
 150                        ' ');
 151         $this->element('script', array('type' => 'text/javascript',
 152                                        'src' => common_path('js/jquery.form.js')),
 153                        ' ');
 154         $this->element('script', array('type' => 'text/javascript',
 155                                        'src' => common_path('js/xbImportNode.js')),
 156                        ' ');
 157         $this->element('script', array('type' => 'text/javascript',
 158                                        'src' => common_path('js/util.js?version='.LACONICA_VERSION)),
 159                        ' ');
 160     }
 161
 162     function showOpenSearch()
 163     {
 164         $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
 165                                      'href' =>  common_local_url('opensearch', array('type' => 'people')),
 166                                      'title' => common_config('site', 'name').' People Search'));
 167
 168         $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
 169                                      'href' =>  common_local_url('opensearch', array('type' => 'notice')),
 170                                      'title' => common_config('site', 'name').' Notice Search'));
 171     }
 172
 173     // MAY overload
 174
 175     function showFeeds()
 176     {
 177         // does nothing by default
 178     }
 179
 180     // SHOULD overload
 181
 182     function showDescription()
 183     {
 184         // does nothing by default
 185     }
 186
 187     // MAY overload
 188
 189     function extraHead()
 190     {
 191         // does nothing by default
 192     }
 193
 194     function showBody()
 195     {
 196         $this->elementStart('body');
 197         $this->elementStart('div', 'wrap');
 198         $this->showHeader();
 199         $this->showCore();
 200         $this->showFooter();
 201         $this->elementEnd('div', 'wrap');
 202         $this->elementEnd('body');
 203     }
 204
 205     function showHeader()
 206     {
 207         $this->elementStart('div', array('id' => 'header'));
 208         $this->showLogo();
 209         $this->showPrimaryNav();
 210         $this->showSiteNotice();
 211         if (common_logged_in()) {
 212             $this->showNoticeForm();
 213         } else {
 214             $this->showAnonymousMessage();
 215         }
 216         $this->elementEnd('div');
 217     }
 218
 219     function showLogo()
 220     {
 221         $this->elementStart('address', array('id' => 'site_contact',
 222                                               'class' => 'vcard'));
 223         $this->elementStart('a', array('class' => 'url home bookmark',
 224                                         'href' => common_local_url('public')));
 225         if ((isset($config['site']['logo']) && is_string($config['site']['logo']) && (strlen($config['site']['logo']) > 0))
 226             || file_exists(theme_file('logo.png')))
 227         {
 228             $this->element('img', array('class' => 'logo photo',
 229                                         'src' => isset($config['site']['logo']) ?
 230                                         ($config['site']['logo']) : theme_path('logo.png'),
 231                                         'alt' => $config['site']['name']));
 232         }
 233         $this->element('span', array('class' => 'fn org'), $config['site']['name']);
 234         $this->elementEnd('a');
 235         $this->elementEnd('address');
 236     }
 237
 238     function showPrimaryNav()
 239     {
 240         $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
 241         $this->element('dt', null, _('Primary site navigation'));
 242         $this->elementStart('dd');
 243         $user = common_current_user();
 244         $this->elementStart('ul', array('class' => 'nav'));
 245         if ($user) {
 246             $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
 247                              _('Home'));
 248         }
 249         $this->menuItem(common_local_url('peoplesearch'), _('Search'));
 250         if ($user) {
 251             $this->menuItem(common_local_url('profilesettings'),
 252                              _('Settings'));
 253             $this->menuItem(common_local_url('invite'),
 254                              _('Invite'));
 255             $this->menuItem(common_local_url('logout'),
 256                              _('Logout'));
 257         } else {
 258             $this->menuItem(common_local_url('login'), _('Login'));
 259             if (!common_config('site', 'closed')) {
 260                 $this->menuItem(common_local_url('register'), _('Register'));
 261             }
 262             $this->menuItem(common_local_url('openidlogin'), _('OpenID'));
 263         }
 264         $this->menuItem(common_local_url('doc', array('title' => 'help')),
 265                          _('Help'));
 266         $this->elementEnd('ul');
 267         $this->elementEnd('dd');
 268         $this->elementEnd('dl');
 269     }
 270
 271     // Revist. Should probably do an hAtom pattern here
 272     function showSiteNotice()
 273     {
 274         $text = common_config('site', 'notice');
 275         if ($text) {
 276             $this->elementStart('dl', array('id' => 'site_notice',
 277                                             'class' => 'system_notice'));
 278             $this->element('dt', null, _('Site notice'));
 279             $this->element('dd', null, $text);
 280             $this->elementEnd('dl');
 281         }
 282     }
 283
 284     // MAY overload if no notice form needed... or direct message box????
 285
 286     function showNoticeForm()
 287     {
 288         $notice_form = new NoticeForm($this);
 289         $notice_form->show();
 290     }
 291
 292     function showAnonymousMessage()
 293     {
 294         // needs to be defined by the class
 295     }
 296
 297     function showCore()
 298     {
 299         $this->elementStart('div', array('id' => 'core'));
 300         $this->elementStart('dl', array('id' => 'site_nav_local_views'));
 301         $this->element('dt', null, _('Local views'));
 302         $this->elementStart('dd');
 303         $this->showLocalNav();
 304         $this->elementEnd('dd');
 305         $this->elementEnd('dl');
 306         $this->showContentBlock();
 307         $this->showAside();
 308         $this->elementEnd('div');
 309     }
 310
 311     // SHOULD overload
 312
 313     function showLocalNav()
 314     {
 315         // does nothing by default
 316     }
 317
 318     function showContentBlock()
 319     {
 320         $this->elementStart('div', array('id' => 'content'));
 321         $this->showPageTitle();
 322         $this->showPageNoticeBlock();
 323         $this->elementStart('div', array('id' => 'content_inner'));
 324         // show the actual content (forms, lists, whatever)
 325         $this->showContent();
 326         $this->elementEnd('div');
 327         $this->elementEnd('div');
 328     }
 329
 330     function showPageTitle() {
 331         $this->element('h1', NULL, $this->title());
 332     }
 333
 334     function showPageNoticeBlock()
 335     {
 336         $this->elementStart('dl', array('id' => 'page_notice',
 337                                         'class' => 'system_notice'));
 338         $this->element('dt', null, _('Page notice'));
 339         $this->elementStart('dd');
 340         $this->showPageNotice();
 341         $this->elementEnd('dd');
 342         $this->elementEnd('dl');
 343         }
 344
 345     // SHOULD overload (unless there's not a notice)
 346
 347     function showPageNotice()
 348     {
 349     }
 350
 351     // MUST overload
 352
 353     function showContent()
 354     {
 355     }
 356
 357     function showAside()
 358     {
 359         $this->elementStart('div', array('id' => 'aside_primary',
 360                                          'class' => 'aside'));
 361         $this->showExportData();
 362         $this->showSections();
 363         $this->elementEnd('div');
 364     }
 365
 366     // MAY overload if there are feeds
 367
 368     function showExportData()
 369     {
 370         // is there structure to this?
 371         // list of (visible!) feed links
 372         // can we reuse list of feeds from showFeeds() ?
 373     }
 374
 375     // SHOULD overload
 376
 377     function showSections() {
 378         // for each section, show it
 379     }
 380
 381     function showFooter()
 382     {
 383         $this->elementStart('div', array('id' => 'footer'));
 384         $this->showSecondaryNav();
 385         $this->showLicenses();
 386         $this->elementEnd('div');
 387     }
 388
 389     function showSecondaryNav()
 390     {
 391         $this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
 392         $this->element('dt', null, _('Secondary site navigation'));
 393         $this->elementStart('dd', null);
 394         $this->elementStart('ul', array('class' => 'nav'));
 395         $this->menuItem(common_local_url('doc', array('title' => 'help')),
 396                          _('Help'));
 397         $this->menuItem(common_local_url('doc', array('title' => 'about')),
 398                          _('About'));
 399         $this->menuItem(common_local_url('doc', array('title' => 'faq')),
 400                          _('FAQ'));
 401         $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
 402                          _('Privacy'));
 403         $this->menuItem(common_local_url('doc', array('title' => 'source')),
 404                          _('Source'));
 405         $this->menuItem(common_local_url('doc', array('title' => 'contact')),
 406                          _('Contact'));
 407         $this->elementEnd('ul');
 408         $this->elementEnd('dd');
 409         $this->elementEnd('dl');
 410     }
 411
 412     function showLicenses()
 413     {
 414         $this->elementStart('dl', array('id' => 'licenses'));
 415         $this->showLaconicaLicense();
 416         $this->showContentLicense();
 417         $this->elementEnd('dl');
 418     }
 419
 420     function showLaconicaLicense()
 421     {
 422         $this->element('dt', array('id' => 'site_laconica_license'), _('Laconica software license'));
 423         $this->elementStart('dd', null);
 424         if (common_config('site', 'broughtby')) {
 425             $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
 426         } else {
 427             $instr = _('**%%site.name%%** is a microblogging service. ');
 428         }
 429         $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);
 430         $output = common_markup_to_html($instr);
 431         $this->raw($output);
 432         $this->elementEnd('dd');
 433         // do it
 434     }
 435
 436     function showContentLicense()
 437     {
 438         $this->element('dt', array('id' => 'site_content_license'), _('Laconica software license'));
 439         $this->elementStart('dd', array('id' => 'site_content_license_cc'));
 440         $this->elementStart('p');
 441         $this->text(_('Unless otherwise specified, contents of this site are copyright by the contributors and available under the '));
 442         $this->element('a', array('class' => 'license',
 443                                   'rel' => 'external license',
 444                                   'href' => common_config('license', 'url')),
 445                        common_config('license', 'title'));
 446         $this->text(_('. Contributors should be attributed by full name or nickname.'));
 447         $this->elementEnd('p');
 448         $this->element('img', array('id' => 'license_cc',
 449                                     'src' => common_config('license', 'image'),
 450                                     'alt' => common_config('license', 'title')));
 451         $this->elementEnd('dd');
 452     }
 453
 454     // For comparison with If-Last-Modified
 455     // If not applicable, return null
 456
 457     function last_modified()
 458     {
 459         return null;
 460     }
 461
 462     function etag()
 463     {
 464         return null;
 465     }
 466
 467     function isReadOnly()
 468     {
 469         return false;
 470     }
 471
 472     function arg($key, $def=null)
 473     {
 474         if (array_key_exists($key, $this->args)) {
 475             return $this->args[$key];
 476         } else {
 477             return $def;
 478         }
 479     }
 480
 481     function trimmed($key, $def=null)
 482     {
 483         $arg = $this->arg($key, $def);
 484         return (is_string($arg)) ? trim($arg) : $arg;
 485     }
 486
 487     // Note: argarray ignored, since it's now passed in in prepare()
 488
 489     function handle($argarray=null)
 490     {
 491
 492         $lm = $this->last_modified();
 493         $etag = $this->etag();
 494
 495         if ($etag) {
 496             header('ETag: ' . $etag);
 497         }
 498
 499         if ($lm) {
 500             header('Last-Modified: ' . date(DATE_RFC1123, $lm));
 501             $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
 502             if ($if_modified_since) {
 503                 $ims = strtotime($if_modified_since);
 504                 if ($lm <= $ims) {
 505                     if (!$etag ||
 506                         $this->_has_etag($etag, $_SERVER['HTTP_IF_NONE_MATCH'])) {
 507                         header('HTTP/1.1 304 Not Modified');
 508                         // Better way to do this?
 509                         exit(0);
 510                     }
 511                 }
 512             }
 513         }
 514     }
 515
 516     function _has_etag($etag, $if_none_match)
 517     {
 518         return ($if_none_match) && in_array($etag, explode(',', $if_none_match));
 519     }
 520
 521     function boolean($key, $def=false)
 522     {
 523         $arg = strtolower($this->trimmed($key));
 524
 525         if (is_null($arg)) {
 526             return $def;
 527         } else if (in_array($arg, array('true', 'yes', '1'))) {
 528             return true;
 529         } else if (in_array($arg, array('false', 'no', '0'))) {
 530             return false;
 531         } else {
 532             return $def;
 533         }
 534     }
 535
 536     function serverError($msg, $code=500)
 537     {
 538         $action = $this->trimmed('action');
 539         common_debug("Server error '$code' on '$action': $msg", __FILE__);
 540         common_server_error($msg, $code);
 541     }
 542
 543     function clientError($msg, $code=400)
 544     {
 545         $action = $this->trimmed('action');
 546         common_debug("User error '$code' on '$action': $msg", __FILE__);
 547         common_user_error($msg, $code);
 548     }
 549
 550     function self_url()
 551     {
 552         $action = $this->trimmed('action');
 553         $args = $this->args;
 554         unset($args['action']);
 555         foreach (array_keys($_COOKIE) as $cookie) {
 556             unset($args[$cookie]);
 557         }
 558         return common_local_url($action, $args);
 559     }
 560
 561     // Added @id to li for some control.
 562     // XXX: We might want to move this to htmloutputter.php
 563
 564     function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
 565     {
 566         $lattrs = array();
 567         if ($is_selected) {
 568             $lattrs['class'] = 'current';
 569         }
 570
 571         $this->elementStart('li', (is_null($id)) ? null : array('id' => $id),  $lattrs);
 572         $attrs['href'] = $url;
 573         if ($title) {
 574             $attrs['title'] = $title;
 575         }
 576         $this->element('a', $attrs, $text);
 577         $this->elementEnd('li');
 578     }
 579
 580     // Does a little before-after block for next/prev page
 581
 582     function pagination($have_before, $have_after, $page, $action, $args=null)
 583     {
 584         if ($have_before || $have_after) {
 585             $this->elementStart('div', array('class' => 'pagination'));
 586             $this->elementStart('dl', null);
 587             $this->element('dt', null, _('Pagination'));
 588             $this->elementStart('dd', null);
 589             $this->elementStart('ul', array('class' => 'nav'));
 590         }
 591
 592         if ($have_before) {
 593             $pargs = array('page' => $page-1);
 594             $newargs = ($args) ? array_merge($args,$pargs) : $pargs;
 595
 596             $this->elementStart('li', array('class' => 'nav_prev'));
 597             $this->element('a', array('href' => common_local_url($action, $newargs), 'rel' => 'prev'),
 598                            _('After'));
 599             $this->elementEnd('li');
 600         }
 601
 602         if ($have_after) {
 603             $pargs = array('page' => $page+1);
 604             $newargs = ($args) ? array_merge($args,$pargs) : $pargs;
 605             $this->elementStart('li', array('class' => 'nav_next'));
 606             $this->element('a', array('href' => common_local_url($action, $newargs), 'rel' => 'next'),
 607                            _('Before'));
 608             $this->elementEnd('li');
 609         }
 610
 611         if ($have_before || $have_after) {
 612             $this->elementEnd('ul');
 613             $this->elementEnd('dd');
 614             $this->elementEnd('dl');
 615             $this->elementEnd('div');
 616         }
 617     }
 618 }