4 * Copyright 1999,2000,2001,2002,2004 $ThePhpWikiProgrammingTeam
6 * This file is part of PhpWiki.
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.
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.
18 * You should have received a copy of the GNU General Public License along
19 * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 // Moved to IniConfig and config-default.ini
24 // Define ENABLE_RAW_HTML to false (in config.ini) to disable the RawHtml
27 if (!defined('ENABLE_RAW_HTML'))
28 define('ENABLE_RAW_HTML', true);
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);
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
47 * Provide for raw HTML within wiki pages.
49 class WikiPlugin_RawHtml
52 function getDescription()
54 return _("Provide for raw HTML within wiki pages.");
57 function getDefaultArguments()
62 function managesValidators()
64 // The plugin output will only change if the plugin
65 // invocation (page text) changes --- so the necessary
66 // validators have already been handled by displayPage.
70 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."));
76 return $this->error("$basepage unset?");
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.",
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.
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")
99 return HTML::raw($argstr);
102 // From http://chxo.com/scripts/safe_html-test.php
103 // safe_html by Chris Snyder (csnyder@chxo.com) for http://pcoms.net
104 // - Huge thanks to James Wetterau for testing and feedback!
107 Copyright 2003 Chris Snyder. All rights reserved.
109 Redistribution and use in source and binary forms, with or without modification,
110 are permitted provided that the following conditions are met:
112 1. Redistributions of source code must retain the above copyright
113 notice, this list of conditions and the following disclaimer.
115 2. Redistributions in binary form must reproduce the above
116 copyright notice, this list of conditions and the following
117 disclaimer in the documentation and/or other materials provided
118 with the distribution.
120 THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
121 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
122 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
123 AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
124 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
125 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
126 OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
127 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
128 OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
129 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
133 set of functions for sanitizing user input:
134 keeps "friendly" tags but strips javascript events and style attributes
135 closes any open comment tags
136 closes any open HTML tags - results may not be valid HTML, but
137 at least they will keep the rest of the page from breaking
139 treats the following as malicious conditions and returns text stripped
141 any instances of ='javascript:
142 event or style attributes remaining after initial replacement
145 function strip_attributes($html, $attrs)
147 if (!is_array($attrs)) {
148 $array = array("$attrs");
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";
160 $html = preg_replace($search, "", $html);
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);
173 function safe_html($html, $allowedtags = "")
175 $version = "safe_html.php/0.4";
177 // anything with ="javascript: is right out -- strip all tags and return if found
178 $pattern = "/=\s*\S+script:\S+/Ui";
179 if (preg_match($pattern, $html)) {
180 $html = strip_tags($html);
184 // 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
185 if ($allowedtags == "") {
186 $allowedtags = array("p" => 1, "br" => 0, "a" => 1, "img" => 0, "li" => 1,
187 "ol" => 1, "ul" => 1, "b" => 1, "i" => 1, "em" => 1, "strong" => 1, "del" => 1, "ins" => 1,
188 "sub" => 1, "sup" => 1, "u" => 1, "blockquote" => 1, "pre" => 1, "hr" => 0,
189 "table" => 1, "thead" => 1, "tfoot" => 1, "tbody" => 1, "tr" => 1, "td" => 1, "th" => 1,
191 } elseif (!is_array($allowedtags)) {
192 $array = array("$allowedtags");
194 $allowedtags = $array;
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()
200 foreach ($allowedtags AS $tag => $closeit) {
201 $stripallowed .= "<$tag>";
204 //print "Stripallowed: $stripallowed -- ".print_r($allowedtags,1);
205 $html = strip_tags($html, $stripallowed);
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);
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));
223 // close any open <!--'s and identify version just in case
224 $html .= "<!-- $version -->";
233 // c-hanging-comment-ender-p: nil
234 // indent-tabs-mode: nil