// static
void VFSNode::copyDirectory(const VFSNode& source, const VFSNode& dest, bool recursive) {
if (recursive) {
VString sourcePathWithTrailingSeparator = source.getPath() + (source.getPath().endsWith(PATH_SEPARATOR_CHAR) ? "" : PATH_SEPARATOR_CHARS);
if (dest.getPath().startsWith(sourcePathWithTrailingSeparator)) {
throw VException(VSTRING_FORMAT("Attempt to recursively copy '%s' into '%s'.", source.getPath().chars(), dest.getPath().chars()));
}
}
if (!dest.exists()) {
dest.mkdirs();
}
VFSNodeCopyDirectoryCallback copyDirectoryCallback(dest, recursive);
source.iterate(copyDirectoryCallback);
}
void VFSNode::mkdirs() const {
// If this directory already exists, we are done.
if (this->exists())
return;
// Create the parent directory (and its parents etc.) if necessary.
VFSNode parentNode;
this->getParentNode(parentNode);
if (! parentNode.getPath().isEmpty()) // root or parent of supplied path must be assumed to exist
parentNode.mkdirs();
// Create this directory specifically.
this->mkdir();
}
void VFSNodeUnit::_writeKnownDirectoryTestFile(VFSNode::KnownDirectoryIdentifier id, const VString& fileName) {
VFSNode folder = VFSNode::getKnownDirectoryNode(id, "BombayDigital", "unittest-temp");
VFSNode fileNode;
folder.getChildNode(fileName, fileNode);
VBufferedFileStream fs(fileNode);
fs.openWrite();
VTextIOStream out(fs);
VInstant now;
out.writeLine(now.getLocalString());
out.flush();
this->logStatus(VSTRING_FORMAT("Wrote to file '%s'.", fileNode.getPath().chars()));
}
void VFSNode::renameToNode(const VFSNode& newNode) const {
VString newPath;
newNode.getPath(newPath);
this->_platform_renameNode(newPath);
}
// static
void VFSNode::safelyOverwriteFile(const VFSNode& target, Vs64 dataLength, VBinaryIOStream& dataStream, bool keepOld) {
bool success = true;
VString errorMessage;
VString targetFileName = target.getName();
VInstant now;
VString temporaryFileName = now.getLocalString(VFSNODE_SAFE_FILE_NAME_INSTANT_FORMATTER) + "_tmp_" + targetFileName;
VString keptFileName = now.getLocalString(VFSNODE_SAFE_FILE_NAME_INSTANT_FORMATTER) + "_ver_" + targetFileName;
VFSNode directoryNode;
target.getParentNode(directoryNode);
VFSNode originalTargetNode(target);
VFSNode temporaryFileNode(directoryNode, temporaryFileName);
VFSNode keptFileNode(directoryNode, keptFileName);
// Create and write to the temp file within a scope block to ensure file is closed when scope is exited.
/* stream scope */ {
VBufferedFileStream tempFileStream(temporaryFileNode);
VBinaryIOStream tempOutputStream(tempFileStream);
try {
tempFileStream.openWrite();
} catch (const VException& ex) {
success = false;
errorMessage = VSTRING_FORMAT("Unable to open temporary file '%s': %s", target.getPath().chars(), ex.what());
}
if (success) {
try {
VStream::streamCopy(dataStream, tempOutputStream, dataLength);
tempOutputStream.flush();
} catch (const VException& ex) {
success = false;
errorMessage = VSTRING_FORMAT("Unable to write to temporary file '%s': %s", target.getPath().chars(), ex.what());
}
}
}
/*
If we succeeded, delete or rename the original file, and rename the temporary file to the original location.
If we failed, delete the temporary file.
Do this itself in separate phases, so that if the delete/rename fails, we still delete the temporary file.
*/
// 1. Remove target. (It might not exist yet.)
if (success && target.exists()) {
if (keepOld) {
try {
target.renameToNode(keptFileNode);
} catch (const VException& ex) {
success = false;
errorMessage = VSTRING_FORMAT("Failed renaming '%s' to '%s': %s", target.getPath().chars(), keptFileNode.getPath().chars(), ex.what());
}
} else {
if (! target.rm()) {
success = false;
errorMessage = VSTRING_FORMAT("Unable to remove target file '%s'.", target.getPath().chars());
}
}
}
// 2. Rename temporary to (original) target.
if (success) {
try {
temporaryFileNode.renameToNode(originalTargetNode);
} catch (const VException& ex) {
success = false;
errorMessage = VSTRING_FORMAT("Failed renaming '%s' to '%s': %s", temporaryFileNode.getPath().chars(), originalTargetNode.getPath().chars(), ex.what());
}
}
// 3. Remove temporary if unsuccessful.
if (! success) {
if (! temporaryFileNode.rm()) {
errorMessage += VSTRING_FORMAT(" Removal of temporary file '%s' failed.", temporaryFileNode.getPath().chars());
}
}
// If we failed, throw an exception with the error message we built wherever we encountered errors.
if (! success) {
throw VException(errorMessage);
}
}
void VFSNodeUnit::run() {
// Note that we also do testing of streams and file i/o here.
this->logStatus(VSTRING_FORMAT("getExecutable: '%s'", VFSNode::getExecutable().getPath().chars()));
this->logStatus(VSTRING_FORMAT("getExecutableDirectory: '%s'", VFSNode::getExecutableDirectory().getPath().chars()));
this->logStatus(VSTRING_FORMAT("USER_HOME_DIRECTORY: '%s'", VFSNode::getKnownDirectoryNode(VFSNode::USER_HOME_DIRECTORY, "com", "app").getPath().chars()));
this->logStatus(VSTRING_FORMAT("LOG_FILES_DIRECTORY: '%s'", VFSNode::getKnownDirectoryNode(VFSNode::LOG_FILES_DIRECTORY, "com", "app").getPath().chars()));
this->logStatus(VSTRING_FORMAT("USER_PREFERENCES_DIRECTORY: '%s'", VFSNode::getKnownDirectoryNode(VFSNode::USER_PREFERENCES_DIRECTORY, "com", "app").getPath().chars()));
this->logStatus(VSTRING_FORMAT("CACHED_DATA_DIRECTORY: '%s'", VFSNode::getKnownDirectoryNode(VFSNode::CACHED_DATA_DIRECTORY, "com", "app").getPath().chars()));
this->logStatus(VSTRING_FORMAT("APPLICATION_DATA_DIRECTORY: '%s'", VFSNode::getKnownDirectoryNode(VFSNode::APPLICATION_DATA_DIRECTORY, "com", "app").getPath().chars()));
this->logStatus(VSTRING_FORMAT("CURRENT_WORKING_DIRECTORY: '%s'", VFSNode::getKnownDirectoryNode(VFSNode::CURRENT_WORKING_DIRECTORY, "com", "app").getPath().chars()));
this->logStatus(VSTRING_FORMAT("EXECUTABLE_DIRECTORY: '%s'", VFSNode::getKnownDirectoryNode(VFSNode::EXECUTABLE_DIRECTORY, "com", "app").getPath().chars()));
VFSNode tempDir = VFSNode::getKnownDirectoryNode(VFSNode::CACHED_DATA_DIRECTORY, "vault", "unittest");
VString tempDirPath = tempDir.getPath();
VFSNode testDirRoot(tempDir, "vfsnodetest_temp");
(void) testDirRoot.rm();
VFSNode testDirDeep(tempDir, "vfsnodetest_temp/one/two/three");
VUNIT_ASSERT_FALSE_LABELED(testDirDeep.exists(), "initial state 1");
testDirDeep.mkdirs();
VUNIT_ASSERT_TRUE_LABELED(testDirDeep.exists(), "deep mkdirs");
VFSNode testDirDeeper(testDirDeep, "four");
VUNIT_ASSERT_FALSE_LABELED(testDirDeeper.exists(), "initial state 2");
testDirDeeper.mkdirs();
VUNIT_ASSERT_TRUE_LABELED(testDirDeeper.exists(), "one-deep mkdirs");
// Now that we have created a deep directory structure, let's do some
// file i/o streams stuff here.
VFSNode testTextFileNode(testDirDeeper, "test_text_file.txt");
VBufferedFileStream btfs(testTextFileNode);
this->_testTextFileIO("starting Buffered Text IO tests", testTextFileNode, btfs);
(void) testTextFileNode.rm();
VUNIT_ASSERT_FALSE_LABELED(testTextFileNode.exists(), "buffered text file removed");
VDirectIOFileStream dtfs(testTextFileNode);
this->_testTextFileIO("starting Unbuffered Text IO tests", testTextFileNode, dtfs);
this->_testTextFileReadAll(testTextFileNode);
(void) testTextFileNode.rm();
VUNIT_ASSERT_FALSE_LABELED(testTextFileNode.exists(), "unbuffered text file removed");
VFSNode testBinaryFileNode(testDirDeeper, "test_binary_file");
VBufferedFileStream bbfs(testBinaryFileNode);
this->_testBinaryFileIO("starting Buffered Binary IO tests", testBinaryFileNode, bbfs);
(void) testBinaryFileNode.rm();
VUNIT_ASSERT_FALSE_LABELED(testBinaryFileNode.exists(), "buffered binary file removed");
VDirectIOFileStream dbfs(testBinaryFileNode);
this->_testBinaryFileIO("starting Unbuffered Binary IO tests", testBinaryFileNode, dbfs);
(void) testBinaryFileNode.rm();
VUNIT_ASSERT_FALSE_LABELED(testBinaryFileNode.exists(), "unbuffered binary file removed");
this->_testDirectoryIteration(testDirDeeper);
// Next, test all flavors of renaming operations.
VFSNode copyTest1(tempDir, "vfsnodetest_temp/one/two/test1.txt");
VBufferedFileStream sourceFileStream(copyTest1);
sourceFileStream.openWrite();
VTextIOStream sourceOut(sourceFileStream);
sourceOut.writeLine("line 1");
sourceOut.writeLine("line 2");
sourceOut.flush();
sourceFileStream.close();
VUNIT_ASSERT_TRUE_LABELED(copyTest1.exists(), "test1 exists");
VFSNode copyTest2(tempDir, "vfsnodetest_temp/one/two/test2.txt");
copyTest1.renameToName("test2.txt");
VUNIT_ASSERT_FALSE_LABELED(copyTest1.exists(), "test1 was renamed");
VUNIT_ASSERT_TRUE_LABELED(copyTest2.exists(), "test2 exists");
VFSNode copyTest3;
copyTest2.renameToName("test3.txt", copyTest3);
VUNIT_ASSERT_FALSE_LABELED(copyTest2.exists(), "test2 was renamed");
VUNIT_ASSERT_TRUE_LABELED(copyTest3.getPath() == tempDirPath + "/vfsnodetest_temp/one/two/test3.txt" && copyTest3.exists(), "test3 exists");
VFSNode copyTest4(tempDir, "vfsnodetest_temp/one/two/three/test4.txt");
copyTest3.renameToNode(copyTest4);
VUNIT_ASSERT_FALSE_LABELED(copyTest3.exists(), "test3 was moved and renamed");
VUNIT_ASSERT_TRUE_LABELED(copyTest4.exists(), "test4 exists");
copyTest4.renameToPath(tempDirPath + "/vfsnodetest_temp/one/two/test5.txt");
VFSNode copyTest5(tempDir, "vfsnodetest_temp/one/two/test5.txt");
VUNIT_ASSERT_FALSE_LABELED(copyTest4.exists(), "test4 was moved and renamed");
VUNIT_ASSERT_TRUE_LABELED(copyTest5.exists(), "test5 exists");
copyTest5.renameToName("test5.txt"); // should throw
VFSNode dirCopyTarget(tempDir, "vfsnodetest_temp_copy");
VFSNode::copyDirectory(testDirRoot, dirCopyTarget, true);
// Verify that expected files now exist. Very dependent on file operations performed in tests above.
VUNIT_ASSERT_TRUE_LABELED(VFSNode(tempDirPath + "/vfsnodetest_temp_copy/one/two/test5.txt").isFile(), "copied directory, spot check test5.txt");
VUNIT_ASSERT_TRUE_LABELED(VFSNode(tempDirPath + "/vfsnodetest_temp_copy/one/two/three/four/iter_test_0.txt").isFile(), "copied directory, spot check iter_test_0.txt");
VUNIT_ASSERT_TRUE_LABELED(VFSNode(tempDirPath + "/vfsnodetest_temp_copy/one/two/three/four/iter_test_1.txt").isFile(), "copied directory, spot check iter_test_1.txt");
VUNIT_ASSERT_TRUE_LABELED(VFSNode(tempDirPath + "/vfsnodetest_temp_copy/one/two/three/four/iter_test_2.txt").isFile(), "copied directory, spot check iter_test_2.txt");
VUNIT_ASSERT_TRUE_LABELED(VFSNode(tempDirPath + "/vfsnodetest_temp_copy/one/two/three/four/iter_test_3.txt").isFile(), "copied directory, spot check iter_test_3.txt");
// Verify that a non-recursive copy of source into a subdirectory of itself is allowed.
VFSNode nrcSource(tempDirPath + "/vfsnodetest_temp/one/two");
VFSNode nrcDest(tempDirPath + "/vfsnodetest_temp/one/two/non-recursive-copy-of-two");
VFSNode::copyDirectory(nrcSource, nrcDest, false);
VUNIT_ASSERT_TRUE_LABELED(VFSNode(tempDirPath + "/vfsnodetest_temp/one/two/non-recursive-copy-of-two/test5.txt").isFile(), "non-recursive nested copy succeeds on child file");
// Verify that a recursive copy of source into a subdirectory of itself yields an
// exception (rather than an infinite loop copying until disk is full!).
try {
VFSNode rcSource(tempDirPath + "/vfsnodetest_temp/one/two");
VFSNode rcDest(tempDirPath + "/vfsnodetest_temp/one/two/recursive-copy-of-two");
VFSNode::copyDirectory(nrcSource, nrcDest, true);
VUNIT_ASSERT_FAILURE("Recursive nested copy was improperly allowed");
} catch (const VException& ex) {
VUNIT_ASSERT_SUCCESS("Recursive nested copy threw an exception as expected");
}
// Clean up our litter.
(void) copyTest5.rm();
(void) dirCopyTarget.rm();
(void) nrcDest.rm();
// Done with exercising file i/o and streams and directory stuff. Clean up our litter.
VString deepPath;
testDirDeeper.getParentPath(deepPath);
VUNIT_ASSERT_EQUAL_LABELED(deepPath, tempDirPath + "/vfsnodetest_temp/one/two/three", "get parent path");
VString nodeName;
testDirDeeper.getName(nodeName);
VUNIT_ASSERT_EQUAL_LABELED(nodeName, "four", "get deep node name");
VFSNode shallowNode("shallow");
shallowNode.getName(nodeName);
VUNIT_ASSERT_EQUAL_LABELED(nodeName, "shallow", "get shallow node name");
(void) testDirRoot.rm();
VUNIT_ASSERT_FALSE_LABELED(testDirRoot.exists(), "rm tree");
// Test some of the path string manipulation.
VString testPath3("one/two/three");
VFSNode testPath3Node(testPath3);
VString testPath2;
testPath3Node.getParentPath(testPath2);
VFSNode testPath2Node(testPath2);
VUNIT_ASSERT_EQUAL_LABELED(testPath2, "one/two", "parent of level 3 path");
VString testPath1;
testPath2Node.getParentPath(testPath1);
VFSNode testPath1Node(testPath1);
VUNIT_ASSERT_EQUAL_LABELED(testPath1, "one", "parent of level 2 path");
VString testPath0;
testPath1Node.getParentPath(testPath0);
VFSNode testPath0Node(testPath0);
VUNIT_ASSERT_EQUAL_LABELED(testPath0, "", "parent of level 1 path");
// Test oddities with DOS driver letters and mapped drives. Trailing slash on drive letter may or may be present.
#ifdef VPLATFORM_WIN
// These tests assume that C: and C:Windows exist; some installations may use a different drive letter, in which case skip the test.
const VString DRIVE_LETTER("C");
const VString CHILD_NODE_NAME("Windows");
if (VFSNode(VSTRING_FORMAT("%s:/%s", DRIVE_LETTER.chars(), CHILD_NODE_NAME.chars())).exists()) {
this->_testWindowsDrivePaths(DRIVE_LETTER, CHILD_NODE_NAME, false, true);
this->_testWindowsDrivePaths(DRIVE_LETTER, CHILD_NODE_NAME, true, true);
}
#endif
// Test assignment operator.
VFSNode someNode("a/b/c/d");
VFSNode copiedNode;
copiedNode = someNode;
VUNIT_ASSERT_EQUAL_LABELED(copiedNode.getPath(), "a/b/c/d", "assignment operator");
/*
Uncomment if you want to exercise this code. It's commented out for now because by its nature it
will litter several directories with its output. (It tests the APIs that locate the various
platform-dependent directories where log files, preference files, etc. should be written.
So for now I've chosen not to exercise this code in this unit test.
// Test known directory location lookup. Just write a file to each directory;
// user will have to visually check that it was put in the right place.
this->_writeKnownDirectoryTestFile(VFSNode::USER_HOME_DIRECTORY, "unittest-user");
this->_writeKnownDirectoryTestFile(VFSNode::LOG_FILES_DIRECTORY, "unittest-logs");
this->_writeKnownDirectoryTestFile(VFSNode::USER_PREFERENCES_DIRECTORY, "unittest-prefs");
this->_writeKnownDirectoryTestFile(VFSNode::CACHED_DATA_DIRECTORY, "unittest-cache");
this->_writeKnownDirectoryTestFile(VFSNode::APPLICATION_DATA_DIRECTORY, "unittest-appdata");
this->_writeKnownDirectoryTestFile(VFSNode::CURRENT_WORKING_DIRECTORY, "unittest-cwd");
*/
}