Merge branch 'master' into dbjournal_per_account

1 files changed, 92 insertions, 41 deletions

diff --git a/src/gui/folderman.h b/src/gui/folderman.h
index 19a515541..047c68ce8 100644
--- a/src/gui/folderman.h
+++ b/src/gui/folderman.h
@@ -37,6 +37,26 @@ class LockWatcher;
 /**
  * @brief The FolderMan class
  * @ingroup gui
+ *
+ * The FolderMan knows about all loaded folders and is responsible for
+ * scheduling them when necessary.
+ *
+ * A folder is scheduled if:
+ * - The configured force-sync-interval has expired
+ *   (_timeScheduler and slotScheduleFolderByTime())
+ *
+ * - A folder watcher receives a notification about a file change
+ *   (_folderWatchers and Folder::slotWatchedPathChanged())
+ *
+ * - The folder etag on the server has changed
+ *   (_etagPollTimer)
+ *
+ * - The locks of a monitored file are released
+ *   (_lockWatcher and slotWatchedFileUnlocked())
+ *
+ * - There was a sync error or a follow-up sync is requested
+ *   (_timeScheduler and slotScheduleFolderByTime()
+ *    and Folder::slotSyncFinished())
  */
 class FolderMan : public QObject
 {
@@ -54,6 +74,9 @@ public:
       */
     Folder* addFolder(AccountState* accountState, const FolderDefinition& folderDefinition);
 
+    /** Removes a folder */
+    void removeFolder( Folder* );
+
     /** Returns the folder which the file or directory stored in path is in */
     Folder* folderForPath(const QString& path);
 
@@ -126,6 +149,24 @@ public:
      */
     Folder* currentSyncFolder() const;
 
+    /** Removes all folders */
+    int unloadAndDeleteAllFolders();
+
+    /**
+     * If enabled is set to false, no new folders will start to sync.
+     * The current one will finish.
+     */
+    void setSyncEnabled( bool );
+
+    /** Queues a folder for syncing. */
+    void scheduleFolder(Folder*);
+
+    /** Queues all folders for syncing. */
+    void scheduleAllFolders();
+
+    void setDirtyProxy(bool value = true);
+    void setDirtyNetworkLimits();
+
 signals:
     /**
       * signal to indicate a folder has changed its sync state.
@@ -139,41 +180,12 @@ signals:
      */
     void scheduleQueueChanged();
 
-    void folderListChanged(const Folder::Map &);
-
-public slots:
-    void slotRemoveFolder( Folder* );
-    void slotFolderSyncPaused(Folder *, bool paused);
-    void slotFolderCanSyncChanged();
-
-    void slotFolderSyncStarted();
-    void slotFolderSyncFinished( const SyncResult& );
-
     /**
-     * Terminates the current folder sync.
-     *
-     * It does not switch the folder to paused state.
+     * Emitted whenever the list of configured folders changes.
      */
-    void terminateSyncProcess();
-
-    /* delete all folder objects */
-    int unloadAndDeleteAllFolders();
-
-    // if enabled is set to false, no new folders will start to sync.
-    // the current one will finish.
-    void setSyncEnabled( bool );
-
-    void slotScheduleAllFolders();
-
-    void setDirtyProxy(bool value = true);
-    void setDirtyNetworkLimits();
+    void folderListChanged(const Folder::Map &);
 
-    // slot to add a folder to the syncing queue
-    void slotScheduleSync(Folder*);
-    // slot to schedule an ETag job
-    void slotScheduleETagJob ( const QString &alias, RequestEtagJob *job);
-    void slotEtagJobDestroyed (QObject*);
-    void slotRunOneEtagJob();
+public slots:
 
     /**
      * Schedules folders of newly connected accounts, terminates and
@@ -190,10 +202,22 @@ public slots:
      * Triggers a sync run once the lock on the given file is removed.
      *
      * Automatically detemines the folder that's responsible for the file.
+     * See slotWatchedFileUnlocked().
      */
     void slotSyncOnceFileUnlocks(const QString& path);
 
+    // slot to schedule an ETag job (from Folder only)
+    void slotScheduleETagJob ( const QString &alias, RequestEtagJob *job);
+
 private slots:
+    void slotFolderSyncPaused(Folder *, bool paused);
+    void slotFolderCanSyncChanged();
+    void slotFolderSyncStarted();
+    void slotFolderSyncFinished( const SyncResult& );
+
+    void slotRunOneEtagJob();
+    void slotEtagJobDestroyed (QObject*);
+
     // slot to take the next folder from queue and start syncing.
     void slotStartScheduledFolderSync();
     void slotEtagPollTimerTimeout();
@@ -207,12 +231,29 @@ private slots:
     void slotServerVersionChanged(Account* account);
 
     /**
-     * Schedules the folder for synchronization that contains
+     * A file whose locks were being monitored has become unlocked.
+     *
+     * This schedules the folder for synchronization that contains
      * the file with the given path.
      */
-    void slotScheduleFolderOwningFile(const QString& path);
+    void slotWatchedFileUnlocked(const QString& path);
+
+    /**
+     * Schedules folders whose time to sync has come.
+     *
+     * Either because a long time has passed since the last sync or
+     * because of previous failures.
+     */
+    void slotScheduleFolderByTime();
 
 private:
+    /**
+     * Terminates the current folder sync.
+     *
+     * It does not switch the folder to paused state.
+     */
+    void terminateSyncProcess();
+
     /** Adds a new folder, does not add it to the account settings and
      *  does not set an account on the new folder.
       */
@@ -222,7 +263,7 @@ private:
     void unloadFolder( Folder * );
 
     /** Will start a sync after a bit of delay. */
-    void startScheduledSyncSoon(qint64 msMinimumDelay = 0);
+    void startScheduledSyncSoon();
 
     // finds all folder configuration files
     // and create the folders
@@ -238,19 +279,29 @@ private:
     Folder        *_currentSyncFolder;
     QPointer<Folder> _lastSyncFolder;
     bool           _syncEnabled;
-    QTimer         _etagPollTimer;
-    QPointer<RequestEtagJob>        _currentEtagJob; // alias of Folder running the current RequestEtagJob
 
+    /// Watching for file changes in folders
     QMap<QString, FolderWatcher*> _folderWatchers;
+
+    /// Starts regular etag query jobs
+    QTimer _etagPollTimer;
+    /// The currently running etag query
+    QPointer<RequestEtagJob> _currentEtagJob;
+
+    /// Watches files that couldn't be synced due to locks
     QScopedPointer<LockWatcher> _lockWatcher;
-    QScopedPointer<SocketApi> _socketApi;
 
-    /** The aliases of folders that shall be synced. */
-    QQueue<Folder*> _scheduleQueue;
+    /// Occasionally schedules folders
+    QTimer _timeScheduler;
+
+    /// Scheduled folders that should be synced as soon as possible
+    QQueue<Folder*> _scheduledFolders;
 
-    /** When the timer expires one of the scheduled syncs will be started. */
+    /// Picks the next scheduled folder and starts the sync
     QTimer          _startScheduledSyncTimer;
 
+    QScopedPointer<SocketApi> _socketApi;
+
     bool            _appRestartRequired;
 
     static FolderMan *_instance;