New: Validate that folders in paths don't start or end with a space

Closes #6709
This commit is contained in:
Mark McDowall 2024-04-27 18:04:50 -07:00 committed by GitHub
parent 2440672179
commit 316b5cbf75
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 57 additions and 5 deletions

View File

@ -3,6 +3,7 @@ using System.IO;
using FluentAssertions; using FluentAssertions;
using Moq; using Moq;
using NUnit.Framework; using NUnit.Framework;
using NzbDrone.Common.Disk;
using NzbDrone.Common.EnvironmentInfo; using NzbDrone.Common.EnvironmentInfo;
using NzbDrone.Common.Extensions; using NzbDrone.Common.Extensions;
using NzbDrone.Test.Common; using NzbDrone.Test.Common;
@ -34,7 +35,7 @@ namespace NzbDrone.Common.Test
[TestCase(@"\\Testserver\\Test\", @"\\Testserver\Test")] [TestCase(@"\\Testserver\\Test\", @"\\Testserver\Test")]
[TestCase(@"\\Testserver\Test\file.ext", @"\\Testserver\Test\file.ext")] [TestCase(@"\\Testserver\Test\file.ext", @"\\Testserver\Test\file.ext")]
[TestCase(@"\\Testserver\Test\file.ext\\", @"\\Testserver\Test\file.ext")] [TestCase(@"\\Testserver\Test\file.ext\\", @"\\Testserver\Test\file.ext")]
[TestCase(@"\\Testserver\Test\file.ext \\", @"\\Testserver\Test\file.ext")] [TestCase(@"\\Testserver\Test\file.ext ", @"\\Testserver\Test\file.ext")]
[TestCase(@"//CAPITAL//lower// ", @"\\CAPITAL\lower")] [TestCase(@"//CAPITAL//lower// ", @"\\CAPITAL\lower")]
public void Clean_Path_Windows(string dirty, string clean) public void Clean_Path_Windows(string dirty, string clean)
{ {
@ -335,5 +336,30 @@ namespace NzbDrone.Common.Test
result[2].Should().Be(@"TV"); result[2].Should().Be(@"TV");
result[3].Should().Be(@"Series Title"); result[3].Should().Be(@"Series Title");
} }
[TestCase(@"C:\Test\")]
[TestCase(@"C:\Test")]
[TestCase(@"C:\Test\TV\")]
[TestCase(@"C:\Test\TV")]
public void IsPathValid_should_be_true(string path)
{
path.AsOsAgnostic().IsPathValid(PathValidationType.CurrentOs).Should().BeTrue();
}
[TestCase(@"C:\Test \")]
[TestCase(@"C:\Test ")]
[TestCase(@"C:\ Test\")]
[TestCase(@"C:\ Test")]
[TestCase(@"C:\Test \TV")]
[TestCase(@"C:\ Test\TV")]
[TestCase(@"C:\Test \TV\")]
[TestCase(@"C:\ Test\TV\")]
[TestCase(@" C:\Test\TV\")]
[TestCase(@" C:\Test\TV")]
public void IsPathValid_should_be_false(string path)
{
path.AsOsAgnostic().IsPathValid(PathValidationType.CurrentOs).Should().BeFalse();
}
} }
} }

View File

@ -29,6 +29,12 @@ namespace NzbDrone.Common.Extensions
public static string CleanFilePath(this string path) public static string CleanFilePath(this string path)
{ {
if (path.IsNotNullOrWhiteSpace())
{
// Trim trailing spaces before checking if the path is valid so validation doesn't fail for something we can fix.
path = path.TrimEnd(' ');
}
Ensure.That(path, () => path).IsNotNullOrWhiteSpace(); Ensure.That(path, () => path).IsNotNullOrWhiteSpace();
Ensure.That(path, () => path).IsValidPath(PathValidationType.AnyOs); Ensure.That(path, () => path).IsValidPath(PathValidationType.AnyOs);
@ -37,10 +43,10 @@ namespace NzbDrone.Common.Extensions
// UNC // UNC
if (!info.FullName.Contains('/') && info.FullName.StartsWith(@"\\")) if (!info.FullName.Contains('/') && info.FullName.StartsWith(@"\\"))
{ {
return info.FullName.TrimEnd('/', '\\', ' '); return info.FullName.TrimEnd('/', '\\');
} }
return info.FullName.TrimEnd('/').Trim('\\', ' '); return info.FullName.TrimEnd('/').Trim('\\');
} }
public static bool PathNotEquals(this string firstPath, string secondPath, StringComparison? comparison = null) public static bool PathNotEquals(this string firstPath, string secondPath, StringComparison? comparison = null)
@ -154,6 +160,23 @@ namespace NzbDrone.Common.Extensions
return false; return false;
} }
if (path.Trim() != path)
{
return false;
}
var directoryInfo = new DirectoryInfo(path);
while (directoryInfo != null)
{
if (directoryInfo.Name.Trim() != directoryInfo.Name)
{
return false;
}
directoryInfo = directoryInfo.Parent;
}
if (validationType == PathValidationType.AnyOs) if (validationType == PathValidationType.AnyOs)
{ {
return IsPathValidForWindows(path) || IsPathValidForNonWindows(path); return IsPathValidForWindows(path) || IsPathValidForNonWindows(path);
@ -291,6 +314,11 @@ namespace NzbDrone.Common.Extensions
return processName; return processName;
} }
public static string CleanPath(this string path)
{
return Path.Join(path.Split(Path.DirectorySeparatorChar).Select(s => s.Trim()).ToArray());
}
public static string GetAppDataPath(this IAppFolderInfo appFolderInfo) public static string GetAppDataPath(this IAppFolderInfo appFolderInfo)
{ {
return appFolderInfo.AppDataFolder; return appFolderInfo.AppDataFolder;

View File

@ -92,8 +92,6 @@ namespace Sonarr.Api.V3.Series
.When(s => s.Path.IsNullOrWhiteSpace()); .When(s => s.Path.IsNullOrWhiteSpace());
PostValidator.RuleFor(s => s.Title).NotEmpty(); PostValidator.RuleFor(s => s.Title).NotEmpty();
PostValidator.RuleFor(s => s.TvdbId).GreaterThan(0).SetValidator(seriesExistsValidator); PostValidator.RuleFor(s => s.TvdbId).GreaterThan(0).SetValidator(seriesExistsValidator);
PutValidator.RuleFor(s => s.Path).IsValidPath();
} }
[HttpGet] [HttpGet]