<?php
/**
- * @file src/Content/Text/Plaintext.php
+ * @copyright Copyright (C) 2010-2021, 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\Core\Protocol;
+use Friendica\DI;
+
class Plaintext
{
/**
* Shortens message
*
- * @param type $msg
- * @param type $limit
- * @return type
+ * @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("…", ENT_QUOTES, 'UTF-8');
+
+ if (!empty($uid) && DI::pConfig()->get($uid, 'system', 'simple_shortening')) {
+ return iconv_substr(iconv_substr(trim($msg), 0, $limit, "UTF-8"), 0, -3, "UTF-8") . $ellipsis;
+ }
+
$lines = explode("\n", $msg);
$msg = "";
$recycle = html_entity_decode("♲ ", ENT_QUOTES, 'UTF-8');
- $ellipsis = html_entity_decode("…", ENT_QUOTES, 'UTF-8');
foreach ($lines as $row => $line) {
if (iconv_strlen(trim($msg . "\n" . $line), "UTF-8") <= $limit) {
$msg = trim($msg . "\n" . $line);
return $msg;
}
+
+ /**
+ * Returns the character positions of the provided boundaries, optionally skipping a number of first occurrences
+ *
+ * @param string $text Text to search
+ * @param string $open Left boundary
+ * @param string $close Right boundary
+ * @param int $occurrences Number of first occurrences to skip
+ * @return boolean|array
+ */
+ public static function getBoundariesPosition($text, $open, $close, $occurrences = 0)
+ {
+ if ($occurrences < 0) {
+ $occurrences = 0;
+ }
+
+ $start_pos = -1;
+ for ($i = 0; $i <= $occurrences; $i++) {
+ if ($start_pos !== false) {
+ $start_pos = strpos($text, $open, $start_pos + 1);
+ }
+ }
+
+ if ($start_pos === false) {
+ return false;
+ }
+
+ $end_pos = strpos($text, $close, $start_pos);
+
+ if ($end_pos === false) {
+ return false;
+ }
+
+ $res = ['start' => $start_pos, 'end' => $end_pos];
+
+ return $res;
+ }
+
+ /**
+ * Convert a message into plaintext for connectors to other networks
+ *
+ * @param array $item The message array that is about to be posted
+ * @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 = '')
+ {
+ // 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);
+
+ if (($item['title'] != '') && ($post['text'] != '')) {
+ $post['text'] = trim($item['title'] . "\n\n" . $post['text']);
+ } elseif ($item['title'] != '') {
+ $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']);
+ }
+ }
+ }
+
+ if ($abstract != '') {
+ $post['text'] = $abstract;
+
+ if ($post['type'] == 'text') {
+ $post['type'] = 'link';
+ $post['url'] = $item['plink'];
+ }
+ }
+
+ $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'));
+
+ $link = '';
+ if ($includedlinks) {
+ if ($post['type'] == 'link') {
+ $link = $post['url'];
+ } elseif ($post['type'] == 'text') {
+ $link = $post['url'] ?? '';
+ } elseif ($post['type'] == 'video') {
+ $link = $post['url'];
+ } elseif ($post['type'] == 'photo') {
+ $link = $post['image'];
+ }
+
+ if (($msg == '') && isset($post['title'])) {
+ $msg = trim($post['title']);
+ }
+
+ if (($msg == '') && isset($post['description'])) {
+ $msg = trim($post['description']);
+ }
+
+ // If the link is already contained in the post, then it neeedn't to be added again
+ // But: if the link is beyond the limit, then it has to be added.
+ if (($link != '') && strstr($msg, $link)) {
+ $pos = strpos($msg, $link);
+
+ // 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)))) {
+ $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);
+ }
+
+ $link = '';
+
+ if ($post['type'] == 'text') {
+ unset($post['url']);
+ }
+ }
+ }
+ }
+
+ if ($limit > 0) {
+ // Reduce multiple spaces
+ // When posted to a network with limited space, we try to gain space where possible
+ while (strpos($msg, ' ') !== false) {
+ $msg = str_replace(' ', ' ', $msg);
+ }
+
+ // 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 (iconv_strlen($msg, 'UTF-8') > $limit) {
+ if (($post['type'] == 'text') && isset($post['url'])) {
+ $post['url'] = $item['plink'];
+ } elseif (!isset($post['url'])) {
+ $limit = $limit - 23;
+ $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, $item['uid']);
+ }
+ }
+
+ $post['text'] = trim($msg);
+
+ return $post;
+ }
}