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
|
// **************************************************************************
// * This file is part of the FreeFileSync project. It is distributed under *
// * GNU General Public License: http://www.gnu.org/licenses/gpl-3.0 *
// * Copyright (C) Zenju (zenju AT gmx DOT de) - All Rights Reserved *
// **************************************************************************
#include "file_traverser.h"
#include "file_error.h"
#include "int64.h"
#ifdef ZEN_WIN
#include "long_path_prefix.h"
#include "file_access.h"
#include "symlink_target.h"
#elif defined ZEN_MAC
#include "osx_string.h"
#endif
#if defined ZEN_LINUX || defined ZEN_MAC
#include <cstddef> //offsetof
#include <unistd.h> //::pathconf()
#include <sys/stat.h>
#include <dirent.h>
#endif
using namespace zen;
void zen::traverseFolder(const Zstring& dirPath,
const std::function<void (const FileInfo& fi)>& onFile,
const std::function<void (const DirInfo& di)>& onDir,
const std::function<void (const SymlinkInfo& si)>& onLink,
const std::function<void (const std::wstring& errorMsg)>& onError)
{
try
{
#ifdef ZEN_WIN
WIN32_FIND_DATA findData = {};
HANDLE hDir = ::FindFirstFile(applyLongPathPrefix(appendSeparator(dirPath) + L'*').c_str(), &findData);
if (hDir == INVALID_HANDLE_VALUE)
{
const DWORD lastError = ::GetLastError(); //copy before making other system calls!
if (lastError == ERROR_FILE_NOT_FOUND)
{
//1. directory may not exist *or* 2. it is completely empty: not all directories contain "., .." entries, e.g. a drive's root directory; NetDrive
// -> FindFirstFile() is a nice example of violation of API design principle of single responsibility
if (dirExists(dirPath)) //yes, a race-condition, still the best we can do
return;
}
throwFileError(replaceCpy(_("Cannot open directory %x."), L"%x", fmtPath(dirPath)), L"FindFirstFile", lastError);
}
ZEN_ON_SCOPE_EXIT(::FindClose(hDir));
bool firstIteration = true;
for (;;)
{
if (firstIteration) //keep ::FindNextFile at the start of the for-loop to support "continue"!
firstIteration = false;
else if (!::FindNextFile(hDir, &findData))
{
const DWORD lastError = ::GetLastError();
if (lastError == ERROR_NO_MORE_FILES) //not an error situation
return;
//else we have a problem... report it:
throwFileError(replaceCpy(_("Cannot enumerate directory %x."), L"%x", fmtPath(dirPath)), L"FindNextFile", lastError);
}
//skip "." and ".."
const Zchar* const shortName = findData.cFileName;
if (shortName[0] == 0) throw FileError(replaceCpy(_("Cannot enumerate directory %x."), L"%x", fmtPath(dirPath)), L"FindNextFile: Data corruption; item is missing a name.");
if (shortName[0] == L'.' &&
(shortName[1] == 0 || (shortName[1] == L'.' && shortName[2] == 0)))
continue;
const Zstring& itempath = appendSeparator(dirPath) + shortName;
if (zen::isSymlink(findData)) //check first!
{
if (onLink)
onLink({ shortName, itempath, filetimeToTimeT(findData.ftLastWriteTime) });
}
else if ((findData.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) != 0)
{
if (onDir)
onDir({ shortName, itempath });
}
else //a file
{
if (onFile)
onFile({ shortName, itempath, get64BitUInt(findData.nFileSizeLow, findData.nFileSizeHigh), filetimeToTimeT(findData.ftLastWriteTime) });
}
}
#elif defined ZEN_LINUX || defined ZEN_MAC
/* quote: "Since POSIX.1 does not specify the size of the d_name field, and other nonstandard fields may precede
that field within the dirent structure, portable applications that use readdir_r() should allocate
the buffer whose address is passed in entry as follows:
len = offsetof(struct dirent, d_name) + pathconf(dirPath, _PC_NAME_MAX) + 1
entryp = malloc(len); */
const size_t nameMax = std::max<long>(::pathconf(dirPath.c_str(), _PC_NAME_MAX), 10000); //::pathconf may return long(-1)
std::vector<char> buffer(offsetof(struct ::dirent, d_name) + nameMax + 1);
#ifdef ZEN_MAC
std::vector<char> bufferUtfDecomposed;
#endif
DIR* dirObj = ::opendir(dirPath.c_str()); //directory must NOT end with path separator, except "/"
if (!dirObj)
throwFileError(replaceCpy(_("Cannot open directory %x."), L"%x", fmtPath(dirPath)), L"opendir", getLastError());
ZEN_ON_SCOPE_EXIT(::closedir(dirObj)); //never close nullptr handles! -> crash
for (;;)
{
struct ::dirent* dirEntry = nullptr;
if (::readdir_r(dirObj, reinterpret_cast< ::dirent*>(&buffer[0]), &dirEntry) != 0)
throwFileError(replaceCpy(_("Cannot enumerate directory %x."), L"%x", fmtPath(dirPath)), L"readdir_r", getLastError());
//don't retry but restart dir traversal on error! http://blogs.msdn.com/b/oldnewthing/archive/2014/06/12/10533529.aspx
if (!dirEntry) //no more items
return;
//don't return "." and ".."
const char* shortName = dirEntry->d_name;
if (shortName[0] == 0) throw FileError(replaceCpy(_("Cannot enumerate directory %x."), L"%x", fmtPath(dirPath)), L"readdir_r: Data corruption; item is missing a name.");
if (shortName[0] == '.' &&
(shortName[1] == 0 || (shortName[1] == '.' && shortName[2] == 0)))
continue;
#ifdef ZEN_MAC
//some file system abstraction layers fail to properly return decomposed UTF8: http://developer.apple.com/library/mac/#qa/qa1173/_index.html
//so we need to do it ourselves; perf: ~600 ns per conversion
//note: it's not sufficient to apply this in z_impl::compareFilenamesNoCase: if UTF8 forms differ, FFS assumes a rename in case sensitivity and
// will try to propagate the rename => this won't work if target drive reports a particular UTF8 form only!
if (CFStringRef cfStr = osx::createCFString(shortName))
{
ZEN_ON_SCOPE_EXIT(::CFRelease(cfStr));
CFIndex lenMax = ::CFStringGetMaximumSizeOfFileSystemRepresentation(cfStr); //"could be much larger than the actual space required" => don't store in Zstring
if (lenMax > 0)
{
bufferUtfDecomposed.resize(lenMax);
if (::CFStringGetFileSystemRepresentation(cfStr, &bufferUtfDecomposed[0], lenMax)) //get decomposed UTF form (verified!) despite ambiguous documentation
shortName = &bufferUtfDecomposed[0];
}
}
//const char* sampleDecomposed = "\x6f\xcc\x81.txt";
//const char* samplePrecomposed = "\xc3\xb3.txt";
#endif
const Zstring& itempath = appendSeparator(dirPath) + shortName;
struct ::stat statData = {};
try
{
if (::lstat(itempath.c_str(), &statData) != 0) //lstat() does not resolve symlinks
throwFileError(replaceCpy(_("Cannot read file attributes of %x."), L"%x", fmtPath(itempath)), L"lstat", getLastError());
}
catch (const FileError& e)
{
if (onError)
onError(e.toString());
continue; //ignore error: skip file
}
if (S_ISLNK(statData.st_mode)) //on Linux there is no distinction between file and directory symlinks!
{
if (onLink)
onLink({ shortName, itempath, statData.st_mtime});
}
else if (S_ISDIR(statData.st_mode)) //a directory
{
if (onDir)
onDir({ shortName, itempath });
}
else //a file or named pipe, ect.
{
if (onFile)
onFile({ shortName, itempath, makeUnsigned(statData.st_size), statData.st_mtime });
}
/*
It may be a good idea to not check "S_ISREG(statData.st_mode)" explicitly and to not issue an error message on other types to support these scenarios:
- RTS setup watch (essentially wants to read directories only)
- removeDirectory (wants to delete everything; pipes can be deleted just like files via "unlink")
However an "open" on a pipe will block (https://sourceforge.net/p/freefilesync/bugs/221/), so the copy routines need to be smarter!!
*/
}
#endif
}
catch (const FileError& e)
{
if (onError)
onError(e.toString());
}
}
|
