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;
24 use Friendica\Core\Protocol;
26 use Friendica\Util\Network;
30 // Assumed length of an URL when shortened via the network's own url shortener (e.g. Twitter)
31 const URL_LENGTH = 23;
41 * @todo For Twitter URLs aren't shortened, but they have to be calculated as if.
43 public static function shorten(string $msg, int $limit, int $uid = 0): string
45 $ellipsis = html_entity_decode("…", ENT_QUOTES, 'UTF-8');
47 if (!empty($uid) && DI::pConfig()->get($uid, 'system', 'simple_shortening')) {
48 return mb_substr(mb_substr(trim($msg), 0, $limit), 0, -3) . $ellipsis;
51 $lines = explode("\n", $msg);
53 $recycle = html_entity_decode("♲ ", 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;
69 * Returns the character positions of the provided boundaries, optionally skipping a number of first occurrences
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
77 public static function getBoundariesPosition($text, $open, $close, $occurrences = 0)
79 if ($occurrences < 0) {
84 for ($i = 0; $i <= $occurrences; $i++) {
85 if ($start_pos !== false) {
86 $start_pos = strpos($text, $open, $start_pos + 1);
90 if ($start_pos === false) {
94 $end_pos = strpos($text, $close, $start_pos);
96 if ($end_pos === false) {
100 $res = ['start' => $start_pos, 'end' => $end_pos];
106 * Convert a message into plaintext for connectors to other networks
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.
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
118 public static function getPost(array $item, int $limit = 0, bool $includedlinks = false, int $htmlmode = BBCode::MASTODON_API, string $target_network = '')
121 $URLSearchString = '^\[\]';
122 $body = preg_replace("/([#@])\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '$1$3', $item['body']);
124 // Add an URL element if the text contains a raw link
125 $body = preg_replace(
126 '/([^\]\=\'"]|^)(https?\:\/\/[a-zA-Z0-9\:\/\-\?\&\;\.\=\_\~\#\%\$\!\+\,]+)/ism',
131 // Remove the abstract
132 $body = BBCode::stripAbstract($body);
134 // At first look at data that is attached via "type-..." stuff
135 $post = BBCode::getAttachedData($body, $item);
137 if (($item['title'] != '') && ($post['text'] != '')) {
138 $post['text'] = trim($item['title'] . "\n\n" . $post['text']);
139 } elseif ($item['title'] != '') {
140 $post['text'] = trim($item['title']);
145 // Fetch the abstract from the given target network
146 if ($target_network != '') {
147 $default_abstract = BBCode::getAbstract($item['body']);
148 $abstract = BBCode::getAbstract($item['body'], $target_network);
150 // If we post to a network with no limit we only fetch
151 // an abstract exactly for this network
152 if (($limit == 0) && ($abstract == $default_abstract)) {
155 } else { // Try to guess the correct target network
157 case BBCode::TWITTER:
158 $abstract = BBCode::getAbstract($item['body'], Protocol::TWITTER);
161 case BBCode::OSTATUS:
162 $abstract = BBCode::getAbstract($item['body'], Protocol::STATUSNET);
165 default: // We don't know the exact target.
166 // We fetch an abstract since there is a posting limit.
168 $abstract = BBCode::getAbstract($item['body']);
173 if ($abstract != '') {
174 $post['text'] = $abstract;
176 if ($post['type'] == 'text') {
177 $post['type'] = 'link';
178 $post['url'] = $item['plink'];
182 $html = BBCode::convertForUriId($item['uri-id'], $post['text'] . ($post['after'] ?? ''), $htmlmode);
183 $msg = HTML::toPlaintext($html, 0, true);
184 $msg = trim(html_entity_decode($msg, ENT_QUOTES, 'UTF-8'));
186 $complete_msg = $msg;
189 if ($includedlinks) {
190 if ($post['type'] == 'link') {
191 $link = $post['url'];
192 } elseif ($post['type'] == 'text') {
193 $link = $post['url'] ?? '';
194 } elseif ($post['type'] == 'video') {
195 $link = $post['url'];
196 } elseif ($post['type'] == 'photo') {
197 $link = $post['image'];
200 if (($msg == '') && isset($post['title'])) {
201 $msg = trim($post['title']);
204 if (($msg == '') && isset($post['description'])) {
205 $msg = trim($post['description']);
208 // If the link is already contained in the post, then it neeedn't to be added again
209 // But: if the link is beyond the limit, then it has to be added.
210 if (($link != '') && strstr($msg, $link)) {
211 $pos = strpos($msg, $link);
213 // Will the text be shortened in the link?
214 // Or is the link the last item in the post?
215 if (($limit > 0) && ($pos < $limit) && (($pos + self::URL_LENGTH > $limit) || ($pos + mb_strlen($link) == mb_strlen($msg)))) {
216 $msg = trim(str_replace($link, '', $msg));
217 } elseif (($limit == 0) || ($pos < $limit)) {
218 // The limit has to be increased since it will be shortened - but not now
219 // Only do it with Twitter
220 if (($limit > 0) && (mb_strlen($link) > self::URL_LENGTH) && ($htmlmode == BBCode::TWITTER)) {
221 $limit = $limit - self::URL_LENGTH + mb_strlen($link);
226 if ($post['type'] == 'text') {
234 // Reduce multiple spaces
235 // When posted to a network with limited space, we try to gain space where possible
236 while (strpos($msg, ' ') !== false) {
237 $msg = str_replace(' ', ' ', $msg);
240 if (!in_array($link, ['', $item['plink']]) && ($post['type'] != 'photo') && (strpos($complete_msg, $link) === false)) {
241 $complete_msg .= "\n" . $link;
244 $post['parts'] = self::getParts(trim($complete_msg), $limit);
246 // Twitter is using its own limiter, so we always assume that shortened links will have this length
247 if (mb_strlen($link) > 0) {
248 $limit = $limit - self::URL_LENGTH;
251 if (mb_strlen($msg) > $limit) {
252 if (($post['type'] == 'text') && isset($post['url'])) {
253 $post['url'] = $item['plink'];
254 } elseif (!isset($post['url'])) {
255 $limit = $limit - self::URL_LENGTH;
256 $post['url'] = $item['plink'];
257 } elseif (strpos($item['body'], '[share') !== false) {
258 $post['url'] = $item['plink'];
259 } elseif (DI::pConfig()->get($item['uid'], 'system', 'no_intelligent_shortening')) {
260 $post['url'] = $item['plink'];
262 $msg = self::shorten($msg, $limit, $item['uid']);
266 $post['text'] = trim($msg);
272 * Split the message in parts
274 * @param string $message
275 * @param integer $baselimit
278 private static function getParts(string $message, int $baselimit): array
286 $pos1 = strpos($message, ' ');
287 $pos2 = strpos($message, "\n");
289 if (($pos1 !== false) && ($pos2 !== false)) {
290 $pos = min($pos1, $pos2) + 1;
291 } elseif ($pos1 !== false) {
293 } elseif ($pos2 !== false) {
300 if (trim($message)) {
301 $word = substr($message, 0, $pos);
302 $message = trim(substr($message, $pos));
305 if (Network::isValidHttpUrl(trim($word))) {
306 $limit += mb_strlen(trim($word)) - self::URL_LENGTH;
309 if ((mb_strlen($part . $word) > $limit - 8) && ($parts || (mb_strlen($part . $word . $message) > $limit))) {
310 $parts[] = trim($part);
316 $parts[] = trim($part);
318 if (count($parts) > 1) {
319 foreach ($parts as $key => $part) {
320 $parts[$key] .= ' (' . ($key + 1) . '/' . count($parts) . ')';