Discord notifications for PIREP and News events #433 (#1215)

* Discord notifications for events #433

* Style fixes

* Check for blank webhook urls and disable

* Cleanup items after review

* Changes and fixes

* Style fixes

* Don't load env for testing

* Fix status text

* Refactor saving fields/fares so events get the latest data

* Cleanup

* Style fixes
This commit is contained in:
Nabeel S
2021-06-04 10:51:59 -04:00
committed by GitHub
parent 17447c6903
commit 9b2e466b7e
46 changed files with 1249 additions and 456 deletions

View File

@@ -0,0 +1,36 @@
<?php
namespace App\Notifications\Channels\Discord;
use App\Contracts\Notification;
use App\Support\HttpClient;
use GuzzleHttp\Exception\RequestException;
use GuzzleHttp\Psr7;
use Illuminate\Support\Facades\Log;
class Discord
{
private $httpClient;
public function __construct(HttpClient $httpClient)
{
$this->httpClient = $httpClient;
}
public function send($notifiable, Notification $notification)
{
$message = $notification->toDiscordChannel($notifiable);
if ($message === null || empty($message->webhook_url)) {
Log::debug('Discord notifications not configured, skipping');
return;
}
try {
$data = $message->toArray();
$this->httpClient->post($message->webhook_url, $data);
} catch (RequestException $e) {
$response = Psr7\Message::toString($e->getResponse());
Log::error('Error sending Discord notification: '.$e->getMessage().', '.$response);
}
}
}

View File

@@ -0,0 +1,140 @@
<?php
namespace App\Notifications\Channels\Discord;
use Carbon\Carbon;
/**
* Original is from https://gist.github.com/freekmurze/e4415090f650e070d3de8b905875cf78
*
* Markdown guide: https://birdie0.github.io/discord-webhooks-guide/other/discord_markdown.html
*/
class DiscordMessage
{
const COLOR_SUCCESS = '#0B6623';
const COLOR_WARNING = '#FD6A02';
const COLOR_ERROR = '#ED2939';
public $webhook_url;
protected $title;
protected $url;
protected $description;
protected $timestamp;
protected $footer;
protected $color;
protected $author = [];
protected $fields = [];
/**
* Supply the webhook URL that this should be going to
*/
public function webhook(string $url): self
{
$this->webhook_url = $url;
return $this;
}
/**
* Title of the notification
*/
public function title(string $title): self
{
$this->title = $title;
return $this;
}
public function url(string $url): self
{
$this->url = $url;
return $this;
}
/**
* @param array|string $descriptionLines
*/
public function description($descriptionLines): self
{
if (!is_array($descriptionLines)) {
$descriptionLines = [$descriptionLines];
}
$this->description = implode(PHP_EOL, $descriptionLines);
return $this;
}
/**
* Set the author information:
* [
* 'name' => '',
* 'url' => '',
* 'icon_url' => '',
*/
public function author(array $author): self
{
$this->author = $author;
return $this;
}
/**
* Set the fields
*/
public function fields(array $fields): self
{
$this->fields = [];
foreach ($fields as $name => $value) {
$this->fields[] = [
'name' => '**'.$name.'**', // bold
'value' => $value,
'inline' => true,
];
}
return $this;
}
public function footer(string $footer): self
{
$this->footer = $footer;
return $this;
}
public function success(): self
{
$this->color = static::COLOR_SUCCESS;
return $this;
}
public function warning(): self
{
$this->color = static::COLOR_WARNING;
return $this;
}
public function error(): self
{
$this->color = static::COLOR_ERROR;
return $this;
}
public function toArray(): array
{
return [
'embeds' => [
[
'title' => $this->title,
'url' => $this->url,
'type' => 'rich',
'description' => $this->description,
// 'color' => hexdec($this->color),
'author' => $this->author,
'fields' => $this->fields,
'footer' => [
'text' => $this->footer ?? '',
],
'timestamp' => Carbon::now('UTC'),
],
],
];
}
}

View File

@@ -17,7 +17,7 @@ trait MailChannel
* @param string $template Markdown template to use
* @param array $args Arguments to pass to the template
*/
public function setMailable($subject, $template, $args)
public function setMailable(string $subject, string $template, array $args)
{
$this->mailSubject = $subject;
$this->mailTemplate = $template;

View File

@@ -4,17 +4,15 @@ namespace App\Notifications\Messages;
use App\Contracts\Notification;
use App\Models\User;
use App\Notifications\Channels\Discord\Discord;
use App\Notifications\Channels\Discord\DiscordMessage;
use App\Notifications\Channels\MailChannel;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
class AdminUserRegistered extends Notification implements ShouldQueue
{
use Queueable;
use MailChannel;
public $channels = ['mail'];
private $user;
/**
@@ -34,6 +32,32 @@ class AdminUserRegistered extends Notification implements ShouldQueue
);
}
public function via($notifiable)
{
return ['mail', Discord::class];
}
/**
* Send a Discord notification
*
* @param User $pirep
* @param mixed $user
*
* @return DiscordMessage|null
*/
public function toDiscordChannel($user): ?DiscordMessage
{
if (empty(setting('notifications.discord_private_webhook_url'))) {
return null;
}
$dm = new DiscordMessage();
return $dm->webhook(setting('notifications.discord_private_webhook_url'))
->success()
->title('New User Registered: '.$user->ident)
->fields([]);
}
public function toArray($notifiable)
{
return [

View File

@@ -4,16 +4,15 @@ namespace App\Notifications\Messages;
use App\Contracts\Notification;
use App\Models\News;
use App\Notifications\Channels\Discord\Discord;
use App\Notifications\Channels\Discord\DiscordMessage;
use App\Notifications\Channels\MailChannel;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
class NewsAdded extends Notification implements ShouldQueue
{
use Queueable;
use MailChannel;
public $channels = ['mail'];
public $requires_opt_in = true;
private $news;
@@ -30,6 +29,34 @@ class NewsAdded extends Notification implements ShouldQueue
);
}
public function via($notifiable)
{
return ['mail', Discord::class];
}
/**
* @param News $news
*
* @return DiscordMessage|null
*/
public function toDiscordChannel($news): ?DiscordMessage
{
if (empty(setting('notifications.discord_public_webhook_url'))) {
return null;
}
$dm = new DiscordMessage();
return $dm->webhook(setting('notifications.discord_public_webhook_url'))
->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.
*

View File

@@ -5,19 +5,15 @@ namespace App\Notifications\Messages;
use App\Contracts\Notification;
use App\Models\Pirep;
use App\Notifications\Channels\MailChannel;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
/**
* Send the PIREP accepted message to a particular user
* Send the PIREP accepted message to a particular user, can also be sent to Discord
*/
class PirepAccepted extends Notification implements ShouldQueue
{
use Queueable;
use MailChannel;
public $channels = ['mail'];
private $pirep;
/**
@@ -38,6 +34,11 @@ class PirepAccepted extends Notification implements ShouldQueue
);
}
public function via($notifiable)
{
return ['mail'];
}
/**
* Get the array representation of the notification.
*

View File

@@ -0,0 +1,102 @@
<?php
namespace App\Notifications\Messages;
use App\Contracts\Notification;
use App\Models\Pirep;
use App\Notifications\Channels\Discord\Discord;
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;
/**
* 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 [Discord::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->airline->code.$pirep->ident.' Prefiled';
$fields = [
'Flight' => $pirep->airline->code.$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.pireps.show', [$pirep->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,
];
}
}

View File

@@ -5,22 +5,18 @@ namespace App\Notifications\Messages;
use App\Contracts\Notification;
use App\Models\Pirep;
use App\Notifications\Channels\MailChannel;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
class PirepRejected extends Notification implements ShouldQueue
{
use Queueable;
use MailChannel;
public $channels = ['mail'];
private $pirep;
/**
* Create a new notification instance.
*
* @param \App\Models\Pirep $pirep
* @param Pirep $pirep
*/
public function __construct(Pirep $pirep)
{
@@ -35,6 +31,11 @@ class PirepRejected extends Notification implements ShouldQueue
);
}
public function via($notifiable)
{
return ['mail'];
}
/**
* Get the array representation of the notification.
*

View File

@@ -0,0 +1,141 @@
<?php
namespace App\Notifications\Messages;
use App\Contracts\Notification;
use App\Models\Enums\PirepStatus;
use App\Models\Pirep;
use App\Notifications\Channels\Discord\Discord;
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;
/**
* 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 => 'has cancelled',
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 [Discord::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->airline->code.$pirep->ident.' '.self::$verbs[$pirep->status];
$fields = [
'Flight' => $pirep->airline->code.$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->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.pireps.show', [$pirep->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,
];
}
}

View File

@@ -4,17 +4,19 @@ namespace App\Notifications\Messages;
use App\Contracts\Notification;
use App\Models\Pirep;
use App\Notifications\Channels\Discord\Discord;
use App\Notifications\Channels\Discord\DiscordMessage;
use App\Notifications\Channels\MailChannel;
use Illuminate\Bus\Queueable;
use App\Support\Units\Distance;
use App\Support\Units\Time;
use Illuminate\Contracts\Queue\ShouldQueue;
use PhpUnitsOfMeasure\Exception\NonNumericValue;
use PhpUnitsOfMeasure\Exception\NonStringUnitName;
class PirepSubmitted extends Notification implements ShouldQueue
{
use Queueable;
use MailChannel;
public $channels = ['mail'];
private $pirep;
/**
@@ -35,6 +37,60 @@ class PirepSubmitted extends Notification implements ShouldQueue
);
}
public function via($notifiable)
{
return ['mail', Discord::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->airline->code.$pirep->ident.' Filed';
$fields = [
'Flight' => $pirep->airline->code.$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 | 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.pireps.show', [$pirep->id]),
'icon_url' => $pirep->user->resolveAvatarUrl(),
])
->fields($fields);
}
/**
* Get the array representation of the notification.
*

View File

@@ -5,20 +5,16 @@ namespace App\Notifications\Messages;
use App\Contracts\Notification;
use App\Models\User;
use App\Notifications\Channels\MailChannel;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
class UserPending extends Notification implements ShouldQueue
{
use Queueable;
use MailChannel;
public $channels = ['mail'];
private $user;
/**
* @param \App\Models\User $user
* @param User $user
*/
public function __construct(User $user)
{
@@ -33,6 +29,11 @@ class UserPending extends Notification implements ShouldQueue
);
}
public function via($notifiable)
{
return ['mail'];
}
/**
* Get the array representation of the notification.
*

View File

@@ -5,22 +5,18 @@ namespace App\Notifications\Messages;
use App\Contracts\Notification;
use App\Models\User;
use App\Notifications\Channels\MailChannel;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
class UserRegistered extends Notification implements ShouldQueue
{
use Queueable;
use MailChannel;
public $channels = ['mail'];
private $user;
/**
* Create a new notification instance.
*
* @param \App\Models\User $user
* @param User $user
*/
public function __construct(User $user)
{
@@ -35,6 +31,11 @@ class UserRegistered extends Notification implements ShouldQueue
);
}
public function via($notifiable)
{
return ['mail'];
}
public function toArray($notifiable)
{
return [

View File

@@ -13,8 +13,6 @@ class UserRejected extends Notification implements ShouldQueue
use Queueable;
use MailChannel;
public $channels = ['mail'];
private $user;
/**
@@ -33,6 +31,11 @@ class UserRejected extends Notification implements ShouldQueue
);
}
public function via($notifiable)
{
return ['mail'];
}
/**
* Get the array representation of the notification.
*

View File

@@ -6,13 +6,13 @@ use App\Contracts\Listener;
use App\Events\NewsAdded;
use App\Events\PirepAccepted;
use App\Events\PirepFiled;
use App\Events\PirepPrefiled;
use App\Events\PirepRejected;
use App\Events\PirepStatusChange;
use App\Events\UserRegistered;
use App\Events\UserStateChanged;
use App\Models\Enums\UserState;
use App\Models\User;
use App\Notifications\Messages\PirepSubmitted;
use App\Notifications\Messages\UserPending;
use App\Notifications\Messages\UserRejected;
use App\Notifications\Notifiables\Broadcast;
use Exception;
@@ -23,17 +23,19 @@ use Illuminate\Support\Facades\Notification;
/**
* Listen for different events and map them to different notifications
*/
class EventHandler extends Listener
class NotificationEventsHandler extends Listener
{
private static $broadcastNotifyable;
public static $callbacks = [
NewsAdded::class => 'onNewsAdded',
PirepAccepted::class => 'onPirepAccepted',
PirepFiled::class => 'onPirepFile',
PirepRejected::class => 'onPirepRejected',
UserRegistered::class => 'onUserRegister',
UserStateChanged::class => 'onUserStateChange',
NewsAdded::class => 'onNewsAdded',
PirepPrefiled::class => 'onPirepPrefile',
PirepStatusChange::class => 'onPirepStatusChange',
PirepAccepted::class => 'onPirepAccepted',
PirepFiled::class => 'onPirepFile',
PirepRejected::class => 'onPirepRejected',
UserRegistered::class => 'onUserRegister',
UserStateChanged::class => 'onUserStateChange',
];
public function __construct()
@@ -56,7 +58,8 @@ class EventHandler extends Listener
}
try {
Notification::send([$user], $notification);
$this->notifyUser($user, $notification);
// Notification::send([$user], $notification);
} catch (Exception $e) {
Log::emergency('Error emailing admin ('.$user->email.'). Error='.$e->getMessage());
}
@@ -117,19 +120,24 @@ class EventHandler extends Listener
.$event->user->ident.' is '
.UserState::label($event->user->state).', sending active email');
/*
* Send all of the admins a notification that a new user registered
*/
$this->notifyAdmins(new Messages\AdminUserRegistered($event->user));
/*
* Send the user a confirmation email
*/
if ($event->user->state === UserState::ACTIVE) {
$this->notifyUser($event->user, new Messages\UserRegistered($event->user));
} elseif ($event->user->state === UserState::PENDING) {
$this->notifyUser($event->user, new UserPending($event->user));
$this->notifyUser($event->user, new Messages\UserPending($event->user));
}
/*
* Send all of the admins a notification that a new user registered
*/
$this->notifyAdmins(new Messages\AdminUserRegistered($event->user));
/**
* Discord and other notifications
*/
Notification::send([$event->user], new Messages\AdminUserRegistered($event->user));
}
/**
@@ -152,15 +160,34 @@ class EventHandler extends Listener
}
}
/**
* Prefile notification
*/
public function onPirepPrefile(PirepPrefiled $event): void
{
Log::info('NotificationEvents::onPirepPrefile: '.$event->pirep->id.' prefiled');
Notification::send([$event->pirep], new Messages\PirepPrefiled($event->pirep));
}
/**
* Status Change notification
*/
public function onPirepStatusChange(PirepStatusChange $event): void
{
Log::info('NotificationEvents::onPirepStatusChange: '.$event->pirep->id.' prefiled');
Notification::send([$event->pirep], new Messages\PirepStatusChanged($event->pirep));
}
/**
* Notify the admins that a new PIREP has been filed
*
* @param \App\Events\PirepFiled $event
* @param PirepFiled $event
*/
public function onPirepFile(PirepFiled $event): void
{
Log::info('NotificationEvents::onPirepFile: '.$event->pirep->id.' filed ');
$this->notifyAdmins(new PirepSubmitted($event->pirep));
Log::info('NotificationEvents::onPirepFile: '.$event->pirep->id.' filed');
$this->notifyAdmins(new Messages\PirepSubmitted($event->pirep));
Notification::send([$event->pirep], new Messages\PirepSubmitted($event->pirep));
}
/**
@@ -194,5 +221,6 @@ class EventHandler extends Listener
{
Log::info('NotificationEvents::onNewsAdded');
$this->notifyAllUsers(new Messages\NewsAdded($event->news));
Notification::send([$event->news], new Messages\NewsAdded($event->news));
}
}