feat: define multiple source fields for external posting

mauricerenck · Aug 17, 2024 · 0f9f04c · 0f9f04c
1 parent 3e73eb9
commit 0f9f04c
Show file tree

Hide file tree

Showing 10 changed files with 99 additions and 95 deletions.
diff --git a/docs/mastodon.md b/docs/mastodon.md
@@ -4,10 +4,10 @@ You can enable automatically posting to Mastodon and/or Bluesky when a new page
 
 ## General setup
 
-In order to post to Mastodon or Bluesky, you have to setup some fields in your `config.php`. The **textfield** is the field that will be used as the text for the post. And if you want to also post an image, you have to define an **imagefield**. Use the same name as in your blueprint:
+In order to post to Mastodon or Bluesky, you have to setup some fields in your `config.php`. The **textfields** is a list of fields that will be used as the text for the post, the first one found and not empty will be used. And if you want to also post an image, you have to define an **imagefield**. Use the same name as in your blueprint:
 
 ```php
-'mauricerenck.indieConnector.post.textfield' => 'description',
+'mauricerenck.indieConnector.post.textfields' => ['description'],
 'mauricerenck.indieConnector.post.imagefield' => 'postImage',
 ```
 

diff --git a/docs/options.md b/docs/options.md
@@ -62,12 +62,12 @@
 
 ## Posting to external services
 
-| Option                  | Default         | Description                                                 |
-| ----------------------- | --------------- | ----------------------------------------------------------- |
-| `post.textfield`        | `‘description‘` | Text source field for posting elsewhere                     |
-| `post.imagefield`       | `''`            | Image source field for posting elsewhere, must be one image |
-| `post.allowedTemplates` | `[]`            | Set templates allowed to send webmentions                   |
-| `post.blockedTemplates` | `[]`            | Block templates from sending webmentions                    |
+| Option                  | Default            | Description                                                 |
+| ----------------------- | ------------------ | ----------------------------------------------------------- |
+| `post.textfields`        | `['description']` | Text source fields for posting elsewhere                    |
+| `post.imagefield`       | `''`               | Image source field for posting elsewhere, must be one image |
+| `post.allowedTemplates` | `[]`               | Set templates allowed to send webmentions                   |
+| `post.blockedTemplates` | `[]`               | Block templates from sending webmentions                    |
 
 
 ### Mastodon ([details](mastodon.md))

diff --git a/lib/BlueskySender.php b/lib/BlueskySender.php
@@ -2,44 +2,27 @@
 
 namespace mauricerenck\IndieConnector;
 
-use Kirby\Toolkit\Str;
 use Exception;
 use Kirby\Filesystem\F;
 use cjrasmussen\BlueskyApi\BlueskyApi;
 
-class BlueskySender extends Sender
+class BlueskySender extends ExternalPostSender
 {
-    private $maxPostLength = 300;
-
     public function __construct(
-        private ?string $textfield = null,
-        private ?string $imagefield = null,
         private ?string $handle = null,
         private ?string $password = null,
         private ?bool $enabled = null,
-        private ?UrlChecks $urlChecks = null,
-        private ?PageChecks $pageChecks = null
     ) {
         parent::__construct();
 
-        $this->textfield = $textfield ?? option('mauricerenck.indieConnector.post.textfield', 'description');
-        $this->imagefield = $imagefield ?? option('mauricerenck.indieConnector.post.imagefield', false);
-
+        $this->enabled = $enabled ?? option('mauricerenck.indieConnector.bluesky.enabled', false);
         $this->handle = $password ?? option('mauricerenck.indieConnector.bluesky.handle', false);
         $this->password = $password ?? option('mauricerenck.indieConnector.bluesky.password', false);
-        $this->enabled = $enabled ?? option('mauricerenck.indieConnector.bluesky.enabled', false);
-
-        $this->urlChecks = $urlChecks ?? new UrlChecks();
-        $this->pageChecks = $pageChecks ?? new PageChecks();
-
-        // backwards compatibility
-        if (!$textfield && option('mauricerenck.indieConnector.mastodon-text-field', false)) {
-            $this->textfield = option('mauricerenck.indieConnector.mastodon-text-field');
-        }
     }
 
     public function sendPost($page)
     {
+
         if (!$this->enabled) {
             return false;
         }
@@ -69,12 +52,9 @@ public function sendPost($page)
         try {
             $pageUrl = $page->url();
             $trimTextPosition = $this->calculatePostTextLength($page->url());
-            $textfield = $this->textfield;
             $language = 'en';
 
-            $message = $page->$textfield()->isNotEmpty()
-                ? $page->$textfield()->value()
-                : Str::short($page->title(), $trimTextPosition);
+            $message = $this->getTextFieldContent($page, $trimTextPosition);
             $message .= "\n" . $pageUrl;
 
             if ($defaultLanguage = kirby()->defaultLanguage()) {
@@ -121,7 +101,7 @@ public function sendPost($page)
 
             $response = $bluesky->request('POST', 'com.atproto.repo.createRecord', $args);
 
-            $this->updatePosts($response->uri, 200, $page);
+            $this->updatePosts($response->uri, 200, $page, 'bluesky');
             return true;
         } catch (Exception $e) {
             throw new Exception($e->getMessage());
@@ -183,15 +163,4 @@ public function getMediaAttachment($page)
             return false;
         }
     }
-
-    public function calculatePostTextLength(string $url)
-    {
-        $urlLength = Str::length($url);
-        return $this->maxPostLength - $urlLength - 2;
-    }
-
-    public function updatePosts($url, $statusCode, $page)
-    {
-        return $this->updateExternalPosts($url, $statusCode, 'bluesky', $page);
-    }
 }
diff --git a/lib/ExternalPostSender.php b/lib/ExternalPostSender.php
@@ -0,0 +1,67 @@
+<?php
+
+namespace mauricerenck\IndieConnector;
+
+use Kirby\Toolkit\Str;
+
+class ExternalPostSender extends Sender
+{
+    public function __construct(
+        public ?array $textfields = null,
+        public ?string $imagefield = null,
+        private ?int $maxPostLength = null,
+        public ?UrlChecks $urlChecks = null,
+        public ?PageChecks $pageChecks = null
+    ) {
+        parent::__construct();
+
+        $this->textfields = $textfields ?? option('mauricerenck.indieConnector.post.textfields', ['description']);
+        $this->imagefield = $imagefield ?? option('mauricerenck.indieConnector.post.imagefield', false);
+        $this->maxPostLength = $maxPostLength ?? 300;
+
+        $this->urlChecks = $urlChecks ?? new UrlChecks();
+        $this->pageChecks = $pageChecks ?? new PageChecks();
+
+        // backwards compatibility
+        $singleTextfield = option('mauricerenck.indieConnector.post.textfield', false);
+        if (!$textfields && $singleTextfield) {
+            $this->textfields = [$singleTextfield];
+        }
+
+        if (!$textfields && $singleTextfield) {
+            $this->textfields = [$singleTextfield];
+        }
+
+        if (!$maxPostLength && option('mauricerenck.indieConnector.mastodon-text-length', false)) {
+            $this->maxPostLength = option('mauricerenck.indieConnector.mastodon-text-length');
+        }
+    }
+
+    public function getTextFieldContent($page, $trimTextPosition) {
+        if(is_array($this->textfields)) {
+            foreach($this->textfields as $field) {
+                if($page->$field()->exists() && $page->$field()->isNotEmpty()) {
+                    return $page->$field()->value();
+                }
+            }
+        }
+
+        $field = $this->textfields;
+        if(!is_array($this->textfields) && $page->$field()->isNotEmpty()) {
+            return $page->$field()->value();
+        }
+
+        return Str::short($page->title(), $trimTextPosition);
+    }
+
+    public function calculatePostTextLength(string $url)
+    {
+        $urlLength = Str::length($url);
+        return $this->maxPostLength - $urlLength - 2;
+    }
+
+    public function updatePosts($url, $statusCode, $page, $target)
+    {
+        return $this->updateExternalPosts($url, $statusCode, $target, $page);
+    }
+}
diff --git a/lib/MastodonSender.php b/lib/MastodonSender.php
@@ -2,45 +2,24 @@
 
 namespace mauricerenck\IndieConnector;
 
-use Kirby\Toolkit\Str;
 use Exception;
 use Kirby\Http\Remote;
 use Kirby\Filesystem\F;
 
-class MastodonSender extends Sender
+class MastodonSender extends ExternalPostSender
 {
     public function __construct(
-        private ?int $tootMaxLength = null,
-        private ?string $textfield = null,
-        private ?string $imagefield = null,
         private ?string $instanceUrl = null,
         private ?string $token = null,
         private ?bool $enabled = null,
-        private ?UrlChecks $urlChecks = null,
-        private ?PageChecks $pageChecks = null
     ) {
         parent::__construct();
 
-        $this->textfield = $textfield ?? option('mauricerenck.indieConnector.post.textfield', 'description');
-        $this->imagefield = $imagefield ?? option('mauricerenck.indieConnector.post.imagefield', false);
-
         $this->enabled = $enabled ?? option('mauricerenck.indieConnector.mastodon.enabled', false);
         $this->instanceUrl = $instanceUrl ?? option('mauricerenck.indieConnector.mastodon.instance-url', false);
         $this->token = $token ?? option('mauricerenck.indieConnector.mastodon.bearer', false);
-        $this->tootMaxLength = $tootMaxLength ?? option('mauricerenck.indieConnector.mastodon.text-length', 500);
-
-        $this->urlChecks = $urlChecks ?? new UrlChecks();
-        $this->pageChecks = $pageChecks ?? new PageChecks();
 
         // backwards compatibility
-        if (!$textfield && option('mauricerenck.indieConnector.mastodon-text-field', false)) {
-            $this->textfield = option('mauricerenck.indieConnector.mastodon-text-field');
-        }
-
-        if (!$tootMaxLength && option('mauricerenck.indieConnector.mastodon-text-length', false)) {
-            $this->tootMaxLength = option('mauricerenck.indieConnector.mastodon-text-length');
-        }
-
         if (!$instanceUrl && option('mauricerenck.indieConnector.mastodon-instance-url', false)) {
             $this->instanceUrl = option('mauricerenck.indieConnector.mastodon-instance-url');
         }
@@ -90,11 +69,8 @@ public function sendPost($page)
         try {
             $pageUrl = $page->url();
             $trimTextPosition = $this->calculatePostTextLength($page->url());
-            $textfield = $this->textfield;
 
-            $message = $page->$textfield()->isNotEmpty()
-                ? $page->$textfield()->value()
-                : Str::short($page->title(), $trimTextPosition);
+            $message = $this->getTextFieldContent($page, $trimTextPosition);
             $message .= "\n" . $pageUrl;
 
             $headers = ['Authorization: Bearer ' . $this->token, 'Content-Type: application/json'];
@@ -121,7 +97,7 @@ public function sendPost($page)
             $result = $response->json();
 
             $url = $result['url'] ?? null;
-            $this->updatePosts($url, $response->code(), $page);
+            $this->updatePosts($url, $response->code(), $page, 'mastodon');
 
             return true;
         } catch (Exception $e) {
@@ -191,14 +167,4 @@ public function uploadImage($page)
         }
     }
 
-    public function calculatePostTextLength(string $url)
-    {
-        $urlLength = Str::length($url);
-        return $this->tootMaxLength - $urlLength - 2;
-    }
-
-    public function updatePosts($url, $statusCode, $page)
-    {
-        return $this->updateExternalPosts($url, $statusCode, 'mastodon', $page);
-    }
 }
diff --git a/site/config/config.php b/site/config/config.php
@@ -35,7 +35,7 @@
     'mauricerenck.indieConnector.sqlitePath' => '.sqlite/',
 
     'mauricerenck.indieConnector.post' => [
-        'textfield' => 'description',
+        'textfields' => ['description'],
         'imagefield' => 'mastodonimage',
         'allowedTemplates' => ['phpunit', 'default'],
         'blockedTemplates' => ['blocked-template'],

diff --git a/tests/lib/MastodonSenderTest.php b/tests/lib/MastodonSenderTest.php
@@ -24,12 +24,12 @@ public function testShouldSendPost()
         $this->urlCheckMock->shouldReceive('isLocalUrl')->andReturn(false);
 
         $sender = new MastodonSender(
-            500,
-            'description',
-            null,
             'https://example.com',
             '1234567890',
             true,
+            500,
+            ['description'],
+            null,
             $this->urlCheckMock
         );
 
@@ -51,12 +51,12 @@ public function testShouldHandleDisabled()
         $this->urlCheckMock->shouldReceive('isLocalUrl')->andReturn(false);
 
         $sender = new MastodonSender(
-            500,
-            'description',
-            null,
             'https://example.com',
             '1234567890',
             true,
+            500,
+            ['description'],
+            null,
             $this->urlCheckMock
         );
 
@@ -78,12 +78,12 @@ public function testShouldHandleDraft()
         $this->urlCheckMock->shouldReceive('isLocalUrl')->andReturn(false);
 
         $sender = new MastodonSender(
-            500,
-            'description',
-            null,
             'https://example.com',
             '1234567890',
             true,
+            500,
+            ['description'],
+            null,
             $this->urlCheckMock
         );
 

diff --git a/vendor/composer/autoload_classmap.php b/vendor/composer/autoload_classmap.php
@@ -15,6 +15,7 @@
     'Kirby\\ComposerInstaller\\PluginInstaller' => $vendorDir . '/getkirby/composer-installer/src/ComposerInstaller/PluginInstaller.php',
     'cjrasmussen\\BlueskyApi\\BlueskyApi' => $vendorDir . '/cjrasmussen/bluesky-api/src/BlueskyApi.php',
     'mauricerenck\\IndieConnector\\BlueskySender' => $baseDir . '/lib/BlueskySender.php',
+    'mauricerenck\\IndieConnector\\ExternalPostSender' => $baseDir . '/lib/ExternalPostSender.php',
     'mauricerenck\\IndieConnector\\IndieConnectorDatabase' => $baseDir . '/lib/Database.php',
     'mauricerenck\\IndieConnector\\MastodonSender' => $baseDir . '/lib/MastodonSender.php',
     'mauricerenck\\IndieConnector\\Microformats' => $baseDir . '/lib/Microformats.php',

diff --git a/vendor/composer/autoload_static.php b/vendor/composer/autoload_static.php
@@ -60,6 +60,7 @@ class ComposerStaticInit84944e4200b9284446d234824c8e9dcc
         'Kirby\\ComposerInstaller\\PluginInstaller' => __DIR__ . '/..' . '/getkirby/composer-installer/src/ComposerInstaller/PluginInstaller.php',
         'cjrasmussen\\BlueskyApi\\BlueskyApi' => __DIR__ . '/..' . '/cjrasmussen/bluesky-api/src/BlueskyApi.php',
         'mauricerenck\\IndieConnector\\BlueskySender' => __DIR__ . '/../..' . '/lib/BlueskySender.php',
+        'mauricerenck\\IndieConnector\\ExternalPostSender' => __DIR__ . '/../..' . '/lib/ExternalPostSender.php',
         'mauricerenck\\IndieConnector\\IndieConnectorDatabase' => __DIR__ . '/../..' . '/lib/Database.php',
         'mauricerenck\\IndieConnector\\MastodonSender' => __DIR__ . '/../..' . '/lib/MastodonSender.php',
         'mauricerenck\\IndieConnector\\Microformats' => __DIR__ . '/../..' . '/lib/Microformats.php',

diff --git a/vendor/composer/installed.php b/vendor/composer/installed.php
@@ -1,8 +1,8 @@
 <?php return array(
     'root' => array(
         'name' => 'mauricerenck/indieconnector',
-        'pretty_version' => '2.0.0',
-        'version' => '2.0.0.0',
+        'pretty_version' => '2.0.1',
+        'version' => '2.0.1.0',
         'reference' => NULL,
         'type' => 'kirby-plugin',
         'install_path' => __DIR__ . '/../../',
@@ -38,8 +38,8 @@
             'dev_requirement' => false,
         ),
         'mauricerenck/indieconnector' => array(
-            'pretty_version' => '2.0.0',
-            'version' => '2.0.0.0',
+            'pretty_version' => '2.0.1',
+            'version' => '2.0.1.0',
             'reference' => NULL,
             'type' => 'kirby-plugin',
             'install_path' => __DIR__ . '/../../',