Initial Upload
This commit is contained in:
Matt Batchelder
202
lib/Widget/MastodonProvider.php
Normal file
202
lib/Widget/MastodonProvider.php
Normal file
@@ -0,0 +1,202 @@
|
||||
<?php
|
||||
/*
|
||||
* Copyright (C) 2023 Xibo Signage Ltd
|
||||
*
|
||||
* Xibo - Digital Signage - https://xibosignage.com
|
||||
*
|
||||
* This file is part of Xibo.
|
||||
*
|
||||
* Xibo 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
|
||||
* any later version.
|
||||
*
|
||||
* Xibo 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 Xibo. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
namespace Xibo\Widget;
|
||||
|
||||
use Carbon\Carbon;
|
||||
use GuzzleHttp\Client;
|
||||
use GuzzleHttp\Exception\GuzzleException;
|
||||
use GuzzleHttp\Exception\RequestException;
|
||||
use Xibo\Widget\DataType\SocialMedia;
|
||||
use Xibo\Widget\Provider\DataProviderInterface;
|
||||
use Xibo\Widget\Provider\DurationProviderNumItemsTrait;
|
||||
use Xibo\Widget\Provider\WidgetProviderInterface;
|
||||
use Xibo\Widget\Provider\WidgetProviderTrait;
|
||||
|
||||
/**
|
||||
* Downloads a Mastodon feed and returns SocialMedia data types
|
||||
*/
|
||||
class MastodonProvider implements WidgetProviderInterface
|
||||
{
|
||||
use WidgetProviderTrait;
|
||||
use DurationProviderNumItemsTrait;
|
||||
|
||||
public function fetchData(DataProviderInterface $dataProvider): WidgetProviderInterface
|
||||
{
|
||||
$uri = $dataProvider->getSetting('defaultServerUrl', 'https://mastodon.social');
|
||||
|
||||
try {
|
||||
$httpOptions = [
|
||||
'timeout' => 20, // wait no more than 20 seconds
|
||||
];
|
||||
|
||||
$queryOptions = [
|
||||
'limit' => $dataProvider->getProperty('numItems', 15)
|
||||
];
|
||||
|
||||
if ($dataProvider->getProperty('searchOn', 'all') === 'local') {
|
||||
$queryOptions['local'] = true;
|
||||
} elseif ($dataProvider->getProperty('searchOn', 'all') === 'remote') {
|
||||
$queryOptions['remote'] = true;
|
||||
}
|
||||
|
||||
// Media Only
|
||||
if ($dataProvider->getProperty('onlyMedia', 0)) {
|
||||
$queryOptions['only_media'] = true;
|
||||
}
|
||||
|
||||
if (!empty($dataProvider->getProperty('serverUrl', ''))) {
|
||||
$uri = $dataProvider->getProperty('serverUrl');
|
||||
}
|
||||
|
||||
// Hashtag
|
||||
$hashtag = trim($dataProvider->getProperty('hashtag', ''));
|
||||
|
||||
// when username is provided do not search in public timeline
|
||||
if (!empty($dataProvider->getProperty('userName', ''))) {
|
||||
// username search: get account ID, always returns one record
|
||||
$accountId = $this->getAccountId($uri, $dataProvider->getProperty('userName'), $dataProvider);
|
||||
$queryOptions['tagged'] = trim($hashtag, '#');
|
||||
$queryOptions['exclude_replies'] = true; // exclude replies to other users
|
||||
$queryOptions['exclude_reblogs'] = true; // exclude reposts/boosts
|
||||
$uri = rtrim($uri, '/') . '/api/v1/accounts/' . $accountId . '/statuses?';
|
||||
} else {
|
||||
// Hashtag: When empty we should do a public search, when filled we should do a hashtag search
|
||||
if (!empty($hashtag)) {
|
||||
$uri = rtrim($uri, '/') . '/api/v1/timelines/tag/' . trim($hashtag, '#');
|
||||
} else {
|
||||
$uri = rtrim($uri, '/') . '/api/v1/timelines/public';
|
||||
}
|
||||
}
|
||||
|
||||
$response = $dataProvider
|
||||
->getGuzzleClient($httpOptions)
|
||||
->get($uri, [
|
||||
'query' => $queryOptions
|
||||
]);
|
||||
|
||||
$result = json_decode($response->getBody()->getContents(), true);
|
||||
|
||||
$this->getLog()->debug('Mastodon: uri: ' . $uri . ' httpOptions: ' . json_encode($httpOptions));
|
||||
|
||||
$this->getLog()->debug('Mastodon: count: ' . count($result));
|
||||
|
||||
// Expiry time for any media that is downloaded
|
||||
$expires = Carbon::now()->addHours($dataProvider->getSetting('cachePeriodImages', 24))->format('U');
|
||||
|
||||
foreach ($result as $item) {
|
||||
// Parse the mastodon
|
||||
$mastodon = new SocialMedia();
|
||||
|
||||
$mastodon->text = strip_tags($item['content']);
|
||||
$mastodon->user = $item['account']['acct'];
|
||||
$mastodon->screenName = $item['account']['display_name'];
|
||||
$mastodon->date = $item['created_at'];
|
||||
|
||||
// Original Default Image
|
||||
$mastodon->userProfileImage = $dataProvider->addImage(
|
||||
'mastodon_' . $item['account']['id'],
|
||||
$item['account']['avatar'],
|
||||
$expires
|
||||
);
|
||||
|
||||
// Mini image
|
||||
$mastodon->userProfileImageMini = $mastodon->userProfileImage;
|
||||
|
||||
// Bigger image
|
||||
$mastodon->userProfileImageBigger = $mastodon->userProfileImage;
|
||||
|
||||
|
||||
// Photo
|
||||
// See if there are any photos associated with this status.
|
||||
if ((isset($item['media_attachments']) && count($item['media_attachments']) > 0)) {
|
||||
// only take the first one
|
||||
$mediaObject = $item['media_attachments'][0];
|
||||
|
||||
$photoUrl = $mediaObject['preview_url'];
|
||||
if (!empty($photoUrl)) {
|
||||
$mastodon->photo = $dataProvider->addImage(
|
||||
'mastodon_' . $mediaObject['id'],
|
||||
$photoUrl,
|
||||
$expires
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
// Add the mastodon topic.
|
||||
$dataProvider->addItem($mastodon);
|
||||
}
|
||||
|
||||
// If we've got data, then set our cache period.
|
||||
$dataProvider->setCacheTtl($dataProvider->getSetting('cachePeriod', 3600));
|
||||
$dataProvider->setIsHandled();
|
||||
} catch (RequestException $requestException) {
|
||||
// Log and return empty?
|
||||
$this->getLog()->error('Mastodon: Unable to get posts: ' . $uri
|
||||
. ', e: ' . $requestException->getMessage());
|
||||
$dataProvider->addError(__('Unable to download posts'));
|
||||
} catch (\Exception $exception) {
|
||||
// Log and return empty?
|
||||
$this->getLog()->error('Mastodon: ' . $exception->getMessage());
|
||||
$this->getLog()->debug($exception->getTraceAsString());
|
||||
$dataProvider->addError(__('Unknown issue getting posts'));
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function getDataCacheKey(DataProviderInterface $dataProvider): ?string
|
||||
{
|
||||
// No special cache key requirements.
|
||||
return null;
|
||||
}
|
||||
|
||||
public function getDataModifiedDt(DataProviderInterface $dataProvider): ?Carbon
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Mastodon Account Id from username
|
||||
* @throws GuzzleException
|
||||
*/
|
||||
private function getAccountId(string $uri, string $username, DataProviderInterface $dataProvider)
|
||||
{
|
||||
$uri = rtrim($uri, '/').'/api/v1/accounts/lookup?';
|
||||
|
||||
$httpOptions = [
|
||||
'timeout' => 20, // wait no more than 20 seconds
|
||||
'query' => [
|
||||
'acct' => $username
|
||||
],
|
||||
];
|
||||
$response = $dataProvider
|
||||
->getGuzzleClient($httpOptions)
|
||||
->get($uri);
|
||||
|
||||
$result = json_decode($response->getBody()->getContents(), true);
|
||||
|
||||
$this->getLog()->debug('Mastodon: getAccountId: ID ' . $result['id']);
|
||||
|
||||
return $result['id'];
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user