// // System.IO.File.cs // // // Authors: // Miguel de Icaza (miguel@ximian.com) // Jim Richardson (develop@wtfo-guru.com) // Dan Lewis (dihlewis@yahoo.co.uk) // Ville Palo (vi64pa@kolumbus.fi) // // Copyright 2002 Ximian, Inc. http://www.ximian.com // Copyright (C) 2001 Moonlight Enterprises, All Rights Reserved // Copyright (C) 2004, 2006 Novell, Inc (http://www.novell.com) // // 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.Text; #if NET_2_0 using System.Collections.Generic; using System.Runtime.InteropServices; using System.Security.AccessControl; #endif namespace System.IO { #if NET_2_0 [ComVisible (true)] #endif public #if NET_2_0 static #else sealed #endif class File { #if !NET_2_0 private File () {} #endif #if NET_2_0 public static void AppendAllText (string path, string contents) { using (TextWriter w = new StreamWriter (path, true)) { w.Write (contents); } } public static void AppendAllText (string path, string contents, Encoding encoding) { using (TextWriter w = new StreamWriter (path, true, encoding)) { w.Write (contents); } } #endif public static StreamWriter AppendText (string path) { return new StreamWriter (path, true); } public static void Copy (string sourceFileName, string destFileName) { Copy (sourceFileName, destFileName, false); } public static void Copy (string sourceFileName, string destFileName, bool overwrite) { MonoIOError error; if (sourceFileName == null) throw new ArgumentNullException ("sourceFileName"); if (destFileName == null) throw new ArgumentNullException ("destFileName"); if (sourceFileName.Length == 0) throw new ArgumentException ("An empty file name is not valid.", "sourceFileName"); if (sourceFileName.Trim ().Length == 0 || sourceFileName.IndexOfAny (Path.InvalidPathChars) != -1) throw new ArgumentException ("The file name is not valid."); if (destFileName.Length == 0) throw new ArgumentException ("An empty file name is not valid.", "destFileName"); if (destFileName.Trim ().Length == 0 || destFileName.IndexOfAny (Path.InvalidPathChars) != -1) throw new ArgumentException ("The file name is not valid."); if (!MonoIO.Exists (sourceFileName, out error)) throw new FileNotFoundException (Locale.GetText ("{0} does not exist", sourceFileName), sourceFileName); if ((GetAttributes (sourceFileName) & FileAttributes.Directory) == FileAttributes.Directory) throw new ArgumentException (Locale.GetText ("{0} is a directory", sourceFileName)); if (MonoIO.Exists (destFileName, out error)) { if ((GetAttributes (destFileName) & FileAttributes.Directory) == FileAttributes.Directory) throw new ArgumentException (Locale.GetText ("{0} is a directory", destFileName)); if (!overwrite) throw new IOException (Locale.GetText ("{0} already exists", destFileName)); } string DirName = Path.GetDirectoryName (destFileName); if (DirName != String.Empty && !Directory.Exists (DirName)) throw new DirectoryNotFoundException (Locale.GetText ("Destination directory not found: {0}",DirName)); if (!MonoIO.CopyFile (sourceFileName, destFileName, overwrite, out error)) { string p = Locale.GetText ("{0}\" or \"{1}", sourceFileName, destFileName); throw MonoIO.GetException (p, error); } } public static FileStream Create (string path) { return Create (path, 8192, FileOptions.None, null); } public static FileStream Create (string path, int bufferSize) { return Create (path, bufferSize, FileOptions.None, null); } #if NET_2_0 [MonoTODO ("options not implemented")] public static FileStream Create (string path, int bufferSize, FileOptions options) { return Create (path, bufferSize, options, null); } [MonoTODO ("options and fileSecurity not implemented")] public static FileStream Create (string path, int bufferSize, FileOptions options, FileSecurity fileSecurity) #else private static FileStream Create (string path, int bufferSize, FileOptions options, object fileSecurity) #endif { if (null == path) throw new ArgumentNullException ("path"); if (String.Empty == path.Trim() || path.IndexOfAny(Path.InvalidPathChars) >= 0) throw new ArgumentException (Locale.GetText ("path is invalid")); string DirName = Path.GetDirectoryName(path); if (DirName != String.Empty && !Directory.Exists (DirName)) throw new DirectoryNotFoundException (Locale.GetText ("Destination directory not found: {0}", DirName)); if (Exists(path)){ if ((GetAttributes(path) & FileAttributes.ReadOnly) == FileAttributes.ReadOnly){ throw new UnauthorizedAccessException (Locale.GetText ("{0} is read-only", path)); } } return new FileStream (path, FileMode.Create, FileAccess.ReadWrite, FileShare.None, bufferSize); } public static StreamWriter CreateText(string path) { return new StreamWriter (path, false); } public static void Delete (string path) { if (null == path) throw new ArgumentNullException("path"); if (String.Empty == path.Trim() || path.IndexOfAny(Path.InvalidPathChars) >= 0) throw new ArgumentException("path"); if (Directory.Exists (path)) throw new UnauthorizedAccessException(Locale.GetText ("{0} is a directory", path)); string DirName = Path.GetDirectoryName(path); if (DirName != String.Empty && !Directory.Exists (DirName)) throw new DirectoryNotFoundException (Locale.GetText ("Destination directory not found: {0}", DirName)); MonoIOError error; if (!MonoIO.DeleteFile (path, out error)){ if (error != MonoIOError.ERROR_FILE_NOT_FOUND) throw MonoIO.GetException (path, error); } } public static bool Exists (string path) { // For security reasons no exceptions are // thrown, only false is returned if there is // any problem with the path or permissions. // Minimizes what information can be // discovered by using this method. if (null == path || path.Trim().Length == 0 || path.IndexOfAny(Path.InvalidPathChars) >= 0) { return false; } MonoIOError error; return MonoIO.ExistsFile (path, out error); } #if NET_2_0 public static FileSecurity GetAccessControl (string path) { throw new NotImplementedException (); } public static FileSecurity GetAccessControl (string path, AccessControlSections includeSections) { throw new NotImplementedException (); } #endif public static FileAttributes GetAttributes (string path) { if (path == null) throw new ArgumentNullException("path"); if (path.Trim ().Length == 0) throw new ArgumentException (Locale.GetText ("Path is empty")); if (path.IndexOfAny (Path.InvalidPathChars) >= 0) throw new ArgumentException (Locale.GetText ("Path contains invalid chars")); MonoIOError error; FileAttributes attrs; attrs = MonoIO.GetFileAttributes (path, out error); if (error != MonoIOError.ERROR_SUCCESS) throw MonoIO.GetException (path, error); return attrs; } public static DateTime GetCreationTime (string path) { MonoIOStat stat; MonoIOError error; CheckPathExceptions (path); if (!MonoIO.GetFileStat (path, out stat, out error)) { #if NET_2_0 if (error == MonoIOError.ERROR_PATH_NOT_FOUND || error == MonoIOError.ERROR_FILE_NOT_FOUND) return _defaultLocalFileTime; else throw new IOException (path); #else throw CreatePartOfPathNotFoundException (path); #endif } return DateTime.FromFileTime (stat.CreationTime); } public static DateTime GetCreationTimeUtc (string path) { return GetCreationTime (path).ToUniversalTime (); } public static DateTime GetLastAccessTime (string path) { MonoIOStat stat; MonoIOError error; CheckPathExceptions (path); if (!MonoIO.GetFileStat (path, out stat, out error)) { #if NET_2_0 if (error == MonoIOError.ERROR_PATH_NOT_FOUND || error == MonoIOError.ERROR_FILE_NOT_FOUND) return _defaultLocalFileTime; else throw new IOException (path); #else throw CreatePartOfPathNotFoundException (path); #endif } return DateTime.FromFileTime (stat.LastAccessTime); } public static DateTime GetLastAccessTimeUtc (string path) { return GetLastAccessTime (path).ToUniversalTime (); } public static DateTime GetLastWriteTime (string path) { MonoIOStat stat; MonoIOError error; CheckPathExceptions (path); if (!MonoIO.GetFileStat (path, out stat, out error)) { #if NET_2_0 if (error == MonoIOError.ERROR_PATH_NOT_FOUND || error == MonoIOError.ERROR_FILE_NOT_FOUND) return _defaultLocalFileTime; else throw new IOException (path); #else throw CreatePartOfPathNotFoundException (path); #endif } return DateTime.FromFileTime (stat.LastWriteTime); } public static DateTime GetLastWriteTimeUtc (string path) { return GetLastWriteTime (path).ToUniversalTime (); } public static void Move (string sourceFileName, string destFileName) { MonoIOError error; if (sourceFileName == null) throw new ArgumentNullException ("sourceFileName"); if (destFileName == null) throw new ArgumentNullException ("destFileName"); if (sourceFileName.Length == 0) throw new ArgumentException ("An empty file name is not valid.", "sourceFileName"); if (sourceFileName.Trim ().Length == 0 || sourceFileName.IndexOfAny (Path.InvalidPathChars) != -1) throw new ArgumentException ("The file name is not valid."); if (destFileName.Length == 0) throw new ArgumentException ("An empty file name is not valid.", "destFileName"); if (destFileName.Trim ().Length == 0 || destFileName.IndexOfAny (Path.InvalidPathChars) != -1) throw new ArgumentException ("The file name is not valid."); if (!MonoIO.Exists (sourceFileName, out error)) throw new FileNotFoundException (Locale.GetText ("{0} does not exist", sourceFileName), sourceFileName); if (MonoIO.ExistsDirectory (destFileName, out error)) throw new IOException (Locale.GetText ("{0} is a directory", destFileName)); // Don't check for this error here to allow the runtime // to check if sourceFileName and destFileName are equal. // Comparing sourceFileName and destFileName is not enough. //if (MonoIO.Exists (destFileName, out error)) // throw new IOException (Locale.GetText ("{0} already exists", destFileName)); string DirName; DirName = Path.GetDirectoryName (destFileName); if (DirName != String.Empty && !Directory.Exists (DirName)) throw new DirectoryNotFoundException(Locale.GetText ("Destination directory not found: {0}", DirName)); if (!MonoIO.MoveFile (sourceFileName, destFileName, out error)) { if (error == MonoIOError.ERROR_ALREADY_EXISTS) throw MonoIO.GetException (destFileName, error); else if (error == MonoIOError.ERROR_SHARING_VIOLATION) throw MonoIO.GetException (sourceFileName, error); throw MonoIO.GetException (error); } } public static FileStream Open (string path, FileMode mode) { return new FileStream (path, mode, mode == FileMode.Append ? FileAccess.Write : FileAccess.ReadWrite, FileShare.None); } public static FileStream Open (string path, FileMode mode, FileAccess access) { return new FileStream (path, mode, access, FileShare.None); } public static FileStream Open (string path, FileMode mode, FileAccess access, FileShare share) { return new FileStream (path, mode, access, share); } public static FileStream OpenRead (string path) { return new FileStream (path, FileMode.Open, FileAccess.Read, FileShare.Read); } public static StreamReader OpenText (string path) { return new StreamReader (path); } public static FileStream OpenWrite (string path) { return new FileStream(path, FileMode.OpenOrCreate, FileAccess.Write, FileShare.None); } #if NET_2_0 public static void Replace (string sourceFileName, string destinationFileName, string destinationBackupFileName) { Replace (sourceFileName, destinationFileName, destinationBackupFileName, false); } public static void Replace (string sourceFileName, string destinationFileName, string destinationBackupFileName, bool ignoreMetadataErrors) { MonoIOError error; if (sourceFileName == null) throw new ArgumentNullException ("sourceFileName"); if (destinationFileName == null) throw new ArgumentNullException ("destinationFileName"); if (sourceFileName.Trim ().Length == 0 || sourceFileName.IndexOfAny (Path.InvalidPathChars) != -1) throw new ArgumentException ("sourceFileName"); if (destinationFileName.Trim ().Length == 0 || destinationFileName.IndexOfAny (Path.InvalidPathChars) != -1) throw new ArgumentException ("destinationFileName"); string fullSource = Path.GetFullPath (sourceFileName); string fullDest = Path.GetFullPath (destinationFileName); if (MonoIO.ExistsDirectory (fullSource, out error)) throw new IOException (Locale.GetText ("{0} is a directory", sourceFileName)); if (MonoIO.ExistsDirectory (fullDest, out error)) throw new IOException (Locale.GetText ("{0} is a directory", destinationFileName)); if (!Exists (fullSource)) throw new FileNotFoundException (Locale.GetText ("{0} does not exist", sourceFileName), sourceFileName); if (!Exists (fullDest)) throw new FileNotFoundException (Locale.GetText ("{0} does not exist", destinationFileName), destinationFileName); if (fullSource == fullDest) throw new IOException (Locale.GetText ("Source and destination arguments are the same file.")); string fullBackup = null; if (destinationBackupFileName != null) { if (destinationBackupFileName.Trim ().Length == 0 || destinationBackupFileName.IndexOfAny (Path.InvalidPathChars) != -1) throw new ArgumentException ("destinationBackupFileName"); fullBackup = Path.GetFullPath (destinationBackupFileName); if (MonoIO.ExistsDirectory (fullBackup, out error)) throw new IOException (Locale.GetText ("{0} is a directory", destinationBackupFileName)); if (fullSource == fullBackup) throw new IOException (Locale.GetText ("Source and backup arguments are the same file.")); if (fullDest == fullBackup) throw new IOException (Locale.GetText ( "Destination and backup arguments are the same file.")); } if (!MonoIO.ReplaceFile (fullSource, fullDest, fullBackup, ignoreMetadataErrors, out error)) { throw MonoIO.GetException (error); } } public static void SetAccessControl (string path, FileSecurity fileSecurity) { throw new NotImplementedException (); } #endif public static void SetAttributes (string path, FileAttributes fileAttributes) { MonoIOError error; CheckPathExceptions (path); if (!MonoIO.SetFileAttributes (path, fileAttributes, out error)) throw MonoIO.GetException (path, error); } public static void SetCreationTime (string path, DateTime creationTime) { MonoIOError error; CheckPathExceptions (path); if (!MonoIO.Exists (path, out error)) throw MonoIO.GetException (path, error); if (!MonoIO.SetCreationTime (path, creationTime, out error)) throw MonoIO.GetException (path, error); } public static void SetCreationTimeUtc (string path, DateTime creationTimeUtc) { SetCreationTime (path, creationTimeUtc.ToLocalTime ()); } public static void SetLastAccessTime (string path, DateTime lastAccessTime) { MonoIOError error; CheckPathExceptions (path); if (!MonoIO.Exists (path, out error)) throw MonoIO.GetException (path, error); if (!MonoIO.SetLastAccessTime (path, lastAccessTime, out error)) throw MonoIO.GetException (path, error); } public static void SetLastAccessTimeUtc (string path, DateTime lastAccessTimeUtc) { SetLastAccessTime (path, lastAccessTimeUtc.ToLocalTime ()); } public static void SetLastWriteTime (string path, DateTime lastWriteTime) { MonoIOError error; CheckPathExceptions (path); if (!MonoIO.Exists (path, out error)) throw MonoIO.GetException (path, error); if (!MonoIO.SetLastWriteTime (path, lastWriteTime, out error)) throw MonoIO.GetException (path, error); } public static void SetLastWriteTimeUtc (string path, DateTime lastWriteTimeUtc) { SetLastWriteTime (path, lastWriteTimeUtc.ToLocalTime ()); } #region Private private static void CheckPathExceptions (string path) { if (path == null) throw new System.ArgumentNullException("path"); if (path.Length == 0) throw new System.ArgumentException(Locale.GetText ("Path is empty")); if (path.Trim().Length == 0) throw new ArgumentException (Locale.GetText ("Path is empty")); if (path.IndexOfAny (Path.InvalidPathChars) != -1) throw new ArgumentException (Locale.GetText ("Path contains invalid chars")); } private static IOException CreatePartOfPathNotFoundException (string path) { string msg = Locale.GetText ("Part of the path \"{0}\" could not be found.", path); return new IOException (msg); } #endregion #if NET_2_0 static File () { _defaultLocalFileTime = new DateTime (1601, 1, 1); _defaultLocalFileTime = _defaultLocalFileTime.ToLocalTime (); } // // The documentation for this method is most likely wrong, it // talks about doing a "binary read", but the remarks say // that this "detects the encoding". // // This can not detect and do anything useful with the encoding // since the result is a byte [] not a char []. // public static byte [] ReadAllBytes (string path) { using (FileStream s = Open (path, FileMode.Open, FileAccess.Read, FileShare.Read)){ long size = s.Length; // // Is this worth supporting? // if (size > Int32.MaxValue) throw new ArgumentException ("Reading more than 4gigs with this call is not supported"); byte [] result = new byte [s.Length]; s.Read (result, 0, (int) size); return result; } } public static string [] ReadAllLines (string path) { using (StreamReader reader = File.OpenText (path)) { return ReadAllLines (reader); } } public static string [] ReadAllLines (string path, Encoding encoding) { using (StreamReader reader = new StreamReader (path, encoding)) { return ReadAllLines (reader); } } static string [] ReadAllLines (StreamReader reader) { List list = new List (); while (!reader.EndOfStream) list.Add (reader.ReadLine ()); return list.ToArray (); } public static string ReadAllText (string path) { return ReadAllText (path, Encoding.UTF8Unmarked); } public static string ReadAllText (string path, Encoding enc) { using (StreamReader sr = new StreamReader (path, enc)) { return sr.ReadToEnd (); } } public static void WriteAllBytes (string path, byte [] data) { using (Stream stream = File.Create (path)) { stream.Write (data, 0, data.Length); } } public static void WriteAllLines (string path, string [] lines) { using (StreamWriter writer = new StreamWriter (path)) { WriteAllLines (writer, lines); } } public static void WriteAllLines (string path, string [] lines, Encoding encoding) { using (StreamWriter writer = new StreamWriter (path, false, encoding)) { WriteAllLines (writer, lines); } } static void WriteAllLines (StreamWriter writer, string [] lines) { foreach (string line in lines) writer.WriteLine (line); } public static void WriteAllText (string path, string contents) { WriteAllText (path, contents, Encoding.UTF8Unmarked); } public static void WriteAllText (string path, string contents, Encoding enc) { using (StreamWriter sw = new StreamWriter (path, false, enc)) { sw.Write (contents); } } private static readonly DateTime _defaultLocalFileTime; [MonoLimitation ("File encryption isn't supported (even on NTFS).")] public static void Encrypt (string path) { // MS.NET support this only on NTFS file systems, i.e. it's a file-system (not a framework) feature. // otherwise it throws a NotSupportedException (or a PlatformNotSupportedException on older OS). // we throw the same (instead of a NotImplementedException) because most code should already be // handling this exception to work properly. throw new NotSupportedException (Locale.GetText ("File encryption isn't supported on any file system.")); } [MonoLimitation ("File encryption isn't supported (even on NTFS).")] public static void Decrypt (string path) { // MS.NET support this only on NTFS file systems, i.e. it's a file-system (not a framework) feature. // otherwise it throws a NotSupportedException (or a PlatformNotSupportedException on older OS). // we throw the same (instead of a NotImplementedException) because most code should already be // handling this exception to work properly. throw new NotSupportedException (Locale.GetText ("File encryption isn't supported on any file system.")); } #endif } }