]> git.mxchange.org Git - friendica.git/blobdiff - src/Content/Text/Markdown.php
Fix code standards
[friendica.git] / src / Content / Text / Markdown.php
index e3e2cd3ac957750e56f04205179611a3038aac72..33e023bc03662b9f55bbec4913a12b6506d6463a 100644 (file)
 <?php
-
 /**
- * @file src/Content/Text/Markdown.php
+ * @copyright Copyright (C) 2010-2023, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
  */
 
 namespace Friendica\Content\Text;
 
-use Friendica\BaseObject;
+use Friendica\Core\Logger;
 use Friendica\Core\System;
+use Friendica\DI;
 use Friendica\Model\Contact;
-use Michelf\MarkdownExtra;
 
 /**
  * Friendica-specific usage of Markdown
- *
- * @author Hypolite Petovan <hypolite@mrpetovan.com>
  */
-class Markdown extends BaseObject
+class Markdown
 {
        /**
         * Converts a Markdown string into HTML. The hardwrap parameter maximizes
         * compatibility with Diaspora in spite of the Markdown standard.
         *
-        * @brief Converts a Markdown string into HTML
         * @param string $text
-        * @param bool   $hardwrap
+        * @param bool   $hardwrap Enables line breaks on \n without two trailing spaces
+        * @param string $baseuri  Optional. Prepend anchor links with this URL
         * @return string
-        * @throws \Exception
         */
-       public static function convert($text, $hardwrap = true) {
-               $stamp1 = microtime(true);
+       public static function convert($text, $hardwrap = true, $baseuri = null) {
+               DI::profiler()->startRecording('rendering');
+
+               $MarkdownParser = new MarkdownParser();
+               $MarkdownParser->code_class_prefix  = 'language-';
+               $MarkdownParser->hard_wrap          = $hardwrap;
+               $MarkdownParser->hashtag_protection = true;
+               $MarkdownParser->url_filter_func    = function ($url) use ($baseuri) {
+                       if (!empty($baseuri) && strpos($url, '#') === 0) {
+                               $url = ltrim($baseuri, '/') . $url;
+                       }
+                       return  $url;
+               };
+
+               $text = self::convertDiasporaMentionsToHtml($text);
 
-               $MarkdownParser = new MarkdownExtra();
-               $MarkdownParser->hard_wrap = $hardwrap;
-               $MarkdownParser->code_class_prefix = 'language-';
                $html = $MarkdownParser->transform($text);
-               $html = preg_replace('/<a(.*?)href="#/is', '<a$1href="' . ltrim($_SERVER['REQUEST_URI'], '/') . '#', $html);
 
-               self::getApp()->getProfiler()->saveTimestamp($stamp1, "parser", System::callstack());
+               DI::profiler()->stopRecording();
 
                return $html;
        }
 
        /**
-        * @brief Callback function to replace a Diaspora style mention in a mention for Friendica
+        * Replace Diaspora-style mentions in a text since they trip the Markdown parser autolinker.
         *
-        * @param array $match Matching values for the callback
-        *                     [1] = mention type (@ or !)
-        *                     [2] = name (optional)
-        *                     [3] = address
-        * @return string Replaced mention
-        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
-        * @throws \ImagickException
+        * @param string $text
+        * @return string
         */
-       private static function diasporaMention2BBCodeCallback($match)
+       private static function convertDiasporaMentionsToHtml(string $text)
        {
-               if ($match[3] == '') {
-                       return;
-               }
-
-               $data = Contact::getDetailsByAddr($match[3]);
-
-               if (empty($data)) {
-                       return;
-               }
-
-               $name = $match[2];
-
-               if ($name == '') {
-                       $name = $data['name'];
-               }
-
-               return $match[1] . '[url=' . $data['url'] . ']' . $name . '[/url]';
+               return preg_replace_callback(
+                       '/([@!]){(?:([^}]+?); ?)?([^} ]+)}/',
+                       /*
+                        * Matching values for the callback
+                        * [1] = mention type (@ or !)
+                        * [2] = name (optional)
+                        * [3] = profile URL
+                        */
+                       function ($matches) {
+                               if ($matches[3] == '') {
+                                       return '';
+                               }
+
+                               $data = Contact::getByURL($matches[3]);
+
+                               if (empty($data)) {
+                                       return '';
+                               }
+
+                               $name = $matches[2];
+
+                               if ($name == '') {
+                                       $name = $data['name'];
+                               }
+
+                               return $matches[1] . '<a href="' . $data['url'] . '">' . $name . '</a>';
+                       },
+                       $text
+               );
        }
 
        /*
@@ -80,9 +108,19 @@ class Markdown extends BaseObject
         * So we'll use that to convert to HTML, then convert the HTML back to bbcode,
         * and then clean up a few Diaspora specific constructs.
         */
-       public static function toBBCode($s)
+       public static function toBBCode($s): string
        {
-               $s = html_entity_decode($s, ENT_COMPAT, 'UTF-8');
+               // @TODO Temporary until we find the source of the null value to finally set the correct type-hint
+               if (is_null($s)) {
+                       Logger::warning('Received null value', ['callstack' => System::callstack()]);
+                       return '';
+               }
+
+               if (!$s) {
+                       return $s;
+               }
+
+               DI::profiler()->startRecording('rendering');
 
                // The parser cannot handle paragraphs correctly
                $s = str_replace(['</p>', '<p>', '<p dir="ltr">'], ['<br>', '<br>', '<br>'], $s);
@@ -92,29 +130,22 @@ class Markdown extends BaseObject
 
                $s = self::convert($s);
 
-               $regexp = "/([@!])\{(?:([^\}]+?); ?)?([^\} ]+)\}/";
-               $s = preg_replace_callback($regexp, ['self', 'diasporaMention2BBCodeCallback'], $s);
-
                $s = HTML::toBBCode($s);
 
                // protect the recycle symbol from turning into a tag, but without unescaping angles and naked ampersands
                $s = str_replace('&#x2672;', html_entity_decode('&#x2672;', ENT_QUOTES, 'UTF-8'), $s);
 
-               // Convert everything that looks like a link to a link
-               $s = preg_replace('/([^\]=]|^)(https?\:\/\/)([a-zA-Z0-9:\/\-?&;.=_~#%$!+,@]+(?<!,))/ism', '$1[url=$2$3]$2$3[/url]', $s);
-
                //$s = preg_replace("/([^\]\=]|^)(https?\:\/\/)(vimeo|youtu|www\.youtube|soundcloud)([a-zA-Z0-9\:\/\-\?\&\;\.\=\_\~\#\%\$\!\+\,]+)/ism", '$1[url=$2$3$4]$2$3$4[/url]',$s);
                $s = BBCode::pregReplaceInTag('/\[url\=?(.*?)\]https?:\/\/www.youtube.com\/watch\?v\=(.*?)\[\/url\]/ism', '[youtube]$2[/youtube]', 'url', $s);
                $s = BBCode::pregReplaceInTag('/\[url\=https?:\/\/www.youtube.com\/watch\?v\=(.*?)\].*?\[\/url\]/ism'   , '[youtube]$1[/youtube]', 'url', $s);
+               $s = BBCode::pregReplaceInTag('/\[url\=https?:\/\/www.youtube.com\/shorts\/(.*?)\].*?\[\/url\]/ism'     , '[youtube]$1[/youtube]', 'url', $s);
                $s = BBCode::pregReplaceInTag('/\[url\=?(.*?)\]https?:\/\/vimeo.com\/([0-9]+)(.*?)\[\/url\]/ism'        , '[vimeo]$2[/vimeo]'    , 'url', $s);
                $s = BBCode::pregReplaceInTag('/\[url\=https?:\/\/vimeo.com\/([0-9]+)\](.*?)\[\/url\]/ism'              , '[vimeo]$1[/vimeo]'    , 'url', $s);
 
                // remove duplicate adjacent code tags
                $s = preg_replace('/(\[code\])+(.*?)(\[\/code\])+/ism', '[code]$2[/code]', $s);
 
-               // Don't show link to full picture (until it is fixed)
-               $s = BBCode::scaleExternalImages($s, false);
-
+               DI::profiler()->stopRecording();
                return $s;
        }
 }