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
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
|
/*
* Copyright (C) by Duncan Mac-Vicar P. <duncan@kde.org>
* Copyright (C) by Daniel Molkentin <danimo@owncloud.com>
* Copyright (C) by Klaas Freitag <freitag@owncloud.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*/
#ifndef MIRALL_FOLDER_H
#define MIRALL_FOLDER_H
#include "syncresult.h"
#include "progressdispatcher.h"
#include "common/syncjournaldb.h"
#include "networkjobs.h"
#include "syncoptions.h"
#include <QDateTime>
#include <QObject>
#include <QStringList>
#include <QUuid>
#include <chrono>
#include <memory>
#include <set>
class QThread;
class QSettings;
namespace OCC {
class Vfs;
class SyncEngine;
class AccountState;
class SyncRunFileLog;
class FolderWatcher;
class LocalDiscoveryTracker;
/**
* @brief The FolderDefinition class
* @ingroup gui
*/
class FolderDefinition
{
public:
FolderDefinition()
: paused(false)
, ignoreHiddenFiles(true)
{
}
/// The name of the folder in the ui and internally
QString alias;
/// path on local machine (always trailing /)
QString localPath;
/// path to the journal, usually relative to localPath
QString journalPath;
/// path on remote (usually no trailing /, exception "/")
QString targetPath;
/// whether the folder is paused
bool paused;
/// whether the folder syncs hidden files
bool ignoreHiddenFiles;
/// Which virtual files setting the folder uses
Vfs::Mode virtualFilesMode = Vfs::Off;
/// The CLSID where this folder appears in registry for the Explorer navigation pane entry.
QUuid navigationPaneClsid;
/// Whether the vfs mode shall silently be updated if possible
bool upgradeVfsMode = false;
/// Saves the folder definition into the current settings group.
static void save(QSettings &settings, const FolderDefinition &folder);
/// Reads a folder definition from the current settings group.
static bool load(QSettings &settings, const QString &alias,
FolderDefinition *folder);
/** The highest version in the settings that load() can read
*
* Version 1: initial version (default if value absent in settings)
* Version 2: introduction of metadata_parent hash in 2.6.0
* (version remains readable by 2.5.1)
* Version 3: introduction of new windows vfs mode in 2.6.0
* Version 4: until 2.9.1 windows vfs tried to unregister folders with a different id from windows.
*/
static int maxSettingsVersion() { return 4; }
/// Ensure / as separator and trailing /.
static QString prepareLocalPath(const QString &path);
/// Remove ending /, then ensure starting '/': so "/foo/bar" and "/".
static QString prepareTargetPath(const QString &path);
/// journalPath relative to localPath.
QString absoluteJournalPath() const;
};
/**
* @brief The Folder class
* @ingroup gui
*/
class Folder : public QObject
{
Q_OBJECT
public:
enum class ChangeReason {
Other,
UnLock
};
Q_ENUM(ChangeReason)
/** Create a new Folder
*/
Folder(const FolderDefinition &definition, AccountState *accountState, std::unique_ptr<Vfs> vfs, QObject *parent = nullptr);
~Folder() override;
/**
* The account the folder is configured on.
*/
AccountState *accountState() const { return _accountState.data(); }
/**
* alias or nickname
*/
QString alias() const;
QString shortGuiRemotePathOrAppName() const; // since 2.0 we don't want to show aliases anymore, show the path instead
/**
* short local path to display on the GUI (native separators)
*/
QString shortGuiLocalPath() const;
/**
* canonical local folder path, always ends with /
*/
QString path() const;
/**
* cleaned canonical folder path, like path() but never ends with a /
*
* Wrapper for QDir::cleanPath(path()) except for "Z:/",
* where it returns "Z:" instead of "Z:/".
*/
QString cleanPath() const;
/**
* remote folder path, usually without trailing /, exception "/"
*/
QString remotePath() const;
/**
* remote folder path, always with a trailing /
*/
QString remotePathTrailingSlash() const;
void setNavigationPaneClsid(const QUuid &clsid) { _definition.navigationPaneClsid = clsid; }
QUuid navigationPaneClsid() const { return _definition.navigationPaneClsid; }
/**
* remote folder path with server url
*/
QUrl remoteUrl() const;
/**
* switch sync on or off
*/
void setSyncPaused(bool);
bool syncPaused() const;
/**
* Returns true when the folder may sync.
*/
bool canSync() const;
/**
* Whether the folder is ready
*/
bool isReady() const;
/**
* Returns true if the folder needs sync poll interval wise, and can
* sync due to its internal state
*/
bool dueToSync() const;
void prepareToSync();
/** True if the folder is currently synchronizing */
bool isSyncRunning() const;
/**
* return the last sync result with error message and status
*/
SyncResult syncResult() const;
/**
* This is called when the sync folder definition is removed. Do cleanups here.
*
* It removes the database, among other things.
*
* The folder is not in a valid state afterwards!
*/
virtual void wipeForRemoval();
void setSyncState(SyncResult::Status state);
void setDirtyNetworkLimits();
/**
* Ignore syncing of hidden files or not. This is defined in the
* folder definition
*/
bool ignoreHiddenFiles();
void setIgnoreHiddenFiles(bool ignore);
// Used by the Socket API
SyncJournalDb *journalDb() { return &_journal; }
SyncEngine &syncEngine() { return *_engine; }
Vfs &vfs()
{
OC_ENFORCE(_vfs);
return *_vfs;
}
RequestEtagJob *etagJob() const { return _requestEtagJob; }
auto lastSyncTime() const { return QDateTime::currentDateTime().addMSecs(-msecSinceLastSync().count()); }
std::chrono::milliseconds msecSinceLastSync() const { return std::chrono::milliseconds(_timeSinceLastSyncDone.elapsed()); }
std::chrono::milliseconds msecLastSyncDuration() const { return _lastSyncDuration; }
int consecutiveFollowUpSyncs() const { return _consecutiveFollowUpSyncs; }
int consecutiveFailingSyncs() const { return _consecutiveFailingSyncs; }
/// Saves the folder data in the account's settings.
void saveToSettings() const;
/// Removes the folder from the account's settings.
void removeFromSettings() const;
/**
* Returns whether a file inside this folder should be excluded.
*/
bool isFileExcludedAbsolute(const QString &fullPath) const;
/**
* Returns whether a file inside this folder should be excluded.
*/
bool isFileExcludedRelative(const QString &relativePath) const;
/** Calls schedules this folder on the FolderMan after a short delay.
*
* This should be used in situations where a sync should be triggered
* because a local file was modified. Syncs don't upload files that were
* modified too recently, and this delay ensures the modification is
* far enough in the past.
*
* The delay doesn't reset with subsequent calls.
*/
void scheduleThisFolderSoon();
/**
* Migration: When this flag is true, this folder will save to
* the backwards-compatible 'Folders' section in the config file.
*/
void setSaveBackwardsCompatible(bool save);
/** Used to have placeholders: save in placeholder config section */
void setSaveInFoldersWithPlaceholders() { _saveInFoldersWithPlaceholders = true; }
/**
* Sets up this folder's folderWatcher if possible.
*
* May be called several times.
*/
void registerFolderWatcher();
/** virtual files of some kind are enabled
*
* This is independent of whether new files will be virtual. It's possible to have this enabled
* and never have an automatic virtual file. But when it's on, the shell context menu will allow
* users to make existing files virtual.
*/
bool virtualFilesEnabled() const;
void setVirtualFilesEnabled(bool enabled);
void setRootPinState(PinState state);
/** Whether user desires a switch that couldn't be executed yet, see member */
bool isVfsOnOffSwitchPending() const { return _vfsOnOffPending; }
void setVfsOnOffSwitchPending(bool pending) { _vfsOnOffPending = pending; }
/** Whether this folder should show selective sync ui */
bool supportsSelectiveSync() const;
signals:
void syncStateChange();
void syncStarted();
void syncFinished(const SyncResult &result);
void progressInfo(const ProgressInfo &progress);
void newBigFolderDiscovered(const QString &); // A new folder bigger than the threshold was discovered
void syncPausedChanged(Folder *, bool paused);
void canSyncChanged();
/**
* Fires for each change inside this folder that wasn't caused
* by sync activity.
*/
void watchedFileChangedExternally(const QString &path);
public slots:
void slotRunEtagJob();
/**
* terminate the current sync run
*/
void slotTerminateSync();
// connected to the corresponding signals in the SyncEngine
void slotAboutToRemoveAllFiles(SyncFileItem::Direction, std::function<void(bool)> abort);
/**
* Starts a sync operation
*
* If the list of changed files is known, it is passed.
*/
void startSync();
int slotDiscardDownloadProgress();
int downloadInfoCount();
int slotWipeErrorBlacklist();
int errorBlackListEntryCount();
/**
* Triggered by the folder watcher when a file/dir in this folder
* changes. Needs to check whether this change should trigger a new
* sync run to be scheduled.
*/
void slotWatchedPathChanged(const QString &path, ChangeReason reason);
/**
* Mark a virtual file as being requested for download, and start a sync.
*
* "implicit" here means that this download request comes from the user wanting
* to access the file's data. The user did not change the file's pin state.
* If the file is currently OnlineOnly its state will change to Unspecified.
*
* The download request is stored by setting ItemTypeVirtualFileDownload
* in the database. This is necessary since the hydration is not driven by
* the pin state.
*
* relativepath is the folder-relative path to the file (including the extension)
*
* Note, passing directories is not supported. Files only.
*/
void implicitlyHydrateFile(const QString &relativepath);
/** Ensures that the next sync performs a full local discovery. */
void slotNextSyncFullLocalDiscovery();
/** Adds the path to the local discovery list
*
* A weaker version of slotNextSyncFullLocalDiscovery() that just
* schedules all parent and child items of the path for local
* discovery.
*/
void schedulePathForLocalDiscovery(const QString &relativePath);
/// Reloads the excludes, used when changing the user-defined excludes after saving them to disk.
bool reloadExcludes();
private slots:
void slotSyncStarted();
void slotSyncFinished(bool);
/** Adds a error message that's not tied to a specific item.
*/
void slotSyncError(const QString &message, ErrorCategory category = ErrorCategory::Normal);
void slotTransmissionProgress(const ProgressInfo &pi);
void slotItemCompleted(const SyncFileItemPtr &);
void etagRetreived(const QByteArray &, const QDateTime &tp);
void etagRetrievedFromSyncEngine(const QByteArray &, const QDateTime &time);
void slotEmitFinishedDelayed();
void slotNewBigFolderDiscovered(const QString &, bool isExternal);
void slotLogPropagationStart();
/** Adds this folder to the list of scheduled folders in the
* FolderMan.
*/
void slotScheduleThisFolder();
/** Adjust sync result based on conflict data from IssuesWidget.
*
* This is pretty awkward, but IssuesWidget just keeps better track
* of conflicts across partial local discovery.
*/
void slotFolderConflicts(const QString &folder, const QStringList &conflictPaths);
/** Warn users if they create a file or folder that is selective-sync excluded */
void warnOnNewExcludedItem(const SyncJournalFileRecord &record, const QStringRef &path);
/** Warn users about an unreliable folder watcher */
void slotWatcherUnreliable(const QString &message);
/** Aborts any running sync and blocks it until hydration is finished.
*
* Hydration circumvents the regular SyncEngine and both mustn't be running
* at the same time.
*/
void slotHydrationStarts();
/** Unblocks normal sync operation */
void slotHydrationDone();
private:
void connectSyncRoot();
void showSyncResultPopup();
bool checkLocalPath();
void setSyncOptions();
enum LogStatus {
LogStatusRemove,
LogStatusRename,
LogStatusMove,
LogStatusNew,
LogStatusError,
LogStatusConflict,
LogStatusUpdated
};
void createGuiLog(const QString &filename, LogStatus status, int count,
const QString &renameTarget = QString());
void startVfs();
AccountStatePtr _accountState;
FolderDefinition _definition;
QString _canonicalLocalPath; // As returned with QFileInfo:canonicalFilePath. Always ends with "/"
SyncResult _syncResult;
QScopedPointer<SyncEngine> _engine;
QPointer<RequestEtagJob> _requestEtagJob;
QByteArray _lastEtag;
QElapsedTimer _timeSinceLastEtagCheckDone;
QElapsedTimer _timeSinceLastSyncDone;
QElapsedTimer _timeSinceLastSyncStart;
QElapsedTimer _timeSinceLastFullLocalDiscovery;
std::chrono::milliseconds _lastSyncDuration;
/// The number of syncs that failed in a row.
/// Reset when a sync is successful.
int _consecutiveFailingSyncs;
/// The number of requested follow-up syncs.
/// Reset when no follow-up is requested.
int _consecutiveFollowUpSyncs;
mutable SyncJournalDb _journal;
QScopedPointer<SyncRunFileLog> _fileLog;
QTimer _scheduleSelfTimer;
/**
* When the same local path is synced to multiple accounts, only one
* of them can be stored in the settings in a way that's compatible
* with old clients that don't support it. This flag marks folders
* that shall be written in a backwards-compatible way, by being set
* on the *first* Folder instance that was configured for each local
* path.
*/
bool _saveBackwardsCompatible = false;
/** Whether the folder should be saved in that settings group
*
* If it was read from there it had virtual files enabled at some
* point and might still have db entries or suffix-virtual files even
* if they are disabled right now. This flag ensures folders that
* were in that group once never go back.
*/
bool _saveInFoldersWithPlaceholders = false;
/** Whether a vfs mode switch is pending
*
* When the user desires that vfs be switched on/off but it hasn't been
* executed yet (syncs are still running), some options should be hidden,
* disabled or different.
*/
bool _vfsOnOffPending = false;
/**
* Setting up vfs is a async operation
*/
bool _vfsIsReady = false;
/**
* Watches this folder's local directory for changes.
*
* Created by registerFolderWatcher(), triggers slotWatchedPathChanged()
*/
QScopedPointer<FolderWatcher> _folderWatcher;
/**
* Keeps track of locally dirty files so we can skip local discovery sometimes.
*/
QScopedPointer<LocalDiscoveryTracker> _localDiscoveryTracker;
/**
* The vfs mode instance (created by plugin) to use. Never null.
*/
QSharedPointer<Vfs> _vfs;
};
}
#endif
|