Rework BBCode::convertShare to accept a callback function

- Create default convertShare callback from previous code
- Remove $simplehtml = 8 case (moved to Twitter addon)
This commit is contained in:
Hypolite Petovan 2018-10-17 01:13:18 -04:00
parent 45748da8a1
commit 9239ecc5e0
1 changed files with 97 additions and 146 deletions

View File

@ -859,187 +859,136 @@ class BBCode extends BaseObject
} }
/** /**
* Processes [share] tags * This function converts a [share] block to text according to a provided callback function whose signature is:
*
* function(array $attributes, array $author_contact, string $content): string
*
* Where:
* - $attributes is an array of attributes of the [share] block itself. Missing keys will be completed by the contact
* data lookup
* - $author_contact is a contact record array
* - $content is the inner content of the [share] block
* - Return value is the string that should replace the [share] block in the provided text
*
* This function is intended to be used by addon connector to format a share block like the target network is expecting it.
*
* @param string $text A BBCode string
* @param callable $callback
* @return string The BBCode string with all [share] blocks replaced
*/
public static function convertShare($text, callable $callback)
{
$return = preg_replace_callback(
"/\[share(.*?)\](.*?)\[\/share\]/ism",
function ($match) use ($callback) {
$attribute_string = $match[1];
$attributes = [];
foreach(['author', 'profile', 'avatar', 'link', 'posted'] as $field) {
preg_match("/$field=(['\"])(.+?)\\1/ism", $attribute_string, $matches);
$attributes[$field] = html_entity_decode(defaults($matches, 2, ''), ENT_QUOTES, 'UTF-8');
}
// We only call this so that a previously unknown contact can be added.
// This is important for the function "Model\Contact::getDetailsByURL()".
// This function then can fetch an entry from the contact table.
Contact::getIdForURL($attributes['profile'], 0, true);
$author_contact = Contact::getDetailsByURL($attributes['profile']);
$author_contact['addr'] = defaults($author_contact, 'addr' , Protocol::getAddrFromProfileUrl($attributes['profile']));
$attributes['author'] = defaults($author_contact, 'name' , $attributes['author']);
$attributes['avatar'] = defaults($author_contact, 'micro', $attributes['avatar']);
$attributes['profile'] = defaults($author_contact, 'url' , $attributes['profile']);
if ($attributes['avatar']) {
$attributes['avatar'] = ProxyUtils::proxifyUrl($attributes['avatar'], false, ProxyUtils::SIZE_THUMB);
}
return $callback($attributes, $author_contact, $match[2]);
},
$text
);
return $return;
}
/**
* Default [share] tag conversion callback
* *
* Note: Can produce a [bookmark] tag in the output * Note: Can produce a [bookmark] tag in the output
* *
* @brief Processes [share] tags * @see BBCode::convertShare()
* @param array $share preg_match_callback result array * @param array $attributes [share] block attribute values
* @param bool|int $simplehtml * @param array $author_contact Contact row of the shared author
* @param string $content Inner content of the [share] block
* @param integer $simplehtml Mysterious integer value depending on the target network/formatting style
* @return string * @return string
*/ */
private static function convertShare($share, $simplehtml) private static function convertShareCallback(array $attributes, array $author_contact, $content, $simplehtml)
{ {
$attributes = $share[2]; $mention = Protocol::formatMention($attributes['profile'], $attributes['author']);
$author = "";
preg_match("/author='(.*?)'/ism", $attributes, $matches);
if (x($matches, 1)) {
$author = html_entity_decode($matches[1], ENT_QUOTES, 'UTF-8');
}
preg_match('/author="(.*?)"/ism', $attributes, $matches);
if (x($matches, 1)) {
$author = $matches[1];
}
$profile = "";
preg_match("/profile='(.*?)'/ism", $attributes, $matches);
if (x($matches, 1)) {
$profile = $matches[1];
}
preg_match('/profile="(.*?)"/ism', $attributes, $matches);
if (x($matches, 1)) {
$profile = $matches[1];
}
$avatar = "";
preg_match("/avatar='(.*?)'/ism", $attributes, $matches);
if (x($matches, 1)) {
$avatar = $matches[1];
}
preg_match('/avatar="(.*?)"/ism', $attributes, $matches);
if (x($matches, 1)) {
$avatar = $matches[1];
}
$link = "";
preg_match("/link='(.*?)'/ism", $attributes, $matches);
if (x($matches, 1)) {
$link = $matches[1];
}
preg_match('/link="(.*?)"/ism', $attributes, $matches);
if (x($matches, 1)) {
$link = $matches[1];
}
$posted = "";
preg_match("/posted='(.*?)'/ism", $attributes, $matches);
if (x($matches, 1)) {
$posted = $matches[1];
}
preg_match('/posted="(.*?)"/ism', $attributes, $matches);
if (x($matches, 1)) {
$posted = $matches[1];
}
// We only call this so that a previously unknown contact can be added.
// This is important for the function "Model\Contact::getDetailsByURL()".
// This function then can fetch an entry from the contact table.
Contact::getIdForURL($profile, 0, true);
$data = Contact::getDetailsByURL($profile);
if (x($data, "name") && x($data, "addr")) {
$userid_compact = $data["name"] . " (" . $data["addr"] . ")";
} else {
$userid_compact = Protocol::getAddrFromProfileUrl($profile, $author);
}
if (x($data, "addr")) {
$userid = $data["addr"];
} else {
$userid = Protocol::formatMention($profile, $author);
}
if (x($data, "name")) {
$author = $data["name"];
}
if (x($data, "micro")) {
$avatar = $data["micro"];
}
$preshare = trim($share[1]);
if ($preshare != "") {
$preshare .= "<br />";
}
switch ($simplehtml) { switch ($simplehtml) {
case 1: case 1:
$text = $preshare . html_entity_decode("&#x2672; ", ENT_QUOTES, 'UTF-8') . ' <a href="' . $profile . '">' . $userid . "</a>: <br />»" . $share[3] . "«"; $text = '<p>' . html_entity_decode('&#x2672; ', ENT_QUOTES, 'UTF-8') . ' <a href="' . $attributes['profile'] . '">' . $mention . '</a>: </p>' . "\n" . '«' . $content . '»';
break; break;
case 2: case 2:
$text = $preshare . html_entity_decode("&#x2672; ", ENT_QUOTES, 'UTF-8') . ' ' . $userid_compact . ": <br />" . $share[3]; $text = '<p>' . html_entity_decode('&#x2672; ', ENT_QUOTES, 'UTF-8') . ' ' . $author_contact['addr'] . ': </p>' . "\n" . $content;
break; break;
case 3: // Diaspora case 3: // Diaspora
$headline = '<b>' . html_entity_decode("&#x2672; ", ENT_QUOTES, 'UTF-8') . $userid . ':</b><br />'; $headline = '<p><b>' . html_entity_decode('&#x2672; ', ENT_QUOTES, 'UTF-8') . $mention . ':</b></p>' . "\n";
$text = trim($share[1]); if (stripos(normalise_link($attributes['link']), 'http://twitter.com/') === 0) {
$text = '<p><a href="' . $attributes['link'] . '">' . $attributes['link'] . '</a></p>' . "\n";
if ($text != "") {
$text .= "<hr />";
}
if (stripos(normalise_link($link), 'http://twitter.com/') === 0) {
$text .= '<br /><a href="' . $link . '">' . $link . '</a>';
} else { } else {
$text .= $headline . '<blockquote>' . trim($share[3]) . "</blockquote><br />"; $text = $headline . '<blockquote>' . trim($content) . '</blockquote>' . "\n";
if ($link != "") { if ($attributes['link'] != '') {
$text .= '<br /><a href="' . $link . '">[l]</a>'; $text .= '<p><a href="' . $attributes['link'] . '">[l]</a></p>' . "\n";
} }
} }
break; break;
case 4: case 4:
$headline = '<br /><b>' . html_entity_decode("&#x2672; ", ENT_QUOTES, 'UTF-8'); $headline = '<p><b>' . html_entity_decode('&#x2672; ', ENT_QUOTES, 'UTF-8');
$headline .= L10n::t('<a href="%1$s" target="_blank">%2$s</a> %3$s', $link, $userid, $posted); $headline .= L10n::t('<a href="%1$s" target="_blank">%2$s</a> %3$s', $attributes['link'], $mention, $attributes['posted']);
$headline .= ":</b><br />"; $headline .= ':</b></p>' . "\n";
$text = trim($share[1]); $text = $headline . '<blockquote class="shared_content">' . trim($content) . '</blockquote>' . "\n";
if ($text != "") {
$text .= "<hr />";
}
$text .= $headline . '<blockquote class="shared_content">' . trim($share[3]) . "</blockquote><br />";
break; break;
case 5: case 5:
$text = $preshare . html_entity_decode("&#x2672; ", ENT_QUOTES, 'UTF-8') . ' ' . $userid_compact . ": <br />" . $share[3]; $text = '<p>' . html_entity_decode('&#x2672; ', ENT_QUOTES, 'UTF-8') . ' ' . $author_contact['addr'] . ': </p>' . "\n" . $content;
break; break;
case 7: // statusnet/GNU Social case 7: // statusnet/GNU Social
$text = $preshare . html_entity_decode("&#x2672; ", ENT_QUOTES, 'UTF-8') . " @" . $userid_compact . ": " . $share[3]; $text = '<p>' . html_entity_decode('&#x2672; ', ENT_QUOTES, 'UTF-8') . ' @' . $author_contact['addr'] . ': ' . $content . '</p>' . "\n";
break;
case 8: // twitter
$text = $preshare . "RT @" . $userid_compact . ": " . $share[3];
break; break;
case 9: // Google+ case 9: // Google+
$text = $preshare . html_entity_decode("&#x2672; ", ENT_QUOTES, 'UTF-8') . ' ' . $userid_compact . ": <br />" . $share[3]; $text = '<p>' . html_entity_decode('&#x2672; ', ENT_QUOTES, 'UTF-8') . ' ' . $author_contact['addr'] . ': </p>' . "\n";
$text .= '<p>' . $content . '</p>' . "\n";
if ($link != "") { if ($attributes['link'] != '') {
$text .= "<br /><br />" . $link; $text .= '<p>' . $attributes['link'] . '</p>';
} }
break; break;
default: default:
// Transforms quoted tweets in rich attachments to avoid nested tweets // Transforms quoted tweets in rich attachments to avoid nested tweets
if (stripos(normalise_link($link), 'http://twitter.com/') === 0 && OEmbed::isAllowedURL($link)) { if (stripos(normalise_link($attributes['link']), 'http://twitter.com/') === 0 && OEmbed::isAllowedURL($attributes['link'])) {
try { try {
$oembed = OEmbed::getHTML($link, $preshare); $text = OEmbed::getHTML($attributes['link']);
} catch (Exception $e) { } catch (Exception $e) {
$oembed = sprintf('[bookmark=%s]%s[/bookmark]', $link, $preshare); $text = sprintf('[bookmark=%s]%s[/bookmark]', $attributes['link'], $content);
} }
$text = $preshare . $oembed;
} else { } else {
$text = trim($share[1]) . "\n";
$avatar = ProxyUtils::proxifyUrl($avatar, false, ProxyUtils::SIZE_THUMB);
$tpl = get_markup_template('shared_content.tpl'); $tpl = get_markup_template('shared_content.tpl');
$text .= replace_macros($tpl, [ $text = replace_macros($tpl, [
'$profile' => $profile, '$profile' => $attributes['profile'],
'$avatar' => $avatar, '$avatar' => $attributes['avatar'],
'$author' => $author, '$author' => $attributes['author'],
'$link' => $link, '$link' => $attributes['link'],
'$posted' => $posted, '$posted' => $attributes['posted'],
'$content' => trim($share[3]) '$content' => trim($content)
]); ]);
} }
break; break;
@ -1621,10 +1570,12 @@ class BBCode extends BaseObject
$text = preg_replace("/\[zmg\](.*?)\[\/zmg\]/ism", '<img src="$1" alt="' . L10n::t('Image/photo') . '" />', $text); $text = preg_replace("/\[zmg\](.*?)\[\/zmg\]/ism", '<img src="$1" alt="' . L10n::t('Image/photo') . '" />', $text);
// Shared content // Shared content
$text = preg_replace_callback("/(.*?)\[share(.*?)\](.*?)\[\/share\]/ism", $text = self::convertShare(
function ($match) use ($simple_html) { $text,
return self::convertShare($match, $simple_html); function (array $attributes, array $author_contact, string $content) use ($simple_html) {
}, $text); return self::convertShareCallback($attributes, $author_contact, $content, $simple_html);
}
);
$text = preg_replace("/\[crypt\](.*?)\[\/crypt\]/ism", '<br/><img src="' .System::baseUrl() . '/images/lock_icon.gif" alt="' . L10n::t('Encrypted content') . '" title="' . L10n::t('Encrypted content') . '" /><br />', $text); $text = preg_replace("/\[crypt\](.*?)\[\/crypt\]/ism", '<br/><img src="' .System::baseUrl() . '/images/lock_icon.gif" alt="' . L10n::t('Encrypted content') . '" title="' . L10n::t('Encrypted content') . '" /><br />', $text);
$text = preg_replace("/\[crypt(.*?)\](.*?)\[\/crypt\]/ism", '<br/><img src="' .System::baseUrl() . '/images/lock_icon.gif" alt="' . L10n::t('Encrypted content') . '" title="' . '$1' . ' ' . L10n::t('Encrypted content') . '" /><br />', $text); $text = preg_replace("/\[crypt(.*?)\](.*?)\[\/crypt\]/ism", '<br/><img src="' .System::baseUrl() . '/images/lock_icon.gif" alt="' . L10n::t('Encrypted content') . '" title="' . '$1' . ' ' . L10n::t('Encrypted content') . '" /><br />', $text);