initial checkin of yaulw (locally)
This commit is contained in:
Donald Duck
452
@integrate/Trinet.Core.IO.Ntfs/FileSystem.cs
Normal file
452
@integrate/Trinet.Core.IO.Ntfs/FileSystem.cs
Normal file
@@ -0,0 +1,452 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using System.Security;
|
||||
using System.Security.Permissions;
|
||||
|
||||
namespace Trinet.Core.IO.Ntfs
|
||||
{
|
||||
using Resources = Properties.Resources;
|
||||
|
||||
/// <summary>
|
||||
/// File-system utilities.
|
||||
/// </summary>
|
||||
public static class FileSystem
|
||||
{
|
||||
#region Create FileSystemInfo
|
||||
|
||||
/// <summary>
|
||||
/// Creates a <see cref="FileSystemInfo"/> for the specified path.
|
||||
/// </summary>
|
||||
/// <param name="path">
|
||||
/// The path of the file or directory.
|
||||
/// </param>
|
||||
/// <returns>
|
||||
/// The <see cref="FileSystemInfo"/> representing the file or directory.
|
||||
/// </returns>
|
||||
/// <exception cref="ArgumentNullException">
|
||||
/// <paramref name="path"/> is <see langword="null"/> or empty.
|
||||
/// </exception>
|
||||
private static FileSystemInfo CreateInfo(string path)
|
||||
{
|
||||
if (string.IsNullOrEmpty(path)) throw new ArgumentNullException("path");
|
||||
|
||||
path = Path.GetFullPath(path);
|
||||
if (!File.Exists(path) && Directory.Exists(path)) return new DirectoryInfo(path);
|
||||
return new FileInfo(path);
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region List Streams
|
||||
|
||||
/// <summary>
|
||||
/// <span style="font-weight:bold;color:#a00;">(Extension Method)</span><br />
|
||||
/// Returns a read-only list of alternate data streams for the specified file.
|
||||
/// </summary>
|
||||
/// <param name="file">
|
||||
/// The <see cref="FileSystemInfo"/> to inspect.
|
||||
/// </param>
|
||||
/// <returns>
|
||||
/// A read-only list of <see cref="AlternateDataStreamInfo"/> objects
|
||||
/// representing the alternate data streams for the specified file, if any.
|
||||
/// If no streams are found, returns an empty list.
|
||||
/// </returns>
|
||||
/// <exception cref="ArgumentNullException">
|
||||
/// <paramref name="file"/> is <see langword="null"/>.
|
||||
/// </exception>
|
||||
/// <exception cref="FileNotFoundException">
|
||||
/// The specified <paramref name="file"/> does not exist.
|
||||
/// </exception>
|
||||
/// <exception cref="SecurityException">
|
||||
/// The caller does not have the required permission.
|
||||
/// </exception>
|
||||
/// <exception cref="UnauthorizedAccessException">
|
||||
/// The caller does not have the required permission.
|
||||
/// </exception>
|
||||
public static IList<AlternateDataStreamInfo> ListAlternateDataStreams(this FileSystemInfo file)
|
||||
{
|
||||
if (null == file) throw new ArgumentNullException("file");
|
||||
if (!file.Exists) throw new FileNotFoundException(null, file.FullName);
|
||||
|
||||
string path = file.FullName;
|
||||
new FileIOPermission(FileIOPermissionAccess.Read, path).Demand();
|
||||
|
||||
return SafeNativeMethods.ListStreams(path)
|
||||
.Select(s => new AlternateDataStreamInfo(path, s))
|
||||
.ToList().AsReadOnly();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns a read-only list of alternate data streams for the specified file.
|
||||
/// </summary>
|
||||
/// <param name="filePath">
|
||||
/// The full path of the file to inspect.
|
||||
/// </param>
|
||||
/// <returns>
|
||||
/// A read-only list of <see cref="AlternateDataStreamInfo"/> objects
|
||||
/// representing the alternate data streams for the specified file, if any.
|
||||
/// </returns>
|
||||
/// <exception cref="ArgumentNullException">
|
||||
/// <paramref name="filePath"/> is <see langword="null"/> or an empty string.
|
||||
/// </exception>
|
||||
/// <exception cref="ArgumentException">
|
||||
/// <paramref name="filePath"/> is not a valid file path.
|
||||
/// </exception>
|
||||
/// <exception cref="FileNotFoundException">
|
||||
/// The specified <paramref name="filePath"/> does not exist.
|
||||
/// </exception>
|
||||
/// <exception cref="SecurityException">
|
||||
/// The caller does not have the required permission.
|
||||
/// </exception>
|
||||
/// <exception cref="UnauthorizedAccessException">
|
||||
/// The caller does not have the required permission.
|
||||
/// </exception>
|
||||
public static IList<AlternateDataStreamInfo> ListAlternateDataStreams(string filePath)
|
||||
{
|
||||
if (string.IsNullOrEmpty(filePath)) throw new ArgumentNullException("filePath");
|
||||
return CreateInfo(filePath).ListAlternateDataStreams();
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region Stream Exists
|
||||
|
||||
/// <summary>
|
||||
/// <span style="font-weight:bold;color:#a00;">(Extension Method)</span><br />
|
||||
/// Returns a flag indicating whether the specified alternate data stream exists.
|
||||
/// </summary>
|
||||
/// <param name="file">
|
||||
/// The <see cref="FileInfo"/> to inspect.
|
||||
/// </param>
|
||||
/// <param name="streamName">
|
||||
/// The name of the stream to find.
|
||||
/// </param>
|
||||
/// <returns>
|
||||
/// <see langword="true"/> if the specified stream exists;
|
||||
/// otherwise, <see langword="false"/>.
|
||||
/// </returns>
|
||||
/// <exception cref="ArgumentNullException">
|
||||
/// <paramref name="file"/> is <see langword="null"/>.
|
||||
/// </exception>
|
||||
/// <exception cref="ArgumentException">
|
||||
/// <paramref name="streamName"/> contains invalid characters.
|
||||
/// </exception>
|
||||
public static bool AlternateDataStreamExists(this FileSystemInfo file, string streamName)
|
||||
{
|
||||
if (null == file) throw new ArgumentNullException("file");
|
||||
SafeNativeMethods.ValidateStreamName(streamName);
|
||||
|
||||
string path = SafeNativeMethods.BuildStreamPath(file.FullName, streamName);
|
||||
return -1 != SafeNativeMethods.SafeGetFileAttributes(path);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns a flag indicating whether the specified alternate data stream exists.
|
||||
/// </summary>
|
||||
/// <param name="filePath">
|
||||
/// The path of the file to inspect.
|
||||
/// </param>
|
||||
/// <param name="streamName">
|
||||
/// The name of the stream to find.
|
||||
/// </param>
|
||||
/// <returns>
|
||||
/// <see langword="true"/> if the specified stream exists;
|
||||
/// otherwise, <see langword="false"/>.
|
||||
/// </returns>
|
||||
/// <exception cref="ArgumentNullException">
|
||||
/// <paramref name="filePath"/> is <see langword="null"/> or an empty string.
|
||||
/// </exception>
|
||||
/// <exception cref="ArgumentException">
|
||||
/// <para><paramref name="filePath"/> is not a valid file path.</para>
|
||||
/// <para>-or-</para>
|
||||
/// <para><paramref name="streamName"/> contains invalid characters.</para>
|
||||
/// </exception>
|
||||
public static bool AlternateDataStreamExists(string filePath, string streamName)
|
||||
{
|
||||
if (string.IsNullOrEmpty(filePath)) throw new ArgumentNullException("filePath");
|
||||
return CreateInfo(filePath).AlternateDataStreamExists(streamName);
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region Open Stream
|
||||
|
||||
/// <summary>
|
||||
/// <span style="font-weight:bold;color:#a00;">(Extension Method)</span><br />
|
||||
/// Opens an alternate data stream.
|
||||
/// </summary>
|
||||
/// <param name="file">
|
||||
/// The <see cref="FileInfo"/> which contains the stream.
|
||||
/// </param>
|
||||
/// <param name="streamName">
|
||||
/// The name of the stream to open.
|
||||
/// </param>
|
||||
/// <param name="mode">
|
||||
/// One of the <see cref="FileMode"/> values, indicating how the stream is to be opened.
|
||||
/// </param>
|
||||
/// <returns>
|
||||
/// An <see cref="AlternateDataStreamInfo"/> representing the stream.
|
||||
/// </returns>
|
||||
/// <exception cref="ArgumentNullException">
|
||||
/// <paramref name="file"/> is <see langword="null"/>.
|
||||
/// </exception>
|
||||
/// <exception cref="FileNotFoundException">
|
||||
/// The specified <paramref name="file"/> was not found.
|
||||
/// </exception>
|
||||
/// <exception cref="ArgumentException">
|
||||
/// <paramref name="streamName"/> contains invalid characters.
|
||||
/// </exception>
|
||||
/// <exception cref="NotSupportedException">
|
||||
/// <paramref name="mode"/> is either <see cref="FileMode.Truncate"/> or <see cref="FileMode.Append"/>.
|
||||
/// </exception>
|
||||
/// <exception cref="IOException">
|
||||
/// <para><paramref name="mode"/> is <see cref="FileMode.Open"/>, and the stream doesn't exist.</para>
|
||||
/// <para>-or-</para>
|
||||
/// <para><paramref name="mode"/> is <see cref="FileMode.CreateNew"/>, and the stream already exists.</para>
|
||||
/// </exception>
|
||||
/// <exception cref="SecurityException">
|
||||
/// The caller does not have the required permission.
|
||||
/// </exception>
|
||||
/// <exception cref="UnauthorizedAccessException">
|
||||
/// The caller does not have the required permission, or the file is read-only.
|
||||
/// </exception>
|
||||
public static AlternateDataStreamInfo GetAlternateDataStream(this FileSystemInfo file, string streamName, FileMode mode)
|
||||
{
|
||||
if (null == file) throw new ArgumentNullException("file");
|
||||
if (!file.Exists) throw new FileNotFoundException(null, file.FullName);
|
||||
SafeNativeMethods.ValidateStreamName(streamName);
|
||||
|
||||
if (FileMode.Truncate == mode || FileMode.Append == mode)
|
||||
{
|
||||
throw new NotSupportedException(string.Format(Resources.Culture,
|
||||
Resources.Error_InvalidMode, mode));
|
||||
}
|
||||
|
||||
FileIOPermissionAccess permAccess = (FileMode.Open == mode) ? FileIOPermissionAccess.Read : FileIOPermissionAccess.Read | FileIOPermissionAccess.Write;
|
||||
new FileIOPermission(permAccess, file.FullName).Demand();
|
||||
|
||||
string path = SafeNativeMethods.BuildStreamPath(file.FullName, streamName);
|
||||
bool exists = -1 != SafeNativeMethods.SafeGetFileAttributes(path);
|
||||
|
||||
if (!exists && FileMode.Open == mode)
|
||||
{
|
||||
throw new IOException(string.Format(Resources.Culture,
|
||||
Resources.Error_StreamNotFound, streamName, file.Name));
|
||||
}
|
||||
if (exists && FileMode.CreateNew == mode)
|
||||
{
|
||||
throw new IOException(string.Format(Resources.Culture,
|
||||
Resources.Error_StreamExists, streamName, file.Name));
|
||||
}
|
||||
|
||||
return new AlternateDataStreamInfo(file.FullName, streamName, path, exists);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// <span style="font-weight:bold;color:#a00;">(Extension Method)</span><br />
|
||||
/// Opens an alternate data stream.
|
||||
/// </summary>
|
||||
/// <param name="file">
|
||||
/// The <see cref="FileInfo"/> which contains the stream.
|
||||
/// </param>
|
||||
/// <param name="streamName">
|
||||
/// The name of the stream to open.
|
||||
/// </param>
|
||||
/// <returns>
|
||||
/// An <see cref="AlternateDataStreamInfo"/> representing the stream.
|
||||
/// </returns>
|
||||
/// <exception cref="ArgumentNullException">
|
||||
/// <paramref name="file"/> is <see langword="null"/>.
|
||||
/// </exception>
|
||||
/// <exception cref="FileNotFoundException">
|
||||
/// The specified <paramref name="file"/> was not found.
|
||||
/// </exception>
|
||||
/// <exception cref="ArgumentException">
|
||||
/// <paramref name="streamName"/> contains invalid characters.
|
||||
/// </exception>
|
||||
/// <exception cref="SecurityException">
|
||||
/// The caller does not have the required permission.
|
||||
/// </exception>
|
||||
/// <exception cref="UnauthorizedAccessException">
|
||||
/// The caller does not have the required permission, or the file is read-only.
|
||||
/// </exception>
|
||||
public static AlternateDataStreamInfo GetAlternateDataStream(this FileSystemInfo file, string streamName)
|
||||
{
|
||||
return file.GetAlternateDataStream(streamName, FileMode.OpenOrCreate);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Opens an alternate data stream.
|
||||
/// </summary>
|
||||
/// <param name="filePath">
|
||||
/// The path of the file which contains the stream.
|
||||
/// </param>
|
||||
/// <param name="streamName">
|
||||
/// The name of the stream to open.
|
||||
/// </param>
|
||||
/// <param name="mode">
|
||||
/// One of the <see cref="FileMode"/> values, indicating how the stream is to be opened.
|
||||
/// </param>
|
||||
/// <returns>
|
||||
/// An <see cref="AlternateDataStreamInfo"/> representing the stream.
|
||||
/// </returns>
|
||||
/// <exception cref="ArgumentNullException">
|
||||
/// <paramref name="filePath"/> is <see langword="null"/> or an empty string.
|
||||
/// </exception>
|
||||
/// <exception cref="FileNotFoundException">
|
||||
/// The specified <paramref name="filePath"/> was not found.
|
||||
/// </exception>
|
||||
/// <exception cref="ArgumentException">
|
||||
/// <para><paramref name="filePath"/> is not a valid file path.</para>
|
||||
/// <para>-or-</para>
|
||||
/// <para><paramref name="streamName"/> contains invalid characters.</para>
|
||||
/// </exception>
|
||||
/// <exception cref="NotSupportedException">
|
||||
/// <paramref name="mode"/> is either <see cref="FileMode.Truncate"/> or <see cref="FileMode.Append"/>.
|
||||
/// </exception>
|
||||
/// <exception cref="IOException">
|
||||
/// <para><paramref name="mode"/> is <see cref="FileMode.Open"/>, and the stream doesn't exist.</para>
|
||||
/// <para>-or-</para>
|
||||
/// <para><paramref name="mode"/> is <see cref="FileMode.CreateNew"/>, and the stream already exists.</para>
|
||||
/// </exception>
|
||||
/// <exception cref="SecurityException">
|
||||
/// The caller does not have the required permission.
|
||||
/// </exception>
|
||||
/// <exception cref="UnauthorizedAccessException">
|
||||
/// The caller does not have the required permission, or the file is read-only.
|
||||
/// </exception>
|
||||
public static AlternateDataStreamInfo GetAlternateDataStream(string filePath, string streamName, FileMode mode)
|
||||
{
|
||||
if (string.IsNullOrEmpty(filePath)) throw new ArgumentNullException("filePath");
|
||||
return CreateInfo(filePath).GetAlternateDataStream(streamName, mode);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Opens an alternate data stream.
|
||||
/// </summary>
|
||||
/// <param name="filePath">
|
||||
/// The path of the file which contains the stream.
|
||||
/// </param>
|
||||
/// <param name="streamName">
|
||||
/// The name of the stream to open.
|
||||
/// </param>
|
||||
/// <returns>
|
||||
/// An <see cref="AlternateDataStreamInfo"/> representing the stream.
|
||||
/// </returns>
|
||||
/// <exception cref="ArgumentNullException">
|
||||
/// <paramref name="filePath"/> is <see langword="null"/> or an empty string.
|
||||
/// </exception>
|
||||
/// <exception cref="FileNotFoundException">
|
||||
/// The specified <paramref name="filePath"/> was not found.
|
||||
/// </exception>
|
||||
/// <exception cref="ArgumentException">
|
||||
/// <para><paramref name="filePath"/> is not a valid file path.</para>
|
||||
/// <para>-or-</para>
|
||||
/// <para><paramref name="streamName"/> contains invalid characters.</para>
|
||||
/// </exception>
|
||||
/// <exception cref="SecurityException">
|
||||
/// The caller does not have the required permission.
|
||||
/// </exception>
|
||||
/// <exception cref="UnauthorizedAccessException">
|
||||
/// The caller does not have the required permission, or the file is read-only.
|
||||
/// </exception>
|
||||
public static AlternateDataStreamInfo GetAlternateDataStream(string filePath, string streamName)
|
||||
{
|
||||
return GetAlternateDataStream(filePath, streamName, FileMode.OpenOrCreate);
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region Delete Stream
|
||||
|
||||
/// <summary>
|
||||
/// <span style="font-weight:bold;color:#a00;">(Extension Method)</span><br />
|
||||
/// Deletes the specified alternate data stream if it exists.
|
||||
/// </summary>
|
||||
/// <param name="file">
|
||||
/// The <see cref="FileInfo"/> to inspect.
|
||||
/// </param>
|
||||
/// <param name="streamName">
|
||||
/// The name of the stream to delete.
|
||||
/// </param>
|
||||
/// <returns>
|
||||
/// <see langword="true"/> if the specified stream is deleted;
|
||||
/// otherwise, <see langword="false"/>.
|
||||
/// </returns>
|
||||
/// <exception cref="ArgumentNullException">
|
||||
/// <paramref name="file"/> is <see langword="null"/>.
|
||||
/// </exception>
|
||||
/// <exception cref="ArgumentException">
|
||||
/// <paramref name="streamName"/> contains invalid characters.
|
||||
/// </exception>
|
||||
/// <exception cref="SecurityException">
|
||||
/// The caller does not have the required permission.
|
||||
/// </exception>
|
||||
/// <exception cref="UnauthorizedAccessException">
|
||||
/// The caller does not have the required permission, or the file is read-only.
|
||||
/// </exception>
|
||||
/// <exception cref="IOException">
|
||||
/// The specified file is in use.
|
||||
/// </exception>
|
||||
public static bool DeleteAlternateDataStream(this FileSystemInfo file, string streamName)
|
||||
{
|
||||
if (null == file) throw new ArgumentNullException("file");
|
||||
SafeNativeMethods.ValidateStreamName(streamName);
|
||||
|
||||
const FileIOPermissionAccess permAccess = FileIOPermissionAccess.Write;
|
||||
new FileIOPermission(permAccess, file.FullName).Demand();
|
||||
|
||||
var result = false;
|
||||
if (file.Exists)
|
||||
{
|
||||
string path = SafeNativeMethods.BuildStreamPath(file.FullName, streamName);
|
||||
if (-1 != SafeNativeMethods.SafeGetFileAttributes(path))
|
||||
{
|
||||
result = SafeNativeMethods.SafeDeleteFile(path);
|
||||
}
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Deletes the specified alternate data stream if it exists.
|
||||
/// </summary>
|
||||
/// <param name="filePath">
|
||||
/// The path of the file to inspect.
|
||||
/// </param>
|
||||
/// <param name="streamName">
|
||||
/// The name of the stream to find.
|
||||
/// </param>
|
||||
/// <returns>
|
||||
/// <see langword="true"/> if the specified stream is deleted;
|
||||
/// otherwise, <see langword="false"/>.
|
||||
/// </returns>
|
||||
/// <exception cref="ArgumentNullException">
|
||||
/// <paramref name="filePath"/> is <see langword="null"/> or an empty string.
|
||||
/// </exception>
|
||||
/// <exception cref="ArgumentException">
|
||||
/// <para><paramref name="filePath"/> is not a valid file path.</para>
|
||||
/// <para>-or-</para>
|
||||
/// <para><paramref name="streamName"/> contains invalid characters.</para>
|
||||
/// </exception>
|
||||
/// <exception cref="SecurityException">
|
||||
/// The caller does not have the required permission.
|
||||
/// </exception>
|
||||
/// <exception cref="UnauthorizedAccessException">
|
||||
/// The caller does not have the required permission, or the file is read-only.
|
||||
/// </exception>
|
||||
/// <exception cref="IOException">
|
||||
/// The specified file is in use.
|
||||
/// </exception>
|
||||
public static bool DeleteAlternateDataStream(string filePath, string streamName)
|
||||
{
|
||||
if (string.IsNullOrEmpty(filePath)) throw new ArgumentNullException("filePath");
|
||||
return CreateInfo(filePath).DeleteAlternateDataStream(streamName);
|
||||
}
|
||||
|
||||
#endregion
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user