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
|
// **************************************************************************
// * This file is part of the FreeFileSync project. It is distributed under *
// * GNU General Public License: http://www.gnu.org/licenses/gpl.html *
// * Copyright (C) ZenJu (zhnmju123 AT gmx DOT de) - All Rights Reserved *
// **************************************************************************
#include "batch_status_handler.h"
#include "msg_popup.h"
#include <wx/ffile.h>
#include <wx/msgdlg.h>
#include "../lib/ffs_paths.h"
#include <zen/file_handling.h>
#include "../lib/resolve_path.h"
#include <wx+/string_conv.h>
#include <wx+/app_main.h>
#include <zen/file_traverser.h>
#include <zen/time.h>
#include "exec_finished_box.h"
#include <wx+/shell_execute.h>
#include "../lib/status_handler_impl.h"
using namespace zen;
namespace
{
class FindLogfiles : public zen::TraverseCallback
{
public:
FindLogfiles(const Zstring& prefix, std::vector<Zstring>& logfiles) : prefix_(prefix), logfiles_(logfiles) {}
virtual void onFile(const Zchar* shortName, const Zstring& fullName, const FileInfo& details)
{
const Zstring fileName(shortName);
if (startsWith(fileName, prefix_) && endsWith(fileName, Zstr(".log")))
logfiles_.push_back(fullName);
}
virtual std::shared_ptr<TraverseCallback>
onDir (const Zchar* shortName, const Zstring& fullName) { return nullptr; } //DON'T traverse into subdirs
virtual void onSymlink(const Zchar* shortName, const Zstring& fullName, const SymlinkInfo& details) {}
virtual HandleError onError (const std::wstring& errorText) { return TRAV_ERROR_IGNORE; } //errors are not really critical in this context
private:
const Zstring prefix_;
std::vector<Zstring>& logfiles_;
};
}
class LogFile //throw FileError
{
public:
LogFile(const Zstring& logfileDirectory, const wxString& jobName) :
jobName_(jobName), //throw FileError
logfileName(findUniqueLogname(logfileDirectory, jobName))
{
logFile.Open(toWx(logfileName), L"w");
if (!logFile.IsOpened())
throw FileError(_("Unable to create log file!") + L"\"" + logfileName + L"\"");
//write header
wxString headerLine = wxString(L"FreeFileSync - ") + _("Batch execution") + L" - " + formatTime<wxString>(FORMAT_DATE);
logFile.Write(headerLine + wxChar('\n'));
logFile.Write(wxString().Pad(headerLine.Len(), L'=') + L'\n');
logItemStart = formatTime<wxString>(L"[%X] ") + _("Start");
totalTime.Start(); //measure total time
}
void writeLog(const ErrorLog& log, const std::wstring& finalStatus)
{
const size_t sepLineLen = finalStatus.size();
//result + statistics
logFile.Write(wxString().Pad(sepLineLen, L'_') + L'\n');
logFile.Write(L"\n" + finalStatus + L"\n");
logFile.Write(wxString().Pad(sepLineLen, L'_') + L"\n\n");
logFile.Write(logItemStart + L"\n\n");
//write actual logfile
const auto& entries = log.getEntries();
for (auto iter = entries.begin(); iter != entries.end(); ++iter)
{
const std::string& msg = utf8CvrtTo<std::string>(formatMessage(*iter));
logFile.Write(msg.c_str(), msg.size()); //better do UTF8 conversion ourselves rather than to rely on wxWidgets
logFile.Write(L'\n');
}
//write footer
logFile.Write(L'\n');
logFile.Write(formatTime<wxString>(L"[%X] ") + _("Stop") + L" (" + _("Total time:") + L" " + wxTimeSpan::Milliseconds(totalTime.Time()).Format() + L")\n");
}
void limitLogfileCount(size_t maxCount) const //throw()
{
std::vector<Zstring> logFiles;
FindLogfiles traverseCallback(toZ(jobName_), logFiles);
traverseFolder(beforeLast(logfileName, FILE_NAME_SEPARATOR), //throw();
false, //don't follow symlinks
traverseCallback);
if (logFiles.size() <= maxCount)
return;
//delete oldest logfiles
std::nth_element(logFiles.begin(), logFiles.end() - maxCount, logFiles.end()); //take advantage of logfile naming convention to find oldest files
std::for_each(logFiles.begin(), logFiles.end() - maxCount,
[](const Zstring& filename) { try { zen::removeFile(filename); } catch (FileError&) {} });
}
//Zstring getLogfileName() const { return logfileName; }
private:
static Zstring findUniqueLogname(const Zstring& logfileDirectory, const wxString& jobName)
{
//create logfile directory
Zstring logfileDir = logfileDirectory.empty() ?
zen::getConfigDir() + Zstr("Logs") :
zen::getFormattedDirectoryName(logfileDirectory);
if (!zen::dirExists(logfileDir))
zen::createDirectory(logfileDir); //throw FileError; create recursively if necessary
//assemble logfile name
if (!endsWith(logfileDir, FILE_NAME_SEPARATOR))
logfileDir += FILE_NAME_SEPARATOR;
const Zstring logfileName = logfileDir + toZ(jobName) + Zstr(" ") + formatTime<Zstring>(Zstr("%Y-%m-%d %H%M%S"));
//ensure uniqueness
Zstring output = logfileName + Zstr(".log");
for (int i = 1; zen::somethingExists(output); ++i)
output = logfileName + Zstr('_') + zen::numberTo<Zstring>(i) + Zstr(".log");
return output;
}
const wxString jobName_;
const Zstring logfileName;
wxFFile logFile;
wxStopWatch totalTime;
wxString logItemStart;
};
//##############################################################################################################################
BatchStatusHandler::BatchStatusHandler(bool showProgress,
const wxString& jobName,
const wxString& logfileDirectory,
size_t logFileCountMax,
const xmlAccess::OnError handleError,
const SwitchToGui& switchBatchToGui, //functionality to change from batch mode to GUI mode
int& returnVal,
const std::wstring& execWhenFinished,
std::vector<std::wstring>& execFinishedHistory) :
switchBatchToGui_(switchBatchToGui),
showFinalResults(showProgress), //=> exit immediately or wait when finished
switchToGuiRequested(false),
handleError_(handleError),
currentProcess(StatusHandler::PROCESS_NONE),
returnValue(returnVal),
syncStatusFrame(*this, nullptr, SyncStatus::SCANNING, showProgress, jobName, execWhenFinished, execFinishedHistory)
{
if (logFileCountMax > 0)
{
if (!tryReportingError([&]
{
logFile = std::make_shared<LogFile>(toZ(logfileDirectory), jobName); //throw FileError
logFile->limitLogfileCount(logFileCountMax); //throw()
}, *this))
{
returnValue = -7;
throw BatchAbortProcess();
}
}
//::wxSetEnv(L"logfile", logFile->getLogfileName());
}
BatchStatusHandler::~BatchStatusHandler()
{
const int totalErrors = errorLog.getItemCount(TYPE_ERROR | TYPE_FATAL_ERROR); //evaluate before finalizing log
//finalize error log
std::wstring finalStatus;
if (abortIsRequested())
{
returnValue = -4;
finalStatus = _("Synchronization aborted!");
errorLog.logMsg(finalStatus, TYPE_FATAL_ERROR);
}
else if (totalErrors > 0)
{
returnValue = -5;
finalStatus = _("Synchronization completed with errors!");
errorLog.logMsg(finalStatus, TYPE_WARNING);
}
else
{
finalStatus = _("Synchronization completed successfully!");
errorLog.logMsg(finalStatus, TYPE_INFO);
}
//print the results list: logfile
if (logFile.get())
{
logFile->writeLog(errorLog, finalStatus);
logFile.reset(); //close file now: user may do something with it in "on completion"
}
//decide whether to stay on status screen or exit immediately...
if (switchToGuiRequested) //-> avoid recursive yield() calls, thous switch not before ending batch mode
{
try
{
switchBatchToGui_.execute(); //open FreeFileSync GUI
}
catch (...) {}
syncStatusFrame.closeWindowDirectly(); //syncStatusFrame is main window => program will quit directly
}
else
{
if (syncStatusFrame.getAsWindow()->IsShown())
showFinalResults = true;
//execute "on completion" command (even in case of ignored errors)
if (!abortIsRequested()) //if aborted (manually), we don't execute the command
{
const std::wstring finalCommand = syncStatusFrame.getExecWhenFinishedCommand(); //final value (after possible user modification)
if (isCloseProgressDlgCommand(finalCommand))
showFinalResults = false; //take precedence over current visibility status
else if (!finalCommand.empty())
shellExecute(finalCommand);
}
if (showFinalResults) //warning: wxWindow::Show() is called within processHasFinished()!
{
//notify about (logical) application main window => program won't quit, but stay on this dialog
zen::setMainWindow(syncStatusFrame.getAsWindow());
//notify to syncStatusFrame that current process has ended
if (abortIsRequested())
syncStatusFrame.processHasFinished(SyncStatus::ABORTED, errorLog); //enable okay and close events
else if (totalErrors > 0)
syncStatusFrame.processHasFinished(SyncStatus::FINISHED_WITH_ERROR, errorLog);
else
syncStatusFrame.processHasFinished(SyncStatus::FINISHED_WITH_SUCCESS, errorLog);
}
else
syncStatusFrame.closeWindowDirectly(); //syncStatusFrame is main window => program will quit directly
}
}
void BatchStatusHandler::initNewProcess(int objectsTotal, zen::Int64 dataTotal, StatusHandler::Process processID)
{
currentProcess = processID;
switch (currentProcess)
{
case StatusHandler::PROCESS_SCANNING:
syncStatusFrame.initNewProcess(SyncStatus::SCANNING, 0, 0); //initialize some gui elements (remaining time, speed)
break;
case StatusHandler::PROCESS_COMPARING_CONTENT:
syncStatusFrame.initNewProcess(SyncStatus::COMPARING_CONTENT, objectsTotal, dataTotal);
break;
case StatusHandler::PROCESS_SYNCHRONIZING:
syncStatusFrame.initNewProcess(SyncStatus::SYNCHRONIZING, objectsTotal, dataTotal);
break;
case StatusHandler::PROCESS_NONE:
assert(false);
break;
}
}
void BatchStatusHandler::updateProcessedData(int objectsDelta, Int64 dataDelta)
{
switch (currentProcess)
{
case StatusHandler::PROCESS_SCANNING:
syncStatusFrame.incScannedObjects_NoUpdate(objectsDelta); //throw ()
break;
case StatusHandler::PROCESS_COMPARING_CONTENT:
case StatusHandler::PROCESS_SYNCHRONIZING:
syncStatusFrame.incProcessedData_NoUpdate(objectsDelta, dataDelta);
break;
case StatusHandler::PROCESS_NONE:
assert(false);
break;
}
//note: this method should NOT throw in order to properly allow undoing setting of statistics!
}
void BatchStatusHandler::updateTotalData(int objectsDelta, Int64 dataDelta)
{
assert(currentProcess != PROCESS_SCANNING);
syncStatusFrame.incTotalData_NoUpdate(objectsDelta, dataDelta);
}
void BatchStatusHandler::reportStatus(const std::wstring& text)
{
syncStatusFrame.setStatusText_NoUpdate(text);
requestUiRefresh(); //throw AbortThisProcess
}
void BatchStatusHandler::reportInfo(const std::wstring& text)
{
errorLog.logMsg(text, TYPE_INFO);
syncStatusFrame.setStatusText_NoUpdate(text);
requestUiRefresh(); //throw AbortThisProcess
}
void BatchStatusHandler::reportWarning(const std::wstring& warningMessage, bool& warningActive)
{
errorLog.logMsg(warningMessage, TYPE_WARNING);
if (!warningActive)
return;
switch (handleError_)
{
case xmlAccess::ON_ERROR_POPUP:
{
PauseTimers dummy(syncStatusFrame);
forceUiRefresh();
bool dontWarnAgain = false;
switch (showWarningDlg(ReturnWarningDlg::BUTTON_IGNORE | ReturnWarningDlg::BUTTON_SWITCH | ReturnWarningDlg::BUTTON_ABORT,
warningMessage + wxT("\n\n") + _("Press \"Switch\" to open FreeFileSync GUI mode."),
dontWarnAgain))
{
case ReturnWarningDlg::BUTTON_ABORT:
abortThisProcess();
break;
case ReturnWarningDlg::BUTTON_SWITCH:
errorLog.logMsg(_("Switching to FreeFileSync GUI mode..."), TYPE_INFO);
switchToGuiRequested = true;
abortThisProcess();
break;
case ReturnWarningDlg::BUTTON_IGNORE: //no unhandled error situation!
warningActive = !dontWarnAgain;
break;
}
}
break; //keep it! last switch might not find match
case xmlAccess::ON_ERROR_EXIT: //abort
abortThisProcess();
break;
case xmlAccess::ON_ERROR_IGNORE: //no unhandled error situation!
break;
}
}
ProcessCallback::Response BatchStatusHandler::reportError(const std::wstring& errorMessage)
{
switch (handleError_)
{
case xmlAccess::ON_ERROR_POPUP:
{
PauseTimers dummy(syncStatusFrame);
forceUiRefresh();
bool ignoreNextErrors = false;
switch (showErrorDlg(ReturnErrorDlg::BUTTON_IGNORE | ReturnErrorDlg::BUTTON_RETRY | ReturnErrorDlg::BUTTON_ABORT,
errorMessage,
&ignoreNextErrors))
{
case ReturnErrorDlg::BUTTON_IGNORE:
if (ignoreNextErrors) //falsify only
handleError_ = xmlAccess::ON_ERROR_IGNORE;
errorLog.logMsg(errorMessage, TYPE_ERROR);
return ProcessCallback::IGNORE_ERROR;
case ReturnErrorDlg::BUTTON_RETRY:
return ProcessCallback::RETRY;
case ReturnErrorDlg::BUTTON_ABORT:
errorLog.logMsg(errorMessage, TYPE_ERROR);
abortThisProcess();
}
}
break; //used if last switch didn't find a match
case xmlAccess::ON_ERROR_EXIT: //abort
errorLog.logMsg(errorMessage, TYPE_ERROR);
abortThisProcess();
break;
case xmlAccess::ON_ERROR_IGNORE:
errorLog.logMsg(errorMessage, TYPE_ERROR);
return ProcessCallback::IGNORE_ERROR;
}
assert(false);
return ProcessCallback::IGNORE_ERROR; //dummy value
}
void BatchStatusHandler::reportFatalError(const std::wstring& errorMessage)
{
errorLog.logMsg(errorMessage, TYPE_FATAL_ERROR);
switch (handleError_)
{
case xmlAccess::ON_ERROR_POPUP:
{
PauseTimers dummy(syncStatusFrame);
forceUiRefresh();
bool ignoreNextErrors = false;
switch (showErrorDlg(ReturnErrorDlg::BUTTON_IGNORE | ReturnErrorDlg::BUTTON_ABORT,
errorMessage,
&ignoreNextErrors))
{
case ReturnErrorDlg::BUTTON_IGNORE:
if (ignoreNextErrors) //falsify only
handleError_ = xmlAccess::ON_ERROR_IGNORE;
break;
case ReturnErrorDlg::BUTTON_ABORT:
abortThisProcess();
break;
case ReturnErrorDlg::BUTTON_RETRY:
assert(false);
}
}
break;
case xmlAccess::ON_ERROR_EXIT: //abort
abortThisProcess();
break;
case xmlAccess::ON_ERROR_IGNORE:
break;
}
}
void BatchStatusHandler::forceUiRefresh()
{
syncStatusFrame.updateStatusDialogNow();
}
void BatchStatusHandler::abortThisProcess()
{
requestAbortion();
throw BatchAbortProcess(); //abort can be triggered by syncStatusFrame
}
|