New test.
[mono.git] / mcs / class / corlib / System.IO / Path.cs
index ba731a70d93e3d5a56e4652a36759986c875de74..44b391d69985552c95395ea8cebc03344c95fa18 100644 (file)
 //                 Dan Lewis (dihlewis@yahoo.co.uk)
 //                 Gonzalo Paniagua Javier (gonzalo@ximian.com)
 //                 Ben Maurer (bmaurer@users.sourceforge.net)
+//                 Sebastien Pouliot  <sebastien@ximian.com>
 // Created:        Saturday, August 11, 2001 
 //
 //------------------------------------------------------------------------------
 
-using System;
+//
+// Copyright (C) 2004-2005 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.Globalization;
 using System.Runtime.CompilerServices;
+using System.Runtime.InteropServices;
+using System.Security;
+using System.Security.Cryptography;
+using System.Security.Permissions;
+using System.Text;
+
+namespace System.IO {
+
+#if NET_2_0
+       [ComVisible (true)]
+       public static class Path {
+
+               [Obsolete ("see GetInvalidPathChars and GetInvalidFileNameChars methods.")]
+               public static readonly char[] InvalidPathChars;
+#else
+       public sealed class Path {
+
+               private Path ()
+               {
+               }
 
-namespace System.IO
-{
-       public sealed class Path
-       {
+               public static readonly char[] InvalidPathChars;
+#endif
                public static readonly char AltDirectorySeparatorChar;
                public static readonly char DirectorySeparatorChar;
-               public static readonly char[] InvalidPathChars;
                public static readonly char PathSeparator;
                internal static readonly string DirectorySeparatorStr;
                public static readonly char VolumeSeparatorChar;
 
                private static readonly char[] PathSeparatorChars;
-               private static bool dirEqualsVolume;
-
-               private Path ()
-               {
-               }
+               private static readonly bool dirEqualsVolume;
 
                // class methods
                public static string ChangeExtension (string path, string extension)
@@ -93,7 +130,8 @@ namespace System.IO
                        if (IsPathRooted (path2))
                                return path2;
                        
-                       if (Array.IndexOf (PathSeparatorChars, path1 [path1.Length - 1]) == -1)
+                       char p1end = path1 [path1.Length - 1];
+                       if (p1end != DirectorySeparatorChar && p1end != AltDirectorySeparatorChar && p1end != VolumeSeparatorChar)
                                return path1 + DirectorySeparatorChar + path2;
 
                        return path1 + path2;
@@ -167,40 +205,91 @@ namespace System.IO
                }
 
                public static string GetFullPath (string path)
+               {
+                       string fullpath = InsecureGetFullPath (path);
+                       if (SecurityManager.SecurityEnabled) {
+                               new FileIOPermission (FileIOPermissionAccess.PathDiscovery, fullpath).Demand ();
+                       }
+                       return fullpath;
+               }
+
+               internal static string WindowsDriveAdjustment (string path)
+               {
+                       // two special cases to consider when a drive is specified
+                       if (path.Length < 2)
+                               return path;
+                       if ((path [1] != ':') || !Char.IsLetter (path [0]))
+                               return path;
+
+                       string current = Directory.GetCurrentDirectory ();
+                       // first, only the drive is specified
+                       if (path.Length == 2) {
+                               // then if the current directory is on the same drive
+                               if (current [0] == path [0])
+                                       path = current; // we return it
+                               else
+                                       path += '\\';
+                       } else if ((path [2] != Path.DirectorySeparatorChar) && (path [2] != Path.AltDirectorySeparatorChar)) {
+                               // second, the drive + a directory is specified *without* a separator between them (e.g. C:dir).
+                               // If the current directory is on the specified drive...
+                               if (current [0] == path [0]) {
+                                       // then specified directory is appended to the current drive directory
+                                       path = Path.Combine (current, path.Substring (2, path.Length - 2));
+                               } else {
+                                       // if not, then just pretend there was a separator (Path.Combine won't work in this case)
+                                       path = String.Concat (path.Substring (0, 2), DirectorySeparatorStr, path.Substring (2, path.Length - 2));
+                               }
+                       }
+                       return path;
+               }
+
+               // insecure - do not call directly
+               internal static string InsecureGetFullPath (string path)
                {
                        if (path == null)
-                               throw (new ArgumentNullException (
-                                       "path",
-                                       "You must specify a path when calling System.IO.Path.GetFullPath"));
+                               throw new ArgumentNullException ("path");
+
+                       if (path.Trim ().Length == 0) {
+                               string msg = Locale.GetText ("The specified path is not of a legal form (empty).");
+                               throw new ArgumentException (msg, "path");
+                       }
+
+                       // adjust for drives, i.e. a special case for windows
+                       if (Environment.IsRunningOnWindows)
+                               path = WindowsDriveAdjustment (path);
 
-                       if (path.Trim () == String.Empty)
-                               throw new ArgumentException ("The path is not of a legal form", "path");
+                       // if the supplied path ends with a separator...
+                       char end = path [path.Length - 1];
 
                        if (path.Length >= 2 &&
                                IsDsc (path [0]) &&
                                IsDsc (path [1])) {
                                if (path.Length == 2 || path.IndexOf (path [0], 2) < 0)
                                        throw new ArgumentException ("UNC pass should be of the form \\\\server\\share.");
-                               else
-                                       if (path [0] == DirectorySeparatorChar)
-                                               return path; // UNC
+
+                               if (path [0] != DirectorySeparatorChar)
+                                       path = path.Replace (AltDirectorySeparatorChar, DirectorySeparatorChar);
+                       } else {
+                               if (!IsPathRooted (path))
+                                       path = Directory.GetCurrentDirectory () + DirectorySeparatorStr + path;
+                               else if (DirectorySeparatorChar == '\\' &&
+                                       path.Length >= 2 &&
+                                       IsDsc (path [0]) &&
+                                       !IsDsc (path [1])) { // like `\abc\def'
+                                       string current = Directory.GetCurrentDirectory ();
+                                       if (current [1] == VolumeSeparatorChar)
+                                               path = current.Substring (0, 2) + path;
                                        else
-                                               return path.Replace (AltDirectorySeparatorChar, DirectorySeparatorChar);
+                                               path = current.Substring (0, current.IndexOf ('\\', current.IndexOf ("\\\\") + 1));
+                               }
+                               path = CanonicalizePath (path);
                        }
 
-                       if (!IsPathRooted (path))
-                               path = Directory.GetCurrentDirectory () + DirectorySeparatorStr + path;
-                       else if (DirectorySeparatorChar == '\\' &&
-                               path.Length >= 2 &&
-                               IsDsc (path [0]) &&
-                               !IsDsc (path [1])) { // like `\abc\def'
-                               string current = Directory.GetCurrentDirectory ();
-                               if (current [1] == VolumeSeparatorChar)
-                                       path = current.Substring (0, 2) + path;
-                               else
-                                       path = current.Substring (0, current.IndexOf ('\\', current.IndexOf ("\\\\") + 1));
-                       }
-                       return CanonicalizePath (path);
+                       // if the original ended with a [Alt]DirectorySeparatorChar then ensure the full path also ends with one
+                       if (IsDsc (end) && (path [path.Length - 1] != DirectorySeparatorChar))
+                               path += DirectorySeparatorChar;
+
+                       return path;
                }
 
                static bool IsDsc (char c) {
@@ -209,8 +298,14 @@ namespace System.IO
                
                public static string GetPathRoot (string path)
                {
-                       if (path == null) return null;
-                       if (!IsPathRooted (path)) return String.Empty;
+                       if (path == null)
+                               return null;
+
+                       if (path == String.Empty)
+                               throw new ArgumentException ("This specified path is invalid.");
+
+                       if (!IsPathRooted (path))
+                               return String.Empty;
                        
                        if (DirectorySeparatorChar == '/') {
                                // UNIX
@@ -228,11 +323,16 @@ namespace System.IO
                                        // UNC: \\server or \\server\share
                                        // Get server
                                        while (len < path.Length && !IsDsc (path [len])) len++;
+
                                        // Get share
-                                       while (len < path.Length && !IsDsc (path [len])) len++;
+                                       if (len < path.Length) {
+                                               len++;
+                                               while (len < path.Length && !IsDsc (path [len])) len++;
+                                       }
+
                                        return DirectorySeparatorStr +
                                                DirectorySeparatorStr +
-                                               path.Substring (2).Replace (AltDirectorySeparatorChar, DirectorySeparatorChar);
+                                               path.Substring (2, len - 2).Replace (AltDirectorySeparatorChar, DirectorySeparatorChar);
                                } else if (IsDsc (path [0])) {
                                        // path starts with '\' or '/'
                                        return DirectorySeparatorStr;
@@ -245,6 +345,8 @@ namespace System.IO
                        }
                }
 
+               // FIXME: Further limit the assertion when imperative Assert is implemented
+               [FileIOPermission (SecurityAction.Assert, Unrestricted = true)]
                public static string GetTempFileName ()
                {
                        FileStream f = null;
@@ -256,11 +358,16 @@ namespace System.IO
                        do {
                                num = rnd.Next ();
                                num++;
-                               path = Path.Combine (GetTempPath(), "tmp" + num.ToString("x"));
+                               path = Path.Combine (GetTempPath(), "tmp" + num.ToString("x") + ".tmp");
 
                                try {
                                        f = new FileStream (path, FileMode.CreateNew);
-                               } catch {
+                               }
+                               catch (SecurityException) {
+                                       // avoid an endless loop
+                                       throw;
+                               }
+                               catch {
                                }
                        } while (f == null);
                        
@@ -268,9 +375,7 @@ namespace System.IO
                        return path;
                }
 
-               /// <summary>
-               /// Returns the path of the current systems temp directory
-               /// </summary>
+               [EnvironmentPermission (SecurityAction.Demand, Unrestricted = true)]
                public static string GetTempPath ()
                {
                        string p = get_temp_path ();
@@ -306,6 +411,56 @@ namespace System.IO
                                (!dirEqualsVolume && path.Length > 1 && path [1] == VolumeSeparatorChar));
                }
 
+#if NET_2_0
+               public static char[] GetInvalidFileNameChars ()
+               {
+                       // return a new array as we do not want anyone to be able to change the values
+                       if (Environment.IsRunningOnWindows) {
+                               return 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', ':', '*', '?', '\\', '/' };
+                       } else {
+                               return new char [2] { '\x00', '/' };
+                       }
+               }
+
+               public static char[] GetInvalidPathChars ()
+               {
+                       // return a new array as we do not want anyone to be able to change the values
+                       if (Environment.IsRunningOnWindows) {
+                               return new char [36] { '\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' };
+                       } else {
+                               return new char [1] { '\x00' };
+                       }
+               }
+
+               public static string GetRandomFileName ()
+               {
+                       char[] invalid = GetInvalidFileNameChars ();
+                       // returns a 8.3 filename (total size 12)
+                       StringBuilder sb = new StringBuilder (12);
+                       // using strong crypto but without creating the file
+                       RandomNumberGenerator rng = RandomNumberGenerator.Create ();
+                       byte[] buffer = new byte [16];
+                       while (sb.Length < 12) {
+                               int i = 0;
+                               rng.GetNonZeroBytes (buffer);
+                               while ((i < buffer.Length) && (sb.Length < 12)) {
+                                       char c = (char) buffer [i];
+                                       if (Array.IndexOf (invalid, c) == -1)
+                                               sb.Append (c);
+                                       i++;
+                                       if (sb.Length == 8)
+                                               sb.Append ('.');
+                               }
+                       }
+                       return sb.ToString ();
+               }
+#endif
                // private class methods
 
                private static int findExtension (string path)
@@ -322,14 +477,24 @@ namespace System.IO
                        return -1;
                }
 
-               static Path () {
+               static Path ()
+               {
                        VolumeSeparatorChar = MonoIO.VolumeSeparatorChar;
                        DirectorySeparatorChar = MonoIO.DirectorySeparatorChar;
                        AltDirectorySeparatorChar = MonoIO.AltDirectorySeparatorChar;
 
                        PathSeparator = MonoIO.PathSeparator;
-                       InvalidPathChars = MonoIO.InvalidPathChars;
-
+#if NET_2_0
+                       // this copy will be modifiable ("by design")
+                       InvalidPathChars = GetInvalidPathChars ();
+#else
+                       if (Environment.IsRunningOnWindows) {
+                               InvalidPathChars = new char [15] { '\x00', '\x08', '\x10', '\x11', '\x12', '\x14', '\x15', '\x16',
+                                       '\x17', '\x18', '\x19', '\x22', '\x3C', '\x3E', '\x7C' };
+                       } else {
+                               InvalidPathChars = new char [1] { '\x00' };
+                       }
+#endif
                        // internal fields
 
                        DirectorySeparatorStr = DirectorySeparatorChar.ToString ();
@@ -342,63 +507,108 @@ namespace System.IO
                        dirEqualsVolume = (DirectorySeparatorChar == VolumeSeparatorChar);
                }
                
-               
-               static string CanonicalizePath (string path) {
-                       
+               static bool SameRoot (string root, string path)
+               {
+                       // compare root - if enough details are available
+                       if ((root.Length < 2) || (path.Length < 2))
+                               return false;
+                       // same volume/drive
+                       if (!root [0].Equals (path [0]))
+                               return false;
+                       // presence if the separator
+                       if (path[1] != Path.VolumeSeparatorChar)
+                               return false;
+                       if ((root.Length > 2) && (path.Length > 2)) {
+                               // but don't directory compare the directory separator
+                               return (IsDsc (root[2]) && IsDsc (path[2]));
+                       }
+                       return true;
+               }
+
+               static string CanonicalizePath (string path)
+               {
                        // STEP 1: Check for empty string
-                       if (path == null) return path;
-                       path = path.Trim ();
-                       if (path == String.Empty) return path;
-                       
+                       if (path == null)
+                               return path;
+                       if (Environment.IsRunningOnWindows)
+                               path = path.Trim ();
+
+                       if (path.Length == 0)
+                               return path;
+
                        // STEP 2: Check to see if this is only a root
-                       string root = GetPathRoot (path);
+                       string root = Path.GetPathRoot (path);
                        // it will return '\' for path '\', while it should return 'c:\' or so.
                        // Note: commenting this out makes the ened for the (target == 1...) check in step 5
                        //if (root == path) return path;
-                               
+
                        // STEP 3: split the directories, this gets rid of consecutative "/"'s
-                       string [] dirs = path.Split (DirectorySeparatorChar, AltDirectorySeparatorChar);
+                       string[] dirs = path.Split (Path.DirectorySeparatorChar, Path.AltDirectorySeparatorChar);
                        // STEP 4: Get rid of directories containing . and ..
                        int target = 0;
-                       
+
                        for (int i = 0; i < dirs.Length; i++) {
-                               if (dirs [i] == "." || (i != 0 && dirs [i] == String.Empty)) continue;
-                               else if (dirs [i] == "..") {
-                                       if (target != 0) target--;
-                               }
-                               else
-                                       dirs [target++] = dirs [i];
+                               if (dirs[i] == "." || (i != 0 && dirs[i].Length == 0))
+                                       continue;
+                               else if (dirs[i] == "..") {
+                                       if (target != 0)
+                                               target--;
+                               } else
+                                       dirs[target++] = dirs[i];
                        }
 
                        // STEP 5: Combine everything.
-                       if (target == 0 || (target == 1 && dirs [0] == ""))
+                       if (target == 0 || (target == 1 && dirs[0] == ""))
                                return root;
                        else {
                                string ret = String.Join (DirectorySeparatorStr, dirs, 0, target);
-                               switch (DirectorySeparatorChar) {
-                               case '\\': // Windows
+                               if (Environment.IsRunningOnWindows) {
+                                       if (!SameRoot (root, ret))
+                                               ret = root + ret;
                                        // In GetFullPath(), it is assured that here never comes UNC. So this must only applied to such path that starts with '\', without drive specification.
-                                       if (path [0] != DirectorySeparatorChar && path.StartsWith (root)) {
+                                       if (!IsDsc (path[0]) && SameRoot (root, path)) {
                                                if (ret.Length <= 2 && !ret.EndsWith (DirectorySeparatorStr)) // '\' after "c:"
-                                                       ret += DirectorySeparatorChar;
+                                                       ret += Path.DirectorySeparatorChar;
                                                return ret;
                                        } else {
                                                string current = Directory.GetCurrentDirectory ();
-                                               if (current.Length > 1 && current [1] == VolumeSeparatorChar) {
+                                               if (current.Length > 1 && current[1] == Path.VolumeSeparatorChar) {
                                                        // DOS local file path
-                                                       if (ret.Length == 0 || IsDsc (ret [0]))
+                                                       if (ret.Length == 0 || IsDsc (ret[0]))
                                                                ret += '\\';
                                                        return current.Substring (0, 2) + ret;
-                                               }
-                                               else if (IsDsc (current [current.Length - 1]) && IsDsc (ret [0]))
+                                               } else if (IsDsc (current[current.Length - 1]) && IsDsc (ret[0]))
                                                        return current + ret.Substring (1);
                                                else
                                                        return current + ret;
                                        }
-                               default: // Unix/Mac
-                                       return ret;
                                }
+                               return ret;
                        }
                }
+
+               // required for FileIOPermission (and most proibably reusable elsewhere too)
+               // both path MUST be "full paths"
+               static internal bool IsPathSubsetOf (string subset, string path)
+               {
+                       if (subset.Length > path.Length)
+                               return false;
+
+                       // check that everything up to the last separator match
+                       int slast = subset.LastIndexOfAny (PathSeparatorChars);
+                       if (String.Compare (subset, 0, path, 0, slast) != 0)
+                               return false;
+
+                       slast++;
+                       // then check if the last segment is identical
+                       int plast = path.IndexOfAny (PathSeparatorChars, slast);
+                       if (plast >= slast) {
+                               return String.Compare (subset, slast, path, slast, path.Length - plast) == 0;
+                       }
+                       if (subset.Length != path.Length)
+                               return false;
+
+                       return String.Compare (subset, slast, path, slast, subset.Length - slast) == 0;
+               }
        }
 }