self-hosted/Sonarr
1
0
Fork 0
mirror of https://github.com/Sonarr/Sonarr.git synced 2024-12-14 11:23:42 +02:00
Code Issues Releases Activity

New: Removed chown and simplified chmod options for linux/osx

Browse Source 
Closes #3760
Closes #3752
This commit is contained in:
Arthur Bols 2020-06-07 19:05:25 +02:00 committed by GitHub
parent c73649b19b
commit 3b579900bb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
18 changed files with 208 additions and 148 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
frontend/src/Settings/MediaManagement/MediaManagement.js
View File

@ -371,7 +371,7 @@ class MediaManagement extends Component {
<FormInputGroup
type={inputTypes.CHECK}
name="setPermissionsLinux"
helpText="Should chmod/chown be run when files are imported/renamed?"
helpText="Should chmod be run when files are imported/renamed?"
helpTextWarning="If you're unsure what these settings do, do not alter them."
onChange={onInputChange}
{...settings.setPermissionsLinux}
@ -387,59 +387,14 @@ class MediaManagement extends Component {
<FormInputGroup
type={inputTypes.TEXT}
name="fileChmod"
helpText="Octal, applied to media files when imported/renamed by Sonarr"
helpTexts={[
'Octal, applied to media files when imported/renamed by Sonarr',
'The same mode is applied to series/season folders with the execute bit added, e.g., 0644 becomes 0755'
]}
onChange={onInputChange}
{...settings.fileChmod}
/>
</FormGroup>
<FormGroup
advancedSettings={advancedSettings}
isAdvanced={true}
>
<FormLabel>Folder chmod mode</FormLabel>
<FormInputGroup
type={inputTypes.TEXT}
name="folderChmod"
helpText="Octal, applied to series/season folders created by Sonarr"
values={fileDateOptions}
onChange={onInputChange}
{...settings.folderChmod}
/>
</FormGroup>
<FormGroup
advancedSettings={advancedSettings}
isAdvanced={true}
>
<FormLabel>chown User</FormLabel>
<FormInputGroup
type={inputTypes.TEXT}
name="chownUser"
helpText="Username or uid. Use uid for remote file systems."
values={fileDateOptions}
onChange={onInputChange}
{...settings.chownUser}
/>
</FormGroup>
<FormGroup
advancedSettings={advancedSettings}
isAdvanced={true}
>
<FormLabel>chown Group</FormLabel>
<FormInputGroup
type={inputTypes.TEXT}
name="chownGroup"
helpText="Group name or gid. Use gid for remote file systems."
values={fileDateOptions}
onChange={onInputChange}
{...settings.chownGroup}
/>
</FormGroup>
</FieldSet>
}
</Form>

7
src/NzbDrone.Api/Config/MediaManagementConfigModule.cs
View File

@ -1,16 +1,17 @@
using FluentValidation;
using NzbDrone.Common.EnvironmentInfo;
using NzbDrone.Core.Configuration;
using NzbDrone.Core.Validation;
using NzbDrone.Core.Validation.Paths;
namespace NzbDrone.Api.Config
{
public class MediaManagementConfigModule : NzbDroneConfigModule<MediaManagementConfigResource>
{
public MediaManagementConfigModule(IConfigService configService, PathExistsValidator pathExistsValidator)
public MediaManagementConfigModule(IConfigService configService, PathExistsValidator pathExistsValidator, FileChmodValidator fileChmodValidator)
: base(configService)
{
SharedValidator.RuleFor(c => c.FileChmod).NotEmpty();
SharedValidator.RuleFor(c => c.FolderChmod).NotEmpty();
SharedValidator.RuleFor(c => c.FileChmod).SetValidator(fileChmodValidator).When(c => !string.IsNullOrEmpty(c.FileChmod) && PlatformInfo.IsMono);
SharedValidator.RuleFor(c => c.RecycleBin).IsValidPath().SetValidator(pathExistsValidator).When(c => !string.IsNullOrWhiteSpace(c.RecycleBin));
}

6
src/NzbDrone.Api/Config/MediaManagementConfigResource.cs
View File

@ -16,9 +16,6 @@ public class MediaManagementConfigResource : RestResource
public bool SetPermissionsLinux { get; set; }
public string FileChmod { get; set; }
public string FolderChmod { get; set; }
public string ChownUser { get; set; }
public string ChownGroup { get; set; }
public bool SkipFreeSpaceCheckWhenImporting { get; set; }
public bool CopyUsingHardlinks { get; set; }
@ -42,9 +39,6 @@ public static MediaManagementConfigResource ToResource(IConfigService model)
SetPermissionsLinux = model.SetPermissionsLinux,
FileChmod = model.FileChmod,
FolderChmod = model.FolderChmod,
ChownUser = model.ChownUser,
ChownGroup = model.ChownGroup,
SkipFreeSpaceCheckWhenImporting = model.SkipFreeSpaceCheckWhenImporting,
CopyUsingHardlinks = model.CopyUsingHardlinks,

4
src/NzbDrone.Common.Test/DiskTests/DiskTransferServiceFixture.cs
View File

@ -1037,7 +1037,7 @@ private void WithEmulatedDiskProvider()
.Returns(new List<FileInfo>());
Mocker.GetMock<IDiskProvider>()
.Setup(v => v.CopyPermissions(It.IsAny<string>(), It.IsAny<string>(), false));
.Setup(v => v.CopyPermissions(It.IsAny<string>(), It.IsAny<string>()));
}
private void WithRealDiskProvider()
@ -1094,7 +1094,7 @@ private void WithRealDiskProvider()
.Returns<string>(s => new FileStream(s, FileMode.Open, FileAccess.Read));
Mocker.GetMock<IDiskProvider>()
.Setup(v => v.CopyPermissions(It.IsAny<string>(), It.IsAny<string>(), false));
.Setup(v => v.CopyPermissions(It.IsAny<string>(), It.IsAny<string>()));
}
private void WithMockMount(string root)

9
src/NzbDrone.Common/Disk/DiskProviderBase.cs
View File

@ -31,8 +31,8 @@ public static StringComparison PathStringComparison
public abstract long? GetAvailableSpace(string path);
public abstract void InheritFolderPermissions(string filename);
public abstract void SetPermissions(string path, string mask, string user, string group);
public abstract void CopyPermissions(string sourcePath, string targetPath, bool includeOwner);
public abstract void SetPermissions(string path, string mask);
public abstract void CopyPermissions(string sourcePath, string targetPath);
public abstract long? GetTotalSize(string path);
public DateTime FolderGetCreationTime(string path)
@ -515,5 +515,10 @@ public void SaveStream(Stream stream, string path)
stream.CopyTo(fileStream);
}
}
public virtual bool IsValidFilePermissionMask(string mask)
{
throw new NotSupportedException();
}
}
}

5
src/NzbDrone.Common/Disk/IDiskProvider.cs
View File

@ -10,8 +10,8 @@ public interface IDiskProvider
{
long? GetAvailableSpace(string path);
void InheritFolderPermissions(string filename);
void SetPermissions(string path, string mask, string user, string group);
void CopyPermissions(string sourcePath, string targetPath, bool includeOwner = false);
void SetPermissions(string path, string mask);
void CopyPermissions(string sourcePath, string targetPath);
long? GetTotalSize(string path);
DateTime FolderGetCreationTime(string path);
DateTime FolderGetLastWrite(string path);
@ -52,5 +52,6 @@ public interface IDiskProvider
List<FileInfo> GetFileInfos(string path);
void RemoveEmptySubfolders(string path);
void SaveStream(Stream stream, string path);
bool IsValidFilePermissionMask(string mask);
}
}

21
src/NzbDrone.Core/Configuration/ConfigService.cs
View File

@ -259,27 +259,6 @@ public string FileChmod
set { SetValue("FileChmod", value); }
}
public string FolderChmod
{
get { return GetValue("FolderChmod", "0755"); }
set { SetValue("FolderChmod", value); }
}
public string ChownUser
{
get { return GetValue("ChownUser", ""); }
set { SetValue("ChownUser", value); }
}
public string ChownGroup
{
get { return GetValue("ChownGroup", ""); }
set { SetValue("ChownGroup", value); }
}
public int FirstDayOfWeek
{
get { return GetValueInt("FirstDayOfWeek", (int)CultureInfo.CurrentCulture.DateTimeFormat.FirstDayOfWeek); }

3
src/NzbDrone.Core/Configuration/IConfigService.cs
View File

@ -44,9 +44,6 @@ public interface IConfigService
//Permissions (Media Management)
bool SetPermissionsLinux { get; set; }
string FileChmod { get; set; }
string FolderChmod { get; set; }
string ChownUser { get; set; }
string ChownGroup { get; set; }
//Indexers
int Retention { get; set; }

15
src/NzbDrone.Core/Datastore/Migration/140_remove_chown_and_folderchmod_config.cs Normal file
View File

@ -0,0 +1,15 @@
using System.Data;
using FluentMigrator;
using NzbDrone.Core.Datastore.Migration.Framework;
namespace NzbDrone.Core.Datastore.Migration
{
[Migration(140)]
public class remove_chown_and_folderchmod_config : NzbDroneMigrationBase
{
protected override void MainDbUpgrade()
{
Execute.Sql("DELETE FROM config WHERE Key IN ('folderchmod', 'chownuser', 'chowngroup')");
}
}
}

4
src/NzbDrone.Core/MediaFiles/DiskScanService.cs
View File

@ -186,8 +186,8 @@ private void SetPermissions(string path)
try
{
var permissions = _configService.FolderChmod;
_diskProvider.SetPermissions(path, permissions, _configService.ChownUser, _configService.ChownGroup);
var permissions = _configService.FileChmod;
_diskProvider.SetPermissions(path, permissions);
}
catch (Exception ex)

4
src/NzbDrone.Core/MediaFiles/MediaFileAttributeService.cs
View File

@ -63,7 +63,7 @@ public void SetFolderPermissions(string path)
{
if (OsInfo.IsNotWindows)
{
SetMonoPermissions(path, _configService.FolderChmod);
SetMonoPermissions(path, _configService.FileChmod);
}
}
@ -85,7 +85,7 @@ private void SetMonoPermissions(string path, string permissions)
try
{
_diskProvider.SetPermissions(path, permissions, _configService.ChownUser, _configService.ChownGroup);
_diskProvider.SetPermissions(path, permissions);
}
catch (Exception ex)

23
src/NzbDrone.Core/Validation/FileChmodValidator.cs Normal file
View File

@ -0,0 +1,23 @@
using FluentValidation.Validators;
using NzbDrone.Common.Disk;
namespace NzbDrone.Core.Validation
{
public class FileChmodValidator : PropertyValidator
{
private readonly IDiskProvider _diskProvider;
public FileChmodValidator(IDiskProvider diskProvider)
: base("Must contain a valid Unix permissions octal")
{
_diskProvider = diskProvider;
}
protected override bool IsValid(PropertyValidatorContext context)
{
if (context.PropertyValue == null) return false;
return _diskProvider.IsValidFilePermissionMask(context.PropertyValue.ToString());
}
}
}

86
src/NzbDrone.Mono.Test/DiskProviderTests/DiskProviderFixture.cs
View File

@ -151,11 +151,95 @@ public void should_copy_folder_permissions()
Syscall.stat(dst, out var dstStat);
dstStat.st_mode.Should().Be(origStat.st_mode);
Subject.CopyPermissions(src, dst, false);
Subject.CopyPermissions(src, dst);
// Verify CopyPermissions
Syscall.stat(dst, out dstStat);
dstStat.st_mode.Should().Be(srcStat.st_mode);
}
[Test]
public void should_set_file_permissions()
{
var tempFile = GetTempFilePath();
File.WriteAllText(tempFile, "File1");
SetWritePermissions(tempFile, false);
// Verify test setup
Syscall.stat(tempFile, out var fileStat);
NativeConvert.ToOctalPermissionString(fileStat.st_mode).Should().Be("0444");
Subject.SetPermissions(tempFile, "644");
Syscall.stat(tempFile, out fileStat);
NativeConvert.ToOctalPermissionString(fileStat.st_mode).Should().Be("0644");
Subject.SetPermissions(tempFile, "0644");
Syscall.stat(tempFile, out fileStat);
NativeConvert.ToOctalPermissionString(fileStat.st_mode).Should().Be("0644");
Subject.SetPermissions(tempFile, "1664");
Syscall.stat(tempFile, out fileStat);
NativeConvert.ToOctalPermissionString(fileStat.st_mode).Should().Be("1664");
}
[Test]
public void should_set_folder_permissions()
{
var tempPath = GetTempFilePath();
Directory.CreateDirectory(tempPath);
SetWritePermissions(tempPath, false);
// Verify test setup
Syscall.stat(tempPath, out var fileStat);
NativeConvert.ToOctalPermissionString(fileStat.st_mode).Should().Be("0555");
Subject.SetPermissions(tempPath, "644");
Syscall.stat(tempPath, out fileStat);
NativeConvert.ToOctalPermissionString(fileStat.st_mode).Should().Be("0755");
Subject.SetPermissions(tempPath, "0644");
Syscall.stat(tempPath, out fileStat);
NativeConvert.ToOctalPermissionString(fileStat.st_mode).Should().Be("0755");
Subject.SetPermissions(tempPath, "1664");
Syscall.stat(tempPath, out fileStat);
NativeConvert.ToOctalPermissionString(fileStat.st_mode).Should().Be("1775");
Subject.SetPermissions(tempPath, "775");
Syscall.stat(tempPath, out fileStat);
NativeConvert.ToOctalPermissionString(fileStat.st_mode).Should().Be("0775");
Subject.SetPermissions(tempPath, "640");
Syscall.stat(tempPath, out fileStat);
NativeConvert.ToOctalPermissionString(fileStat.st_mode).Should().Be("0750");
Subject.SetPermissions(tempPath, "0041");
Syscall.stat(tempPath, out fileStat);
NativeConvert.ToOctalPermissionString(fileStat.st_mode).Should().Be("0051");
}
[Test]
public void IsValidFilePermissionMask_should_return_correct()
{
// Files may not be executable
Subject.IsValidFilePermissionMask("0777").Should().BeFalse();
Subject.IsValidFilePermissionMask("0544").Should().BeFalse();
Subject.IsValidFilePermissionMask("0454").Should().BeFalse();
Subject.IsValidFilePermissionMask("0445").Should().BeFalse();
// No special bits should be set
Subject.IsValidFilePermissionMask("1644").Should().BeFalse();
Subject.IsValidFilePermissionMask("2644").Should().BeFalse();
Subject.IsValidFilePermissionMask("4644").Should().BeFalse();
Subject.IsValidFilePermissionMask("7644").Should().BeFalse();
// Files should be readable and writeable by owner
Subject.IsValidFilePermissionMask("0400").Should().BeFalse();
Subject.IsValidFilePermissionMask("0000").Should().BeFalse();
Subject.IsValidFilePermissionMask("0200").Should().BeFalse();
Subject.IsValidFilePermissionMask("0600").Should().BeTrue();
}
}
}

95
src/NzbDrone.Mono/Disk/DiskProvider.cs
View File

@ -72,13 +72,62 @@ public override void InheritFolderPermissions(string filename)
}
}
public override void SetPermissions(string path, string mask, string user, string group)
public override void SetPermissions(string path, string mask)
{
SetPermissions(path, mask);
SetOwner(path, user, group);
Logger.Debug("Setting permissions: {0} on {1}", mask, path);
var permissions = NativeConvert.FromOctalPermissionString(mask);
if (Directory.Exists(path))
{
permissions = GetFolderPermissions(permissions);
}
if (Syscall.chmod(path, permissions) < 0)
{
var error = Stdlib.GetLastError();
throw new LinuxPermissionsException("Error setting permissions: " + error);
}
}
public override void CopyPermissions(string sourcePath, string targetPath, bool includeOwner)
private static FilePermissions GetFolderPermissions(FilePermissions permissions)
{
permissions |= (FilePermissions) ((int) (permissions & (FilePermissions.S_IRUSR | FilePermissions.S_IRGRP | FilePermissions.S_IROTH)) >> 2);
return permissions;
}
public override bool IsValidFilePermissionMask(string mask)
{
try
{
var permissions = NativeConvert.FromOctalPermissionString(mask);
if ((permissions & (FilePermissions.S_ISUID | FilePermissions.S_ISGID | FilePermissions.S_ISVTX)) != 0)
{
return false;
}
if ((permissions & (FilePermissions.S_IXUSR | FilePermissions.S_IXGRP | FilePermissions.S_IXOTH)) != 0)
{
return false;
}
if ((permissions & (FilePermissions.S_IRUSR | FilePermissions.S_IWUSR)) != (FilePermissions.S_IRUSR | FilePermissions.S_IWUSR))
{
return false;
}
return true;
}
catch (FormatException)
{
return false;
}
}
public override void CopyPermissions(string sourcePath, string targetPath)
{
try
{
@ -89,11 +138,6 @@ public override void CopyPermissions(string sourcePath, string targetPath, bool
{
Syscall.chmod(targetPath, srcStat.st_mode);
}
if (includeOwner && (srcStat.st_uid != tgtStat.st_uid || srcStat.st_gid != tgtStat.st_gid))
{
Syscall.chown(targetPath, srcStat.st_uid, srcStat.st_gid);
}
}
catch (Exception ex)
{
@ -361,39 +405,6 @@ public override bool TryCreateHardLink(string source, string destination)
}
}
private void SetPermissions(string path, string mask)
{
Logger.Debug("Setting permissions: {0} on {1}", mask, path);
var filePermissions = NativeConvert.FromOctalPermissionString(mask);
if (Syscall.chmod(path, filePermissions) < 0)
{
var error = Stdlib.GetLastError();
throw new LinuxPermissionsException("Error setting file permissions: " + error);
}
}
private void SetOwner(string path, string user, string group)
{
if (string.IsNullOrWhiteSpace(user) && string.IsNullOrWhiteSpace(group))
{
Logger.Debug("User and Group for chown not configured, skipping chown.");
return;
}
var userId = GetUserId(user);
var groupId = GetGroupId(group);
if (Syscall.chown(path, userId, groupId) < 0)
{
var error = Stdlib.GetLastError();
throw new LinuxPermissionsException("Error setting file owner and/or group: " + error);
}
}
private uint GetUserId(string user)
{
if (user.IsNullOrWhiteSpace())

2
src/NzbDrone.Update/UpdateEngine/InstallUpdateService.cs
View File

@ -129,7 +129,7 @@ public void Start(string installationFolder, int processId)
{
// Old MacOS App stores Sonarr binaries in MacOS together with shell script
// Make shim executable
_diskProvider.SetPermissions(shimPath, "0755", null, null);
_diskProvider.SetPermissions(shimPath, "0755");
}
}
}

4
src/NzbDrone.Windows/Disk/DiskProvider.cs
View File

@ -44,12 +44,12 @@ public override void InheritFolderPermissions(string filename)
File.SetAccessControl(filename, fs);
}
public override void SetPermissions(string path, string mask, string user, string group)
public override void SetPermissions(string path, string mask)
{
}
public override void CopyPermissions(string sourcePath, string targetPath, bool includeOwner)
public override void CopyPermissions(string sourcePath, string targetPath)
{
}

7
src/Sonarr.Api.V3/Config/MediaManagementConfigModule.cs
View File

@ -1,17 +1,18 @@
using FluentValidation;
using NzbDrone.Common.EnvironmentInfo;
using NzbDrone.Core.Configuration;
using NzbDrone.Core.Validation;
using NzbDrone.Core.Validation.Paths;
namespace Sonarr.Api.V3.Config
{
public class MediaManagementConfigModule : SonarrConfigModule<MediaManagementConfigResource>
{
public MediaManagementConfigModule(IConfigService configService, PathExistsValidator pathExistsValidator)
public MediaManagementConfigModule(IConfigService configService, PathExistsValidator pathExistsValidator, FileChmodValidator fileChmodValidator)
: base(configService)
{
SharedValidator.RuleFor(c => c.RecycleBinCleanupDays).GreaterThanOrEqualTo(0);
SharedValidator.RuleFor(c => c.FileChmod).NotEmpty();
SharedValidator.RuleFor(c => c.FolderChmod).NotEmpty();
SharedValidator.RuleFor(c => c.FileChmod).SetValidator(fileChmodValidator).When(c => !string.IsNullOrEmpty(c.FileChmod) && PlatformInfo.IsMono);
SharedValidator.RuleFor(c => c.RecycleBin).IsValidPath().SetValidator(pathExistsValidator).When(c => !string.IsNullOrWhiteSpace(c.RecycleBin));
SharedValidator.RuleFor(c => c.MinimumFreeSpaceWhenImporting).GreaterThanOrEqualTo(100);
}

6
src/Sonarr.Api.V3/Config/MediaManagementConfigResource.cs
View File

@ -19,9 +19,6 @@ public class MediaManagementConfigResource : RestResource
public bool SetPermissionsLinux { get; set; }
public string FileChmod { get; set; }
public string FolderChmod { get; set; }
public string ChownUser { get; set; }
public string ChownGroup { get; set; }
public EpisodeTitleRequiredType EpisodeTitleRequired { get; set; }
public bool SkipFreeSpaceCheckWhenImporting { get; set; }
@ -49,9 +46,6 @@ public static MediaManagementConfigResource ToResource(IConfigService model)
SetPermissionsLinux = model.SetPermissionsLinux,
FileChmod = model.FileChmod,
FolderChmod = model.FolderChmod,
ChownUser = model.ChownUser,
ChownGroup = model.ChownGroup,
EpisodeTitleRequired = model.EpisodeTitleRequired,
SkipFreeSpaceCheckWhenImporting = model.SkipFreeSpaceCheckWhenImporting,