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
|
// *****************************************************************************
// * This file is part of the FreeFileSync project. It is distributed under *
// * GNU General Public License: https://www.gnu.org/licenses/gpl-3.0 *
// * Copyright (C) Zenju (zenju AT freefilesync DOT org) - All Rights Reserved *
// *****************************************************************************
#include "path_filter.h"
#include <typeindex>
#include <zen/file_path.h>
using namespace zen;
using namespace fff;
std::strong_ordering fff::operator<=>(const FilterRef& lhs, const FilterRef& rhs)
{
//caveat: typeid returns static type for pointers, dynamic type for references!!!
if (const std::strong_ordering cmp = std::type_index(typeid(lhs.ref())) <=>
std::type_index(typeid(rhs.ref()));
cmp != std::strong_ordering::equal)
return cmp;
return lhs.ref().compareSameType(rhs.ref());
}
void NameFilter::parseFilterPhrase(const Zstring& filterPhrase, FilterSet& filter)
{
//normalize filter: 1. ignore Unicode normalization form 2. ignore case
Zstring filterPhraseNorm = getUpperCase(filterPhrase);
//3. fix path separator
if constexpr (FILE_NAME_SEPARATOR != Zstr('/' )) replace(filterPhraseNorm, Zstr('/'), FILE_NAME_SEPARATOR);
if constexpr (FILE_NAME_SEPARATOR != Zstr('\\')) replace(filterPhraseNorm, Zstr('\\'), FILE_NAME_SEPARATOR);
static_assert(FILE_NAME_SEPARATOR == '/');
const Zstring sepAsterisk = Zstr("/*");
const Zstring asteriskSep = Zstr("*/");
auto processTail = [&](const ZstringView phrase)
{
if (endsWith(phrase, Zstr(':'))) //file-only tag
filter.fileMasks.insert({phrase.begin(), phrase.end() - 1});
else if (endsWith(phrase, FILE_NAME_SEPARATOR) || //folder-only tag
endsWith(phrase, sepAsterisk)) // abc\*
filter.folderMasks.insert(Zstring(beforeLast(phrase, FILE_NAME_SEPARATOR, IfNotFoundReturn::none)));
else
{
filter.fileMasks .insert(Zstring(phrase));
filter.folderMasks.insert(Zstring(phrase));
}
};
split2(filterPhraseNorm, [](Zchar c) { return c == FILTER_ITEM_SEPARATOR || c == Zstr('\n'); }, //delimiters
[&](ZstringView itemPhrase)
{
itemPhrase = trimCpy(itemPhrase);
if (!itemPhrase.empty())
{
/* phrase | action
+---------+--------
| \blah | remove \
| \*blah | remove \
| \*\blah | remove \
| \*\* | remove \
+---------+--------
| *blah |
| *\blah | -> add blah
| *\*blah | -> add *blah
+---------+--------
| blah: | remove : (file only)
| blah\*: | remove : (file only)
+---------+--------
| blah\ | remove \ (folder only)
| blah*\ | remove \ (folder only)
| blah\*\ | remove \ (folder only)
+---------+--------
| blah* |
| blah\* | remove \* (folder only)
| blah*\* | remove \* (folder only)
+---------+-------- */
if (startsWith(itemPhrase, FILE_NAME_SEPARATOR)) // \abc
processTail(afterFirst(itemPhrase, FILE_NAME_SEPARATOR, IfNotFoundReturn::none));
else
{
processTail(itemPhrase);
if (startsWith(itemPhrase, asteriskSep)) // *\abc
processTail(afterFirst(itemPhrase, asteriskSep, IfNotFoundReturn::none));
}
}
});
}
void NameFilter::MaskMatcher::insert(const Zstring& mask)
{
assert(mask == getUpperCase(mask));
if (mask.empty())
return;
if (contains(mask, Zstr('?')) ||
contains(mask, Zstr('*')))
realMasks_.insert(mask);
else
{
relPaths_ .insert(mask);
relPathsCmp_.insert(mask); //little memory wasted thanks to COW string!
}
}
namespace
{
//"true" if path or any parent path matches the mask
bool matchesMask(const Zchar* path, const Zchar* const pathEnd, const Zchar* mask /*0-terminated*/)
{
for (;; ++mask, ++path)
{
Zchar m = *mask;
switch (m)
{
case 0:
return path == pathEnd || *path == FILE_NAME_SEPARATOR; //"full" or parent path match
case Zstr('?'): //should not match FILE_NAME_SEPARATOR
if (path == pathEnd || *path == FILE_NAME_SEPARATOR)
return false;
break;
case Zstr('*'):
do //advance mask to next non-* char
{
m = *++mask;
}
while (m == Zstr('*'));
if (m == 0) //mask ends with '*':
return true;
++mask;
if (m == Zstr('?')) //*? pattern
{
while (path != pathEnd)
if (*path++ != FILE_NAME_SEPARATOR)
if (matchesMask(path, pathEnd, mask))
return true;
}
else //*[letter or /] pattern
while (path != pathEnd)
if (*path++ == m)
if (matchesMask(path, pathEnd, mask))
return true;
return false;
default:
if (path == pathEnd || *path != m)
return false;
}
}
}
//"true" if path matches (only!) the beginning of mask
template <bool haveWildcards> bool matchesMaskBegin(const ZstringView relPath, const Zstring& mask);
template <> inline
bool matchesMaskBegin<true /*haveWildcards*/>(const ZstringView relPath, const Zstring& mask)
{
auto itP = relPath.begin();
for (auto itM = mask.begin(); itM != mask.end(); ++itM, ++itP)
{
const Zchar m = *itM;
switch (m)
{
case Zstr('?'):
if (itP == relPath.end() || *itP == FILE_NAME_SEPARATOR)
return false;
break;
case Zstr('*'):
return true;
default:
if (itP == relPath.end())
return m == FILE_NAME_SEPARATOR && mask.end() - itM > 1; //require strict sub match
if (*itP != m)
return false;
}
}
return false; //not a strict sub match
}
template <> inline //perf: going overboard? remaining fruits are hanging higher and higher...
bool matchesMaskBegin<false /*haveWildcards*/>(const ZstringView relPath, const Zstring& mask)
{
return mask.size() > relPath.size() + 1 && //room for FILE_NAME_SEPARATOR *and* at least one more char
mask[relPath.size()] == FILE_NAME_SEPARATOR &&
startsWith(mask, relPath);
}
}
bool NameFilter::MaskMatcher::matches(const ZstringView relPath) const
{
assert(!relPath.empty());
if (std::any_of(realMasks_.begin(), realMasks_.end(), [&](const Zstring& mask) { return matchesMask(relPath.data(), relPath.data() + relPath.size(), mask.c_str()); }))
/**/return true;
//perf: for relPaths_ we can go from linear to *constant* time!!! => annihilates https://freefilesync.org/forum/viewtopic.php?t=7768#p26519
ZstringView parentPath = relPath;
for (;;) //check all parent paths!
{
if (relPaths_.contains(parentPath)) //heterogenous lookup!
return true;
parentPath = beforeLast(parentPath, FILE_NAME_SEPARATOR, IfNotFoundReturn::none);
if (parentPath.empty())
return false;
}
}
bool NameFilter::MaskMatcher::matchesBegin(const ZstringView relPath) const
{
return std::any_of(realMasks_.begin(), realMasks_.end(), [&](const Zstring& mask) { return matchesMaskBegin<true /*haveWildcards*/>(relPath, mask); }) ||
/**/ std::any_of(relPaths_ .begin(), relPaths_ .end(), [&](const Zstring& mask) { return matchesMaskBegin<false /*haveWildcards*/>(relPath, mask); });
}
//#################################################################################################
NameFilter::NameFilter(const Zstring& includePhrase, const Zstring& excludePhrase)
{
parseFilterPhrase(includePhrase, includeFilter);
parseFilterPhrase(excludePhrase, excludeFilter);
}
void NameFilter::addExclusion(const Zstring& excludePhrase)
{
parseFilterPhrase(excludePhrase, excludeFilter);
}
bool NameFilter::passFileFilter(const Zstring& relFilePath) const
{
assert(!startsWith(relFilePath, FILE_NAME_SEPARATOR));
//normalize input: 1. ignore Unicode normalization form 2. ignore case
const Zstring& pathFmt = getUpperCase(relFilePath);
const ZstringView parentPath = beforeLast<ZstringView>(pathFmt, FILE_NAME_SEPARATOR, IfNotFoundReturn::none);
if (excludeFilter.fileMasks.matches(pathFmt) || //either match on file or any parent folder
(!parentPath.empty() && excludeFilter.folderMasks.matches(parentPath))) //match on any parent folder only
return false;
return includeFilter.fileMasks.matches(pathFmt) ||
(!parentPath.empty() && includeFilter.folderMasks.matches(parentPath));
}
bool NameFilter::passDirFilter(const Zstring& relDirPath, bool* childItemMightMatch) const
{
assert(!startsWith(relDirPath, FILE_NAME_SEPARATOR));
assert(!childItemMightMatch || *childItemMightMatch); //check correct usage
//normalize input: 1. ignore Unicode normalization form 2. ignore case
const Zstring& pathFmt = getUpperCase(relDirPath);
if (excludeFilter.folderMasks.matches(pathFmt))
{
if (childItemMightMatch)
*childItemMightMatch = false; //perf: no need to traverse deeper; subfolders/subfiles would be excluded by filter anyway!
/* Attention: If *childItemMightMatch == false, then any direct filter evaluation for a child item must also return "false"!
This is not a problem for folder traversal which stops at the first *childItemMightMatch == false anyway, but other code continues recursing further,
e.g. the database update code in db_file.cpp recurses unconditionally without *childItemMightMatch check! */
return false;
}
if (includeFilter.folderMasks.matches(pathFmt))
return true;
if (childItemMightMatch)
*childItemMightMatch = includeFilter.fileMasks .matchesBegin(pathFmt) || //might match a file or folder in subdirectory
includeFilter.folderMasks.matchesBegin(pathFmt); //
return false;
}
bool NameFilter::isNull(const Zstring& includePhrase, const Zstring& excludePhrase)
{
return trimCpy(includePhrase) == Zstr("*") &&
trimCpy(excludePhrase).empty();
//return NameFilter(includePhrase, excludePhrase).isNull(); -> very expensive for huge lists
}
bool NameFilter::isNull() const
{
return compareSameType(NameFilter(Zstr("*"), Zstr(""))) == std::strong_ordering::equal;
//avoid static non-POD null-NameFilter instance
}
std::strong_ordering NameFilter::compareSameType(const PathFilter& other) const
{
assert(typeid(*this) == typeid(other)); //always given in this context!
const NameFilter& lhs = *this;
const NameFilter& rhs = static_cast<const NameFilter&>(other);
return std::tie(lhs.includeFilter, lhs.excludeFilter) <=>
std::tie(rhs.includeFilter, rhs.excludeFilter);
}
|
