Archive-Team
/
sonarr-repo-only
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

New: Improve validation messages

This commit is contained in:
Bogdan 2023-05-20 22:22:04 +03:00 committed by Mark McDowall
parent 6118afa339
commit a117001de6
14 changed files with 44 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/NzbDrone.Core/Validation/FolderValidator.cs
View File

@ -6,7 +6,7 @@ namespace NzbDrone.Core.Validation
{
public class FolderValidator : PropertyValidator
{
protected override string GetDefaultMessageTemplate() => "Invalid Path";
protected override string GetDefaultMessageTemplate() => "Invalid Path: '{path}'";
protected override bool IsValid(PropertyValidatorContext context)
{
@ -15,6 +15,8 @@ namespace NzbDrone.Core.Validation
return false;
}
context.MessageFormatter.AppendArgument("path", context.PropertyValue.ToString());
return context.PropertyValue.ToString().IsPathValid(PathValidationType.CurrentOs);
}
}

4
src/NzbDrone.Core/Validation/Paths/FileExistsValidator.cs
View File

@ -12,7 +12,7 @@ namespace NzbDrone.Core.Validation.Paths
_diskProvider = diskProvider;
}
protected override string GetDefaultMessageTemplate() => "File does not exist";
protected override string GetDefaultMessageTemplate() => "File '{file}' does not exist";
protected override bool IsValid(PropertyValidatorContext context)
{
@ -21,6 +21,8 @@ namespace NzbDrone.Core.Validation.Paths
return false;
}
context.MessageFormatter.AppendArgument("file", context.PropertyValue.ToString());
return _diskProvider.FileExists(context.PropertyValue.ToString());
}
}

5
src/NzbDrone.Core/Validation/Paths/FolderWritableValidator.cs
View File

@ -13,7 +13,7 @@ namespace NzbDrone.Core.Validation.Paths
_diskProvider = diskProvider;
}
protected override string GetDefaultMessageTemplate() => $"Folder is not writable by user {Environment.UserName}";
protected override string GetDefaultMessageTemplate() => "Folder '{path}' is not writable by user '{user}'";
protected override bool IsValid(PropertyValidatorContext context)
{
@ -22,6 +22,9 @@ namespace NzbDrone.Core.Validation.Paths
return false;
}
context.MessageFormatter.AppendArgument("path", context.PropertyValue.ToString());
context.MessageFormatter.AppendArgument("user", Environment.UserName);
return _diskProvider.FolderWritable(context.PropertyValue.ToString());
}
}

4
src/NzbDrone.Core/Validation/Paths/PathExistsValidator.cs
View File

@ -12,7 +12,7 @@ namespace NzbDrone.Core.Validation.Paths
_diskProvider = diskProvider;
}
protected override string GetDefaultMessageTemplate() => "Path does not exist";
protected override string GetDefaultMessageTemplate() => "Path '{path}' does not exist";
protected override bool IsValid(PropertyValidatorContext context)
{
@ -21,6 +21,8 @@ namespace NzbDrone.Core.Validation.Paths
return false;
}
context.MessageFormatter.AppendArgument("path", context.PropertyValue.ToString());
return _diskProvider.FolderExists(context.PropertyValue.ToString());
}
}

4
src/NzbDrone.Core/Validation/Paths/PathValidator.cs
View File

@ -15,7 +15,7 @@ namespace NzbDrone.Core.Validation.Paths
public class PathValidator : PropertyValidator
{
protected override string GetDefaultMessageTemplate() => "Invalid Path";
protected override string GetDefaultMessageTemplate() => "Invalid Path: '{path}'";
protected override bool IsValid(PropertyValidatorContext context)
{
@ -24,6 +24,8 @@ namespace NzbDrone.Core.Validation.Paths
return false;
}
context.MessageFormatter.AppendArgument("path", context.PropertyValue.ToString());
return context.PropertyValue.ToString().IsPathValid(PathValidationType.CurrentOs);
}
}

6
src/NzbDrone.Core/Validation/Paths/RecycleBinValidator.cs
View File

@ -13,18 +13,20 @@ namespace NzbDrone.Core.Validation.Paths
_configService = configService;
}
protected override string GetDefaultMessageTemplate() => "Path is {relationship} configured recycle bin folder";
protected override string GetDefaultMessageTemplate() => "Path '{path}' is {relationship} configured recycle bin folder";
protected override bool IsValid(PropertyValidatorContext context)
{
var recycleBin = _configService.RecycleBin;
var folder = context.PropertyValue.ToString();
if (context.PropertyValue == null || recycleBin.IsNullOrWhiteSpace())
{
return true;
}
var folder = context.PropertyValue.ToString();
context.MessageFormatter.AppendArgument("path", folder);
if (recycleBin.PathEquals(folder))
{
context.MessageFormatter.AppendArgument("relationship", "set to");

4
src/NzbDrone.Core/Validation/Paths/RootFolderAncestorValidator.cs
View File

@ -14,7 +14,7 @@ namespace NzbDrone.Core.Validation.Paths
_rootFolderService = rootFolderService;
}
protected override string GetDefaultMessageTemplate() => "Path is an ancestor of an existing root folder";
protected override string GetDefaultMessageTemplate() => "Path '{path}' is an ancestor of an existing root folder";
protected override bool IsValid(PropertyValidatorContext context)
{
@ -23,6 +23,8 @@ namespace NzbDrone.Core.Validation.Paths
return true;
}
context.MessageFormatter.AppendArgument("path", context.PropertyValue.ToString());
return !_rootFolderService.All().Any(s => context.PropertyValue.ToString().IsParentPath(s.Path));
}
}

4
src/NzbDrone.Core/Validation/Paths/RootFolderValidator.cs
View File

@ -13,7 +13,7 @@ namespace NzbDrone.Core.Validation.Paths
_rootFolderService = rootFolderService;
}
protected override string GetDefaultMessageTemplate() => "Path is already configured as a root folder";
protected override string GetDefaultMessageTemplate() => "Path '{path}' is already configured as a root folder";
protected override bool IsValid(PropertyValidatorContext context)
{
@ -22,6 +22,8 @@ namespace NzbDrone.Core.Validation.Paths
return true;
}
context.MessageFormatter.AppendArgument("path", context.PropertyValue.ToString());
return !_rootFolderService.All().Exists(r => r.Path.PathEquals(context.PropertyValue.ToString()));
}
}

4
src/NzbDrone.Core/Validation/Paths/SeriesAncestorValidator.cs
View File

@ -14,7 +14,7 @@ namespace NzbDrone.Core.Validation.Paths
_seriesService = seriesService;
}
protected override string GetDefaultMessageTemplate() => "Path is an ancestor of an existing series";
protected override string GetDefaultMessageTemplate() => "Path '{path}' is an ancestor of an existing series";
protected override bool IsValid(PropertyValidatorContext context)
{
@ -23,6 +23,8 @@ namespace NzbDrone.Core.Validation.Paths
return true;
}
context.MessageFormatter.AppendArgument("path", context.PropertyValue.ToString());
return !_seriesService.GetAllSeriesPaths().Any(s => context.PropertyValue.ToString().IsParentPath(s.Value));
}
}

4
src/NzbDrone.Core/Validation/Paths/SeriesPathValidator.cs
View File

@ -13,7 +13,7 @@ namespace NzbDrone.Core.Validation.Paths
_seriesService = seriesService;
}
protected override string GetDefaultMessageTemplate() => "Path is already configured for another series";
protected override string GetDefaultMessageTemplate() => "Path '{path}' is already configured for another series";
protected override bool IsValid(PropertyValidatorContext context)
{
@ -22,6 +22,8 @@ namespace NzbDrone.Core.Validation.Paths
return true;
}
context.MessageFormatter.AppendArgument("path", context.PropertyValue.ToString());
dynamic instance = context.ParentContext.InstanceToValidate;
var instanceId = (int)instance.Id;

3
src/NzbDrone.Core/Validation/Paths/StartupFolderValidator.cs
View File

@ -13,7 +13,7 @@ namespace NzbDrone.Core.Validation.Paths
_appFolderInfo = appFolderInfo;
}
protected override string GetDefaultMessageTemplate() => "Path cannot be {relationship} the start up folder";
protected override string GetDefaultMessageTemplate() => "Path '{path}' cannot be {relationship} the start up folder";
protected override bool IsValid(PropertyValidatorContext context)
{
@ -24,6 +24,7 @@ namespace NzbDrone.Core.Validation.Paths
var startupFolder = _appFolderInfo.StartUpFolder;
var folder = context.PropertyValue.ToString();
context.MessageFormatter.AppendArgument("path", folder);
if (startupFolder.PathEquals(folder))
{

3
src/NzbDrone.Core/Validation/Paths/SystemFolderValidator.cs
View File

@ -6,11 +6,12 @@ namespace NzbDrone.Core.Validation.Paths
{
public class SystemFolderValidator : PropertyValidator
{
protected override string GetDefaultMessageTemplate() => "Is {relationship} system folder {systemFolder}";
protected override string GetDefaultMessageTemplate() => "Path '{path}' is {relationship} system folder {systemFolder}";
protected override bool IsValid(PropertyValidatorContext context)
{
var folder = context.PropertyValue.ToString();
context.MessageFormatter.AppendArgument("path", folder);
foreach (var systemFolder in SystemFolders.GetSystemFolders())
{

4
src/NzbDrone.Core/Validation/UrlValidator.cs
View File

@ -14,7 +14,7 @@ namespace NzbDrone.Core.Validation
public class UrlValidator : PropertyValidator
{
protected override string GetDefaultMessageTemplate() => "Invalid Url";
protected override string GetDefaultMessageTemplate() => "Invalid Url: '{url}'";
protected override bool IsValid(PropertyValidatorContext context)
{
@ -23,6 +23,8 @@ namespace NzbDrone.Core.Validation
return false;
}
context.MessageFormatter.AppendArgument("url", context.PropertyValue.ToString());
return context.PropertyValue.ToString().IsValidUrl();
}
}

9
src/Sonarr.Api.V3/Series/SeriesFolderAsRootFolderValidator.cs
View File

@ -15,7 +15,7 @@ namespace Sonarr.Api.V3.Series
_fileNameBuilder = fileNameBuilder;
}
protected override string GetDefaultMessageTemplate() => "Root folder path contains series folder";
protected override string GetDefaultMessageTemplate() => "Root folder path '{rootFolderPath}' contains series folder '{seriesFolder}'";
protected override bool IsValid(PropertyValidatorContext context)
{
@ -24,9 +24,7 @@ namespace Sonarr.Api.V3.Series
return true;
}
var seriesResource = context.InstanceToValidate as SeriesResource;
if (seriesResource == null)
if (context.InstanceToValidate is not SeriesResource seriesResource)
{
return true;
}
@ -42,6 +40,9 @@ namespace Sonarr.Api.V3.Series
var series = seriesResource.ToModel();
var seriesFolder = _fileNameBuilder.GetSeriesFolder(series);
context.MessageFormatter.AppendArgument("rootFolderPath", rootFolderPath);
context.MessageFormatter.AppendArgument("seriesFolder", seriesFolder);
if (seriesFolder == rootFolder)
{
return false;