1 //------------------------------------------------------------------------------
5 // Copyright (C) 2001 Moonlight Enterprises, All Rights Reserved
6 // Copyright (C) 2002 Ximian, Inc. (http://www.ximian.com)
7 // Copyright (C) 2003 Ben Maurer
8 // Copyright 2011 Xamarin Inc (http://www.xamarin.com).
10 // Author: Jim Richardson, develop@wtfo-guru.com
11 // Dan Lewis (dihlewis@yahoo.co.uk)
12 // Gonzalo Paniagua Javier (gonzalo@ximian.com)
13 // Ben Maurer (bmaurer@users.sourceforge.net)
14 // Sebastien Pouliot <sebastien@ximian.com>
15 // Created: Saturday, August 11, 2001
17 //------------------------------------------------------------------------------
20 // Copyright (C) 2004-2005 Novell, Inc (http://www.novell.com)
22 // Permission is hereby granted, free of charge, to any person obtaining
23 // a copy of this software and associated documentation files (the
24 // "Software"), to deal in the Software without restriction, including
25 // without limitation the rights to use, copy, modify, merge, publish,
26 // distribute, sublicense, and/or sell copies of the Software, and to
27 // permit persons to whom the Software is furnished to do so, subject to
28 // the following conditions:
30 // The above copyright notice and this permission notice shall be
31 // included in all copies or substantial portions of the Software.
33 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
34 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
35 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
36 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
37 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
38 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
39 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
42 using System.Globalization;
43 using System.Runtime.CompilerServices;
44 using System.Runtime.InteropServices;
45 using System.Security;
46 using System.Security.Cryptography;
47 using System.Security.Permissions;
53 public static class Path {
55 [Obsolete ("see GetInvalidPathChars and GetInvalidFileNameChars methods.")]
56 public static readonly char[] InvalidPathChars;
57 public static readonly char AltDirectorySeparatorChar;
58 public static readonly char DirectorySeparatorChar;
59 public static readonly char PathSeparator;
60 internal static readonly string DirectorySeparatorStr;
61 public static readonly char VolumeSeparatorChar;
63 internal static readonly char[] PathSeparatorChars;
64 private static readonly bool dirEqualsVolume;
67 public static string ChangeExtension (string path, string extension)
72 if (path.IndexOfAny (InvalidPathChars) != -1)
73 throw new ArgumentException ("Illegal characters in path.");
75 int iExt = findExtension (path);
77 if (extension == null)
78 return iExt < 0 ? path : path.Substring (0, iExt);
79 else if (extension.Length == 0)
80 return iExt < 0 ? path + '.' : path.Substring (0, iExt + 1);
82 else if (path.Length != 0) {
83 if (extension.Length > 0 && extension [0] != '.')
84 extension = "." + extension;
86 extension = String.Empty;
89 return path + extension;
90 } else if (iExt > 0) {
91 string temp = path.Substring (0, iExt);
92 return temp + extension;
98 public static string Combine (string path1, string path2)
101 throw new ArgumentNullException ("path1");
104 throw new ArgumentNullException ("path2");
106 if (path1.Length == 0)
109 if (path2.Length == 0)
112 if (path1.IndexOfAny (InvalidPathChars) != -1)
113 throw new ArgumentException ("Illegal characters in path.");
115 if (path2.IndexOfAny (InvalidPathChars) != -1)
116 throw new ArgumentException ("Illegal characters in path.");
119 if (IsPathRooted (path2))
122 char p1end = path1 [path1.Length - 1];
123 if (p1end != DirectorySeparatorChar && p1end != AltDirectorySeparatorChar && p1end != VolumeSeparatorChar)
124 return path1 + DirectorySeparatorStr + path2;
126 return path1 + path2;
131 // * Removes duplicat path separators from a string
132 // * If the string starts with \\, preserves the first two (hostname on Windows)
133 // * Removes the trailing path separator.
134 // * Returns the DirectorySeparatorChar for the single input DirectorySeparatorChar or AltDirectorySeparatorChar
136 // Unlike CanonicalizePath, this does not do any path resolution
137 // (which GetDirectoryName is not supposed to do).
139 internal static string CleanPath (string s)
147 if (l > 2 && s0 == '\\' && s [1] == '\\'){
151 // We are only left with root
152 if (l == 1 && (s0 == DirectorySeparatorChar || s0 == AltDirectorySeparatorChar))
156 for (int i = start; i < l; i++){
159 if (c != DirectorySeparatorChar && c != AltDirectorySeparatorChar)
165 if (c == DirectorySeparatorChar || c == AltDirectorySeparatorChar)
173 char [] copy = new char [l-sub];
178 for (int i = start, j = start; i < l && j < copy.Length; i++){
181 if (c != DirectorySeparatorChar && c != AltDirectorySeparatorChar){
186 // For non-trailing cases.
187 if (j+1 != copy.Length){
188 copy [j++] = DirectorySeparatorChar;
191 if (c != DirectorySeparatorChar && c != AltDirectorySeparatorChar)
196 return new String (copy);
199 public static string GetDirectoryName (string path)
201 // LAMESPEC: For empty string MS docs say both
202 // return null AND throw exception. Seems .NET throws.
203 if (path == String.Empty)
204 throw new ArgumentException("Invalid path");
206 if (path == null || GetPathRoot (path) == path)
209 if (path.Trim ().Length == 0)
210 throw new ArgumentException ("Argument string consists of whitespace characters only.");
212 if (path.IndexOfAny (System.IO.Path.InvalidPathChars) > -1)
213 throw new ArgumentException ("Path contains invalid characters");
215 int nLast = path.LastIndexOfAny (PathSeparatorChars);
220 string ret = path.Substring (0, nLast);
223 if (l >= 2 && DirectorySeparatorChar == '\\' && ret [l - 1] == VolumeSeparatorChar)
224 return ret + DirectorySeparatorChar;
225 else if (l == 1 && DirectorySeparatorChar == '\\' && path.Length >= 2 && path [nLast] == VolumeSeparatorChar)
226 return ret + VolumeSeparatorChar;
229 // Important: do not use CanonicalizePath here, use
230 // the custom CleanPath here, as this should not
231 // return absolute paths
233 return CleanPath (ret);
240 public static string GetExtension (string path)
245 if (path.IndexOfAny (InvalidPathChars) != -1)
246 throw new ArgumentException ("Illegal characters in path.");
248 int iExt = findExtension (path);
252 if (iExt < path.Length - 1)
253 return path.Substring (iExt);
258 public static string GetFileName (string path)
260 if (path == null || path.Length == 0)
263 if (path.IndexOfAny (InvalidPathChars) != -1)
264 throw new ArgumentException ("Illegal characters in path.");
266 int nLast = path.LastIndexOfAny (PathSeparatorChars);
268 return path.Substring (nLast + 1);
273 public static string GetFileNameWithoutExtension (string path)
275 return ChangeExtension (GetFileName (path), null);
278 public static string GetFullPath (string path)
280 string fullpath = InsecureGetFullPath (path);
282 SecurityManager.EnsureElevatedPermissions (); // this is a no-op outside moonlight
285 if (SecurityManager.SecurityEnabled) {
286 new FileIOPermission (FileIOPermissionAccess.PathDiscovery, fullpath).Demand ();
292 // http://msdn.microsoft.com/en-us/library/windows/desktop/aa364963%28v=vs.85%29.aspx
293 [DllImport("Kernel32.dll", SetLastError = true, CharSet = CharSet.Unicode)]
294 private static extern int GetFullPathName(string path, int numBufferChars, StringBuilder buffer, ref IntPtr lpFilePartOrNull);
296 internal static string GetFullPathName(string path)
298 const int MAX_PATH = 260;
299 StringBuilder buffer = new StringBuilder(MAX_PATH);
300 IntPtr ptr = IntPtr.Zero;
301 int length = GetFullPathName(path, MAX_PATH, buffer, ref ptr);
304 int error = Marshal.GetLastWin32Error();
305 throw new IOException("Windows API call to GetFullPathName failed, Windows error code: " + error);
307 else if (length > MAX_PATH)
309 buffer = new StringBuilder(length);
310 GetFullPathName(path, length, buffer, ref ptr);
312 return buffer.ToString();
315 internal static string WindowsDriveAdjustment (string path)
317 // two special cases to consider when a drive is specified
320 if ((path [1] != ':') || !Char.IsLetter (path [0]))
323 string current = Directory.InsecureGetCurrentDirectory ();
324 // first, only the drive is specified
325 if (path.Length == 2) {
326 // then if the current directory is on the same drive
327 if (current [0] == path [0])
328 path = current; // we return it
330 path = GetFullPathName(path); // we have to use the GetFullPathName Windows API
331 } else if ((path [2] != Path.DirectorySeparatorChar) && (path [2] != Path.AltDirectorySeparatorChar)) {
332 // second, the drive + a directory is specified *without* a separator between them (e.g. C:dir).
333 // If the current directory is on the specified drive...
334 if (current [0] == path [0]) {
335 // then specified directory is appended to the current drive directory
336 path = Path.Combine (current, path.Substring (2, path.Length - 2));
338 // we have to use the GetFullPathName Windows API
339 path = GetFullPathName(path);
345 // insecure - do not call directly
346 internal static string InsecureGetFullPath (string path)
349 throw new ArgumentNullException ("path");
351 if (path.Trim ().Length == 0) {
352 string msg = Locale.GetText ("The specified path is not of a legal form (empty).");
353 throw new ArgumentException (msg);
356 // adjust for drives, i.e. a special case for windows
357 if (Environment.IsRunningOnWindows)
358 path = WindowsDriveAdjustment (path);
360 // if the supplied path ends with a separator...
361 char end = path [path.Length - 1];
363 var canonicalize = true;
364 if (path.Length >= 2 &&
367 if (path.Length == 2 || path.IndexOf (path [0], 2) < 0)
368 throw new ArgumentException ("UNC paths should be of the form \\\\server\\share.");
370 if (path [0] != DirectorySeparatorChar)
371 path = path.Replace (AltDirectorySeparatorChar, DirectorySeparatorChar);
374 if (!IsPathRooted (path)) {
376 // avoid calling expensive CanonicalizePath when possible
377 if (!Environment.IsRunningOnWindows) {
379 while ((start = path.IndexOf ('.', start)) != -1) {
380 if (++start == path.Length || path [start] == DirectorySeparatorChar || path [start] == AltDirectorySeparatorChar)
383 canonicalize = start > 0;
386 path = Directory.InsecureGetCurrentDirectory() + DirectorySeparatorStr + path;
387 } else if (DirectorySeparatorChar == '\\' &&
390 !IsDsc (path [1])) { // like `\abc\def'
391 string current = Directory.InsecureGetCurrentDirectory();
392 if (current [1] == VolumeSeparatorChar)
393 path = current.Substring (0, 2) + path;
395 path = current.Substring (0, current.IndexOf ('\\', current.IndexOfOrdinalUnchecked ("\\\\") + 1));
400 path = CanonicalizePath (path);
402 // if the original ended with a [Alt]DirectorySeparatorChar then ensure the full path also ends with one
403 if (IsDsc (end) && (path [path.Length - 1] != DirectorySeparatorChar))
404 path += DirectorySeparatorChar;
409 static bool IsDsc (char c) {
410 return c == DirectorySeparatorChar || c == AltDirectorySeparatorChar;
413 public static string GetPathRoot (string path)
418 if (path.Trim ().Length == 0)
419 throw new ArgumentException ("The specified path is not of a legal form.");
421 if (!IsPathRooted (path))
424 if (DirectorySeparatorChar == '/') {
426 return IsDsc (path [0]) ? DirectorySeparatorStr : String.Empty;
431 if (path.Length == 1 && IsDsc (path [0]))
432 return DirectorySeparatorStr;
433 else if (path.Length < 2)
436 if (IsDsc (path [0]) && IsDsc (path[1])) {
437 // UNC: \\server or \\server\share
439 while (len < path.Length && !IsDsc (path [len])) len++;
442 if (len < path.Length) {
444 while (len < path.Length && !IsDsc (path [len])) len++;
447 return DirectorySeparatorStr +
448 DirectorySeparatorStr +
449 path.Substring (2, len - 2).Replace (AltDirectorySeparatorChar, DirectorySeparatorChar);
450 } else if (IsDsc (path [0])) {
451 // path starts with '\' or '/'
452 return DirectorySeparatorStr;
453 } else if (path[1] == VolumeSeparatorChar) {
455 if (path.Length >= 3 && (IsDsc (path [2]))) len++;
457 return Directory.GetCurrentDirectory ().Substring (0, 2);// + path.Substring (0, len);
458 return path.Substring (0, len);
462 // FIXME: Further limit the assertion when imperative Assert is implemented
463 [FileIOPermission (SecurityAction.Assert, Unrestricted = true)]
464 public static string GetTempFileName ()
472 SecurityManager.EnsureElevatedPermissions (); // this is a no-op outside moonlight
478 path = Path.Combine (GetTempPath(), "tmp" + num.ToString("x") + ".tmp");
481 f = new FileStream (path, FileMode.CreateNew, FileAccess.ReadWrite, FileShare.Read,
482 8192, false, (FileOptions) 1);
484 catch (IOException ex){
485 if (ex.hresult != MonoIO.FileAlreadyExistsHResult || count ++ > 65536)
488 catch (UnauthorizedAccessException ex) {
489 if (count ++ > 65536)
490 throw new IOException (ex.Message, ex);
498 [EnvironmentPermission (SecurityAction.Demand, Unrestricted = true)]
499 public static string GetTempPath ()
501 SecurityManager.EnsureElevatedPermissions (); // this is a no-op outside moonlight
503 string p = get_temp_path ();
504 if (p.Length > 0 && p [p.Length - 1] != DirectorySeparatorChar)
505 return p + DirectorySeparatorChar;
510 [MethodImplAttribute(MethodImplOptions.InternalCall)]
511 private static extern string get_temp_path ();
513 public static bool HasExtension (string path)
515 if (path == null || path.Trim ().Length == 0)
518 if (path.IndexOfAny (InvalidPathChars) != -1)
519 throw new ArgumentException ("Illegal characters in path.");
521 int pos = findExtension (path);
522 return 0 <= pos && pos < path.Length - 1;
525 public static bool IsPathRooted (string path)
527 if (path == null || path.Length == 0)
530 if (path.IndexOfAny (InvalidPathChars) != -1)
531 throw new ArgumentException ("Illegal characters in path.");
534 return (c == DirectorySeparatorChar ||
535 c == AltDirectorySeparatorChar ||
536 (!dirEqualsVolume && path.Length > 1 && path [1] == VolumeSeparatorChar));
539 public static char[] GetInvalidFileNameChars ()
541 // return a new array as we do not want anyone to be able to change the values
542 if (Environment.IsRunningOnWindows) {
543 return new char [41] { '\x00', '\x01', '\x02', '\x03', '\x04', '\x05', '\x06', '\x07',
544 '\x08', '\x09', '\x0A', '\x0B', '\x0C', '\x0D', '\x0E', '\x0F', '\x10', '\x11', '\x12',
545 '\x13', '\x14', '\x15', '\x16', '\x17', '\x18', '\x19', '\x1A', '\x1B', '\x1C', '\x1D',
546 '\x1E', '\x1F', '\x22', '\x3C', '\x3E', '\x7C', ':', '*', '?', '\\', '/' };
548 return new char [2] { '\x00', '/' };
552 public static char[] GetInvalidPathChars ()
554 // return a new array as we do not want anyone to be able to change the values
555 if (Environment.IsRunningOnWindows) {
556 return new char [36] { '\x22', '\x3C', '\x3E', '\x7C', '\x00', '\x01', '\x02', '\x03', '\x04', '\x05', '\x06', '\x07',
557 '\x08', '\x09', '\x0A', '\x0B', '\x0C', '\x0D', '\x0E', '\x0F', '\x10', '\x11', '\x12',
558 '\x13', '\x14', '\x15', '\x16', '\x17', '\x18', '\x19', '\x1A', '\x1B', '\x1C', '\x1D',
561 return new char [1] { '\x00' };
565 public static string GetRandomFileName ()
567 // returns a 8.3 filename (total size 12)
568 StringBuilder sb = new StringBuilder (12);
569 // using strong crypto but without creating the file
570 RandomNumberGenerator rng = RandomNumberGenerator.Create ();
571 byte [] buffer = new byte [11];
572 rng.GetBytes (buffer);
574 for (int i = 0; i < buffer.Length; i++) {
578 // restrict to length of range [a..z0..9]
579 int b = (buffer [i] % 36);
580 char c = (char) (b < 26 ? (b + 'a') : (b - 26 + '0'));
584 return sb.ToString ();
587 // private class methods
589 private static int findExtension (string path)
591 // method should return the index of the path extension
592 // start or -1 if no valid extension
594 int iLastDot = path.LastIndexOf ('.');
595 int iLastSep = path.LastIndexOfAny ( PathSeparatorChars );
597 if (iLastDot > iLastSep)
605 VolumeSeparatorChar = MonoIO.VolumeSeparatorChar;
606 DirectorySeparatorChar = MonoIO.DirectorySeparatorChar;
607 AltDirectorySeparatorChar = MonoIO.AltDirectorySeparatorChar;
609 PathSeparator = MonoIO.PathSeparator;
610 // this copy will be modifiable ("by design")
611 InvalidPathChars = GetInvalidPathChars ();
614 DirectorySeparatorStr = DirectorySeparatorChar.ToString ();
615 PathSeparatorChars = new char [] {
616 DirectorySeparatorChar,
617 AltDirectorySeparatorChar,
621 dirEqualsVolume = (DirectorySeparatorChar == VolumeSeparatorChar);
624 // returns the server and share part of a UNC. Assumes "path" is a UNC.
625 static string GetServerAndShare (string path)
628 while (len < path.Length && !IsDsc (path [len])) len++;
630 if (len < path.Length) {
632 while (len < path.Length && !IsDsc (path [len])) len++;
635 return path.Substring (2, len - 2).Replace (AltDirectorySeparatorChar, DirectorySeparatorChar);
638 // assumes Environment.IsRunningOnWindows == true
639 static bool SameRoot (string root, string path)
641 // compare root - if enough details are available
642 if ((root.Length < 2) || (path.Length < 2))
646 if (IsDsc (root[0]) && IsDsc (root[1])) {
647 if (!(IsDsc (path[0]) && IsDsc (path[1])))
650 string rootShare = GetServerAndShare (root);
651 string pathShare = GetServerAndShare (path);
653 return String.Compare (rootShare, pathShare, true, CultureInfo.InvariantCulture) == 0;
657 if (!root [0].Equals (path [0]))
659 // presence of the separator
660 if (path[1] != Path.VolumeSeparatorChar)
662 if ((root.Length > 2) && (path.Length > 2)) {
663 // but don't directory compare the directory separator
664 return (IsDsc (root[2]) && IsDsc (path[2]));
669 static string CanonicalizePath (string path)
671 // STEP 1: Check for empty string
674 if (Environment.IsRunningOnWindows)
677 if (path.Length == 0)
680 // STEP 2: Check to see if this is only a root
681 string root = Path.GetPathRoot (path);
682 // it will return '\' for path '\', while it should return 'c:\' or so.
683 // Note: commenting this out makes the need for the (target == 1...) check in step 5
684 //if (root == path) return path;
686 // STEP 3: split the directories, this gets rid of consecutative "/"'s
687 string[] dirs = path.Split (Path.DirectorySeparatorChar, Path.AltDirectorySeparatorChar);
688 // STEP 4: Get rid of directories containing . and ..
691 bool isUnc = Environment.IsRunningOnWindows &&
692 root.Length > 2 && IsDsc (root[0]) && IsDsc (root[1]);
694 // Set an overwrite limit for UNC paths since '\' + server + share
695 // must not be eliminated by the '..' elimination algorithm.
696 int limit = isUnc ? 3 : 0;
698 for (int i = 0; i < dirs.Length; i++) {
699 // WIN32 path components must be trimmed
700 if (Environment.IsRunningOnWindows)
701 dirs[i] = dirs[i].TrimEnd ();
703 if (dirs[i] == "." || (i != 0 && dirs[i].Length == 0))
705 else if (dirs[i] == "..") {
706 // don't overwrite path segments below the limit
710 dirs[target++] = dirs[i];
713 // STEP 5: Combine everything.
714 if (target == 0 || (target == 1 && dirs[0] == ""))
717 string ret = String.Join (DirectorySeparatorStr, dirs, 0, target);
718 if (Environment.IsRunningOnWindows) {
719 // append leading '\' of the UNC path that was lost in STEP 3.
721 ret = Path.DirectorySeparatorStr + ret;
723 if (!SameRoot (root, ret))
728 } else if (!IsDsc (path[0]) && SameRoot (root, path)) {
729 if (ret.Length <= 2 && !ret.EndsWith (DirectorySeparatorStr)) // '\' after "c:"
730 ret += Path.DirectorySeparatorChar;
733 string current = Directory.GetCurrentDirectory ();
734 if (current.Length > 1 && current[1] == Path.VolumeSeparatorChar) {
735 // DOS local file path
736 if (ret.Length == 0 || IsDsc (ret[0]))
738 return current.Substring (0, 2) + ret;
739 } else if (IsDsc (current[current.Length - 1]) && IsDsc (ret[0]))
740 return current + ret.Substring (1);
742 return current + ret;
745 if (root != "" && ret.Length > 0 && ret [0] != '/')
752 // required for FileIOPermission (and most proibably reusable elsewhere too)
753 // both path MUST be "full paths"
754 static internal bool IsPathSubsetOf (string subset, string path)
756 if (subset.Length > path.Length)
759 // check that everything up to the last separator match
760 int slast = subset.LastIndexOfAny (PathSeparatorChars);
761 if (String.Compare (subset, 0, path, 0, slast) != 0)
765 // then check if the last segment is identical
766 int plast = path.IndexOfAny (PathSeparatorChars, slast);
767 if (plast >= slast) {
768 return String.Compare (subset, slast, path, slast, path.Length - plast) == 0;
770 if (subset.Length != path.Length)
773 return String.Compare (subset, slast, path, slast, subset.Length - slast) == 0;
781 static string Combine (params string [] paths)
784 throw new ArgumentNullException ("paths");
787 var ret = new StringBuilder ();
788 int pathsLen = paths.Length;
792 foreach (var s in paths) {
794 throw new ArgumentNullException ("One of the paths contains a null value", "paths");
797 if (s.IndexOfAny (InvalidPathChars) != -1)
798 throw new ArgumentException ("Illegal characters in path.");
802 ret.Append (DirectorySeparatorStr);
806 if (IsPathRooted (s))
811 if (slen > 0 && pathsLen > 0) {
812 char p1end = s [slen - 1];
813 if (p1end != DirectorySeparatorChar && p1end != AltDirectorySeparatorChar && p1end != VolumeSeparatorChar)
818 return ret.ToString ();
826 static string Combine (string path1, string path2, string path3)
829 throw new ArgumentNullException ("path1");
832 throw new ArgumentNullException ("path2");
835 throw new ArgumentNullException ("path3");
837 return Combine (new string [] { path1, path2, path3 });
845 static string Combine (string path1, string path2, string path3, string path4)
848 throw new ArgumentNullException ("path1");
851 throw new ArgumentNullException ("path2");
854 throw new ArgumentNullException ("path3");
857 throw new ArgumentNullException ("path4");
859 return Combine (new string [] { path1, path2, path3, path4 });
862 internal static void Validate (string path)
864 Validate (path, "path");
867 internal static void Validate (string path, string parameterName)
870 throw new ArgumentNullException (parameterName);
871 if (String.IsNullOrWhiteSpace (path))
872 throw new ArgumentException (Locale.GetText ("Path is empty"));
873 if (path.IndexOfAny (Path.InvalidPathChars) != -1)
874 throw new ArgumentException (Locale.GetText ("Path contains invalid chars"));
875 if (Environment.IsRunningOnWindows) {
876 int idx = path.IndexOf (':');
877 if (idx >= 0 && idx != 1)
878 throw new ArgumentException (parameterName);