/* Copyright (C) 2008-2016 Peter Palotas, Jeffrey Jangli, Alexandr Normuradov * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ using System; using System.Diagnostics.CodeAnalysis; using System.Globalization; using System.IO; using System.Runtime.InteropServices; using System.Security; namespace Alphaleonis.Win32.Filesystem { partial class Directory { #region .NET /// Deletes an empty directory from a specified path. /// /// /// /// /// /// /// /// The name of the empty directory to remove. This directory must be writable and empty. [SecurityCritical] public static void Delete(string path) { DeleteDirectoryCore(null, null, path, false, false, true, false, PathFormat.RelativePath); } /// Deletes the specified directory and, if indicated, any subdirectories in the directory. /// /// /// /// /// /// /// /// The name of the directory to remove. /// to remove directories, subdirectories, and files in . otherwise. [SecurityCritical] public static void Delete(string path, bool recursive) { DeleteDirectoryCore(null, null, path, recursive, false, !recursive, false, PathFormat.RelativePath); } #endregion // .NET /// [AlphaFS] Deletes an empty directory from a specified path. /// /// /// /// /// /// /// /// The name of the empty directory to remove. This directory must be writable and empty. /// Indicates the format of the path parameter(s). [SecurityCritical] public static void Delete(string path, PathFormat pathFormat) { DeleteDirectoryCore(null, null, path, false, false, true, false, pathFormat); } /// [AlphaFS] Deletes the specified directory and, if indicated, any subdirectories in the directory. /// /// /// /// /// /// /// /// The name of the directory to remove. /// to remove directories, subdirectories, and files in . otherwise. /// Indicates the format of the path parameter(s). [SecurityCritical] public static void Delete(string path, bool recursive, PathFormat pathFormat) { DeleteDirectoryCore(null, null, path, recursive, false, !recursive, false, pathFormat); } /// [AlphaFS] Deletes the specified directory and, if indicated, any subdirectories in the directory. /// /// /// /// /// /// /// /// The name of the directory to remove. /// to remove directories, subdirectories, and files in . otherwise. /// overrides read only of files and directories. [SecurityCritical] public static void Delete(string path, bool recursive, bool ignoreReadOnly) { DeleteDirectoryCore(null, null, path, recursive, ignoreReadOnly, !recursive, false, PathFormat.RelativePath); } /// [AlphaFS] Deletes the specified directory and, if indicated, any subdirectories in the directory. /// /// /// /// /// /// /// /// The name of the directory to remove. /// to remove directories, subdirectories, and files in . otherwise. /// overrides read only of files and directories. /// Indicates the format of the path parameter(s). [SecurityCritical] public static void Delete(string path, bool recursive, bool ignoreReadOnly, PathFormat pathFormat) { DeleteDirectoryCore(null, null, path, recursive, ignoreReadOnly, !recursive, false, pathFormat); } #region Transactional /// [AlphaFS] Deletes an empty directory from a specified path. /// /// /// /// /// /// /// /// The transaction. /// The name of the empty directory to remove. This directory must be writable and empty. [SecurityCritical] public static void DeleteTransacted(KernelTransaction transaction, string path) { DeleteDirectoryCore(null, transaction, path, false, false, true, false, PathFormat.RelativePath); } /// [AlphaFS] Deletes an empty directory from a specified path. /// /// /// /// /// /// /// /// The transaction. /// The name of the empty directory to remove. This directory must be writable and empty. /// Indicates the format of the path parameter(s). [SecurityCritical] public static void DeleteTransacted(KernelTransaction transaction, string path, PathFormat pathFormat) { DeleteDirectoryCore(null, transaction, path, false, false, true, false, pathFormat); } /// [AlphaFS] Deletes the specified directory and, if indicated, any subdirectories in the directory. /// /// /// /// /// /// /// /// The transaction. /// The name of the directory to remove. /// to remove directories, subdirectories, and files in . otherwise. [SecurityCritical] public static void DeleteTransacted(KernelTransaction transaction, string path, bool recursive) { DeleteDirectoryCore(null, transaction, path, recursive, false, !recursive, false, PathFormat.RelativePath); } /// [AlphaFS] Deletes the specified directory and, if indicated, any subdirectories in the directory. /// /// /// /// /// /// /// /// The transaction. /// The name of the directory to remove. /// to remove directories, subdirectories, and files in . otherwise. /// Indicates the format of the path parameter(s). [SecurityCritical] public static void DeleteTransacted(KernelTransaction transaction, string path, bool recursive, PathFormat pathFormat) { DeleteDirectoryCore(null, transaction, path, recursive, false, !recursive, false, pathFormat); } /// [AlphaFS] Deletes the specified directory and, if indicated, any subdirectories in the directory. /// /// /// /// /// /// /// /// The transaction. /// The name of the directory to remove. /// to remove directories, subdirectories, and files in . otherwise. /// overrides read only of files and directories. [SecurityCritical] public static void DeleteTransacted(KernelTransaction transaction, string path, bool recursive, bool ignoreReadOnly) { DeleteDirectoryCore(null, transaction, path, recursive, ignoreReadOnly, !recursive, false, PathFormat.RelativePath); } /// [AlphaFS] Deletes the specified directory and, if indicated, any subdirectories in the directory. /// /// /// /// /// /// /// /// The transaction. /// The name of the directory to remove. /// to remove directories, subdirectories, and files in . otherwise. /// overrides read only of files and directories. /// Indicates the format of the path parameter(s). [SecurityCritical] public static void DeleteTransacted(KernelTransaction transaction, string path, bool recursive, bool ignoreReadOnly, PathFormat pathFormat) { DeleteDirectoryCore(null, transaction, path, recursive, ignoreReadOnly, !recursive, false, pathFormat); } #endregion // Transactional #region Internal Methods /// Deletes the specified directory and, if indicated, any subdirectories in the directory. /// The RemoveDirectory function marks a directory for deletion on close. Therefore, the directory is not removed until the last handle to the directory is closed. /// /// /// /// /// /// /// /// A FileSystemEntryInfo instance. Use either or , not both. /// The transaction. /// The name of the directory to remove. Use either or , not both. /// to remove all files and subdirectories recursively; otherwise only the top level empty directory. /// overrides read only attribute of files and directories. /// requires the directory must be empty. /// does not throw an Exception when the file system object does not exist. /// Indicates the format of the path parameter(s). [SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity")] [SecurityCritical] internal static void DeleteDirectoryCore(FileSystemEntryInfo fileSystemEntryInfo, KernelTransaction transaction, string path, bool recursive, bool ignoreReadOnly, bool requireEmpty, bool continueOnNotExist, PathFormat pathFormat) { #region Setup if (pathFormat == PathFormat.RelativePath) Path.CheckSupportedPathFormat(path, true, true); if (fileSystemEntryInfo == null) { // MSDN: .NET 3.5+: DirectoryNotFoundException: // Path does not exist or could not be found. // Path refers to a file instead of a directory. // The specified path is invalid (for example, it is on an unmapped drive). fileSystemEntryInfo = File.GetFileSystemEntryInfoCore(true, transaction, Path.GetExtendedLengthPathCore(transaction, path, pathFormat, GetFullPathOptions.TrimEnd | GetFullPathOptions.RemoveTrailingDirectorySeparator), continueOnNotExist, pathFormat); } if (fileSystemEntryInfo == null) return; string pathLp = fileSystemEntryInfo.LongFullPath; #endregion // Setup // Do not follow mount points nor symbolic links, but do delete the reparse point itself. // If directory is reparse point, disable recursion. if (recursive && fileSystemEntryInfo.IsReparsePoint) recursive = false; // Check to see if this is a mount point, and unmount it. if (fileSystemEntryInfo.IsMountPoint) { int lastError = Volume.DeleteVolumeMountPointCore(pathLp, true); if (lastError != Win32Errors.ERROR_SUCCESS && lastError != Win32Errors.ERROR_PATH_NOT_FOUND) NativeError.ThrowException(lastError, pathLp); // Now it is safe to delete the actual directory. } if (recursive) { // Enumerate all file system objects. foreach (var fsei in EnumerateFileSystemEntryInfosCore(transaction, pathLp, Path.WildcardStarMatchAll, DirectoryEnumerationOptions.FilesAndFolders, PathFormat.LongFullPath)) { if (fsei.IsDirectory) DeleteDirectoryCore(fsei, transaction, null, true, ignoreReadOnly, requireEmpty, true, PathFormat.LongFullPath); else File.DeleteFileCore(transaction, fsei.LongFullPath, ignoreReadOnly, PathFormat.LongFullPath); } } #region Remove startRemoveDirectory: if (!(transaction == null || !NativeMethods.IsAtLeastWindowsVista // RemoveDirectory() / RemoveDirectoryTransacted() // In the ANSI version of this function, the name is limited to MAX_PATH characters. // To extend this limit to 32,767 wide characters, call the Unicode version of the function and prepend "\\?\" to the path. // 2014-09-09: MSDN confirms LongPath usage. // RemoveDirectory on a symbolic link will remove the link itself. ? NativeMethods.RemoveDirectory(pathLp) : NativeMethods.RemoveDirectoryTransacted(pathLp, transaction.SafeHandle))) { int lastError = Marshal.GetLastWin32Error(); switch ((uint) lastError) { case Win32Errors.ERROR_DIR_NOT_EMPTY: if (requireEmpty) // MSDN: .NET 3.5+: IOException: The directory specified by path is not an empty directory. throw new DirectoryNotEmptyException(pathLp); goto startRemoveDirectory; case Win32Errors.ERROR_DIRECTORY: // MSDN: .NET 3.5+: DirectoryNotFoundException: Path refers to a file instead of a directory. if (File.ExistsCore(false, transaction, pathLp, PathFormat.LongFullPath)) throw new DirectoryNotFoundException(string.Format(CultureInfo.CurrentCulture, "({0}) {1}", Win32Errors.ERROR_INVALID_PARAMETER, string.Format(CultureInfo.CurrentCulture, Resources.Target_Directory_Is_A_File, pathLp))); break; case Win32Errors.ERROR_PATH_NOT_FOUND: if (continueOnNotExist) return; break; case Win32Errors.ERROR_SHARING_VIOLATION: // MSDN: .NET 3.5+: IOException: The directory is being used by another process or there is an open handle on the directory. NativeError.ThrowException(lastError, pathLp); break; case Win32Errors.ERROR_ACCESS_DENIED: var data = new NativeMethods.WIN32_FILE_ATTRIBUTE_DATA(); int dataInitialised = File.FillAttributeInfoCore(transaction, pathLp, ref data, false, true); if (data.dwFileAttributes != (FileAttributes) (-1)) { if ((data.dwFileAttributes & FileAttributes.ReadOnly) != 0) { // MSDN: .NET 3.5+: IOException: The directory specified by path is read-only. if (ignoreReadOnly) { // Reset directory attributes. File.SetAttributesCore(true, transaction, pathLp, FileAttributes.Normal, true, PathFormat.LongFullPath); goto startRemoveDirectory; } // MSDN: .NET 3.5+: IOException: The directory is read-only. throw new DirectoryReadOnlyException(pathLp); } } if (dataInitialised == Win32Errors.ERROR_SUCCESS) // MSDN: .NET 3.5+: UnauthorizedAccessException: The caller does not have the required permission. NativeError.ThrowException(lastError, pathLp); break; } // MSDN: .NET 3.5+: IOException: // A file with the same name and location specified by path exists. // The directory specified by path is read-only, or recursive is false and path is not an empty directory. // The directory is the application's current working directory. // The directory contains a read-only file. // The directory is being used by another process. NativeError.ThrowException(lastError, pathLp); } #endregion // Remove } #endregion // Internal Methods } }