1 <?php rcs_id('$Id: transform.php,v 1.28 2001-12-06 18:41:21 dairiki Exp $');
2 require_once('lib/WikiPlugin.php');
4 define('WT_SIMPLE_MARKUP', 0);
5 define('WT_TOKENIZER', 1);
6 define('WT_MODE_MARKUP', 2);
8 define("ZERO_LEVEL", 0);
9 define("NESTED_LEVEL", 1);
13 // public variables (only meaningful during do_transform)
14 var $linenumber; // current linenumber
15 var $replacements; // storage for tokenized strings of current line
16 var $user_data; // can be used by the transformer functions
17 // to store miscellaneous data.
20 var $content; // wiki markup, array of lines
21 var $mode_set; // stores if a HTML mode for this line has been set
22 var $trfrm_func; // array of registered functions
23 var $stack; // stack for SetHTMLMode (keeping track of open tags)
26 function WikiTransform()
28 $this->trfrm_func = array();
29 $this->stack = new Stack;
33 * Register transformation functions
35 * This should be done *before* calling do_transform
37 * @param $type enum <dl>
38 * <dt>WT_MODE_MARKUP</dt>
39 * <dd>If one WT_MODE_MARKUP really sets the html mode, then
40 * all successive WT_MODE_MARKUP functions are skipped.</dd>
41 * <dt>WT_TOKENIZER</dt>
42 * <dd> The transformer function is called once for each match
43 * of the $regexp in the line. The matched values are tokenized
44 * to protect them from further transformation.</dd>
46 * @param $function string Function name
47 * @param $regexp string Required for WT_TOKENIZER functions.
48 * Optional for others. If given, the transformer function will only be
49 * called if the line matches the $regexp.
51 function register($type, $function, $regexp = false)
53 $this->trfrm_func[] = array ($type, $function, $regexp);
57 * Sets current mode like list, preformatted text, plain text
59 * Takes care of closing (open) tags
61 * This is a helper function used to keep track of what HTML
62 * block-level element we are currently processing.
63 * Block-level elements are things like paragraphs "<p>",
64 * pre-formatted text "<pre>", and the various list elements:
65 * "<ul>", "<ol>" and "<dl>". Now, SetHTMLMode is also used to
66 * keep track of "<li>" and "<dd>" elements. Note that some of these elements
67 * can be nested, while others can not. (In particular, according to
68 * the HTML 4.01 specification, a paragraph "<p>" element is not
69 * allowed to contain any other block-level elements. Also <pre>,
70 * <li>, <dt>, <dd>, <h1> ... have this same restriction.)
72 * SetHTMLMode generates whatever HTML is necessary to get us into
73 * the requested element type at the requested nesting level.
75 * @param $tag string Type of HTML element to open.
77 * If $tag is an array, $tag[0] gives the element type,
78 * and $tag[1] should be a hash containing attribute-value
79 * pairs for the element.
81 * If $tag is the empty string, all open elements (down to the
82 * level requested by $level) are closed. Use
83 * SetHTMLMode('',0) to close all open block-level elements.
85 * @param $level string Rrequested nesting level for current element.
86 * The nesting level for top level block is one (which is
88 * Nesting is arbitrary limited to 20 levels.
90 * @return string Returns the HTML markup to open the specified element.
92 function SetHTMLMode($tag, $level = 1)
102 $this->mode_set = 1; // in order to prevent other mode markup
107 // arbitrarily limit tag nesting
108 ExitWiki(gettext ("Lists nested too deep in SetHTMLOutputMode"));
111 if ($level <= $this->stack->cnt()) {
112 // $tag has fewer nestings (old: tabs) than stack,
113 // reduce stack to that tab count
114 while ($this->stack->cnt() > $level) {
115 $closetag = $this->stack->pop();
116 assert('$closetag != false');
117 $retvar .= "</$closetag>\n";
120 // if list type isn't the same,
121 // back up one more and push new tag
122 if ($tag && $tag != $this->stack->top()) {
123 $closetag = $this->stack->pop();
124 $retvar .= "</$closetag>" . StartTag($tag, $args) . "\n";
125 $this->stack->push($tag);
129 else {// $level > $this->stack->cnt()
130 // Test for and close top level elements which are not allowed to contain
131 // other block-level elements.
132 if ($this->stack->cnt() == 1 and
133 preg_match('/^(p|pre|h\d)$/i', $this->stack->top()))
135 $closetag = $this->stack->pop();
136 $retvar .= "</$closetag>";
139 // we add the diff to the stack
140 // stack might be zero
141 if ($this->stack->cnt() < $level) {
142 while ($this->stack->cnt() < $level - 1) {
143 // This is a bit of a hack:
145 // We're not nested deep enough, and have to make up some kind of block
146 // element to nest within.
148 // Currently, this can only happen for nested list element
149 // (either <ul> <ol> or <dl>). What we used to do here is
150 // to open extra lists of whatever type was requested.
151 // This would result in invalid HTML, since and list is
152 // not allowed to contain another list without first containing
153 // a list item. ("<ul><ul><li>Item</ul></ul>" is invalid.)
155 // So now, when we need extra list elements, we use a <dl>, and
156 // open it with an empty <dd>.
157 $el = $this->stack->cnt() % 2 == 0 ? 'dl' : 'dd';
159 $this->stack->push($el);
162 $retvar .= StartTag($tag, $args) . "\n";
163 $this->stack->push($tag);
167 return $this->token($retvar);
171 * Start new list item element.
173 * This closes any currently open list items at the specified level or deeper,
174 * then opens a new list item element.
176 * @param $list_type string Type of list element to open. This should
177 * be one of 'dl', 'ol', or 'ul'.
179 * @param $level integer Nesting depth for list item. Should be a positive integer.
181 * @param $defn_term string Definition term. Specifies the contents for the
182 * <dt> element. Only used if $list_type is 'dl'.
184 * @return string HTML
186 function ListItem($list_type, $level, $defn_term = '')
188 $retval = $this->SetHTMLMode($list_type, 2 * $level - 1);
189 if ($list_type == 'dl') {
190 $retval .= Element('dt', $defn_term);
191 $retval .= $this->SetHTMLMode('dd', 2 * $level);
194 $retval .= $this->SetHTMLMode('li', 2 * $level);
200 /** Work horse and main loop.
202 * This function does the transform from wiki markup to HTML.
204 * Contains main-loop and calls transformer functions.
206 * @param $html string HTML header (if needed, otherwise '')
207 * (This string is prepended to the return value.)
209 * @param $content array Wiki markup as array of lines
211 * @return string HTML
213 function do_transform($html, $content)
215 global $FieldSeparator;
217 $this->content = $content;
218 $this->replacements = array();
219 $this->user_data = array();
221 // Loop over all lines of the page and apply transformation rules
222 $numlines = count($this->content);
223 for ($lnum = 0; $lnum < $numlines; $lnum++)
226 $this->linenumber = $lnum;
227 $line = $this->content[$lnum];
229 // blank lines clear the current mode (to force new paragraph)
230 if (!strlen($line) || $line == "\r") {
231 $html .= $this->SetHTMLMode('', 0);
237 // main loop applying all registered functions
238 // tokenizers, markup, html mode, ...
239 // functions are executed in order of registering
240 for (reset($this->trfrm_func);
241 list($flags, $func, $regexp) = current($this->trfrm_func);
242 next($this->trfrm_func)) {
244 // if HTMLmode is already set then skip all following
245 // WT_MODE_MARKUP functions
246 if ($this->mode_set && ($flags & WT_MODE_MARKUP) != 0)
249 if (!empty($regexp) && !preg_match("/$regexp/", $line))
252 // call registered function
253 if (($flags & WT_TOKENIZER) != 0)
254 $line = $this->tokenize($line, $regexp, $func);
256 $line = $func($line, $this);
259 $html .= $line . "\n";
262 $html .= $this->SetHTMLMode('', 0);
264 return $this->untokenize($html);
266 // end do_transfrom()
268 // Register a new token.
269 function token($repl) {
270 global $FieldSeparator;
271 $tok = $FieldSeparator . sizeof($this->replacements) . $FieldSeparator;
272 $this->replacements[] = $repl;
276 // helper function which does actual tokenizing
277 function tokenize($str, $pattern, $func) {
278 // Find any strings in $str that match $pattern and
279 // store them in $orig, replacing them with tokens
280 // starting at number $ntokens - returns tokenized string
282 while (preg_match("/^(.*?)($pattern)/", $str, $matches)) {
283 $str = substr($str, strlen($matches[0]));
284 $new .= $matches[1] . $this->token($func($matches[2], $this));
289 function untokenize($line) {
290 global $FieldSeparator;
292 $chunks = explode ($FieldSeparator, "$line ");
294 for ($i = 1; $i < count($chunks); $i += 2)
297 $line .= $this->replacements[$tok] . $chunks[$i + 1];
302 // end class WikiTransform
305 //////////////////////////////////////////////////////////
307 function do_transform ($lines) {
308 global $WikiNameRegexp, $AllowedProtocols, $InterWikiLinkRegexp;
310 if (is_string($lines))
311 $lines = preg_split('/[ \t\r]*\n/', trim($lines));
314 $transform = new WikiTransform;
316 // register functions
317 // functions are applied in order of registering
319 $transform->register(WT_SIMPLE_MARKUP, 'wtm_plugin_link');
320 $transform->register(WT_MODE_MARKUP, 'wtm_plugin');
322 $transform->register(WT_TOKENIZER, 'wtt_doublebrackets', '\[\[');
323 $transform->register(WT_TOKENIZER, 'wtt_footnotes', '^\[\d+\]');
324 $transform->register(WT_TOKENIZER, 'wtt_footnoterefs', '\[\d+\]');
325 $transform->register(WT_TOKENIZER, 'wtt_bracketlinks', '\[.+?\]');
326 $transform->register(WT_TOKENIZER, 'wtt_urls',
327 "!?\b($AllowedProtocols):[^\s<>\[\]\"'()]*[^\s<>\[\]\"'(),.?]");
329 if (function_exists('wtt_interwikilinks')) {
330 $transform->register(WT_TOKENIZER, 'wtt_interwikilinks',
331 pcre_fix_posix_classes("!?(?<![[:alnum:]])") .
332 "$InterWikiLinkRegexp:[^\\s.,;?()]+");
334 $transform->register(WT_TOKENIZER, 'wtt_bumpylinks', "!?$WikiNameRegexp");
336 if (function_exists('wtm_table')) {
337 $transform->register(WT_MODE_MARKUP, 'wtm_table', '^\|');
339 $transform->register(WT_SIMPLE_MARKUP, 'wtm_htmlchars');
340 $transform->register(WT_SIMPLE_MARKUP, 'wtm_linebreak');
341 $transform->register(WT_SIMPLE_MARKUP, 'wtm_bold_italics');
343 $transform->register(WT_MODE_MARKUP, 'wtm_list_ul');
344 $transform->register(WT_MODE_MARKUP, 'wtm_list_ol');
345 $transform->register(WT_MODE_MARKUP, 'wtm_list_dl');
346 $transform->register(WT_MODE_MARKUP, 'wtm_preformatted');
347 $transform->register(WT_MODE_MARKUP, 'wtm_headings');
348 $transform->register(WT_MODE_MARKUP, 'wtm_hr');
349 $transform->register(WT_MODE_MARKUP, 'wtm_paragraph');
351 //$html = $transform->do_transform($html, $pagehash['content']);
352 return $transform->do_transform('', $lines);
356 Requirements for functions registered to WikiTransform:
358 Signature: function wtm_xxxx($line, &$transform)
360 $line ... current line containing wiki markup
361 (Note: it may already contain HTML from other transform functions)
362 &$transform ... WikiTransform object -- public variables of this
363 object and their use see above.
365 Functions have to return $line (doesn't matter if modified or not)
366 All conversion should take place inside $line.
368 Tokenizer functions should use $transform->replacements to store
369 the replacement strings. Also, they have to keep track of
370 $transform->tokencounter. See functions below. Back substitution
371 of tokenized strings is done by do_transform().
376 //////////////////////////////////////////////////////////
377 // Tokenizer functions
380 function wtt_doublebrackets($match, &$trfrm)
385 function wtt_footnotes($match, &$trfrm)
387 // FIXME: should this set HTML mode?
388 $ftnt = trim(substr($match,1,-1)) + 0;
390 $html = Element('br');
392 $fnlist = $trfrm->user_data['footnotes'][$ftnt];
393 if (!is_array($fnlist))
394 return $html . $fntext;
396 $trfrm->user_data['footnotes'][$ftnt] = 'footnote_seen';
398 while (list($k, $anchor) = each($fnlist))
400 $html .= Element("a", array("name" => "footnote-$ftnt",
401 "href" => "#$anchor",
402 "class" => "footnote-rev"),
409 function wtt_footnoterefs($match, &$trfrm)
411 $ftnt = trim(substr($match,1,-1)) + 0;
413 $footnote_definition_seen = false;
415 if (empty($trfrm->user_data['footnotes']))
416 $trfrm->user_data['footnotes'] = array();
417 if (empty($trfrm->user_data['footnotes'][$ftnt]))
418 $trfrm->user_data['footnotes'][$ftnt] = array();
419 else if (!is_array($trfrm->user_data['footnotes'][$ftnt]))
420 $footnote_definition_seen = true;
423 $args['href'] = "#footnote-$ftnt";
424 if (!$footnote_definition_seen)
426 $args['name'] = "footrev-$ftnt-" .
427 count($trfrm->user_data['footnotes'][$ftnt]);
428 $trfrm->user_data['footnotes'][$ftnt][] = $args['name'];
431 return Element('sup', array('class' => 'footnote'),
432 QElement("a", $args, "[$ftnt]"));
435 function wtt_bracketlinks($match, &$trfrm)
437 $link = ParseAndLink($match);
438 if (strstr($link['link'], "</form>")) {
439 // FIXME: BIG HACK: see note in wtm_plugin.
440 return "</p>" . $link['link'] . "<p>";
442 return $link["link"];
447 // replace all URL's with tokens, so we don't confuse them
448 // with Wiki words later. Wiki words in URL's break things.
449 // URLs preceeded by a '!' are not linked
450 function wtt_urls($match, &$trfrm)
452 if ($match[0] == "!")
453 return htmlspecialchars(substr($match,1));
454 return LinkURL($match);
457 // Link Wiki words (BumpyText)
458 // Wikiwords preceeded by a '!' are not linked
459 function wtt_bumpylinks($match, &$trfrm)
462 if ($match[0] == "!")
463 return htmlspecialchars(substr($match,1));
464 return LinkWikiWord($match);
467 // end of tokenizer functions
468 //////////////////////////////////////////////////////////
471 //////////////////////////////////////////////////////////
472 // basic simple markup functions
474 // escape HTML metachars
475 function wtm_htmlchars($line, &$transformer)
477 $line = str_replace('&', '&', $line);
478 $line = str_replace('>', '>', $line);
479 $line = str_replace('<', '<', $line);
484 // %%% are linebreaks
485 function wtm_linebreak($line, &$transformer) {
486 return str_replace('%%%', Element('br'), $line);
490 function wtm_bold_italics($line, &$transformer) {
491 $line = preg_replace('|(__)(.*?)(__)|', '<strong>\2</strong>', $line);
492 $line = preg_replace("|('')(.*?)('')|", '<em>\2</em>', $line);
498 //////////////////////////////////////////////////////////
499 // some tokens to be replaced by (dynamic) content
501 // FIXME: some plugins are in-line (maybe?) and some are block level.
502 // Here we treat them all as inline, which will probably
503 // generate some minorly invalid HTML in some cases.
505 function wtm_plugin_link($line, &$transformer) {
506 // FIXME: is this good syntax?
507 global $dbi, $request; // FIXME: make these non-global?
509 if (preg_match('/^(.*?)(<\?plugin-link\s+.*?\?>)(.*)$/', $line, $m)) {
510 list(, $prematch, $plugin_pi, $postmatch) = $m;
511 $loader = new WikiPluginLoader;
512 $html = $loader->expandPI($plugin_pi, $dbi, $request);
513 $line = $prematch . $transformer->token($html) . $postmatch;
518 function wtm_plugin($line, &$transformer) {
519 // FIXME: is this good syntax?
520 global $dbi, $request; // FIXME: make these non-global?
522 if (preg_match('/^<\?plugin(-form)?\s.*\?>\s*$/', $line)) {
523 $loader = new WikiPluginLoader;
524 $html = $loader->expandPI($line, $dbi, $request);
525 $line = $transformer->SetHTMLMode('', 0) . $transformer->token($html);
531 //////////////////////////////////////////////////////////
532 // mode markup functions
535 // tabless markup for unordered, ordered, and dictionary lists
536 // ul/ol list types can be mixed, so we only look at the last
537 // character. Changes e.g. from "**#*" to "###*" go unnoticed.
538 // and wouldn't make a difference to the HTML layout anyway.
540 // unordered lists <UL>: "*"
541 // has to be registereed before list OL
542 function wtm_list_ul($line, &$trfrm) {
543 if (preg_match("/^([#*;]*\*)[^#]/", $line, $matches)) {
544 $numtabs = strlen($matches[1]);
545 $line = preg_replace("/^([#*]*\*)/", '', $line);
546 $line = $trfrm->ListItem('ul', $numtabs) . $line;
551 // ordered lists <OL>: "#"
552 function wtm_list_ol($line, &$trfrm) {
553 if (preg_match("/^([#*;]*\#)/", $line, $matches)) {
554 $numtabs = strlen($matches[1]);
555 $line = preg_replace("/^([#*]*\#)/", "", $line);
556 $line = $trfrm->ListItem('ol', $numtabs) . $line;
562 // definition lists <DL>: ";text:text"
563 function wtm_list_dl($line, &$trfrm) {
564 if (preg_match("/^([#*;]*;)(.*?):(.*$)/", $line, $matches)) {
565 $numtabs = strlen($matches[1]);
566 $line = $trfrm->ListItem('dl', $numtabs, $matches[2]) . $matches[3];
571 // mode: preformatted text, i.e. <pre>
572 function wtm_preformatted($line, &$trfrm) {
573 if (preg_match("/^\s+/", $line)) {
574 $line = $trfrm->SetHTMLMode('pre') . $line;
579 // mode: headings, i.e. <h1>, <h2>, <h3>
580 // lines starting with !,!!,!!! are headings
581 // Patch from steph/tara <tellme@climbtothestars.org>:
582 // use <h2>, <h3>, <h4> since <h1> is page title.
583 function wtm_headings($line, &$trfrm) {
584 if (preg_match("/^(!{1,3})[^!]/", $line, $whichheading)) {
585 if($whichheading[1] == '!') $heading = 'h4';
586 elseif($whichheading[1] == '!!') $heading = 'h3';
587 elseif($whichheading[1] == '!!!') $heading = 'h2';
588 $line = preg_replace("/^!+/", '', $line);
589 $line = $trfrm->SetHTMLMode($heading) . $line;
595 function wtm_table($line, &$trfrm)
598 while (preg_match('/^(\|+)(v*)([<>^]?)([^|]*)/', $line, $m))
600 $line = substr($line, strlen($m[0]));
603 if (strlen($m[1]) > 1)
604 $td['colspan'] = strlen($m[1]);
605 if (strlen($m[2]) > 0)
606 $td['rowspan'] = strlen($m[2]) + 1;
609 $td['align'] = 'center';
610 else if ($m[3] == '>')
611 $td['align'] = 'right';
613 $td['align'] = 'left';
615 $row .= $trfrm->token(StartTag('td', $td) . " ");
617 $row .= $trfrm->token(" </td>");
619 assert(empty($line));
620 $row = $trfrm->token("<tr>") . $row . $trfrm->token("</tr>");
622 return $trfrm->SetHTMLMode(array('table',
623 array(//'align' => 'left',
630 // four or more dashes to <hr>
631 // Note this is of type WT_MODE_MARKUP becuase <hr>'s aren't
632 // allowed within <p>'s. (e.g. "<p><hr></p>" is not valid HTML.)
633 function wtm_hr($line, &$trfrm) {
634 if (preg_match('/^-{4,}(.*)$/', $line, $m)) {
635 $line = $trfrm->SetHTMLMode('', 0) . Element('hr');
637 $line .= $trfrm->SetHTMLMode('p') . $m[1];
642 // default mode: simple text paragraph
643 function wtm_paragraph($line, &$trfrm) {
644 $line = $trfrm->SetHTMLMode('p') . $line;
648 // (c-file-style: "gnu")
653 // c-hanging-comment-ender-p: nil
654 // indent-tabs-mode: nil