static const char sgSearchPathSep = ':';
#endif
+#ifdef _WIN32
+#include <ShlObj.h> // for CSIDL
+// TODO: replace this include file with the official <versionhelpers.h> header
+// included in the Windows 8.1 SDK
+#include "sgversionhelpers.hxx"
+
+static SGPath pathForCSIDL(int csidl, const SGPath& def)
+{
+ typedef BOOL (WINAPI*GetSpecialFolderPath)(HWND, LPSTR, int, BOOL);
+ static GetSpecialFolderPath SHGetSpecialFolderPath = NULL;
+
+ // lazy open+resolve of shell32
+ if (!SHGetSpecialFolderPath) {
+ HINSTANCE shellDll = ::LoadLibrary("shell32");
+ SHGetSpecialFolderPath = (GetSpecialFolderPath) GetProcAddress(shellDll, "SHGetSpecialFolderPathA");
+ }
+
+ if (!SHGetSpecialFolderPath){
+ return def;
+ }
+
+ char path[MAX_PATH];
+ if (SHGetSpecialFolderPath(0, path, csidl, false)) {
+ return SGPath(path, def.getPermissionChecker());
+ }
+
+ return def;
+}
+
+static SGPath pathForKnownFolder(REFKNOWNFOLDERID folderId, const SGPath& def)
+{
+ typedef HRESULT (WINAPI*PSHGKFP)(REFKNOWNFOLDERID, DWORD, HANDLE, PWSTR*);
+
+ HINSTANCE shellDll = LoadLibrary(TEXT("shell32"));
+ if (shellDll != NULL) {
+ PSHGKFP pSHGetKnownFolderPath = (PSHGKFP) GetProcAddress(shellDll, "SHGetKnownFolderPath");
+ if (pSHGetKnownFolderPath != NULL) {
+ // system call will allocate dynamic memory... which we must release when done
+ wchar_t* localFolder = 0;
+
+ if (pSHGetKnownFolderPath(folderId, KF_FLAG_DEFAULT_PATH, NULL, &localFolder) == S_OK) {
+ // copy into local memory
+ char path[MAX_PATH];
+ size_t len;
+ if (wcstombs_s(&len, path, localFolder, MAX_PATH) != S_OK) {
+ path[0] = '\0';
+ SG_LOG(SG_GENERAL, SG_WARN, "WCS to MBS failed");
+ }
+
+ SGPath folder_path = SGPath(path, def.getPermissionChecker());
+
+ // release dynamic memory
+ CoTaskMemFree(static_cast<void*>(localFolder));
+
+ return folder_path;
+ }
+ }
+
+ FreeLibrary(shellDll);
+ }
+
+ return def;
+}
+
+#elif __APPLE__
+
+// defined in CocoaHelpers.mm
+SGPath appleSpecialFolder(int dirType, int domainMask, const SGPath& def);
+
+#else
+static SGPath getXDGDir( const std::string& name,
+ const SGPath& def,
+ const std::string& fallback )
+{
+ // http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
+
+ // $XDG_CONFIG_HOME defines the base directory relative to which user specific
+ // configuration files should be stored. If $XDG_CONFIG_HOME is either not set
+ // or empty, a default equal to $HOME/.config should be used.
+ const SGPath user_dirs = SGPath::fromEnv( "XDG_CONFIG_HOME",
+ SGPath::home() / ".config")
+ / "user-dirs.dirs";
+
+ // Format is XDG_xxx_DIR="$HOME/yyy", where yyy is a shell-escaped
+ // homedir-relative path, or XDG_xxx_DIR="/yyy", where /yyy is an absolute
+ // path. No other format is supported.
+ const std::string XDG_ID = "XDG_" + name + "_DIR=\"";
+
+ std::ifstream user_dirs_file( user_dirs.c_str() );
+ std::string line;
+ while( std::getline(user_dirs_file, line).good() )
+ {
+ if( !starts_with(line, XDG_ID) || *line.rbegin() != '"' )
+ continue;
+
+ // Extract dir from XDG_<name>_DIR="<dir>"
+ line = line.substr(XDG_ID.length(), line.length() - XDG_ID.length() - 1 );
+
+ const std::string HOME = "$HOME";
+ if( starts_with(line, HOME) )
+ return SGPath::home(def)
+ / simgear::strutils::unescape(line.substr(HOME.length()));
+
+ return SGPath(line, def.getPermissionChecker());
+ }
+
+ if( def.isNull() )
+ return SGPath::home(def) / fallback;
+
+ return def;
+}
+#endif
// For windows, replace "\" by "/".
void
// default constructor
-SGPath::SGPath()
+SGPath::SGPath(PermissionChecker validator)
: path(""),
+ _permission_checker(validator),
_cached(false),
+ _rwCached(false),
_cacheEnabled(true)
{
}
// create a path based on "path"
-SGPath::SGPath( const std::string& p )
+SGPath::SGPath( const std::string& p, PermissionChecker validator )
: path(p),
+ _permission_checker(validator),
_cached(false),
+ _rwCached(false),
_cacheEnabled(true)
{
fix();
}
// create a path based on "path" and a "subpath"
-SGPath::SGPath( const SGPath& p, const std::string& r )
+SGPath::SGPath( const SGPath& p,
+ const std::string& r,
+ PermissionChecker validator )
: path(p.path),
+ _permission_checker(validator),
_cached(false),
+ _rwCached(false),
_cacheEnabled(p._cacheEnabled)
{
append(r);
SGPath::SGPath(const SGPath& p) :
path(p.path),
+ _permission_checker(p._permission_checker),
_cached(p._cached),
+ _rwCached(p._rwCached),
_cacheEnabled(p._cacheEnabled),
+ _canRead(p._canRead),
+ _canWrite(p._canWrite),
_exists(p._exists),
_isDir(p._isDir),
_isFile(p._isFile),
SGPath& SGPath::operator=(const SGPath& p)
{
path = p.path;
+ _permission_checker = p._permission_checker,
_cached = p._cached;
+ _rwCached = p._rwCached;
_cacheEnabled = p._cacheEnabled;
+ _canRead = p._canRead;
+ _canWrite = p._canWrite;
_exists = p._exists;
_isDir = p._isDir;
_isFile = p._isFile;
path = p;
fix();
_cached = false;
+ _rwCached = false;
+}
+
+//------------------------------------------------------------------------------
+void SGPath::setPermissionChecker(PermissionChecker validator)
+{
+ _permission_checker = validator;
+ _rwCached = false;
+}
+
+//------------------------------------------------------------------------------
+SGPath::PermissionChecker SGPath::getPermissionChecker() const
+{
+ return _permission_checker;
}
+//------------------------------------------------------------------------------
void SGPath::set_cached(bool cached)
{
- _cacheEnabled = cached;
+ _cacheEnabled = cached;
}
// append another piece to the existing path
void SGPath::append( const string& p ) {
- if ( path.size() == 0 ) {
+ if ( path.empty() ) {
path = p;
} else {
if ( p[0] != sgDirPathSep ) {
}
fix();
_cached = false;
+ _rwCached = false;
}
//------------------------------------------------------------------------------
// concatenate a string to the end of the path without inserting a
// path separator
void SGPath::concat( const string& p ) {
- if ( path.size() == 0 ) {
+ if ( path.empty() ) {
path = p;
} else {
path += p;
}
fix();
_cached = false;
+ _rwCached = false;
}
}
}
+//------------------------------------------------------------------------------
void SGPath::validate() const
{
if (_cached && _cacheEnabled) {
return;
}
-
+
+ if (path.empty()) {
+ _exists = false;
+ return;
+ }
+
#ifdef _WIN32
struct _stat buf ;
-
bool remove_trailing = false;
- if ( path.length() > 1 && path[path.length()-1] == '/' )
- remove_trailing=true;
- if (_stat (path.substr(0,remove_trailing?path.length()-1:path.length()).c_str(), &buf ) < 0) {
+ string statPath(path);
+ if ((path.length() > 1) && (path.back() == '/')) {
+ statPath.pop_back();
+ }
+
+ if (_stat(statPath.c_str(), &buf ) < 0) {
_exists = false;
} else {
_exists = true;
_cached = true;
}
+//------------------------------------------------------------------------------
+void SGPath::checkAccess() const
+{
+ if( _rwCached && _cacheEnabled )
+ return;
+
+ if( _permission_checker )
+ {
+ Permissions p = _permission_checker(*this);
+ _canRead = p.read;
+ _canWrite = p.write;
+ }
+ else
+ {
+ _canRead = true;
+ _canWrite = true;
+ }
+
+ _rwCached = true;
+}
+
bool SGPath::exists() const
{
validate();
return _exists;
}
+//------------------------------------------------------------------------------
+bool SGPath::canRead() const
+{
+ checkAccess();
+ return _canRead;
+}
+
+//------------------------------------------------------------------------------
+bool SGPath::canWrite() const
+{
+ checkAccess();
+ return _canWrite;
+}
+
bool SGPath::isDir() const
{
validate();
return _exists && _isFile;
}
+//------------------------------------------------------------------------------
#ifdef _WIN32
# define sgMkDir(d,m) _mkdir(d)
#else
# define sgMkDir(d,m) mkdir(d,m)
#endif
+int SGPath::create_dir(mode_t mode)
+{
+ if( !canWrite() )
+ {
+ SG_LOG( SG_IO,
+ SG_WARN, "Error creating directory for '" << str() << "'"
+ " reason: access denied" );
+ return -3;
+ }
-int SGPath::create_dir( mode_t mode ) {
string_list dirlist = sgPathSplit(dir());
if ( dirlist.empty() )
return -1;
bool absolute = !path.empty() && path[0] == sgDirPathSep;
unsigned int i = 1;
- SGPath dir = absolute ? string( 1, sgDirPathSep ) : "";
+ SGPath dir(absolute ? string( 1, sgDirPathSep ) : "", _permission_checker);
dir.concat( path_elements[0] );
#ifdef _WIN32
if ( dir.str().find(':') != string::npos && path_elements.size() >= 2 ) {
i = 2;
}
#endif
- struct stat info;
- int r;
- for(; ( r = stat( dir.c_str(), &info ) ) == 0 && i < path_elements.size(); i++) {
- dir.append(path_elements[i]);
- }
- if ( r == 0 ) {
- return 0; // Directory already exists
- }
- if ( sgMkDir( dir.c_str(), mode) ) {
- SG_LOG( SG_IO, SG_ALERT, "Error creating directory: " + dir.str() );
- return -2;
- }
- for(; i < path_elements.size(); i++) {
- dir.append(path_elements[i]);
- if ( sgMkDir( dir.c_str(), mode) ) {
- SG_LOG( SG_IO, SG_ALERT, "Error creating directory: " + dir.str() );
- return -2;
- }
+ struct stat info;
+ int r;
+ for(; (r = stat(dir.c_str(), &info)) == 0 && i < path_elements.size(); ++i)
+ dir.append(path_elements[i]);
+ if( r == 0 )
+ return 0; // Directory already exists
+
+ for(;;)
+ {
+ if( sgMkDir(dir.c_str(), mode) )
+ {
+ SG_LOG( SG_IO,
+ SG_ALERT, "Error creating directory: (" << dir.str() << ")" );
+ return -2;
}
+ else
+ SG_LOG(SG_IO, SG_DEBUG, "Directory created: " << dir.str());
+
+ if( i >= path_elements.size() )
+ return 0;
- return 0;
+ dir.append(path_elements[i++]);
+ }
+
+ return 0;
}
string_list sgPathBranchSplit( const string &dirpath ) {
string_list path_elements;
string element, path = dirpath;
- while ( path.size() ) {
+ while ( ! path.empty() ) {
size_t p = path.find( sgDirPathSep );
if ( p != string::npos ) {
element = path.substr( 0, p );
element = path;
path = "";
}
- if ( element.size() )
+ if ( ! element.empty() )
path_elements.push_back( element );
}
return path_elements;
#endif
}
+//------------------------------------------------------------------------------
bool SGPath::remove()
{
- int err = ::unlink(c_str());
- if (err) {
- SG_LOG(SG_IO, SG_WARN, "file remove failed: (" << str() << ") " << strerror(errno));
- }
- return (err == 0);
+ if( !canWrite() )
+ {
+ SG_LOG( SG_IO, SG_WARN, "file remove failed: (" << str() << ")"
+ " reason: access denied" );
+ return false;
+ }
+
+ int err = ::unlink(c_str());
+ if( err )
+ {
+ SG_LOG( SG_IO, SG_WARN, "file remove failed: (" << str() << ") "
+ " reason: " << strerror(errno) );
+ // TODO check if failed unlink can really change any of the cached values
+ }
+
+ _cached = false; // stat again if required
+ _rwCached = false;
+ return (err == 0);
}
time_t SGPath::modTime() const
return (path != other.path);
}
+//------------------------------------------------------------------------------
bool SGPath::rename(const SGPath& newName)
{
- if (::rename(c_str(), newName.c_str()) != 0) {
- SG_LOG(SG_IO, SG_WARN, "renamed failed: from " << str() << " to " << newName.str()
- << " reason: " << strerror(errno));
- return false;
- }
-
- path = newName.path;
- _cached = false;
- return true;
-}
+ if( !canRead() || !canWrite() || !newName.canWrite() )
+ {
+ SG_LOG( SG_IO, SG_WARN, "rename failed: from " << str() <<
+ " to " << newName.str() <<
+ " reason: access denied" );
+ return false;
+ }
-//------------------------------------------------------------------------------
-SGPath SGPath::fromEnv(const char* name, const SGPath& def)
-{
- const char* val = getenv(name);
- if( val && val[0] )
- return SGPath(val);
- return def;
-}
+#ifdef SG_WINDOWS
+ if (newName.exists()) {
+ SGPath r(newName);
+ if (!r.remove()) {
+ return false;
+ }
+ }
+#endif
+ if( ::rename(c_str(), newName.c_str()) != 0 )
+ {
+ SG_LOG( SG_IO, SG_WARN, "rename failed: from " << str() <<
+ " to " << newName.str() <<
+ " reason: " << strerror(errno) );
+ return false;
+ }
-#ifdef _WIN32
-//------------------------------------------------------------------------------
-SGPath SGPath::home()
-{
- // TODO
- return SGPath();
+ path = newName.path;
+
+ // Do not remove permission checker (could happen for example if just using
+ // a std::string as new name)
+ if( newName._permission_checker )
+ _permission_checker = newName._permission_checker;
+
+ _cached = false;
+ _rwCached = false;
+
+ return true;
}
-#else
+
//------------------------------------------------------------------------------
-SGPath SGPath::home()
+SGPath SGPath::standardLocation(StandardLocation type, const SGPath& def)
{
- return fromEnv("HOME");
-}
-#endif
+ switch(type)
+ {
+ case HOME:
+ return home(def);
#ifdef _WIN32
+ case DESKTOP:
+ if (IsWindowsVistaOrGreater())
+ return pathForKnownFolder(FOLDERID_Desktop, def);
-#include <ShlObj.h> // for CSIDL
+ return pathForCSIDL(CSIDL_DESKTOPDIRECTORY, def);
-//------------------------------------------------------------------------------
-SGPath SGPath::desktop()
-{
- typedef BOOL (WINAPI*GetSpecialFolderPath)(HWND, LPSTR, int, BOOL);
- static GetSpecialFolderPath SHGetSpecialFolderPath = NULL;
+ case DOWNLOADS:
+ if (IsWindowsVistaOrGreater())
+ return pathForKnownFolder(FOLDERID_Downloads, def);
- // lazy open+resolve of shell32
- if (!SHGetSpecialFolderPath) {
- HINSTANCE shellDll = ::LoadLibrary("shell32");
- SHGetSpecialFolderPath = (GetSpecialFolderPath) GetProcAddress(shellDll, "SHGetSpecialFolderPathA");
- }
+ if (!def.isNull())
+ return def;
- if (!SHGetSpecialFolderPath){
- return SGPath();
- }
+ return pathForCSIDL(CSIDL_DESKTOPDIRECTORY, def);
- char path[MAX_PATH];
- if (SHGetSpecialFolderPath(0, path, CSIDL_DESKTOPDIRECTORY, false)) {
- return SGPath(path);
- }
+ case DOCUMENTS:
+ if (IsWindowsVistaOrGreater())
+ return pathForKnownFolder(FOLDERID_Documents, def);
- SG_LOG(SG_GENERAL, SG_ALERT, "SGPath::desktop() failed, bad" );
- return SGPath();
-}
-#elif __APPLE__
-#include <CoreServices/CoreServices.h>
+ return pathForCSIDL(CSIDL_MYDOCUMENTS, def);
-//------------------------------------------------------------------------------
-SGPath SGPath::desktop()
-{
- FSRef ref;
- OSErr err = FSFindFolder(kUserDomain, kDesktopFolderType, false, &ref);
- if (err) {
- return SGPath();
- }
+ case PICTURES:
+ if (IsWindowsVistaOrGreater())
+ return pathForKnownFolder(FOLDERID_Pictures, def);
- unsigned char path[1024];
- if (FSRefMakePath(&ref, path, 1024) != noErr) {
- return SGPath();
- }
+ return pathForCSIDL(CSIDL_MYPICTURES, def);
- return SGPath((const char*) path);
-}
+#elif __APPLE__
+ // since this is C++, we can't include NSPathUtilities.h to access the enum
+ // values, so hard-coding them here (they are stable, don't worry)
+ case DOWNLOADS:
+ return appleSpecialFolder(15, 1, def);
+ case DESKTOP:
+ return appleSpecialFolder(12, 1, def);
+ case DOCUMENTS:
+ return appleSpecialFolder(9, 1, def);
+ case PICTURES:
+ return appleSpecialFolder(19, 1, def);
#else
+ case DESKTOP:
+ return getXDGDir("DESKTOP", def, "Desktop");
+ case DOWNLOADS:
+ return getXDGDir("DOWNLOADS", def, "Downloads");
+ case DOCUMENTS:
+ return getXDGDir("DOCUMENTS", def, "Documents");
+ case PICTURES:
+ return getXDGDir("PICTURES", def, "Pictures");
+#endif
+ default:
+ SG_LOG( SG_GENERAL,
+ SG_WARN,
+ "SGPath::standardLocation() unhandled type: " << type );
+ return def;
+ }
+}
+
//------------------------------------------------------------------------------
-SGPath SGPath::desktop()
+SGPath SGPath::fromEnv(const char* name, const SGPath& def)
{
- // http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
-
- // $XDG_CONFIG_HOME defines the base directory relative to which user specific
- // configuration files should be stored. If $XDG_CONFIG_HOME is either not set
- // or empty, a default equal to $HOME/.config should be used.
- const SGPath user_dirs = fromEnv("XDG_CONFIG_HOME", home() / ".config")
- / "user-dirs.dirs";
-
- // Format is XDG_xxx_DIR="$HOME/yyy", where yyy is a shell-escaped
- // homedir-relative path, or XDG_xxx_DIR="/yyy", where /yyy is an absolute
- // path. No other format is supported.
- const std::string DESKTOP = "XDG_DESKTOP_DIR=\"";
-
- std::ifstream user_dirs_file( user_dirs.c_str() );
- std::string line;
- while( std::getline(user_dirs_file, line).good() )
- {
- if( !starts_with(line, DESKTOP) || *line.rbegin() != '"' )
- continue;
-
- // Extract dir from XDG_DESKTOP_DIR="<dir>"
- line = line.substr(DESKTOP.length(), line.length() - DESKTOP.length() - 1 );
+ const char* val = getenv(name);
+ if( val && val[0] )
+ return SGPath(val, def._permission_checker);
+ return def;
+}
- const std::string HOME = "$HOME";
- if( starts_with(line, HOME) )
- return home() / simgear::strutils::unescape(line.substr(HOME.length()));
+//------------------------------------------------------------------------------
+SGPath SGPath::home(const SGPath& def)
+{
+#ifdef _WIN32
+ return fromEnv("USERPROFILE", def);
+#else
+ return fromEnv("HOME", def);
+#endif
+}
- return SGPath(line);
- }
+//------------------------------------------------------------------------------
+SGPath SGPath::desktop(const SGPath& def)
+{
+ return standardLocation(DESKTOP, def);
+}
- return home() / "Desktop";
+//------------------------------------------------------------------------------
+SGPath SGPath::documents(const SGPath& def)
+{
+ return standardLocation(DOCUMENTS, def);
}
-#endif
+//------------------------------------------------------------------------------
std::string SGPath::realpath() const
{
#if (defined(__APPLE__) && MAC_OS_X_VERSION_MAX_ALLOWED <= 1050)
#endif
if (!buf)
{
- SG_LOG(SG_IO, SG_ALERT, "ERROR: The path '" << path << "' does not exist in the file system.");
+ SG_LOG(SG_IO, SG_WARN, "ERROR: The path '" << path << "' does not exist in the file system.");
return path;
}
std::string p(buf);
projects / simgear.git / blobdiff