mirror of https://github.com/friendica/friendica
324 lines
9.6 KiB
PHP
324 lines
9.6 KiB
PHP
<?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\Core\Protocol;
|
|
use Friendica\DI;
|
|
use Friendica\Util\Network;
|
|
|
|
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(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 mb_substr(mb_substr(trim($msg), 0, $limit), 0, -3) . $ellipsis;
|
|
}
|
|
|
|
$lines = explode("\n", $msg);
|
|
$msg = "";
|
|
$recycle = html_entity_decode("♲ ", ENT_QUOTES, 'UTF-8');
|
|
foreach ($lines as $row => $line) {
|
|
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 = mb_substr(mb_substr(trim($msg . "\n" . $line), 0, $limit), 0, -3) . $ellipsis;
|
|
} else {
|
|
break;
|
|
}
|
|
}
|
|
|
|
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(array $item, int $limit = 0, bool $includedlinks = false, int $htmlmode = BBCode::MASTODON_API, string $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
|
|
$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'));
|
|
|
|
$complete_msg = $msg;
|
|
|
|
$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 + 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) && (mb_strlen($link) > self::URL_LENGTH) && ($htmlmode == BBCode::TWITTER)) {
|
|
$limit = $limit - self::URL_LENGTH + mb_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);
|
|
}
|
|
|
|
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 (mb_strlen($link) > 0) {
|
|
$limit = $limit - self::URL_LENGTH;
|
|
}
|
|
|
|
if (mb_strlen($msg) > $limit) {
|
|
if (($post['type'] == 'text') && isset($post['url'])) {
|
|
$post['url'] = $item['plink'];
|
|
} elseif (!isset($post['url'])) {
|
|
$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, $item['uid']);
|
|
}
|
|
}
|
|
|
|
$post['text'] = trim($msg);
|
|
|
|
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;
|
|
}
|
|
}
|