New: Option to include series image for Gotify notifications

Closes #4882
This commit is contained in:
Mark McDowall 2022-12-22 23:47:05 -08:00
parent ce0388ca99
commit e57e68c97a
4 changed files with 121 additions and 20 deletions

View File

@ -1,7 +1,11 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using FluentValidation.Results;
using NLog;
using NzbDrone.Core.MediaCover;
using NzbDrone.Core.Tv;
namespace NzbDrone.Core.Notifications.Gotify
{
@ -19,34 +23,34 @@ namespace NzbDrone.Core.Notifications.Gotify
public override string Name => "Gotify";
public override string Link => "https://gotify.net/";
public override void OnGrab(GrabMessage grabMessage)
public override void OnGrab(GrabMessage message)
{
_proxy.SendNotification(EPISODE_GRABBED_TITLE, grabMessage.Message, Settings);
SendNotification(EPISODE_GRABBED_TITLE, message.Message, message.Series);
}
public override void OnDownload(DownloadMessage message)
{
_proxy.SendNotification(EPISODE_DOWNLOADED_TITLE, message.Message, Settings);
SendNotification(EPISODE_DOWNLOADED_TITLE, message.Message, message.Series);
}
public override void OnEpisodeFileDelete(EpisodeDeleteMessage deleteMessage)
public override void OnEpisodeFileDelete(EpisodeDeleteMessage message)
{
_proxy.SendNotification(EPISODE_DELETED_TITLE, deleteMessage.Message, Settings);
SendNotification(EPISODE_DELETED_TITLE, message.Message, message.Series);
}
public override void OnSeriesDelete(SeriesDeleteMessage deleteMessage)
public override void OnSeriesDelete(SeriesDeleteMessage message)
{
_proxy.SendNotification(SERIES_DELETED_TITLE, deleteMessage.Message, Settings);
SendNotification(SERIES_DELETED_TITLE, message.Message, message.Series);
}
public override void OnHealthIssue(HealthCheck.HealthCheck healthCheck)
{
_proxy.SendNotification(HEALTH_ISSUE_TITLE, healthCheck.Message, Settings);
SendNotification(HEALTH_ISSUE_TITLE, healthCheck.Message, null);
}
public override void OnApplicationUpdate(ApplicationUpdateMessage updateMessage)
public override void OnApplicationUpdate(ApplicationUpdateMessage message)
{
_proxy.SendNotification(APPLICATION_UPDATE_TITLE, updateMessage.Message, Settings);
SendNotification(APPLICATION_UPDATE_TITLE, message.Message, null);
}
public override ValidationResult Test()
@ -55,10 +59,29 @@ namespace NzbDrone.Core.Notifications.Gotify
try
{
var isMarkdown = false;
const string title = "Test Notification";
const string body = "This is a test message from Sonarr";
_proxy.SendNotification(title, body, Settings);
var sb = new StringBuilder();
sb.AppendLine("This is a test message from Sonarr");
if (Settings.IncludeSeriesPoster)
{
isMarkdown = true;
sb.AppendLine("\r![](https://raw.githubusercontent.com/Sonarr/Sonarr/develop/Logo/128.png)");
}
var payload = new GotifyMessage
{
Title = title,
Message = sb.ToString(),
Priority = Settings.Priority
};
payload.SetContentType(isMarkdown);
_proxy.SendNotification(payload, Settings);
}
catch (Exception ex)
{
@ -68,5 +91,35 @@ namespace NzbDrone.Core.Notifications.Gotify
return new ValidationResult(failures);
}
private void SendNotification(string title, string message, Series series)
{
var isMarkdown = false;
var sb = new StringBuilder();
sb.AppendLine(message);
if (Settings.IncludeSeriesPoster && series != null)
{
var poster = series.Images.FirstOrDefault(x => x.CoverType == MediaCoverTypes.Poster)?.Url;
if (poster != null)
{
isMarkdown = true;
sb.AppendLine($"\r![]({poster})");
}
}
var payload = new GotifyMessage
{
Title = title,
Message = sb.ToString(),
Priority = Settings.Priority
};
payload.SetContentType(isMarkdown);
_proxy.SendNotification(payload, Settings);
}
}
}

View File

@ -0,0 +1,40 @@
using Newtonsoft.Json;
namespace NzbDrone.Core.Notifications.Gotify
{
public class GotifyMessage
{
public string Title { get; set; }
public string Message { get; set; }
public int Priority { get; set; }
public GotifyExtras Extras { get; set; }
public GotifyMessage()
{
Extras = new GotifyExtras();
}
public void SetContentType(bool isMarkdown)
{
var contentType = isMarkdown ? "text/markdown" : "text/plain";
Extras.ClientDisplay = new GotifyClientDisplay(contentType);
}
}
public class GotifyExtras
{
[JsonProperty("client::display")]
public GotifyClientDisplay ClientDisplay { get; set; }
}
public class GotifyClientDisplay
{
public string ContentType { get; set; }
public GotifyClientDisplay(string contentType)
{
ContentType = contentType;
}
}
}

View File

@ -1,11 +1,12 @@
using System.Net;
using NzbDrone.Common.Http;
using NzbDrone.Common.Serializer;
namespace NzbDrone.Core.Notifications.Gotify
{
public interface IGotifyProxy
{
void SendNotification(string title, string message, GotifySettings settings);
void SendNotification(GotifyMessage payload, GotifySettings settings);
}
public class GotifyProxy : IGotifyProxy
@ -17,16 +18,20 @@ namespace NzbDrone.Core.Notifications.Gotify
_httpClient = httpClient;
}
public void SendNotification(string title, string message, GotifySettings settings)
public void SendNotification(GotifyMessage payload, GotifySettings settings)
{
try
{
var request = new HttpRequestBuilder(settings.Server).Resource("message").Post()
.AddQueryParam("token", settings.AppToken)
.AddFormParameter("title", title)
.AddFormParameter("message", message)
.AddFormParameter("priority", settings.Priority)
.Build();
var request = new HttpRequestBuilder(settings.Server)
.Resource("message")
.Post()
.AddQueryParam("token", settings.AppToken)
.Build();
request.Headers.ContentType = "application/json";
var json = payload.ToJson();
request.SetContent(payload.ToJson());
_httpClient.Execute(request);
}

View File

@ -32,6 +32,9 @@ namespace NzbDrone.Core.Notifications.Gotify
[FieldDefinition(2, Label = "Priority", Type = FieldType.Select, SelectOptions = typeof(GotifyPriority), HelpText = "Priority of the notification")]
public int Priority { get; set; }
[FieldDefinition(3, Label = "Include Series Poster", Type = FieldType.Checkbox, HelpText = "Include series poster in message")]
public bool IncludeSeriesPoster { get; set; }
public NzbDroneValidationResult Validate()
{
return new NzbDroneValidationResult(Validator.Validate(this));