feat: set a prefered language for posting to mastodon or bluesky

Author: mauricerenck

README.md

@@ -43,13 +43,13 @@ Use one of these three methods to install the plugin:
 
 ## Roadmap
 
+- [x] Manual queue cleanup
 - [ ] Queue for sending webmentions
 - [ ] Queue for sending mastodon posts
 - [ ] Queue for sending bluesky posts
 - [ ] Nested indieweb replies
 - [ ] Blocklist for users on Mastodon and Bluesky
 - [ ] Manual post to Mastodon and Bluesky
-- [x] Manual queue cleanup
 - [ ] Block hosts from within the panel
 - [ ] Post complete texts to Mastodon and Bluesky splitted in threads
 - [ ] Option for using Kirby UUID permalinks in Mastodon/Bluesky posts

docs/mastodon.md

@@ -42,6 +42,27 @@ Depending on your Mastodon instance the text length may vary. The default is 500
 'mauricerenck.indieConnector.mastodon.text-length' => 500,
 ```
 
+### Setting a language
+
+If you want to use another language than your default language to use the text from, you can set the following option:
+
+```php
+'mauricerenck.indieConnector.post.prefereLanguage' => 'en',
+```
+
+This might be handy if your default language is for example German but you only want to post in English on Mastodon or Bluesky. This way the english translation is used as a source for the text or title.
+
+### Use the permalink URL
+
+If you want to use the permalink URL instead of the page URL, you can set the following option:
+
+```php
+'mauricerenck.indieConnector.post.usePermalinkUrl' => true,
+```
+
+This url will never change, even if you change the slug of the page. This way you can ensure that the link in your Mastodon post will always work.
+
+
 ### Get the URL of the post
 
 If you want to display te URL of your Mastodon post on your page, so that people can use it to interact with your post, you can use the following page method:

docs/options.md

@@ -62,12 +62,14 @@
 
 ## Posting to external services
 
-| 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                    |
+| Option                  | Default            | Description                                                          |
+| ----------------------- | ------------------ | -------------------------------------------------------------------- |
+| `post.prefereLanguage`  | `-`                | Use another language than your default language to use the text from |
+| `post.usePermalinkUrl`  | `false`            | Use the permalink url instead of the page url                        |
+| `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))

lib/BlueskySender.php

@@ -60,8 +60,8 @@ public function sendPost($page)
                 $language = $defaultLanguage->code();
             }
 
-            if ($this->forceLanguage !== false) {
-                $language = $this->forceLanguage;
+            if ($this->prefereLanguage !== false) {
+                $language = $this->prefereLanguage;
             }
 
             $bluesky = new BlueskyApi();

lib/ExternalPostSender.php

@@ -9,7 +9,7 @@ class ExternalPostSender extends Sender
     public function __construct(
         public ?array $textfields = null,
         public ?string $imagefield = null,
-        public ?string $forceLanguage = null,
+        public ?string $prefereLanguage = null,
         public ?bool $usePermalinkUrl = null,
         private ?int $maxPostLength = null,
         public ?UrlChecks $urlChecks = null,
@@ -19,7 +19,7 @@ public function __construct(
 
         $this->textfields = $textfields ?? option('mauricerenck.indieConnector.post.textfields', ['description']);
         $this->imagefield = $imagefield ?? option('mauricerenck.indieConnector.post.imagefield', false);
-        $this->forceLanguage = $forceLanguage ?? option('mauricerenck.indieConnector.post.forceLanguage', false);
+        $this->prefereLanguage = $prefereLanguage ?? option('mauricerenck.indieConnector.post.prefereLanguage', false);
         $this->usePermalinkUrl = $usePermalinkUrl ?? option('mauricerenck.indieConnector.post.usePermalinkUrl', false);
         $this->maxPostLength = $maxPostLength ?? 300;
 
@@ -43,7 +43,7 @@ public function __construct(
 
     public function getTextFieldContent($page, $trimTextPosition)
     {
-        $pageOfLanguage = $page->translation($this->forceLanguage);
+        $pageOfLanguage = $page->translation($this->prefereLanguage);
         $content = !is_null($pageOfLanguage) ? $pageOfLanguage->content() : $page->content()->toArray();
 
         if (is_array($this->textfields)) {
@@ -64,7 +64,7 @@ public function getTextFieldContent($page, $trimTextPosition)
 
     public function getPostUrl($page)
     {
-        $url = $page->url($this->forceLanguage);
+        $url = $page->url($this->prefereLanguage);
 
         if ($this->usePermalinkUrl) {
             $url = $page->permalink();

lib/MastodonSender.php

@@ -84,8 +84,8 @@ public function sendPost($page)
                 $requestBody['language'] = $defaultLanguage->code();
             }
 
-            if ($this->forceLanguage !== false) {
-                $requestBody['language'] = $this->forceLanguage;
+            if ($this->prefereLanguage !== false) {
+                $requestBody['language'] = $this->prefereLanguage;
             }
 
             if ($mediaId = $this->uploadImage($page)) {