Expand settings for notifications.

app/Notifications/Admin/UserInvitation.php

@@ -107,6 +107,9 @@ class UserInvitation extends Notification
      */
     public function via($notifiable)
     {
+
+
+
         $slackUrl = app('fireflyconfig')->get('slack_webhook_url', '')->data;
         if (UrlValidator::isValidWebhookURL($slackUrl)) {
             return ['mail', 'slack'];

app/Notifications/Notifiables/OwnerNotifiable.php

@@ -0,0 +1,70 @@
+<?php
+/*
+ * AdminNotifiable.php
+ * Copyright (c) 2024 james@firefly-iii.org.
+ *
+ * This file is part of Firefly III (https://github.com/firefly-iii).
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see https://www.gnu.org/licenses/.
+ */
+
+declare(strict_types=1);
+
+namespace FireflyIII\Notifications\Notifiables;
+
+use Illuminate\Notifications\Notification;
+use Illuminate\Support\Str;
+use NotificationChannels\Pushover\PushoverReceiver;
+
+class OwnerNotifiable
+{
+
+    public function routeNotificationForSlack(): string
+    {
+        $res = app('fireflyconfig')->getEncrypted('slack_webhook_url', '')->data;
+        if (is_array($res)) {
+            $res = '';
+        }
+        return (string) $res;
+    }
+
+    public function routeNotificationForPushover()
+    {
+        $pushoverAppToken  = (string) app('fireflyconfig')->getEncrypted('pushover_app_token', '')->data;
+        $pushoverUserToken = (string) app('fireflyconfig')->getEncrypted('pushover_user_token', '')->data;
+        return PushoverReceiver::withUserKey($pushoverUserToken)
+                               ->withApplicationToken($pushoverAppToken);
+    }
+
+    /**
+     * Get the notification routing information for the given driver.
+     *
+     * @param string            $driver
+     * @param null|Notification $notification
+     *
+     * @return mixed
+     */
+    public function routeNotificationFor($driver, $notification = null)
+    {
+        $method = 'routeNotificationFor' . Str::studly($driver);
+        if (method_exists($this, $method)) {
+            return $this->{$method}($notification); // @phpstan-ignore-line
+        }
+
+        return match ($driver) {
+            'mail'  => (string) config('firefly.site_owner'),
+            default => null,
+        };
+    }
+}

app/Notifications/ReturnsAvailableChannels.php

@@ -0,0 +1,46 @@
+<?php
+/*
+ * ReturnsAvailableChannels.php
+ * Copyright (c) 2024 james@firefly-iii.org.
+ *
+ * This file is part of Firefly III (https://github.com/firefly-iii).
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see https://www.gnu.org/licenses/.
+ */
+
+declare(strict_types=1);
+
+namespace FireflyIII\Notifications;
+
+use FireflyIII\Support\Notifications\UrlValidator;
+
+class ReturnsAvailableChannels
+{
+    public static function returnChannels(string $type): array {
+        $channels = ['mail'];
+
+        if('owner' === $type) {
+            $slackUrl = app('fireflyconfig')->get('slack_webhook_url', '')->data;
+            if (UrlValidator::isValidWebhookURL($slackUrl)) {
+                $channels[] = 'slack';
+            }
+            // only the owner can get notifications over
+        }
+
+
+
+        return $channels;
+    }
+
+}

app/Notifications/ReturnsSettings.php

@@ -0,0 +1,60 @@
+<?php
+/*
+ * ReturnsSettings.php
+ * Copyright (c) 2024 james@firefly-iii.org.
+ *
+ * This file is part of Firefly III (https://github.com/firefly-iii).
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see https://www.gnu.org/licenses/.
+ */
+
+declare(strict_types=1);
+
+namespace FireflyIII\Notifications;
+
+use FireflyIII\Exceptions\FireflyException;
+use FireflyIII\Support\Facades\FireflyConfig;
+use FireflyIII\User;
+
+class ReturnsSettings
+{
+    public static function getSettings(string $channel, string $type, ?User $user): array
+    {
+        if ('ntfy' === $channel) {
+            return self::getNtfySettings($type, $user);
+        }
+        throw new FireflyException(sprintf('Cannot handle channel "%s"', $channel));
+    }
+
+    private static function getNtfySettings(string $type, ?User $user)
+    {
+        $settings = [
+            'ntfy_server' => 'https://ntfy.sh',
+            'ntfy_topic'  => '',
+            'ntfy_auth'   => false,
+            'ntfy_user'   => '',
+            'ntfy_pass'   => '',
+
+        ];
+        if ('owner' === $type) {
+            $settings['ntfy_server'] = FireflyConfig::getEncrypted('ntfy_server', 'https://ntfy.sh')->data;
+            $settings['ntfy_topic']  = FireflyConfig::getEncrypted('ntfy_topic', '')->data;
+            $settings['ntfy_auth']   = FireflyConfig::get('ntfy_auth', false)->data;
+            $settings['ntfy_user']   = FireflyConfig::getEncrypted('ntfy_user', '')->data;
+            $settings['ntfy_pass']   = FireflyConfig::getEncrypted('ntfy_pass', '')->data;
+        }
+        return $settings;
+    }
+
+}

app/Notifications/Test/TestNotificationEmail.php

@@ -24,6 +24,7 @@ declare(strict_types=1);
 
 namespace FireflyIII\Notifications\Test;
 
+use FireflyIII\Notifications\Notifiables\OwnerNotifiable;
 use Illuminate\Bus\Queueable;
 use Illuminate\Notifications\Messages\MailMessage;
 use Illuminate\Notifications\Notification;
@@ -35,26 +36,26 @@ class TestNotificationEmail extends Notification
 {
     use Queueable;
 
-    private string $address;
+    private OwnerNotifiable $owner;
 
     /**
      * Create a new notification instance.
      */
-    public function __construct(string $address)
+    public function __construct(OwnerNotifiable $owner)
     {
-        $this->address = $address;
+        $this->owner = $owner;
     }
 
     /**
      * Get the array representation of the notification.
      *
-     * @param mixed $notifiable
+     * @param OwnerNotifiable $notifiable
      *
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      *
      * @return array
      */
-    public function toArray($notifiable)
+    public function toArray(OwnerNotifiable $notifiable)
     {
         return [
         ];
@@ -69,23 +70,14 @@ class TestNotificationEmail extends Notification
      *
      * @return MailMessage
      */
-    public function toMail($notifiable)
+    public function toMail(OwnerNotifiable $notifiable)
     {
+        $address = (string) config('firefly.site_owner');
         return (new MailMessage())
-            ->markdown('emails.admin-test', ['email' => $this->address])
+            ->markdown('emails.admin-test', ['email' => $address])
             ->subject((string) trans('email.admin_test_subject'));
     }
 
-    /**
-     * Get the Slack representation of the notification.
-     *
-     * @param mixed $notifiable
-     *
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
-     *
-     */
-    public function toSlack($notifiable) {}
-
     /**
      * Get the notification's delivery channels.
      *
@@ -95,7 +87,7 @@ class TestNotificationEmail extends Notification
      *
      * @return array
      */
-    public function via($notifiable)
+    public function via(OwnerNotifiable $notifiable)
     {
         return ['mail'];
     }

app/Notifications/Test/TestNotificationNtfy.php

@@ -24,9 +24,10 @@ declare(strict_types=1);
 
 namespace FireflyIII\Notifications\Test;
 
+use FireflyIII\Notifications\Notifiables\OwnerNotifiable;
+use FireflyIII\Notifications\ReturnsSettings;
+use FireflyIII\User;
 use Illuminate\Bus\Queueable;
-use Illuminate\Notifications\Messages\MailMessage;
-use Illuminate\Notifications\Messages\SlackMessage;
 use Illuminate\Notifications\Notification;
 use Ntfy\Message;
 use Wijourdil\NtfyNotificationChannel\Channels\NtfyChannel;
@@ -40,14 +41,14 @@ class TestNotificationNtfy extends Notification
 {
     use Queueable;
 
-    private string $address;
+    public OwnerNotifiable $owner;
 
     /**
      * Create a new notification instance.
      */
-    public function __construct(string $address)
+    public function __construct(OwnerNotifiable $owner)
     {
-        $this->address = $address;
+        $this->owner = $owner;
     }
 
     /**
@@ -66,51 +67,34 @@ class TestNotificationNtfy extends Notification
     }
 
 
-    public function toNtfy(mixed $notifiable): Message
+    public function toNtfy(OwnerNotifiable $notifiable): Message
     {
+        $settings = ReturnsSettings::getSettings('ntfy', 'owner', null);
+
+        // overrule config.
+        config(['ntfy-notification-channel.server' => $settings['ntfy_server']]);
+        config(['ntfy-notification-channel.topic' => $settings['ntfy_topic']]);
+
+        if ($settings['ntfy_auth']) {
+            // overrule auth as well.
+            config(['ntfy-notification-channel.authentication.enabled' => true]);
+            config(['ntfy-notification-channel.authentication.username' => $settings['ntfy_user']]);
+            config(['ntfy-notification-channel.authentication.password' => $settings['ntfy_pass']]);
+        }
+
         $message = new Message();
-        $message->topic(config('ntfy-notification-channel.topic'));
-        $message->title((string)trans('email.admin_test_subject'));
-        $message->body((string)trans('email.admin_test_message', ['channel' => 'ntfy']));
-        $message->tags(['white_check_mark', 'ok_hand']);
+        $message->topic($settings['ntfy_topic']);
+        $message->title((string) trans('email.admin_test_subject'));
+        $message->body((string) trans('email.admin_test_message', ['channel' => 'ntfy']));
+        $message->tags(['white_check_mark']);
 
         return $message;
     }
 
     /**
-     * Get the mail representation of the notification.
-     *
-     * @param mixed $notifiable
-     *
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
-     *
-     * @return MailMessage
      */
-    public function toMail($notifiable)
-    {
-    }
-
-    /**
-     * Get the Slack representation of the notification.
-     *
-     * @param mixed $notifiable
-     *
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
-     *
-     */
-    public function toSlack($notifiable) {
-    }
-
-    /**
-     * Get the notification's delivery channels.
-     *
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
-     *
-     * @param mixed $notifiable
-     *
-     * @return array
-     */
-    public function via($notifiable)
+    public function via(OwnerNotifiable $notifiable)
     {
         return [NtfyChannel::class];
     }

app/Notifications/Test/TestNotificationPushover.php

@@ -24,6 +24,8 @@ declare(strict_types=1);
 
 namespace FireflyIII\Notifications\Test;
 
+use FireflyIII\Notifications\Notifiables\OwnerNotifiable;
+use FireflyIII\User;
 use Illuminate\Bus\Queueable;
 use Illuminate\Notifications\Messages\MailMessage;
 use Illuminate\Notifications\Notification;
@@ -42,73 +44,45 @@ class TestNotificationPushover extends Notification
 {
     use Queueable;
 
-    private string $address;
+    private OwnerNotifiable $owner;
 
     /**
      * Create a new notification instance.
      */
-    public function __construct(string $address)
+    public function __construct(OwnerNotifiable $owner)
     {
-        $this->address = $address;
+        $this->owner = $owner;
     }
 
     /**
      * Get the array representation of the notification.
      *
-     * @param mixed $notifiable
+     * @param OwnerNotifiable $notifiable
      *
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      *
      * @return array
      */
-    public function toArray($notifiable)
+    public function toArray(OwnerNotifiable $notifiable)
     {
         return [
         ];
     }
 
 
-    public function toPushover(mixed $notifiable): PushoverMessage
+    public function toPushover(OwnerNotifiable $notifiable): PushoverMessage
     {
         Log::debug('Now in toPushover()');
+
         return PushoverMessage::create((string)trans('email.admin_test_message', ['channel' => 'Pushover']))
                               ->title((string)trans('email.admin_test_subject'));
     }
 
-    /**
-     * Get the mail representation of the notification.
-     *
-     * @param mixed $notifiable
-     *
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
-     *
-     * @return MailMessage
-     */
-    public function toMail($notifiable)
-    {
-    }
 
     /**
-     * Get the Slack representation of the notification.
-     *
-     * @param mixed $notifiable
-     *
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
-     *
      */
-    public function toSlack($notifiable) {
-    }
-
-    /**
-     * Get the notification's delivery channels.
-     *
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
-     *
-     * @param mixed $notifiable
-     *
-     * @return array
-     */
-    public function via($notifiable)
+    public function via(OwnerNotifiable $notifiable)
     {
         return [PushoverChannel::class];
     }

app/Notifications/Test/TestNotificationSlack.php

@@ -24,11 +24,14 @@ declare(strict_types=1);
 
 namespace FireflyIII\Notifications\Test;
 
+use FireflyIII\Notifications\Notifiables\OwnerNotifiable;
+use FireflyIII\User;
 use Illuminate\Bus\Queueable;
-use Illuminate\Notifications\Messages\MailMessage;
-use Illuminate\Notifications\Messages\SlackMessage;
 use Illuminate\Notifications\Notification;
 //use Illuminate\Notifications\Slack\SlackMessage;
+use Illuminate\Support\Facades\Log;
+
+use Illuminate\Notifications\Messages\SlackMessage;
 
 /**
  * Class TestNotification
@@ -37,64 +40,49 @@ class TestNotificationSlack extends Notification
 {
     use Queueable;
 
-    private string $address;
+    private OwnerNotifiable $owner;
 
     /**
      * Create a new notification instance.
      */
-    public function __construct(string $address)
+    public function __construct(OwnerNotifiable $owner)
     {
-        $this->address = $address;
+        $this->owner =$owner;
     }
 
     /**
      * Get the array representation of the notification.
      *
-     * @param mixed $notifiable
+     * @param OwnerNotifiable $notifiable
      *
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      *
      * @return array
      */
-    public function toArray($notifiable)
+    public function toArray(OwnerNotifiable $notifiable)
     {
         return [
         ];
     }
 
-    /**
-     * Get the mail representation of the notification.
-     *
-     * @param mixed $notifiable
-     *
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
-     *
-     * @return MailMessage
-     */
-    public function toMail($notifiable)
-    {
-    }
-
     /**
      * Get the Slack representation of the notification.
      *
-     * @param mixed $notifiable
+     * @param OwnerNotifiable $notifiable
      *
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      *
      */
-    public function toSlack($notifiable) {
-
+    public function toSlack(OwnerNotifiable $notifiable)
+    {
         // since it's an admin notification, grab the URL from fireflyconfig
-        $url = app('fireflyconfig')->get('slack_webhook_url', '')->data;
-
-//        return (new SlackMessage)
-//            ->text((string)trans('email.admin_test_subject'))
-//            ->to($url);
-        return (new SlackMessage())
-            ->content((string)trans('email.admin_test_subject'))
-            ->to($url);
+        $url = app('fireflyconfig')->getEncrypted('slack_webhook_url', '')->data;
+        if ('' !== $url) {
+            return new SlackMessage()->content((string)trans('email.admin_test_subject'))->to($url);
+            //return new SlackMessage()->text((string) trans('email.admin_test_subject'))->to($url);
 
+        }
+        Log::error('Empty slack URL, cannot send notification.');
     }
 
     /**
@@ -102,11 +90,11 @@ class TestNotificationSlack extends Notification
      *
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      *
-     * @param mixed $notifiable
+     * @param OwnerNotifiable $notifiable
      *
      * @return array
      */
-    public function via($notifiable)
+    public function via(OwnerNotifiable $notifiable)
     {
         return ['slack'];
     }