/*
 * 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 SYNCSCHEDULER_H
#define SYNCSCHEDULER_H

#if defined(USE_KEEPALIVE)
#include "BackgroundSync.h"
#include "ProfileManager.h"
#elif defined(USE_IPHB)
#include "SyncAlarmInventory.h"
#include "IPHeartBeat.h"
#endif
#include <QObject>
#include <QMap>
#include <QSet>
#include <QString>
#include <QDateTime>
#include <ctime>

class QDateTime;
#ifdef USE_KEEPALIVE
class BackgroundSync;
#elif defined(USE_IPHB)
class IPHeartBeat;
#endif

namespace Buteo {

class SyncSession;
class SyncSchedulerTest;
class SyncProfile;

/*! \brief SyncScheduler Object to be used to set Schedule via the framework */
class SyncScheduler : public QObject
{
    Q_OBJECT

public:
    //! \brief Constructor.
    SyncScheduler(QObject *aParent = 0);

    /**
     * \brief Destructor
     */
    virtual ~SyncScheduler();

    /*! \brief Adds a profile to the scheduler.
     *
     * Verifies that the profile is enabled and it has schedule enabled
     * before adding. If the profile is already added, removes the old schedule
     * and then adds the profile again.
     * A syncNow signal is sent when sync should be started based on the
     * schedule settings of the profile. The signal is sent only once. Call
     * this function again after the sync has finished to continue scheduling
     * syncs for the profile.
     * \param aProfile Profile to add to scheduler.
     * \return Success indicator.
     */
    bool addProfile(const SyncProfile *aProfile);

    /* Schedule a retry for a failed sync if the profile has retries enabled
     *
     * @param aProfile sync profile
     * @param aNExtSyncTime retry after this duration
     */
    void addProfileForSyncRetry(const SyncProfile *aProfile, QDateTime aNextSyncTime);

    /*! \brief Removes the profile with the given name from the scheduler.
     *
     * No new syncNow signals will be sent for the profile. Note that an
     * already sent signal may still be waiting in the event queue of receiving
     * thread.
     * \param aProfileName Name of the profile to remove from the scheduler.
     */
    void removeProfile(const QString &aProfileName);

public slots:
    /*! \brief Handles the sync status change signal from the synchronizer
     *
     * This allows the SyncScheduler to appropriately wait() or stop() any background
     * activity which is preventing device suspend.
     *
     * @param aProfileName Name of the profile
     * @param aStatus Status of the sync
     * @param aMessage Status message as a string
     * @param aMoreDetails In case of failure, contains detailed reason
     */
    void syncStatusChanged(const QString &aProfileName, int aStatus,
                           const QString &aMessage, int aMoreDetails);

private slots:
#if defined(USE_IPHB)
    /**
     * \brief Performs needed actions when scheduled alarm is triggered
     *
     * @param aAlarmEventID an ID that identifies the triggered alarm event
     */

    void doAlarmActions(int aAlarmEventID);
#endif

    /**
     * \brief Performs needed actions when a IP heart beat is triggered
     *
     * @param aProfileName Name of the profile on which heart beat received
     */
    void doIPHeartbeatActions(QString aProfileName);

#if defined(USE_KEEPALIVE)
    /**
     * \brief Reschedule backgroundActivity for a profile
     *
     * @param aProfileName Name of the profile to reschedule
     */
    void rescheduleBackgroundActivity(const QString &aProfileName);
#endif

signals:
    /*! \brief Signal emitted when a sync session should be launched based on
     *   the sync schedule settings of the profile.
     *
     * \param aProfileName Name of the profile.
     */
    void syncNow(QString aProfileName);

    /*! \brief Signal emitted when a sync session should be launched based on
     *   the sync schedule settings of the profile.
     *
     * \param aProfileName Name of the profile.
     */
    void externalSyncChanged(QString aProfileName, bool aQuery = false);

private: // functions
    /**
     * \brief Programs next alarm event to alarmd.
     *
     * @param aProfile The profile for which the alarm is programmed
     * @param aNextSyncTime use if provided, otherwise fetch the info from the profile
     * @return Unique alarm event ID or 0 in failure case.
     */
    int setNextAlarm(const SyncProfile *aProfile, QDateTime aNextSyncTime = QDateTime());

    /**
     * \brief Creates a DBUS adaptor for the scheduler
     */
    void setupDBusAdaptor();

#if defined(USE_IPHB)
    /**
     * \brief Removes an alarm from alarmd queue
     * @param aAlarmEventID ID of the alarm to be removed
     */
    void removeAlarmEvent(int aAlarmEvent);

    /**
     * \brief A convenience method that removes all alarms from alarmd queue
     */
    void removeAllAlarms();
#endif

private: // data
    QSet<QString> iActiveBackgroundSyncProfiles;
#if defined(USE_KEEPALIVE)
    /// BackgroundSync management object
    BackgroundSync *iBackgroundActivity;
    ProfileManager iProfileManager;
#elif defined(USE_IPHB)
    /// A list of sync schedule profiles
    QMap<QString, int> iSyncScheduleProfiles;

    /// Alarm factory object
    SyncAlarmInventory *iAlarmInventory;

    /// IP Heartbeat management object
    IPHeartBeat *iIPHeartBeatMan;
#endif

#ifdef SYNCFW_UNIT_TESTS
    friend class SyncSchedulerTest;
#endif

};

}

#endif // SYNCSCHEDULER_H
