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 | /* ============================================================
*
* This file is a part of digiKam project
* https://www.digikam.org
*
* Date : 2009-08-11
* Description : the main parser object for the AdvancedRename utility
*
* SPDX-FileCopyrightText: 2009-2012 by Andi Clemens <andi dot clemens at gmail dot com>
*
* SPDX-License-Identifier: GPL-2.0-or-later
*
* ============================================================ */
#include "parser.h"
// Qt includes
#include <QFileInfo>
#include <QRegularExpression>
// Local includes
#include "cameranameoption.h"
#include "databaseoption.h"
#include "dateoption.h"
#include "directorynameoption.h"
#include "filepropertiesoption.h"
#include "metadataoption.h"
#include "sequencenumberoption.h"
#include "casemodifier.h"
#include "defaultvaluemodifier.h"
#include "rangemodifier.h"
#include "removedoublesmodifier.h"
#include "replacemodifier.h"
#include "trimmedmodifier.h"
#include "uniquemodifier.h"
namespace Digikam
{
class Q_DECL_HIDDEN Parser::Private
{
public:
Private() = default;
RulesList options;
RulesList modifiers;
};
// --------------------------------------------------------
Parser::Parser()
: d(new Private)
{
registerOption(new FilePropertiesOption());
registerOption(new DirectoryNameOption());
registerOption(new CameraNameOption());
registerOption(new SequenceNumberOption());
registerOption(new DateOption());
registerOption(new DatabaseOption());
registerOption(new MetadataOption());
// --------------------------------------------------------
registerModifier(new CaseModifier());
registerModifier(new TrimmedModifier());
registerModifier(new UniqueModifier());
registerModifier(new RemoveDoublesModifier());
registerModifier(new DefaultValueModifier());
registerModifier(new ReplaceModifier());
registerModifier(new RangeModifier());
}
Parser::~Parser()
{
qDeleteAll(d->options);
d->options.clear();
qDeleteAll(d->modifiers);
d->modifiers.clear();
delete d;
}
void Parser::reset()
{
for (Rule* const option : std::as_const(d->options))
{
option->reset();
}
for (Rule* const modifier : std::as_const(d->modifiers))
{
modifier->reset();
}
}
bool Parser::parseStringIsValid(const QString& str)
{
QRegularExpression invalidString(QRegularExpression::anchoredPattern(QLatin1String("^\\s*$")));
return (!str.isEmpty() && !invalidString.match(str).hasMatch());
}
RulesList Parser::options() const
{
return d->options;
}
RulesList Parser::modifiers() const
{
return d->modifiers;
}
void Parser::registerOption(Rule* option)
{
if (!option || !option->isValid())
{
return;
}
d->options.append(option);
}
void Parser::unregisterOption(const Rule* option)
{
if (!option)
{
return;
}
for (RulesList::iterator it = d->options.begin() ;
it != d->options.end() ; )
{
if (*it == option)
{
delete *it;
it = d->options.erase(it);
}
else
{
++it;
}
}
}
void Parser::registerModifier(Rule* modifier)
{
if (!modifier || !modifier->isValid())
{
return;
}
d->modifiers.append(modifier);
}
void Parser::unregisterModifier(const Rule* modifier)
{
if (!modifier)
{
return;
}
for (RulesList::iterator it = d->modifiers.begin() ;
it != d->modifiers.end() ; )
{
if (*it == modifier)
{
delete *it;
it = d->modifiers.erase(it);
}
else
{
++it;
}
}
}
ParseResults Parser::results(ParseSettings& settings)
{
ParseResults results;
for (Rule* const option : std::as_const(d->options))
{
ParseResults r = option->parse(settings);
results.append(r);
}
for (Rule* const modifier : std::as_const(d->modifiers))
{
ParseResults r = modifier->parse(settings);
results.append(r);
}
return results;
}
ParseResults Parser::invalidModifiers(ParseSettings& settings)
{
parse(settings);
return settings.invalidModifiers;
}
QString Parser::parse(ParseSettings& settings)
{
QFileInfo fi(settings.fileUrl.toLocalFile());
if (!parseStringIsValid(settings.parseString))
{
return fi.fileName();
}
ParseResults results;<--- Shadow variable
for (Rule* const option : std::as_const(d->options))
{
ParseResults r = option->parse(settings);
results.append(r);
}
settings.invalidModifiers = applyModifiers(settings, results);
QString newName = results.replaceTokens(settings.parseString);
settings.results = results;
// remove invalid modifiers from the new name
for (Rule* const mod : std::as_const(d->modifiers))
{
newName.remove(mod->regExp());
}
if (newName.isEmpty())
{
return fi.fileName();
}
if (settings.useOriginalFileExtension)
{
newName.append(QLatin1Char('.')).append(fi.suffix());
}
return newName;
}
bool Parser::tokenAtPosition(ParseSettings& settings, int pos)
{
int start;
int length;
return tokenAtPosition(settings, pos, start, length);
}
bool Parser::tokenAtPosition(ParseSettings& settings, int pos, int& start, int& length)
{
bool found = false;
ParseResults r = results(settings);
ParseResults::ResultsKey key = r.keyAtApproximatePosition(pos);
start = key.first;
length = key.second;
if ((pos >= start) && (pos <= start + length))
{
found = true;
}
return found;
}
ParseResults Parser::applyModifiers(const ParseSettings& _settings, ParseResults& results)
{
if (results.isEmpty() || d->modifiers.isEmpty())
{
return ParseResults();
}
ParseSettings settings = _settings;
settings.results = results;
// appliedModifiers holds all the modified parse results
ParseResults appliedModifiers = results;
// modifierResults holds all the modifiers found in the parse string
ParseResults modifierResults;
// modifierMap maps the actual modifier objects to the entries in the modifierResults structure
QMap<ParseResults::ResultsKey, Rule*> modifierMap;
for (Rule* const modifier : std::as_const(d->modifiers))
{
QRegularExpression regExp = modifier->regExp();
int pos = 0;
QRegularExpressionMatch match;
while (pos > -1)
{
pos = _settings.parseString.indexOf(regExp, pos, &match);
if (pos > -1)
{
ParseResults::ResultsKey k(pos, match.capturedLength());
ParseResults::ResultsValue v(match.captured(0), QString());
modifierResults.addEntry(k, v);
modifierMap.insert(k, modifier);
pos += match.capturedLength();
}
}
}
// Check for valid modifiers (they must appear directly after an option) and apply the modification to the option
// parse result.
// We need to create a second ParseResults object with modified keys, otherwise the final parsing step will not
// remove the modifier tokens from the result.
const auto keys = results.keys();
for (const ParseResults::ResultsKey& key : keys)
{
int off = results.offset(key);
int diff = 0;
for (int pos = off ; pos < _settings.parseString.count() ; )
{
if (modifierResults.hasKeyAtPosition(pos))
{
ParseResults::ResultsKey mkey = modifierResults.keyAtPosition(pos);
Rule* const mod = modifierMap[mkey];
QString modToken = modifierResults.token(mkey);
QString token = results.token(key);
QString str2Modify = results.result(key);
QString modResult;
if (mod)
{
settings.parseString = modToken;
settings.currentResultsKey = key;
settings.str2Modify = str2Modify;
ParseResults modResults = mod->parse(settings);
if (!modResults.isEmpty() && (modResults.values().length() == 1))
{
modResult = modResults.result(modResults.keys().constFirst());
}
}
// update result
ParseResults::ResultsKey resultKey = key;
ParseResults::ResultsValue resultValue(token, modResult);
results.addEntry(resultKey, resultValue);
// update modifier map
ParseResults::ResultsKey modifierKey = key;
modifierKey.second += diff;
ParseResults::ResultsValue modifierValue(modToken, modResult);
appliedModifiers.deleteEntry(modifierKey);
modifierKey.second += modToken.count();
appliedModifiers.addEntry(modifierKey, modifierValue);
// set position to the next possible token
pos += mkey.second;
diff += mkey.second;
// remove assigned modifier from modifierResults
modifierResults.deleteEntry(mkey);
}
else
{
break;
}
}
}
results = appliedModifiers;
return modifierResults;
}
} // namespace Digikam
|