/* * Copyright (C) by Duncan Mac-Vicar P. * Copyright (C) by Daniel Molkentin * Copyright (C) by Klaas Freitag * * 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 "syncjournaldb.h" #include "clientproxy.h" #include "networkjobs.h" #include #include #include class QThread; class QSettings; namespace OCC { class SyncEngine; class AccountState; class SyncRunFileLog; /** * @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 QString localPath; /// path to the journal, usually relative to localPath QString journalPath; /// path on remote QString targetPath; /// whether the folder is paused bool paused; /// whether the folder syncs hidden files bool ignoreHiddenFiles; /// Saves the folder definition, creating a new settings group. static void save(QSettings& settings, const FolderDefinition& folder); /// Reads a folder definition from a settings group with the name 'alias'. static bool load(QSettings& settings, const QString& alias, FolderDefinition* folder); /// Ensure / as separator and trailing /. static QString prepareLocalPath(const QString& path); /// Ensure starting / and no ending /. static QString prepareTargetPath(const QString& path); /// journalPath relative to localPath. QString absoluteJournalPath() const; /// Returns the relative journal path that's appropriate for this folder and account. QString defaultJournalPath(AccountPtr account); }; /** * @brief The Folder class * @ingroup gui */ class Folder : public QObject { Q_OBJECT public: Folder(const FolderDefinition& definition, AccountState* accountState, QObject* parent = 0L); ~Folder(); typedef QMap Map; typedef QMapIterator MapIterator; /** * 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 */ QString remotePath() const; /** * 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; void prepareToSync(); /** * True if the folder is busy and can't initiate * a synchronization */ virtual bool isBusy() const; /** * return the last sync result with error message and status */ SyncResult syncResult() const; /** * set the config file name. */ void setConfigFile( const QString& ); QString configFile(); /** * This is called if the sync folder definition is removed. Do cleanups here. */ virtual void wipe(); 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; } RequestEtagJob *etagJob() { return _requestEtagJob; } qint64 msecSinceLastSync() const { return _timeSinceLastSyncDone.elapsed(); } qint64 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); 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: /** * terminate the current sync run */ void slotTerminateSync(); // connected to the corresponding signals in the SyncEngine void slotAboutToRemoveAllFiles(SyncFileItem::Direction, bool*); void slotAboutToRestoreBackup(bool*); /** * Starts a sync operation * * If the list of changed files is known, it is passed. */ void startSync(const QStringList &pathList = QStringList()); void setProxyDirty(bool value); bool proxyDirty(); 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); private slots: void slotSyncStarted(); void slotSyncError(const QString& ); void slotCsyncUnavailable(); void slotSyncFinished(bool); void slotFolderDiscovered(bool local, QString folderName); void slotTransmissionProgress(const ProgressInfo& pi); void slotItemCompleted(const SyncFileItemPtr&); void slotRunEtagJob(); void etagRetreived(const QString &); void etagRetreivedFromSyncEngine(const QString &); void slotEmitFinishedDelayed(); void slotNewBigFolderDiscovered(const QString &, bool isExternal); void slotLogPropagationStart(); /** Adds this folder to the list of scheduled folders in the * FolderMan. */ void slotScheduleThisFolder(); private: bool setIgnoredFiles(); void showSyncResultPopup(); void 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::null ); AccountStatePtr _accountState; FolderDefinition _definition; QString _canonicalLocalPath; // As returned with QFileInfo:canonicalFilePath. Always ends with "/" SyncResult _syncResult; QScopedPointer _engine; bool _csyncUnavail; bool _proxyDirty; QPointer _requestEtagJob; QString _lastEtag; QElapsedTimer _timeSinceLastSyncDone; QElapsedTimer _timeSinceLastSyncStart; qint64 _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; SyncJournalDb _journal; ClientProxy _clientProxy; QScopedPointer _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; }; } #endif