Refactor broadcast notifications (#1402)

* Refactor broadcast notifications * StyleCI fixes * Fix the planned_distance accidental changes
2022-02-08 15:07:02 -05:00
parent 6cfbd91328
commit cb38f2ad90
17 changed files with 290 additions and 119 deletions
@@ -0,0 +1,57 @@
+<?php
+
+namespace App\Notifications\Messages\Broadcast;
+
+use App\Contracts\Notification;
+use App\Models\News;
+use App\Notifications\Channels\Discord\DiscordMessage;
+use Illuminate\Contracts\Queue\ShouldQueue;
+
+class NewsAdded extends Notification implements ShouldQueue
+{
+    private $news;
+
+    public function __construct(News $news)
+    {
+        parent::__construct();
+
+        $this->news = $news;
+    }
+
+    public function via($notifiable)
+    {
+        return ['discord_webhook'];
+    }
+
+    /**
+     * @param News $news
+     *
+     * @return DiscordMessage|null
+     */
+    public function toDiscordChannel($news): ?DiscordMessage
+    {
+        $dm = new DiscordMessage();
+        return $dm->success()
+            ->title('News: '.$news->subject)
+            ->author([
+                'name'     => $news->user->ident.' - '.$news->user->name_private,
+                'url'      => '',
+                'icon_url' => $news->user->resolveAvatarUrl(),
+            ])
+            ->description($news->body);
+    }
+
+    /**
+     * Get the array representation of the notification.
+     *
+     * @param mixed $notifiable
+     *
+     * @return array
+     */
+    public function toArray($notifiable)
+    {
+        return [
+            'news_id' => $this->news->id,
+        ];
+    }
+}
@@ -0,0 +1,93 @@
+<?php
+
+namespace App\Notifications\Messages\Broadcast;
+
+use App\Contracts\Notification;
+use App\Models\Pirep;
+use App\Notifications\Channels\Discord\DiscordMessage;
+use App\Support\Units\Distance;
+use App\Support\Units\Time;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use PhpUnitsOfMeasure\Exception\NonNumericValue;
+use PhpUnitsOfMeasure\Exception\NonStringUnitName;
+
+class PirepFiled extends Notification implements ShouldQueue
+{
+    private $pirep;
+
+    /**
+     * Create a new notification instance.
+     *
+     * @param \App\Models\Pirep $pirep
+     */
+    public function __construct(Pirep $pirep)
+    {
+        parent::__construct();
+
+        $this->pirep = $pirep;
+    }
+
+    public function via($notifiable)
+    {
+        return ['discord_webhook'];
+    }
+
+    /**
+     * Send a Discord notification
+     *
+     * @param Pirep $pirep
+     *
+     * @return DiscordMessage|null
+     */
+    public function toDiscordChannel($pirep): ?DiscordMessage
+    {
+        $title = 'Flight '.$pirep->ident.' Filed';
+        $fields = [
+            'Flight'            => $pirep->ident,
+            'Departure Airport' => $pirep->dpt_airport_id,
+            'Arrival Airport'   => $pirep->arr_airport_id,
+            'Equipment'         => $pirep->aircraft->ident,
+            'Flight Time'       => Time::minutesToTimeString($pirep->flight_time),
+        ];
+
+        if ($pirep->distance) {
+            try {
+                $distance = new Distance(
+                    $pirep->distance,
+                    config('phpvms.internal_units.distance')
+                );
+
+                $pd = $distance[$distance->unit].' '.$distance->unit;
+                $fields['Distance'] = $pd;
+            } catch (NonNumericValue|NonStringUnitName $e) {
+            }
+        }
+
+        $dm = new DiscordMessage();
+        return $dm->success()
+            ->title($title)
+            ->description($pirep->user->discord_id ? 'Flight by <@'.$pirep->user->discord_id.'>' : '')
+            ->url(route('frontend.pireps.show', [$pirep->id]))
+            ->author([
+                'name'     => $pirep->user->ident.' - '.$pirep->user->name_private,
+                'url'      => route('frontend.profile.show', [$pirep->user_id]),
+                'icon_url' => $pirep->user->resolveAvatarUrl(),
+            ])
+            ->fields($fields);
+    }
+
+    /**
+     * Get the array representation of the notification.
+     *
+     * @param mixed $notifiable
+     *
+     * @return array
+     */
+    public function toArray($notifiable)
+    {
+        return [
+            'pirep_id' => $this->pirep->id,
+            'user_id'  => $this->pirep->user_id,
+        ];
+    }
+}
@@ -0,0 +1,102 @@
+<?php
+
+namespace App\Notifications\Messages\Broadcast;
+
+use App\Contracts\Notification;
+use App\Models\Pirep;
+use App\Notifications\Channels\Discord\DiscordMessage;
+use App\Notifications\Channels\Discord\DiscordWebhook;
+use App\Support\Units\Distance;
+use App\Support\Units\Time;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use PhpUnitsOfMeasure\Exception\NonNumericValue;
+use PhpUnitsOfMeasure\Exception\NonStringUnitName;
+
+/**
+ * Send the PIREP accepted message to a particular user, can also be sent to Discord
+ */
+class PirepPrefiled extends Notification implements ShouldQueue
+{
+    private $pirep;
+
+    /**
+     * Create a new notification instance.
+     *
+     * @param Pirep $pirep
+     */
+    public function __construct(Pirep $pirep)
+    {
+        parent::__construct();
+        $this->pirep = $pirep;
+    }
+
+    public function via($notifiable)
+    {
+        return [DiscordWebhook::class];
+    }
+
+    /**
+     * Send a Discord notification
+     *
+     * @param Pirep $pirep
+     *
+     * @return DiscordMessage|null
+     */
+    public function toDiscordChannel($pirep): ?DiscordMessage
+    {
+        if (empty(setting('notifications.discord_public_webhook_url'))) {
+            return null;
+        }
+
+        $title = 'Flight '.$pirep->ident.' Prefiled';
+        $fields = [
+            'Flight'                => $pirep->ident,
+            'Departure Airport'     => $pirep->dpt_airport_id,
+            'Arrival Airport'       => $pirep->arr_airport_id,
+            'Equipment'             => $pirep->aircraft->ident,
+            'Flight Time (Planned)' => Time::minutesToTimeString($pirep->planned_flight_time),
+        ];
+
+        if ($pirep->planned_distance) {
+            try {
+                $planned_distance = new Distance(
+                    $pirep->planned_distance,
+                    config('phpvms.internal_units.distance')
+                );
+
+                $pd = $planned_distance[$planned_distance->unit].' '.$planned_distance->unit;
+                $fields['Distance (Planned)'] = $pd;
+            } catch (NonNumericValue $e) {
+            } catch (NonStringUnitName $e) {
+            }
+        }
+
+        $dm = new DiscordMessage();
+        return $dm->webhook(setting('notifications.discord_public_webhook_url'))
+            ->success()
+            ->title($title)
+            ->description($pirep->user->discord_id ? 'Flight by <@'.$pirep->user->discord_id.'>' : '')
+            ->url(route('frontend.pireps.show', [$pirep->id]))
+            ->author([
+                'name'     => $pirep->user->ident.' - '.$pirep->user->name_private,
+                'url'      => route('frontend.profile.show', [$pirep->user_id]),
+                'icon_url' => $pirep->user->resolveAvatarUrl(),
+            ])
+            ->fields($fields);
+    }
+
+    /**
+     * Get the array representation of the notification.
+     *
+     * @param mixed $notifiable
+     *
+     * @return array
+     */
+    public function toArray($notifiable)
+    {
+        return [
+            'pirep_id' => $this->pirep->id,
+            'user_id'  => $this->pirep->user_id,
+        ];
+    }
+}
@@ -0,0 +1,139 @@
+<?php
+
+namespace App\Notifications\Messages\Broadcast;
+
+use App\Contracts\Notification;
+use App\Models\Enums\PirepStatus;
+use App\Models\Pirep;
+use App\Notifications\Channels\Discord\DiscordMessage;
+use App\Notifications\Channels\Discord\DiscordWebhook;
+use App\Support\Units\Distance;
+use App\Support\Units\Time;
+use function config;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use PhpUnitsOfMeasure\Exception\NonNumericValue;
+use PhpUnitsOfMeasure\Exception\NonStringUnitName;
+use function route;
+
+/**
+ * Send the PIREP accepted message to a particular user, can also be sent to Discord
+ */
+class PirepStatusChanged extends Notification implements ShouldQueue
+{
+    private $pirep;
+
+    // TODO: Int'l languages for these
+    protected static $verbs = [
+        PirepStatus::INITIATED     => 'is initialized',
+        PirepStatus::SCHEDULED     => 'is scheduled',
+        PirepStatus::BOARDING      => 'is boarding',
+        PirepStatus::RDY_START     => 'is ready for start',
+        PirepStatus::PUSHBACK_TOW  => 'is pushing back',
+        PirepStatus::DEPARTED      => 'has departed',
+        PirepStatus::RDY_DEICE     => 'is ready for de-icing',
+        PirepStatus::STRT_DEICE    => 'is de-icing',
+        PirepStatus::GRND_RTRN     => 'on ground return',
+        PirepStatus::TAXI          => 'is taxiing',
+        PirepStatus::TAKEOFF       => 'has taken off',
+        PirepStatus::INIT_CLIM     => 'in initial climb',
+        PirepStatus::AIRBORNE      => 'is enroute',
+        PirepStatus::ENROUTE       => 'is enroute',
+        PirepStatus::DIVERTED      => 'has diverted',
+        PirepStatus::APPROACH      => 'on approach',
+        PirepStatus::APPROACH_ICAO => 'on approach',
+        PirepStatus::ON_FINAL      => 'on final approach',
+        PirepStatus::LANDING       => 'is landing',
+        PirepStatus::LANDED        => 'has landed',
+        PirepStatus::ARRIVED       => 'has arrived',
+        PirepStatus::CANCELLED     => 'is cancelled',
+        PirepStatus::PAUSED        => 'is paused',
+        PirepStatus::EMERG_DESCENT => 'in emergency descent',
+    ];
+
+    /**
+     * Create a new notification instance.
+     *
+     * @param Pirep $pirep
+     */
+    public function __construct(Pirep $pirep)
+    {
+        parent::__construct();
+        $this->pirep = $pirep;
+    }
+
+    public function via($notifiable)
+    {
+        return [DiscordWebhook::class];
+    }
+
+    /**
+     * Send a Discord notification
+     *
+     * @param Pirep $pirep
+     *
+     * @return DiscordMessage|null
+     */
+    public function toDiscordChannel($pirep): ?DiscordMessage
+    {
+        $title = 'Flight '.$pirep->ident.' '.self::$verbs[$pirep->status];
+
+        $fields = [
+            'Flight'            => $pirep->ident,
+            'Departure Airport' => $pirep->dpt_airport_id,
+            'Arrival Airport'   => $pirep->arr_airport_id,
+            'Equipment'         => $pirep->aircraft->ident,
+            'Flight Time'       => Time::minutesToTimeString($pirep->flight_time),
+        ];
+
+        // Show the distance, but include the planned distance if it's been set
+        if ($pirep->distance) {
+            $unit = config('phpvms.internal_units.distance');
+
+            try {
+                $planned_distance = new Distance($pirep->distance, $unit);
+                $pd = $planned_distance[$planned_distance->unit];
+                $fields['Distance'] = $pd;
+
+                // Add the planned distance in
+                if ($pirep->planned_distance) {
+                    try {
+                        $planned_distance = new Distance($pirep->planned_distance, $unit);
+                        $pd = $planned_distance[$planned_distance->unit];
+                        $fields['Distance'] .= '/'.$pd;
+                    } catch (NonNumericValue|NonStringUnitName $e) {
+                    }
+                }
+
+                $fields['Distance'] .= ' '.$planned_distance->unit;
+            } catch (NonNumericValue|NonStringUnitName $e) {
+            }
+        }
+
+        $dm = new DiscordMessage();
+        return $dm->success()
+            ->title($title)
+            ->description($pirep->user->discord_id ? 'Flight by <@'.$pirep->user->discord_id.'>' : '')
+            ->url(route('frontend.pireps.show', [$pirep->id]))
+            ->author([
+                'name'     => $pirep->user->ident.' - '.$pirep->user->name_private,
+                'url'      => route('frontend.profile.show', [$pirep->user_id]),
+                'icon_url' => $pirep->user->resolveAvatarUrl(),
+            ])
+            ->fields($fields);
+    }
+
+    /**
+     * Get the array representation of the notification.
+     *
+     * @param mixed $notifiable
+     *
+     * @return array
+     */
+    public function toArray($notifiable)
+    {
+        return [
+            'pirep_id' => $this->pirep->id,
+            'user_id'  => $this->pirep->user_id,
+        ];
+    }
+}
@@ -0,0 +1,73 @@
+<?php
+
+namespace App\Notifications\Messages\Broadcast;
+
+use App\Contracts\Notification;
+use App\Models\User;
+use App\Notifications\Channels\Discord\DiscordMessage;
+use App\Notifications\Channels\MailChannel;
+use Illuminate\Contracts\Queue\ShouldQueue;
+
+/**
+ * Send a message to a Discord channel that a user was registered
+ */
+class UserRegistered extends Notification implements ShouldQueue
+{
+    use MailChannel;
+
+    private $user;
+
+    /**
+     * Create a new notification instance.
+     *
+     * @param \App\Models\User $user
+     */
+    public function __construct(User $user)
+    {
+        parent::__construct();
+
+        $this->user = $user;
+    }
+
+    /**
+     * @param $notifiable
+     *
+     * @return string[]
+     */
+    public function via($notifiable)
+    {
+        return ['discord_webhook'];
+    }
+
+    /**
+     * Send a Discord notification
+     *
+     * @param $notifiable
+     *
+     * @return DiscordMessage|null
+     */
+    public function toDiscordChannel($notifiable): ?DiscordMessage
+    {
+        $dm = new DiscordMessage();
+        return $dm->success()
+            ->title('New User Registered: '.$this->user->ident)
+            ->author([
+                'name'     => $this->user->ident.' - '.$this->user->name_private,
+                'url'      => '',
+                'icon_url' => $this->user->resolveAvatarUrl(),
+            ])
+            ->fields([]);
+    }
+
+    /**
+     * @param $notifiable
+     *
+     * @return array
+     */
+    public function toArray($notifiable)
+    {
+        return [
+            'user_id' => $this->user->id,
+        ];
+    }
+}