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
|
// *****************************************************************************
// * 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 "batch_status_handler.h"
#include <zen/shell_execute.h>
#include <zen/shutdown.h>
#include <wx+/popup_dlg.h>
#include <wx/app.h>
#include "../base/resolve_path.h"
#include "../base/generate_logfile.h"
#include "../fs/concrete.h"
using namespace zen;
using namespace fff;
BatchStatusHandler::BatchStatusHandler(bool showProgress,
bool autoCloseDialog,
const std::wstring& jobName,
const Zstring& soundFileSyncComplete,
const std::chrono::system_clock::time_point& startTime,
bool ignoreErrors,
BatchErrorHandling batchErrorHandling,
size_t automaticRetryCount,
std::chrono::seconds automaticRetryDelay,
const Zstring& postSyncCommand,
PostSyncCondition postSyncCondition,
PostSyncAction postSyncAction) :
batchErrorHandling_(batchErrorHandling),
automaticRetryCount_(automaticRetryCount),
automaticRetryDelay_(automaticRetryDelay),
progressDlg_(createProgressDialog(*this, [this] { this->onProgressDialogTerminate(); }, *this, nullptr /*parentWindow*/, showProgress, autoCloseDialog,
jobName, soundFileSyncComplete, ignoreErrors, automaticRetryCount, [&]
{
switch (postSyncAction)
{
case PostSyncAction::NONE:
return PostSyncAction2::NONE;
case PostSyncAction::SLEEP:
return PostSyncAction2::SLEEP;
case PostSyncAction::SHUTDOWN:
return PostSyncAction2::SHUTDOWN;
}
assert(false);
return PostSyncAction2::NONE;
}())),
jobName_(jobName),
startTime_(startTime),
postSyncCommand_(postSyncCommand),
postSyncCondition_(postSyncCondition)
{
//ATTENTION: "progressDlg_" is an unmanaged resource!!! However, at this point we already consider construction complete! =>
//ZEN_ON_SCOPE_FAIL( cleanup(); ); //destructor call would lead to member double clean-up!!!
//...
//if (logFile)
// ::wxSetEnv(L"logfile", utfTo<wxString>(logFile->getFilename()));
}
BatchStatusHandler::~BatchStatusHandler()
{
if (progressDlg_) //reportFinalStatus() was not called!
std::abort();
}
BatchStatusHandler::Result BatchStatusHandler::reportFinalStatus(const Zstring& altLogFolderPathPhrase, int logfilesMaxAgeDays, const std::set<AbstractPath>& logFilePathsToKeep) //noexcept!!
{
const auto totalTime = std::chrono::duration_cast<std::chrono::milliseconds>(std::chrono::system_clock::now() - startTime_);
if (progressDlg_) progressDlg_->timerSetStatus(false /*active*/); //keep correct summary window stats considering count down timer, system sleep
//determine post-sync status irrespective of further errors during tear-down
const SyncResult finalStatus = [&]
{
if (getAbortStatus())
{
errorLog_.logMsg(_("Stopped"), MSG_TYPE_ERROR); //= user cancel; *not* a MSG_TYPE_FATAL_ERROR!
return SyncResult::ABORTED;
}
else if (errorLog_.getItemCount(MSG_TYPE_ERROR | MSG_TYPE_FATAL_ERROR) > 0)
return SyncResult::FINISHED_WITH_ERROR;
else if (errorLog_.getItemCount(MSG_TYPE_WARNING) > 0)
return SyncResult::FINISHED_WITH_WARNINGS;
if (getStatsTotal(currentPhase()) == ProgressStats())
errorLog_.logMsg(_("Nothing to synchronize"), MSG_TYPE_INFO);
return SyncResult::FINISHED_WITH_SUCCESS;
}();
assert(finalStatus == SyncResult::ABORTED || currentPhase() == PHASE_SYNCHRONIZING);
const ProcessSummary summary
{
finalStatus, jobName_,
getStatsCurrent(currentPhase()),
getStatsTotal (currentPhase()),
totalTime
};
//post sync command
Zstring commandLine = [&]
{
if (getAbortStatus() && *getAbortStatus() == AbortTrigger::USER)
; //user cancelled => don't run post sync command!
else
switch (postSyncCondition_)
{
case PostSyncCondition::COMPLETION:
return postSyncCommand_;
case PostSyncCondition::ERRORS:
if (finalStatus == SyncResult::ABORTED ||
finalStatus == SyncResult::FINISHED_WITH_ERROR)
return postSyncCommand_;
break;
case PostSyncCondition::SUCCESS:
if (finalStatus == SyncResult::FINISHED_WITH_WARNINGS ||
finalStatus == SyncResult::FINISHED_WITH_SUCCESS)
return postSyncCommand_;
break;
}
return Zstring();
}();
trim(commandLine);
if (!commandLine.empty())
errorLog_.logMsg(replaceCpy(_("Executing command %x"), L"%x", fmtPath(commandLine)), MSG_TYPE_INFO);
//----------------- always save log under %appdata%\FreeFileSync\Logs ------------------------
//create not before destruction: 1. avoid issues with FFS trying to sync open log file 2. simplify transactional retry on failure 3. include status in log file name without rename
// 4. failure to write to particular stream must not be retried!
AbstractPath logFilePath = getNullPath();
try
{
//do NOT use tryReportingError()! saving log files should not be cancellable!
auto notifyStatusNoThrow = [&](const std::wstring& msg) { try { reportStatus(msg); /*throw X*/ } catch (...) {} };
logFilePath = saveLogFile(summary, errorLog_, startTime_, altLogFolderPathPhrase, logfilesMaxAgeDays, logFilePathsToKeep, notifyStatusNoThrow /*throw X*/); //throw FileError
}
catch (const FileError& e) { errorLog_.logMsg(e.toString(), MSG_TYPE_ERROR); }
//execute post sync command *after* writing log files, so that user can refer to the log via the command!
if (!commandLine.empty())
try
{
//----------------------------------------------------------------------
::wxSetEnv(L"logfile_path", AFS::getDisplayPath(logFilePath));
//----------------------------------------------------------------------
//use ExecutionType::ASYNC until there is reason not to: https://freefilesync.org/forum/viewtopic.php?t=31
shellExecute(expandMacros(commandLine), ExecutionType::ASYNC); //throw FileError
}
catch (const FileError& e) { errorLog_.logMsg(e.toString(), MSG_TYPE_ERROR); }
if (progressDlg_)
{
//post sync action
bool autoClose = false;
FinalRequest finalRequest = FinalRequest::none;
if (getAbortStatus() && *getAbortStatus() == AbortTrigger::USER)
; //user cancelled => don't run post sync command!
else
{
auto mayRunAfterCountDown = [&](const std::wstring& operationName)
{
auto notifyStatusThrowOnCancel = [&](const std::wstring& msg)
{
try { reportStatus(msg); /*throw X*/ }
catch (...)
{
if (getAbortStatus() && *getAbortStatus() == AbortTrigger::USER)
throw;
}
};
if (progressDlg_->getWindowIfVisible())
try
{
delayAndCountDown(operationName, std::chrono::seconds(5), notifyStatusThrowOnCancel); //throw X
}
catch (...) { return false; }
return true;
};
switch (progressDlg_->getOptionPostSyncAction())
{
case PostSyncAction2::NONE:
autoClose = progressDlg_->getOptionAutoCloseDialog();
break;
case PostSyncAction2::EXIT:
assert(false);
break;
case PostSyncAction2::SLEEP:
if (mayRunAfterCountDown(_("System: Sleep")))
try
{
suspendSystem(); //throw FileError
autoClose = progressDlg_->getOptionAutoCloseDialog();
}
catch (const FileError& e) { errorLog_.logMsg(e.toString(), MSG_TYPE_ERROR); }
break;
case PostSyncAction2::SHUTDOWN:
if (mayRunAfterCountDown(_("System: Shut down")))
{
autoClose = true;
finalRequest = FinalRequest::shutdown; //system shutdown must be handled by calling context!
}
break;
}
}
if (switchToGuiRequested_) //-> avoid recursive yield() calls, thous switch not before ending batch mode
{
autoClose = true;
finalRequest = FinalRequest::switchGui;
}
auto errorLogFinal = std::make_shared<const ErrorLog>(std::move(errorLog_));
//close progress dialog
if (autoClose) //warning: wxWindow::Show() is called within showSummary()!
progressDlg_->closeDirectly(true /*restoreParentFrame: n/a here*/); //progressDlg_ is main window => program will quit shortly after
else
//notify about (logical) application main window => program won't quit, but stay on this dialog
//setMainWindow(progressDlg_->getAsWindow()); -> not required anymore since we block waiting until dialog is closed below
progressDlg_->showSummary(finalStatus, errorLogFinal);
//wait until progress dialog notified shutdown via onProgressDialogTerminate()
//-> required since it has our "this" pointer captured in lambda "notifyWindowTerminate"!
//-> nicely manages dialog lifetime
for (;;)
{
wxTheApp->Yield(); //*first* refresh GUI (removing flicker) before sleeping!
if (!progressDlg_) break;
std::this_thread::sleep_for(UI_UPDATE_INTERVAL);
}
return { finalStatus, finalRequest, logFilePath };
}
else
return { finalStatus, FinalRequest::none, logFilePath };
}
void BatchStatusHandler::initNewPhase(int itemsTotal, int64_t bytesTotal, ProcessCallback::Phase phaseID)
{
StatusHandler::initNewPhase(itemsTotal, bytesTotal, phaseID);
if (progressDlg_)
progressDlg_->initNewPhase(); //call after "StatusHandler::initNewPhase"
forceUiRefresh(); //throw X; OS X needs a full yield to update GUI and get rid of "dummy" texts
}
void BatchStatusHandler::updateDataProcessed(int itemsDelta, int64_t bytesDelta)
{
StatusHandler::updateDataProcessed(itemsDelta, bytesDelta);
//note: this method should NOT throw in order to properly allow undoing setting of statistics!
if (progressDlg_) progressDlg_->notifyProgressChange(); //noexcept
//for "curveDataBytes_->addRecord()"
}
void BatchStatusHandler::logInfo(const std::wstring& msg)
{
errorLog_.logMsg(msg, MSG_TYPE_INFO);
}
void BatchStatusHandler::reportWarning(const std::wstring& msg, bool& warningActive)
{
if (!progressDlg_) abortProcessNow();
PauseTimers dummy(*progressDlg_);
errorLog_.logMsg(msg, MSG_TYPE_WARNING);
if (!warningActive)
return;
if (!progressDlg_->getOptionIgnoreErrors())
switch (batchErrorHandling_)
{
case BatchErrorHandling::SHOW_POPUP:
{
forceUiRefreshNoThrow(); //noexcept! => don't throw here when error occurs during clean up!
bool dontWarnAgain = false;
switch (showQuestionDialog(progressDlg_->getWindowIfVisible(), DialogInfoType::WARNING,
PopupDialogCfg().setDetailInstructions(msg + L"\n\n" + _("You can switch to FreeFileSync's main window to resolve this issue.")).
setCheckBox(dontWarnAgain, _("&Don't show this warning again"), QuestionButton2::NO),
_("&Ignore"), _("&Switch")))
{
case QuestionButton2::YES: //ignore
warningActive = !dontWarnAgain;
break;
case QuestionButton2::NO: //switch
errorLog_.logMsg(_("Switching to FreeFileSync's main window"), MSG_TYPE_INFO);
switchToGuiRequested_ = true; //treat as a special kind of cancel
userAbortProcessNow(); //throw AbortProcess
case QuestionButton2::CANCEL:
userAbortProcessNow(); //throw AbortProcess
break;
}
}
break; //keep it! last switch might not find match
case BatchErrorHandling::CANCEL:
abortProcessNow(); //not user-initiated! throw AbortProcess
break;
}
}
ProcessCallback::Response BatchStatusHandler::reportError(const std::wstring& msg, size_t retryNumber)
{
if (!progressDlg_) abortProcessNow();
PauseTimers dummy(*progressDlg_);
//auto-retry
if (retryNumber < automaticRetryCount_)
{
errorLog_.logMsg(msg + L"\n-> " + _("Automatic retry"), MSG_TYPE_INFO);
delayAndCountDown(_("Automatic retry") + (automaticRetryCount_ <= 1 ? L"" : L" " + numberTo<std::wstring>(retryNumber + 1) + L"/" + numberTo<std::wstring>(automaticRetryCount_)),
automaticRetryDelay_, [&](const std::wstring& statusMsg) { this->reportStatus(_("Error") + L": " + statusMsg); });
return ProcessCallback::RETRY;
}
//always, except for "retry":
auto guardWriteLog = makeGuard<ScopeGuardRunMode::ON_EXIT>([&] { errorLog_.logMsg(msg, MSG_TYPE_ERROR); });
if (!progressDlg_->getOptionIgnoreErrors())
{
switch (batchErrorHandling_)
{
case BatchErrorHandling::SHOW_POPUP:
{
forceUiRefreshNoThrow(); //noexcept! => don't throw here when error occurs during clean up!
switch (showConfirmationDialog(progressDlg_->getWindowIfVisible(), DialogInfoType::ERROR2,
PopupDialogCfg().setDetailInstructions(msg),
_("&Ignore"), _("Ignore &all"), _("&Retry")))
{
case ConfirmationButton3::ACCEPT: //ignore
return ProcessCallback::IGNORE_ERROR;
case ConfirmationButton3::ACCEPT_ALL: //ignore all
progressDlg_->setOptionIgnoreErrors(true);
return ProcessCallback::IGNORE_ERROR;
case ConfirmationButton3::DECLINE: //retry
guardWriteLog.dismiss();
errorLog_.logMsg(msg + L"\n-> " + _("Retrying operation..."), MSG_TYPE_INFO);
return ProcessCallback::RETRY;
case ConfirmationButton3::CANCEL:
userAbortProcessNow(); //throw AbortProcess
break;
}
}
break; //used if last switch didn't find a match
case BatchErrorHandling::CANCEL:
abortProcessNow(); //not user-initiated! throw AbortProcess
break;
}
}
else
return ProcessCallback::IGNORE_ERROR;
assert(false);
return ProcessCallback::IGNORE_ERROR; //dummy value
}
void BatchStatusHandler::reportFatalError(const std::wstring& msg)
{
if (!progressDlg_) abortProcessNow();
PauseTimers dummy(*progressDlg_);
errorLog_.logMsg(msg, MSG_TYPE_FATAL_ERROR);
if (!progressDlg_->getOptionIgnoreErrors())
switch (batchErrorHandling_)
{
case BatchErrorHandling::SHOW_POPUP:
{
forceUiRefreshNoThrow(); //noexcept! => don't throw here when error occurs during clean up!
switch (showConfirmationDialog(progressDlg_->getWindowIfVisible(), DialogInfoType::ERROR2,
PopupDialogCfg().setTitle(_("Serious Error")).
setDetailInstructions(msg),
_("&Ignore"), _("Ignore &all")))
{
case ConfirmationButton2::ACCEPT:
break;
case ConfirmationButton2::ACCEPT_ALL:
progressDlg_->setOptionIgnoreErrors(true);
break;
case ConfirmationButton2::CANCEL:
userAbortProcessNow(); //throw AbortProcess
break;
}
}
break;
case BatchErrorHandling::CANCEL:
abortProcessNow(); //not user-initiated! throw AbortProcess
break;
}
}
void BatchStatusHandler::forceUiRefreshNoThrow()
{
if (progressDlg_)
progressDlg_->updateGui();
}
void BatchStatusHandler::onProgressDialogTerminate()
{
progressDlg_ = nullptr;
}
|