lib/htmloutputter.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Low-level generator for HTML
   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  Output
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @author    Sarven Capadisli <csarven@status.net>
  26  * @copyright 2008 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET') && !defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 require_once INSTALLDIR.'/lib/xmloutputter.php';
  36
  37 // Can include XHTML options but these are too fragile in practice.
  38 define('PAGE_TYPE_PREFS', 'text/html');
  39
  40 /**
  41  * Low-level generator for HTML
  42  *
  43  * Abstracts some of the code necessary for HTML generation. Especially
  44  * has methods for generating HTML form elements. Note that these have
  45  * been created kind of haphazardly, not with an eye to making a general
  46  * HTML-creation class.
  47  *
  48  * @category Output
  49  * @package  StatusNet
  50  * @author   Evan Prodromou <evan@status.net>
  51  * @author   Sarven Capadisli <csarven@status.net>
  52  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  53  * @link     http://status.net/
  54  *
  55  * @see      Action
  56  * @see      XMLOutputter
  57  */
  58
  59 class HTMLOutputter extends XMLOutputter
  60 {
  61     /**
  62      * Constructor
  63      *
  64      * Just wraps the XMLOutputter constructor.
  65      *
  66      * @param string  $output URI to output to, default = stdout
  67      * @param boolean $indent Whether to indent output, default true
  68      */
  69
  70     function __construct($output='php://output', $indent=null)
  71     {
  72         parent::__construct($output, $indent);
  73     }
  74
  75     /**
  76      * Start an HTML document
  77      *
  78      * If $type isn't specified, will attempt to do content negotiation.
  79      *
  80      * Attempts to do content negotiation for language, also.
  81      *
  82      * @param string $type MIME type to use; default is to do negotation.
  83      *
  84      * @todo extract content negotiation code to an HTTP module or class.
  85      *
  86      * @return void
  87      */
  88
  89     function startHTML($type=null)
  90     {
  91         if (!$type) {
  92             $httpaccept = isset($_SERVER['HTTP_ACCEPT']) ?
  93               $_SERVER['HTTP_ACCEPT'] : null;
  94
  95             // XXX: allow content negotiation for RDF, RSS, or XRDS
  96
  97             $cp = common_accept_to_prefs($httpaccept);
  98             $sp = common_accept_to_prefs(PAGE_TYPE_PREFS);
  99
 100             $type = common_negotiate_type($cp, $sp);
 101
 102             if (!$type) {
 103                 // TRANS: Client exception 406
 104                 throw new ClientException(_('This page is not available in a '.
 105                                             'media type you accept'), 406);
 106             }
 107         }
 108
 109         header('Content-Type: '.$type);
 110
 111         // Output anti-framing headers to prevent clickjacking (respected by newer
 112         // browsers).
 113         if (common_config('javascript', 'bustframes')) {
 114             header('X-XSS-Protection: 1; mode=block'); // detect XSS Reflection attacks
 115             header('X-Frame-Options: SAMEORIGIN'); // no rendering if origin mismatch
 116         }
 117
 118         $this->extraHeaders();
 119         if (preg_match("/.*\/.*xml/", $type)) {
 120             // Required for XML documents
 121             $this->startXML();
 122         }
 123         $this->xw->writeDTD('html',
 124                             '-//W3C//DTD XHTML 1.0 Strict//EN',
 125                             'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
 126
 127         $language = $this->getLanguage();
 128
 129         $attrs = array(
 130             'xmlns' => 'http://www.w3.org/1999/xhtml',
 131             'xml:lang' => $language,
 132             'lang' => $language
 133         );
 134
 135         if (Event::handle('StartHtmlElement', array($this, &$attrs))) {
 136             $this->elementStart('html', $attrs);
 137             Event::handle('EndHtmlElement', array($this, &$attrs));
 138         }
 139     }
 140
 141     function getLanguage()
 142     {
 143         // FIXME: correct language for interface
 144         return common_language();
 145     }
 146
 147     /**
 148     *  Ends an HTML document
 149     *
 150     *  @return void
 151     */
 152     function endHTML()
 153     {
 154         $this->elementEnd('html');
 155         $this->endXML();
 156     }
 157
 158     /**
 159     *  To specify additional HTTP headers for the action
 160     *
 161     *  @return void
 162     */
 163     function extraHeaders()
 164     {
 165         // Needs to be overloaded
 166     }
 167
 168     /**
 169      * Output an HTML text input element
 170      *
 171      * Despite the name, it is specifically for outputting a
 172      * text input element, not other <input> elements. It outputs
 173      * a cluster of elements, including a <label> and an associated
 174      * instructions span.
 175      *
 176      * If $attrs['type'] does not exist it will be set to 'text'.
 177      *
 178      * @param string $id           element ID, must be unique on page
 179      * @param string $label        text of label for the element
 180      * @param string $value        value of the element, default null
 181      * @param string $instructions instructions for valid input
 182      * @param string $name         name of the element; if null, the id will
 183      *                             be used
 184      * @param bool   $required     HTML5 required attribute (exclude when false)
 185      * @param array  $attrs        Initial attributes manually set in an array (overwritten by previous options)
 186      *
 187      * @todo add a $maxLength parameter
 188      * @todo add a $size parameter
 189      *
 190      * @return void
 191      */
 192
 193     function input($id, $label, $value=null, $instructions=null, $name=null, $required=false, array $attrs=array())
 194     {
 195         $this->element('label', array('for' => $id), $label);
 196         if (!array_key_exists('type', $attrs)) {
 197             $attrs['type'] = 'text';
 198         }
 199         $attrs['id'] = $id;
 200         $attrs['name'] = is_null($name) ? $id : $name;
 201         if (!is_null($value)) { // value can be 0 or ''
 202             $attrs['value'] = $value;
 203         }
 204         if (!empty($required)) {
 205             $attrs['required'] = 'required';
 206         }
 207         $this->element('input', $attrs);
 208         if ($instructions) {
 209             $this->element('p', 'form_guide', $instructions);
 210         }
 211     }
 212
 213     /**
 214      * output an HTML checkbox and associated elements
 215      *
 216      * Note that the value is default 'true' (the string), which can
 217      * be used by Action::boolean()
 218      *
 219      * @param string $id           element ID, must be unique on page
 220      * @param string $label        text of label for the element
 221      * @param string $checked      if the box is checked, default false
 222      * @param string $instructions instructions for valid input
 223      * @param string $value        value of the checkbox, default 'true'
 224      * @param string $disabled     show the checkbox disabled, default false
 225      *
 226      * @return void
 227      *
 228      * @todo add a $name parameter
 229      */
 230
 231     function checkbox($id, $label, $checked=false, $instructions=null,
 232                       $value='true', $disabled=false)
 233     {
 234         $attrs = array('name' => $id,
 235                        'type' => 'checkbox',
 236                        'class' => 'checkbox',
 237                        'id' => $id);
 238         if ($value) {
 239             $attrs['value'] = $value;
 240         }
 241         if ($checked) {
 242             $attrs['checked'] = 'checked';
 243         }
 244         if ($disabled) {
 245             $attrs['disabled'] = 'true';
 246         }
 247         $this->element('input', $attrs);
 248         $this->text(' ');
 249         $this->element('label', array('class' => 'checkbox',
 250                                       'for' => $id),
 251                        $label);
 252         $this->text(' ');
 253         if ($instructions) {
 254             $this->element('p', 'form_guide', $instructions);
 255         }
 256     }
 257
 258     /**
 259      * output an HTML combobox/select and associated elements
 260      *
 261      * $content is an array of key-value pairs for the dropdown, where
 262      * the key is the option value attribute and the value is the option
 263      * text. (Careful on the overuse of 'value' here.)
 264      *
 265      * @param string $id           element ID, must be unique on page
 266      * @param string $label        text of label for the element
 267      * @param array  $content      options array, value => text
 268      * @param string $instructions instructions for valid input
 269      * @param string $blank_select whether to have a blank entry, default false
 270      * @param string $selected     selected value, default null
 271      *
 272      * @return void
 273      *
 274      * @todo add a $name parameter
 275      */
 276
 277     function dropdown($id, $label, $content, $instructions=null,
 278                       $blank_select=false, $selected=null)
 279     {
 280         $this->element('label', array('for' => $id), $label);
 281         $this->elementStart('select', array('id' => $id, 'name' => $id));
 282         if ($blank_select) {
 283             $this->element('option', array('value' => ''));
 284         }
 285         foreach ($content as $value => $option) {
 286             if ($value == $selected) {
 287                 $this->element('option', array('value' => $value,
 288                                                'selected' => 'selected'),
 289                                $option);
 290             } else {
 291                 $this->element('option', array('value' => $value), $option);
 292             }
 293         }
 294         $this->elementEnd('select');
 295         if ($instructions) {
 296             $this->element('p', 'form_guide', $instructions);
 297         }
 298     }
 299
 300     /**
 301      * output an HTML hidden element
 302      *
 303      * $id is re-used as name
 304      *
 305      * @param string $id    element ID, must be unique on page
 306      * @param string $value hidden element value, default null
 307      * @param string $name  name, if different than ID
 308      *
 309      * @return void
 310      */
 311
 312     function hidden($id, $value, $name=null)
 313     {
 314         $this->element('input', array('name' => $name ?: $id,
 315                                       'type' => 'hidden',
 316                                       'id' => $id,
 317                                       'value' => $value));
 318     }
 319
 320     /**
 321      * output an HTML password input and associated elements
 322      *
 323      * @param string $id           element ID, must be unique on page
 324      * @param string $label        text of label for the element
 325      * @param string $instructions instructions for valid input
 326      *
 327      * @return void
 328      *
 329      * @todo add a $name parameter
 330      */
 331
 332     function password($id, $label, $instructions=null)
 333     {
 334         $this->element('label', array('for' => $id), $label);
 335         $attrs = array('name' => $id,
 336                        'type' => 'password',
 337                        'class' => 'password',
 338                        'id' => $id);
 339         $this->element('input', $attrs);
 340         if ($instructions) {
 341             $this->element('p', 'form_guide', $instructions);
 342         }
 343     }
 344
 345     /**
 346      * output an HTML submit input and associated elements
 347      *
 348      * @param string $id    element ID, must be unique on page
 349      * @param string $label text of the button
 350      * @param string $cls   class of the button, default 'submit'
 351      * @param string $name  name, if different than ID
 352      * @param string $title  title text for the submit button
 353      *
 354      * @return void
 355      *
 356      * @todo add a $name parameter
 357      */
 358
 359     function submit($id, $label, $cls='submit', $name=null, $title=null)
 360     {
 361         $this->element('input', array('type' => 'submit',
 362                                       'id' => $id,
 363                                       'name'  => $name ?: $id,
 364                                       'class' => $cls,
 365                                       'value' => $label,
 366                                       'title' => $title));
 367     }
 368
 369     /**
 370      * output a script (almost always javascript) tag
 371      *
 372      * @param string $src          relative or absolute script path
 373      * @param string $type         'type' attribute value of the tag
 374      *
 375      * @return void
 376      */
 377     function script($src, $type='text/javascript')
 378     {
 379         if (Event::handle('StartScriptElement', array($this,&$src,&$type))) {
 380
 381             $url = parse_url($src);
 382
 383             if (empty($url['scheme']) && empty($url['host']) && empty($url['query']) && empty($url['fragment'])) {
 384
 385                 // XXX: this seems like a big assumption
 386
 387                 if (strpos($src, 'plugins/') === 0 || strpos($src, 'local/') === 0) {
 388
 389                     $src = common_path($src, StatusNet::isHTTPS()) . '?version=' . GNUSOCIAL_VERSION;
 390
 391                 } else {
 392
 393                     if (StatusNet::isHTTPS()) {
 394
 395                         $sslserver = common_config('javascript', 'sslserver');
 396
 397                         if (empty($sslserver)) {
 398                             if (is_string(common_config('site', 'sslserver')) &&
 399                                 mb_strlen(common_config('site', 'sslserver')) > 0) {
 400                                 $server = common_config('site', 'sslserver');
 401                             } else if (common_config('site', 'server')) {
 402                                 $server = common_config('site', 'server');
 403                             }
 404                             $path   = common_config('site', 'path') . '/js/';
 405                         } else {
 406                             $server = $sslserver;
 407                             $path   = common_config('javascript', 'sslpath');
 408                             if (empty($path)) {
 409                                 $path = common_config('javascript', 'path');
 410                             }
 411                         }
 412
 413                         $protocol = 'https';
 414
 415                     } else {
 416
 417                         $path = common_config('javascript', 'path');
 418
 419                         if (empty($path)) {
 420                             $path = common_config('site', 'path') . '/js/';
 421                         }
 422
 423                         $server = common_config('javascript', 'server');
 424
 425                         if (empty($server)) {
 426                             $server = common_config('site', 'server');
 427                         }
 428
 429                         $protocol = 'http';
 430                     }
 431
 432                     if ($path[strlen($path)-1] != '/') {
 433                         $path .= '/';
 434                     }
 435
 436                     if ($path[0] != '/') {
 437                         $path = '/'.$path;
 438                     }
 439
 440                     $src = $protocol.'://'.$server.$path.$src . '?version=' . GNUSOCIAL_VERSION;
 441                 }
 442             }
 443
 444             $this->element('script', array('type' => $type,
 445                                            'src' => $src),
 446                            ' ');
 447
 448             Event::handle('EndScriptElement', array($this,$src,$type));
 449         }
 450     }
 451
 452     /**
 453      * output a script (almost always javascript) tag with inline
 454      * code.
 455      *
 456      * @param string $code         code to put in the script tag
 457      * @param string $type         'type' attribute value of the tag
 458      *
 459      * @return void
 460      */
 461
 462     function inlineScript($code, $type='text/javascript')
 463     {
 464         if(Event::handle('StartInlineScriptElement', array($this,&$code,&$type))) {
 465             $this->elementStart('script', array('type' => $type));
 466             if($type == 'text/javascript') {
 467                 $this->raw('/*<![CDATA[*/ '); // XHTML compat
 468             }
 469             $this->raw($code);
 470             if($type == 'text/javascript') {
 471                 $this->raw(' /*]]>*/'); // XHTML compat
 472             }
 473             $this->elementEnd('script');
 474             Event::handle('EndInlineScriptElement', array($this,$code,$type));
 475         }
 476     }
 477
 478     /**
 479      * output a css link
 480      *
 481      * @param string $src     relative path within the theme directory, or an absolute path
 482      * @param string $theme        'theme' that contains the stylesheet
 483      * @param string media         'media' attribute of the tag
 484      *
 485      * @return void
 486      */
 487     function cssLink($src,$theme=null,$media=null)
 488     {
 489         if(Event::handle('StartCssLinkElement', array($this,&$src,&$theme,&$media))) {
 490             $url = parse_url($src);
 491             if( empty($url['scheme']) && empty($url['host']) && empty($url['query']) && empty($url['fragment']))
 492             {
 493                 if(file_exists(Theme::file($src,$theme))){
 494                    $src = Theme::path($src, $theme);
 495                 }else{
 496                     $src = common_path($src, StatusNet::isHTTPS());
 497                 }
 498                 $src.= '?version=' . GNUSOCIAL_VERSION;
 499             }
 500             $this->element('link', array('rel' => 'stylesheet',
 501                                     'type' => 'text/css',
 502                                     'href' => $src,
 503                                     'media' => $media));
 504             Event::handle('EndCssLinkElement', array($this,$src,$theme,$media));
 505         }
 506     }
 507
 508     /**
 509      * output a style (almost always css) tag with inline
 510      * code.
 511      *
 512      * @param string $code         code to put in the style tag
 513      * @param string $type         'type' attribute value of the tag
 514      * @param string $media        'media' attribute value of the tag
 515      *
 516      * @return void
 517      */
 518
 519     function style($code, $type = 'text/css', $media = null)
 520     {
 521         if(Event::handle('StartStyleElement', array($this,&$code,&$type,&$media))) {
 522             $this->elementStart('style', array('type' => $type, 'media' => $media));
 523             $this->raw($code);
 524             $this->elementEnd('style');
 525             Event::handle('EndStyleElement', array($this,$code,$type,$media));
 526         }
 527     }
 528
 529     /**
 530      * output an HTML textarea and associated elements
 531      *
 532      * @param string $id           element ID, must be unique on page
 533      * @param string $label        text of label for the element
 534      * @param string $content      content of the textarea, default none
 535      * @param string $instructions instructions for valid input
 536      * @param string $name         name of textarea; if null, $id will be used
 537      * @param int    $cols         number of columns
 538      * @param int    $rows         number of rows
 539      * @param bool   $required     HTML5 required attribute (exclude when false)
 540      *
 541      * @return void
 542      */
 543
 544     function textarea(
 545         $id,
 546         $label,
 547         $content      = null,
 548         $instructions = null,
 549         $name         = null,
 550         $cols         = null,
 551         $rows         = null,
 552         $required     = false
 553     ) {
 554         $this->element('label', array('for' => $id), $label);
 555         $attrs = array(
 556             'rows' => 3,
 557             'cols' => 40,
 558             'id' => $id
 559         );
 560         $attrs['name'] = is_null($name) ? $id : $name;
 561
 562         if ($cols != null) {
 563             $attrs['cols'] = $cols;
 564
 565         }
 566         if ($rows != null) {
 567             $attrs['rows'] = $rows;
 568         }
 569         $this->element(
 570             'textarea',
 571             $attrs,
 572             is_null($content) ? '' : $content
 573         );
 574         if ($instructions) {
 575             $this->element('p', 'form_guide', $instructions);
 576         }
 577     }
 578
 579    /**
 580     * Internal script to autofocus the given element on page onload.
 581     *
 582     * @param string $id element ID, must refer to an existing element
 583     *
 584     * @return void
 585     *
 586     */
 587     function autofocus($id)
 588     {
 589         $this->inlineScript(
 590                    ' $(document).ready(function() {'.
 591                    ' var el = $("#' . $id . '");'.
 592                    ' if (el.length) { el.focus(); }'.
 593                    ' });');
 594     }
 595 }