Merge branch 'filename-misc-fixes'

Fix handling of single letter UNC paths and other wxFileName
improvements.

See https://github.com/wxWidgets/wxWidgets/pull/2519

docs/changes.txt

@@ -133,6 +133,12 @@ Changes in behaviour not resulting in compilation errors
   bitmaps in wxMSW if the corresponding Set had been called before, as in the
   other ports, instead of returning the normal bitmap as fallback in this case.
 
+- wxFileName::GetVolume() now returns "\\share" and not just "share" for the
+  UNC paths (i.e. \\share\path\on\remote\server) and "\\?\Volume{GUID}" for the
+  volume GUID paths rather than just "Volume{GUID}" as before. This allows
+  distinguishing them from the drive letters, even for single letter network
+  share name.
+
 
 Changes in behaviour which may result in build errors
 -----------------------------------------------------

include/wx/filename.h

@@ -626,7 +626,21 @@ private:
     // check whether this dir is valid for Append/Prepend/InsertDir()
     static bool IsValidDirComponent(const wxString& dir);
 
+    // flags used with DoSetPath()
+    enum
+    {
+        SetPath_PathOnly = 0,
+        SetPath_MayHaveVolume = 1
+    };
+
+    // helper of public SetPath() also used internally
+    void DoSetPath(const wxString& path, wxPathFormat format,
+                   int flags = SetPath_MayHaveVolume);
+
     // the drive/volume/device specification (always empty for Unix)
+    //
+    // for the drive letters, contains just the letter itself, but for MSW UNC
+    // and volume GUID paths, it starts with double backslash, e.g. "\\share"
     wxString        m_volume;
 
     // the path components of the file

interface/wx/filename.h

@@ -859,14 +859,32 @@ public:
                   wxDateTime* dtCreate) const;
 
     /**
-        Returns the string containing the volume for this file name, empty if it
+        Returns the string containing the volume for this file name.
-        doesn't have one or if the file system doesn't support volumes at all
+
-        (for example, Unix).
+        The returned string is empty if this object doesn't have a volume name,
+        as is always the case for the paths in Unix format which don't support
+        volumes at all.
+
+        Note that for @c wxPATH_DOS format paths, the returned string may have
+        one of the following forms:
+
+        - Just a single letter, for the usual drive letter volumes, e.g. @c C.
+        - A share name preceded by a double backslash, e.g. @c \\\\share.
+        - A GUID volume preceded by a double backslash and a question mark,
+          e.g. @c \\\\?\\Volume{12345678-9abc-def0-1234-56789abcdef0}.
     */
     wxString GetVolume() const;
 
     /**
         Returns the string separating the volume from the path for this format.
+
+        Note that for @c wxPATH_DOS paths this string can only be used for
+        single-character volumes representing the drive letters, but not with
+        the UNC or GUID volumes (see their description in GetVolume()
+        documentation). For this reason, its use should be avoided, prefer
+        using wxFileName constructor and Assign() overload taking the volume
+        and the path as separate arguments to combining the volume and the path
+        into a single string using the volume separator between them.
     */
     static wxString GetVolumeSeparator(wxPathFormat format = wxPATH_NATIVE);
 
@@ -1225,9 +1243,12 @@ public:
         Deletes the specified directory from the file system.
 
         @param flags
-            Can contain one of wxPATH_RMDIR_FULL or wxPATH_RMDIR_RECURSIVE. By
+            With default value, the directory is removed only if it is empty.
-            default contains neither so the directory will not be removed
+            If wxPATH_RMDIR_FULL is specified, it is removed even if it
-            unless it is empty.
+            contains subdirectories, provided that there are no files in
+            neither this directory nor its subdirectories. If flags contains
+            wxPATH_RMDIR_RECURSIVE, then the directory is removed with all the
+            files and directories under it.
 
         @return Returns @true if the directory was successfully deleted, @false
                 otherwise.
@@ -1240,9 +1261,12 @@ public:
         @param dir
             The directory to delete
         @param flags
-            Can contain one of wxPATH_RMDIR_FULL or wxPATH_RMDIR_RECURSIVE. By
+            With default value, the directory is removed only if it is empty.
-            default contains neither so the directory will not be removed
+            If wxPATH_RMDIR_FULL is specified, it is removed even if it
-            unless it is empty.
+            contains subdirectories, provided that there are no files in
+            neither this directory nor its subdirectories. If flags contains
+            wxPATH_RMDIR_RECURSIVE, then the directory is removed with all the
+            files and directories under it.
 
         @return Returns @true if the directory was successfully deleted, @false
                 otherwise.

src/common/filename.cpp

@@ -133,6 +133,13 @@ extern const wxULongLong wxInvalidSize = (unsigned)-1;
 namespace
 {
 
+// ----------------------------------------------------------------------------
+// private constants
+// ----------------------------------------------------------------------------
+
+// length of \\?\Volume{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}\ string
+static const size_t wxMSWUniqueVolumePrefixLength = 49;
+
 // ----------------------------------------------------------------------------
 // private classes
 // ----------------------------------------------------------------------------
@@ -250,30 +257,31 @@ static wxString wxGetVolumeString(const wxString& volume, wxPathFormat format)
     {
         format = wxFileName::GetFormat(format);
 
-        // Special Windows UNC paths hack, part 2: undo what we did in
+        switch ( format )
-        // SplitPath() and make an UNC path if we have a drive which is not a
-        // single letter (hopefully the network shares can't be one letter only
-        // although I didn't find any authoritative docs on this)
-        if ( format == wxPATH_DOS && volume.length() > 1 )
-        {
-            // We also have to check for Windows unique volume names here and
-            // return it with '\\?\' prepended to it
-            if ( wxFileName::IsMSWUniqueVolumeNamePath("\\\\?\\" + volume + "\\",
-                                                       format) )
-            {
-                path << "\\\\?\\" << volume;
-            }
-            else
-            {
-                // it must be a UNC path
-                path << wxFILE_SEP_PATH_DOS << wxFILE_SEP_PATH_DOS << volume;
-            }
-        }
-        else if  ( format == wxPATH_DOS || format == wxPATH_VMS )
         {
+            case wxPATH_DOS:
+                path = volume;
+
+                // We shouldn't use a colon after the volume in UNC and volume
+                // GUID paths, so append it only if it's just a drive letter.
+                if ( volume.length() == 1 )
+                    path += wxFileName::GetVolumeSeparator(format);
+                break;
+
+            case wxPATH_VMS:
                 path << volume << wxFileName::GetVolumeSeparator(format);
+                break;
+
+            case wxPATH_MAC:
+            case wxPATH_UNIX:
+                // Volumes are not used in paths in this format.
+                break;
+
+            case wxPATH_NATIVE:
+            case wxPATH_MAX:
+                wxFAIL_MSG( wxS("unreachable") );
+                break;
         }
-        // else ignore
     }
 
     return path;
@@ -286,17 +294,23 @@ inline bool IsDOSPathSep(wxUniChar ch)
     return ch == wxFILE_SEP_PATH_DOS || ch == wxFILE_SEP_PATH_UNIX;
 }
 
-// return true if the format used is the DOS/Windows one and the string looks
+// return true if the string looks like a UNC path
-// like a UNC path
+static bool IsUNCPath(const wxString& path)
-static bool IsUNCPath(const wxString& path, wxPathFormat format)
 {
-    return format == wxPATH_DOS &&
+    return path.length() >= 3 && // "\\a" is the shortest UNC path
-                path.length() >= 4 && // "\\a" can't be a UNC path
                     IsDOSPathSep(path[0u]) &&
                         IsDOSPathSep(path[1u]) &&
                             !IsDOSPathSep(path[2u]);
 }
 
+// return true if the string looks like a GUID volume path ("\\?\Volume{guid}\")
+static bool IsVolumeGUIDPath(const wxString& path)
+{
+    return path.length() >= wxMSWUniqueVolumePrefixLength &&
+             path.StartsWith(wxS("\\\\?\\Volume{")) &&
+              path[wxMSWUniqueVolumePrefixLength - 1] == wxFILE_SEP_PATH_DOS;
+}
+
 // Under Unix-ish systems (basically everything except Windows but we can't
 // just test for non-__WIN32__ because Cygwin defines it, yet we want to use
 // lstat() under it, so test for all the rest explicitly) we may work either
@@ -353,13 +367,6 @@ bool StatAny(wxStructStat& st, const wxFileName& fn)
 
 #endif // wxHAVE_LSTAT
 
-// ----------------------------------------------------------------------------
-// private constants
-// ----------------------------------------------------------------------------
-
-// length of \\?\Volume{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}\ string
-static const size_t wxMSWUniqueVolumePrefixLength = 49;
-
 } // anonymous namespace
 
 // ============================================================================
@@ -392,22 +399,7 @@ void wxFileName::Assign(const wxString& volume,
     // have the volume here and the UNC notation (\\server\path) is only valid
     // for paths which don't start with a volume, so prevent SetPath() from
     // recognizing "\\foo\bar" in "c:\\foo\bar" as an UNC path
-    //
+    DoSetPath(path, format, SetPath_PathOnly);
-    // note also that this is a rather ugly way to do what we want (passing
-    // some kind of flag telling to ignore UNC paths to SetPath() would be
-    // better) but this is the safest thing to do to avoid breaking backwards
-    // compatibility in 2.8
-    if ( IsUNCPath(path, format) )
-    {
-        // remove one of the 2 leading backslashes to ensure that it's not
-        // recognized as an UNC path by SetPath()
-        wxString pathNonUNC(path, 1, wxString::npos);
-        SetPath(pathNonUNC, format);
-    }
-    else // no UNC complications
-    {
-        SetPath(path, format);
-    }
 
     m_volume = volume;
     m_ext = ext;
@@ -416,7 +408,13 @@ void wxFileName::Assign(const wxString& volume,
     m_hasExt = hasExt;
 }
 
-void wxFileName::SetPath( const wxString& pathOrig, wxPathFormat format )
+void wxFileName::SetPath( const wxString& path, wxPathFormat format )
+{
+    DoSetPath(path, format, SetPath_MayHaveVolume);
+}
+
+void
+wxFileName::DoSetPath(const wxString& pathOrig, wxPathFormat format, int flags)
 {
     m_dirs.Clear();
 
@@ -431,8 +429,10 @@ void wxFileName::SetPath( const wxString& pathOrig, wxPathFormat format )
     format = GetFormat( format );
 
     // 0) deal with possible volume part first
-    wxString volume,
+    wxString path;
-             path;
+    if ( flags & SetPath_MayHaveVolume )
+    {
+        wxString volume;
         SplitVolume(pathOrig, &volume, &path, format);
         if ( !volume.empty() )
         {
@@ -441,13 +441,18 @@ void wxFileName::SetPath( const wxString& pathOrig, wxPathFormat format )
             SetVolume(volume);
         }
 
-    // 1) Determine if the path is relative or absolute.
-
         if ( path.empty() )
         {
             // we had only the volume
             return;
         }
+    }
+    else
+    {
+        path = pathOrig;
+    }
+
+    // 1) Determine if the path is relative or absolute.
 
     wxChar leadingChar = path[0u];
 
@@ -1283,7 +1288,10 @@ bool wxFileName::Mkdir( const wxString& dir, int perm, int flags )
         size_t count = dirs.GetCount();
         for ( size_t i = 0; i < count; i++ )
         {
-            if ( i > 0 || filename.IsAbsolute() )
+            // Do not use IsAbsolute() here because we want the path to start
+            // with the separator even if it doesn't have any volume, but
+            // IsAbsolute() would return false in this case.
+            if ( i > 0 || !filename.m_relative )
                 currPath += wxFILE_SEP_PATH;
             currPath += dirs[i];
 
@@ -1985,10 +1993,7 @@ wxFileName::IsMSWUniqueVolumeNamePath(const wxString& path, wxPathFormat format)
 {
     // return true if the format used is the DOS/Windows one and the string begins
     // with a Windows unique volume name ("\\?\Volume{guid}\")
-    return format == wxPATH_DOS &&
+    return GetFormat(format) == wxPATH_DOS && IsVolumeGUIDPath(path);
-            path.length() >= wxMSWUniqueVolumePrefixLength &&
-             path.StartsWith(wxS("\\\\?\\Volume{")) &&
-              path[wxMSWUniqueVolumePrefixLength - 1] == wxFILE_SEP_PATH_DOS;
 }
 
 // ----------------------------------------------------------------------------
@@ -2331,50 +2336,62 @@ wxString wxFileName::GetVolumeString(char drive, int flags)
 
 /* static */
 void
-wxFileName::SplitVolume(const wxString& fullpathWithVolume,
+wxFileName::SplitVolume(const wxString& fullpath,
                         wxString *pstrVolume,
                         wxString *pstrPath,
                         wxPathFormat format)
 {
     format = GetFormat(format);
 
-    wxString fullpath = fullpathWithVolume;
+    wxString pathOnly;
 
-    if ( IsMSWUniqueVolumeNamePath(fullpath, format) )
+    switch ( format )
     {
-        // special Windows unique volume names hack: transform
+        case wxPATH_DOS:
-        // \\?\Volume{guid}\path into Volume{guid}:path
+            // Deal with MSW UNC and volume GUID paths complications first.
-        // note: this check must be done before the check for UNC path
+            if ( IsVolumeGUIDPath(fullpath) )
+            {
+                if ( pstrVolume )
+                    *pstrVolume = fullpath.Left(wxMSWUniqueVolumePrefixLength - 1);
 
-        // we know the last backslash from the unique volume name is located
+                // Note: take the first slash here.
-        // there from IsMSWUniqueVolumeNamePath
+                pathOnly = fullpath.Mid(wxMSWUniqueVolumePrefixLength - 1);
-        fullpath[wxMSWUniqueVolumePrefixLength - 1] = wxFILE_SEP_DSK;
 
-        // paths starting with a unique volume name should always be absolute
+                break;
-        fullpath.insert(wxMSWUniqueVolumePrefixLength, 1, wxFILE_SEP_PATH_DOS);
-
-        // remove the leading "\\?\" part
-        fullpath.erase(0, 4);
             }
-    else if ( IsUNCPath(fullpath, format) )
+
+            if ( IsUNCPath(fullpath) )
             {
-        // special Windows UNC paths hack: transform \\share\path into share:path
+                // Note that IsUNCPath() checks that 3rd character is not a
-
+                // (back)slash.
-        fullpath.erase(0, 2);
-
                 size_t posFirstSlash =
-            fullpath.find_first_of(GetPathTerminators(format));
+                    fullpath.find_first_of(GetPathTerminators(format), 3);
                 if ( posFirstSlash != wxString::npos )
                 {
-            fullpath[posFirstSlash] = wxFILE_SEP_DSK;
+                    if ( pstrVolume )
-
+                        *pstrVolume = fullpath.Left(posFirstSlash);
-            // UNC paths are always absolute, right? (FIXME)
+                    pathOnly = fullpath.Mid(posFirstSlash);
-            fullpath.insert(posFirstSlash + 1, 1, wxFILE_SEP_PATH_DOS);
                 }
+                else // UNC path to the root of the share (just "\\share")
+                {
+                    if ( pstrVolume )
+                        *pstrVolume = fullpath;
                 }
 
-    // We separate the volume here
+                // In any case, normalize slashes to backslashes, which are canonical
-    if ( format == wxPATH_DOS || format == wxPATH_VMS )
+                // separators for the UNC paths.
+                if ( pstrVolume )
+                {
+                    (*pstrVolume)[0] =
+                    (*pstrVolume)[1] = '\\';
+                }
+
+                break;
+            }
+
+            wxFALLTHROUGH;
+
+        case wxPATH_VMS:
             {
                 wxString sepVol = GetVolumeSeparator(format);
 
@@ -2390,12 +2407,29 @@ wxFileName::SplitVolume(const wxString& fullpathWithVolume,
                     }
 
                     // remove the volume name and the separator from the full path
-            fullpath.erase(0, posFirstColon + sepVol.length());
+                    pathOnly = fullpath.Mid(posFirstColon + 1);
                 }
+                else
+                {
+                    pathOnly = fullpath;
+                }
+            }
+            break;
+
+        case wxPATH_MAC:
+        case wxPATH_UNIX:
+            // Volumes are not used in paths in this format.
+            pathOnly = fullpath;
+            break;
+
+        case wxPATH_NATIVE:
+        case wxPATH_MAX:
+            wxFAIL_MSG( wxS("unreachable") );
+            break;
     }
 
     if ( pstrPath )
-        *pstrPath = fullpath;
+        *pstrPath = pathOnly;
 }
 
 /* static */

tests/filename/filenametest.cpp

@@ -82,9 +82,9 @@ static struct TestFileNameInfo
     { "c:\\foo.bar", "c", "\\", "foo", "bar", true, wxPATH_DOS },
     { "c:\\Windows\\command.com", "c", "\\Windows", "command", "com", true, wxPATH_DOS },
     { "\\\\?\\Volume{8089d7d7-d0ac-11db-9dd0-806d6172696f}\\",
-      "Volume{8089d7d7-d0ac-11db-9dd0-806d6172696f}", "\\", "", "", true, wxPATH_DOS },
+      "\\\\?\\Volume{8089d7d7-d0ac-11db-9dd0-806d6172696f}", "\\", "", "", true, wxPATH_DOS },
     { "\\\\?\\Volume{8089d7d7-d0ac-11db-9dd0-806d6172696f}\\Program Files\\setup.exe",
-      "Volume{8089d7d7-d0ac-11db-9dd0-806d6172696f}", "\\Program Files", "setup", "exe", true, wxPATH_DOS },
+      "\\\\?\\Volume{8089d7d7-d0ac-11db-9dd0-806d6172696f}", "\\Program Files", "setup", "exe", true, wxPATH_DOS },
 
 #if 0
     // NB: when using the wxFileName::GetLongPath() function on these two
@@ -169,7 +169,9 @@ TEST_CASE("wxFileName::Construction", "[filename]")
         // if the test is run from root directory or its direct subdirectory
         CHECK( fn.Normalize(wxPATH_NORM_ALL, "/foo/bar/baz", fni.format) );
 
-        if ( *fni.volume && *fni.path )
+        // restrict this check to drive letter volumes as UNC and GUID volumes
+        // can't be combined with the path using the volume separator
+        if ( strlen(fni.volume) == 1 && *fni.path )
         {
             // check that specifying the volume separately or as part of the
             // path doesn't make any difference
@@ -287,6 +289,7 @@ TEST_CASE("wxFileName::Normalize", "[filename]")
         { "a/.././b/c/../../", wxPATH_NORM_DOTS, "", wxPATH_UNIX },
         { "", wxPATH_NORM_DOTS, "", wxPATH_UNIX },
         { "./foo", wxPATH_NORM_DOTS, "foo", wxPATH_UNIX },
+        { "foo/./bar", wxPATH_NORM_DOTS, "foo/bar", wxPATH_UNIX },
         { "b/../bar", wxPATH_NORM_DOTS, "bar", wxPATH_UNIX },
         { "c/../../quux", wxPATH_NORM_DOTS, "../quux", wxPATH_UNIX },
         { "/c/../../quux", wxPATH_NORM_DOTS, "/quux", wxPATH_UNIX },
@@ -544,25 +547,38 @@ TEST_CASE("wxFileName::ShortLongPath", "[filename]")
 TEST_CASE("wxFileName::UNC", "[filename]")
 {
     wxFileName fn("//share/path/name.ext", wxPATH_DOS);
-    CHECK( fn.GetVolume() == "share" );
+    CHECK( fn.GetVolume() == "\\\\share" );
     CHECK( fn.GetPath(wxPATH_NO_SEPARATOR, wxPATH_DOS) == "\\path" );
 
     fn.Assign("\\\\share2\\path2\\name.ext", wxPATH_DOS);
-    CHECK( fn.GetVolume() == "share2" );
+    CHECK( fn.GetVolume() == "\\\\share2" );
     CHECK( fn.GetPath(wxPATH_NO_SEPARATOR, wxPATH_DOS) == "\\path2" );
+
+#ifdef __WINDOWS__
+    // Check that doubled backslashes in the beginning of the path are not
+    // misinterpreted as UNC volume when we have a drive letter in the
+    // beginning.
+    fn.Assign("d:\\\\root\\directory\\file");
+    CHECK( fn.GetFullPath() == "d:\\root\\directory\\file" );
+
+    // Check that single letter UNC paths don't turn into drive letters, as
+    // they used to do.
+    fn.Assign("\\\\x\\dir\\file");
+    CHECK( fn.GetFullPath() == "\\\\x\\dir\\file" );
+#endif // __WINDOWS__
 }
 
 TEST_CASE("wxFileName::VolumeUniqueName", "[filename]")
 {
     wxFileName fn("\\\\?\\Volume{8089d7d7-d0ac-11db-9dd0-806d6172696f}\\",
                   wxPATH_DOS);
-    CHECK( fn.GetVolume() == "Volume{8089d7d7-d0ac-11db-9dd0-806d6172696f}" );
+    CHECK( fn.GetVolume() == "\\\\?\\Volume{8089d7d7-d0ac-11db-9dd0-806d6172696f}" );
     CHECK( fn.GetPath(wxPATH_NO_SEPARATOR, wxPATH_DOS) == "\\" );
     CHECK( fn.GetFullPath(wxPATH_DOS) == "\\\\?\\Volume{8089d7d7-d0ac-11db-9dd0-806d6172696f}\\" );
 
     fn.Assign("\\\\?\\Volume{8089d7d7-d0ac-11db-9dd0-806d6172696f}\\"
               "Program Files\\setup.exe", wxPATH_DOS);
-    CHECK( fn.GetVolume() == "Volume{8089d7d7-d0ac-11db-9dd0-806d6172696f}" );
+    CHECK( fn.GetVolume() == "\\\\?\\Volume{8089d7d7-d0ac-11db-9dd0-806d6172696f}" );
     CHECK( fn.GetPath(wxPATH_NO_SEPARATOR, wxPATH_DOS) == "\\Program Files" );
     CHECK( fn.GetFullPath(wxPATH_DOS) == "\\\\?\\Volume{8089d7d7-d0ac-11db-9dd0-806d6172696f}\\Program Files\\setup.exe" );
 }
@@ -708,6 +724,18 @@ TEST_CASE("wxFileName::Exists", "[filename]")
 #endif // __UNIX__
 }
 
+TEST_CASE("wxFileName::Mkdir", "[filename]")
+{
+    wxFileName fn;
+    fn.AssignDir("/foo/bar");
+    if ( fn.Mkdir(wxS_DIR_DEFAULT, wxPATH_MKDIR_FULL) )
+    {
+        CHECK( fn.DirExists() );
+        CHECK( fn.Rmdir() );
+    }
+    //else: creating the directory may fail because of permissions
+}
+
 TEST_CASE("wxFileName::SameAs", "[filename]")
 {
     wxFileName fn1( wxFileName::CreateTempFileName( "filenametest1" ) );