]> git.mxchange.org Git - friendica.git/blob - include/html2bbcode.php
fix docstring of `get_poke_verbs()`
[friendica.git] / include / html2bbcode.php
1 <?php
2 /**
3  * @file include/html2bbcode.php
4  * @brief Converter for HTML to BBCode
5  *
6  * Made by: ike@piratenpartei.de
7  * Originally made for the syncom project: http://wiki.piratenpartei.de/Syncom
8  *                                      https://github.com/annando/Syncom
9  */
10
11 use Friendica\Core\Addon;
12 use Friendica\Util\Network;
13 use Friendica\Util\XML;
14
15 function node2bbcode(&$doc, $oldnode, $attributes, $startbb, $endbb)
16 {
17         do {
18                 $done = node2bbcodesub($doc, $oldnode, $attributes, $startbb, $endbb);
19         } while ($done);
20 }
21
22 function node2bbcodesub(&$doc, $oldnode, $attributes, $startbb, $endbb)
23 {
24         $savestart = str_replace('$', '\x01', $startbb);
25         $replace = false;
26
27         $xpath = new DomXPath($doc);
28
29         $list = $xpath->query("//".$oldnode);
30         foreach ($list as $oldNode) {
31                 $attr = [];
32                 if ($oldNode->attributes->length) {
33                         foreach ($oldNode->attributes as $attribute) {
34                                 $attr[$attribute->name] = $attribute->value;
35                         }
36                 }
37
38                 $replace = true;
39
40                 $startbb = $savestart;
41
42                 $i = 0;
43
44                 foreach ($attributes as $attribute => $value) {
45                         $startbb = str_replace('\x01'.++$i, '$1', $startbb);
46                         if (strpos('*'.$startbb, '$1') > 0) {
47                                 if ($replace && (@$attr[$attribute] != '')) {
48                                         $startbb = preg_replace($value, $startbb, $attr[$attribute], -1, $count);
49
50                                         // If nothing could be changed
51                                         if ($count == 0) {
52                                                 $replace = false;
53                                         }
54                                 } else {
55                                         $replace = false;
56                                 }
57                         } else {
58                                 if (@$attr[$attribute] != $value) {
59                                         $replace = false;
60                                 }
61                         }
62                 }
63
64                 if ($replace) {
65                         $StartCode = $oldNode->ownerDocument->createTextNode($startbb);
66                         $EndCode = $oldNode->ownerDocument->createTextNode($endbb);
67
68                         $oldNode->parentNode->insertBefore($StartCode, $oldNode);
69
70                         if ($oldNode->hasChildNodes()) {
71                                 foreach ($oldNode->childNodes as $child) {
72                                         $newNode = $child->cloneNode(true);
73                                         $oldNode->parentNode->insertBefore($newNode, $oldNode);
74                                 }
75                         }
76
77                         $oldNode->parentNode->insertBefore($EndCode, $oldNode);
78                         $oldNode->parentNode->removeChild($oldNode);
79                 }
80         }
81         return($replace);
82 }
83
84 function html2bbcode($message, $basepath = '')
85 {
86
87         $message = str_replace("\r", "", $message);
88
89         // Removing code blocks before the whitespace removal processing below
90         $codeblocks = [];
91         $message = preg_replace_callback(
92                 '#<pre><code(?: class="([^"]*)")?>(.*)</code></pre>#iUs',
93                 function ($matches) use (&$codeblocks) {
94                         $return = '[codeblock-' . count($codeblocks) . ']';
95
96                         $prefix = '[code]';
97                         if ($matches[1] != '') {
98                                 $prefix = '[code=' . $matches[1] . ']';
99                         }
100                         $codeblocks[] = $prefix . trim($matches[2]) . '[/code]';
101                         return $return;
102                 },
103                 $message
104         );
105
106         $message = str_replace(
107                 [
108                         "<li><p>",
109                         "</p></li>",
110                 ],
111                 [
112                         "<li>",
113                         "</li>",
114                 ],
115                 $message
116         );
117
118         // remove namespaces
119         $message = preg_replace('=<(\w+):(.+?)>=', '<removeme>', $message);
120         $message = preg_replace('=</(\w+):(.+?)>=', '</removeme>', $message);
121
122         $doc = new DOMDocument();
123         $doc->preserveWhiteSpace = false;
124
125         $message = mb_convert_encoding($message, 'HTML-ENTITIES', "UTF-8");
126
127         @$doc->loadHTML($message);
128
129         XML::deleteNode($doc, 'style');
130         XML::deleteNode($doc, 'head');
131         XML::deleteNode($doc, 'title');
132         XML::deleteNode($doc, 'meta');
133         XML::deleteNode($doc, 'xml');
134         XML::deleteNode($doc, 'removeme');
135
136         $xpath = new DomXPath($doc);
137         $list = $xpath->query("//pre");
138         foreach ($list as $node) {
139                 $node->nodeValue = str_replace("\n", "\r", $node->nodeValue);
140         }
141
142         $message = $doc->saveHTML();
143         $message = str_replace(["\n<", ">\n", "\r", "\n", "\xC3\x82\xC2\xA0"], ["<", ">", "<br />", " ", ""], $message);
144         $message = preg_replace('= [\s]*=i', " ", $message);
145         @$doc->loadHTML($message);
146
147         node2bbcode($doc, 'html', [], "", "");
148         node2bbcode($doc, 'body', [], "", "");
149
150         // Outlook-Quote - Variant 1
151         node2bbcode($doc, 'p', ['class'=>'MsoNormal', 'style'=>'margin-left:35.4pt'], '[quote]', '[/quote]');
152
153         // Outlook-Quote - Variant 2
154         node2bbcode($doc, 'div', ['style'=>'border:none;border-left:solid blue 1.5pt;padding:0cm 0cm 0cm 4.0pt'], '[quote]', '[/quote]');
155
156         // MyBB-Stuff
157         node2bbcode($doc, 'span', ['style'=>'text-decoration: underline;'], '[u]', '[/u]');
158         node2bbcode($doc, 'span', ['style'=>'font-style: italic;'], '[i]', '[/i]');
159         node2bbcode($doc, 'span', ['style'=>'font-weight: bold;'], '[b]', '[/b]');
160
161         /*node2bbcode($doc, 'font', array('face'=>'/([\w ]+)/', 'size'=>'/(\d+)/', 'color'=>'/(.+)/'), '[font=$1][size=$2][color=$3]', '[/color][/size][/font]');
162         node2bbcode($doc, 'font', array('size'=>'/(\d+)/', 'color'=>'/(.+)/'), '[size=$1][color=$2]', '[/color][/size]');
163         node2bbcode($doc, 'font', array('face'=>'/([\w ]+)/', 'size'=>'/(.+)/'), '[font=$1][size=$2]', '[/size][/font]');
164         node2bbcode($doc, 'font', array('face'=>'/([\w ]+)/', 'color'=>'/(.+)/'), '[font=$1][color=$3]', '[/color][/font]');
165         node2bbcode($doc, 'font', array('face'=>'/([\w ]+)/'), '[font=$1]', '[/font]');
166         node2bbcode($doc, 'font', array('size'=>'/(\d+)/'), '[size=$1]', '[/size]');
167         node2bbcode($doc, 'font', array('color'=>'/(.+)/'), '[color=$1]', '[/color]');
168         */
169         // Untested
170         //node2bbcode($doc, 'span', array('style'=>'/.*font-size:\s*(.+?)[,;].*font-family:\s*(.+?)[,;].*color:\s*(.+?)[,;].*/'), '[size=$1][font=$2][color=$3]', '[/color][/font][/size]');
171         //node2bbcode($doc, 'span', array('style'=>'/.*font-size:\s*(\d+)[,;].*/'), '[size=$1]', '[/size]');
172         //node2bbcode($doc, 'span', array('style'=>'/.*font-size:\s*(.+?)[,;].*/'), '[size=$1]', '[/size]');
173
174         node2bbcode($doc, 'span', ['style'=>'/.*color:\s*(.+?)[,;].*/'], '[color="$1"]', '[/color]');
175
176         //node2bbcode($doc, 'span', array('style'=>'/.*font-family:\s*(.+?)[,;].*/'), '[font=$1]', '[/font]');
177
178         //node2bbcode($doc, 'div', array('style'=>'/.*font-family:\s*(.+?)[,;].*font-size:\s*(\d+?)pt.*/'), '[font=$1][size=$2]', '[/size][/font]');
179         //node2bbcode($doc, 'div', array('style'=>'/.*font-family:\s*(.+?)[,;].*font-size:\s*(\d+?)px.*/'), '[font=$1][size=$2]', '[/size][/font]');
180         //node2bbcode($doc, 'div', array('style'=>'/.*font-family:\s*(.+?)[,;].*/'), '[font=$1]', '[/font]');
181
182         // Importing the classes - interesting for importing of posts from third party networks that were exported from friendica
183         // Test
184         //node2bbcode($doc, 'span', array('class'=>'/([\w ]+)/'), '[class=$1]', '[/class]');
185         node2bbcode($doc, 'span', ['class'=>'type-link'], '[class=type-link]', '[/class]');
186         node2bbcode($doc, 'span', ['class'=>'type-video'], '[class=type-video]', '[/class]');
187
188         node2bbcode($doc, 'strong', [], '[b]', '[/b]');
189         node2bbcode($doc, 'em', [], '[i]', '[/i]');
190         node2bbcode($doc, 'b', [], '[b]', '[/b]');
191         node2bbcode($doc, 'i', [], '[i]', '[/i]');
192         node2bbcode($doc, 'u', [], '[u]', '[/u]');
193
194         node2bbcode($doc, 'big', [], "[size=large]", "[/size]");
195         node2bbcode($doc, 'small', [], "[size=small]", "[/size]");
196
197         node2bbcode($doc, 'blockquote', [], '[quote]', '[/quote]');
198
199         node2bbcode($doc, 'br', [], "\n", '');
200
201         node2bbcode($doc, 'p', ['class'=>'MsoNormal'], "\n", "");
202         node2bbcode($doc, 'div', ['class'=>'MsoNormal'], "\r", "");
203
204         node2bbcode($doc, 'span', [], "", "");
205
206         node2bbcode($doc, 'span', [], "", "");
207         node2bbcode($doc, 'pre', [], "", "");
208
209         node2bbcode($doc, 'div', [], "\r", "\r");
210         node2bbcode($doc, 'p', [], "\n", "\n");
211
212         node2bbcode($doc, 'ul', [], "[list]", "[/list]");
213         node2bbcode($doc, 'ol', [], "[list=1]", "[/list]");
214         node2bbcode($doc, 'li', [], "[*]", "");
215
216         node2bbcode($doc, 'hr', [], "[hr]", "");
217
218         node2bbcode($doc, 'table', [], "", "");
219         node2bbcode($doc, 'tr', [], "\n", "");
220         node2bbcode($doc, 'td', [], "\t", "");
221         //node2bbcode($doc, 'table', array(), "[table]", "[/table]");
222         //node2bbcode($doc, 'th', array(), "[th]", "[/th]");
223         //node2bbcode($doc, 'tr', array(), "[tr]", "[/tr]");
224         //node2bbcode($doc, 'td', array(), "[td]", "[/td]");
225
226         //node2bbcode($doc, 'h1', array(), "\n\n[size=xx-large][b]", "[/b][/size]\n");
227         //node2bbcode($doc, 'h2', array(), "\n\n[size=x-large][b]", "[/b][/size]\n");
228         //node2bbcode($doc, 'h3', array(), "\n\n[size=large][b]", "[/b][/size]\n");
229         //node2bbcode($doc, 'h4', array(), "\n\n[size=medium][b]", "[/b][/size]\n");
230         //node2bbcode($doc, 'h5', array(), "\n\n[size=small][b]", "[/b][/size]\n");
231         //node2bbcode($doc, 'h6', array(), "\n\n[size=x-small][b]", "[/b][/size]\n");
232
233         node2bbcode($doc, 'h1', [], "\n\n[h1]", "[/h1]\n");
234         node2bbcode($doc, 'h2', [], "\n\n[h2]", "[/h2]\n");
235         node2bbcode($doc, 'h3', [], "\n\n[h3]", "[/h3]\n");
236         node2bbcode($doc, 'h4', [], "\n\n[h4]", "[/h4]\n");
237         node2bbcode($doc, 'h5', [], "\n\n[h5]", "[/h5]\n");
238         node2bbcode($doc, 'h6', [], "\n\n[h6]", "[/h6]\n");
239
240         node2bbcode($doc, 'a', ['href'=>'/mailto:(.+)/'], '[mail=$1]', '[/mail]');
241         node2bbcode($doc, 'a', ['href'=>'/(.+)/'], '[url=$1]', '[/url]');
242
243         node2bbcode($doc, 'img', ['src'=>'/(.+)/', 'width'=>'/(\d+)/', 'height'=>'/(\d+)/'], '[img=$2x$3]$1', '[/img]');
244         node2bbcode($doc, 'img', ['src'=>'/(.+)/'], '[img]$1', '[/img]');
245
246
247         node2bbcode($doc, 'video', ['src'=>'/(.+)/'], '[video]$1', '[/video]');
248         node2bbcode($doc, 'audio', ['src'=>'/(.+)/'], '[audio]$1', '[/audio]');
249         node2bbcode($doc, 'iframe', ['src'=>'/(.+)/'], '[iframe]$1', '[/iframe]');
250
251         node2bbcode($doc, 'key', [], '[code]', '[/code]');
252         node2bbcode($doc, 'code', [], '[code]', '[/code]');
253
254         $message = $doc->saveHTML();
255
256         // I'm removing something really disturbing
257         // Don't know exactly what it is
258         $message = str_replace(chr(194).chr(160), ' ', $message);
259
260         $message = str_replace("&nbsp;", " ", $message);
261
262         // removing multiple DIVs
263         $message = preg_replace('=\r *\r=i', "\n", $message);
264         $message = str_replace("\r", "\n", $message);
265
266         Addon::callHooks('html2bbcode', $message);
267
268         $message = strip_tags($message);
269
270         $message = html_entity_decode($message, ENT_QUOTES, 'UTF-8');
271
272         $message = str_replace(["<"], ["&lt;"], $message);
273
274         // remove quotes if they don't make sense
275         $message = preg_replace('=\[/quote\][\s]*\[quote\]=i', "\n", $message);
276
277         $message = preg_replace('=\[quote\]\s*=i', "[quote]", $message);
278         $message = preg_replace('=\s*\[/quote\]=i', "[/quote]", $message);
279
280         do {
281                 $oldmessage = $message;
282                 $message = str_replace("\n \n", "\n\n", $message);
283         } while ($oldmessage != $message);
284
285         do {
286                 $oldmessage = $message;
287                 $message = str_replace("\n\n\n", "\n\n", $message);
288         } while ($oldmessage != $message);
289
290         do {
291                 $oldmessage = $message;
292                 $message = str_replace(
293                         [
294                                 "[/size]\n\n",
295                                 "\n[hr]",
296                                 "[hr]\n",
297                                 "\n[list",
298                                 "[/list]\n",
299                                 "\n[/",
300                                 "[list]\n",
301                                 "[list=1]\n",
302                                 "\n[*]"],
303                         [
304                                 "[/size]\n",
305                                 "[hr]",
306                                 "[hr]",
307                                 "[list",
308                                 "[/list]",
309                                 "[/",
310                                 "[list]",
311                                 "[list=1]",
312                                 "[*]"],
313                         $message
314                 );
315         } while ($message != $oldmessage);
316
317         $message = str_replace(
318                 ['[b][b]', '[/b][/b]', '[i][i]', '[/i][/i]'],
319                 ['[b]', '[/b]', '[i]', '[/i]'],
320                 $message
321         );
322
323         // Handling Yahoo style of mails
324         $message = str_replace('[hr][b]From:[/b]', '[quote][b]From:[/b]', $message);
325
326         // Restore code blocks
327         $message = preg_replace_callback(
328                 '#\[codeblock-([0-9]+)\]#iU',
329                 function ($matches) use ($codeblocks) {
330                         $return = '';
331                         if (isset($codeblocks[intval($matches[1])])) {
332                                 $return = $codeblocks[$matches[1]];
333                         }
334                         return $return;
335                 },
336                 $message
337         );
338
339         $message = trim($message);
340
341         if ($basepath != '') {
342                 $message = addHostname($message, $basepath);
343         }
344
345         return $message;
346 }
347
348 /**
349  * @brief Sub function to complete incomplete URL
350  *
351  * @param array  $matches  Result of preg_replace_callback
352  * @param string $basepath Basepath that is used to complete the URL
353  *
354  * @return string The expanded URL
355  */
356 function addHostnameSub($matches, $basepath)
357 {
358         $base = parse_url($basepath);
359         unset($base['query']);
360         unset($base['fragment']);
361
362         $link = $matches[0];
363         $url = $matches[1];
364
365         $parts = array_merge($base, parse_url($url));
366         $url2 = Network::unparseURL($parts);
367
368         return str_replace($url, $url2, $link);
369 }
370
371 /**
372  * @brief Complete incomplete URLs in BBCode
373  *
374  * @param string $body     Body with URLs
375  * @param string $basepath Basepath that is used to complete the URL
376  *
377  * @return string Body with expanded URLs
378  */
379 function addHostname($body, $basepath)
380 {
381         $URLSearchString = "^\[\]";
382
383         $matches = ["/\[url\=([$URLSearchString]*)\].*?\[\/url\]/ism",
384                         "/\[url\]([$URLSearchString]*)\[\/url\]/ism",
385                         "/\[img\=[0-9]*x[0-9]*\](.*?)\[\/img\]/ism",
386                         "/\[img\](.*?)\[\/img\]/ism",
387                         "/\[zmg\=[0-9]*x[0-9]*\](.*?)\[\/img\]/ism",
388                         "/\[zmg\](.*?)\[\/zmg\]/ism",
389                         "/\[video\](.*?)\[\/video\]/ism",
390                         "/\[audio\](.*?)\[\/audio\]/ism",
391                         ];
392
393         foreach ($matches as $match) {
394                 $body = preg_replace_callback(
395                         $match,
396                         function ($match) use ($basepath) {
397                                 return addHostnameSub($match, $basepath);
398                         },
399                         $body
400                 );
401         }
402         return $body;
403 }