using System; using System.Collections.Generic; using System.IO; using System.Linq; using System.Text; using MediaBrowser.Common.IO; using MediaBrowser.Model.IO; using Patterns.Logging; namespace MediaBrowser.Common.Implementations.IO { /// /// Class ManagedFileSystem /// public class ManagedFileSystem : IFileSystem { protected ILogger Logger; private readonly bool _supportsAsyncFileStreams; private char[] _invalidFileNameChars; private readonly List _shortcutHandlers = new List(); protected bool EnableFileSystemRequestConcat = true; public ManagedFileSystem(ILogger logger, bool supportsAsyncFileStreams, bool enableManagedInvalidFileNameChars) { Logger = logger; _supportsAsyncFileStreams = supportsAsyncFileStreams; SetInvalidFileNameChars(enableManagedInvalidFileNameChars); } public void AddShortcutHandler(IShortcutHandler handler) { _shortcutHandlers.Add(handler); } protected void SetInvalidFileNameChars(bool enableManagedInvalidFileNameChars) { if (enableManagedInvalidFileNameChars) { _invalidFileNameChars = Path.GetInvalidFileNameChars(); } else { // GetInvalidFileNameChars is less restrictive in Linux/Mac than Windows, this mimic Windows behavior for mono under Linux/Mac. _invalidFileNameChars = new char[41] { '\x00', '\x01', '\x02', '\x03', '\x04', '\x05', '\x06', '\x07', '\x08', '\x09', '\x0A', '\x0B', '\x0C', '\x0D', '\x0E', '\x0F', '\x10', '\x11', '\x12', '\x13', '\x14', '\x15', '\x16', '\x17', '\x18', '\x19', '\x1A', '\x1B', '\x1C', '\x1D', '\x1E', '\x1F', '\x22', '\x3C', '\x3E', '\x7C', ':', '*', '?', '\\', '/' }; } } public char DirectorySeparatorChar { get { return Path.DirectorySeparatorChar; } } public string GetFullPath(string path) { return Path.GetFullPath(path); } /// /// Determines whether the specified filename is shortcut. /// /// The filename. /// true if the specified filename is shortcut; otherwise, false. /// filename public virtual bool IsShortcut(string filename) { if (string.IsNullOrEmpty(filename)) { throw new ArgumentNullException("filename"); } var extension = Path.GetExtension(filename); return _shortcutHandlers.Any(i => string.Equals(extension, i.Extension, StringComparison.OrdinalIgnoreCase)); } /// /// Resolves the shortcut. /// /// The filename. /// System.String. /// filename public virtual string ResolveShortcut(string filename) { if (string.IsNullOrEmpty(filename)) { throw new ArgumentNullException("filename"); } var extension = Path.GetExtension(filename); var handler = _shortcutHandlers.FirstOrDefault(i => string.Equals(extension, i.Extension, StringComparison.OrdinalIgnoreCase)); if (handler != null) { return handler.Resolve(filename); } return null; } /// /// Creates the shortcut. /// /// The shortcut path. /// The target. /// /// shortcutPath /// or /// target /// public void CreateShortcut(string shortcutPath, string target) { if (string.IsNullOrEmpty(shortcutPath)) { throw new ArgumentNullException("shortcutPath"); } if (string.IsNullOrEmpty(target)) { throw new ArgumentNullException("target"); } var extension = Path.GetExtension(shortcutPath); var handler = _shortcutHandlers.FirstOrDefault(i => string.Equals(extension, i.Extension, StringComparison.OrdinalIgnoreCase)); if (handler != null) { handler.Create(shortcutPath, target); } else { throw new NotImplementedException(); } } /// /// Returns a object for the specified file or directory path. /// /// A path to a file or directory. /// A object. /// If the specified path points to a directory, the returned object's /// property will be set to true and all other properties will reflect the properties of the directory. public FileSystemMetadata GetFileSystemInfo(string path) { if (string.IsNullOrEmpty(path)) { throw new ArgumentNullException("path"); } // Take a guess to try and avoid two file system hits, but we'll double-check by calling Exists if (Path.HasExtension(path)) { var fileInfo = new FileInfo(path); if (fileInfo.Exists) { return GetFileSystemMetadata(fileInfo); } return GetFileSystemMetadata(new DirectoryInfo(path)); } else { var fileInfo = new DirectoryInfo(path); if (fileInfo.Exists) { return GetFileSystemMetadata(fileInfo); } return GetFileSystemMetadata(new FileInfo(path)); } } /// /// Returns a object for the specified file path. /// /// A path to a file. /// A object. /// If the specified path points to a directory, the returned object's /// property and the property will both be set to false. /// For automatic handling of files and directories, use . public FileSystemMetadata GetFileInfo(string path) { if (string.IsNullOrEmpty(path)) { throw new ArgumentNullException("path"); } var fileInfo = new FileInfo(path); return GetFileSystemMetadata(fileInfo); } /// /// Returns a object for the specified directory path. /// /// A path to a directory. /// A object. /// If the specified path points to a file, the returned object's /// property will be set to true and the property will be set to false. /// For automatic handling of files and directories, use . public FileSystemMetadata GetDirectoryInfo(string path) { if (string.IsNullOrEmpty(path)) { throw new ArgumentNullException("path"); } var fileInfo = new DirectoryInfo(path); return GetFileSystemMetadata(fileInfo); } private FileSystemMetadata GetFileSystemMetadata(FileSystemInfo info) { var result = new FileSystemMetadata(); result.Exists = info.Exists; result.FullName = info.FullName; result.Extension = info.Extension; result.Name = info.Name; if (result.Exists) { var attributes = info.Attributes; result.IsDirectory = info is DirectoryInfo || (attributes & FileAttributes.Directory) == FileAttributes.Directory; result.IsHidden = (attributes & FileAttributes.Hidden) == FileAttributes.Hidden; result.IsReadOnly = (attributes & FileAttributes.ReadOnly) == FileAttributes.ReadOnly; var fileInfo = info as FileInfo; if (fileInfo != null) { result.Length = fileInfo.Length; result.DirectoryName = fileInfo.DirectoryName; } result.CreationTimeUtc = GetCreationTimeUtc(info); result.LastWriteTimeUtc = GetLastWriteTimeUtc(info); } else { result.IsDirectory = info is DirectoryInfo; } return result; } /// /// The space char /// private const char SpaceChar = ' '; /// /// Takes a filename and removes invalid characters /// /// The filename. /// System.String. /// filename public string GetValidFilename(string filename) { if (string.IsNullOrEmpty(filename)) { throw new ArgumentNullException("filename"); } var builder = new StringBuilder(filename); foreach (var c in _invalidFileNameChars) { builder = builder.Replace(c, SpaceChar); } return builder.ToString(); } /// /// Gets the creation time UTC. /// /// The info. /// DateTime. public DateTime GetCreationTimeUtc(FileSystemInfo info) { // This could throw an error on some file systems that have dates out of range try { return info.CreationTimeUtc; } catch (Exception ex) { Logger.ErrorException("Error determining CreationTimeUtc for {0}", ex, info.FullName); return DateTime.MinValue; } } /// /// Gets the creation time UTC. /// /// The path. /// DateTime. public DateTime GetCreationTimeUtc(string path) { return GetCreationTimeUtc(GetFileSystemInfo(path)); } public DateTime GetCreationTimeUtc(FileSystemMetadata info) { return info.CreationTimeUtc; } public DateTime GetLastWriteTimeUtc(FileSystemMetadata info) { return info.LastWriteTimeUtc; } /// /// Gets the creation time UTC. /// /// The info. /// DateTime. public DateTime GetLastWriteTimeUtc(FileSystemInfo info) { // This could throw an error on some file systems that have dates out of range try { return info.LastWriteTimeUtc; } catch (Exception ex) { Logger.ErrorException("Error determining LastAccessTimeUtc for {0}", ex, info.FullName); return DateTime.MinValue; } } /// /// Gets the last write time UTC. /// /// The path. /// DateTime. public DateTime GetLastWriteTimeUtc(string path) { return GetLastWriteTimeUtc(GetFileSystemInfo(path)); } /// /// Gets the file stream. /// /// The path. /// The mode. /// The access. /// The share. /// if set to true [is asynchronous]. /// FileStream. public Stream GetFileStream(string path, FileOpenMode mode, FileAccessMode access, FileShareMode share, bool isAsync = false) { if (_supportsAsyncFileStreams && isAsync) { return new FileStream(path, GetFileMode(mode), GetFileAccess(access), GetFileShare(share), 262144, true); } return new FileStream(path, GetFileMode(mode), GetFileAccess(access), GetFileShare(share), 262144); } private FileMode GetFileMode(FileOpenMode mode) { switch (mode) { case FileOpenMode.Append: return FileMode.Append; case FileOpenMode.Create: return FileMode.Create; case FileOpenMode.CreateNew: return FileMode.CreateNew; case FileOpenMode.Open: return FileMode.Open; case FileOpenMode.OpenOrCreate: return FileMode.OpenOrCreate; case FileOpenMode.Truncate: return FileMode.Truncate; default: throw new Exception("Unrecognized FileOpenMode"); } } private FileAccess GetFileAccess(FileAccessMode mode) { var val = (int)mode; return (FileAccess)val; } private FileShare GetFileShare(FileShareMode mode) { var val = (int)mode; return (FileShare)val; } public void SetHidden(string path, bool isHidden) { var info = GetFileInfo(path); if (info.Exists && info.IsHidden != isHidden) { if (isHidden) { FileAttributes attributes = File.GetAttributes(path); attributes = RemoveAttribute(attributes, FileAttributes.Hidden); File.SetAttributes(path, attributes); } else { File.SetAttributes(path, File.GetAttributes(path) | FileAttributes.Hidden); } } } private static FileAttributes RemoveAttribute(FileAttributes attributes, FileAttributes attributesToRemove) { return attributes & ~attributesToRemove; } /// /// Swaps the files. /// /// The file1. /// The file2. public void SwapFiles(string file1, string file2) { if (string.IsNullOrEmpty(file1)) { throw new ArgumentNullException("file1"); } if (string.IsNullOrEmpty(file2)) { throw new ArgumentNullException("file2"); } var temp1 = Path.GetTempFileName(); var temp2 = Path.GetTempFileName(); // Copying over will fail against hidden files RemoveHiddenAttribute(file1); RemoveHiddenAttribute(file2); CopyFile(file1, temp1, true); CopyFile(file2, temp2, true); CopyFile(temp1, file2, true); CopyFile(temp2, file1, true); DeleteFile(temp1); DeleteFile(temp2); } /// /// Removes the hidden attribute. /// /// The path. private void RemoveHiddenAttribute(string path) { if (string.IsNullOrEmpty(path)) { throw new ArgumentNullException("path"); } var currentFile = new FileInfo(path); // This will fail if the file is hidden if (currentFile.Exists) { if ((currentFile.Attributes & FileAttributes.Hidden) == FileAttributes.Hidden) { currentFile.Attributes &= ~FileAttributes.Hidden; } } } public bool ContainsSubPath(string parentPath, string path) { if (string.IsNullOrEmpty(parentPath)) { throw new ArgumentNullException("parentPath"); } if (string.IsNullOrEmpty(path)) { throw new ArgumentNullException("path"); } return path.IndexOf(parentPath.TrimEnd(Path.DirectorySeparatorChar) + Path.DirectorySeparatorChar, StringComparison.OrdinalIgnoreCase) != -1; } public bool IsRootPath(string path) { if (string.IsNullOrEmpty(path)) { throw new ArgumentNullException("path"); } var parent = Path.GetDirectoryName(path); if (!string.IsNullOrEmpty(parent)) { return false; } return true; } public string NormalizePath(string path) { if (string.IsNullOrEmpty(path)) { throw new ArgumentNullException("path"); } if (path.EndsWith(":\\", StringComparison.OrdinalIgnoreCase)) { return path; } return path.TrimEnd(Path.DirectorySeparatorChar); } public string GetFileNameWithoutExtension(FileSystemMetadata info) { if (info.IsDirectory) { return info.Name; } return Path.GetFileNameWithoutExtension(info.FullName); } public string GetFileNameWithoutExtension(string path) { return Path.GetFileNameWithoutExtension(path); } public bool IsPathFile(string path) { if (string.IsNullOrWhiteSpace(path)) { throw new ArgumentNullException("path"); } // Cannot use Path.IsPathRooted because it returns false under mono when using windows-based paths, e.g. C:\\ if (path.IndexOf("://", StringComparison.OrdinalIgnoreCase) != -1 && !path.StartsWith("file://", StringComparison.OrdinalIgnoreCase)) { return false; } return true; //return Path.IsPathRooted(path); } public void DeleteFile(string path) { File.Delete(path); } public void DeleteDirectory(string path, bool recursive) { Directory.Delete(path, recursive); } public void CreateDirectory(string path) { Directory.CreateDirectory(path); } public IEnumerable GetDirectories(string path, bool recursive = false) { var searchOption = recursive ? SearchOption.AllDirectories : SearchOption.TopDirectoryOnly; return ToMetadata(path, new DirectoryInfo(path).EnumerateDirectories("*", searchOption)); } public IEnumerable GetFiles(string path, bool recursive = false) { var searchOption = recursive ? SearchOption.AllDirectories : SearchOption.TopDirectoryOnly; return ToMetadata(path, new DirectoryInfo(path).EnumerateFiles("*", searchOption)); } public IEnumerable GetFileSystemEntries(string path, bool recursive = false) { var directoryInfo = new DirectoryInfo(path); var searchOption = recursive ? SearchOption.AllDirectories : SearchOption.TopDirectoryOnly; if (EnableFileSystemRequestConcat) { return ToMetadata(path, directoryInfo.EnumerateDirectories("*", searchOption)) .Concat(ToMetadata(path, directoryInfo.EnumerateFiles("*", searchOption))); } return ToMetadata(path, directoryInfo.EnumerateFileSystemInfos("*", searchOption)); } private IEnumerable ToMetadata(string parentPath, IEnumerable infos) { return infos.Select(i => { try { return GetFileSystemMetadata(i); } catch (PathTooLongException) { // Can't log using the FullName because it will throw the PathTooLongExceptiona again //Logger.Warn("Path too long: {0}", i.FullName); Logger.Warn("File or directory path too long. Parent folder: {0}", parentPath); return null; } }).Where(i => i != null); } public Stream OpenRead(string path) { return File.OpenRead(path); } public void CopyFile(string source, string target, bool overwrite) { File.Copy(source, target, overwrite); } public void MoveFile(string source, string target) { File.Move(source, target); } public void MoveDirectory(string source, string target) { Directory.Move(source, target); } public bool DirectoryExists(string path) { return Directory.Exists(path); } public bool FileExists(string path) { return File.Exists(path); } public string ReadAllText(string path) { return File.ReadAllText(path); } public void WriteAllText(string path, string text, Encoding encoding) { File.WriteAllText(path, text, encoding); } public void WriteAllText(string path, string text) { File.WriteAllText(path, text); } public string ReadAllText(string path, Encoding encoding) { return File.ReadAllText(path, encoding); } public IEnumerable GetDirectoryPaths(string path, bool recursive = false) { var searchOption = recursive ? SearchOption.AllDirectories : SearchOption.TopDirectoryOnly; return Directory.EnumerateDirectories(path, "*", searchOption); } public IEnumerable GetFilePaths(string path, bool recursive = false) { var searchOption = recursive ? SearchOption.AllDirectories : SearchOption.TopDirectoryOnly; return Directory.EnumerateFiles(path, "*", searchOption); } public IEnumerable GetFileSystemEntryPaths(string path, bool recursive = false) { var searchOption = recursive ? SearchOption.AllDirectories : SearchOption.TopDirectoryOnly; return Directory.EnumerateFileSystemEntries(path, "*", searchOption); } } }