Mastodon username search

cypress/e2e/layout_dataset.cy.js

@@ -57,10 +57,7 @@ describe('Layout Designer', function() {
     cy.get('.select2-container--open').contains('test');
     cy.get('.select2-container--open .select2-results > ul > li').should('have.length', 1);
     cy.get('.select2-container--open .select2-results > ul > li:first').contains('test').click();
-
-    cy.get('[contenteditable="true" ]').should('exist');
-    cy.get('.cke_editable_inline').clear();
-    cy.get('.cke_editable_inline').type('No data to show').trigger('change');
+
     cy.get('[name="lowerLimit"]').clear().type('1');
     cy.get('[name="upperLimit"]').clear().type('10');
     cy.get('.order-clause-row > :nth-child(2) > .form-control').select('Text', {force: true});

lib/Widget/MastodonProvider.php

@@ -23,6 +23,8 @@
 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;
@@ -62,24 +64,35 @@ public function fetchData(DataProviderInterface $dataProvider): WidgetProviderIn
             }
 
             if (!empty($dataProvider->getProperty('serverUrl', ''))) {
-                $uri = $dataProvider->getProperty('serverUrl', '');
+                $uri = $dataProvider->getProperty('serverUrl');
             }
 
-            // Hashtag: When empty we should do a public search, when filled we should do a hashtag search
+            // Hashtag
             $hashtag = trim($dataProvider->getProperty('hashtag', ''));
-            if (!empty($hashtag)) {
-                $uri = rtrim($uri, '/').'/api/v1/timelines/tag/'. trim($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);
+                $httpOptions['query']['tagged'] = trim($hashtag, '#');
+                ;
+                $result = $this->getResult($uri, $accountId, $httpOptions);
             } else {
-                $uri = rtrim($uri, '/').'/api/v1/timelines/public';
-            }
+                // 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';
+                }
 
-            $this->getLog()->debug('Mastodon: uri: ' . $uri . ' httpOptions: '. json_encode($httpOptions));
+                $response = $dataProvider
+                    ->getGuzzleClient($httpOptions)
+                    ->get($uri);
 
-            $response = $dataProvider
-                ->getGuzzleClient($httpOptions)
-                ->get($uri);
+                $result = json_decode($response->getBody()->getContents(), true);
+            }
 
-            $result = json_decode($response->getBody()->getContents(), true);
+            $this->getLog()->debug('Mastodon: uri: ' . $uri . ' httpOptions: ' . json_encode($httpOptions));
 
             $this->getLog()->debug('Mastodon: count: ' . count($result));
 
@@ -157,4 +170,45 @@ public function getDataModifiedDt(DataProviderInterface $dataProvider): ?Carbon
     {
         return null;
     }
+
+    /**
+     * Get Mastodon Account Id from username
+     * @throws GuzzleException
+     */
+    private function getAccountId(mixed $uri, DataProviderInterface $dataProvider)
+    {
+        $uri = rtrim($uri, '/').'/api/v1/accounts/lookup?';
+
+        $httpOptions = [
+            'timeout' => 20, // wait no more than 20 seconds
+            'query' => [
+                'acct' => $dataProvider->getProperty('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'];
+    }
+
+    /**
+     * Get Mastodon account public status
+     * @throws GuzzleException
+     */
+    private function getResult(mixed $uri, $accountId, $httpOptions)
+    {
+        $uri = rtrim($uri, '/') . '/api/v1/accounts/' . $accountId . '/statuses?';
+
+        $client = new Client();
+        $response = $client->request('GET', $uri, $httpOptions);
+        $result = json_decode($response->getBody()->getContents(), true);
+
+        $this->getLog()->debug('Mastodon: username search result count ' . count($result));
+        return $result;
+    }
 }

modules/mastodon.xml

@@ -26,7 +26,7 @@
     <class>\Xibo\Widget\MastodonProvider</class>
     <type>mastodon</type>
     <dataType>social-media</dataType>
-    <dataCacheKey>%hashtag%_%numItems%_%searchOn%_%onlyMedia%_%serverUrl%</dataCacheKey>
+    <dataCacheKey>%hashtag%_%numItems%_%searchOn%_%onlyMedia%_%serverUrl%_%userName%</dataCacheKey>
     <schemaVersion>1</schemaVersion>
     <assignable>1</assignable>
     <regionSpecific>1</regionSpecific>
@@ -70,6 +70,11 @@
             <helpText>Leave empty to use the one from settings.</helpText>
             <default></default>
         </property>
+        <property id="userName" type="text">
+            <title>Username</title>
+            <helpText>Provide Mastodon username to get public statuses from the account.</helpText>
+            <default></default>
+        </property>
         <property id="numItems" type="number">
             <title>Count</title>
             <helpText>The number of posts to return (default = 15).</helpText>