Allow testing for existence of specific file types in wxFileName.

Add "flags" parameter to wxFileName::Exists() to allow testing for the
existing of files of specific type: not only regular or directory but also
symlink, device, FIFO or socket.

And also to pass wxFILE_EXISTS_NO_FOLLOW flag inhibiting following the
symlinks without using DontFollowLink().

Closes #14542.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@72707 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2012-10-19 22:02:15 +00:00
parent 4f21fcb1ae
commit c50db84779
5 changed files with 155 additions and 44 deletions

View File

@@ -335,14 +335,14 @@ static bool IsUNCPath(const wxString& path, wxPathFormat format)
#ifndef __WIN32__
// Under Unix-ish systems (basically everything except Windows) we may work
// either with the file itself or its target in case it's a symbolic link, as
// determined by wxFileName::ShouldFollowLink(). StatAny() can be used to stat
// the appropriate file with an extra twist that it also works (by following
// the symlink by default) when there is no wxFileName object at all, as is the
// case in static methods.
// either with the file itself or its target if it's a symbolic link and we
// should dereference it, as determined by wxFileName::ShouldFollowLink() and
// the absence of the wxFILE_EXISTS_NO_FOLLOW flag. StatAny() can be used to
// stat the appropriate file with an extra twist that it also works when there
// is no wxFileName object at all, as is the case in static methods.
// Private implementation, don't call directly, use one of the overloads below.
bool DoStatAny(wxStructStat& st, wxString path, const wxFileName* fn)
bool DoStatAny(wxStructStat& st, wxString path, bool dereference)
{
// We need to remove any trailing slashes from the path because they could
// interfere with the symlink following decision: even if we use lstat(),
@@ -362,23 +362,22 @@ bool DoStatAny(wxStructStat& st, wxString path, const wxFileName* fn)
path.erase(posLast);
}
int ret = !fn || fn->ShouldFollowLink() ? wxStat(path, &st)
: wxLstat(path, &st);
int ret = dereference ? wxStat(path, &st) : wxLstat(path, &st);
return ret == 0;
}
// Overloads to use for a case when we don't have wxFileName object and when we
// do have one.
inline
bool StatAny(wxStructStat& st, const wxString& path)
bool StatAny(wxStructStat& st, const wxString& path, int flags)
{
return DoStatAny(st, path, NULL);
return DoStatAny(st, path, !(flags & wxFILE_EXISTS_NO_FOLLOW));
}
inline
bool StatAny(wxStructStat& st, const wxFileName& fn)
{
return DoStatAny(st, fn.GetFullPath(), &fn);
return DoStatAny(st, fn.GetFullPath(), fn.ShouldFollowLink());
}
#endif // !__WIN32__
@@ -644,16 +643,6 @@ wxFileName wxFileName::DirName(const wxString& dir, wxPathFormat format)
namespace
{
// Flags for wxFileSystemObjectExists() asking it to check for:
enum
{
wxFileSystemObject_File = 1, // file existence
wxFileSystemObject_Dir = 2, // directory existence
wxFileSystemObject_Other = 4, // existence of something else, e.g.
// device, socket, FIFO under Unix
wxFileSystemObject_Any = 7 // existence of anything at all
};
#if defined(__WINDOWS__) && !defined(__WXMICROWIN__)
void RemoveTrailingSeparatorsFromPath(wxString& strPath)
@@ -679,15 +668,13 @@ void RemoveTrailingSeparatorsFromPath(wxString& strPath)
#endif // __WINDOWS__ || __OS2__
bool
wxFileSystemObjectExists(const wxString& path, int flags,
const wxFileName* fn = NULL)
wxFileSystemObjectExists(const wxString& path, int flags)
{
wxUnusedVar(fn); // It's only used under Unix
// Should the existence of file/directory with this name be accepted, i.e.
// result in the true return value from this function?
const bool acceptFile = (flags & wxFileSystemObject_File) != 0;
const bool acceptDir = (flags & wxFileSystemObject_Dir) != 0;
const bool acceptFile = (flags & wxFILE_EXISTS_REGULAR) != 0;
const bool acceptDir = (flags & wxFILE_EXISTS_DIR) != 0;
wxString strPath(path);
@@ -735,22 +722,30 @@ wxFileSystemObjectExists(const wxString& path, int flags,
// We consider that the path must exist if we get a sharing violation for
// it but we don't know what is it in this case.
if ( rc == ERROR_SHARING_VIOLATION )
return flags & wxFileSystemObject_Other;
return flags & wxFILE_EXISTS_ANY;
// Any other error (usually ERROR_PATH_NOT_FOUND), means there is nothing
// there.
return false;
#else // Non-MSW, non-OS/2
wxStructStat st;
if ( !DoStatAny(st, strPath, fn) )
if ( !StatAny(st, strPath, flags) )
return false;
if ( S_ISREG(st.st_mode) )
return acceptFile;
if ( S_ISDIR(st.st_mode) )
return acceptDir;
if ( S_ISLNK(st.st_mode) )
return (flags & wxFILE_EXISTS_SYMLINK) != 0;
if ( S_ISBLK(st.st_mode) || S_ISCHR(st.st_mode) )
return (flags & wxFILE_EXISTS_DEVICE) != 0;
if ( S_ISFIFO(st.st_mode) )
return (flags & wxFILE_EXISTS_FIFO) != 0;
if ( S_ISSOCK(st.st_mode) )
return (flags & wxFILE_EXISTS_SOCKET) != 0;
return flags & wxFileSystemObject_Other;
return flags & wxFILE_EXISTS_ANY;
#endif // Platforms
}
@@ -758,35 +753,50 @@ wxFileSystemObjectExists(const wxString& path, int flags,
bool wxFileName::FileExists() const
{
return wxFileSystemObjectExists(GetFullPath(), wxFileSystemObject_File, this);
int flags = wxFILE_EXISTS_REGULAR;
if ( !ShouldFollowLink() )
flags |= wxFILE_EXISTS_NO_FOLLOW;
return wxFileSystemObjectExists(GetFullPath(), flags);
}
/* static */
bool wxFileName::FileExists( const wxString &filePath )
{
return wxFileSystemObjectExists(filePath, wxFileSystemObject_File);
return wxFileSystemObjectExists(filePath, wxFILE_EXISTS_REGULAR);
}
bool wxFileName::DirExists() const
{
return wxFileSystemObjectExists(GetPath(), wxFileSystemObject_Dir, this);
int flags = wxFILE_EXISTS_DIR;
if ( !ShouldFollowLink() )
flags |= wxFILE_EXISTS_NO_FOLLOW;
return Exists(GetFullPath(), flags);
}
/* static */
bool wxFileName::DirExists( const wxString &dirPath )
{
return wxFileSystemObjectExists(dirPath, wxFileSystemObject_Dir);
return wxFileSystemObjectExists(dirPath, wxFILE_EXISTS_DIR);
}
bool wxFileName::Exists() const
bool wxFileName::Exists(int flags) const
{
return wxFileSystemObjectExists(GetFullPath(), wxFileSystemObject_Any, this);
// Notice that wxFILE_EXISTS_NO_FOLLOW may be specified in the flags even
// if our DontFollowLink() hadn't been called and we do honour it then. But
// if the user took the care of calling DontFollowLink(), it is always
// taken into account.
if ( !ShouldFollowLink() )
flags |= wxFILE_EXISTS_NO_FOLLOW;
return wxFileSystemObjectExists(GetFullPath(), flags);
}
/* static */
bool wxFileName::Exists(const wxString& path)
bool wxFileName::Exists(const wxString& path, int flags)
{
return wxFileSystemObjectExists(path, wxFileSystemObject_Any);
return wxFileSystemObjectExists(path, flags);
}
// ----------------------------------------------------------------------------