]> git.mxchange.org Git - friendica.git/blobdiff - src/Content/Text/Plaintext.php
spelling: expiry
[friendica.git] / src / Content / Text / Plaintext.php
index b6d767f15999cd461facca3de72288af69ab0668..ce0a305fe70a361359706cad1c8924686c139b8a 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2020, Friendica
+ * @copyright Copyright (C) 2010-2023, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -23,30 +23,43 @@ namespace Friendica\Content\Text;
 
 use Friendica\Core\Protocol;
 use Friendica\DI;
+use Friendica\Model\Photo;
+use Friendica\Model\Post;
+use Friendica\Util\Network;
+use Friendica\Util\Strings;
 
 class Plaintext
 {
+       // Assumed length of an URL when shortened via the network's own url shortener (e.g. Twitter)
+       const URL_LENGTH = 23;
+
        /**
         * Shortens message
         *
         * @param  string $msg
         * @param  int    $limit
+        * @param  int    $uid
         * @return string
         *
         * @todo For Twitter URLs aren't shortened, but they have to be calculated as if.
         */
-       public static function shorten($msg, $limit)
+       public static function shorten(string $msg, int $limit, int $uid = 0): string
        {
+               $ellipsis = html_entity_decode("&#x2026;", ENT_QUOTES, 'UTF-8');
+
+               if (!empty($uid) && DI::pConfig()->get($uid, 'system', 'simple_shortening')) {
+                       return mb_substr(mb_substr(trim($msg), 0, $limit), 0, -3) . $ellipsis;
+               }
+
                $lines = explode("\n", $msg);
                $msg = "";
                $recycle = html_entity_decode("&#x2672; ", ENT_QUOTES, 'UTF-8');
-               $ellipsis = html_entity_decode("&#x2026;", ENT_QUOTES, 'UTF-8');
                foreach ($lines as $row => $line) {
-                       if (iconv_strlen(trim($msg . "\n" . $line), "UTF-8") <= $limit) {
+                       if (mb_strlen(trim($msg . "\n" . $line)) <= $limit) {
                                $msg = trim($msg . "\n" . $line);
                        } elseif (($msg == "") || (($row == 1) && (substr($msg, 0, 4) == $recycle))) {
                                // Is the new message empty by now or is it a reshared message?
-                               $msg = iconv_substr(iconv_substr(trim($msg . "\n" . $line), 0, $limit, "UTF-8"), 0, -3, "UTF-8") . $ellipsis;
+                               $msg = mb_substr(mb_substr(trim($msg . "\n" . $line), 0, $limit), 0, -3) . $ellipsis;
                        } else {
                                break;
                        }
@@ -99,30 +112,15 @@ class Plaintext
         * @param int    $limit          The maximum number of characters when posting to that network
         * @param bool   $includedlinks  Has an attached link to be included into the message?
         * @param int    $htmlmode       This controls the behavior of the BBCode conversion
-        * @param string $target_network Name of the network where the post should go to.
         *
         * @return array Same array structure than \Friendica\Content\Text\BBCode::getAttachedData
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         * @see   \Friendica\Content\Text\BBCode::getAttachedData
-        *
         */
-       public static function getPost($item, $limit = 0, $includedlinks = false, $htmlmode = BBCode::API, $target_network = '')
+       public static function getPost(array $item, int $limit = 0, bool $includedlinks = false, int $htmlmode = BBCode::MASTODON_API)
        {
-               // Remove hashtags
-               $URLSearchString = '^\[\]';
-               $body = preg_replace("/([#@])\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '$1$3', $item['body']);
-
-               // Add an URL element if the text contains a raw link
-               $body = preg_replace('/([^\]\=\'"]|^)(https?\:\/\/[a-zA-Z0-9\:\/\-\?\&\;\.\=\_\~\#\%\$\!\+\,]+)/ism',
-                       '$1[url]$2[/url]', $body);
-
-               // Remove the abstract
-               $body = BBCode::stripAbstract($body);
-
-               // At first look at data that is attached via "type-..." stuff
-               // This will hopefully replaced with a dedicated bbcode later
-               //$post = self::getAttachedData($b['body']);
-               $post = BBCode::getAttachedData($body, $item);
+               // Fetch attached media information
+               $post = self::getPostMedia($item);
 
                if (($item['title'] != '') && ($post['text'] != '')) {
                        $post['text'] = trim($item['title'] . "\n\n" . $post['text']);
@@ -130,34 +128,21 @@ class Plaintext
                        $post['text'] = trim($item['title']);
                }
 
-               $abstract = '';
-
                // Fetch the abstract from the given target network
-               if ($target_network != '') {
-                       $default_abstract = BBCode::getAbstract($item['body']);
-                       $abstract = BBCode::getAbstract($item['body'], $target_network);
-
-                       // If we post to a network with no limit we only fetch
-                       // an abstract exactly for this network
-                       if (($limit == 0) && ($abstract == $default_abstract)) {
-                               $abstract = '';
-                       }
-               } else {// Try to guess the correct target network
-                       switch ($htmlmode) {
-                               case BBCode::TWITTER:
-                                       $abstract = BBCode::getAbstract($item['body'], Protocol::TWITTER);
-                                       break;
-
-                               case BBCode::OSTATUS:
-                                       $abstract = BBCode::getAbstract($item['body'], Protocol::STATUSNET);
-                                       break;
-
-                               default: // We don't know the exact target.
-                                       // We fetch an abstract since there is a posting limit.
-                                       if ($limit > 0) {
-                                               $abstract = BBCode::getAbstract($item['body']);
-                                       }
-                       }
+               switch ($htmlmode) {
+                       case BBCode::TWITTER:
+                               $abstract = BBCode::getAbstract($item['body'], Protocol::TWITTER);
+                               break;
+
+                       case BBCode::OSTATUS:
+                               $abstract = BBCode::getAbstract($item['body'], Protocol::STATUSNET);
+                               break;
+
+                       default: // We don't know the exact target.
+                               // We fetch an abstract since there is a posting limit.
+                               if ($limit > 0) {
+                                       $abstract = BBCode::getAbstract($item['body']);
+                               }
                }
 
                if ($abstract != '') {
@@ -169,10 +154,12 @@ class Plaintext
                        }
                }
 
-               $html = BBCode::convert($post['text'] . ($post['after'] ?? ''), false, $htmlmode);
+               $html = BBCode::convertForUriId($item['uri-id'], $post['text'] . ($post['after'] ?? ''), $htmlmode);
                $msg = HTML::toPlaintext($html, 0, true);
                $msg = trim(html_entity_decode($msg, ENT_QUOTES, 'UTF-8'));
 
+               $complete_msg = $msg;
+
                $link = '';
                if ($includedlinks) {
                        if ($post['type'] == 'link') {
@@ -200,13 +187,13 @@ class Plaintext
 
                                // Will the text be shortened in the link?
                                // Or is the link the last item in the post?
-                               if (($limit > 0) && ($pos < $limit) && (($pos + 23 > $limit) || ($pos + strlen($link) == strlen($msg)))) {
+                               if (($limit > 0) && ($pos < $limit) && (($pos + self::URL_LENGTH > $limit) || ($pos + mb_strlen($link) == mb_strlen($msg)))) {
                                        $msg = trim(str_replace($link, '', $msg));
                                } elseif (($limit == 0) || ($pos < $limit)) {
                                        // The limit has to be increased since it will be shortened - but not now
                                        // Only do it with Twitter
-                                       if (($limit > 0) && (strlen($link) > 23) && ($htmlmode == BBCode::TWITTER)) {
-                                               $limit = $limit - 23 + strlen($link);
+                                       if (($limit > 0) && (mb_strlen($link) > self::URL_LENGTH) && ($htmlmode == BBCode::TWITTER)) {
+                                               $limit = $limit - self::URL_LENGTH + mb_strlen($link);
                                        }
 
                                        $link = '';
@@ -225,23 +212,29 @@ class Plaintext
                                $msg = str_replace('  ', ' ', $msg);
                        }
 
+                       if (!in_array($link, ['', $item['plink']]) && ($post['type'] != 'photo') && (strpos($complete_msg, $link) === false)) {
+                               $complete_msg .= "\n" . $link;
+                       }
+
+                       $post['parts'] = self::getParts(trim($complete_msg), $limit);
+
                        // Twitter is using its own limiter, so we always assume that shortened links will have this length
-                       if (iconv_strlen($link, 'UTF-8') > 0) {
-                               $limit = $limit - 23;
+                       if (mb_strlen($link) > 0) {
+                               $limit = $limit - self::URL_LENGTH;
                        }
 
-                       if (iconv_strlen($msg, 'UTF-8') > $limit) {
+                       if (mb_strlen($msg) > $limit) {
                                if (($post['type'] == 'text') && isset($post['url'])) {
                                        $post['url'] = $item['plink'];
                                } elseif (!isset($post['url'])) {
-                                       $limit = $limit - 23;
+                                       $limit = $limit - self::URL_LENGTH;
                                        $post['url'] = $item['plink'];
                                } elseif (strpos($item['body'], '[share') !== false) {
                                        $post['url'] = $item['plink'];
                                } elseif (DI::pConfig()->get($item['uid'], 'system', 'no_intelligent_shortening')) {
                                        $post['url'] = $item['plink'];
                                }
-                               $msg = self::shorten($msg, $limit);
+                               $msg = self::shorten($msg, $limit, $item['uid']);
                        }
                }
 
@@ -249,4 +242,143 @@ class Plaintext
 
                return $post;
        }
+
+       /**
+        * Split the message in parts
+        *
+        * @param string  $message
+        * @param integer $baselimit
+        * @return array
+        */
+       private static function getParts(string $message, int $baselimit): array
+       {
+               $parts = [];
+               $part = '';
+
+               $limit = $baselimit;
+
+               while ($message) {
+                       $pos1 = strpos($message, ' ');
+                       $pos2 = strpos($message, "\n");
+
+                       if (($pos1 !== false) && ($pos2 !== false)) {
+                               $pos = min($pos1, $pos2) + 1;
+                       } elseif ($pos1 !== false) {
+                               $pos = $pos1 + 1;
+                       } elseif ($pos2 !== false) {
+                               $pos = $pos2 + 1;
+                       } else {
+                               $word = $message;
+                               $message = '';
+                       }
+
+                       if (trim($message)) {
+                               $word    = substr($message, 0, $pos);
+                               $message = trim(substr($message, $pos));
+                       }
+
+                       if (Network::isValidHttpUrl(trim($word))) {
+                               $limit += mb_strlen(trim($word)) - self::URL_LENGTH;
+                       }
+
+                       if ((mb_strlen($part . $word) > $limit - 8) && ($parts || (mb_strlen($part . $word . $message) > $limit))) {
+                               $parts[] = trim($part);
+                               $part    = '';
+                               $limit   = $baselimit;
+                       }
+                       $part .= $word;
+               }
+               $parts[] = trim($part);
+
+               if (count($parts) > 1) {
+                       foreach ($parts as $key => $part) {
+                               $parts[$key] .= ' (' . ($key + 1) . '/' . count($parts) . ')';
+                       }
+               }
+
+               return $parts;
+       }
+
+       /**
+        * Fetch attached media to the post and simplify the body.
+        *
+        * @param array $item
+        * @return array
+        */
+       private static function getPostMedia(array $item): array
+       {
+               $post = ['type' => 'text', 'images' => [], 'remote_images' => []];
+
+               // Remove mentions and hashtag links
+               $URLSearchString = '^\[\]';
+               $post['text'] = preg_replace("/([#!@])\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '$1$3', $item['body']);
+
+               // Remove abstract
+               $post['text'] = BBCode::stripAbstract($post['text']);
+               // Remove attached links
+               $post['text'] = BBCode::removeAttachment($post['text']);
+               // Remove any links
+               $post['text'] = Post\Media::removeFromBody($post['text']);
+
+               $images = Post\Media::getByURIId($item['uri-id'], [Post\Media::IMAGE]);
+               if (!empty($item['quote-uri-id'])) {
+                       $images = array_merge($images, Post\Media::getByURIId($item['quote-uri-id'], [Post\Media::IMAGE]));
+               }
+               foreach ($images as $image) {
+                       if ($id = Photo::getIdForName($image['url'])) {
+                               $post['images'][] = ['url' => $image['url'], 'description' => $image['description'], 'id' => $id];
+                       } else {
+                               $post['remote_images'][] = ['url' => $image['url'], 'description' => $image['description']];
+                       }
+               }
+
+               if (empty($post['images'])) {
+                       unset($post['images']);
+               }
+
+               if (empty($post['remote_images'])) {
+                       unset($post['remote_images']);
+               }
+
+               if (!empty($post['images'])) {
+                       $post['type']              = 'photo';
+                       $post['image']             = $post['images'][0]['url'];
+                       $post['image_description'] = $post['images'][0]['description'];
+               } elseif (!empty($post['remote_images'])) {
+                       $post['type']              = 'photo';
+                       $post['image']             = $post['remote_images'][0]['url'];
+                       $post['image_description'] = $post['remote_images'][0]['description'];
+               }
+
+               // Look for audio or video links
+               $media = Post\Media::getByURIId($item['uri-id'], [Post\Media::AUDIO, Post\Media::VIDEO]);
+               if (!empty($item['quote-uri-id'])) {
+                       $media = array_merge($media, Post\Media::getByURIId($item['quote-uri-id'], [Post\Media::AUDIO, Post\Media::VIDEO]));
+               }
+
+               foreach ($media as $medium) {
+                       if (in_array($medium['type'], [Post\Media::AUDIO, Post\Media::VIDEO])) {
+                               $post['type'] = 'link';
+                               $post['url']  = $medium['url'];
+                       }
+               }
+
+               // Look for an attached link
+               $page = Post\Media::getByURIId($item['uri-id'], [Post\Media::HTML]);
+               if (!empty($item['quote-uri-id']) && empty($page)) {
+                       $page = Post\Media::getByURIId($item['quote-uri-id'], [Post\Media::HTML]);
+               }
+               if (!empty($page)) {
+                       $post['type']          = 'link';
+                       $post['url']           = $page[0]['url'];
+                       $post['description']   = $page[0]['description'];
+                       $post['title']         = $page[0]['name'];
+
+                       if (empty($post['image']) && !empty($page[0]['preview'])) {
+                               $post['image'] = $page[0]['preview'];
+                       }
+               }
+
+               return $post;
+       }
 }