cuqmbr/rss-bridge
1
0
Fork 0
mirror of https://github.com/RSS-Bridge/rss-bridge.git synced 2025-04-09 16:38:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

[TwitterV2Bridge] Properly include quoted tweets (#2713)

Browse Source
This commit is contained in:
quickwick 2022-05-10 00:41:12 -07:00 committed by GitHub
parent 6547ed0c04
commit 9110b70f07
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 255 additions and 165 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

420
bridges/TwitterV2Bridge.php
View File

@ -124,8 +124,8 @@ EOD
) )
); );
private $apiToken = null; // $Item variable needs to be accessible from multiple functions without passing
private $authHeaders = array(); private $item = array();
public function getName() { public function getName() {
switch($this->queriedContext) { switch($this->queriedContext) {
@ -167,9 +167,9 @@ EOD
$onlyMediaTweets = $this->getInput('imgonly'); $onlyMediaTweets = $this->getInput('imgonly');
// Read API token from config.ini.php, put into Header // Read API token from config.ini.php, put into Header
$this->apiToken = $this->getOption('twitterv2apitoken'); $apiToken = $this->getOption('twitterv2apitoken');
$this->authHeaders = array( $authHeaders = array(
'authorization: Bearer ' . $this->apiToken, 'authorization: Bearer ' . $apiToken,
); );
// Try to get all tweets // Try to get all tweets
@ -180,7 +180,7 @@ EOD
'user.fields' => 'pinned_tweet_id,profile_image_url' 'user.fields' => 'pinned_tweet_id,profile_image_url'
); );
$user = $this->makeApiCall('/users/by/username/' $user = $this->makeApiCall('/users/by/username/'
. $this->getInput('u'), $params); . $this->getInput('u'), $authHeaders, $params);
if(isset($user->errors)) { if(isset($user->errors)) {
Debug::log('User JSON: ' . json_encode($user)); Debug::log('User JSON: ' . json_encode($user));
@ -209,7 +209,7 @@ EOD
// Get the tweets // Get the tweets
$data = $this->makeApiCall('/users/' . $user->data->id $data = $this->makeApiCall('/users/' . $user->data->id
. '/tweets', $params); . '/tweets', $authHeaders, $params);
break; break;
case 'By keyword or hashtag': case 'By keyword or hashtag':
@ -231,7 +231,7 @@ EOD
$params['query'] = $params['query'] . ' -is:retweet'; $params['query'] = $params['query'] . ' -is:retweet';
} }
$data = $this->makeApiCall('/tweets/search/recent', $params); $data = $this->makeApiCall('/tweets/search/recent', $authHeaders, $params);
break; break;
case 'By list ID': case 'By list ID':
@ -246,7 +246,7 @@ EOD
); );
$data = $this->makeApiCall('/lists/' . $this->getInput('listid') . $data = $this->makeApiCall('/lists/' . $this->getInput('listid') .
'/tweets', $params); '/tweets', $authHeaders, $params);
break; break;
default: default:
@ -291,13 +291,13 @@ EOD
$retweetedData = null; $retweetedData = null;
$retweetedMedia = null; $retweetedMedia = null;
$retweetedUsers = null; $retweetedUsers = null;
if(!$hideImages && !$hideRetweets && isset($includesTweets)) { if(!$hideImages && isset($includesTweets)) {
// There has to be a better PHP way to extract the tweet Ids? // There has to be a better PHP way to extract the tweet Ids?
$includesTweetsIds = array(); $includesTweetsIds = array();
foreach($includesTweets as $includesTweet) { foreach($includesTweets as $includesTweet) {
$includesTweetsIds[] = $includesTweet->id; $includesTweetsIds[] = $includesTweet->id;
} }
//Debug::log('includesTweetsIds: ' . join(',', $includesTweetsIds)); Debug::log('includesTweetsIds: ' . join(',', $includesTweetsIds));
// Set default params for API query // Set default params for API query
$params = array( $params = array(
@ -309,7 +309,7 @@ EOD
); );
// Get the retweeted tweets // Get the retweeted tweets
$retweetedData = $this->makeApiCall('/tweets', $params); $retweetedData = $this->makeApiCall('/tweets', $authHeaders, $params);
// Extract retweets Media data into array // Extract retweets Media data into array
isset($retweetedData->includes->media) ? $retweetedMedia isset($retweetedData->includes->media) ? $retweetedMedia
@ -329,16 +329,19 @@ EOD
continue; continue;
} }
// Check if Retweet or Reply // Check if tweet is Retweet, Quote or Reply
//$retweetTypes = array('retweeted', 'quoted');
$isRetweet = false; $isRetweet = false;
$isReply = false; $isReply = false;
$isQuote = false;
if(isset($tweet->referenced_tweets)) { if(isset($tweet->referenced_tweets)) {
//if(in_array($tweet->referenced_tweets[0]->type, $retweetTypes)) { switch($tweet->referenced_tweets[0]->type) {
if($tweet->referenced_tweets[0]->type === 'retweeted') { case 'retweeted':
$isRetweet = true; $isRetweet = true; break;
} elseif ($tweet->referenced_tweets[0]->type === 'replied_to') { case 'quoted':
$isReply = true; $isQuote = true; break;
case 'replied_to':
$isReply = true; break;
} }
} }
@ -351,17 +354,33 @@ EOD
$cleanedTweet = nl2br($tweet->text); $cleanedTweet = nl2br($tweet->text);
//Debug::log('cleanedTweet: ' . $cleanedTweet); //Debug::log('cleanedTweet: ' . $cleanedTweet);
// Perform filtering (skip tweets that don't contain desired word, if provided) // Perform optional keyword filtering (only keep tweet if keyword is found)
if (! empty($tweetFilter)) { if (! empty($tweetFilter)) {
if(stripos($cleanedTweet, $this->getInput('filter')) === false) { if(stripos($cleanedTweet, $this->getInput('filter')) === false) {
continue; continue;
} }
} }
// Initialize empty array to hold eventual HTML output // Initialize empty array to hold feed item values
$item = array(); $this->item = array();
// Start setting values needed for HTML output // Start getting and setting values needed for HTML output
$quotedTweet = null;
$cleanedQuotedTweet = null;
$quotedUser = null;
if ($isQuote) {
Debug::log('Tweet is quote');
foreach($includesTweets as $includesTweet) {
if($includesTweet->id === $tweet->referenced_tweets[0]->id) {
$quotedTweet = $includesTweet;
$cleanedQuotedTweet = nl2br($quotedTweet->text);
//Debug::log('Found quoted tweet');
break;
}
}
$quotedUser = $this->getTweetUser($quotedTweet, $retweetedUsers, $includesUsers);
}
if($isRetweet || is_null($user)) { if($isRetweet || is_null($user)) {
Debug::log('Tweet is retweet, or $user is null'); Debug::log('Tweet is retweet, or $user is null');
// Replace tweet object with original retweeted object // Replace tweet object with original retweeted object
@ -380,77 +399,45 @@ EOD
} }
// Get user object for retweeted tweet // Get user object for retweeted tweet
$originalUser = new stdClass(); // make the linters stop complaining $originalUser = $this->getTweetUser($tweet, $retweetedUsers, $includesUsers);
if(isset($retweetedUsers)) {
Debug::log('Searching for tweet author_id in $retweetedUsers');
foreach($retweetedUsers as $retweetedUser) {
if($retweetedUser->id === $tweet->author_id) {
$originalUser = $retweetedUser;
Debug::log('Found author_id match in $retweetedUsers');
break;
}
}
}
if(!isset($originalUser->username) && isset($includesUsers)) {
Debug::log('Searching for tweet author_id in $includesUsers');
foreach($includesUsers as $includesUser) {
if($includesUser->id === $tweet->author_id) {
$originalUser = $includesUser;
Debug::log('Found author_id match in $includesUsers');
break;
}
}
}
$item['username'] = $originalUser->username; $this->item['username'] = $originalUser->username;
$item['fullname'] = $originalUser->name; $this->item['fullname'] = $originalUser->name;
if(isset($originalUser->profile_image_url)) { if(isset($originalUser->profile_image_url)) {
$item['avatar'] = $originalUser->profile_image_url; $this->item['avatar'] = $originalUser->profile_image_url;
} else{ } else{
$item['avatar'] = null; $this->item['avatar'] = null;
} }
} else{ } else{
$item['username'] = $user->data->username; $this->item['username'] = $user->data->username;
$item['fullname'] = $user->data->name; $this->item['fullname'] = $user->data->name;
$item['avatar'] = $user->data->profile_image_url; $this->item['avatar'] = $user->data->profile_image_url;
} }
$item['id'] = $tweet->id; $this->item['id'] = $tweet->id;
$item['timestamp'] = $tweet->created_at; $this->item['timestamp'] = $tweet->created_at;
$item['uri'] $this->item['uri']
= self::URI . $item['username'] . '/status/' . $item['id']; = self::URI . $this->item['username'] . '/status/' . $this->item['id'];
$item['author'] = ($isRetweet ? 'RT: ' : '' ) $this->item['author'] = ($isRetweet ? 'RT: ' : '' )
. $item['fullname'] . $this->item['fullname']
. ' (@' . ' (@'
. $item['username'] . ')'; . $this->item['username'] . ')';
// Skip non-media tweet (if selected) // (Optional) Skip non-media tweet
// This check must wait until after retweets are identified // This check must wait until after retweets are identified
if ($onlyMediaTweets && !isset($tweet->attachments->media_keys)) { if ($onlyMediaTweets && !isset($tweet->attachments->media_keys) &&
continue; (($isQuote && !isset($quotedTweet->attachments->media_keys)) || !$isQuote)) {
// There is no media in current tweet or quoted tweet, skip to next
continue;
} }
// Search for and replace URLs in Tweet text // Search for and replace URLs in Tweet text
$foundUrls = false; $cleanedTweet = $this->replaceTweetURLs($tweet, $cleanedTweet);
if(isset($tweet->entities->urls)) { if (isset($cleanedQuotedTweet)) {
foreach($tweet->entities->urls as $url) { Debug::log('Replacing URLs in Quoted Tweet text');
$cleanedTweet = str_replace($url->url, $cleanedQuotedTweet = $this->replaceTweetURLs($quotedTweet, $cleanedQuotedTweet);
'<a href="' . $url->expanded_url
. '">' . $url->display_url . '</a>',
$cleanedTweet);
$foundUrls = true;
}
}
if($foundUrls === false) {
// fallback to regex'es
$reg_ex = '/(http|https|ftp|ftps)\:\/\/[a-zA-Z0-9\-\.]+\.[a-zA-Z]{2,3}(\/\S*)?/';
if(preg_match($reg_ex, $cleanedTweet, $url)) {
$cleanedTweet = preg_replace($reg_ex,
"<a href='{$url[0]}' target='_blank'>{$url[0]}</a> ",
$cleanedTweet);
}
} }
// generate the title // Generate Title text
if ($idAsTitle) { if ($idAsTitle) {
$titleText = $tweet->id; $titleText = $tweet->id;
} else{ } else{
@ -463,99 +450,38 @@ EOD
$titleText = 'R: ' . $titleText; $titleText = 'R: ' . $titleText;
} }
$item['title'] = $titleText; $this->item['title'] = $titleText;
// Add avatar // Generate Avatar HTML block
$picture_html = ''; $picture_html = '';
if(!$hideProfilePic && isset($item['avatar'])) { if(!$hideProfilePic && isset($this->item['avatar'])) {
$picture_html = <<<EOD $picture_html = <<<EOD
<a href="https://twitter.com/{$item['username']}"> <a href="https://twitter.com/{$this->item['username']}">
<img <img
style="margin-right: 10px; margin-bottom: 10px;" style="margin-right: 10px; margin-bottom: 10px;"
alt="{$item['username']}" alt="{$this->item['username']}"
src="{$item['avatar']}" src="{$this->item['avatar']}"
title="{$item['fullname']}" /> title="{$this->item['fullname']}" />
</a> </a>
EOD; EOD;
} }
// Get images // Generate media HTML block
$media_html = ''; $media_html = '';
if(!$hideImages && isset($tweet->attachments->media_keys)) { $quoted_media_html = '';
if(!$hideImages) {
// Match media_keys in tweet to media list from, put matches if (isset($tweet->attachments->media_keys)) {
// into new array Debug::log('Generating HTML for tweet media');
$tweetMedia = array(); $media_html = $this->createTweetMediaHTML($tweet, $includesMedia, $retweetedMedia);
// Start by checking the original list of tweet Media includes
if(isset($includesMedia)) {
foreach($includesMedia as $includesMedium) {
if(in_array ($includesMedium->media_key,
$tweet->attachments->media_keys)) {
$tweetMedia[] = $includesMedium;
}
}
} }
// If no matches found, check the retweet Media includes if (isset($quotedTweet->attachments->media_keys)) {
if(empty($tweetMedia) && isset($retweetedMedia)) { Debug::log('Generating HTML for quoted tweet media');
foreach($retweetedMedia as $retweetedMedium) { $quoted_media_html = $this->createTweetMediaHTML($quotedTweet, $includesMedia, $retweetedMedia);
if(in_array ($retweetedMedium->media_key,
$tweet->attachments->media_keys)) {
$tweetMedia[] = $retweetedMedium;
}
}
}
foreach($tweetMedia as $media) {
switch($media->type) {
case 'photo':
if ($this->getInput('noimgscaling')) {
$image = $media->url;
$display_image = $media->url;
} else{
$image = $media->url . '?name=orig';
$display_image = $media->url;
}
// add enclosures
$item['enclosures'][] = $image;
$media_html .= <<<EOD
<a href="{$image}">
<img
referrerpolicy="no-referrer"
src="{$display_image}" />
</a>
EOD;
break;
case 'video':
// To Do: Is there a way to easily match this
// to a URL for a link?
$display_image = $media->preview_image_url;
$media_html .= <<<EOD
<img
referrerpolicy="no-referrer"
src="{$display_image}" />
EOD;
break;
case 'animated_gif':
// To Do: Is there a way to easily match this to a
// URL for a link?
$display_image = $media->preview_image_url;
$media_html .= <<<EOD
<img
referrerpolicy="no-referrer"
src="{$display_image}" />
EOD;
break;
default:
Debug::log('Missing support for media type: '
. $media->type);
}
} }
} }
$item['content'] = <<<EOD // Generate the HTML for Item content
$this->item['content'] = <<<EOD
<div style="float: left;"> <div style="float: left;">
{$picture_html} {$picture_html}
</div> </div>
@ -564,13 +490,27 @@ EOD;
</div> </div>
<div style="display: block; margin-top: 16px;"> <div style="display: block; margin-top: 16px;">
{$media_html} {$media_html}
</div>
EOD; EOD;
$item['content'] = htmlspecialchars_decode($item['content'], ENT_QUOTES); // Add Quoted Tweet HTML, if relevant
if (isset($quotedTweet)) {
$quotedTweetURI = self::URI . $quotedUser->username . '/status/' . $quotedTweet->id;
$quote_html = <<<QUOTE
<div style="display: table; border-style: solid; border-width: 1px;
border-radius: 5px; padding: 5px;">
<p><b>$quotedUser->name</b> @$quotedUser->username ·
<a href="$quotedTweetURI">$quotedTweet->created_at</a></p>
$cleanedQuotedTweet
$quoted_media_html
</div>
QUOTE;
$this->item['content'] .= $quote_html;
}
// put out item $this->item['content'] = htmlspecialchars_decode($this->item['content'], ENT_QUOTES);
$this->items[] = $item;
// Add current Item to Items array
$this->items[] = $this->item;
} }
// Sort all tweets in array by date // Sort all tweets in array by date
@ -587,10 +527,160 @@ EOD;
* @param $params array additional URI parmaeters * @param $params array additional URI parmaeters
* @return object json data * @return object json data
*/ */
private function makeApiCall($api, $params) { private function makeApiCall($api, $authHeaders, $params) {
$uri = self::API_URI . $api . '?' . http_build_query($params); $uri = self::API_URI . $api . '?' . http_build_query($params);
$result = getContents($uri, $this->authHeaders, array(), false); $result = getContents($uri, $authHeaders, array(), false);
$data = json_decode($result); $data = json_decode($result);
return $data; return $data;
} }
/**
* Change format of URLs in tweet text
* @param $tweetObject object current Tweet JSON
* @param $tweetText string current Tweet text
* @return string modified tweet text
*/
private function replaceTweetURLs($tweetObject, $tweetText) {
$foundUrls = false;
// Rewrite URL links, based on URL list in tweet object
if(isset($tweetObject->entities->urls)) {
foreach($tweetObject->entities->urls as $url) {
$tweetText = str_replace($url->url,
'<a href="' . $url->expanded_url
. '">' . $url->display_url . '</a>',
$tweetText);
}
$foundUrls = true;
}
// Regex fallback for rewriting URL links. Should never trigger?
if($foundUrls === false) {
$reg_ex = '/(http|https|ftp|ftps)\:\/\/[a-zA-Z0-9\-\.]+\.[a-zA-Z]{2,3}(\/\S*)?/';
if(preg_match($reg_ex, $tweetText, $url)) {
$tweetText = preg_replace($reg_ex,
"<a href='{$url[0]}' target='_blank'>{$url[0]}</a> ",
$tweetText);
}
}
// Fix back-to-back URLs by adding a <br>
$reg_ex = '/\/a>\s*<a/';
$tweetText = preg_replace($reg_ex, '/a><br><a', $tweetText);
return $tweetText;
}
/**
* Find User object for Retweeted/Quoted tweet
* @param $tweetObject object current Tweet JSON
* @param $retweetedUsers
* @param $includesUsers
* @return object found User
*/
private function getTweetUser($tweetObject, $retweetedUsers, $includesUsers) {
$originalUser = new stdClass(); // make the linters stop complaining
if(isset($retweetedUsers)) {
Debug::log('Searching for tweet author_id in $retweetedUsers');
foreach($retweetedUsers as $retweetedUser) {
if($retweetedUser->id === $tweetObject->author_id) {
$matchedUser = $retweetedUser;
Debug::log('Found author_id match in $retweetedUsers');
break;
}
}
}
if(!isset($matchedUser->username) && isset($includesUsers)) {
Debug::log('Searching for tweet author_id in $includesUsers');
foreach($includesUsers as $includesUser) {
if($includesUser->id === $tweetObject->author_id) {
$matchedUser = $includesUser;
Debug::log('Found author_id match in $includesUsers');
break;
}
}
}
return $matchedUser;
}
/**
* Generates HTML for embedded media
* @param $tweetObject object current Tweet JSON
* @param $includesMedia
* @param $retweetedMedia
* @return string modified tweet text
*/
private function createTweetMediaHTML($tweetObject, $includesMedia, $retweetedMedia){
$media_html = '';
// Match media_keys in tweet to media list from, put matches into new array
$tweetMedia = array();
// Start by checking the original list of tweet Media includes
if(isset($includesMedia)) {
Debug::log('Searching for media_key in $includesMedia');
foreach($includesMedia as $includesMedium) {
if(in_array ($includesMedium->media_key,
$tweetObject->attachments->media_keys)) {
Debug::log('Found media_key in $includesMedia');
$tweetMedia[] = $includesMedium;
}
}
}
// If no matches found, check the retweet Media includes
if(empty($tweetMedia) && isset($retweetedMedia)) {
Debug::log('Searching for media_key in $retweetedMedia');
foreach($retweetedMedia as $retweetedMedium) {
if(in_array ($retweetedMedium->media_key,
$tweetObject->attachments->media_keys)) {
Debug::log('Found media_key in $retweetedMedia');
$tweetMedia[] = $retweetedMedium;
}
}
}
foreach($tweetMedia as $media) {
switch($media->type) {
case 'photo':
if ($this->getInput('noimgscaling')) {
$image = $media->url;
$display_image = $media->url;
} else{
$image = $media->url . '?name=orig';
$display_image = $media->url;
}
// add enclosures
$this->item['enclosures'][] = $image;
$media_html .= <<<EOD
<a href="{$image}">
<img
referrerpolicy="no-referrer"
src="{$display_image}" />
</a>
EOD;
break;
case 'video':
// To Do: Is there a way to easily match this
// to a direct Video URL?
$display_image = $media->preview_image_url;
$media_html .= <<<EOD
<p>Video:</p><a href="{$this->item['uri']}">
<img referrerpolicy="no-referrer" src="{$display_image}" /></a>
EOD;
break;
case 'animated_gif':
// To Do: Is there a way to easily match this to a
// direct animated Gif URL?
$display_image = $media->preview_image_url;
$media_html .= <<<EOD
<p>Animated Gif:</p><a href="{$this->item['uri']}">
<img referrerpolicy="no-referrer" src="{$display_image}" /></a>
EOD;
break;
default:
Debug::log('Missing support for media type: '
. $media->type);
}
}
return $media_html;
}
} }