ProfileManager.h

/*
 * This file is part of buteo-syncfw package
 *
 * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
 *
 * Contact: Sateesh Kavuri <sateesh.kavuri@nokia.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * version 2.1 as published by the Free Software Foundation.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */
 
#ifndef PROFILEMANAGER_H
#define PROFILEMANAGER_H
 
#include "SyncProfile.h"
#include "Profile.h"
#include <QObject>
#include <QList>
#include <QHash>
 
namespace Buteo {
 
class ProfileManagerPrivate;
    
class ProfileManager: public QObject
{
    Q_OBJECT
public:
 
    static const QString DEFAULT_PRIMARY_PROFILE_PATH;
 
    static const QString DEFAULT_SECONDARY_PROFILE_PATH;
 
    struct SearchCriteria
    {
        enum Type
        {
            EXISTS,
 
            NOT_EXISTS,
 
            EQUAL,
 
            NOT_EQUAL
        };
 
        SearchCriteria();
 
        SearchCriteria(const SearchCriteria &aSource);
 
        Type iType;
 
        QString iSubProfileName;
 
        QString iSubProfileType;
 
        QString iKey;
 
        QString iValue;
    };
 
    enum ProfileChangeType
    {
        PROFILE_ADDED = 0,
        PROFILE_MODIFIED,
        PROFILE_REMOVED,
        PROFILE_LOGS_MODIFIED
    };
 
    ProfileManager(const QString &aPrimaryPath = DEFAULT_PRIMARY_PROFILE_PATH,
                   const QString &aSecondaryPath = DEFAULT_SECONDARY_PROFILE_PATH);
 
    ~ProfileManager();
 
    QStringList profileNames(const QString &aType);
 
    SyncProfile *syncProfile(const QString &aName);
 
    QList<SyncProfile*> allSyncProfiles();
 
    QList<SyncProfile*> allVisibleSyncProfiles();
 
    QList<SyncProfile*> getSyncProfilesByData(const QString &aSubProfileName,
        const QString &aSubProfileType,
        const QString &aKey = "", const QString &aValue = "");
 
    QList<SyncProfile*> getSyncProfilesByData(
        const QList<SearchCriteria> &aCriteria);
 
    QList<SyncProfile*> getSyncProfilesByStorage(
        const QString &aStorageName, bool aStorageMustBeEnabled = false);
 
    QList<SyncProfile*> getSOCProfilesForStorage(
        const QString &aStorageName);
 
    void expand(Profile &aProfile);
 
    bool saveLog(const SyncLog &aLog);
 
    bool saveSyncResults(QString aProfileName, const SyncResults &aResults);
 
    Profile *profile(const QString &aName, const QString &aType);
 
    Profile *profileFromXml(const QString &aProfileAsXml);
     
    SyncProfile *createTempSyncProfile (const QString &btAddress, bool &saveNewProfile);
 
    QString updateProfile(const Profile &aProfile);
 
    bool removeProfile(const QString &aProfileId);
 
    bool rename(const QString &aName, const QString &aNewName);
  
    void enableStorages (Profile &aProfile, QMap<QString , bool> &aStorageMap, bool *aModified = NULL);
   
    void setStoragesVisible(Profile &aProfile, QMap<QString, bool> &aStorageMap, bool *aModified = NULL);
    
    void saveRemoteTargetId (Profile &aProfile,const QString& aId);
    
    bool setSyncSchedule(QString aProfileId , QString aScheduleAsXml);
 
    void addRetriesInfo(const SyncProfile* aProfile);
 
    QDateTime getNextRetryInterval(const SyncProfile* aProfile);
 
    void retriesDone(const QString& aProfileName);
 
#ifdef SYNCFW_UNIT_TESTS
    friend class ProfileManagerTest;
#endif
 
signals:
 
    void signalProfileChanged(QString aProfileName, int aChangeType , QString aProfileAsXml);
 
private:
    
    ProfileManager& operator=(const ProfileManager &aRhs);
    
    ProfileManagerPrivate *d_ptr;
 
    QHash<QString, QList<quint32> > iSyncRetriesInfo;
};
 
}
 
#endif // PROFILEMANAGER_H