Merge pull request #3 from Digitalist-Open-Cloud/add_commands

mikkeschiren · web-flow · commit c7a58bd9fb90 · 2025-01-03T12:10:50.000+01:00
add some commands
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Changelog
 
+## [5.0.4] - 2025-01-03
+
+### Added
+
+- Console commands to create and list notifications.
+- Improved usability on the manage page for notifications.
+
 ## [5.0.3] - 2025-01-02
 
 ### Added
diff --git a/Commands/CreateNotification.php b/Commands/CreateNotification.php
@@ -44,7 +44,7 @@ protected function configure()
         To run:
         <info>%command.name%</info>';
                 $this->setHelp($HelpText);
-                $this->setName('rebelnotifications:create-notification');
+                $this->setName('rebelnotifications:create');
                 $this->setDescription('CreateNotification');
                 $this->addNoValueOption(
                     'enabled',
@@ -100,54 +100,38 @@ protected function doExecute(): int
     {
         $input = $this->getInput();
         $output = $this->getOutput();
-
-        // Retrieve and check 'active' option
         if (!$input->hasOption('enabled') || $input->getOption('enabled') === null) {
             $enabled = 0;
         } else {
             $enabled = 1;
         }
-
-        // Retrieve and check 'raw' option
         if (!$input->hasOption('raw') || $input->getOption('raw') === null) {
             $raw = 0;
         } else {
             $raw = 1;
         }
-
-        // Retrieve and check 'type' option
         if (!$input->hasOption('type') || $input->getOption('type') === null) {
             throw new \InvalidArgumentException("The 'type' option is required.");
         }
         $type = $input->getOption('type');
-
-        // Retrieve and check 'title' option
         if (!$input->hasOption('title') || $input->getOption('title') === null) {
             throw new \InvalidArgumentException("The 'title' option is required.");
         }
         $title = $input->getOption('title');
-
-        // Retrieve and check 'message' option
         if (!$input->hasOption('message') || $input->getOption('message') === null) {
             throw new \InvalidArgumentException("The 'message' option is required.");
         }
         $message = $input->getOption('message');
-
-        // Retrieve and check 'context' option
         if (!$input->hasOption('context') || $input->getOption('context') === null) {
             throw new \InvalidArgumentException("The 'context' option is required.");
         }
         $context = $input->getOption('context');
-
-        // Retrieve and check 'priority' option
         if (!$input->hasOption('priority') || $input->getOption('priority') === null) {
             throw new \InvalidArgumentException("The 'priority' option is required.");
         }
         $priority = $input->getOption('priority');
-
-        $api = new API;
+        $api = new API();
         $addNotification = $api->insertNotification($enabled, $title, $message, $context, $priority, $type, $raw);
-
         $message = sprintf('<info>Created notification: %s</info>', $title);
 
         $output->writeln($message);
diff --git a/Commands/ListNotifications.php b/Commands/ListNotifications.php
@@ -0,0 +1,93 @@
+<?php
+
+/**
+ * The Rebel Notification plugin for Matomo.
+ *
+ * Copyright (C) Digitalist Open Cloud <cloud@digitalist.com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+namespace Piwik\Plugins\RebelNotifications\Commands;
+
+use Piwik\Plugin\ConsoleCommand;
+use Piwik\Plugins\RebelNotifications\API;
+
+/**
+ * This class lets you define a new command. To read more about commands have a look at our Matomo Console guide on
+ * https://developer.matomo.org/guides/piwik-on-the-command-line
+ *
+ * As Matomo Console is based on the Symfony Console you might also want to have a look at
+ * http://symfony.com/doc/current/components/console/index.html
+ */
+class ListNotifications extends ConsoleCommand
+{
+    /**
+     * This method allows you to configure your command. Here you can define the name and description of your command
+     * as well as all options and arguments you expect when executing it.
+     */
+    protected function configure()
+    {
+        $HelpText = 'The <info>%command.name%</info> will create a notification.
+        <comment>Samples:</comment>
+        To run:
+        <info>%command.name%</info>';
+                $this->setHelp($HelpText);
+                $this->setName('rebelnotifications:list');
+                $this->setDescription('List notifications');
+                $this->addNoValueOption(
+                    'enabled',
+                    null,
+                    'Set to enabled',
+                    null
+                );
+    }
+
+    protected function doExecute(): int
+    {
+        $input = $this->getInput();
+        $output = $this->getOutput();
+        $enabled = $input->getOption('enabled') ? true : false;
+
+        $api = new API();
+        if ($enabled === false) {
+            $listNotifications = $api->getAllNotifications();
+        } else {
+            $listNotifications = $api->getEnabledNotifications();
+        }
+
+        foreach ($listNotifications as $notification) {
+            if ($notification['enabled'] == 1) {
+                $enabled = 'yes';
+            }
+            if ($notification['raw'] == 1) {
+                $raw = 'yes';
+            }
+
+            $out = "ID: <comment>{$notification['id']}</comment>\n";
+            $out .= "Enabled: <comment>{$enabled}</comment>\n";
+            $out .= "Title: <comment>{$notification['title']}</comment>\n";
+            $out .= "Message: <comment>{$notification['message']}</comment>\n";
+            $out .= "Context: <comment>{$notification['context']}</comment>\n";
+            $out .= "Priority: <comment>{$notification['priority']}</comment>\n";
+            $out .= "Type: <comment>{$notification['type']}</comment>\n";
+            $out .= "Raw (HTML allowed): <comment>{$raw}</comment>\n";
+            $out .= "-----------------------------------";
+            $output->writeln("<info>$out</info>");
+        }
+
+
+        return self::SUCCESS;
+    }
+}
diff --git a/README.md b/README.md
@@ -43,10 +43,24 @@ When you add or change a notification, nothing is changed until you logout and l
 ### Create a notification
 
 ```sh
-./console rebelnotifications:create-notification --raw --enabled --title="My title" --me
+./console rebelnotifications:create --raw --enabled --title="My title" --me
 ssage="This is the message in <strong>bold</strong>" --context=warning --priority=50 --type=persistent
 ```
 
+### List notifications
+
+#### All notifications
+
+```sh
+./console rebelnotifications:list
+```
+
+#### Enabled notifications
+
+```sh
+./console rebelnotifications:list --enabled
+```
+
 ## Using RebelNotifications with Matomo API
 
 Examples with curl.
diff --git a/docs/index.md b/docs/index.md
@@ -38,6 +38,29 @@ At "Manage" you can add, edit and delete notifications.
 
 When you add or change a notification, nothing is changed until you logout and login. The triggering event for the notifications is `Login.authenticate.successful` - which means that nothing updates until you login.
 
+## Using Rebel Notifications with the console
+
+### Create a notification
+
+```sh
+./console rebelnotifications:create --raw --enabled --title="My title" --me
+ssage="This is the message in <strong>bold</strong>" --context=warning --priority=50 --type=persistent
+```
+
+### List notifications
+
+#### All notifications
+
+```sh
+./console rebelnotifications:list
+```
+
+#### Enabled notifications
+
+```sh
+./console rebelnotifications:list --enabled
+```
+
 ## Using RebelNotifications with Matomo API
 
 Examples with curl.
diff --git a/plugin.json b/plugin.json
@@ -1,7 +1,7 @@
 {
     "name": "RebelNotifications",
     "description": "Show Notifications to your users.",
-    "version": "5.0.3",
+    "version": "5.0.4",
     "theme": false,
     "require": {
         "matomo": ">=5.0.0-stable,<6.0.0-b1"
diff --git a/templates/manageNotifications.twig b/templates/manageNotifications.twig
@@ -44,19 +44,24 @@
                 <tbody>
                     {% for notification in messages %}
                         <tr>
-                            <td>{{ notification.enabled }}</td>
+                            <td>{% if notification.enabled == "1" %}
+                                <span class="icon-show" title="Enabled"></span>
+                            {% elseif notification.enabled == "0" %}
+                                <span class="icon-hide" title="Disabled"></span>
+                            {% endif %}
+                           </td>
                             <td>{{ notification.title }}</td>
                             <td>{{ notification.message | raw }}</td>
                             <td>{{ notification.context }}</td>
                             <td>{{ notification.priority }}</td>
                             <td>{{ notification.type }}</td>
                             <td>{{ notification.raw }}</td>
                             <td>
-                                <a href="{{ linkTo({'module':'RebelNotifications','action':'editNotification', 'id': notification.id}) }}">
+                                <a href="{{ linkTo({'module':'RebelNotifications','action':'editNotification', 'id': notification.id}) }}" title="Edit notification">
                                     <span class="icon-edit"></span>
                                 </a>
                             </td>
-                            <td><a href='{{ linkTo({'module':'RebelNotifications','action':'deleteNotification', 'id': notification.id}) }}'><span class="icon-delete"></span></a></td>
+                            <td><a href='{{ linkTo({'module':'RebelNotifications','action':'deleteNotification', 'id': notification.id}) }}' title="Delete notification"><span class="icon-delete"></span></a></td>
                         </tr>
                     {% else %}
                         <tr>
diff --git a/tests/Integration/CommandsTest.php b/tests/Integration/CommandsTest.php
@@ -4,6 +4,7 @@
 
 use Piwik\Tests\Framework\TestCase\ConsoleCommandTestCase;
 use Piwik\Tests\Framework\Fixture;
+use Piwik\Plugins\RebelNotifications\API;
 
 /**
  * @group RebelNotifications
@@ -12,31 +13,37 @@
  */
 class CommandsTest extends ConsoleCommandTestCase
 {
+    /**
+     * @var API
+     */
+    private $api;
+
     public function setUp(): void
     {
         parent::setUp();
         Fixture::createSuperUser();
         Fixture::createWebsite('2025-01-01 00:00:00');
+        $this->api = API::getInstance();
     }
 
     public function testHelpCreateNotification()
     {
         $code = $this->applicationTester->run([
-            'command' => 'rebelnotifications:create-notification',
+            'command' => 'rebelnotifications:create',
             '--help' => true,
             '-vvv' => true,
         ]);
         $this->assertEquals(0, $code);
         $this->assertStringContainsStringIgnoringCase(
-            "rebelnotifications:create-notification [options]",
+            "rebelnotifications:create [options]",
             $this->applicationTester->getDisplay()
         );
     }
 
     public function testCreateNotification()
     {
         $code = $this->applicationTester->run([
-            'command' => 'rebelnotifications:create-notification',
+            'command' => 'rebelnotifications:create',
             '--raw' => true,
             '--enabled' => true,
             '--title' => 'test title',
@@ -52,4 +59,52 @@ public function testCreateNotification()
             $this->applicationTester->getDisplay()
         );
     }
+
+    public function testHelpListNotifications()
+    {
+        $code = $this->applicationTester->run([
+            'command' => 'rebelnotifications:list',
+            '--help' => true,
+            '-vvv' => true,
+        ]);
+        $this->assertEquals(0, $code);
+        $this->assertStringContainsStringIgnoringCase(
+            "rebelnotifications:list [options]",
+            $this->applicationTester->getDisplay()
+        );
+    }
+
+    public function testListEnabledNotifications()
+    {
+        $this->api->insertNotification('1', 'this should show', 'bar', 'warning', '25', 'persistent', '0');
+        $this->api->insertNotification('0', 'this should not show', 'bar', 'warning', '25', 'persistent', '0');
+        $code = $this->applicationTester->run([
+            'command' => 'rebelnotifications:list',
+            '--enabled' => true,
+        ]);
+
+        $this->assertEquals(0, $code);
+        $this->assertStringContainsStringIgnoringCase(
+            "this should show",
+            $this->applicationTester->getDisplay()
+        );
+        $this->assertStringNotContainsStringIgnoringCase(
+            "this should not show",
+            $this->applicationTester->getDisplay()
+        );
+    }
+
+    public function testListAllNotifications()
+    {
+        $this->api->insertNotification('0', 'this one is disabled', 'bar', 'warning', '25', 'persistent', '0');
+        $code = $this->applicationTester->run([
+            'command' => 'rebelnotifications:list',
+        ]);
+
+        $this->assertEquals(0, $code);
+        $this->assertStringContainsStringIgnoringCase(
+            "this one is disabled",
+            $this->applicationTester->getDisplay()
+        );
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "RebelNotifications",`
`3`	`3`	`"description": "Show Notifications to your users.",`
`4`		`- "version": "5.0.3",`
	`4`	`+ "version": "5.0.4",`
`5`	`5`	`"theme": false,`
`6`	`6`	`"require": {`
`7`	`7`	`"matomo": ">=5.0.0-stable,<6.0.0-b1"`