3 * @copyright Copyright (C) 2010-2023, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Content\Text;
26 use Friendica\Protocol\HTTP\MediaType;
27 use Friendica\Core\Hook;
28 use Friendica\Core\Renderer;
29 use Friendica\Core\Search;
31 use Friendica\Model\Contact;
32 use Friendica\Util\Network;
33 use Friendica\Util\Strings;
34 use Friendica\Util\XML;
35 use League\HTMLToMarkdown\HtmlConverter;
36 use Psr\Http\Message\UriInterface;
41 * Search all instances of a specific HTML tag node in the provided DOM document and replaces them with BBCode text nodes.
43 * @see HTML::tagToBBCodeSub()
45 private static function tagToBBCode(DOMDocument $doc, string $tag, array $attributes, string $startbb, string $endbb, bool $ignoreChildren = false)
48 $done = self::tagToBBCodeSub($doc, $tag, $attributes, $startbb, $endbb, $ignoreChildren);
53 * Search the first specific HTML tag node in the provided DOM document and replaces it with BBCode text nodes.
55 * @param DOMDocument $doc
56 * @param string $tag HTML tag name
57 * @param array $attributes Array of attributes to match and optionally use the value from
58 * @param string $startbb BBCode tag opening
59 * @param string $endbb BBCode tag closing
60 * @param bool $ignoreChildren If set to false, the HTML tag children will be appended as text inside the BBCode tag
61 * Otherwise, they will be entirely ignored. Useful for simple BBCode that draw their
62 * inner value from an attribute value and disregard the tag children.
63 * @return bool Whether a replacement was done
65 private static function tagToBBCodeSub(DOMDocument $doc, string $tag, array $attributes, string $startbb, string $endbb, bool $ignoreChildren = false): bool
67 $savestart = str_replace('$', '\x01', $startbb);
70 $xpath = new DOMXPath($doc);
72 /** @var \DOMNode[] $list */
73 $list = $xpath->query("//" . $tag);
74 foreach ($list as $node) {
76 if ($node->attributes->length) {
77 foreach ($node->attributes as $attribute) {
78 $attr[$attribute->name] = $attribute->value;
84 $startbb = $savestart;
88 foreach ($attributes as $attribute => $value) {
89 $startbb = str_replace('\x01' . ++$i, '$1', $startbb);
90 if (strpos('*' . $startbb, '$1') > 0) {
91 if ($replace && (@$attr[$attribute] != '')) {
92 $startbb = preg_replace($value, $startbb, $attr[$attribute], -1, $count);
94 // If nothing could be changed
102 if (@$attr[$attribute] != $value) {
109 $StartCode = $doc->createTextNode($startbb);
110 $EndCode = $doc->createTextNode($endbb);
112 $node->parentNode->insertBefore($StartCode, $node);
114 if (!$ignoreChildren && $node->hasChildNodes()) {
115 /** @var \DOMNode $child */
116 foreach ($node->childNodes as $key => $child) {
117 /* Remove empty text nodes at the start or at the end of the children list */
118 if ($key > 0 && $key < $node->childNodes->length - 1 || $child->nodeName != '#text' || trim($child->nodeValue) !== '') {
119 $newNode = $child->cloneNode(true);
120 $node->parentNode->insertBefore($newNode, $node);
125 $node->parentNode->insertBefore($EndCode, $node);
126 $node->parentNode->removeChild($node);
134 * Converter for HTML to BBCode
136 * Made by: ike@piratenpartei.de
137 * Originally made for the syncom project: http://wiki.piratenpartei.de/Syncom
138 * https://github.com/annando/Syncom
140 * @param string $message
141 * @param string $basepath
143 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
145 public static function toBBCode(string $message, string $basepath = ''): string
148 * Check if message is empty to prevent a lot of code below from being executed
149 * for just an empty message.
151 if ($message === '') {
155 DI::profiler()->startRecording('rendering');
156 $message = str_replace("\r", "", $message);
158 $message = Strings::performWithEscapedBlocks($message, '#<pre><code.*</code></pre>#iUs', function ($message) {
159 $message = str_replace(
172 $message = preg_replace('=<(\w+):(.+?)>=', '<removeme>', $message);
173 $message = preg_replace('=</(\w+):(.+?)>=', '</removeme>', $message);
175 $doc = new DOMDocument();
176 $doc->preserveWhiteSpace = false;
178 $message = mb_convert_encoding($message, 'HTML-ENTITIES', "UTF-8");
180 if (empty($message)) {
184 @$doc->loadHTML($message, LIBXML_HTML_NODEFDTD);
186 XML::deleteNode($doc, 'style');
187 XML::deleteNode($doc, 'head');
188 XML::deleteNode($doc, 'title');
189 XML::deleteNode($doc, 'meta');
190 XML::deleteNode($doc, 'xml');
191 XML::deleteNode($doc, 'removeme');
193 $xpath = new DomXPath($doc);
194 $list = $xpath->query("//pre");
195 foreach ($list as $node) {
196 // Ensure to escape unescaped & - they will otherwise raise a warning
197 $safe_value = preg_replace('/&(?!\w+;)/', '&', $node->nodeValue);
198 $node->nodeValue = str_replace("\n", "\r", $safe_value);
201 $message = $doc->saveHTML();
202 $message = str_replace(["\n<", ">\n", "\r", "\n", "\xC3\x82\xC2\xA0"], ["<", ">", "<br />", " ", ""], $message);
203 $message = preg_replace('= [\s]*=i', " ", $message);
205 if (empty($message)) {
209 @$doc->loadHTML($message, LIBXML_HTML_NODEFDTD);
211 self::tagToBBCode($doc, 'html', [], "", "");
212 self::tagToBBCode($doc, 'body', [], "", "");
214 // Outlook-Quote - Variant 1
215 self::tagToBBCode($doc, 'p', ['class' => 'MsoNormal', 'style' => 'margin-left:35.4pt'], '[quote]', '[/quote]');
217 // Outlook-Quote - Variant 2
221 ['style' => 'border:none;border-left:solid blue 1.5pt;padding:0cm 0cm 0cm 4.0pt'],
227 self::tagToBBCode($doc, 'span', ['style' => 'text-decoration: underline;'], '[u]', '[/u]');
228 self::tagToBBCode($doc, 'span', ['style' => 'font-style: italic;'], '[i]', '[/i]');
229 self::tagToBBCode($doc, 'span', ['style' => 'font-weight: bold;'], '[b]', '[/b]');
231 /* self::node2BBCode($doc, 'font', array('face'=>'/([\w ]+)/', 'size'=>'/(\d+)/', 'color'=>'/(.+)/'), '[font=$1][size=$2][color=$3]', '[/color][/size][/font]');
232 self::node2BBCode($doc, 'font', array('size'=>'/(\d+)/', 'color'=>'/(.+)/'), '[size=$1][color=$2]', '[/color][/size]');
233 self::node2BBCode($doc, 'font', array('face'=>'/([\w ]+)/', 'size'=>'/(.+)/'), '[font=$1][size=$2]', '[/size][/font]');
234 self::node2BBCode($doc, 'font', array('face'=>'/([\w ]+)/', 'color'=>'/(.+)/'), '[font=$1][color=$3]', '[/color][/font]');
235 self::node2BBCode($doc, 'font', array('face'=>'/([\w ]+)/'), '[font=$1]', '[/font]');
236 self::node2BBCode($doc, 'font', array('size'=>'/(\d+)/'), '[size=$1]', '[/size]');
237 self::node2BBCode($doc, 'font', array('color'=>'/(.+)/'), '[color=$1]', '[/color]');
240 //self::node2BBCode($doc, 'span', array('style'=>'/.*font-size:\s*(.+?)[,;].*font-family:\s*(.+?)[,;].*color:\s*(.+?)[,;].*/'), '[size=$1][font=$2][color=$3]', '[/color][/font][/size]');
241 //self::node2BBCode($doc, 'span', array('style'=>'/.*font-size:\s*(\d+)[,;].*/'), '[size=$1]', '[/size]');
242 //self::node2BBCode($doc, 'span', array('style'=>'/.*font-size:\s*(.+?)[,;].*/'), '[size=$1]', '[/size]');
244 self::tagToBBCode($doc, 'span', ['style' => '/.*color:\s*(.+?)[,;].*/'], '[color="$1"]', '[/color]');
246 //self::node2BBCode($doc, 'span', array('style'=>'/.*font-family:\s*(.+?)[,;].*/'), '[font=$1]', '[/font]');
247 //self::node2BBCode($doc, 'div', array('style'=>'/.*font-family:\s*(.+?)[,;].*font-size:\s*(\d+?)pt.*/'), '[font=$1][size=$2]', '[/size][/font]');
248 //self::node2BBCode($doc, 'div', array('style'=>'/.*font-family:\s*(.+?)[,;].*font-size:\s*(\d+?)px.*/'), '[font=$1][size=$2]', '[/size][/font]');
249 //self::node2BBCode($doc, 'div', array('style'=>'/.*font-family:\s*(.+?)[,;].*/'), '[font=$1]', '[/font]');
250 // Importing the classes - interesting for importing of posts from third party networks that were exported from friendica
252 //self::node2BBCode($doc, 'span', array('class'=>'/([\w ]+)/'), '[class=$1]', '[/class]');
253 self::tagToBBCode($doc, 'span', ['class' => 'type-link'], '[class=type-link]', '[/class]');
254 self::tagToBBCode($doc, 'span', ['class' => 'type-video'], '[class=type-video]', '[/class]');
256 self::tagToBBCode($doc, 'strong', [], '[b]', '[/b]');
257 self::tagToBBCode($doc, 'em', [], '[i]', '[/i]');
258 self::tagToBBCode($doc, 'b', [], '[b]', '[/b]');
259 self::tagToBBCode($doc, 'i', [], '[i]', '[/i]');
260 self::tagToBBCode($doc, 'u', [], '[u]', '[/u]');
261 self::tagToBBCode($doc, 's', [], '[s]', '[/s]');
262 self::tagToBBCode($doc, 'del', [], '[s]', '[/s]');
263 self::tagToBBCode($doc, 'strike', [], '[s]', '[/s]');
265 self::tagToBBCode($doc, 'big', [], "[size=large]", "[/size]");
266 self::tagToBBCode($doc, 'small', [], "[size=small]", "[/size]");
268 self::tagToBBCode($doc, 'blockquote', [], '[quote]', '[/quote]');
270 self::tagToBBCode($doc, 'br', [], "\n", '');
272 self::tagToBBCode($doc, 'p', ['class' => 'MsoNormal'], "\n", "");
273 self::tagToBBCode($doc, 'div', ['class' => 'MsoNormal'], "\r", "");
275 self::tagToBBCode($doc, 'span', [], "", "");
277 self::tagToBBCode($doc, 'span', [], "", "");
278 self::tagToBBCode($doc, 'pre', [], "", "");
280 self::tagToBBCode($doc, 'div', [], "\r", "\r");
281 self::tagToBBCode($doc, 'p', [], "\n", "\n");
283 self::tagToBBCode($doc, 'ul', [], "[ul]", "\n[/ul]");
284 self::tagToBBCode($doc, 'ol', [], "[ol]", "\n[/ol]");
285 self::tagToBBCode($doc, 'li', [], "\n[li]", "[/li]");
287 self::tagToBBCode($doc, 'hr', [], "[hr]", "");
289 self::tagToBBCode($doc, 'table', [], "[table]", "[/table]");
290 self::tagToBBCode($doc, 'th', [], "[th]", "[/th]");
291 self::tagToBBCode($doc, 'tr', [], "[tr]", "[/tr]");
292 self::tagToBBCode($doc, 'td', [], "[td]", "[/td]");
294 self::tagToBBCode($doc, 'h1', [], "[h1]", "[/h1]");
295 self::tagToBBCode($doc, 'h2', [], "[h2]", "[/h2]");
296 self::tagToBBCode($doc, 'h3', [], "[h3]", "[/h3]");
297 self::tagToBBCode($doc, 'h4', [], "[h4]", "[/h4]");
298 self::tagToBBCode($doc, 'h5', [], "[h5]", "[/h5]");
299 self::tagToBBCode($doc, 'h6', [], "[h6]", "[/h6]");
301 self::tagToBBCode($doc, 'a', ['href' => '/mailto:(.+)/'], '[mail=$1]', '[/mail]');
302 self::tagToBBCode($doc, 'a', ['href' => '/(.+)/'], '[url=$1]', '[/url]');
304 self::tagToBBCode($doc, 'img', ['src' => '/(.+)/', 'alt' => '/(.+)/'], '[img=$1]$2', '[/img]', true);
305 self::tagToBBCode($doc, 'img', ['src' => '/(.+)/', 'width' => '/(\d+)/', 'height' => '/(\d+)/'], '[img=$2x$3]$1', '[/img]', true);
306 self::tagToBBCode($doc, 'img', ['src' => '/(.+)/'], '[img]$1', '[/img]', true);
309 self::tagToBBCode($doc, 'video', ['src' => '/(.+)/'], '[video]$1', '[/video]', true);
310 self::tagToBBCode($doc, 'audio', ['src' => '/(.+)/'], '[audio]$1', '[/audio]', true);
311 // Backward compatibility, [iframe] support has been removed in version 2020.12
312 self::tagToBBCode($doc, 'iframe', ['src' => '/(.+)/'], '[url]$1', '[/url]', true);
314 self::tagToBBCode($doc, 'key', [], '[code]', '[/code]');
315 self::tagToBBCode($doc, 'code', [], '[code]', '[/code]');
317 $message = $doc->saveHTML();
319 // I'm removing something really disturbing
320 // Don't know exactly what it is
321 $message = str_replace(chr(194) . chr(160), ' ', $message);
323 $message = str_replace(" ", " ", $message);
325 // removing multiple DIVs
326 $message = preg_replace('=\r *\r=i', "\n", $message);
327 $message = str_replace("\r", "\n", $message);
329 Hook::callAll('html2bbcode', $message);
331 $message = strip_tags($message);
333 $message = html_entity_decode($message, ENT_QUOTES, 'UTF-8');
335 // remove quotes if they don't make sense
336 $message = preg_replace('=\[/quote\][\s]*\[quote\]=i', "\n", $message);
338 $message = preg_replace('=\[quote\]\s*=i', "[quote]", $message);
339 $message = preg_replace('=\s*\[/quote\]=i', "[/quote]", $message);
342 $oldmessage = $message;
343 $message = str_replace("\n \n", "\n\n", $message);
344 } while ($oldmessage != $message);
347 $oldmessage = $message;
348 $message = str_replace("\n\n\n", "\n\n", $message);
349 } while ($oldmessage != $message);
351 $message = str_replace(
352 ['[b][b]', '[/b][/b]', '[i][i]', '[/i][/i]'],
353 ['[b]', '[/b]', '[i]', '[/i]'],
357 // Handling Yahoo style of mails
358 $message = str_replace('[hr][b]From:[/b]', '[quote][b]From:[/b]', $message);
363 $message = preg_replace_callback(
364 '#<pre><code(?: class="language-([^"]*)")?>(.*)</code></pre>#iUs',
365 function ($matches) {
367 if ($matches[1] != '') {
368 $prefix = '[code=' . $matches[1] . ']';
371 return $prefix . "\n" . html_entity_decode($matches[2]) . "\n" . '[/code]';
376 $message = trim($message);
378 if ($basepath != '') {
379 $message = self::qualifyURLs($message, $basepath);
382 DI::profiler()->stopRecording();
387 * Sub function to complete incomplete URL
389 * @param array $matches Result of preg_replace_callback
390 * @param string $basepath Basepath that is used to complete the URL
392 * @return string The expanded URL
394 private static function qualifyURLsSub(array $matches, string $basepath): string
396 $base = parse_url($basepath);
397 unset($base['query']);
398 unset($base['fragment']);
403 if (empty($url) || empty(parse_url($url))) {
407 $parts = array_merge($base, parse_url($url));
408 $url2 = Network::unparseURL($parts);
410 return str_replace($url, $url2, $link);
414 * Complete incomplete URLs in BBCode
416 * @param string $body Body with URLs
417 * @param string $basepath Base path that is used to complete the URL
419 * @return string Body with expanded URLs
421 private static function qualifyURLs(string $body, string $basepath): string
423 $URLSearchString = "^\[\]";
426 "/\[url\=([$URLSearchString]*)\].*?\[\/url\]/ism",
427 "/\[url\]([$URLSearchString]*)\[\/url\]/ism",
428 "/\[img\=[0-9]*x[0-9]*\](.*?)\[\/img\]/ism",
429 "/\[img\](.*?)\[\/img\]/ism",
430 "/\[zmg\=[0-9]*x[0-9]*\](.*?)\[\/img\]/ism",
431 "/\[zmg\](.*?)\[\/zmg\]/ism",
432 "/\[video\](.*?)\[\/video\]/ism",
433 "/\[audio\](.*?)\[\/audio\]/ism",
436 foreach ($matches as $match) {
437 $body = preg_replace_callback(
439 function ($match) use ($basepath) {
440 return self::qualifyURLsSub($match, $basepath);
448 private static function breakLines(string $line, int $level, int $wraplength = 75): string
450 if ($wraplength == 0) {
451 $wraplength = 2000000;
454 $wraplen = $wraplength - $level;
461 $subline = substr($line, 0, $wraplen);
463 $pos = strrpos($subline, ' ');
466 $pos = strpos($line, ' ');
469 if (($pos > 0) && strlen($line) > $wraplen) {
470 $newline = trim(substr($line, 0, $pos));
472 $newline = str_repeat(">", $level) . ' ' . $newline;
475 $newlines[] = $newline . " ";
476 $line = substr($line, $pos + 1);
478 } while ((strlen($line) > $wraplen) && !($oldline == $line));
481 $line = str_repeat(">", $level) . ' ' . $line;
486 return implode("\n", $newlines);
489 private static function quoteLevel(string $message, int $wraplength = 75): string
491 $lines = explode("\n", $message);
495 foreach ($lines as $line) {
498 while (strpos("*" . $line, '[quote]') > 0) {
500 $pos = strpos($line, '[quote]');
501 $line = substr($line, 0, $pos) . substr($line, $pos + 7);
507 while (strpos("*" . $line, '[/quote]') > 0) {
513 $pos = strpos($line, '[/quote]');
514 $line = substr($line, 0, $pos) . substr($line, $pos + 8);
517 if (!$startquote || ($line != '')) {
518 $newlines[] = self::breakLines($line, $currlevel, $wraplength);
522 return implode("\n", $newlines);
525 private static function collectURLs(string $message): array
527 $pattern = '/<a.*?href="(.*?)".*?>(.*?)<\/a>/is';
528 preg_match_all($pattern, $message, $result, PREG_SET_ORDER);
531 foreach ($result as $treffer) {
534 // A list of some links that should be ignored
536 "/user/", "/tag/", "/group/", "/circle/", "/profile/", "/search?search=", "/search?tag=", "mailto:", "/u/", "/node/",
537 "//plus.google.com/", "//twitter.com/"
539 foreach ($list as $listitem) {
540 if (strpos($treffer[1], $listitem) !== false) {
545 if ((strpos($treffer[1], "//twitter.com/") !== false) && (strpos($treffer[1], "/status/") !== false)) {
549 if ((strpos($treffer[1], "//plus.google.com/") !== false) && (strpos($treffer[1], "/posts") !== false)) {
553 if ((strpos($treffer[1], "//plus.google.com/") !== false) && (strpos($treffer[1], "/photos") !== false)) {
557 $ignore = $ignore || strpos($treffer[1], '#') === 0;
560 $urls[$treffer[1]] = $treffer[1];
568 * @param string $html
569 * @param int $wraplength Ensures individual lines aren't longer than this many characters. Doesn't break words.
570 * @param bool $compact True: Completely strips image tags; False: Keeps image URLs
573 public static function toPlaintext(string $html, int $wraplength = 75, bool $compact = false): string
575 DI::profiler()->startRecording('rendering');
576 $message = str_replace("\r", "", $html);
578 $doc = new DOMDocument();
579 $doc->preserveWhiteSpace = false;
581 $message = mb_convert_encoding($message, 'HTML-ENTITIES', "UTF-8");
583 if (empty($message)) {
584 DI::profiler()->stopRecording();
588 @$doc->loadHTML($message, LIBXML_HTML_NODEFDTD);
590 $message = $doc->saveHTML();
591 // Remove eventual UTF-8 BOM
592 $message = str_replace("\xC3\x82\xC2\xA0", "", $message);
594 // Collecting all links
595 $urls = self::collectURLs($message);
597 if (empty($message)) {
598 DI::profiler()->stopRecording();
602 @$doc->loadHTML($message, LIBXML_HTML_NODEFDTD);
604 self::tagToBBCode($doc, 'html', [], '', '');
605 self::tagToBBCode($doc, 'body', [], '', '');
608 self::tagToBBCode($doc, 'blockquote', [], "»", "«");
610 self::tagToBBCode($doc, 'blockquote', [], '[quote]', "[/quote]\n");
613 self::tagToBBCode($doc, 'br', [], "\n", '');
615 self::tagToBBCode($doc, 'span', [], "", "");
616 self::tagToBBCode($doc, 'pre', [], "", "");
617 self::tagToBBCode($doc, 'div', [], "\r", "\r");
618 self::tagToBBCode($doc, 'p', [], "\n", "\n");
620 self::tagToBBCode($doc, 'li', [], "\n* ", "\n");
622 self::tagToBBCode($doc, 'hr', [], "\n" . str_repeat("-", 70) . "\n", "");
624 self::tagToBBCode($doc, 'tr', [], "\n", "");
625 self::tagToBBCode($doc, 'td', [], "\t", "");
627 self::tagToBBCode($doc, 'h1', [], "\n\n*", "*\n");
628 self::tagToBBCode($doc, 'h2', [], "\n\n*", "*\n");
629 self::tagToBBCode($doc, 'h3', [], "\n\n*", "*\n");
630 self::tagToBBCode($doc, 'h4', [], "\n\n*", "*\n");
631 self::tagToBBCode($doc, 'h5', [], "\n\n*", "*\n");
632 self::tagToBBCode($doc, 'h6', [], "\n\n*", "*\n");
635 self::tagToBBCode($doc, 'img', ['src' => '/(.+)/'], ' [img]$1', '[/img] ');
637 self::tagToBBCode($doc, 'img', ['src' => '/(.+)/'], ' ', ' ');
640 // Backward compatibility, [iframe] support has been removed in version 2020.12
641 self::tagToBBCode($doc, 'iframe', ['src' => '/(.+)/'], ' $1 ', '');
643 $message = $doc->saveHTML();
646 $message = str_replace("[img]", "", $message);
647 $message = str_replace("[/img]", "", $message);
650 // was ersetze ich da?
651 // Irgendein stoerrisches UTF-Zeug
652 $message = str_replace(chr(194) . chr(160), ' ', $message);
654 $message = str_replace(" ", " ", $message);
656 // Aufeinanderfolgende DIVs
657 $message = preg_replace('=\r *\r=i', "\n", $message);
658 $message = str_replace("\r", "\n", $message);
660 $message = strip_tags($message);
662 $message = html_entity_decode($message, ENT_QUOTES, 'UTF-8');
664 if (!$compact && ($message != '')) {
665 foreach ($urls as $id => $url) {
666 if ($url != '' && strpos($message, $url) === false) {
667 $message .= "\n" . $url . ' ';
672 $message = str_replace("\n«", "«\n", $message);
673 $message = str_replace("»\n", "\n»", $message);
676 $oldmessage = $message;
677 $message = str_replace("\n\n\n", "\n\n", $message);
678 } while ($oldmessage != $message);
680 $message = self::quoteLevel(trim($message), $wraplength);
682 DI::profiler()->stopRecording();
683 return trim($message);
687 * Converts provided HTML code to Markdown. The hardwrap parameter maximizes
688 * compatibility with Diaspora in spite of the Markdown standards.
690 * @param string $html
693 public static function toMarkdown(string $html): string
695 DI::profiler()->startRecording('rendering');
696 $converter = new HtmlConverter(['hard_break' => true]);
697 $markdown = $converter->convert($html);
699 DI::profiler()->stopRecording();
704 * Convert video HTML to BBCode tags
709 public static function toBBCodeVideo(string $s): string
712 '#<object[^>]+>(.*?)https?://www.youtube.com/((?:v|cp)/[A-Za-z0-9\-_=]+)(.*?)</object>#ism',
713 '[youtube]$2[/youtube]',
718 '#<iframe[^>](.*?)https?://www.youtube.com/embed/([A-Za-z0-9\-_=]+)(.*?)</iframe>#ism',
719 '[youtube]$2[/youtube]',
724 '#<iframe[^>](.*?)https?://player.vimeo.com/video/([0-9]+)(.*?)</iframe>#ism',
733 * transform link href and img src from relative to absolute
735 * @param string $text
736 * @param string $base base url
739 public static function relToAbs(string $text, string $base): string
745 $base = rtrim($base, '/');
747 $base2 = $base . "/";
750 $pattern = "/<a([^>]*) href=\"(?!http|https|\/)([^\"]*)\"/";
751 $replace = "<a\${1} href=\"" . $base2 . "\${2}\"";
752 $text = preg_replace($pattern, $replace, $text);
754 $pattern = "/<a([^>]*) href=\"(?!http|https)([^\"]*)\"/";
755 $replace = "<a\${1} href=\"" . $base . "\${2}\"";
756 $text = preg_replace($pattern, $replace, $text);
759 $pattern = "/<img([^>]*) src=\"(?!http|https|\/)([^\"]*)\"/";
760 $replace = "<img\${1} src=\"" . $base2 . "\${2}\"";
761 $text = preg_replace($pattern, $replace, $text);
763 $pattern = "/<img([^>]*) src=\"(?!http|https)([^\"]*)\"/";
764 $replace = "<img\${1} src=\"" . $base . "\${2}\"";
765 $text = preg_replace($pattern, $replace, $text);
773 * Loader for infinite scrolling
775 * @return string html for loader
776 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
778 public static function scrollLoader(): string
780 $tpl = Renderer::getMarkupTemplate("scroll_loader.tpl");
781 return Renderer::replaceMacros($tpl, [
782 'wait' => DI::l10n()->t('Loading more entries...'),
783 'end' => DI::l10n()->t('The end')
788 * Format contacts as picture links or as text links
790 * @param array $contact Array with contacts which contains an array with
791 * int 'id' => The ID of the contact
792 * int 'uid' => The user ID of the user who owns this data
793 * string 'name' => The name of the contact
794 * string 'url' => The url to the profile page of the contact
795 * string 'addr' => The webbie of the contact (e.g.) username@friendica.com
796 * string 'network' => The network to which the contact belongs to
797 * string 'thumb' => The contact picture
798 * string 'click' => js code which is performed when clicking on the contact
799 * @param boolean $redirect If true try to use the redir url if it's possible
800 * @param string $class CSS class for the
801 * @param boolean $textmode If true display the contacts as text links
802 * if false display the contacts as picture links
803 * @return string Formatted html
804 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
805 * @throws \ImagickException
807 public static function micropro(array $contact, bool $redirect = false, string $class = '', bool $textmode = false): string
809 // Use the contact URL if no address is available
810 if (empty($contact['addr'])) {
811 $contact["addr"] = $contact["url"];
814 $url = $contact['url'];
819 $url = Contact::magicLinkByContact($contact);
820 if (strpos($url, 'contact/redir/') === 0) {
821 $sparkle = ' sparkle';
825 // If there is some js available we don't need the url
826 if (!empty($contact['click'])) {
830 return Renderer::replaceMacros(Renderer::getMarkupTemplate($textmode ? 'micropro_txt.tpl' : 'micropro_img.tpl'), [
831 '$click' => $contact['click'] ?? '',
834 '$photo' => Contact::getThumb($contact),
835 '$name' => $contact['name'],
836 'title' => $contact['name'] . ' [' . $contact['addr'] . ']',
837 '$parkle' => $sparkle,
845 * @param string $s Search query.
846 * @param string $id HTML id
847 * @param bool $aside Display the search widget aside.
849 * @return string Formatted HTML.
852 public static function search(string $s, string $id = 'search-box', bool $aside = true): string
856 if (strpos($s, '#') === 0) {
859 $save_label = $mode === 'text' ? DI::l10n()->t('Save') : DI::l10n()->t('Follow');
863 '$q' => urlencode($s),
865 '$search_label' => DI::l10n()->t('Search'),
866 '$save_label' => $save_label,
867 '$search_hint' => DI::l10n()->t('@name, !group, #tags, content'),
869 '$return_url' => urlencode(Search::getSearchPath($s)),
873 $values['$search_options'] = [
874 'fulltext' => DI::l10n()->t('Full Text'),
875 'tags' => DI::l10n()->t('Tags'),
876 'contacts' => DI::l10n()->t('Contacts')
879 if (DI::config()->get('system', 'poco_local_search')) {
880 $values['$searchoption']['groups'] = DI::l10n()->t('Groups');
884 return Renderer::replaceMacros(Renderer::getMarkupTemplate('searchbox.tpl'), $values);
888 * Given a HTML text and a set of filtering reasons, adds a content hiding header with the provided reasons
890 * Reasons are expected to have been translated already.
892 * @param string $html
893 * @param array $reasons
895 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
897 public static function applyContentFilter(string $html, array $reasons): string
899 if (count($reasons)) {
900 $tpl = Renderer::getMarkupTemplate('wall/content_filter.tpl');
901 $html = Renderer::replaceMacros($tpl, [
902 '$reasons' => $reasons,
903 '$rnd' => Strings::getRandomHex(8),
904 '$openclose' => DI::l10n()->t('Click to open/close'),
913 * replace html amp entity with amp char
917 public static function unamp(string $s): string
919 return str_replace('&', '&', $s);
923 * Clean an HTML text for potentially harmful code
925 * @param string $text
926 * @param array $allowedIframeDomains List of allowed iframe source domains without the scheme
929 public static function purify(string $text, array $allowedIframeDomains = []): string
931 // Allows cid: URL scheme
932 \HTMLPurifier_URISchemeRegistry::instance()->register('cid', new HTMLPurifier_URIScheme_cid());
934 $config = \HTMLPurifier_HTML5Config::createDefault();
935 $config->set('HTML.Doctype', 'HTML5');
937 // Used to remove iframe with src attribute filtered out
938 $config->set('AutoFormat.RemoveEmpty', true);
940 $config->set('HTML.SafeIframe', true);
942 array_walk($allowedIframeDomains, function (&$domain) {
943 // Allow the domain and all its eventual sub-domains
944 $domain = '(?:(?!-)[A-Za-z0-9-]{1,63}(?<!-)\.)*' . preg_quote(trim($domain, '/'), '%');
948 'URI.SafeIframeRegexp',
950 ' . implode('|', $allowedIframeDomains) . '
952 (?:/|$) # Prevents bogus domains like youtube.com.fake.tld
956 $config->set('Attr.AllowedRel', [
957 'noreferrer' => true,
961 $config->set('Attr.AllowedFrameTargets', [
965 $config->set('AutoFormat.RemoveEmpty.Predicate', [
966 'colgroup' => [], // |
969 'iframe' => ['src'], // ↳ Default HTMLPurify values
970 'i' => ['class'], // Allows forkawesome icons
973 // Uncomment to debug HTMLPurifier behavior
974 //$config->set('Core.CollectErrors', true);
975 //$config->set('Core.MaintainLineNumbers', true);
977 $HTMLPurifier = new \HTMLPurifier($config);
979 $text = $HTMLPurifier->purify($text);
981 /** @var \HTMLPurifier_ErrorCollector $errorCollector */
982 // Uncomment to debug HTML Purifier behavior
983 //$errorCollector = $HTMLPurifier->context->get('ErrorCollector');
984 //var_dump($errorCollector->getRaw());
990 * XPath arbitrary string quoting
992 * @see https://stackoverflow.com/a/45228168
993 * @param string $value
996 public static function xpathQuote(string $value): string
998 if (false === strpos($value, '"')) {
999 return '"' . $value . '"';
1002 if (false === strpos($value, "'")) {
1003 return "'" . $value . "'";
1006 // if the value contains both single and double quotes, construct an
1007 // expression that concatenates all non-double-quote substrings with
1008 // the quotes, e.g.:
1010 // concat("'foo'", '"', "bar")
1011 return 'concat(' . implode(', \'"\', ', array_map([self::class, 'xpathQuote'], explode('"', $value))) . ')';
1015 * Checks if the provided URL is present in the DOM document in an element with the rel="me" attribute
1017 * XHTML Friends Network http://gmpg.org/xfn/
1019 * @param DOMDocument $doc
1020 * @param UriInterface $meUrl
1023 public static function checkRelMeLink(DOMDocument $doc, UriInterface $meUrl): bool
1025 $xpath = new \DOMXpath($doc);
1027 // This expression checks that "me" is among the space-delimited values of the "rel" attribute.
1028 // And that the href attribute contains exactly the provided URL
1029 $expression = "//*[contains(concat(' ', normalize-space(@rel), ' '), ' me ')][@href = " . self::xpathQuote($meUrl) . "]";
1031 $result = $xpath->query($expression);
1033 return $result !== false && $result->length > 0;
1037 * @param DOMDocument $doc
1038 * @return string|null Lowercase charset
1040 public static function extractCharset(DOMDocument $doc): ?string
1042 $xpath = new DOMXPath($doc);
1044 $expression = "string(//meta[@charset]/@charset)";
1045 if ($charset = $xpath->evaluate($expression)) {
1046 return strtolower($charset);
1050 // This expression looks for a meta tag with the http-equiv attribute set to "content-type" ignoring case
1051 // whose content attribute contains a "charset" string and returns its value
1052 $expression = "string(//meta[@http-equiv][translate(@http-equiv, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz') = 'content-type'][contains(translate(@content, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz'), 'charset')]/@content)";
1053 $mediaType = MediaType::fromContentType($xpath->evaluate($expression));
1054 if (isset($mediaType->parameters['charset'])) {
1055 return strtolower($mediaType->parameters['charset']);
1057 } catch (\InvalidArgumentException $e) {