nextcloud-desktop/src/mirall/folderman.h
2013-11-18 09:37:09 +01:00

150 lines
4.2 KiB
C++

/*
* 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 FOLDERMAN_H
#define FOLDERMAN_H
#include <QObject>
#include <QQueue>
#include <QList>
#include "mirall/folder.h"
#include "mirall/folderwatcher.h"
#include "mirall/syncfileitem.h"
class QSignalMapper;
class SyncResult;
namespace Mirall {
class FolderMan : public QObject
{
Q_OBJECT
public:
static FolderMan* instance();
~FolderMan();
int setupFolders();
Mirall::Folder::Map map();
/**
* Add a folder definition to the config
* Params:
* QString alias
* QString sourceFolder on local machine
* QString targetPath on remote
*/
void addFolderDefinition(const QString&, const QString&, const QString& );
/** Returns the folder which the file or directory stored in path is in */
Folder* folderForPath(const QUrl& path);
/** Returns the folder by alias or NULL if no folder with the alias exists. */
Folder *folder( const QString& );
/** Returns the last sync result by alias */
SyncResult syncResult( const QString& );
/** Returns the last sync result by Folder */
SyncResult syncResult( Folder* );
/** Creates a folder for a specific configuration, identified by alias. */
Folder* setupFolderFromConfigFile(const QString & );
/** Wipes all folder defintions. No way back! */
void removeAllFolderDefinitions();
/** Removes csync journals from all folders. */
void wipeAllJournals();
/**
* Ensures that a given directory does not contain a .csync_journal.
*
* @returns false if the journal could not be removed, true otherwise.
*/
static bool ensureJournalGone(const QString &path);
/** Creates a new and empty local directory. */
bool startFromScratch( const QString& );
QString statusToString( SyncResult, bool enabled ) const;
static SyncResult accountStatus( const QList<Folder*> &folders );
signals:
/**
* signal to indicate a folder named by alias has changed its sync state.
* Get the state via the Folder Map or the syncResult and syncState methods.
*/
void folderSyncStateChange( const QString & );
public slots:
void slotRemoveFolder( const QString& );
void slotEnableFolder( const QString&, bool );
void slotFolderSyncStarted();
void slotFolderSyncFinished( const SyncResult& );
void terminateSyncProcess( const QString& alias = QString::null );
/* delete all folder objects */
int unloadAllFolders();
// 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);
private slots:
// slot to add a folder to the syncing queue
void slotScheduleSync( const QString & );
// slot to take the next folder from queue and start syncing.
void slotScheduleFolderSync();
private:
// finds all folder configuration files
// and create the folders
void terminateCurrentSync();
QString getBackupName( const QString& ) const;
// Escaping of the alias which is used in QSettings AND the file
// system, thus need to be escaped.
QString escapeAlias( const QString& ) const;
QString unescapeAlias( const QString& ) const;
void removeFolder( const QString& );
QSet<Folder*> _disabledFolders;
Folder::Map _folderMap;
QString _folderConfigPath;
QSignalMapper *_folderChangeSignalMapper;
QString _currentSyncFolder;
bool _syncEnabled;
QQueue<QString> _scheduleQueue;
bool _dirtyProxy; // If the proxy need to be re-configured
explicit FolderMan(QObject *parent = 0);
static FolderMan *_instance;
};
} // namespace Mirall
#endif // FOLDERMAN_H