1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
|
#include "FileSystemHandler.h"
#include <cassert>
#include <sys/stat.h>
#include <sys/types.h>
#include <errno.h>
#include <string.h>
#include <boost/regex.hpp>
#ifndef _WIN32
#include <dirent.h>
#include <sstream>
#include <unistd.h>
#include <time.h>
#else
#include <windows.h>
#include <io.h>
#include <direct.h>
#include <fstream>
// winapi redifines these which breaks things
#if defined(CreateDirectory)
#undef CreateDirectory
#endif
#if defined(DeleteFile)
#undef DeleteFile
#endif
#endif
#include "Util.h"
#include "LogOutput.h"
#include "FileSystem/ArchiveScanner.h"
#include "FileSystem/VFSHandler.h"
#include "Exceptions.h"
#include "FileSystem.h"
std::string StripTrailingSlashes(std::string path)
{
while (!path.empty() && (path.at(path.length()-1) == '\\' || path.at(path.length()-1) == '/'))
path = path.substr(0, path.length()-1);
return path;
}
/**
* @brief The global data directory handler instance
*/
FileSystemHandler* FileSystemHandler::instance = NULL;
/**
* @brief get the data directory handler instance
*/
FileSystemHandler& FileSystemHandler::GetInstance()
{
if (!instance)
Initialize(false);
return *instance;
}
/**
* @brief initialize the data directory handler
*/
void FileSystemHandler::Initialize(bool verbose)
{
if (!instance) {
instance = new FileSystemHandler();
try {
instance->locater.LocateDataDirs();
archiveScanner = new CArchiveScanner();
vfsHandler = new CVFSHandler();
}
catch (...) {
FileSystemHandler* tmp = instance;
instance = NULL;
delete tmp;
throw;
}
}
}
void FileSystemHandler::Cleanup()
{
FileSystemHandler* tmp = instance;
instance = NULL;
delete tmp;
}
FileSystemHandler::~FileSystemHandler()
{
SafeDelete(archiveScanner);
SafeDelete(vfsHandler);
// configHandler->Deallocate();
}
#ifndef _WIN32
const int FileSystemHandler::native_path_separator = '/';
#else
const int FileSystemHandler::native_path_separator = '\\';
#endif
FileSystemHandler::FileSystemHandler()
{
}
/**
* @brief returns the highest priority writable directory, aka the writedir
*/
std::string FileSystemHandler::GetWriteDir() const
{
const DataDir* writedir = locater.GetWriteDir();
assert(writedir && writedir->writable); // duh
return writedir->path;
}
/**
* Removes "./" or ".\" from the start of a path string.
*/
static std::string RemoveLocalPathPrefix(const std::string& path)
{
std::string p(path);
if (p.length() >= 2 && p[0] == '.' && (p[1] == '/' || p[1] == '\\')) {
p.erase(0, 2);
}
return p;
}
bool FileSystemHandler::IsFSRoot(const std::string& p)
{
#ifdef WIN32
if (p.length() >= 2 && p[1] == ':' && ((p[0] >= 'a' && p[0] <= 'z') || (p[0] >= 'A' && p[0] <= 'Z')) && (p.length() == 2 || (p.length() == 3 && (p[2] == '\\' || p[2] == '/')))) {
#else
if (p.length() == 1 && p[0] == '/') {
#endif
return true;
}
return false;
}
std::vector<std::string> FileSystemHandler::FindFiles(const std::string& dir, const std::string& pattern, int flags) const
{
std::vector<std::string> matches;
// if it's an absolute path, don't look for it in the data directories
if (FileSystemHandler::IsAbsolutePath(dir)) {
// pass the directory as second directory argument, so the path gets included in the matches.
FindFilesSingleDir(matches, "", dir, pattern, flags);
return matches;
}
std::string dir2 = RemoveLocalPathPrefix(dir);
const std::vector<DataDir>& datadirs = locater.GetDataDirs();
for (std::vector<DataDir>::const_reverse_iterator d = datadirs.rbegin(); d != datadirs.rend(); ++d) {
FindFilesSingleDir(matches, d->path, dir2, pattern, flags);
}
return matches;
}
bool FileSystemHandler::IsReadableFile(const std::string& file)
{
#ifdef WIN32
return (_access(StripTrailingSlashes(file).c_str(), 4) == 0);
#else
return (access(file.c_str(), R_OK | F_OK) == 0);
#endif
}
std::string FileSystemHandler::GetFileModificationDate(const std::string& file)
{
std::string time = "";
#if defined(WIN32)
HANDLE hFile = CreateFile(file.c_str(), // file to open
GENERIC_READ, // open for reading
FILE_SHARE_READ, // share for reading
NULL, // default security
OPEN_EXISTING, // existing file only
FILE_ATTRIBUTE_NORMAL, // normal file
NULL); // no attr. template
if (hFile == INVALID_HANDLE_VALUE) {
logOutput.Print("WARNING: Failed opening file for retreiving last modification time: %s", file.c_str());
} else {
FILETIME /*ftCreate, ftAccess,*/ ftWrite;
// Retrieve the file times for the file.
if (GetFileTime(hFile, NULL, NULL, &ftWrite) != 0) {
logOutput.Print("WARNING: Failed fetching last modification time from file: %s", file.c_str());
} else {
// Convert the last-write time to local time.
const size_t cTime_size = 20;
char cTime[cTime_size];
SYSTEMTIME stUTC, stLocal;
if ((FileTimeToSystemTime(&ftWrite, &stUTC) != 0) &&
SystemTimeToTzSpecificLocalTime(NULL, &stUTC, &stLocal))
{
// Build a string showing the date and time.
SNPRINTF(cTime, cTime_size,
"%d%02d%02d%02d%02d%02d",
stLocal.wYear, stLocal.wMonth, stLocal.wDay,
stLocal.wHour, stLocal.wMinute, stLocal.wSecond);
time = cTime;
} else {
logOutput.Print("WARNING: Failed converting last modification time to a string");
}
}
CloseHandle(hFile);
}
#else // defined(WIN32)
struct tm* clock;
struct stat attrib;
const size_t cTime_size = 20;
char cTime[cTime_size];
const int fetchOk = stat(file.c_str(), &attrib); // get the attributes of file
if (fetchOk != 0) {
logOutput.Print("WARNING: Failed opening file for retreiving last modification time: %s", file.c_str());
} else {
// Get the last modified time and put it into the time structure
clock = gmtime(&(attrib.st_mtime));
if (clock == NULL) {
logOutput.Print("WARNING: Failed fetching last modification time from file: %s", file.c_str());
} else {
SNPRINTF(cTime, cTime_size, "%d%02d%02d%02d%02d%02d", 1900+clock->tm_year, clock->tm_mon, clock->tm_mday, clock->tm_hour, clock->tm_min, clock->tm_sec);
time = cTime;
}
}
#endif // defined(WIN32)
return time;
}
std::string FileSystemHandler::LocateFile(const std::string& file) const
{
// if it's an absolute path, don't look for it in the data directories
if (FileSystemHandler::IsAbsolutePath(file)) {
return file;
}
const std::vector<DataDir>& datadirs = locater.GetDataDirs();
for (std::vector<DataDir>::const_iterator d = datadirs.begin(); d != datadirs.end(); ++d) {
std::string fn(d->path + file);
// does the file exist, and is it readable?
if (IsReadableFile(fn)) {
return fn;
}
}
return file;
}
std::vector<std::string> FileSystemHandler::GetDataDirectories() const
{
std::vector<std::string> f;
const std::vector<DataDir>& datadirs = locater.GetDataDirs();
for (std::vector<DataDir>::const_iterator d = datadirs.begin(); d != datadirs.end(); ++d) {
f.push_back(d->path);
}
return f;
}
bool FileSystemHandler::IsAbsolutePath(const std::string& path)
{
#ifdef WIN32
return ((path.length() > 1) && (path[1] == ':'));
#else
return ((path.length() > 0) && (path[0] == '/'));
#endif
}
/**
* @brief creates a rwxr-xr-x dir in the writedir
*
* Returns true if the postcondition of this function is that dir exists in
* the write directory.
*
* Note that this function does not check access to the dir, ie. if you've
* created it manually with 0000 permissions then this function may return
* true, subsequent operation on files inside the directory may still fail.
*
* As a rule of thumb, set identical permissions on identical items in the
* data directory, ie. all subdirectories the same perms, all files the same
* perms.
*/
bool FileSystemHandler::mkdir(const std::string& dir)
{
// First check if directory exists. We'll return success if it does.
if (DirExists(dir)) {
return true;
}
// If it doesn't exist we try to mkdir it and return success if that succeeds.
#ifndef _WIN32
if (::mkdir(dir.c_str(), S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH) == 0)
#else
if (::_mkdir(StripTrailingSlashes(dir).c_str()) == 0)
#endif
{
return true;
}
else
{
logOutput.Print("Could not create directory %s: %s", dir.c_str(), strerror(errno));
// Otherwise we return false.
return false;
}
}
bool FileSystemHandler::DeleteFile(const std::string& file)
{
if (remove(file.c_str()) == 0)
{
return true;
}
else
{
logOutput.Print("Could not delete file %s: %s", file.c_str(), strerror(errno));
// Otherwise we return false.
return false;
}
}
bool FileSystemHandler::FileExists(const std::string& file)
{
#ifdef _WIN32
struct _stat info;
const int ret = _stat(StripTrailingSlashes(file).c_str(), &info);
if ((ret == 0 && (info.st_mode & _S_IFREG)))
#else
struct stat info;
const int ret = stat(file.c_str(), &info);
if ((ret == 0 && !S_ISDIR(info.st_mode)))
#endif
{
return true;
}
else
return false;
}
bool FileSystemHandler::DirExists(const std::string& dir)
{
#ifdef _WIN32
struct _stat info;
std::string myDir = dir;
// for the root dir on a drive (for example C:\)
// we need the trailing slash
if ((myDir.length() == 3) && (myDir[1] == ':') && ((myDir[2] != '\\') || (myDir[2] != '/'))) {
// do nothing
} else if ((myDir.length() == 2) && (myDir[1] == ':')) {
myDir += "\\";
} else {
// for any other dir (for example C:\WINDOWS\),
// we need to get rid of it.
myDir = StripTrailingSlashes(myDir);
}
const int ret = _stat(myDir.c_str(), &info);
if ((ret == 0) && (info.st_mode & _S_IFDIR))
#else
struct stat info;
const int ret = stat(dir.c_str(), &info);
if ((ret == 0) && S_ISDIR(info.st_mode))
#endif
return true;
else
return false;
}
bool FileSystemHandler::DirIsWritable(const std::string& dir)
{
#ifdef _WIN32
// this exists because _access doesn't do the right thing
// see http://msdn.microsoft.com/en-us/library/1w06ktdy(VS.71).aspx
// for now, try to create a temporary file in a directory and open it
// to rule out the possibility of it being created in the virtual store
// TODO perhaps use SECURITY_DESCRIPTOR winapi calls here
std::string testfile = dir + "\\__$testfile42$.test";
std::ofstream os(testfile.c_str());
if (os.fail())
return false;
const char *testdata = "THIS IS A TEST";
os << testdata;
os.close();
// this part should only be needed when there's no manifest embedded
std::ifstream is(testfile.c_str());
if (is.fail())
return false; // the file most likely exists in the virtual store
std::string input;
getline(is, input);
if (input != testdata) {
unlink(testfile.c_str());
return false;
}
is.close();
unlink(testfile.c_str());
return true;
#else
return (access(dir.c_str(), W_OK) == 0);
#endif
}
std::string FileSystemHandler::GetCwd()
{
std::string cwd = "";
#ifndef _WIN32
#define GETCWD getcwd
#else
#define GETCWD _getcwd
#endif
const size_t path_maxSize = 1024;
char path[path_maxSize];
if (GETCWD(path, path_maxSize) != NULL) {
cwd = path;
}
return cwd;
}
void FileSystemHandler::Chdir(const std::string& dir)
{
#ifndef _WIN32
const int err = chdir(dir.c_str());
#else
const int err = _chdir(StripTrailingSlashes(dir).c_str());
#endif
if (err)
throw content_error("Could not chdir into SPRING_DATADIR");
}
static void FindFiles(std::vector<std::string>& matches, const std::string& datadir, const std::string& dir, const boost::regex ®expattern, int flags)
{
#ifdef _WIN32
WIN32_FIND_DATA wfd;
HANDLE hFind = FindFirstFile((datadir + dir + "\\*").c_str(), &wfd);
if (hFind != INVALID_HANDLE_VALUE) {
do {
if(strcmp(wfd.cFileName,".") && strcmp(wfd.cFileName ,"..")) {
if(!(wfd.dwFileAttributes&FILE_ATTRIBUTE_DIRECTORY)) {
if ((flags & FileSystem::ONLY_DIRS) == 0) {
if (boost::regex_match(wfd.cFileName, regexpattern)) {
matches.push_back(dir + wfd.cFileName);
}
}
}
else {
if (flags & FileSystem::INCLUDE_DIRS) {
if (boost::regex_match(wfd.cFileName, regexpattern)) {
matches.push_back(dir + wfd.cFileName + "\\");
}
}
if (flags & FileSystem::RECURSE) {
FindFiles(matches, datadir, dir + wfd.cFileName + "\\", regexpattern, flags);
}
}
}
} while (FindNextFile(hFind, &wfd));
FindClose(hFind);
}
#else
DIR* dp;
struct dirent* ep;
if (!(dp = opendir((datadir + dir).c_str())))
return;
while ((ep = readdir(dp))) {
// exclude hidden files
if (ep->d_name[0] != '.') {
// is it a file? (we just treat sockets / pipes / fifos / character&block devices as files...)
// (need to stat because d_type is DT_UNKNOWN on linux :-/)
struct stat info;
if (stat((datadir + dir + ep->d_name).c_str(), &info) == 0) {
if (!S_ISDIR(info.st_mode)) {
if ((flags & FileSystem::ONLY_DIRS) == 0) {
if (boost::regex_match(ep->d_name, regexpattern)) {
matches.push_back(dir + ep->d_name);
}
}
}
else {
// or a directory?
if (flags & FileSystem::INCLUDE_DIRS) {
if (boost::regex_match(ep->d_name, regexpattern)) {
matches.push_back(dir + ep->d_name + "/");
}
}
if (flags & FileSystem::RECURSE) {
FindFiles(matches, datadir, dir + ep->d_name + "/", regexpattern, flags);
}
}
}
}
}
closedir(dp);
#endif
}
void FileSystemHandler::FindFilesSingleDir(std::vector<std::string>& matches, const std::string& datadir, const std::string& dir, const std::string &pattern, int flags) const
{
assert(datadir.empty() || datadir[datadir.length() - 1] == native_path_separator);
assert(!dir.empty() && dir[dir.length() - 1] == native_path_separator);
boost::regex regexpattern(filesystem.glob_to_regex(pattern));
::FindFiles(matches, datadir, dir, regexpattern, flags);
}
|