816417238ed909f3928dfa9dc1e2782fcce33aaa
[banana.git] / banana / message.func.inc.php
1 <?php
2 /********************************************************************************
3 * * banana/message.func.inc.php : function to display messages
4 * * ------------------------
5 * *
6 * * This file is part of the banana distribution
7 * * Copyright: See COPYING files that comes with this distribution
8 * ********************************************************************************/
9
10 require_once dirname(__FILE__) . '/mimepart.inc.php';
11 require_once dirname(__FILE__) . '/banana.inc.php';
12
13 // {{{ Plain Text Functions
14
15 function banana_isFlowed($line)
16 {
17 return ctype_space(substr($line, -1)) && $line != '-- ';
18 }
19
20 function banana_removeQuotes($line, &$quote_level, $strict = true)
21 {
22 $quote_level = 0;
23 if (empty($line)) {
24 return '';
25 }
26 while ($line{0} == '>') {
27 $line = substr($line, 1);
28 if (!$strict && ctype_space($line{0})) {
29 $line = substr($line, 1);
30 }
31 $quote_level++;
32 }
33 if (ctype_space($line{0})) {
34 $line = substr($line, 1);
35 }
36 return $line;
37 }
38
39 function banana_quote($line, $level, $mark = '>')
40 {
41 $lines = explode("\n", $line);
42 $quote = str_repeat($mark, $level);
43 foreach ($lines as &$line) {
44 $line = $quote . $line;
45 }
46 return implode("\n", $lines);
47 }
48
49 function banana_unflowed($text)
50 {
51 $lines = explode("\n", $text);
52 $text = '';
53 while (!is_null($line = array_shift($lines))) {
54 $level = 0;
55 $line = banana_removeQuotes($line, $level);
56 while (banana_isFlowed($line)) {
57 $lvl = 0;
58 if (empty($lines)) {
59 break;
60 }
61 $nl = $lines[0];
62 $nl = banana_removeQuotes($nl, $lvl);
63 if ($lvl == $level) {
64 $line .= $nl;
65 array_shift($lines);
66 } else {
67 break;
68 }
69 }
70 $text .= banana_quote($line, $level) . "\n";
71 }
72 return $text;
73 }
74
75 function banana_wordwrap($text, $quote_level)
76 {
77 if ($quote_level > 0) {
78 $length = Banana::$msgshow_wrap - $quote_level - 1;
79 return banana_quote(wordwrap($text, $length), $quote_level);
80
81 }
82 return wordwrap($text, Banana::$msgshow_wrap);
83 }
84
85 function banana_catchFormats($text)
86 {
87 $formatting = Array('/' => 'em', // match / first in order not to match closing markups </...> <> </>
88 '_' => 'u',
89 '*' => 'strong');
90 $url = Banana::$msgshow_url;
91 preg_match_all("/$url/ui", $text, $urls);
92 $text = str_replace($urls[0], "&&&urls&&&", $text);
93 foreach ($formatting as $limit=>$mark) {
94 $limit = preg_quote($limit, '/');
95 $text = preg_replace("/$limit\\b(.*?)\\b$limit/s",
96 "<$mark>\\1</$mark>", $text);
97 }
98 return preg_replace('/&&&urls&&&/e', 'array_shift($urls[0])', $text);
99 }
100
101 // {{{ URL Catcher tools
102
103 function banana__cutlink($link)
104 {
105 $link = banana_html_entity_decode($link, ENT_QUOTES);
106 if (strlen($link) > Banana::$msgshow_wrap) {
107 $link = substr($link, 0, Banana::$msgshow_wrap - 3) . "...";
108 }
109 return banana_htmlentities($link, ENT_QUOTES);
110 }
111
112 function banana__cleanURL($url)
113 {
114 $url = str_replace('@', '%40', $url);
115 if (strpos($url, '://') === false) {
116 $url = 'http://' . $url;
117 }
118 return '<a href="'.$url.'" title="'.$url.'">' . banana__cutlink($url) . '</a>';
119 }
120
121 function banana__catchMailLink($email)
122 {
123 $mid = '<' . $email . '>';
124 if (isset(Banana::$spool->ids[$mid])) {
125 return Banana::$page->makeLink(Array('group' => Banana::$group,
126 'artid' => Banana::$spool->ids[$mid],
127 'text' => $email));
128 } elseif (strpos($email, '$') !== false) {
129 return $email;
130 }
131 return '<a href="mailto:' . $email . '">' . $email . '</a>';
132 }
133
134 // }}}
135
136 function banana_catchURLs($text)
137 {
138 $url = Banana::$msgshow_url;
139
140 $res = preg_replace("/&(lt|gt|quot);/", " &\\1; ", $text);
141 $res = preg_replace("/$url/uie", "'\\1'.banana__cleanurl('\\2').'\\3'", $res);
142 $res = preg_replace('/(["\[])?(?:mailto:|news:)?([a-z0-9.\-+_\$]+@([\-.+_]?[a-z0-9])+)(["\]])?/ie',
143 "'\\1' . banana__catchMailLink('\\2') . '\\4'",
144 $res);
145 $res = preg_replace("/ &(lt|gt|quot); /", "&\\1;", $res);
146 return $res;
147 }
148
149 // {{{ Quotes catcher functions
150
151 function banana__replaceQuotes($text, $regexp)
152 {
153 return stripslashes(preg_replace("@(^|<pre>|\n)$regexp@i", '\1', $text));
154 }
155
156 // }}}
157
158 function banana_catchQuotes($res, $strict = true)
159 {
160 if ($strict) {
161 $regexp = "&gt;";
162 } else {
163 $regexp = "&gt; *";
164 }
165 while (preg_match("/(^|<pre>|\n)$regexp/i", $res)) {
166 $res = preg_replace("/(^|<pre>|\n)(($regexp.*(?:\n|$))+)/ie",
167 "'\\1</pre><blockquote><pre>'"
168 ." . banana__replaceQuotes('\\2', '$regexp')"
169 ." . '</pre></blockquote><pre>'",
170 $res);
171 }
172 return $res;
173 }
174
175 function banana_catchSignature($res)
176 {
177 $res = preg_replace("@<pre>-- ?\n@", "<pre>\n-- \n", $res);
178 $parts = preg_split("/\n-- ?\n/", $res);
179 $sign = '</pre><hr style="width: 100%; margin: 1em 0em; " /><pre>';
180 return join($sign, $parts);
181 }
182
183 function banana_plainTextToHtml($text, $strict = true)
184 {
185 $text = banana_htmlentities($text);
186 $text = banana_catchFormats($text);
187 $text = banana_catchURLs($text);
188 $text = banana_catchQuotes($text, $strict);
189 $text = banana_catchSignature($text);
190 return banana_cleanHtml('<pre>' . $text . '</pre>');
191 }
192
193 function banana_wrap($text, $base_level = 0, $strict = true)
194 {
195 $lines = explode("\n", $text);
196 $text = '';
197 $buffer = array();
198 $level = 0;
199 while (!is_null($line = array_shift($lines))) {
200 $lvl = 0;
201 $line = banana_removeQuotes($line, $lvl, $strict);
202 if($lvl != $level) {
203 if (!empty($buffer)) {
204 $text .= banana_wordwrap(implode("\n", $buffer), $level + $base_level) . "\n";
205 $buffer = array();
206 }
207 $level = $lvl;
208 }
209 $buffer[] = $line;
210 }
211 if (!empty($buffer)) {
212 $text .= banana_wordwrap(implode("\n", $buffer), $level + $base_level);
213 }
214 return $text;
215 }
216
217 function banana_formatPlainText(BananaMimePart &$part, $base_level = 0)
218 {
219 $text = $part->getText();
220 if ($part->isFlowed()) {
221 $text = banana_unflowed($text);
222 }
223 $text = banana_wrap($text, $base_level, $part->isFlowed());
224 return banana_plainTextToHtml($text, $part->isFlowed());
225 }
226
227 function banana_quotePlainText(BananaMimePart &$part)
228 {
229 $text = $part->getText();
230 if ($part->isFlowed()) {
231 $text = banana_unflowed($text);
232 }
233 return banana_wrap($text, 1);
234 }
235
236 // }}}
237 // {{{ HTML Functions
238
239 function banana_htmlentities($text, $quote = ENT_COMPAT)
240 {
241 return htmlentities($text, $quote, 'UTF-8');
242 }
243
244 function banana_html_entity_decode($text, $quote = ENT_COMPAT)
245 {
246 return html_entity_decode($text, $quote, 'UTF-8');
247 }
248
249 function banana_removeEvilAttributes($tagSource)
250 {
251 $stripAttrib = 'javascript:|onclick|ondblclick|onmousedown|onmouseup|onmouseover|'.
252 'onmousemove|onmouseout|onkeypress|onkeydown|onkeyup';
253 return stripslashes(preg_replace("/$stripAttrib/i", '', $tagSource));
254 }
255
256 /**
257 * @return string
258 * @param string
259 * @desc Strip forbidden tags and delegate tag-source check to removeEvilAttributes()
260 */
261 function banana_cleanHtml($source)
262 {
263 $allowedTags = '<h1><b><i><a><ul><li><pre><hr><blockquote><img><br><font><div>'
264 . '<p><small><big><sup><sub><code><em><strong><table><tr><td><th>';
265 $source = strip_tags($source, $allowedTags);
266 $source = preg_replace('/<(.*?)>/ie', "'<'.banana_removeEvilAttributes('\\1').'>'", $source);
267
268 if (function_exists('tidy_repair_string')) {
269 $tidy_on = Array(
270 'drop-empty-paras', 'drop-proprietary-attributes',
271 'hide-comments', 'logical-emphasis', 'output-xhtml',
272 'replace-color', 'show-body-only'
273 );
274 $tidy_off = Array('join-classes', 'clean'); // 'clean' may be a good idea, but it is too aggressive
275
276 foreach($tidy_on as $opt) {
277 tidy_setopt($opt, true);
278 }
279 foreach($tidy_off as $opt) {
280 tidy_setopt($opt, false);
281 }
282 tidy_setopt('alt-text', '[ inserted by TIDY ]');
283 tidy_setopt('wrap', '120');
284 tidy_set_encoding('utf8');
285 return tidy_repair_string($source);
286 }
287 return $source;
288 }
289
290 function banana_catchHtmlSignature($res)
291 {
292 $res = preg_replace("@(</p>)\n?-- ?\n?(<p[^>]*>|<br[^>]*>)@", "\\1<br/>-- \\2", $res);
293 $res = preg_replace("@<br[^>]*>\n?-- ?\n?(<p[^>]*>)@", "<br/>-- <br/>\\2", $res);
294 $res = preg_replace("@(<pre[^>]*>)\n?-- ?\n@", "<br/>-- <br/>\\1", $res);
295 $parts = preg_split("@(:?<p[^>]*>\n?-- ?\n?</p>|<br[^>]*>\n?-- ?\n?<br[^>]*>)@", $res);
296 $sign = '<hr style="width: 100%; margin: 1em 0em; " />';
297 return join($sign, $parts);
298 }
299
300 // {{{ Link to part catcher tools
301
302 function banana__linkAttachment($cid)
303 {
304 return banana_htmlentities(
305 Banana::$page->makeUrl(Array('group' => Banana::$group,
306 'artid' => Banana::$artid,
307 'part' => $cid)));
308 }
309
310 // }}}
311
312 function banana_hideExternalImages($text)
313 {
314 return preg_replace("/<img[^>]*?src=['\"](?!cid).*?>/i",
315 Banana::$page->makeImg(array('img' => 'invalid')),
316 $text);
317 }
318
319 function banana_catchPartLinks($text)
320 {
321 return preg_replace('/cid:([^\'" ]+)/e', "banana__linkAttachment('\\1')", $text);
322 }
323
324 // {{{ HTML to Plain Text tools
325
326 function banana__convertFormats($res)
327 {
328 $table = array('em|i' => '/',
329 'strong|b' => '*',
330 'u' => '_');
331 foreach ($table as $tags=>$format) {
332 $res = preg_replace("!</?($tags)( .*?)?>!is", $format, $res);
333 }
334 return $res;
335 }
336
337 function banana__convertQuotes($res)
338 {
339 return preg_replace('!<blockquote.*?>([^<]*)</blockquote>!ies',
340 "\"\n\" . banana_quote(banana__convertQuotes('\\1' . \"\n\"), 1, '&gt;')",
341 $res);
342 }
343
344 // }}}
345
346 function banana_htmlToPlainText($res)
347 {
348 $res = str_replace("\n", '', $res);
349 $res = banana__convertFormats($res);
350 $res = trim(strip_tags($res, '<div><br><p><blockquote>'));
351 $res = preg_replace("@</?(br|p|div).*?>@si", "\n", $res);
352 $res = banana__convertQuotes($res);
353 return banana_html_entity_decode($res);
354 }
355
356 function banana_formatHtml(BananaMimePart &$part)
357 {
358 $text = $part->getText();
359 $text = banana_catchHtmlSignature($text);
360 $text = banana_hideExternalImages($text);
361 $text = banana_catchPartLinks($text);
362 return banana_cleanHtml($text);
363 }
364
365 function banana_quoteHtml(BananaMimePart &$part)
366 {
367 $text = $part->getText();
368 $text = banana_htmlToPlainText($text);
369 return banana_wrap($text, 1);
370 }
371
372 // }}}
373 // {{{ Richtext Functions
374
375 /** Convert richtext to html
376 */
377 function banana_richtextToHtml($source)
378 {
379 $tags = Array('bold' => 'b',
380 'italic' => 'i',
381 'smaller' => 'small',
382 'bigger' => 'big',
383 'underline' => 'u',
384 'subscript' => 'sub',
385 'superscript' => 'sup',
386 'excerpt' => 'blockquote',
387 'paragraph' => 'p',
388 'nl' => 'br'
389 );
390
391 // clean unsupported tags
392 $protectedTags = '<signature><lt><comment><'.join('><', array_keys($tags)).'>';
393 $source = strip_tags($source, $protectedTags);
394
395 // convert richtext tags to html
396 foreach (array_keys($tags) as $tag) {
397 $source = preg_replace('@(</?)'.$tag.'([^>]*>)@i', '\1'.$tags[$tag].'\2', $source);
398 }
399
400 // some special cases
401 $source = preg_replace('@<signature>@i', '<br>-- <br>', $source);
402 $source = preg_replace('@</signature>@i', '', $source);
403 $source = preg_replace('@<lt>@i', '&lt;', $source);
404 $source = preg_replace('@<comment[^>]*>((?:[^<]|<(?!/comment>))*)</comment>@i', '<!-- \1 -->', $source);
405 return banana_cleanHtml($source);
406 }
407
408 function banana_formatRichText(BananaMimePart &$part)
409 {
410 $text = $part->getText();
411 $text = banana_richtextToHtml($text);
412 $text = banana_catchHtmlSignature($text);
413 return banana_cleanHtml($text);
414 }
415
416 function banana_quoteRichtText(BananaMimePart &$part)
417 {
418 $text = $part->getText();
419 $text = banana_richtextToHtml($text);
420 $text = banana_htmlToPlainText($text);
421 return banana_wrap($text, 1);
422 }
423
424 // }}}
425
426 // vim:set et sw=4 sts=4 ts=4 enc=utf-8:
427 ?>