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;
27 use Friendica\Content\ContactSelector;
28 use Friendica\Content\Item;
29 use Friendica\Content\OEmbed;
30 use Friendica\Content\PageInfo;
31 use Friendica\Content\Smilies;
32 use Friendica\Core\Hook;
33 use Friendica\Core\Logger;
34 use Friendica\Core\Protocol;
35 use Friendica\Core\Renderer;
37 use Friendica\Model\Contact;
38 use Friendica\Model\Event;
39 use Friendica\Model\Photo;
40 use Friendica\Model\Post;
41 use Friendica\Model\Tag;
42 use Friendica\Network\HTTPClient\Client\HttpClientAccept;
43 use Friendica\Network\HTTPClient\Client\HttpClientOptions;
44 use Friendica\Object\Image;
45 use Friendica\Protocol\Activity;
46 use Friendica\Util\Images;
47 use Friendica\Util\Map;
48 use Friendica\Util\ParseUrl;
49 use Friendica\Util\Proxy;
50 use Friendica\Util\Strings;
51 use Friendica\Util\XML;
55 // Update this value to the current date whenever changes are made to BBCode::convert
56 const VERSION = '2021-07-28';
60 const MASTODON_API = 2;
63 const TWITTER_API = 5;
67 const ACTIVITYPUB = 9;
69 const TOP_ANCHOR = '<br class="top-anchor">';
70 const BOTTOM_ANCHOR = '<br class="button-anchor">';
72 const PREVIEW_NONE = 0;
73 const PREVIEW_NO_IMAGE = 1;
74 const PREVIEW_LARGE = 2;
75 const PREVIEW_SMALL = 3;
78 * Fetches attachment data that were generated the old way
80 * @param string $body Message body
82 * 'type' -> Message type ('link', 'video', 'photo')
83 * 'text' -> Text before the shared message
84 * 'after' -> Text after the shared message
85 * 'image' -> Preview image of the message
86 * 'url' -> Url to the attached message
87 * 'title' -> Title of the attachment
88 * 'description' -> Description of the attachment
89 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
91 private static function getOldAttachmentData(string $body): array
95 // Simplify image codes
96 $body = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $body);
98 if (preg_match_all("(\[class=(.*?)\](.*?)\[\/class\])ism", $body, $attached, PREG_SET_ORDER)) {
99 foreach ($attached as $data) {
100 if (!in_array($data[1], ['type-link', 'type-video', 'type-photo'])) {
104 $post['type'] = substr($data[1], 5);
106 $pos = strpos($body, $data[0]);
108 $post['text'] = trim(substr($body, 0, $pos));
109 $post['after'] = trim(substr($body, $pos + strlen($data[0])));
111 $post['text'] = trim(str_replace($data[0], '', $body));
115 $attacheddata = $data[2];
117 if (preg_match("/\[img\](.*?)\[\/img\]/ism", $attacheddata, $matches)) {
119 $picturedata = Images::getInfoFromURLCached($matches[1]);
122 if (($picturedata[0] >= 500) && ($picturedata[0] >= $picturedata[1])) {
123 $post['image'] = $matches[1];
125 $post['preview'] = $matches[1];
130 if (preg_match("/\[bookmark\=(.*?)\](.*?)\[\/bookmark\]/ism", $attacheddata, $matches)) {
131 $post['url'] = $matches[1];
132 $post['title'] = $matches[2];
134 if (!empty($post['url']) && (in_array($post['type'], ['link', 'video']))
135 && preg_match("/\[url\=(.*?)\](.*?)\[\/url\]/ism", $attacheddata, $matches)) {
136 $post['url'] = $matches[1];
139 // Search for description
140 if (preg_match("/\[quote\](.*?)\[\/quote\]/ism", $attacheddata, $matches)) {
141 $post['description'] = $matches[1];
149 * Fetches attachment data that were generated with the "attachment" element
151 * @param string $body Message body
153 * 'type' -> Message type ('link', 'video', 'photo')
154 * 'text' -> Text before the shared message
155 * 'after' -> Text after the shared message
156 * 'image' -> Preview image of the message
157 * 'url' -> Url to the attached message
158 * 'title' -> Title of the attachment
159 * 'description' -> Description of the attachment
160 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
162 public static function getAttachmentData(string $body): array
164 DI::profiler()->startRecording('rendering');
173 'provider_name' => '',
174 'provider_url' => '',
179 if (!preg_match("/(.*)\[attachment(.*?)\](.*?)\[\/attachment\](.*)/ism", $body, $match)) {
180 DI::profiler()->stopRecording();
181 return self::getOldAttachmentData($body);
184 $attributes = $match[2];
186 $data['text'] = trim($match[1]);
188 foreach (['type', 'url', 'title', 'image', 'preview', 'publisher_name', 'publisher_url', 'author_name', 'author_url'] as $field) {
189 preg_match('/' . preg_quote($field, '/') . '=("|\')(.*?)\1/ism', $attributes, $matches);
190 $value = $matches[2] ?? '';
194 case 'publisher_name':
195 $data['provider_name'] = html_entity_decode($value, ENT_QUOTES, 'UTF-8');
198 case 'publisher_url':
199 $data['provider_url'] = html_entity_decode($value, ENT_QUOTES, 'UTF-8');
203 $data['author_name'] = html_entity_decode($value, ENT_QUOTES, 'UTF-8');
204 if ($data['provider_name'] == $data['author_name']) {
205 $data['author_name'] = '';
210 $data['author_url'] = html_entity_decode($value, ENT_QUOTES, 'UTF-8');
211 if ($data['provider_url'] == $data['author_url']) {
212 $data['author_url'] = '';
217 $value = self::convert(html_entity_decode($value, ENT_QUOTES, 'UTF-8'), false, true);
218 $value = html_entity_decode($value, ENT_QUOTES, 'UTF-8');
219 $value = str_replace(['[', ']'], ['[', ']'], $value);
220 $data['title'] = $value;
223 $data[$field] = html_entity_decode($value, ENT_QUOTES, 'UTF-8');
229 if (!in_array($data['type'], ['link', 'audio', 'photo', 'video'])) {
230 DI::profiler()->stopRecording();
234 $data['description'] = trim($match[3]);
236 $data['after'] = trim($match[4]);
238 $parts = parse_url($data['url']);
239 if (!empty($parts['scheme']) && !empty($parts['host'])) {
240 if (empty($data['provider_name'])) {
241 $data['provider_name'] = $parts['host'];
243 if (empty($data['provider_url']) || empty(parse_url($data['provider_url'], PHP_URL_SCHEME))) {
244 $data['provider_url'] = $parts['scheme'] . '://' . $parts['host'];
246 if (!empty($parts['port'])) {
247 $data['provider_url'] .= ':' . $parts['port'];
252 DI::profiler()->stopRecording();
256 public static function getAttachedData(string $body, array $item = []): array
260 - type: link, video, photo
268 DI::profiler()->startRecording('rendering');
269 $has_title = !empty($item['title']);
270 $plink = $item['plink'] ?? '';
271 $post = self::getAttachmentData($body);
273 // Get all linked images with alternative image description
274 if (preg_match_all("/\[img=(http[^\[\]]*)\]([^\[\]]*)\[\/img\]/Usi", $body, $pictures, PREG_SET_ORDER)) {
275 foreach ($pictures as $picture) {
276 if ($id = Photo::getIdForName($picture[1])) {
277 $post['images'][] = ['url' => str_replace('-1.', '-0.', $picture[1]), 'description' => $picture[2], 'id' => $id];
279 $post['remote_images'][] = ['url' => $picture[1], 'description' => $picture[2]];
282 if (!empty($post['images']) && !empty($post['images'][0]['description'])) {
283 $post['image_description'] = $post['images'][0]['description'];
287 if (preg_match_all("/\[img\]([^\[\]]*)\[\/img\]/Usi", $body, $pictures, PREG_SET_ORDER)) {
288 foreach ($pictures as $picture) {
289 if ($id = Photo::getIdForName($picture[1])) {
290 $post['images'][] = ['url' => str_replace('-1.', '-0.', $picture[1]), 'description' => '', 'id' => $id];
292 $post['remote_images'][] = ['url' => $picture[1], 'description' => ''];
297 if (!isset($post['type'])) {
298 $post['text'] = $body;
301 // Simplify image codes
302 $post['text'] = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $post['text']);
303 $post['text'] = preg_replace("/\[img\=(.*?)\](.*?)\[\/img\]/ism", '[img]$1[/img]', $post['text']);
305 // if nothing is found, it maybe having an image.
306 if (!isset($post['type'])) {
307 if (preg_match_all("#\[url=([^\]]+?)\]\s*\[img\]([^\[]+?)\[/img\]\s*\[/url\]#ism", $post['text'], $pictures, PREG_SET_ORDER)) {
308 if ((count($pictures) == 1) && !$has_title) {
309 if (!empty($item['object-type']) && ($item['object-type'] == Activity\ObjectType::IMAGE)) {
310 // Replace the preview picture with the real picture
311 $url = str_replace('-1.', '-0.', $pictures[0][2]);
312 $data = ['url' => $url, 'type' => 'photo'];
314 // Checking, if the link goes to a picture
315 $data = ParseUrl::getSiteinfoCached($pictures[0][1]);
319 // Sometimes photo posts to the own album are not detected at the start.
320 // So we seem to cannot use the cache for these cases. That's strange.
321 if (($data['type'] != 'photo') && strstr($pictures[0][1], '/photos/')) {
322 $data = ParseUrl::getSiteinfo($pictures[0][1]);
325 if ($data['type'] == 'photo') {
326 $post['type'] = 'photo';
327 if (isset($data['images'][0])) {
328 $post['image'] = $data['images'][0]['src'];
329 $post['url'] = $data['url'];
331 $post['image'] = $data['url'];
334 $post['preview'] = $pictures[0][2];
335 $post['text'] = trim(str_replace($pictures[0][0], '', $post['text']));
337 $imgdata = Images::getInfoFromURLCached($pictures[0][1]);
338 if (($imgdata) && substr($imgdata['mime'], 0, 6) == 'image/') {
339 $post['type'] = 'photo';
340 $post['image'] = $pictures[0][1];
341 $post['preview'] = $pictures[0][2];
342 $post['text'] = trim(str_replace($pictures[0][0], '', $post['text']));
345 } elseif (count($pictures) > 0) {
346 if (count($pictures) > 4) {
347 $post['type'] = 'link';
348 $post['url'] = $plink;
350 $post['type'] = 'photo';
353 $post['image'] = $pictures[0][2];
355 foreach ($pictures as $picture) {
356 $post['text'] = trim(str_replace($picture[0], '', $post['text']));
359 } elseif (preg_match_all("(\[img\](.*?)\[\/img\])ism", $post['text'], $pictures, PREG_SET_ORDER)) {
361 $post['type'] = 'link';
362 $post['url'] = $plink;
364 $post['type'] = 'photo';
367 $post['image'] = $pictures[0][1];
368 foreach ($pictures as $picture) {
369 $post['text'] = trim(str_replace($picture[0], '', $post['text']));
373 // Test for the external links
374 preg_match_all("(\[url\](.*?)\[\/url\])ism", $post['text'], $links1, PREG_SET_ORDER);
375 preg_match_all("(\[url\=(.*?)\].*?\[\/url\])ism", $post['text'], $links2, PREG_SET_ORDER);
377 $links = array_merge($links1, $links2);
379 // If there is only a single one, then use it.
380 // This should cover link posts via API.
381 if ((count($links) == 1) && !isset($post['preview']) && !$has_title) {
382 $post['type'] = 'link';
383 $post['url'] = $links[0][1];
386 // Simplify "video" element
387 $post['text'] = preg_replace('(\[video.*?\ssrc\s?=\s?([^\s\]]+).*?\].*?\[/video\])ism', '[video]$1[/video]', $post['text']);
389 // Now count the number of external media links
390 preg_match_all("(\[vimeo\](.*?)\[\/vimeo\])ism", $post['text'], $links1, PREG_SET_ORDER);
391 preg_match_all("(\[youtube\\](.*?)\[\/youtube\\])ism", $post['text'], $links2, PREG_SET_ORDER);
392 preg_match_all("(\[video\\](.*?)\[\/video\\])ism", $post['text'], $links3, PREG_SET_ORDER);
393 preg_match_all("(\[audio\\](.*?)\[\/audio\\])ism", $post['text'], $links4, PREG_SET_ORDER);
395 // Add them to the other external links
396 $links = array_merge($links, $links1, $links2, $links3, $links4);
398 // Are there more than one?
399 if (count($links) > 1) {
400 // The post will be the type "text", which means a blog post
401 unset($post['type']);
402 $post['url'] = $plink;
405 if (!isset($post['type'])) {
406 $post['type'] = 'text';
409 if (($post['type'] == 'photo') && empty($post['images']) && !empty($post['remote_images'])) {
410 $post['images'] = $post['remote_images'];
411 $post['image'] = $post['images'][0]['url'];
412 if (!empty($post['images']) && !empty($post['images'][0]['description'])) {
413 $post['image_description'] = $post['images'][0]['description'];
416 unset($post['remote_images']);
417 } elseif (isset($post['url']) && ($post['type'] == 'video')) {
418 $data = ParseUrl::getSiteinfoCached($post['url']);
420 if (isset($data['images'][0])) {
421 $post['image'] = $data['images'][0]['src'];
423 } elseif (preg_match_all("#\[url=([^\]]+?)\]\s*\[img\]([^\[]+?)\[/img\]\s*\[/url\]#ism", $post['text'], $pictures, PREG_SET_ORDER)) {
424 foreach ($pictures as $picture) {
425 $post['text'] = trim(str_replace($picture[0], '', $post['text']));
429 DI::profiler()->stopRecording();
434 * Remove [attachment] BBCode and replaces it with a regular [url]
436 * @param string $body
437 * @param boolean $no_link_desc No link description
438 * @return string with replaced body
440 public static function removeAttachment(string $body, bool $no_link_desc = false): string
442 return preg_replace_callback("/\s*\[attachment (.*?)\](.*?)\[\/attachment\]\s*/ism",
443 function ($match) use ($body, $no_link_desc) {
444 $attach_data = self::getAttachmentData($match[0]);
445 if (empty($attach_data['url'])) {
447 } elseif (strpos(str_replace($match[0], '', $body), $attach_data['url']) !== false) {
449 } elseif (empty($attach_data['title']) || $no_link_desc) {
450 return " \n[url]" . $attach_data['url'] . "[/url]\n";
452 return " \n[url=" . $attach_data['url'] . ']' . $attach_data['title'] . "[/url]\n";
458 * Converts a BBCode text into plaintext
460 * @param string $text
461 * @param bool $keep_urls Whether to keep URLs in the resulting plaintext
464 public static function toPlaintext(string $text, bool $keep_urls = true): string
466 DI::profiler()->startRecording('rendering');
467 // Remove pictures in advance to avoid unneeded proxy calls
468 $text = preg_replace("/\[img\=(.*?)\](.*?)\[\/img\]/ism", ' $2 ', $text);
469 $text = preg_replace("/\[img.*?\[\/img\]/ism", ' ', $text);
472 $text = self::removeAttachment($text);
474 $naked_text = HTML::toPlaintext(self::convert($text, false, 0, true), 0, !$keep_urls);
476 DI::profiler()->stopRecording();
480 private static function proxyUrl(string $image, int $simplehtml = self::INTERNAL, int $uriid = 0, string $size = ''): string
482 // Only send proxied pictures to API and for internal display
483 if (!in_array($simplehtml, [self::INTERNAL, self::MASTODON_API, self::TWITTER_API])) {
485 } elseif ($uriid > 0) {
486 return Post\Link::getByLink($uriid, $image, $size);
488 return Proxy::proxifyUrl($image, $size);
493 * Truncates imported message body string length to max_import_size
495 * The purpose of this function is to apply system message length limits to
496 * imported messages without including any embedded photos in the length
498 * @param string $body
500 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
502 public static function limitBodySize(string $body): string
504 DI::profiler()->startRecording('rendering');
505 $maxlen = DI::config()->get('config', 'max_import_size', 0);
507 // If the length of the body, including the embedded images, is smaller
508 // than the maximum, then don't waste time looking for the images
509 if ($maxlen && (strlen($body) > $maxlen)) {
511 Logger::info('the total body length exceeds the limit', ['maxlen' => $maxlen, 'body_len' => strlen($body)]);
517 $img_start = strpos($orig_body, '[img');
518 $img_st_close = ($img_start !== false ? strpos(substr($orig_body, $img_start), ']') : false);
519 $img_end = ($img_start !== false ? strpos(substr($orig_body, $img_start), '[/img]') : false);
520 while (($img_st_close !== false) && ($img_end !== false)) {
522 $img_st_close++; // make it point to AFTER the closing bracket
523 $img_end += $img_start;
524 $img_end += strlen('[/img]');
526 if (!strcmp(substr($orig_body, $img_start + $img_st_close, 5), 'data:')) {
527 // This is an embedded image
529 if (($textlen + $img_start) > $maxlen) {
530 if ($textlen < $maxlen) {
531 Logger::debug('the limit happens before an embedded image');
532 $new_body = $new_body . substr($orig_body, 0, $maxlen - $textlen);
536 $new_body = $new_body . substr($orig_body, 0, $img_start);
537 $textlen += $img_start;
540 $new_body = $new_body . substr($orig_body, $img_start, $img_end - $img_start);
543 if (($textlen + $img_end) > $maxlen) {
544 if ($textlen < $maxlen) {
545 Logger::debug('the limit happens before the end of a non-embedded image');
546 $new_body = $new_body . substr($orig_body, 0, $maxlen - $textlen);
550 $new_body = $new_body . substr($orig_body, 0, $img_end);
551 $textlen += $img_end;
554 $orig_body = substr($orig_body, $img_end);
556 if ($orig_body === false) {
557 // in case the body ends on a closing image tag
561 $img_start = strpos($orig_body, '[img');
562 $img_st_close = ($img_start !== false ? strpos(substr($orig_body, $img_start), ']') : false);
563 $img_end = ($img_start !== false ? strpos(substr($orig_body, $img_start), '[/img]') : false);
566 if (($textlen + strlen($orig_body)) > $maxlen) {
567 if ($textlen < $maxlen) {
568 Logger::debug('the limit happens after the end of the last image');
569 $new_body = $new_body . substr($orig_body, 0, $maxlen - $textlen);
572 Logger::debug('the text size with embedded images extracted did not violate the limit');
573 $new_body = $new_body . $orig_body;
576 DI::profiler()->stopRecording();
579 DI::profiler()->stopRecording();
585 * Processes [attachment] tags
587 * Note: Can produce a [bookmark] tag in the returned string
589 * @param string $text
590 * @param integer $simplehtml
591 * @param bool $tryoembed
595 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
597 public static function convertAttachment(string $text, int $simplehtml = self::INTERNAL, bool $tryoembed = true, array $data = [], int $uriid = 0, int $preview_mode = self::PREVIEW_LARGE): string
599 DI::profiler()->startRecording('rendering');
600 $data = $data ?: self::getAttachmentData($text);
601 if (empty($data) || empty($data['url'])) {
602 DI::profiler()->stopRecording();
606 if (isset($data['title'])) {
607 $data['title'] = strip_tags($data['title']);
608 $data['title'] = str_replace(['http://', 'https://'], '', $data['title']);
613 if (((strpos($data['text'], '[img=') !== false) || (strpos($data['text'], '[img]') !== false) || DI::config()->get('system', 'always_show_preview')) && !empty($data['image'])) {
614 $data['preview'] = $data['image'];
620 if ($tryoembed && OEmbed::isAllowedURL($data['url'])) {
621 $return = OEmbed::getHTML($data['url'], $data['title']);
623 throw new Exception('OEmbed is disabled for this attachment.');
625 } catch (Exception $e) {
626 $data['title'] = ($data['title'] ?? '') ?: $data['url'];
628 if ($simplehtml != self::CONNECTORS) {
629 $return = sprintf('<div class="type-%s">', $data['type']);
632 if ($preview_mode == self::PREVIEW_NO_IMAGE) {
633 unset($data['image']);
634 unset($data['preview']);
637 if (!empty($data['title']) && !empty($data['url'])) {
638 $preview_class = $preview_mode == self::PREVIEW_LARGE ? 'attachment-image' : 'attachment-preview';
639 if (!empty($data['image']) && empty($data['text']) && ($data['type'] == 'photo')) {
640 $return .= sprintf('<a href="%s" target="_blank" rel="noopener noreferrer"><img src="%s" alt="" title="%s" class="' . $preview_class . '" /></a>', $data['url'], self::proxyUrl($data['image'], $simplehtml, $uriid), $data['title']);
642 if (!empty($data['image'])) {
643 $return .= sprintf('<a href="%s" target="_blank" rel="noopener noreferrer"><img src="%s" alt="" title="%s" class="' . $preview_class . '" /></a><br>', $data['url'], self::proxyUrl($data['image'], $simplehtml, $uriid), $data['title']);
644 } elseif (!empty($data['preview'])) {
645 $return .= sprintf('<a href="%s" target="_blank" rel="noopener noreferrer"><img src="%s" alt="" title="%s" class="attachment-preview" /></a><br>', $data['url'], self::proxyUrl($data['preview'], $simplehtml, $uriid), $data['title']);
647 $return .= sprintf('<h4><a href="%s" target="_blank" rel="noopener noreferrer">%s</a></h4>', $data['url'], $data['title']);
651 if (!empty($data['description']) && $data['description'] != $data['title']) {
653 $return .= sprintf('<blockquote>%s</blockquote>', trim(HTML::purify($data['description'])));
656 if (!empty($data['provider_url']) && !empty($data['provider_name'])) {
657 if (!empty($data['author_name'])) {
658 $return .= sprintf('<sup><a href="%s" target="_blank" rel="noopener noreferrer">%s (%s)</a></sup>', $data['provider_url'], $data['author_name'], $data['provider_name']);
660 $return .= sprintf('<sup><a href="%s" target="_blank" rel="noopener noreferrer">%s</a></sup>', $data['provider_url'], $data['provider_name']);
664 if ($simplehtml != self::CONNECTORS) {
669 DI::profiler()->stopRecording();
670 return trim(($data['text'] ?? '') . ' ' . $return . ' ' . ($data['after'] ?? ''));
673 public static function removeShareInformation(string $text, bool $plaintext = false, bool $nolink = false): string
675 DI::profiler()->startRecording('rendering');
676 $data = self::getAttachmentData($text);
679 DI::profiler()->stopRecording();
682 DI::profiler()->stopRecording();
683 return $data['text'] . ($data['after'] ?? '');
686 $title = htmlentities($data['title'] ?? '', ENT_QUOTES, 'UTF-8', false);
687 $text = htmlentities($data['text'], ENT_QUOTES, 'UTF-8', false);
688 if ($plaintext || (($title != '') && strstr($text, $title))) {
689 $data['title'] = $data['url'];
690 } elseif (($text != '') && strstr($title, $text)) {
691 $data['text'] = $data['title'];
692 $data['title'] = $data['url'];
695 if (empty($data['text']) && !empty($data['title']) && empty($data['url'])) {
696 DI::profiler()->stopRecording();
697 return $data['title'] . $data['after'];
700 // If the link already is included in the post, don't add it again
701 if (!empty($data['url']) && strpos($data['text'], $data['url'])) {
702 DI::profiler()->stopRecording();
703 return $data['text'] . $data['after'];
706 $text = $data['text'];
708 if (!empty($data['url']) && !empty($data['title'])) {
709 $text .= "\n[url=" . $data['url'] . ']' . $data['title'] . '[/url]';
710 } elseif (!empty($data['url'])) {
711 $text .= "\n[url]" . $data['url'] . '[/url]';
714 DI::profiler()->stopRecording();
715 return $text . "\n" . $data['after'];
719 * Converts [url] BBCodes in a format that looks fine on Mastodon. (callback function)
721 * @param array $match Array with the matching values
722 * @return string reformatted link including HTML codes
724 private static function convertUrlForActivityPubCallback(array $match): string
728 if (isset($match[2]) && ($match[1] != $match[2])) {
732 $parts = parse_url($url);
733 if (!isset($parts['scheme'])) {
737 return self::convertUrlForActivityPub($url);
741 * Converts [url] BBCodes in a format that looks fine on ActivityPub systems.
743 * @param string $url URL that is about to be reformatted
744 * @return string reformatted link including HTML codes
746 private static function convertUrlForActivityPub(string $url): string
748 return sprintf('<a href="%s" target="_blank" rel="noopener noreferrer">%s</a>', $url, self::getStyledURL($url));
752 * Converts an URL in a nicer format (without the scheme and possibly shortened)
754 * @param string $url URL that is about to be reformatted
755 * @return string reformatted link
757 private static function getStyledURL(string $url): string
759 $parts = parse_url($url);
760 $scheme = $parts['scheme'] . '://';
761 $styled_url = str_replace($scheme, '', $url);
763 if (strlen($styled_url) > 30) {
764 $styled_url = substr($styled_url, 0, 30) . "…";
771 * [noparse][i]italic[/i][/noparse] turns into
772 * [noparse][ i ]italic[ /i ][/noparse],
773 * to hide them from parser.
775 * @param array $match
778 private static function escapeNoparseCallback(array $match): string
780 $whole_match = $match[0];
781 $captured = $match[1];
782 $spacefied = preg_replace("/\[(.*?)\]/", "[ $1 ]", $captured);
783 $new_str = str_replace($captured, $spacefied, $whole_match);
788 * The previously spacefied [noparse][ i ]italic[ /i ][/noparse],
789 * now turns back and the [noparse] tags are trimed
790 * returning [i]italic[/i]
792 * @param array $match
795 private static function unescapeNoparseCallback(array $match): string
797 $captured = $match[1];
798 $unspacefied = preg_replace("/\[ (.*?)\ ]/", "[$1]", $captured);
803 * Returns the bracket character positions of a set of opening and closing BBCode tags, optionally skipping first
806 * @param string $text Text to search
807 * @param string $name Tag name
808 * @param int $occurrences Number of first occurrences to skip
809 * @return boolean|array
811 public static function getTagPosition(string $text, string $name, int $occurrences = 0)
813 DI::profiler()->startRecording('rendering');
814 if ($occurrences < 0) {
819 for ($i = 0; $i <= $occurrences; $i++) {
820 if ($start_open !== false) {
821 $start_open = strpos($text, '[' . $name, $start_open + 1); // allow [name= type tags
825 if ($start_open === false) {
826 DI::profiler()->stopRecording();
830 $start_equal = strpos($text, '=', $start_open);
831 $start_close = strpos($text, ']', $start_open);
833 if ($start_close === false) {
834 DI::profiler()->stopRecording();
840 $end_open = strpos($text, '[/' . $name . ']', $start_close);
842 if ($end_open === false) {
843 DI::profiler()->stopRecording();
849 'open' => $start_open,
850 'close' => $start_close
854 'close' => $end_open + strlen('[/' . $name . ']')
858 if ($start_equal !== false) {
859 $res['start']['equal'] = $start_equal + 1;
862 DI::profiler()->stopRecording();
867 * Performs a preg_replace within the boundaries of all named BBCode tags in a text
869 * @param string $pattern Preg pattern string
870 * @param string $replace Preg replace string
871 * @param string $name BBCode tag name
872 * @param string $text Text to search
875 public static function pregReplaceInTag(string $pattern, string $replace, string $name, string $text): string
877 DI::profiler()->startRecording('rendering');
879 $pos = self::getTagPosition($text, $name, $occurrences);
880 while ($pos !== false && $occurrences++ < 1000) {
881 $start = substr($text, 0, $pos['start']['open']);
882 $subject = substr($text, $pos['start']['open'], $pos['end']['close'] - $pos['start']['open']);
883 $end = substr($text, $pos['end']['close']);
884 if ($end === false) {
888 $subject = preg_replace($pattern, $replace, $subject);
889 $text = $start . $subject . $end;
891 $pos = self::getTagPosition($text, $name, $occurrences);
894 DI::profiler()->stopRecording();
898 private static function extractImagesFromItemBody(string $body): array
905 $img_start = strpos($orig_body, '[img');
906 $img_st_close = ($img_start !== false ? strpos(substr($orig_body, $img_start), ']') : false);
907 $img_end = ($img_start !== false ? strpos(substr($orig_body, $img_start), '[/img]') : false);
908 while (($img_st_close !== false) && ($img_end !== false)) {
909 $img_st_close++; // make it point to AFTER the closing bracket
910 $img_end += $img_start;
912 if (!strcmp(substr($orig_body, $img_start + $img_st_close, 5), 'data:')) {
913 // This is an embedded image
914 $saved_image[$cnt] = substr($orig_body, $img_start + $img_st_close, $img_end - ($img_start + $img_st_close));
915 $new_body = $new_body . substr($orig_body, 0, $img_start) . '[$#saved_image' . $cnt . '#$]';
919 $new_body = $new_body . substr($orig_body, 0, $img_end + strlen('[/img]'));
922 $orig_body = substr($orig_body, $img_end + strlen('[/img]'));
924 if ($orig_body === false) {
925 // in case the body ends on a closing image tag
929 $img_start = strpos($orig_body, '[img');
930 $img_st_close = ($img_start !== false ? strpos(substr($orig_body, $img_start), ']') : false);
931 $img_end = ($img_start !== false ? strpos(substr($orig_body, $img_start), '[/img]') : false);
934 $new_body = $new_body . $orig_body;
936 return ['body' => $new_body, 'images' => $saved_image];
939 private static function interpolateSavedImagesIntoItemBody(int $uriid, string $body, array $images): string
944 foreach ($images as $image) {
945 // We're depending on the property of 'foreach' (specified on the PHP website) that
946 // it loops over the array starting from the first element and going sequentially
947 // to the last element
948 $newbody = str_replace('[$#saved_image' . $cnt . '#$]',
949 '<img src="' . self::proxyUrl($image, self::INTERNAL, $uriid) . '" alt="' . DI::l10n()->t('Image/photo') . '" />', $newbody);
957 * @param string $text A BBCode string
958 * @return array Empty array if no share tag is present or the following array, missing attributes end up empty strings:
959 * - comment : Text before the opening share tag
960 * - shared : Text inside the share tags
961 * - author : (Optional) Display name of the shared author
962 * - profile : (Optional) Profile page URL of the shared author
963 * - avatar : (Optional) Profile picture URL of the shared author
964 * - link : (Optional) Canonical URL of the shared post
965 * - posted : (Optional) Date the shared post was initially posted ("Y-m-d H:i:s" in GMT)
966 * - message_id: (Optional) Shared post URI if any
967 * - guid : (Optional) Shared post GUID if any
969 public static function fetchShareAttributes(string $text): array
971 DI::profiler()->startRecording('rendering');
972 if (preg_match('~(.*?)\[share](.*)\[/share]~ism', $text, $matches)) {
973 DI::profiler()->stopRecording();
981 'message_id' => trim($matches[2]),
982 'comment' => trim($matches[1]),
986 // See Issue https://github.com/friendica/friendica/issues/10454
987 // Hashtags in usernames are expanded to links. This here is a quick fix.
988 $text = preg_replace('~([@!#])\[url=.*?](.*?)\[/url]~ism', '$1$2', $text);
990 if (!preg_match('~(.*?)\[share(.*?)](.*)\[/share]~ism', $text, $matches)) {
991 DI::profiler()->stopRecording();
995 $attributes = self::extractShareAttributes($matches[2]);
997 $attributes['comment'] = trim($matches[1]);
998 $attributes['shared'] = trim($matches[3]);
1000 DI::profiler()->stopRecording();
1005 * @see BBCode::fetchShareAttributes()
1006 * @param string $shareString Internal opening share tag string matched by the regular expression
1007 * @return array A fixed attribute array where missing attribute are represented by empty strings
1009 private static function extractShareAttributes(string $shareString): array
1012 foreach (['author', 'profile', 'avatar', 'link', 'posted', 'guid', 'message_id'] as $field) {
1013 preg_match("/$field=(['\"])(.+?)\\1/ism", $shareString, $matches);
1014 $attributes[$field] = html_entity_decode($matches[2] ?? '', ENT_QUOTES, 'UTF-8');
1021 * Remove the share block
1023 * @param string $body
1026 public static function removeSharedData(string $body): string
1028 return trim(preg_replace("/\s*\[share.*?\].*?\[\/share\]\s*/ism", '', $body));
1032 * This function converts a [share] block to text according to a provided callback function whose signature is:
1034 * function(array $attributes, array $author_contact, string $content, boolean $is_quote_share): string
1037 * - $attributes is an array of attributes of the [share] block itself. Missing keys will be completed by the contact
1039 * - $author_contact is a contact record array
1040 * - $content is the inner content of the [share] block
1041 * - $is_quote_share indicates whether there's any content before the [share] block
1042 * - Return value is the string that should replace the [share] block in the provided text
1044 * This function is intended to be used by addon connector to format a share block like the target network is expecting it.
1046 * @param string $text A BBCode string
1047 * @param callable $callback
1048 * @return string The BBCode string with all [share] blocks replaced
1050 public static function convertShare(string $text, callable $callback, int $uriid = 0): string
1052 DI::profiler()->startRecording('rendering');
1053 $return = preg_replace_callback(
1054 '~(.*?)\[share(.*?)](.*)\[/share]~ism',
1055 function ($match) use ($callback, $uriid) {
1056 $attributes = self::extractShareAttributes($match[2]);
1058 $author_contact = Contact::getByURL($attributes['profile'], false, ['id', 'url', 'addr', 'name', 'micro']);
1059 $author_contact['url'] = ($author_contact['url'] ?? $attributes['profile']);
1060 $author_contact['addr'] = ($author_contact['addr'] ?? '');
1062 $attributes['author'] = ($author_contact['name'] ?? '') ?: $attributes['author'];
1063 $attributes['avatar'] = ($author_contact['micro'] ?? '') ?: $attributes['avatar'];
1064 $attributes['profile'] = ($author_contact['url'] ?? '') ?: $attributes['profile'];
1066 if (!empty($author_contact['id'])) {
1067 $attributes['avatar'] = Contact::getAvatarUrlForId($author_contact['id'], Proxy::SIZE_THUMB);
1068 } elseif ($attributes['avatar']) {
1069 $attributes['avatar'] = self::proxyUrl($attributes['avatar'], self::INTERNAL, $uriid, Proxy::SIZE_THUMB);
1072 $content = preg_replace(Strings::autoLinkRegEx(), '<a href="$1">$1</a>', $match[3]);
1074 return $match[1] . $callback($attributes, $author_contact, $content, trim($match[1]) != '');
1079 DI::profiler()->stopRecording();
1080 return trim($return);
1084 * Convert complex IMG and ZMG elements
1086 * @param [type] $text
1087 * @param integer $simplehtml
1088 * @param integer $uriid
1091 private static function convertImages(string $text, int $simplehtml, int $uriid = 0): string
1093 DI::profiler()->startRecording('rendering');
1094 $return = preg_replace_callback(
1095 "/\[[zi]mg(.*?)\]([^\[\]]*)\[\/[zi]mg\]/ism",
1096 function ($match) use ($simplehtml, $uriid) {
1097 $attribute_string = $match[1];
1099 foreach (['alt', 'width', 'height'] as $field) {
1100 preg_match("/$field=(['\"])(.+?)\\1/ism", $attribute_string, $matches);
1101 $attributes[$field] = html_entity_decode($matches[2] ?? '', ENT_QUOTES, 'UTF-8');
1104 $img_str = '<img src="' .
1105 self::proxyUrl($match[2], $simplehtml, $uriid) . '"';
1106 foreach ($attributes as $key => $value) {
1107 if (!empty($value)) {
1108 $img_str .= ' ' . $key . '="' . htmlspecialchars($value, ENT_COMPAT) . '"';
1111 return $img_str . '>';
1116 DI::profiler()->stopRecording();
1121 * Default [share] tag conversion callback
1123 * Note: Can produce a [bookmark] tag in the output
1125 * @see BBCode::convertShare()
1126 * @param array $attributes [share] block attribute values
1127 * @param array $author_contact Contact row of the shared author
1128 * @param string $content Inner content of the [share] block
1129 * @param boolean $is_quote_share Whether there is content before the [share] block
1130 * @param integer $simplehtml Mysterious integer value depending on the target network/formatting style
1132 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1134 private static function convertShareCallback(array $attributes, array $author_contact, string $content, bool $is_quote_share, int $simplehtml): string
1136 DI::profiler()->startRecording('rendering');
1137 $mention = $attributes['author'] . ' (' . ($author_contact['addr'] ?? '') . ')';
1139 switch ($simplehtml) {
1140 case self::MASTODON_API:
1141 case self::TWITTER_API:
1142 $text = ($is_quote_share? '<br>' : '') .
1143 '<b><a href="' . $attributes['link'] . '">' . html_entity_decode('♲', ENT_QUOTES, 'UTF-8') . ' ' . $author_contact['addr'] . "</a>:</b><br>\n" .
1144 '<blockquote class="shared_content" dir="auto">' . $content . '</blockquote>';
1146 case self::DIASPORA:
1147 if (stripos(Strings::normaliseLink($attributes['link']), 'http://twitter.com/') === 0) {
1148 $text = ($is_quote_share? '<hr />' : '') . '<p><a href="' . $attributes['link'] . '">' . $attributes['link'] . '</a></p>' . "\n";
1150 $headline = '<p><b>♲ <a href="' . $attributes['profile'] . '">' . $attributes['author'] . '</a>:</b></p>' . "\n";
1152 if (!empty($attributes['posted']) && !empty($attributes['link'])) {
1153 $headline = '<p><b>♲ <a href="' . $attributes['profile'] . '">' . $attributes['author'] . '</a></b> - <a href="' . $attributes['link'] . '">' . $attributes['posted'] . ' GMT</a></p>' . "\n";
1156 $text = ($is_quote_share? '<hr />' : '') . $headline . '<blockquote>' . trim($content) . '</blockquote>' . "\n";
1158 if (empty($attributes['posted']) && !empty($attributes['link'])) {
1159 $text .= '<p><a href="' . $attributes['link'] . '">[Source]</a></p>' . "\n";
1164 case self::CONNECTORS:
1165 $headline = '<p><b>' . html_entity_decode('♲ ', ENT_QUOTES, 'UTF-8');
1166 $headline .= DI::l10n()->t('<a href="%1$s" target="_blank" rel="noopener noreferrer">%2$s</a> %3$s', $attributes['link'], $mention, $attributes['posted']);
1167 $headline .= ':</b></p>' . "\n";
1169 $text = ($is_quote_share? '<hr />' : '') . $headline . '<blockquote class="shared_content" dir="auto">' . trim($content) . '</blockquote>' . "\n";
1173 $text = ($is_quote_share? '<br>' : '') . '<p>' . html_entity_decode('♲ ', ENT_QUOTES, 'UTF-8') . ' @' . $author_contact['addr'] . ': ' . $content . '</p>' . "\n";
1175 case self::ACTIVITYPUB:
1176 $author = '@<span class="vcard"><a href="' . $author_contact['url'] . '" class="url u-url mention" title="' . $author_contact['addr'] . '"><span class="fn nickname mention">' . $author_contact['addr'] . '</span></a>:</span>';
1177 $text = '<div><a href="' . $attributes['link'] . '">' . html_entity_decode('♲', ENT_QUOTES, 'UTF-8') . '</a> ' . $author . '<blockquote>' . $content . '</blockquote></div>' . "\n";
1180 $text = ($is_quote_share? "\n" : '');
1182 $contact = Contact::getByURL($attributes['profile'], false, ['network']);
1183 $network = $contact['network'] ?? Protocol::PHANTOM;
1185 $tpl = Renderer::getMarkupTemplate('shared_content.tpl');
1186 $text .= Renderer::replaceMacros($tpl, [
1187 '$profile' => $attributes['profile'],
1188 '$avatar' => $attributes['avatar'],
1189 '$author' => $attributes['author'],
1190 '$link' => $attributes['link'],
1191 '$link_title' => DI::l10n()->t('Link to source'),
1192 '$posted' => $attributes['posted'],
1193 '$guid' => $attributes['guid'],
1194 '$network_name' => ContactSelector::networkToName($network, $attributes['profile']),
1195 '$network_icon' => ContactSelector::networkToIcon($network, $attributes['profile']),
1196 '$content' => self::TOP_ANCHOR . self::setMentions(trim($content), 0, $network) . self::BOTTOM_ANCHOR,
1204 private static function removePictureLinksCallback(array $match): string
1206 $cache_key = 'remove:' . $match[1];
1207 $text = DI::cache()->get($cache_key);
1209 if (is_null($text)) {
1210 $curlResult = DI::httpClient()->head($match[1], [HttpClientOptions::TIMEOUT => DI::config()->get('system', 'xrd_timeout')]);
1211 if ($curlResult->isSuccess()) {
1212 $mimetype = $curlResult->getHeader('Content-Type')[0] ?? '';
1217 if (substr($mimetype, 0, 6) == 'image/') {
1218 $text = '[url=' . $match[1] . ']' . $match[1] . '[/url]';
1220 $text = '[url=' . $match[2] . ']' . $match[2] . '[/url]';
1222 // if its not a picture then look if its a page that contains a picture link
1223 $body = DI::httpClient()->fetch($match[1], HttpClientAccept::HTML, 0);
1225 DI::cache()->set($cache_key, $text);
1229 $doc = new DOMDocument();
1230 @$doc->loadHTML($body);
1231 $xpath = new DOMXPath($doc);
1232 $list = $xpath->query('//meta[@name]');
1233 foreach ($list as $node) {
1236 if ($node->attributes->length) {
1237 foreach ($node->attributes as $attribute) {
1238 $attr[$attribute->name] = $attribute->value;
1242 if (strtolower($attr['name']) == 'twitter:image') {
1243 $text = '[url=' . $attr['content'] . ']' . $attr['content'] . '[/url]';
1247 DI::cache()->set($cache_key, $text);
1254 * Callback: Expands links from given $match array
1256 * @param array $match Array with link match
1257 * @return string BBCode
1259 private static function expandLinksCallback(array $match): string
1261 if (($match[3] == '') || ($match[2] == $match[3]) || stristr($match[2], $match[3])) {
1262 return ($match[1] . '[url]' . $match[2] . '[/url]');
1264 return ($match[1] . $match[3] . ' [url]' . $match[2] . '[/url]');
1269 * Callback: Cleans picture links
1271 * @param array $match Array with link match
1272 * @return string BBCode
1274 private static function cleanPictureLinksCallback(array $match): string
1276 // When the picture link is the own photo path then we can avoid fetching the link
1277 $own_photo_url = preg_quote(Strings::normaliseLink(DI::baseUrl()->get()) . '/photos/');
1278 if (preg_match('|' . $own_photo_url . '.*?/image/|', Strings::normaliseLink($match[1]))) {
1279 if (!empty($match[3])) {
1280 $text = '[img=' . str_replace('-1.', '-0.', $match[2]) . ']' . $match[3] . '[/img]';
1282 $text = '[img]' . str_replace('-1.', '-0.', $match[2]) . '[/img]';
1287 $cache_key = 'clean:' . $match[1];
1288 $text = DI::cache()->get($cache_key);
1289 if (!is_null($text)) {
1293 $curlResult = DI::httpClient()->head($match[1], [HttpClientOptions::TIMEOUT => DI::config()->get('system', 'xrd_timeout')]);
1294 if ($curlResult->isSuccess()) {
1295 $mimetype = $curlResult->getHeader('Content-Type')[0] ?? '';
1300 // if its a link to a picture then embed this picture
1301 if (substr($mimetype, 0, 6) == 'image/') {
1302 $text = '[img]' . $match[1] . '[/img]';
1304 if (!empty($match[3])) {
1305 $text = '[img=' . $match[2] . ']' . $match[3] . '[/img]';
1307 $text = '[img]' . $match[2] . '[/img]';
1310 // if its not a picture then look if its a page that contains a picture link
1311 $body = DI::httpClient()->fetch($match[1], HttpClientAccept::HTML, 0);
1313 DI::cache()->set($cache_key, $text);
1317 $doc = new DOMDocument();
1318 @$doc->loadHTML($body);
1319 $xpath = new DOMXPath($doc);
1320 $list = $xpath->query('//meta[@name]');
1321 foreach ($list as $node) {
1323 if ($node->attributes->length) {
1324 foreach ($node->attributes as $attribute) {
1325 $attr[$attribute->name] = $attribute->value;
1329 if (strtolower($attr['name']) == "twitter:image") {
1330 if (!empty($match[3])) {
1331 $text = "[img=" . $attr['content'] . "]" . $match[3] . "[/img]";
1333 $text = "[img]" . $attr['content'] . "[/img]";
1338 DI::cache()->set($cache_key, $text);
1344 * Cleans picture links
1346 * @param string $text HTML/BBCode string
1347 * @return string Cleaned HTML/BBCode
1349 public static function cleanPictureLinks(string $text): string
1351 DI::profiler()->startRecording('rendering');
1352 $return = preg_replace_callback("&\[url=([^\[\]]*)\]\[img=(.*)\](.*)\[\/img\]\[\/url\]&Usi", [self::class, 'cleanPictureLinksCallback'], $text);
1353 $return = preg_replace_callback("&\[url=([^\[\]]*)\]\[img\](.*)\[\/img\]\[\/url\]&Usi", [self::class, 'cleanPictureLinksCallback'], $return);
1354 DI::profiler()->stopRecording();
1361 * @param string $text HTML/BBCode string
1362 * @return string Cleaned HTML/BBCode
1364 public static function removeLinks(string $bbcode): string
1366 DI::profiler()->startRecording('rendering');
1367 $bbcode = preg_replace("/\[img\=(.*?)\](.*?)\[\/img\]/ism", ' $1 ', $bbcode);
1368 $bbcode = preg_replace("/\[img.*?\[\/img\]/ism", ' ', $bbcode);
1370 $bbcode = preg_replace('/[@!#]\[url\=.*?\].*?\[\/url\]/ism', '', $bbcode);
1371 $bbcode = preg_replace("/\[url=[^\[\]]*\](.*)\[\/url\]/Usi", ' $1 ', $bbcode);
1372 $bbcode = preg_replace('/[@!#]?\[url.*?\[\/url\]/ism', '', $bbcode);
1373 DI::profiler()->stopRecording();
1378 * Replace names in mentions with nicknames
1380 * @param string $body HTML/BBCode
1381 * @return string Body with replaced mentions
1383 public static function setMentionsToNicknames(string $body): string
1385 DI::profiler()->startRecording('rendering');
1386 $regexp = "/([@!])\[url\=([^\[\]]*)\].*?\[\/url\]/ism";
1387 $body = preg_replace_callback($regexp, [self::class, 'mentionCallback'], $body);
1388 DI::profiler()->stopRecording();
1393 * Callback function to replace a Friendica style mention in a mention with the nickname
1395 * @param array $match Matching values for the callback
1396 * @return string Replaced mention or empty string
1397 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1399 private static function mentionCallback(array $match): string
1401 if (empty($match[2])) {
1405 $data = Contact::getByURL($match[2], false, ['url', 'nick']);
1406 if (empty($data['nick'])) {
1410 return $match[1] . '[url=' . $data['url'] . ']' . $data['nick'] . '[/url]';
1414 * Converts a BBCode message for a given URI-ID to a HTML message
1416 * BBcode 2 HTML was written by WAY2WEB.net
1417 * extended to work with Mistpark/Friendica - Mike Macgirvin
1419 * Simple HTML values meaning:
1420 * - 0: Friendica display
1422 * - 2: Used for Windows Phone push, Friendica API
1423 * - 3: Used before converting to Markdown in bb2diaspora.php
1424 * - 4: Used for WordPress, Libertree (before Markdown), pump.io and tumblr
1427 * - 7: Used for dfrn, OStatus
1428 * - 8: Used for Twitter, WP backlink text setting
1432 * @param string $text
1433 * @param int $simple_html
1435 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1437 public static function convertForUriId(int $uriid = null, string $text = null, int $simple_html = self::INTERNAL): string
1439 $try_oembed = ($simple_html == self::INTERNAL);
1441 return self::convert($text ?? '', $try_oembed, $simple_html, false, $uriid ?? 0);
1445 * Converts a BBCode message to HTML message
1447 * BBcode 2 HTML was written by WAY2WEB.net
1448 * extended to work with Mistpark/Friendica - Mike Macgirvin
1450 * Simple HTML values meaning:
1451 * - 0: Friendica display
1453 * - 2: Used for Windows Phone push, Friendica API
1454 * - 3: Used before converting to Markdown in bb2diaspora.php
1455 * - 4: Used for WordPress, Libertree (before Markdown), pump.io and tumblr
1458 * - 7: Used for dfrn, OStatus
1459 * - 8: Used for Twitter, WP backlink text setting
1462 * @param string $text
1463 * @param bool $try_oembed
1464 * @param int $simple_html
1465 * @param bool $for_plaintext
1467 * @return string Converted code or empty string
1468 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1470 public static function convert(string $text = null, bool $try_oembed = true, int $simple_html = self::INTERNAL, bool $for_plaintext = false, int $uriid = 0): string
1472 // Accounting for null default column values
1473 if (is_null($text) || $text === '') {
1477 DI::profiler()->startRecording('rendering');
1479 Hook::callAll('bbcode', $text);
1483 $text = self::performWithEscapedTags($text, ['code'], function ($text) use ($try_oembed, $simple_html, $for_plaintext, $a, $uriid) {
1484 $text = self::performWithEscapedTags($text, ['noparse', 'nobb', 'pre'], function ($text) use ($try_oembed, $simple_html, $for_plaintext, $a, $uriid) {
1486 * preg_match_callback function to replace potential Oembed tags with Oembed content
1488 * $match[0] = [tag]$url[/tag] or [tag=$url]$title[/tag]
1490 * $match[2] = $title or absent
1492 $try_oembed_callback = function (array $match)
1495 $title = $match[2] ?? '';
1498 $return = OEmbed::getHTML($url, $title);
1499 } catch (Exception $ex) {
1500 $return = $match[0];
1506 // Remove the abstract element. It is a non visible element.
1507 $text = self::stripAbstract($text);
1509 // Line ending normalisation
1510 $text = str_replace("\r\n", "\n", $text);
1512 // Move new lines outside of tags
1513 $text = preg_replace("#\[(\w*)](\n*)#ism", '$2[$1]', $text);
1514 $text = preg_replace("#(\n*)\[/(\w*)]#ism", '[/$2]$1', $text);
1516 // Extract the private images which use data urls since preg has issues with
1517 // large data sizes. Stash them away while we do bbcode conversion, and then put them back
1518 // in after we've done all the regex matching. We cannot use any preg functions to do this.
1520 $extracted = self::extractImagesFromItemBody($text);
1521 $text = $extracted['body'];
1522 $saved_image = $extracted['images'];
1524 // If we find any event code, turn it into an event.
1525 // After we're finished processing the bbcode we'll
1526 // replace all of the event code with a reformatted version.
1528 $ev = Event::fromBBCode($text);
1530 // Replace any html brackets with HTML Entities to prevent executing HTML or script
1531 // Don't use strip_tags here because it breaks [url] search by replacing & with amp
1533 $text = str_replace("<", "<", $text);
1534 $text = str_replace(">", ">", $text);
1536 // remove some newlines before the general conversion
1537 $text = preg_replace("/\s?\[share(.*?)\]\s?(.*?)\s?\[\/share\]\s?/ism", "\n[share$1]$2[/share]\n", $text);
1538 $text = preg_replace("/\s?\[quote(.*?)\]\s?(.*?)\s?\[\/quote\]\s?/ism", "\n[quote$1]$2[/quote]\n", $text);
1540 // when the content is meant exporting to other systems then remove the avatar picture since this doesn't really look good on these systems
1542 $text = preg_replace("/\[share(.*?)avatar\s?=\s?'.*?'\s?(.*?)\]\s?(.*?)\s?\[\/share\]\s?/ism", "\n[share$1$2]$3[/share]", $text);
1545 // Remove linefeeds inside of the table elements. See issue #6799
1546 $search = ["\n[th]", "[th]\n", " [th]", "\n[/th]", "[/th]\n", "[/th] ",
1547 "\n[td]", "[td]\n", " [td]", "\n[/td]", "[/td]\n", "[/td] ",
1548 "\n[tr]", "[tr]\n", " [tr]", "[tr] ", "\n[/tr]", "[/tr]\n", " [/tr]", "[/tr] ",
1549 "\n[hr]", "[hr]\n", " [hr]", "[hr] ",
1550 "\n[attachment ", " [attachment ", "\n[/attachment]", "[/attachment]\n", " [/attachment]", "[/attachment] ",
1551 "[table]\n", "[table] ", " [table]", "\n[/table]", " [/table]", "[/table] "];
1552 $replace = ["[th]", "[th]", "[th]", "[/th]", "[/th]", "[/th]",
1553 "[td]", "[td]", "[td]", "[/td]", "[/td]", "[/td]",
1554 "[tr]", "[tr]", "[tr]", "[tr]", "[/tr]", "[/tr]", "[/tr]", "[/tr]",
1555 "[hr]", "[hr]", "[hr]", "[hr]",
1556 "[attachment ", "[attachment ", "[/attachment]", "[/attachment]", "[/attachment]", "[/attachment]",
1557 "[table]", "[table]", "[table]", "[/table]", "[/table]", "[/table]"];
1560 $text = str_replace($search, $replace, $text);
1561 } while ($oldtext != $text);
1563 // Replace these here only once
1564 $search = ["\n[table]", "[/table]\n"];
1565 $replace = ["[table]", "[/table]"];
1566 $text = str_replace($search, $replace, $text);
1568 // Trim new lines regardless of the system.remove_multiplicated_lines config value
1569 $text = trim($text, "\n");
1571 // removing multiplicated newlines
1572 if (DI::config()->get('system', 'remove_multiplicated_lines')) {
1573 $search = ["\n\n\n", "\n ", " \n", "[/quote]\n\n", "\n[/quote]", "[/li]\n", "\n[li]", "\n[*]", "\n[ul]", "[/ul]\n", "\n\n[share ", "[/attachment]\n",
1574 "\n[h1]", "[/h1]\n", "\n[h2]", "[/h2]\n", "\n[h3]", "[/h3]\n", "\n[h4]", "[/h4]\n", "\n[h5]", "[/h5]\n", "\n[h6]", "[/h6]\n"];
1575 $replace = ["\n\n", "\n", "\n", "[/quote]\n", "[/quote]", "[/li]", "[li]", "[*]", "[ul]", "[/ul]", "\n[share ", "[/attachment]",
1576 "[h1]", "[/h1]", "[h2]", "[/h2]", "[h3]", "[/h3]", "[h4]", "[/h4]", "[h5]", "[/h5]", "[h6]", "[/h6]"];
1579 $text = str_replace($search, $replace, $text);
1580 } while ($oldtext != $text);
1583 /// @todo Have a closer look at the different html modes
1584 // Handle attached links or videos
1585 if (in_array($simple_html, [self::MASTODON_API, self::TWITTER_API, self::ACTIVITYPUB])) {
1586 $text = self::removeAttachment($text);
1587 } elseif (!in_array($simple_html, [self::INTERNAL, self::EXTERNAL, self::CONNECTORS])) {
1588 $text = self::removeAttachment($text, true);
1590 $text = self::convertAttachment($text, $simple_html, $try_oembed, [], $uriid);
1593 $nosmile = strpos($text, '[nosmile]') !== false;
1594 $text = str_replace('[nosmile]', '', $text);
1596 // Replace non graphical smilies for external posts
1598 $text = self::performWithEscapedTags($text, ['img'], function ($text) use ($simple_html, $for_plaintext) {
1599 return Smilies::replace($text, ($simple_html != self::INTERNAL) || $for_plaintext);
1603 // leave open the posibility of [map=something]
1604 // this is replaced in Item::prepareBody() which has knowledge of the item location
1605 if (strpos($text, '[/map]') !== false) {
1606 $text = preg_replace_callback(
1607 "/\[map\](.*?)\[\/map\]/ism",
1608 function ($match) use ($simple_html) {
1609 return str_replace($match[0], '<p class="map">' . Map::byLocation($match[1], $simple_html) . '</p>', $match[0]);
1615 if (strpos($text, '[map=') !== false) {
1616 $text = preg_replace_callback(
1617 "/\[map=(.*?)\]/ism",
1618 function ($match) use ($simple_html) {
1619 return str_replace($match[0], '<p class="map">' . Map::byCoordinates(str_replace('/', ' ', $match[1]), $simple_html) . '</p>', $match[0]);
1625 if (strpos($text, '[map]') !== false) {
1626 $text = preg_replace("/\[map\]/", '<p class="map"></p>', $text);
1629 // Check for headers
1630 $text = preg_replace("(\[h1\](.*?)\[\/h1\])ism", '<h1>$1</h1>', $text);
1631 $text = preg_replace("(\[h2\](.*?)\[\/h2\])ism", '<h2>$1</h2>', $text);
1632 $text = preg_replace("(\[h3\](.*?)\[\/h3\])ism", '<h3>$1</h3>', $text);
1633 $text = preg_replace("(\[h4\](.*?)\[\/h4\])ism", '<h4>$1</h4>', $text);
1634 $text = preg_replace("(\[h5\](.*?)\[\/h5\])ism", '<h5>$1</h5>', $text);
1635 $text = preg_replace("(\[h6\](.*?)\[\/h6\])ism", '<h6>$1</h6>', $text);
1637 // Check for paragraph
1638 $text = preg_replace("(\[p\](.*?)\[\/p\])ism", '<p>$1</p>', $text);
1640 // Check for bold text
1641 $text = preg_replace("(\[b\](.*?)\[\/b\])ism", '<strong>$1</strong>', $text);
1643 // Check for Italics text
1644 $text = preg_replace("(\[i\](.*?)\[\/i\])ism", '<em>$1</em>', $text);
1646 // Check for Underline text
1647 $text = preg_replace("(\[u\](.*?)\[\/u\])ism", '<u>$1</u>', $text);
1649 // Check for strike-through text
1650 $text = preg_replace("(\[s\](.*?)\[\/s\])ism", '<s>$1</s>', $text);
1652 // Check for over-line text
1653 $text = preg_replace("(\[o\](.*?)\[\/o\])ism", '<span class="overline">$1</span>', $text);
1655 // Check for colored text
1656 $text = preg_replace("(\[color=(.*?)\](.*?)\[\/color\])ism", "<span style=\"color: $1;\">$2</span>", $text);
1658 // Check for sized text
1659 // [size=50] --> font-size: 50px (with the unit).
1660 if ($simple_html != self::DIASPORA) {
1661 $text = preg_replace("(\[size=(\d*?)\](.*?)\[\/size\])ism", '<span style="font-size:$1px;line-height:normal;">$2</span>', $text);
1662 $text = preg_replace("(\[size=(.*?)\](.*?)\[\/size\])ism", '<span style="font-size:$1;line-height:normal;">$2</span>', $text);
1664 // Issue 2199: Diaspora doesn't interpret the construct above, nor the <small> or <big> element
1665 $text = preg_replace("(\[size=(.*?)\](.*?)\[\/size\])ism", "$2", $text);
1669 // Check for centered text
1670 $text = preg_replace("(\[center\](.*?)\[\/center\])ism", '<div style="text-align:center;">$1</div>', $text);
1672 // Check for list text
1673 $text = str_replace("[*]", "<li>", $text);
1675 // Check for block-level custom CSS
1676 $text = preg_replace('#(?<=^|\n)\[style=(.*?)](.*?)\[/style](?:\n|$)#ism', '<div style="$1">$2</div>', $text);
1678 // Check for inline custom CSS
1679 $text = preg_replace("(\[style=(.*?)\](.*?)\[\/style\])ism", '<span style="$1">$2</span>', $text);
1681 // Mastodon Emoji (internal tag, do not document for users)
1682 $text = preg_replace("(\[emoji=(.*?)](.*?)\[/emoji])ism", '<span class="mastodon emoji"><img src="$1" alt="$2" title="$2"/></span>', $text);
1684 // Check for CSS classes
1685 // @deprecated since 2021.12, left for backward-compatibility reasons
1686 $text = preg_replace("(\[class=(.*?)\](.*?)\[\/class\])ism", '<span class="$1">$2</span>', $text);
1687 // Add HTML new lines
1688 $text = str_replace("\n", '<br>', $text);
1690 // handle nested lists
1693 while ((((strpos($text, "[/list]") !== false) && (strpos($text, "[list") !== false)) ||
1694 ((strpos($text, "[/ol]") !== false) && (strpos($text, "[ol]") !== false)) ||
1695 ((strpos($text, "[/ul]") !== false) && (strpos($text, "[ul]") !== false)) ||
1696 ((strpos($text, "[/li]") !== false) && (strpos($text, "[li]") !== false))) && (++$endlessloop < 20)) {
1697 $text = preg_replace("/\[list\](.*?)\[\/list\]/ism", '<ul class="listbullet" style="list-style-type: circle;">$1</ul>', $text);
1698 $text = preg_replace("/\[list=\](.*?)\[\/list\]/ism", '<ul class="listnone" style="list-style-type: none;">$1</ul>', $text);
1699 $text = preg_replace("/\[list=1\](.*?)\[\/list\]/ism", '<ul class="listdecimal" style="list-style-type: decimal;">$1</ul>', $text);
1700 $text = preg_replace("/\[list=((?-i)i)\](.*?)\[\/list\]/ism", '<ul class="listlowerroman" style="list-style-type: lower-roman;">$2</ul>', $text);
1701 $text = preg_replace("/\[list=((?-i)I)\](.*?)\[\/list\]/ism", '<ul class="listupperroman" style="list-style-type: upper-roman;">$2</ul>', $text);
1702 $text = preg_replace("/\[list=((?-i)a)\](.*?)\[\/list\]/ism", '<ul class="listloweralpha" style="list-style-type: lower-alpha;">$2</ul>', $text);
1703 $text = preg_replace("/\[list=((?-i)A)\](.*?)\[\/list\]/ism", '<ul class="listupperalpha" style="list-style-type: upper-alpha;">$2</ul>', $text);
1704 $text = preg_replace("/\[ul\](.*?)\[\/ul\]/ism", '<ul class="listbullet" style="list-style-type: circle;">$1</ul>', $text);
1705 $text = preg_replace("/\[ol\](.*?)\[\/ol\]/ism", '<ul class="listdecimal" style="list-style-type: decimal;">$1</ul>', $text);
1706 $text = preg_replace("/\[li\](.*?)\[\/li\]/ism", '<li>$1</li>', $text);
1709 $text = preg_replace("/\[th\](.*?)\[\/th\]/sm", '<th>$1</th>', $text);
1710 $text = preg_replace("/\[td\](.*?)\[\/td\]/sm", '<td>$1</td>', $text);
1711 $text = preg_replace("/\[tr\](.*?)\[\/tr\]/sm", '<tr>$1</tr>', $text);
1712 $text = preg_replace("/\[table\](.*?)\[\/table\]/sm", '<table>$1</table>', $text);
1714 $text = preg_replace("/\[table border=1\](.*?)\[\/table\]/sm", '<table border="1" >$1</table>', $text);
1715 $text = preg_replace("/\[table border=0\](.*?)\[\/table\]/sm", '<table border="0" >$1</table>', $text);
1717 $text = str_replace('[hr]', '<hr />', $text);
1719 if (!$for_plaintext) {
1720 $text = self::performWithEscapedTags($text, ['url', 'img', 'audio', 'video', 'youtube', 'vimeo', 'share', 'attachment', 'iframe', 'bookmark'], function ($text) {
1721 return preg_replace(Strings::autoLinkRegEx(), '[url]$1[/url]', $text);
1725 // Check for font change text
1726 $text = preg_replace("/\[font=(.*?)\](.*?)\[\/font\]/sm", "<span style=\"font-family: $1;\">$2</span>", $text);
1728 // Declare the format for [spoiler] layout
1729 $SpoilerLayout = '<details class="spoiler"><summary>' . DI::l10n()->t('Click to open/close') . '</summary>$1</details>';
1731 // Check for [spoiler] text
1732 // handle nested quotes
1734 while ((strpos($text, "[/spoiler]") !== false) && (strpos($text, "[spoiler]") !== false) && (++$endlessloop < 20)) {
1735 $text = preg_replace("/\[spoiler\](.*?)\[\/spoiler\]/ism", $SpoilerLayout, $text);
1738 // Check for [spoiler=Title] text
1740 // handle nested quotes
1742 while ((strpos($text, "[/spoiler]")!== false) && (strpos($text, "[spoiler=") !== false) && (++$endlessloop < 20)) {
1743 $text = preg_replace("/\[spoiler=[\"\']*(.*?)[\"\']*\](.*?)\[\/spoiler\]/ism",
1744 '<details class="spoiler"><summary>$1</summary>$2</details>',
1748 // Declare the format for [quote] layout
1749 $QuoteLayout = '<blockquote>$1</blockquote>';
1751 // Check for [quote] text
1752 // handle nested quotes
1754 while ((strpos($text, "[/quote]") !== false) && (strpos($text, "[quote]") !== false) && (++$endlessloop < 20)) {
1755 $text = preg_replace("/\[quote\](.*?)\[\/quote\]/ism", "$QuoteLayout", $text);
1758 // Check for [quote=Author] text
1760 $t_wrote = DI::l10n()->t('$1 wrote:');
1762 // handle nested quotes
1764 while ((strpos($text, "[/quote]")!== false) && (strpos($text, "[quote=") !== false) && (++$endlessloop < 20)) {
1765 $text = preg_replace("/\[quote=[\"\']*(.*?)[\"\']*\](.*?)\[\/quote\]/ism",
1766 "<p><strong class=".'"author"'.">" . $t_wrote . "</strong></p><blockquote>$2</blockquote>",
1771 // [img=widthxheight]image source[/img]
1772 $text = preg_replace_callback(
1773 "/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism",
1774 function ($matches) use ($simple_html, $uriid) {
1775 if (strpos($matches[3], "data:image/") === 0) {
1779 $matches[3] = self::proxyUrl($matches[3], $simple_html, $uriid);
1780 return "[img=" . $matches[1] . "x" . $matches[2] . "]" . $matches[3] . "[/img]";
1785 $text = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '<img src="$3" style="width: $1px;" >', $text);
1786 $text = preg_replace("/\[zmg\=([0-9]*)x([0-9]*)\](.*?)\[\/zmg\]/ism", '<img class="zrl" src="$3" style="width: $1px;" >', $text);
1788 $text = preg_replace_callback("/\[img\=(.*?)\](.*?)\[\/img\]/ism",
1789 function ($matches) use ($simple_html, $uriid) {
1790 $matches[1] = self::proxyUrl($matches[1], $simple_html, $uriid);
1791 $matches[2] = htmlspecialchars($matches[2], ENT_COMPAT);
1792 return '<img src="' . $matches[1] . '" alt="' . $matches[2] . '" title="' . $matches[2] . '">';
1797 // [img]pathtoimage[/img]
1798 $text = preg_replace_callback(
1799 "/\[img\](.*?)\[\/img\]/ism",
1800 function ($matches) use ($simple_html, $uriid) {
1801 if (strpos($matches[1], "data:image/") === 0) {
1805 $matches[1] = self::proxyUrl($matches[1], $simple_html, $uriid);
1806 return "[img]" . $matches[1] . "[/img]";
1811 $text = preg_replace("/\[img\](.*?)\[\/img\]/ism", '<img src="$1" alt="' . DI::l10n()->t('Image/photo') . '" />', $text);
1812 $text = preg_replace("/\[zmg\](.*?)\[\/zmg\]/ism", '<img src="$1" alt="' . DI::l10n()->t('Image/photo') . '" />', $text);
1814 $text = self::convertImages($text, $simple_html, $uriid);
1816 $text = preg_replace("/\[crypt\](.*?)\[\/crypt\]/ism", '<br><img src="' .DI::baseUrl() . '/images/lock_icon.gif" alt="' . DI::l10n()->t('Encrypted content') . '" title="' . DI::l10n()->t('Encrypted content') . '" /><br>', $text);
1817 $text = preg_replace("/\[crypt(.*?)\](.*?)\[\/crypt\]/ism", '<br><img src="' .DI::baseUrl() . '/images/lock_icon.gif" alt="' . DI::l10n()->t('Encrypted content') . '" title="' . '$1' . ' ' . DI::l10n()->t('Encrypted content') . '" /><br>', $text);
1818 //$text = preg_replace("/\[crypt=(.*?)\](.*?)\[\/crypt\]/ism", '<br><img src="' .DI::baseUrl() . '/images/lock_icon.gif" alt="' . DI::l10n()->t('Encrypted content') . '" title="' . '$1' . ' ' . DI::l10n()->t('Encrypted content') . '" /><br>', $text);
1820 // Simplify "video" element
1821 $text = preg_replace('(\[video[^\]]*?\ssrc\s?=\s?([^\s\]]+)[^\]]*?\].*?\[/video\])ism', '[video]$1[/video]', $text);
1824 // html5 video and audio
1825 $text = preg_replace("/\[video\](.*?\.(ogg|ogv|oga|ogm|webm|mp4).*?)\[\/video\]/ism",
1826 '<video src="$1" controls width="100%" height="auto"><a href="$1">$1</a></video>', $text);
1828 $text = preg_replace_callback("/\[video\](.*?)\[\/video\]/ism", $try_oembed_callback, $text);
1829 $text = preg_replace_callback("/\[audio\](.*?)\[\/audio\]/ism", $try_oembed_callback, $text);
1831 $text = preg_replace("/\[video\](.*?)\[\/video\]/ism",
1832 '<a href="$1" target="_blank" rel="noopener noreferrer">$1</a>', $text);
1833 $text = preg_replace("/\[audio\](.*?)\[\/audio\]/ism", '<audio src="$1" controls><a href="$1">$1</a></audio>', $text);
1835 $text = preg_replace("/\[video\](.*?)\[\/video\]/ism",
1836 '<a href="$1" target="_blank" rel="noopener noreferrer">$1</a>', $text);
1837 $text = preg_replace("/\[audio\](.*?)\[\/audio\]/ism",
1838 '<a href="$1" target="_blank" rel="noopener noreferrer">$1</a>', $text);
1841 // Backward compatibility, [iframe] support has been removed in version 2020.12
1842 $text = preg_replace("/\[iframe\](.*?)\[\/iframe\]/ism", '<a href="$1">$1</a>', $text);
1844 // Youtube extensions
1846 $text = preg_replace_callback("/\[youtube\](https?:\/\/www.youtube.com\/watch\?v\=.*?)\[\/youtube\]/ism", $try_oembed_callback, $text);
1847 $text = preg_replace_callback("/\[youtube\](www.youtube.com\/watch\?v\=.*?)\[\/youtube\]/ism", $try_oembed_callback, $text);
1848 $text = preg_replace_callback("/\[youtube\](https?:\/\/www.youtube.com\/shorts\/.*?)\[\/youtube\]/ism", $try_oembed_callback, $text);
1849 $text = preg_replace_callback("/\[youtube\](https?:\/\/youtu.be\/.*?)\[\/youtube\]/ism", $try_oembed_callback, $text);
1852 $text = preg_replace("/\[youtube\]https?:\/\/www.youtube.com\/watch\?v\=(.*?)\[\/youtube\]/ism", '[youtube]$1[/youtube]', $text);
1853 $text = preg_replace("/\[youtube\]https?:\/\/www.youtube.com\/embed\/(.*?)\[\/youtube\]/ism", '[youtube]$1[/youtube]', $text);
1854 $text = preg_replace("/\[youtube\]https?:\/\/www.youtube.com\/shorts\/(.*?)\[\/youtube\]/ism", '[youtube]$1[/youtube]', $text);
1855 $text = preg_replace("/\[youtube\]https?:\/\/youtu.be\/(.*?)\[\/youtube\]/ism", '[youtube]$1[/youtube]', $text);
1858 $text = preg_replace("/\[youtube\]([A-Za-z0-9\-_=]+)(.*?)\[\/youtube\]/ism", '<iframe width="' . $a->getThemeInfoValue('videowidth') . '" height="' . $a->getThemeInfoValue('videoheight') . '" src="https://www.youtube.com/embed/$1" frameborder="0" ></iframe>', $text);
1860 $text = preg_replace("/\[youtube\]([A-Za-z0-9\-_=]+)(.*?)\[\/youtube\]/ism",
1861 '<a href="https://www.youtube.com/watch?v=$1" target="_blank" rel="noopener noreferrer">https://www.youtube.com/watch?v=$1</a>', $text);
1865 $text = preg_replace_callback("/\[vimeo\](https?:\/\/player.vimeo.com\/video\/[0-9]+).*?\[\/vimeo\]/ism", $try_oembed_callback, $text);
1866 $text = preg_replace_callback("/\[vimeo\](https?:\/\/vimeo.com\/[0-9]+).*?\[\/vimeo\]/ism", $try_oembed_callback, $text);
1869 $text = preg_replace("/\[vimeo\]https?:\/\/player.vimeo.com\/video\/([0-9]+)(.*?)\[\/vimeo\]/ism", '[vimeo]$1[/vimeo]', $text);
1870 $text = preg_replace("/\[vimeo\]https?:\/\/vimeo.com\/([0-9]+)(.*?)\[\/vimeo\]/ism", '[vimeo]$1[/vimeo]', $text);
1873 $text = preg_replace("/\[vimeo\]([0-9]+)(.*?)\[\/vimeo\]/ism", '<iframe width="' . $a->getThemeInfoValue('videowidth') . '" height="' . $a->getThemeInfoValue('videoheight') . '" src="https://player.vimeo.com/video/$1" frameborder="0" ></iframe>', $text);
1875 $text = preg_replace("/\[vimeo\]([0-9]+)(.*?)\[\/vimeo\]/ism",
1876 '<a href="https://vimeo.com/$1" target="_blank" rel="noopener noreferrer">https://vimeo.com/$1</a>', $text);
1880 $text = OEmbed::BBCode2HTML($text);
1882 // Avoid triple linefeeds through oembed
1883 $text = str_replace("<br style='clear:left'></span><br><br>", "<br style='clear:left'></span><br>", $text);
1885 // If we found an event earlier, strip out all the event code and replace with a reformatted version.
1886 // Replace the event-start section with the entire formatted event. The other bbcode is stripped.
1887 // Summary (e.g. title) is required, earlier revisions only required description (in addition to
1888 // start which is always required). Allow desc with a missing summary for compatibility.
1890 if ((!empty($ev['desc']) || !empty($ev['summary'])) && !empty($ev['start'])) {
1891 $sub = Event::getHTML($ev, $simple_html, $uriid);
1893 $text = preg_replace("/\[event\-summary\](.*?)\[\/event\-summary\]/ism", '', $text);
1894 $text = preg_replace("/\[event\-description\](.*?)\[\/event\-description\]/ism", '', $text);
1895 $text = preg_replace("/\[event\-start\](.*?)\[\/event\-start\]/ism", $sub, $text);
1896 $text = preg_replace("/\[event\-finish\](.*?)\[\/event\-finish\]/ism", '', $text);
1897 $text = preg_replace("/\[event\-location\](.*?)\[\/event\-location\]/ism", '', $text);
1898 $text = preg_replace("/\[event\-id\](.*?)\[\/event\-id\]/ism", '', $text);
1901 if (!$for_plaintext && DI::config()->get('system', 'big_emojis') && ($simple_html != self::DIASPORA)) {
1902 $conv = html_entity_decode(str_replace([' ', "\n", "\r"], '', $text));
1903 // Emojis are always 4 byte Unicode characters
1904 if (!empty($conv) && (strlen($conv) / mb_strlen($conv) == 4)) {
1905 $text = '<span style="font-size: xx-large; line-height: normal;">' . $text . '</span>';
1909 // Handle mentions and hashtag links
1910 if ($simple_html == self::DIASPORA) {
1911 // The ! is converted to @ since Diaspora only understands the @
1912 $text = preg_replace("/([@!])\[url\=(.*?)\](.*?)\[\/url\]/ism",
1913 '@<a href="$2">$3</a>',
1915 } elseif (in_array($simple_html, [self::OSTATUS, self::ACTIVITYPUB])) {
1916 $text = preg_replace("/([@!])\[url\=(.*?)\](.*?)\[\/url\]/ism",
1917 '<span class="h-card"><a href="$2" class="u-url mention">$1<span>$3</span></a></span>',
1919 $text = preg_replace("/([#])\[url\=(.*?)\](.*?)\[\/url\]/ism",
1920 '<a href="$2" class="mention hashtag" rel="tag">$1<span>$3</span></a>',
1922 } elseif (in_array($simple_html, [self::INTERNAL, self::EXTERNAL, self::TWITTER_API])) {
1923 $text = preg_replace("/([@!])\[url\=(.*?)\](.*?)\[\/url\]/ism",
1924 '<bdi>$1<a href="$2" class="userinfo mention" title="$3">$3</a></bdi>',
1926 } elseif ($simple_html == self::MASTODON_API) {
1927 $text = preg_replace("/([@!])\[url\=(.*?)\](.*?)\[\/url\]/ism",
1928 '<a class="u-url mention status-link" href="$2" rel="nofollow noopener noreferrer" target="_blank" title="$3">$1<span>$3</span></a>',
1930 $text = preg_replace("/([#])\[url\=(.*?)\](.*?)\[\/url\]/ism",
1931 '<a class="mention hashtag status-link" href="$2" rel="tag">$1<span>$3</span></a>',
1934 $text = preg_replace("/([#@!])\[url\=(.*?)\](.*?)\[\/url\]/ism", '$1$3', $text);
1937 if (!$for_plaintext) {
1938 if (in_array($simple_html, [self::OSTATUS, self::MASTODON_API, self::TWITTER_API, self::ACTIVITYPUB])) {
1939 $text = preg_replace_callback("/\[url\](.*?)\[\/url\]/ism", [self::class, 'convertUrlForActivityPubCallback'], $text);
1940 $text = preg_replace_callback("/\[url\=(.*?)\](.*?)\[\/url\]/ism", [self::class, 'convertUrlForActivityPubCallback'], $text);
1943 $text = preg_replace("(\[url\](.*?)\[\/url\])ism", " $1 ", $text);
1944 $text = preg_replace_callback("&\[url=([^\[\]]*)\]\[img\](.*)\[\/img\]\[\/url\]&Usi", [self::class, 'removePictureLinksCallback'], $text);
1947 // Bookmarks in red - will be converted to bookmarks in friendica
1948 $text = preg_replace("/#\^\[url\](.*?)\[\/url\]/ism", '[bookmark=$1]$1[/bookmark]', $text);
1949 $text = preg_replace("/#\^\[url\=(.*?)\](.*?)\[\/url\]/ism", '[bookmark=$1]$2[/bookmark]', $text);
1950 $text = preg_replace("/#\[url\=.*?\]\^\[\/url\]\[url\=(.*?)\](.*?)\[\/url\]/i",
1951 "[bookmark=$1]$2[/bookmark]", $text);
1953 if (in_array($simple_html, [self::OSTATUS, self::TWITTER])) {
1954 $text = preg_replace_callback("/([^#@!])\[url\=([^\]]*)\](.*?)\[\/url\]/ism", [self::class, 'expandLinksCallback'], $text);
1955 //$text = preg_replace("/[^#@!]\[url\=([^\]]*)\](.*?)\[\/url\]/ism", ' $2 [url]$1[/url]', $text);
1956 $text = preg_replace("/\[bookmark\=([^\]]*)\](.*?)\[\/bookmark\]/ism", ' $2 [url]$1[/url]', $text);
1959 // Perform URL Search
1961 $text = preg_replace_callback("/\[bookmark\=([^\]]*)\](.*?)\[\/bookmark\]/ism", $try_oembed_callback, $text);
1964 $text = preg_replace("/\[bookmark\=([^\]]*)\](.*?)\[\/bookmark\]/ism", '[url=$1]$2[/url]', $text);
1966 // Handle Diaspora posts
1967 $text = preg_replace_callback(
1968 "&\[url=/?posts/([^\[\]]*)\](.*)\[\/url\]&Usi",
1970 return "[url=" . DI::baseUrl() . "/display/" . $match[1] . "]" . $match[2] . "[/url]";
1974 $text = preg_replace_callback(
1975 "&\[url=/people\?q\=(.*)\](.*)\[\/url\]&Usi",
1977 return "[url=" . DI::baseUrl() . "/search?search=%40" . $match[1] . "]" . $match[2] . "[/url]";
1981 // Server independent link to posts and comments
1982 // See issue: https://github.com/diaspora/diaspora_federation/issues/75
1983 $expression = "=diaspora://.*?/post/([0-9A-Za-z\-_@.:]{15,254}[0-9A-Za-z])=ism";
1984 $text = preg_replace($expression, DI::baseUrl()."/display/$1", $text);
1988 * - #[url=<anything>]<term>[/url]
1989 * - [url=<anything>]#<term>[/url]
1991 self::performWithEscapedTags($text, ['url', 'share'], function ($text) use ($simple_html) {
1992 $text = preg_replace_callback("/(?:#\[url\=[^\[\]]*\]|\[url\=[^\[\]]*\]#)(.*?)\[\/url\]/ism", function($matches) use ($simple_html) {
1993 if ($simple_html == self::ACTIVITYPUB) {
1994 return '<a href="' . DI::baseUrl() . '/search?tag=' . rawurlencode($matches[1])
1995 . '" data-tag="' . XML::escape($matches[1]) . '" rel="tag ugc">#'
1996 . XML::escape($matches[1]) . '</a>';
1998 return '#<a href="' . DI::baseUrl() . '/search?tag=' . rawurlencode($matches[1])
1999 . '" class="tag" rel="tag" title="' . XML::escape($matches[1]) . '">'
2000 . XML::escape($matches[1]) . '</a>';
2006 // We need no target="_blank" rel="noopener noreferrer" for local links
2007 // convert links start with DI::baseUrl() as local link without the target="_blank" rel="noopener noreferrer" attribute
2008 $escapedBaseUrl = preg_quote(DI::baseUrl(), '/');
2009 $text = preg_replace("/\[url\](".$escapedBaseUrl.".*?)\[\/url\]/ism", '<a href="$1">$1</a>', $text);
2010 $text = preg_replace("/\[url\=(".$escapedBaseUrl.".*?)\](.*?)\[\/url\]/ism", '<a href="$1">$2</a>', $text);
2012 $text = preg_replace("/\[url\](.*?)\[\/url\]/ism", '<a href="$1" target="_blank" rel="noopener noreferrer">$1</a>', $text);
2013 $text = preg_replace("/\[url\=(.*?)\](.*?)\[\/url\]/ism", '<a href="$1" target="_blank" rel="noopener noreferrer">$2</a>', $text);
2015 // Red compatibility, though the link can't be authenticated on Friendica
2016 $text = preg_replace("/\[zrl\=(.*?)\](.*?)\[\/zrl\]/ism", '<a href="$1" target="_blank" rel="noopener noreferrer">$2</a>', $text);
2019 // we may need to restrict this further if it picks up too many strays
2020 // link acct:user@host to a webfinger profile redirector
2022 $text = preg_replace('/acct:([^@]+)@((?!\-)(?:[a-zA-Z\d\-]{0,62}[a-zA-Z\d]\.){1,126}(?!\d+)[a-zA-Z\d]{1,63})/', '<a href="' . DI::baseUrl() . '/acctlink?addr=$1@$2" target="extlink">acct:$1@$2</a>', $text);
2024 // Perform MAIL Search
2025 $text = preg_replace("/\[mail\](.*?)\[\/mail\]/", '<a href="mailto:$1">$1</a>', $text);
2026 $text = preg_replace("/\[mail\=(.*?)\](.*?)\[\/mail\]/", '<a href="mailto:$1">$2</a>', $text);
2028 /// @todo What is the meaning of these lines?
2029 $text = preg_replace('/\[\&\;([#a-z0-9]+)\;\]/', '&$1;', $text);
2030 $text = preg_replace('/\&\#039\;/', '\'', $text);
2032 // Currently deactivated, it made problems with " inside of alt texts.
2033 //$text = preg_replace('/\"\;/', '"', $text);
2035 // fix any escaped ampersands that may have been converted into links
2036 $text = preg_replace('/\<([^>]*?)(src|href)=(.*?)\&\;(.*?)\>/ism', '<$1$2=$3&$4>', $text);
2038 // sanitizes src attributes (http and redir URLs for displaying in a web page, cid used for inline images in emails)
2039 $allowed_src_protocols = ['//', 'http://', 'https://', 'contact/redir/', 'cid:'];
2041 array_walk($allowed_src_protocols, function(&$value) { $value = preg_quote($value, '#');});
2043 $text = preg_replace('#<([^>]*?)(src)="(?!' . implode('|', $allowed_src_protocols) . ')(.*?)"(.*?)>#ism',
2044 '<$1$2=""$4 data-original-src="$3" class="invalid-src" title="' . DI::l10n()->t('Invalid source protocol') . '">', $text);
2046 // sanitize href attributes (only allowlisted protocols URLs)
2047 // default value for backward compatibility
2048 $allowed_link_protocols = DI::config()->get('system', 'allowed_link_protocols', []);
2050 // Always allowed protocol even if config isn't set or not including it
2051 $allowed_link_protocols[] = '//';
2052 $allowed_link_protocols[] = 'http://';
2053 $allowed_link_protocols[] = 'https://';
2054 $allowed_link_protocols[] = 'contact/redir/';
2056 array_walk($allowed_link_protocols, function(&$value) { $value = preg_quote($value, '#');});
2058 $regex = '#<([^>]*?)(href)="(?!' . implode('|', $allowed_link_protocols) . ')(.*?)"(.*?)>#ism';
2059 $text = preg_replace($regex, '<$1$2="javascript:void(0)"$4 data-original-href="$3" class="invalid-href" title="' . DI::l10n()->t('Invalid link protocol') . '">', $text);
2062 $text = self::convertShare(
2064 function (array $attributes, array $author_contact, $content, $is_quote_share) use ($simple_html) {
2065 return self::convertShareCallback($attributes, $author_contact, $content, $is_quote_share, $simple_html);
2069 $text = self::interpolateSavedImagesIntoItemBody($uriid, $text, $saved_image);
2072 }); // Escaped noparse, nobb, pre
2074 // Remove escaping tags and replace new lines that remain
2075 $text = preg_replace_callback('/\[(noparse|nobb)](.*?)\[\/\1]/ism', function ($match) {
2076 return str_replace("\n", "<br>", $match[2]);
2079 // Additionally, [pre] tags preserve spaces
2080 $text = preg_replace_callback("/\[pre\](.*?)\[\/pre\]/ism", function ($match) {
2081 return str_replace([' ', "\n"], [' ', "<br>"], htmlentities($match[1], ENT_NOQUOTES,'UTF-8'));
2087 $text = preg_replace_callback("#\[code(?:=([^\]]*))?\](.*?)\[\/code\]#ism",
2088 function ($matches) {
2089 if (strpos($matches[2], "\n") !== false) {
2090 $return = '<pre><code class="language-' . trim($matches[1]) . '">' . htmlentities(trim($matches[2], "\n\r"), ENT_NOQUOTES, 'UTF-8') . '</code></pre>';
2092 $return = '<code>' . htmlentities($matches[2], ENT_NOQUOTES, 'UTF-8') . '</code>';
2100 // Default iframe allowed domains/path
2101 $allowedIframeDomains = [
2102 DI::baseUrl()->getHostname()
2103 . (DI::baseUrl()->getUrlPath() ? '/' . DI::baseUrl()->getUrlPath() : '')
2104 . '/oembed/', # The path part has to change with the source in Content\Oembed::iframe
2105 'www.youtube.com/embed/',
2106 'player.vimeo.com/video/',
2109 $allowedIframeDomains = array_merge(
2110 $allowedIframeDomains,
2111 DI::config()->get('system', 'allowed_oembed') ?
2112 explode(',', DI::config()->get('system', 'allowed_oembed'))
2116 $text = HTML::purify($text, $allowedIframeDomains);
2117 DI::profiler()->stopRecording();
2123 * Strips the "abstract" tag from the provided text
2125 * @param string $text The text with BBCode
2126 * @return string The same text - but without "abstract" element
2128 public static function stripAbstract(string $text): string
2130 DI::profiler()->startRecording('rendering');
2132 $text = BBCode::performWithEscapedTags($text, ['code', 'noparse', 'nobb', 'pre'], function ($text) {
2133 $text = preg_replace("/[\s|\n]*\[abstract\].*?\[\/abstract\][\s|\n]*/ism", ' ', $text);
2134 $text = preg_replace("/[\s|\n]*\[abstract=.*?\].*?\[\/abstract][\s|\n]*/ism", ' ', $text);
2138 DI::profiler()->stopRecording();
2143 * Returns the value of the "abstract" element
2145 * @param string $text The text that maybe contains the element
2146 * @param string $addon The addon for which the abstract is meant for
2147 * @return string The abstract
2149 public static function getAbstract(string $text, string $addon = ''): string
2151 DI::profiler()->startRecording('rendering');
2152 $addon = strtolower($addon);
2154 $abstract = BBCode::performWithEscapedTags($text, ['code', 'noparse', 'nobb', 'pre'], function ($text) use ($addon) {
2155 if ($addon && preg_match('#\[abstract=' . preg_quote($addon, '#') . '](.*?)\[/abstract]#ism', $text, $matches)) {
2159 if (preg_match("#\[abstract](.*?)\[/abstract]#ism", $text, $matches)) {
2166 DI::profiler()->stopRecording();
2171 * Callback function to replace a Friendica style mention in a mention for Diaspora
2173 * @param array $match Matching values for the callback
2174 * [1] = Mention type (! or @)
2177 * @return string Replaced mention
2178 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
2179 * @throws \ImagickException
2181 private static function bbCodeMention2DiasporaCallback(array $match): string
2183 $contact = Contact::getByURL($match[3], false, ['addr']);
2184 if (empty($contact['addr'])) {
2188 $mention = $match[1] . '{' . $match[2] . '; ' . $contact['addr'] . '}';
2193 * Converts a BBCode text into Markdown
2195 * This function converts a BBCode item body to be sent to Markdown-enabled
2196 * systems like Diaspora and Libertree
2198 * @param string $text
2199 * @param bool $for_diaspora Diaspora requires more changes than Libertree
2201 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
2203 public static function toMarkdown(string $text, bool $for_diaspora = true): string
2205 DI::profiler()->startRecording('rendering');
2206 $original_text = $text;
2208 // Since Diaspora is creating a summary for links, this function removes them before posting
2209 if ($for_diaspora) {
2210 $text = self::removeShareInformation($text);
2214 * Transform #tags, strip off the [url] and replace spaces with underscore
2216 $url_search_string = "^\[\]";
2217 $text = preg_replace_callback("/#\[url\=([$url_search_string]*)\](.*?)\[\/url\]/i",
2218 function ($matches) {
2219 return '#' . str_replace(' ', '_', $matches[2]);
2224 // Converting images with size parameters to simple images. Markdown doesn't know it.
2225 $text = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $text);
2227 // Convert it to HTML - don't try oembed
2228 if ($for_diaspora) {
2229 $text = self::convert($text, false, self::DIASPORA);
2231 // Add all tags that maybe were removed
2232 if (preg_match_all("/#\[url\=([$url_search_string]*)\](.*?)\[\/url\]/ism", $original_text, $tags)) {
2234 foreach ($tags[2] as $tag) {
2235 $tag = html_entity_decode($tag, ENT_QUOTES, 'UTF-8');
2236 if (!strpos(html_entity_decode($text, ENT_QUOTES, 'UTF-8'), '#' . $tag)) {
2237 $tagline .= '#' . $tag . ' ';
2240 $text = $text . ' ' . $tagline;
2243 $text = self::convert($text, false, self::CONNECTORS);
2246 // If a link is followed by a quote then there should be a newline before it
2247 // Maybe we should make this newline at every time before a quote.
2248 $text = str_replace(['</a><blockquote>'], ['</a><br><blockquote>'], $text);
2250 // Now convert HTML to Markdown
2251 $text = HTML::toMarkdown($text);
2253 // Libertree has a problem with escaped hashtags.
2254 $text = str_replace(['\#'], ['#'], $text);
2256 // Remove any leading or trailing whitespace, as this will mess up
2257 // the Diaspora signature verification and cause the item to disappear
2258 $text = trim($text);
2260 if ($for_diaspora) {
2261 $url_search_string = "^\[\]";
2262 $text = preg_replace_callback(
2263 "/([@!])\[(.*?)\]\(([$url_search_string]*?)\)/ism",
2264 [self::class, 'bbCodeMention2DiasporaCallback'],
2269 Hook::callAll('bb2diaspora', $text);
2271 DI::profiler()->stopRecording();
2276 * Pull out all #hashtags and @person tags from $string.
2278 * We also get @person@domain.com - which would make
2279 * the regex quite complicated as tags can also
2280 * end a sentence. So we'll run through our results
2281 * and strip the period from any tags which end with one.
2282 * Returns array of tags found, or empty array.
2284 * @param string $string Post content
2285 * @return array List of tag and person names
2287 public static function getTags(string $string): array
2289 DI::profiler()->startRecording('rendering');
2292 self::performWithEscapedTags($string, ['noparse', 'pre', 'code', 'img', 'attachment'], function ($string) use (&$ret) {
2293 // Convert hashtag links to hashtags
2294 $string = preg_replace('/#\[url\=([^\[\]]*)\](.*?)\[\/url\]/ism', '#$2 ', $string);
2296 // Force line feeds at bbtags
2297 $string = str_replace(['[', ']'], ["\n[", "]\n"], $string);
2299 // ignore anything in a bbtag
2300 $string = preg_replace('/\[(.*?)\]/sm', '', $string);
2302 // Match full names against @tags including the space between first and last
2303 // We will look these up afterward to see if they are full names or not recognisable.
2305 if (preg_match_all('/(@[^ \x0D\x0A,:?]+ [^ \x0D\x0A@,:?]+)([ \x0D\x0A@,:?]|$)/', $string, $matches)) {
2306 foreach ($matches[1] as $match) {
2307 if (strstr($match, ']')) {
2308 // we might be inside a bbcode color tag - leave it alone
2312 if (substr($match, -1, 1) === '.') {
2313 $ret[] = substr($match, 0, -1);
2320 // Otherwise pull out single word tags. These can be @nickname, @first_last
2323 if (preg_match_all('/([!#@][^\^ \x0D\x0A,;:?\']*[^\^ \x0D\x0A,;:?!\'.])/', $string, $matches)) {
2324 foreach ($matches[1] as $match) {
2325 if (strstr($match, ']')) {
2326 // we might be inside a bbcode color tag - leave it alone
2330 // try not to catch url fragments
2331 if (strpos($string, $match) && preg_match('/[a-zA-z0-9\/]/', substr($string, strpos($string, $match) - 1, 1))) {
2340 DI::profiler()->stopRecording();
2341 return array_unique($ret);
2345 * Expand tags to URLs, checks the tag is at the start of a line or preceded by a non-word character
2347 * @param string $body HTML/BBCode
2348 * @return string body with expanded tags
2350 public static function expandTags(string $body): string
2352 return preg_replace_callback("/(?<=\W|^)([!#@])([^\^ \x0D\x0A,;:?'\"]*[^\^ \x0D\x0A,;:?!'\".])/",
2353 function (array $match) {
2354 switch ($match[1]) {
2357 $contact = Contact::getByURL($match[2]);
2358 if (!empty($contact)) {
2359 return $match[1] . '[url=' . $contact['url'] . ']' . $contact['name'] . '[/url]';
2361 return $match[1] . $match[2];
2367 return $match[1] . '[url=' . DI::baseUrl() . '/search?tag=' . $match[2] . ']' . $match[2] . '[/url]';
2373 * Perform a custom function on a text after having escaped blocks enclosed in the provided tag list.
2375 * @param string $text HTML/BBCode
2376 * @param array $tagList A list of tag names, e.g ['noparse', 'nobb', 'pre']
2377 * @param callable $callback
2379 * @see Strings::performWithEscapedBlocks
2381 public static function performWithEscapedTags(string $text, array $tagList, callable $callback): string
2383 $tagList = array_map('preg_quote', $tagList);
2385 return Strings::performWithEscapedBlocks($text, '#\[(?:' . implode('|', $tagList) . ').*?\[/(?:' . implode('|', $tagList) . ')]#ism', $callback);
2389 * Replaces mentions in the provided message body in BBCode links for the provided user and network if any
2391 * @param string $body HTML/BBCode
2392 * @param int $profile_uid Profile user id
2393 * @param string $network Network name
2394 * @return string HTML/BBCode with inserted images
2395 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
2396 * @throws \ImagickException
2398 public static function setMentions(string $body, $profile_uid = 0, $network = '')
2400 DI::profiler()->startRecording('rendering');
2401 $body = self::performWithEscapedTags($body, ['noparse', 'pre', 'code', 'img'], function ($body) use ($profile_uid, $network) {
2402 $tags = self::getTags($body);
2406 foreach ($tags as $tag) {
2407 $tag_type = substr($tag, 0, 1);
2409 if ($tag_type == Tag::TAG_CHARACTER[Tag::HASHTAG]) {
2414 * If we already tagged 'Robert Johnson', don't try and tag 'Robert'.
2415 * Robert Johnson should be first in the $tags array
2417 foreach ($tagged as $nextTag) {
2418 if (stristr($nextTag, $tag . ' ')) {
2423 if (($success = Item::replaceTag($body, $profile_uid, $tag, $network)) && $success['replaced']) {
2431 DI::profiler()->stopRecording();
2436 * @param string $author Author display name
2437 * @param string $profile Author profile URL
2438 * @param string $avatar Author profile picture URL
2439 * @param string $link Post source URL
2440 * @param string $posted Post created date
2441 * @param string|null $guid Post guid (if any)
2442 * @param string|null $uri Post uri (if any)
2444 * @TODO Rewrite to handle over whole record array
2446 public static function getShareOpeningTag(string $author, string $profile, string $avatar, string $link, string $posted, string $guid = null, string $uri = null): string
2448 DI::profiler()->startRecording('rendering');
2449 $header = "[share author='" . str_replace(["'", "[", "]"], ["'", "[", "]"], $author) .
2450 "' profile='" . str_replace(["'", "[", "]"], ["'", "[", "]"], $profile) .
2451 "' avatar='" . str_replace(["'", "[", "]"], ["'", "[", "]"], $avatar) .
2452 "' link='" . str_replace(["'", "[", "]"], ["'", "[", "]"], $link) .
2453 "' posted='" . str_replace(["'", "[", "]"], ["'", "[", "]"], $posted);
2456 $header .= "' guid='" . str_replace(["'", "[", "]"], ["'", "[", "]"], $guid);
2460 $header .= "' message_id='" . str_replace(["'", "[", "]"], ["'", "[", "]"], $uri);
2465 DI::profiler()->stopRecording();
2470 * Returns the BBCode relevant to embed the provided URL in a post body.
2471 * For media type, it will return [img], [video] and [audio] tags.
2472 * For regular web pages, it will either output a [bookmark] tag if title and description were provided,
2473 * an [attachment] tag or a simple [url] tag depending on $tryAttachment.
2475 * @param string $url
2476 * @param bool $tryAttachment
2477 * @param string|null $title
2478 * @param string|null $description
2479 * @param string|null $tags
2481 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
2482 * @see ParseUrl::getSiteinfoCached
2484 public static function embedURL(string $url, bool $tryAttachment = true, string $title = null, string $description = null, string $tags = null): string
2486 DI::profiler()->startRecording('rendering');
2487 DI::logger()->info($url);
2489 // If there is already some content information submitted we don't
2490 // need to parse the url for content.
2491 if (!empty($title) && !empty($description)) {
2492 $title = str_replace(["\r", "\n"], ['', ''], $title);
2494 $description = '[quote]' . trim($description) . '[/quote]' . "\n";
2497 if (!empty($tags)) {
2498 $arr_tags = ParseUrl::convertTagsToArray($tags);
2499 if (count($arr_tags)) {
2500 $str_tags = "\n" . implode(' ', $arr_tags) . "\n";
2504 $result = sprintf('[bookmark=%s]%s[/bookmark]%s', $url, ($title) ? $title : $url, $description) . $str_tags;
2506 DI::logger()->info('(unparsed): returns: ' . $result);
2508 DI::profiler()->stopRecording();
2512 $siteinfo = ParseUrl::getSiteinfoCached($url);
2514 if (in_array($siteinfo['type'], ['image', 'video', 'audio'])) {
2515 switch ($siteinfo['type']) {
2517 $bbcode = "\n" . '[video]' . $url . '[/video]' . "\n";
2520 $bbcode = "\n" . '[audio]' . $url . '[/audio]' . "\n";
2523 $bbcode = "\n" . '[img]' . $url . '[/img]' . "\n";
2527 DI::profiler()->stopRecording();
2531 unset($siteinfo['keywords']);
2533 // Bypass attachment if parse url for a comment
2534 if (!$tryAttachment) {
2535 DI::profiler()->stopRecording();
2536 return "\n" . '[url=' . $url . ']' . ($siteinfo['title'] ?? $url) . '[/url]';
2539 // Format it as BBCode attachment
2540 $bbcode = "\n" . PageInfo::getFooterFromData($siteinfo);
2541 DI::profiler()->stopRecording();