2 /*=====================================================================*\
3 || ###################################################################
4 || # Blue Static ISSO Framework
5 || # Copyright ©2002-[#]year[#] Blue Static
7 || # This program is free software; you can redistribute it and/or modify
8 || # it under the terms of the GNU General Public License as published by
9 || # the Free Software Foundation; version [#]gpl[#] of the License.
11 || # This program is distributed in the hope that it will be useful, but
12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
16 || # You should have received a copy of the GNU General Public License along
17 || # with this program; if not, write to the Free Software Foundation, Inc.,
18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
19 || ###################################################################
20 \*=====================================================================*/
22 require_once('ISSO/Functions.php');
27 * This class is a PHP implementation of John Gruber's Markdown text processing
28 * system. It is not a port of his Perl version, but rather a creation based
29 * on the rules outlined here: http://daringfireball.net/projects/markdown/.
32 * @copyright Copyright (c)2002 - [#]year[#], Blue Static
40 * Remove HTML rather than ignoring it?
43 public $removeHtml = false
;
46 * Map of HTML blocks extracted from the text
49 private $htmlBlockMap = array();
52 * The working parser text that at any given moment is only partially parsed
58 * HTML block element tags
61 private $htmlBockTags = array(
62 'p', 'div', 'blockquote',
63 'pre', 'table', 'form', 'ol',
64 'ul', 'h1', 'h2', 'h3', 'h4',
65 'h5', 'h6', 'iframe', 'script',
70 * Map of link IDs to their link
73 private $linkMap = array();
75 // ###################################################################
77 * Quick parsing function that uses the system defaults for parsing.
79 * @param string Original text
81 * @return string HTML output
83 public static function Parse($text)
85 $parser = new BSMarkdown();
86 return $parser->transform($text);
89 // ###################################################################
93 public function __construct()
95 $this->htmlBlockMap
= array();
99 // ###################################################################
101 * Transforms the Markdown text into XHTML with the parser's set options
103 * @param string Text to transform
105 * @return string HTML output
107 public function transform($text)
109 // reset the data arrays
110 $this->__construct();
112 // convert line breaks and remove empty lines of whitespace
113 $this->text
= BSFunctions
::ConvertLineBreaks($text);
114 $this->text
= preg_replace('/^\s*?$/m', '', $this->text
);
116 $this->_extractHtmlBlocks();
117 $this->_extractLinkMap();
119 $this->_convertHardLineBreaks();
120 $this->_convertAtxHeaders();
121 $this->_convertSetextHeaders();
122 $this->_convertHorizontalRules();
123 $this->_formatParagraphs();
124 $this->text
= $this->_expandHtmlBlocks($this->text
);
127 $this->_convertFloatingEntities();
132 // ###################################################################
134 * Description of the function
136 * @param string A string param
138 * @return integer Return value
140 private function _extractHtmlBlocks()
147 // find the first insance of a block tag
148 $regex = implode('|', $this->htmlBockTags
);
149 while ($start <= strlen($this->text
))
152 if (preg_match("/^<($regex)/i", substr($this->text
, $start)) === 1)
154 if (sizeof($nest) == 0)
156 $blockStart = $start;
158 array_push($nest, $start);
160 else if (preg_match("#^</($regex)>#i", substr($this->text
, $start), $matches) === 1)
163 if (sizeof($nest) == 0)
165 $block = substr($this->text
, $blockStart, $start - $blockStart +
strlen($matches[0]));
166 $hash = md5($block . microtime());
167 $this->htmlBlockMap
[$hash] = $block;
168 $this->text
= substr_replace($this->text
, $hash, $blockStart, strlen($block));
169 $start = $blockStart;
175 // ###################################################################
177 * Expands the hashed HTML blocks back into their originial form
179 private function _expandHtmlBlocks($text)
181 return str_replace(array_keys($this->htmlBlockMap
), array_values($this->htmlBlockMap
), $text);
184 // ###################################################################
186 * Extracts all links in the "[id]: link" form
188 public function _extractLinkMap()
190 $this->text
= preg_replace_callback('/\[(\w+)\]:\s*<?(\S+)>?(\s*(("|\')|\()(.*?)(\4|\)))?\n?/', array(&$this, '_extractLinkMapCallback'), $this->text
);
193 // ###################################################################
195 * Converts extracted link definitions into the map
197 * @param array Matches array
199 private function _extractLinkMapCallback($matches)
201 $this->linkMap
[$matches[1]] = array($matches[2], $matches[6]);
204 // ###################################################################
206 * Converts text surrounded by #sings to headers (## Heading 2)
208 private function _convertAtxHeaders()
210 $this->text
= preg_replace_callback('/^(\#{1,6})\s*(.+)(\s*\#+)?$/', array(&$this, '_convertAtxHeadersCallback'), $this->text
);
213 // ###################################################################
215 * Callback function for preg_replace() in _convertAtxHeaders()
217 * @param array Matches
219 private function _convertAtxHeadersCallback($matches)
221 // var_dump($matches);
222 $html = '<h' . strlen($matches[1]) . '>' . $this->_expandHtmlBlocks($matches[2]) . '</h' . strlen($matches[1]) . '>';
223 $hash = md5($html . microtime());
224 $this->htmlBlockMap
[$hash] = $html;
228 // ###################################################################
230 * Converts headers that are formed by underlines into headings
232 private function _convertSetextHeaders()
234 $this->text
= preg_replace_callback('/(.+)\n(-|=){1,}$/m', array(&$this, '_convertSetextHeadersCallback'), $this->text
);
237 // ###################################################################
239 * Callback function for _convertSetextHeaders(). This does the actual
240 * conversion and then hashes it into a block
242 * @param array Matches from the preg_replace_callback()
244 private function _convertSetextHeadersCallback($matches)
246 $text = $this->_expandHtmlBlocks($matches[1]);
247 if ($matches[2][0] == '=')
249 $text = '<h1>' . $text . '</h1>';
253 $text = '<h2>' . $text . '</h2>';
255 $hash = md5($text . microtime());
256 $this->htmlBlockMap
[$hash] = $text;
260 // ###################################################################
262 * Converts three stars or dashes (optionally separated by spaces) into
265 private function _convertHorizontalRules()
267 $hash = md5('<hr />' . microtime());
269 $this->text
= preg_replace('/((-|\*) ?){3,}/', $hash, $this->text
, -1, $count);
272 $this->htmlBlockMap
[$hash] = '<hr />';
276 // ###################################################################
278 * Wraps blocks into paragraphs
280 private function _formatParagraphs()
282 $blocks = preg_split('/\n{2,}/', $this->text
, -1, PREG_SPLIT_NO_EMPTY
);
283 foreach ($blocks AS $key => $value)
285 if (!isset($this->htmlBlockMap
[$value]))
287 $blocks[$key] = "<p>$value</p>";
291 $this->text
= implode("\n\n", $blocks);
294 // ###################################################################
296 * Converts two spaces followed by a new line with text on it to
297 * a hard line break (<br />)
299 private function _convertHardLineBreaks()
301 $this->text
= preg_replace('/ {2,}\n/m', " <br />\n", $this->text
);
304 // ###################################################################
306 * Converts all angle brackets and ampersands that are floating into
309 private function _convertFloatingEntities()
312 $this->text
= preg_replace('/&(?!#?x?[0-9a-z]+;)/i', '&', $this->text
);
314 // encode brackets who aren't followed by text
315 $this->text
= preg_replace('#<(?![/?a-z])#i', '<', $this->text
);
319 /*=====================================================================*\
320 || ###################################################################
323 || ###################################################################
324 \*=====================================================================*/