lib/plugin/RawHtml.php

   1 <?php // -*-php-*-
   2 // rcs_id('$Id$');
   3 /**
   4  * Copyright 1999,2000,2001,2002,2004 $ThePhpWikiProgrammingTeam
   5  *
   6  * This file is part of PhpWiki.
   7  *
   8  * PhpWiki is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * PhpWiki is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with PhpWiki; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 // Moved to IniConfig and config-default.ini
  24 // Define ENABLE_RAW_HTML to false (in config.ini) to disable the RawHtml
  25 // plugin completely
  26 /*
  27 if (!defined('ENABLE_RAW_HTML'))
  28     define('ENABLE_RAW_HTML', true);
  29 // must be locked
  30 if (!defined('ENABLE_RAW_HTML_LOCKEDONLY'))
  31     define('ENABLE_RAW_HTML_LOCKEDONLY', true);
  32 // sanitize to safe html code
  33 if (!defined('ENABLE_RAW_HTML_SAFE'))
  34     define('ENABLE_RAW_HTML_SAFE', true);
  35 */
  36
  37 /** We defined a better policy when to allow RawHtml:
  38  *   ENABLE_RAW_HTML_LOCKEDONLY:
  39  *  - Allowed if page is locked by ADMIN_USER.
  40  *   ENABLE_RAW_HTML_SAFE:
  41  *  - Allow some sort of "safe" html tags and attributes.
  42  *    Unsafe attributes are automatically stripped. (Experimental!)
  43  *    See http://phpwiki.sourceforge.net/phpwiki/allowing%20safe%20HTML
  44  */
  45
  46 /**
  47  * A plugin to provide for raw HTML within wiki pages.
  48  */
  49 class WikiPlugin_RawHtml
  50 extends WikiPlugin
  51 {
  52     function getName () {
  53         return "RawHtml";
  54     }
  55
  56     function getDescription () {
  57         return _("A plugin to provide for raw HTML within wiki pages.");
  58     }
  59
  60     function getDefaultArguments() {
  61         return array();
  62     }
  63
  64     function managesValidators() {
  65         // The plugin output will only change if the plugin
  66         // invocation (page text) changes --- so the necessary
  67         // validators have already been handled by displayPage.
  68         return true;
  69     }
  70
  71     function run($dbi, $argstr, &$request, $basepage) {
  72         if (!defined('ENABLE_RAW_HTML') || ! ENABLE_RAW_HTML) {
  73             return $this->disabled(_("Raw HTML is disabled in this wiki."));
  74         }
  75         if (!$basepage) {
  76             return $this->error("$basepage unset?");
  77         }
  78
  79         $page = $request->getPage($basepage);
  80         if (ENABLE_RAW_HTML_LOCKEDONLY) {
  81             if (! $page->get('locked')) {
  82                 return $this->disabled(fmt("%s is only allowed in locked pages.",
  83                                            _("Raw HTML")));
  84             }
  85         }
  86         if (ENABLE_RAW_HTML_SAFE) {
  87             // check for javascript handlers (on*) and style tags with external urls. no javascript urls.
  88             // See also http://simon.incutio.com/archive/2003/02/23/safeHtmlChecker
  89             // But we should allow not only code semantic meaning,  presentational markup also.
  90
  91             // http://chxo.com/scripts/safe_html-test.php looks better
  92             $argstr = $this->safe_html($argstr);
  93             /*return $this->disabled(HTML(fmt("This %s plugin on %s is disabled because of unsafe HTML code. ",$this->getName(), $basepage),
  94                                         fmt("See PhpWiki:allowing%20safe%20HTML")
  95                                         ));
  96             */
  97         }
  98
  99         return HTML::raw($argstr);
 100     }
 101
 102
 103     // From http://chxo.com/scripts/safe_html-test.php
 104     // safe_html by Chris Snyder (csnyder@chxo.com) for http://pcoms.net
 105     //   - Huge thanks to James Wetterau for testing and feedback!
 106
 107 /*
 108 Copyright 2003 Chris Snyder. All rights reserved.
 109
 110 Redistribution and use in source and binary forms, with or without modification,
 111 are permitted provided that the following conditions are met:
 112
 113    1. Redistributions of source code must retain the above copyright
 114    notice, this list of conditions and the following disclaimer.
 115
 116    2. Redistributions in binary form must reproduce the above
 117    copyright notice, this list of conditions and the following
 118    disclaimer in the documentation and/or other materials provided
 119    with the distribution.
 120
 121 THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
 122 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 123 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 124 AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 125 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 126 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA, OR PROFITS;
 127 OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 128 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 129 OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 130 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 131 */
 132
 133 /*
 134  set of functions for sanitizing user input:
 135     keeps "friendly" tags but strips javascript events and style attributes
 136     closes any open comment tags
 137     closes any open HTML tags - results may not be valid HTML, but
 138         at least they will keep the rest of the page from breaking
 139
 140     treats the following as malicious conditions and returns text stripped
 141     of all html tags:
 142         any instances of ='javascript:
 143         event or style attributes remaining after initial replacement
 144 */
 145
 146     function strip_attributes ($html, $attrs) {
 147         if (!is_array($attrs)) {
 148             $array= array( "$attrs" );
 149             unset($attrs);
 150             $attrs= $array;
 151         }
 152
 153         foreach ($attrs AS $attribute) {
 154             // once for ", once for ', s makes the dot match linebreaks, too.
 155             $search[]= "/".$attribute.'\s*=\s*".+"/Uis';
 156             $search[]= "/".$attribute."\s*=\s*'.+'/Uis";
 157             // and once more for unquoted attributes
 158             $search[]= "/".$attribute."\s*=\s*\S+/i";
 159         }
 160         $html= preg_replace($search, "", $html);
 161
 162         // check for additional matches and strip all tags if found
 163         foreach ($search AS $pattern) {
 164             if (preg_match($pattern, $html)) {
 165                 $html= strip_tags($html);
 166                 break;
 167             }
 168         }
 169
 170         return $html;
 171     }
 172
 173     function safe_html ($html, $allowedtags="") {
 174         $version= "safe_html.php/0.4";
 175
 176         // anything with ="javascript: is right out -- strip all tags and return if found
 177         $pattern= "/=\s*\S+script:\S+/Ui";
 178         if (preg_match($pattern, $html)) {
 179             $html= strip_tags($html);
 180             return $html;
 181         }
 182
 183         // setup -- $allowedtags is an array of $tag=>$closeit pairs, where $tag is an HTML tag to allow and $closeit is 1 if the tag requires a matching, closing tag
 184         if ($allowedtags=="") {
 185             $allowedtags= array ( "p"=>1, "br"=>0, "a"=>1, "img"=>0, "li"=>1,
 186                 "ol"=>1, "ul"=>1, "b"=>1, "i"=>1, "em"=>1, "strong"=>1, "del"=>1, "ins"=>1,
 187                 "sub"=>1, "sup"=>1, "u"=>1, "blockquote"=>1, "pre"=>1, "hr"=>0,
 188                 "table"=>1, "thead"=>1, "tfoot"=>1, "tbody"=>1, "tr"=>1, "td"=>1, "th"=>1,
 189                 );
 190         }
 191         elseif (!is_array($allowedtags)) {
 192             $array= array( "$allowedtags" );
 193             unset($allowedtags);
 194             $allowedtags= $array;
 195         }
 196
 197         // there's some debate about this.. is strip_tags() better than rolling your own regex?
 198         // note: a bug in PHP 4.3.1 caused improper handling of ! in tag attributes when using strip_tags()
 199         $stripallowed= "";
 200         foreach ($allowedtags AS $tag=>$closeit) {
 201             $stripallowed.= "<$tag>";
 202         }
 203
 204         //print "Stripallowed: $stripallowed -- ".print_r($allowedtags,1);
 205         $html= strip_tags($html, $stripallowed);
 206
 207         // also, lets get rid of some pesky attributes that may be set on the remaining tags...
 208         $badattrs= array("on\w+", "style");
 209         $html= $this->strip_attributes($html, $badattrs);
 210
 211         // close html tags if necessary -- note that this WON'T be graceful formatting-wise, it just has to fix any maliciousness
 212         foreach ($allowedtags AS $tag=>$closeit) {
 213             if (!$closeit) continue;
 214             $patternopen= "/<$tag\b[^>]*>/Ui";
 215             $patternclose= "/<\/$tag\b[^>]*>/Ui";
 216             $totalopen= preg_match_all ( $patternopen, $html, $matches );
 217             $totalclose= preg_match_all ( $patternclose, $html, $matches2 );
 218             if ($totalopen>$totalclose) {
 219                 $html.= str_repeat("</$tag>", ($totalopen - $totalclose));
 220             }
 221         }
 222
 223         // close any open <!--'s and identify version just in case
 224         $html.= "<!-- $version -->";
 225         return $html;
 226     }
 227 }
 228
 229 // Local Variables:
 230 // mode: php
 231 // tab-width: 8
 232 // c-basic-offset: 4
 233 // c-hanging-comment-ender-p: nil
 234 // indent-tabs-mode: nil
 235 // End:
 236 ?>