mirror of
https://github.com/Radarr/Radarr
synced 2024-12-25 17:27:59 +00:00
Join: Device ID entry and better error handling
New: Optionally limit Join notifications to specific devices Fixes #1455
This commit is contained in:
parent
edc1e0b8d1
commit
c0b0567c23
4 changed files with 76 additions and 24 deletions
|
@ -0,0 +1,16 @@
|
|||
using System;
|
||||
using NzbDrone.Common.Exceptions;
|
||||
|
||||
namespace NzbDrone.Core.Notifications.Join
|
||||
{
|
||||
public class JoinInvalidDeviceException : JoinException
|
||||
{
|
||||
public JoinInvalidDeviceException(string message) : base(message)
|
||||
{
|
||||
}
|
||||
|
||||
public JoinInvalidDeviceException(string message, Exception innerException, params object[] args) : base(message, innerException, args)
|
||||
{
|
||||
}
|
||||
}
|
||||
}
|
|
@ -36,7 +36,7 @@ public void SendNotification(string title, string message, JoinSettings settings
|
|||
catch (JoinException ex)
|
||||
{
|
||||
_logger.Error(ex, "Unable to send Join message.");
|
||||
throw new JoinException("Unable to send Join notifications. " + ex.Message);
|
||||
throw ex;
|
||||
}
|
||||
}
|
||||
|
||||
|
@ -50,46 +50,77 @@ public ValidationFailure Test(JoinSettings settings)
|
|||
SendNotification(title, body, settings);
|
||||
return null;
|
||||
}
|
||||
catch(JoinInvalidDeviceException ex)
|
||||
{
|
||||
_logger.Error(ex, "Unable to send test Join message. Invalid Device IDs supplied.");
|
||||
return new ValidationFailure("DeviceIds", "Device IDs appear invalid.");
|
||||
}
|
||||
catch (JoinException ex)
|
||||
{
|
||||
_logger.Error(ex, "Unable to send test Join message.");
|
||||
return new ValidationFailure("APIKey", ex.Message);
|
||||
return new ValidationFailure("ApiKey", ex.Message);
|
||||
}
|
||||
catch(RestException ex)
|
||||
{
|
||||
_logger.Error(ex, "Unable to send test Join message. Server connection failed.");
|
||||
return new ValidationFailure("ApiKey", "Unable to connect to Join API. Please try again later.");
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
_logger.Error(ex, "Unable to send test Join message. Unknown error.");
|
||||
return new ValidationFailure("ApiKey", ex.Message);
|
||||
}
|
||||
}
|
||||
|
||||
private void SendNotification(string title, string message, RestRequest request, JoinSettings settings)
|
||||
{
|
||||
try
|
||||
|
||||
var client = RestClientFactory.BuildClient(URL);
|
||||
|
||||
if (!string.IsNullOrEmpty(settings.DeviceIds))
|
||||
{
|
||||
request.AddParameter("deviceIds", settings.DeviceIds);
|
||||
}
|
||||
else
|
||||
{
|
||||
var client = RestClientFactory.BuildClient(URL);
|
||||
|
||||
request.AddParameter("deviceId", "group.all");
|
||||
request.AddParameter("apikey", settings.APIKey);
|
||||
request.AddParameter("title", title);
|
||||
request.AddParameter("text", message);
|
||||
request.AddParameter("icon", "https://cdn.rawgit.com/Sonarr/Sonarr/develop/Logo/256.png"); // Use the Sonarr logo.
|
||||
}
|
||||
|
||||
request.AddParameter("apikey", settings.ApiKey);
|
||||
request.AddParameter("title", title);
|
||||
request.AddParameter("text", message);
|
||||
request.AddParameter("icon", "https://cdn.rawgit.com/Sonarr/Sonarr/develop/Logo/256.png"); // Use the Sonarr logo.
|
||||
|
||||
var response = client.ExecuteAndValidate(request);
|
||||
var res = Json.Deserialize<JoinResponseModel>(response.Content);
|
||||
var response = client.ExecuteAndValidate(request);
|
||||
var res = Json.Deserialize<JoinResponseModel>(response.Content);
|
||||
|
||||
if (res.success) return;
|
||||
if (res.success) return;
|
||||
|
||||
if (res.errorMessage != null)
|
||||
if (res.userAuthError)
|
||||
{
|
||||
throw new JoinAuthException("Authentication failed.");
|
||||
}
|
||||
|
||||
if (res.errorMessage != null)
|
||||
{
|
||||
// Unfortunately hard coding this string here is the only way to determine that there aren't any devices to send to.
|
||||
// There isn't an enum or flag contained in the response that can be used instead.
|
||||
if (res.errorMessage.Equals("No devices to send to"))
|
||||
{
|
||||
throw new JoinException(res.errorMessage);
|
||||
throw new JoinInvalidDeviceException(res.errorMessage);
|
||||
}
|
||||
|
||||
if (res.userAuthError)
|
||||
// Oddly enough, rather than give us an "Invalid API key", the Join API seems to assume the key is valid,
|
||||
// but fails when doing a device lookup associated with that key.
|
||||
// In our case we are using "deviceIds" rather than "deviceId" so when the singular form error shows up
|
||||
// we know the API key was the fault.
|
||||
else if (res.errorMessage.Equals("No device to send message to"))
|
||||
{
|
||||
throw new JoinAuthException("Authentication failed.");
|
||||
}
|
||||
throw new JoinException(res.errorMessage);
|
||||
}
|
||||
|
||||
throw new JoinException("Unknown error. Join message failed to send.");
|
||||
}
|
||||
catch(Exception e)
|
||||
{
|
||||
throw new JoinException(e.Message, e);
|
||||
}
|
||||
throw new JoinException("Unknown error. Join message failed to send.");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
@ -10,7 +10,8 @@ public class JoinSettingsValidator : AbstractValidator<JoinSettings>
|
|||
{
|
||||
public JoinSettingsValidator()
|
||||
{
|
||||
RuleFor(c => c.APIKey).NotEmpty();
|
||||
RuleFor(s => s.ApiKey).NotEmpty();
|
||||
RuleFor(s => s.DeviceIds).Matches(@"\A\S+\z").When(s => !string.IsNullOrEmpty(s.DeviceIds));
|
||||
}
|
||||
}
|
||||
|
||||
|
@ -19,7 +20,10 @@ public class JoinSettings : IProviderConfig
|
|||
private static readonly JoinSettingsValidator Validator = new JoinSettingsValidator();
|
||||
|
||||
[FieldDefinition(0, Label = "API Key", HelpText = "The API Key from your Join account settings (click Join API button).", HelpLink = "https://joinjoaomgcd.appspot.com/")]
|
||||
public string APIKey { get; set; }
|
||||
public string ApiKey { get; set; }
|
||||
|
||||
[FieldDefinition(1, Label = "Device IDs", HelpText = "Comma separated list of Device IDs you'd like to send notifications to. If unset, all devices will receive notifications.", HelpLink = "https://joinjoaomgcd.appspot.com/")]
|
||||
public string DeviceIds { get; set; }
|
||||
|
||||
public NzbDroneValidationResult Validate()
|
||||
{
|
||||
|
|
|
@ -806,6 +806,7 @@
|
|||
<Compile Include="MetadataSource\IProvideSeriesInfo.cs" />
|
||||
<Compile Include="MetadataSource\ISearchForNewSeries.cs" />
|
||||
<Compile Include="Notifications\Join\JoinAuthException.cs" />
|
||||
<Compile Include="Notifications\Join\JoinInvalidDeviceException.cs" />
|
||||
<Compile Include="Notifications\Join\JoinResponseModel.cs" />
|
||||
<Compile Include="Notifications\Join\Join.cs" />
|
||||
<Compile Include="Notifications\Join\JoinException.cs" />
|
||||
|
|
Loading…
Reference in a new issue