4 * Copyright 1999, 2000, 2001, 2002 $ThePhpWikiProgrammingTeam
5 * Copyright 2009 Marc-Etienne Vargenau, Alcatel-Lucent
7 * This file is part of PhpWiki.
9 * PhpWiki is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * PhpWiki 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 General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 * A plugin that runs the highlight_string() function in PHP on it's
26 * arguments to pretty-print PHP code.
29 * <<PhpHighlight default='#FF0000' comment='#0000CC'
30 * code that should be highlighted
33 * You do not have to add '<?php' and '?>' to the code - the plugin
34 * does this automatically if you do not set wrap to 0.
36 * If you do set wrap to 0, then you'll have to start and stop PHP
37 * mode in the source yourself, or you wont see any highlighting. But
38 * you cannot use '<?php' and '?>' in the source, because this
39 * interferes with PhpWiki, you'll have use '< ?php' and '? >'
42 * Author: Martin Geisler <gimpster@gimpster.com>.
44 * Added ability to override colors defined in php.ini --Carsten Klapp
49 * testing~[badworkaround~];
51 * will swallow "[somearray]"
54 class WikiPlugin_PhpHighlight
57 // Four required functions in a WikiPlugin.
61 return _("PhpHighlight");
64 function getDescription()
66 return _("PHP syntax highlighting");
69 // Establish default values for each of this plugin's arguments.
70 function getDefaultArguments()
72 // TODO: results of ini_get() should be static for multiple
73 // invocations of plugin on one WikiPage
74 return array('wrap' => true,
75 'string' => ini_get("highlight.string"), //'#00CC00',
76 'comment' => ini_get("highlight.comment"), //'#FF9900',
77 'keyword' => ini_get("highlight.keyword"), //'#006600',
78 'bg' => ini_get("highlight.bg"), //'#FFFFFF',
79 'default' => ini_get("highlight.default"), //'#0000CC',
80 'html' => ini_get("highlight.html") //'#000000'
84 function run($dbi, $argstr, &$request, $basepage)
87 extract($this->getArgs($argstr, $request));
88 $source =& $this->source;
90 return HTML::div(array('class' => "error"),
91 "Please provide source code to PhpHighlight plugin");
94 $this->sanify_colors($string, $comment, $keyword, $bg, $default, $html);
95 $this->set_colors($string, $comment, $keyword, $bg, $default, $html);
98 /* Wrap with "<?php\n" and "\n?>" required by highlight_string(): */
99 $source = "<?php\n" . $source . "\n?>";
101 $source = str_replace(array('< ?php', '? >'),
102 array('<?php', '?>'), $source);
105 $str = highlight_string($source, true);
108 /* Remove "<?php\n" and "\n?>" again: */
109 $str = str_replace(array('<?php<br />', '?>'), '', $str);
112 /* Remove empty span tags. */
113 foreach (array($string, $comment, $keyword, $bg, $default, $html) as $color) {
114 $search = "<span style=\"color: $color\"></span>";
115 $str = str_replace($search, '', $str);
118 /* restore default colors in case of multiple invocations of this plugin on one page */
119 $this->restore_colors();
120 return new RawXml($str);
123 function handle_plugin_args_cruft(&$argstr, &$args)
125 $this->source = $argstr;
129 * Make sure color argument is valid
130 * See http://www.w3.org/TR/REC-html40/types.html#h-6.5
132 function sanify_colors($string, $comment, $keyword, $bg, $default, $html)
134 static $html4colors = array("black", "silver", "gray", "white",
135 "maroon", "red", "purple", "fuchsia",
136 "green", "lime", "olive", "yellow",
137 "navy", "blue", "teal", "aqua");
138 /* max(strlen("fuchsia"), strlen("#00FF00"), ... ) = 7 */
140 foreach (array($string, $comment, $keyword, $bg, $default, $html) as $color) {
141 $length = strlen($color);
142 //trigger_error(sprintf(_("DEBUG: color “%s” is length %d."), $color, $length), E_USER_NOTICE);
143 if (($length == 7 || $length == 4) && substr($color, 0, 1) == "#"
144 && "#" == preg_replace("/[a-fA-F0-9]/", "", $color)
146 //trigger_error(sprintf(_("DEBUG: color “%s” appears to be hex."), $color), E_USER_NOTICE);
147 // stop checking, ok to go
148 } elseif (($length < $MAXLEN + 1) && in_array($color, $html4colors)) {
149 //trigger_error(sprintf(_("DEBUG color “%s” appears to be an HTML 4 color."), $color), E_USER_NOTICE);
150 // stop checking, ok to go
152 trigger_error(sprintf(_("Invalid color: %s"),
153 $color), E_USER_NOTICE);
154 // FIXME: also change color to something valid like "black" or ini_get("highlight.xxx")
159 function set_colors($string, $comment, $keyword, $bg, $default, $html)
161 // set highlight colors
162 $this->oldstring = ini_set('highlight.string', $string);
163 $this->oldcomment = ini_set('highlight.comment', $comment);
164 $this->oldkeyword = ini_set('highlight.keyword', $keyword);
165 $this->oldbg = ini_set('highlight.bg', $bg);
166 $this->olddefault = ini_set('highlight.default', $default);
167 $this->oldhtml = ini_set('highlight.html', $html);
170 function restore_colors()
172 // restore previous default highlight colors
173 ini_set('highlight.string', $this->oldstring);
174 ini_set('highlight.comment', $this->oldcomment);
175 ini_set('highlight.keyword', $this->oldkeyword);
176 ini_set('highlight.bg', $this->oldbg);
177 ini_set('highlight.default', $this->olddefault);
178 ini_set('highlight.html', $this->oldhtml);
187 // c-hanging-comment-ender-p: nil
188 // indent-tabs-mode: nil