feat: added option to store email of senders (#58)

Author: mauricerenck

blueprints/sections/komments.yml

@@ -12,6 +12,7 @@ fields:
   kommentsInbox:
     type: structure
     label: Inbox
+    # translate: false
     fields:
       author:
         type: text
@@ -25,6 +26,10 @@ fields:
         type: url
         label: Author Url
         width: 2/3
+      authorEmail:
+        type: email
+        label: Author email
+        width: 1/3
       kommentType:
         type: select
         label: Type

docs/options.md

@@ -43,8 +43,14 @@ You can fine tune the komments plugin to behave as you whish. Use these options
 
 ## Moderation settings
 
-| Option                                  | Default   | Description                                                 |
-| --------------------------------------- | --------- | ----------------------------------------------------------- |
-| `komment-auto-publish`            | `false`  | When you receive a komment set status to published                                               |
-| `auto-publish-verified`           | `true`   | New comments by verified users are automatically published                                       |
-| `moderation.autoPublish`          | `[]`   | An array of email addresses which comments will be published without moderation                  |
+| Option                   | Default | Description                                                                     |
+| ------------------------ | ------- | ------------------------------------------------------------------------------- |
+| `komment-auto-publish`   | `false` | When you receive a komment set status to published                              |
+| `auto-publish-verified`  | `true`  | New comments by verified users are automatically published                      |
+| `moderation.autoPublish` | `[]`    | An array of email addresses which comments will be published without moderation |
+
+## Privacy settings
+
+| Option               | Default | Description                                                                |
+| -------------------- | ------- | -------------------------------------------------------------------------- |
+| `privacy.storeEmail` | `false` | Enable to also store the email address of the comment sender in plain text |

tests/utils/ReceiveKommentTest.php

@@ -44,4 +44,53 @@ public function testAutoPublishUnknownAddress()
 
         $this->assertFalse($isVerified);
     }
+
+    public function testSetEmailAddressDisabled()
+    {
+        $kommentReceiver = new KommentReceiver();
+        $result = $kommentReceiver->setEmail('[email protected]');
+
+        $this->assertNull($result);
+    }
+
+    public function testSetConvertToWebmention()
+    {
+        $commentMock = Array
+        (
+            'komment' => 'This is my comment',
+            'url' => '',
+            'email' => '[email protected]',
+            'author' => 'John Doe',
+            'author_url' => 'https://web.site',
+            'wmSource' => 'https://komments.test:8890/en/phpunit',
+            'wmTarget' => 'https://komments.test:8890/en/phpunit',
+            'wmProperty' => 'komment',
+            'quote' => '',
+            'replyTo' => '',
+            'replyHandle' => '',
+            'cts' => 10,
+        );
+
+        $expectedResult = [
+            'type' => 'KOMMENT',
+            'target' => '/en/phpunit',
+            'source' => '/en/phpunit',
+            'mentionOf' =>  null,
+            'published' => date('c'),
+            'content' => 'This is my comment',
+            'quote' => '',
+            'author' => [
+                'type' => 'card',
+                'name' => 'John Doe',
+                'avatar' => 'https://www.gravatar.com/avatar/cc1bdde8cb8ec60527b5102beafc99a6',
+                'url' => 'https://web.site',
+                'email' => null,
+            ]
+        ];
+
+        $kommentReceiver = new KommentReceiver();
+        $webmention = $kommentReceiver->convertToWebmention($commentMock, page('phpunit'));
+        
+        $this->assertEquals($expectedResult, $webmention);
+    }
 }

utils/receiveKomment.php

@@ -38,6 +38,7 @@ public function convertToWebmention($formData, $targetPage)
                 'name' => $this->setAuthorName($formData['author']),
                 'avatar' => $this->setAvatarFromEmail($formData['email']),
                 'url' => $this->setUrl($formData['author_url']),
+                'email' => $this->setEmail($formData['email']),
             ]
         ];
     }
@@ -51,6 +52,7 @@ public function createKomment($webmention, $spamlevel = 0, $isVerified = false,
             'avatar' => $this->setUrl($webmention['author']['avatar']),
             'author' => $webmention['author']['name'],
             'authorUrl' => $this->setUrl($webmention['author']['url']),
+            'authorEmail' => $this->setEmail($webmention['author']['email']),
             'source' => $this->setUrl($webmention['source']),
             'target' => $this->setUrl($webmention['target']),
             'mentionOf' => (!isset($webmention['mentionOf']) || is_null($webmention['mentionOf'])) ? $this->setUrl($webmention['target']) : $webmention['mentionOf'],
@@ -186,6 +188,21 @@ public function setAvatarFromEmail(string $email)
         return null;
     }
 
+    public function setEmail(string | null $email) {
+
+        if(is_null($email)) {
+            return null;
+        }
+
+        if(option('mauricerenck.komments.privacy.storeEmail', false)) {
+            if (V::email($email)) {
+                return $email;
+            }
+        }
+
+        return null;
+    }
+
     public function sendReponseToClient(string $headlineTranslationString, string $messageTranslationString, int $httpCode, bool $shouldReturnJson)
     {
         if ($shouldReturnJson) {