src/Content/Text/Plaintext.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   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.
  11  *
  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.
  16  *
  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/>.
  19  *
  20  */
  21
  22 namespace Friendica\Content\Text;
  23
  24 use Friendica\Core\Protocol;
  25 use Friendica\DI;
  26 use Friendica\Util\Network;
  27
  28 class Plaintext
  29 {
  30         // Assumed length of an URL when shortened via the network's own url shortener (e.g. Twitter)
  31         const URL_LENGTH = 23;
  32
  33         /**
  34          * Shortens message
  35          *
  36          * @param  string $msg
  37          * @param  int    $limit
  38          * @param  int    $uid
  39          * @return string
  40          *
  41          * @todo For Twitter URLs aren't shortened, but they have to be calculated as if.
  42          */
  43         public static function shorten(string $msg, int $limit, int $uid = 0): string
  44         {
  45                 $ellipsis = html_entity_decode("&#x2026;", ENT_QUOTES, 'UTF-8');
  46
  47                 if (!empty($uid) && DI::pConfig()->get($uid, 'system', 'simple_shortening')) {
  48                         return mb_substr(mb_substr(trim($msg), 0, $limit), 0, -3) . $ellipsis;
  49                 }
  50
  51                 $lines = explode("\n", $msg);
  52                 $msg = "";
  53                 $recycle = html_entity_decode("&#x2672; ", ENT_QUOTES, 'UTF-8');
  54                 foreach ($lines as $row => $line) {
  55                         if (mb_strlen(trim($msg . "\n" . $line)) <= $limit) {
  56                                 $msg = trim($msg . "\n" . $line);
  57                         } elseif (($msg == "") || (($row == 1) && (substr($msg, 0, 4) == $recycle))) {
  58                                 // Is the new message empty by now or is it a reshared message?
  59                                 $msg = mb_substr(mb_substr(trim($msg . "\n" . $line), 0, $limit), 0, -3) . $ellipsis;
  60                         } else {
  61                                 break;
  62                         }
  63                 }
  64
  65                 return $msg;
  66         }
  67
  68         /**
  69          * Returns the character positions of the provided boundaries, optionally skipping a number of first occurrences
  70          *
  71          * @param string $text        Text to search
  72          * @param string $open        Left boundary
  73          * @param string $close       Right boundary
  74          * @param int    $occurrences Number of first occurrences to skip
  75          * @return boolean|array
  76          */
  77         public static function getBoundariesPosition($text, $open, $close, $occurrences = 0)
  78         {
  79                 if ($occurrences < 0) {
  80                         $occurrences = 0;
  81                 }
  82
  83                 $start_pos = -1;
  84                 for ($i = 0; $i <= $occurrences; $i++) {
  85                         if ($start_pos !== false) {
  86                                 $start_pos = strpos($text, $open, $start_pos + 1);
  87                         }
  88                 }
  89
  90                 if ($start_pos === false) {
  91                         return false;
  92                 }
  93
  94                 $end_pos = strpos($text, $close, $start_pos);
  95
  96                 if ($end_pos === false) {
  97                         return false;
  98                 }
  99
 100                 $res = ['start' => $start_pos, 'end' => $end_pos];
 101
 102                 return $res;
 103         }
 104
 105         /**
 106          * Convert a message into plaintext for connectors to other networks
 107          *
 108          * @param array  $item           The message array that is about to be posted
 109          * @param int    $limit          The maximum number of characters when posting to that network
 110          * @param bool   $includedlinks  Has an attached link to be included into the message?
 111          * @param int    $htmlmode       This controls the behavior of the BBCode conversion
 112          * @param string $target_network Name of the network where the post should go to.
 113          *
 114          * @return array Same array structure than \Friendica\Content\Text\BBCode::getAttachedData
 115          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 116          * @see   \Friendica\Content\Text\BBCode::getAttachedData
 117          *
 118          */
 119         public static function getPost($item, $limit = 0, $includedlinks = false, $htmlmode = BBCode::API, $target_network = '')
 120         {
 121                 // Remove hashtags
 122                 $URLSearchString = '^\[\]';
 123                 $body = preg_replace("/([#@])\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '$1$3', $item['body']);
 124
 125                 // Add an URL element if the text contains a raw link
 126                 $body = preg_replace('/([^\]\=\'"]|^)(https?\:\/\/[a-zA-Z0-9\:\/\-\?\&\;\.\=\_\~\#\%\$\!\+\,]+)/ism',
 127                         '$1[url]$2[/url]', $body);
 128
 129                 // Remove the abstract
 130                 $body = BBCode::stripAbstract($body);
 131
 132                 // At first look at data that is attached via "type-..." stuff
 133                 $post = BBCode::getAttachedData($body, $item);
 134
 135                 if (($item['title'] != '') && ($post['text'] != '')) {
 136                         $post['text'] = trim($item['title'] . "\n\n" . $post['text']);
 137                 } elseif ($item['title'] != '') {
 138                         $post['text'] = trim($item['title']);
 139                 }
 140
 141                 $abstract = '';
 142
 143                 // Fetch the abstract from the given target network
 144                 if ($target_network != '') {
 145                         $default_abstract = BBCode::getAbstract($item['body']);
 146                         $abstract = BBCode::getAbstract($item['body'], $target_network);
 147
 148                         // If we post to a network with no limit we only fetch
 149                         // an abstract exactly for this network
 150                         if (($limit == 0) && ($abstract == $default_abstract)) {
 151                                 $abstract = '';
 152                         }
 153                 } else {// Try to guess the correct target network
 154                         switch ($htmlmode) {
 155                                 case BBCode::TWITTER:
 156                                         $abstract = BBCode::getAbstract($item['body'], Protocol::TWITTER);
 157                                         break;
 158
 159                                 case BBCode::OSTATUS:
 160                                         $abstract = BBCode::getAbstract($item['body'], Protocol::STATUSNET);
 161                                         break;
 162
 163                                 default: // We don't know the exact target.
 164                                         // We fetch an abstract since there is a posting limit.
 165                                         if ($limit > 0) {
 166                                                 $abstract = BBCode::getAbstract($item['body']);
 167                                         }
 168                         }
 169                 }
 170
 171                 if ($abstract != '') {
 172                         $post['text'] = $abstract;
 173
 174                         if ($post['type'] == 'text') {
 175                                 $post['type'] = 'link';
 176                                 $post['url'] = $item['plink'];
 177                         }
 178                 }
 179
 180                 $html = BBCode::convertForUriId($item['uri-id'], $post['text'] . ($post['after'] ?? ''), $htmlmode);
 181                 $msg = HTML::toPlaintext($html, 0, true);
 182                 $msg = trim(html_entity_decode($msg, ENT_QUOTES, 'UTF-8'));
 183
 184                 $complete_msg = $msg;
 185
 186                 $link = '';
 187                 if ($includedlinks) {
 188                         if ($post['type'] == 'link') {
 189                                 $link = $post['url'];
 190                         } elseif ($post['type'] == 'text') {
 191                                 $link = $post['url'] ?? '';
 192                         } elseif ($post['type'] == 'video') {
 193                                 $link = $post['url'];
 194                         } elseif ($post['type'] == 'photo') {
 195                                 $link = $post['image'];
 196                         }
 197
 198                         if (($msg == '') && isset($post['title'])) {
 199                                 $msg = trim($post['title']);
 200                         }
 201
 202                         if (($msg == '') && isset($post['description'])) {
 203                                 $msg = trim($post['description']);
 204                         }
 205
 206                         // If the link is already contained in the post, then it neeedn't to be added again
 207                         // But: if the link is beyond the limit, then it has to be added.
 208                         if (($link != '') && strstr($msg, $link)) {
 209                                 $pos = strpos($msg, $link);
 210
 211                                 // Will the text be shortened in the link?
 212                                 // Or is the link the last item in the post?
 213                                 if (($limit > 0) && ($pos < $limit) && (($pos + self::URL_LENGTH > $limit) || ($pos + mb_strlen($link) == mb_strlen($msg)))) {
 214                                         $msg = trim(str_replace($link, '', $msg));
 215                                 } elseif (($limit == 0) || ($pos < $limit)) {
 216                                         // The limit has to be increased since it will be shortened - but not now
 217                                         // Only do it with Twitter
 218                                         if (($limit > 0) && (mb_strlen($link) > self::URL_LENGTH) && ($htmlmode == BBCode::TWITTER)) {
 219                                                 $limit = $limit - self::URL_LENGTH + mb_strlen($link);
 220                                         }
 221
 222                                         $link = '';
 223
 224                                         if ($post['type'] == 'text') {
 225                                                 unset($post['url']);
 226                                         }
 227                                 }
 228                         }
 229                 }
 230
 231                 if ($limit > 0) {
 232                         // Reduce multiple spaces
 233                         // When posted to a network with limited space, we try to gain space where possible
 234                         while (strpos($msg, '  ') !== false) {
 235                                 $msg = str_replace('  ', ' ', $msg);
 236                         }
 237
 238                         if (!in_array($link, ['', $item['plink']]) && ($post['type'] != 'photo') && (strpos($complete_msg, $link) === false)) {
 239                                 $complete_msg .= "\n" . $link;
 240                         }
 241
 242                         $post['parts'] = self::getParts(trim($complete_msg), $limit);
 243
 244                         // Twitter is using its own limiter, so we always assume that shortened links will have this length
 245                         if (mb_strlen($link) > 0) {
 246                                 $limit = $limit - self::URL_LENGTH;
 247                         }
 248
 249                         if (mb_strlen($msg) > $limit) {
 250                                 if (($post['type'] == 'text') && isset($post['url'])) {
 251                                         $post['url'] = $item['plink'];
 252                                 } elseif (!isset($post['url'])) {
 253                                         $limit = $limit - self::URL_LENGTH;
 254                                         $post['url'] = $item['plink'];
 255                                 } elseif (strpos($item['body'], '[share') !== false) {
 256                                         $post['url'] = $item['plink'];
 257                                 } elseif (DI::pConfig()->get($item['uid'], 'system', 'no_intelligent_shortening')) {
 258                                         $post['url'] = $item['plink'];
 259                                 }
 260                                 $msg = self::shorten($msg, $limit, $item['uid']);
 261                         }
 262                 }
 263
 264                 $post['text'] = trim($msg);
 265
 266                 return $post;
 267         }
 268
 269         /**
 270          * Split the message in parts
 271          *
 272          * @param string  $message
 273          * @param integer $baselimit
 274          * @return array
 275          */
 276         private static function getParts(string $message, int $baselimit): array
 277         {
 278                 $parts = [];
 279                 $part = '';
 280
 281                 $limit = $baselimit;
 282
 283                 while ($message) {
 284                         $pos1 = strpos($message, ' ');
 285                         $pos2 = strpos($message, "\n");
 286
 287                         if (($pos1 !== false) && ($pos2 !== false)) {
 288                                 $pos = min($pos1, $pos2) + 1;
 289                         } elseif ($pos1 !== false) {
 290                                 $pos = $pos1 + 1;
 291                         } elseif ($pos2 !== false) {
 292                                 $pos = $pos2 + 1;
 293                         } else {
 294                                 $word = $message;
 295                                 $message = '';
 296                         }
 297
 298                         if (trim($message)) {
 299                                 $word    = substr($message, 0, $pos);
 300                                 $message = trim(substr($message, $pos));
 301                         }
 302
 303                         if (Network::isValidHttpUrl(trim($word))) {
 304                                 $limit += mb_strlen(trim($word)) - self::URL_LENGTH;
 305                         }
 306
 307                         if ((mb_strlen($part . $word) > $limit - 8) && (mb_strlen($part . $word . $message) > $limit)) {
 308                                 $parts[] = trim($part);
 309                                 $part    = '';
 310                                 $limit   = $baselimit;
 311                         }
 312                         $part .= $word;
 313                 }
 314                 $parts[] = trim($part);
 315
 316                 if (count($parts) > 1) {
 317                         foreach ($parts as $key => $part) {
 318                                 $parts[$key] .= ' (' . ($key + 1) . '/' . count($parts) . ')';
 319                         }
 320                 }
 321
 322                 return $parts;
 323         }
 324 }