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('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('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('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('wrap');
 198         $this->showHeader();
 199         $this->showCore();
 200         $this->showFooter();
 201         $this->elementEnd('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         $this->showNoticeForm();
 212         $this->elementEnd('div');
 213     }
 214
 215     function showLogo()
 216     {
 217         $this->elementStart('address', array('id' => 'site_contact',
 218                                               'class' => 'vcard'));
 219         $this->elementStart('a', array('class' => 'url home bookmark',
 220                                         'href' => common_local_url('public')));
 221         if ((isset($config['site']['logo']) && is_string($config['site']['logo']) && (strlen($config['site']['logo']) > 0))
 222             || file_exists(theme_file('logo.png')))
 223         {
 224             $this->element('img', array('class' => 'logo photo',
 225                                         'src' => isset($config['site']['logo']) ?
 226                                         ($config['site']['logo']) : theme_path('logo.png'),
 227                                         'alt' => $config['site']['name']));
 228         }
 229         $this->element('span', array('class' => 'fn org'), $config['site']['name']);
 230         $this->elementEnd('a');
 231         $this->elementEnd('address');
 232     }
 233
 234     function showPrimaryNav()
 235     {
 236         $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
 237         $this->element('dt', null, _('Primary site navigation'));
 238         $user = common_current_user();
 239         $this->elementStart('ul', array('id' => 'nav'));
 240         if ($user) {
 241             $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
 242                              _('Home'));
 243         }
 244         $this->menuItem(common_local_url('peoplesearch'), _('Search'));
 245         if ($user) {
 246             $this->menuItem(common_local_url('profilesettings'),
 247                              _('Settings'));
 248             $this->menuItem(common_local_url('invite'),
 249                              _('Invite'));
 250             $this->menuItem(common_local_url('logout'),
 251                              _('Logout'));
 252         } else {
 253             $this->menuItem(common_local_url('login'), _('Login'));
 254             if (!common_config('site', 'closed')) {
 255                 $this->menuItem(common_local_url('register'), _('Register'));
 256             }
 257             $this->menuItem(common_local_url('openidlogin'), _('OpenID'));
 258         }
 259         $this->menuItem(common_local_url('doc', array('title' => 'help')),
 260                          _('Help'));
 261         $this->elementEnd('ul');
 262         $this->elementEnd('dl');
 263     }
 264
 265     // Revist. Should probably do an hAtom pattern here
 266     function showSiteNotice()
 267     {
 268         $text = common_config('site', 'notice');
 269         if ($text) {
 270             $this->elementStart('dl', array('id' => 'site_notice',
 271                                             'class' => 'system_notice'));
 272             $this->element('dt', null, _('Site notice'));
 273             $this->element('dd', null, $text);
 274             $this->elementEnd('dl');
 275         }
 276     }
 277
 278     // MAY overload if no notice form needed... or direct message box????
 279
 280     function showNoticeForm()
 281     {
 282         $notice_form = new NoticeForm($this);
 283         $notice_form->show();
 284     }
 285
 286     function showCore()
 287     {
 288         $this->elementStart('div', array('class' => 'core'));
 289         $this->showLocalNav();
 290         $this->showContentBlock();
 291         $this->showAside();
 292         $this->elementEnd('div');
 293     }
 294
 295     // SHOULD overload
 296
 297     function showLocalNav()
 298     {
 299         // does nothing by default
 300     }
 301
 302     function showContentBlock()
 303     {
 304         $this->elementStart('div', array('id' => 'content'));
 305         $this->showPageTitle();
 306         $this->showPageNotice();
 307         $this->showContent();
 308         $this->elementEnd('div');
 309     }
 310
 311     function showPageTitle() {
 312         $this->element('h1', NULL, $this->title());
 313     }
 314
 315     // SHOULD overload (unless there's not a notice)
 316
 317     function showPageNotice()
 318     {
 319         $this->elementStart('dl', array('id' => 'page_notice',
 320                                         'class' => 'system_notice'));
 321         $this->element('dt', null, _('Page notice'));
 322         $this->elementStart('dd', null);
 323         // Output a bunch of paragraphs here
 324         $this->elementEnd('dd');
 325     }
 326
 327     // MUST overload
 328
 329     function showContent()
 330     {
 331         // show the actual content (forms, lists, whatever)
 332         $this->elementStart('div', array('id' => 'content_inner'));
 333         $this->elementEnd('div');
 334     }
 335
 336     function showAside()
 337     {
 338         $this->showExportData();
 339         $this->showSections();
 340     }
 341
 342     // MAY overload if there are feeds
 343
 344     function showExportData()
 345     {
 346         // is there structure to this?
 347         // list of (visible!) feed links
 348         // can we reuse list of feeds from showFeeds() ?
 349     }
 350
 351     // SHOULD overload
 352
 353     function showSections() {
 354         // for each section, show it
 355     }
 356
 357     function showFooter()
 358     {
 359         $this->elementStart('div', array('id' => 'footer'));
 360         $this->showSecondaryNav();
 361         $this->showLicenses();
 362         $this->elementEnd('div');
 363     }
 364
 365     function showSecondaryNav()
 366     {
 367         $this->elementStart('ul', array('id' => 'nav_sub'));
 368         $this->menuItem(common_local_url('doc', array('title' => 'help')),
 369                          _('Help'));
 370         $this->menuItem(common_local_url('doc', array('title' => 'about')),
 371                          _('About'));
 372         $this->menuItem(common_local_url('doc', array('title' => 'faq')),
 373                          _('FAQ'));
 374         $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
 375                          _('Privacy'));
 376         $this->menuItem(common_local_url('doc', array('title' => 'source')),
 377                          _('Source'));
 378         $this->menuItem(common_local_url('doc', array('title' => 'contact')),
 379                          _('Contact'));
 380         $this->elementEnd('ul');
 381     }
 382
 383     function showLicenses()
 384     {
 385         $this->elementStart('dl', array('id' => 'licenses'));
 386         $this->showLaconicaLicense();
 387         $this->showContentLicense();
 388         $this->elementEnd('dl');
 389     }
 390
 391     function showLaconicaLicense()
 392     {
 393         $this->element('dt', array('id' => 'site_laconica_license'), _('Laconica software license'));
 394         $this->elementStart('dd', null);
 395         if (common_config('site', 'broughtby')) {
 396             $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
 397         } else {
 398             $instr = _('**%%site.name%%** is a microblogging service. ');
 399         }
 400         $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);
 401         $output = common_markup_to_html($instr);
 402         $this->raw($output);
 403         $this->elementEnd('dd');
 404         // do it
 405     }
 406
 407     function showContentLicense()
 408     {
 409         $this->element('dt', array('id' => 'site_content_license'), _('Laconica software license'));
 410         $this->elementStart('dd', array('id' => 'site_content_license_cc'));
 411         $this->elementStart('p');
 412         $this->text(_('Unless otherwise specified, contents of this site are copyright by the contributors and available under the '));
 413         $this->element('a', array('class' => 'license',
 414                                   'rel' => 'external license',
 415                                   'href' => $config['license']['url']),
 416                        $config['license']['title']);
 417         $this->text(_('. Contributors should be attributed by full name or nickname.'));
 418         $this->elementEnd('p');
 419         $this->element('img', array('id' => 'license_cc',
 420                                     'src' => $config['license']['image'],
 421                                     'alt' => $config['license']['title']));
 422         $this->elementEnd('dd');
 423     }
 424
 425     // For comparison with If-Last-Modified
 426     // If not applicable, return null
 427
 428     function last_modified()
 429     {
 430         return null;
 431     }
 432
 433     function etag()
 434     {
 435         return null;
 436     }
 437
 438     function is_readonly()
 439     {
 440         return false;
 441     }
 442
 443     function arg($key, $def=null)
 444     {
 445         if (array_key_exists($key, $this->args)) {
 446             return $this->args[$key];
 447         } else {
 448             return $def;
 449         }
 450     }
 451
 452     function trimmed($key, $def=null)
 453     {
 454         $arg = $this->arg($key, $def);
 455         return (is_string($arg)) ? trim($arg) : $arg;
 456     }
 457
 458     // Note: argarray ignored, since it's now passed in in prepare()
 459
 460     function handle($argarray=null)
 461     {
 462
 463         $lm = $this->last_modified();
 464         $etag = $this->etag();
 465
 466         if ($etag) {
 467             header('ETag: ' . $etag);
 468         }
 469
 470         if ($lm) {
 471             header('Last-Modified: ' . date(DATE_RFC1123, $lm));
 472             $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
 473             if ($if_modified_since) {
 474                 $ims = strtotime($if_modified_since);
 475                 if ($lm <= $ims) {
 476                     if (!$etag ||
 477                         $this->_has_etag($etag, $_SERVER['HTTP_IF_NONE_MATCH'])) {
 478                         header('HTTP/1.1 304 Not Modified');
 479                         // Better way to do this?
 480                         exit(0);
 481                     }
 482                 }
 483             }
 484         }
 485     }
 486
 487     function _has_etag($etag, $if_none_match)
 488     {
 489         return ($if_none_match) && in_array($etag, explode(',', $if_none_match));
 490     }
 491
 492     function boolean($key, $def=false)
 493     {
 494         $arg = strtolower($this->trimmed($key));
 495
 496         if (is_null($arg)) {
 497             return $def;
 498         } else if (in_array($arg, array('true', 'yes', '1'))) {
 499             return true;
 500         } else if (in_array($arg, array('false', 'no', '0'))) {
 501             return false;
 502         } else {
 503             return $def;
 504         }
 505     }
 506
 507     function server_error($msg, $code=500)
 508     {
 509         $action = $this->trimmed('action');
 510         common_debug("Server error '$code' on '$action': $msg", __FILE__);
 511         common_server_error($msg, $code);
 512     }
 513
 514     function client_error($msg, $code=400)
 515     {
 516         $action = $this->trimmed('action');
 517         common_debug("User error '$code' on '$action': $msg", __FILE__);
 518         common_user_error($msg, $code);
 519     }
 520
 521     function self_url()
 522     {
 523         $action = $this->trimmed('action');
 524         $args = $this->args;
 525         unset($args['action']);
 526         foreach (array_keys($_COOKIE) as $cookie) {
 527             unset($args[$cookie]);
 528         }
 529         return common_local_url($action, $args);
 530     }
 531
 532     function nav_menu($menu)
 533     {
 534         $action = $this->trimmed('action');
 535         $this->elementStart('ul', array('id' => 'nav_views'));
 536         foreach ($menu as $menuaction => $menudesc) {
 537             $this->menuItem(common_local_url($menuaction,
 538                                               isset($menudesc[2]) ? $menudesc[2] : null),
 539                              $menudesc[0],
 540                              $menudesc[1],
 541                              $action == $menuaction);
 542         }
 543         $this->elementEnd('ul');
 544     }
 545
 546     function common_show_header($pagetitle, $callable=null, $data=null, $headercall=null)
 547     {
 548         global $config, $xw;
 549         global $action; /* XXX: kind of cheating here. */
 550
 551         common_start_html();
 552
 553         $this->elementStart('head');
 554
 555         if ($callable) {
 556             if ($data) {
 557                 call_user_func($callable, $data);
 558             } else {
 559                 call_user_func($callable);
 560             }
 561         }
 562         $this->elementEnd('head');
 563         $this->elementStart('body', $action);
 564         $this->elementStart('div', array('id' => 'wrap'));
 565         $this->elementStart('div', array('id' => 'content'));
 566     }
 567
 568     // Added @id to li for some control.
 569     // XXX: We might want to move this to htmloutputter.php
 570
 571     function menuItem($url, $text, $id=null, $title=null, $is_selected=false)
 572     {
 573         $lattrs = array();
 574         if ($is_selected) {
 575             $lattrs['class'] = 'current';
 576         }
 577
 578         $this->elementStart('li', (is_null($id)) ? null : array('id' => $id),  $lattrs);
 579         $attrs['href'] = $url;
 580         if ($title) {
 581             $attrs['title'] = $title;
 582         }
 583         $this->element('a', $attrs, $text);
 584         $this->elementEnd('li');
 585     }
 586
 587     // Does a little before-after block for next/prev page
 588
 589     function pagination($have_before, $have_after, $page, $action, $args=null)
 590     {
 591         if ($have_before || $have_after) {
 592             $this->elementStart('div', array('class' => 'pagination'));
 593             $this->elementStart('dl', null);
 594             $this->element('dt', null, _('Pagination'));
 595             $this->elementStart('dd', null);
 596             $this->elementStart('ul', array('class' => 'nav'));
 597         }
 598
 599         if ($have_before) {
 600             $pargs = array('page' => $page-1);
 601             $newargs = ($args) ? array_merge($args,$pargs) : $pargs;
 602
 603             $this->elementStart('li', array('class' => 'nav_prev'));
 604             $this->element('a', array('href' => common_local_url($action, $newargs), 'rel' => 'prev'),
 605                            _('After'));
 606             $this->elementEnd('li');
 607         }
 608
 609         if ($have_after) {
 610             $pargs = array('page' => $page+1);
 611             $newargs = ($args) ? array_merge($args,$pargs) : $pargs;
 612             $this->elementStart('li', array('class' => 'nav_next'));
 613             $this->element('a', array('href' => common_local_url($action, $newargs), 'rel' => 'next'),
 614                            _('Before'));
 615             $this->elementEnd('li');
 616         }
 617
 618         if ($have_before || $have_after) {
 619             $this->elementEnd('ul');
 620             $this->elementEnd('dd');
 621             $this->elementEnd('dl');
 622             $this->elementEnd('div');
 623         }
 624     }
 625 }