Code and compatibility improvements (#66)

* chore: show author action * chore: removed console log * improvement: added mockery * feat: removed moderation cookies BREAKING CHANGE: Komments plugin will not use cookies anymore * improvement: use structures in snippets no more arrays BREAKING CHANGE: comments and replies are splitted, strcutures are used now * chore: add deprecation warning * improvement: base utils optimization * feat: added frontend class (wip) * feat: removed unused quote feature BRAKING CHANGE: Quotes are getting removed * improvement: moved kommentsAreExpired to frontend class * feat: multilang page mock * improvement: tests * chore: ignore tilde folder * chore: remove dump * chore: class loader * improvement: refactored classes and tests * improvement: remove needless api calls * fix: better backwards compatibility with Kirby 3 * chore: added translations * fix: show all language comments in panel * improvement: reduced css BREAKING CHANGE: CSS has been reduced to a minimum
mauricerenck · Mar 4, 2024 · 51e4ccf · 51e4ccf
1 parent d1e2fd9
commit 51e4ccf
Show file tree

Hide file tree

Showing 43 changed files with 2,017 additions and 926 deletions.
diff --git a/.gitignore b/.gitignore
@@ -35,3 +35,4 @@
 /media
 /kirby
 /site/cache
+/~
diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-v16.3.0
+v20.11.1
diff --git a/BREAKING_CHANGES.md b/BREAKING_CHANGES.md
@@ -0,0 +1,7 @@
+- Moderation Cookies entfernt
+- Snippets angepasst
+- Comments und Replies getrennt
+- Alles jetzt als Object, keine Arrays mehr
+- hasQueuedKomments DEPRECATED
+- Quote ist weg, wurde sowieso nicht aktiv genutzt
+- 
diff --git a/assets/komments.css b/assets/komments.css
diff --git a/assets/komments.css.map b/assets/komments.css.map
diff --git a/assets/komments.js b/assets/komments.js
@@ -127,7 +127,7 @@ docReady(function () {
         link.addEventListener('click', (event) => {
             const kommentId = event.target.dataset.id;
             const kommentHandle = event.target.dataset.handle;
-            console.log(kommentId, kommentHandle);
+
             kommentForm.querySelector('input[name=replyTo]').value = kommentId;
             kommentForm.querySelector('input[name=replyHandle]').value = kommentHandle;
             replyHandleDisplay.innerHTML = `<a href="#komment_${kommentId}">@${kommentHandle}</a>`;

diff --git a/blueprints/sections/komments.yml b/blueprints/sections/komments.yml
@@ -41,11 +41,6 @@ fields:
           MENTION: Mention
           KOMMENT: Komment
           SPAM: Spam
-
-      quote:
-        type: textarea
-        label: Quote
-        width: 1/1
       komment:
         type: textarea
         label: Komment

diff --git a/components/api.php b/components/api.php
@@ -2,68 +2,10 @@
 
 namespace mauricerenck\Komments;
 
-use Structure;
 use Kirby\Http\Response;
 
 return [
     'routes' => [
-        [
-            'pattern' => 'komments/queued',
-            'action' => function () {
-
-                $pendingKomments = [];
-                $collection = site()->index();
-
-                foreach ($collection as $item) {
-                    if ($item->kommentsInbox()->isNotEmpty()) {
-                        foreach ($item->kommentsInbox()->yaml() as $komment) {
-                            $komment['spamlevel'] = (isset($komment['spamlevel'])) ? $komment['spamlevel'] : 0; // backward compatiblity
-
-                            if (($komment['status'] === 'false' || $komment['status'] === false) && (integer)$komment['spamlevel'] === 0) {
-                                $pendingKomments[] = [
-                                    'author' => $komment['author'],
-                                    'komment' => $komment['komment'],
-                                    'kommentType' => (isset($komment['kommenttype'])) ? $komment['kommenttype'] : 'komment', // backward compatiblity
-                                    'image' => $komment['avatar'],
-                                    'title' => (string) $item->title(),
-                                    'url' => $item->panel()->url(),
-                                ];
-                            }
-                        }
-                    }
-                }
-
-                return new Response(json_encode($pendingKomments), 'application/json');
-            }
-        ],
-        [
-            'pattern' => 'komments/spam',
-            'action' => function () {
-                $spamKomments = [];
-                $collection = site()->index();
-
-
-                foreach ($collection as $item) {
-                    if ($item->kommentsInbox()->isNotEmpty()) {
-                        foreach ($item->kommentsInbox()->yaml() as $komment) {
-                            $komment['spamlevel'] = (isset($komment['spamlevel'])) ? $komment['spamlevel'] : 0; // backward compatiblity
-                            if ((integer)$komment['spamlevel'] > 0) {
-                                $spamKomments[] = [
-                                    'author' => $komment['author'],
-                                    'komment' => $komment['komment'],
-                                    'kommentType' => (isset($komment['kommenttype'])) ? $komment['kommenttype'] : 'komment', // backward compatiblity
-                                    'image' => $komment['avatar'],
-                                    'title' => (string) $item->title(),
-                                    'url' => $item->panel()->url(),
-                                ];
-                            }
-                        }
-                    }
-                }
-
-                return new Response(json_encode($spamKomments), 'application/json');
-            }
-        ],
         [
             'pattern' => 'komments/spam',
             'method' => 'POST',
@@ -74,7 +16,7 @@
                 $kommentModeration->markAsSpam($formData['pageSlug'], $formData['kommentId'], $formData['isSpam']);
 
                 return new Response(json_encode(['message' => 'okay']), 'application/json');
-            }
+            },
         ],
         [
             'pattern' => 'komments/verify',
@@ -83,10 +25,14 @@
                 $formData = kirby()->request()->data();
 
                 $kommentModeration = new KommentModeration();
-                $kommentModeration->markAsVerified($formData['pageSlug'], $formData['kommentId'], $formData['isVerified']);
+                $kommentModeration->markAsVerified(
+                    $formData['pageSlug'],
+                    $formData['kommentId'],
+                    $formData['isVerified']
+                );
 
                 return new Response(json_encode(['message' => 'okay']), 'application/json');
-            }
+            },
         ],
         [
             'pattern' => 'komments/publish',
@@ -98,7 +44,7 @@
                 $kommentModeration->publish($formData['pageSlug'], $formData['kommentId'], $formData['isPublished']);
 
                 return new Response(json_encode(['message' => 'okay']), 'application/json');
-            }
+            },
         ],
         [
             'pattern' => 'komments/delete',
@@ -110,7 +56,7 @@
                 $kommentModeration->delete($formData['pageSlug'], $formData['kommentId']);
 
                 return new Response(json_encode(['message' => 'okay']), 'application/json');
-            }
+            },
         ],
-    ]
+    ],
 ];
diff --git a/components/areas.php b/components/areas.php
@@ -3,7 +3,7 @@
 namespace mauricerenck\Komments;
 
 return [
-    'komments' => function ($kirby) {
+    'komments' => function () {
         return [
             'label' => 'Komments',
             'icon' => 'chat',
@@ -18,14 +18,15 @@
                             'title' => 'Komments',
                             'props' => [
                                 'queuedKomments' => function () {
-                                    $kommentUtils = new KommentBaseUtils();
-                                    return $kommentUtils->getPendingKomments();
+                                    $kommentModeration = new KommentModeration();
+                                    return $kommentModeration->getSiteWideComments('pending');
                                 },
+                                'kirbyVersion' => kirby()->version(),
                             ],
                         ];
-                    }
-                ]
-            ]
+                    },
+                ],
+            ],
         ];
-    }
+    },
 ];
diff --git a/components/fields.php b/components/fields.php
@@ -4,24 +4,23 @@
 
 return [
     'kommentType' => [
-        'props' => [
-        ]
+        'props' => [],
     ],
     'kommentsPending' => [
         'props' => [
             'queuedComments' => function () {
                 $kommentUtils = new KommentBaseUtils();
-                $pendingComments = $kommentUtils->getPendingCommentCount();
+                $pendingComments = $kommentUtils->getSiteWideCommentCount('pending');
                 return $pendingComments;
             },
-        ]
+        ],
     ],
     'komments' => [
         'props' => [
             'queuedComments' => function () {
-                $kommentUtils = new KommentBaseUtils();
-                return $kommentUtils->getPendingKomments();
+                $kommentModeration = new KommentModeration();
+                return $kommentModeration->getSiteWideComments('pending');
             },
-        ]
-    ]
+        ],
+    ],
 ];
diff --git a/components/page-methods.php b/components/page-methods.php
@@ -2,27 +2,19 @@
 
 namespace mauricerenck\Komments;
 
-use mauricerenck\Komments\KommentBaseUtils;
-use mauricerenck\Komments\KommentModeration;
-
 return [
-    'kommentCount' => function () {
-        $count = 0;
-        foreach ($this->kommentsInbox()->yaml() as $komment) {
-            if ($komment['status'] !== 'false' && $komment['status'] !== false) {
-                $count++;
-            }
-        }
-        return $count;
+    'kommentCount' => function ($language = null) {
+        $baseUtils = new KommentBaseUtils();
+        return $baseUtils->getCommentsCountOfPage($this, 'published');
     },
     'hasQueuedKomments' => function ($kommentId, $kommenStatus) {
-        $kommentModeration = new KommentModeration();
-        return $kommentModeration->pageHasQueuedKomments($kommentId, $kommenStatus);
+        deprecated('`hasQueuedKomments()` is deprecated, queued comment cookies habe been removed, this is no more needed. `hasQueuedKomments()` will be removed in future versions.');
+        return 0;
     },
     'kommentsAreEnabled' => function () {
-        $kommentBaseUtils = new KommentBaseUtils();
+        $kommentsFrontend = new KommentsFrontend();
 
-        if ($kommentBaseUtils->kommentsAreExpired($this)) {
+        if ($kommentsFrontend->kommentsAreExpired($this)) {
             return false;
         }
 

diff --git a/components/site-methods.php b/components/site-methods.php
@@ -7,10 +7,10 @@
 return [
     'numberOfPendingComments' => function () {
         $kommentBaseUtils = new KommentBaseUtils();
-        return $kommentBaseUtils->getPendingCommentCount();
+        return $kommentBaseUtils->getSiteWideCommentCount('pending');
     },
     'numberOfSpamComments' => function () {
         $kommentBaseUtils = new KommentBaseUtils();
-        return $kommentBaseUtils->getSpamCommentCount();
-    }
+        return $kommentBaseUtils->getSiteWideCommentCount('spam');
+    },
 ];