SyncSchedule.h

/*
 * This file is part of buteo-syncfw package
 *
 * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
 * Copyright (C) 2014-2019 Jolla Ltd.
 * Copyright (C) 2020 Open Mobile Platform LLC.
 *
 * 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 SYNCSCHEDULE_H
#define SYNCSCHEDULE_H
 
#include <QTime>
#include <QFlags>
#include <QObject>
 
class QDomDocument;
class QDomElement;
 
namespace Buteo {
 
class SyncSchedulePrivate;
class SyncScheduleTest;
 
const QString SYNC_SCHEDULE_ENABLED_KEY_BOOL("scheduler/schedule_enabled");
const QString SYNC_SCHEDULE_PEAK_ENABLED_KEY_BOOL("scheduler/schedule_peak_enabled");
const QString SYNC_SCHEDULE_OFFPEAK_ENABLED_KEY_BOOL("scheduler/schedule_offpeak_enabled");
const QString SYNC_SCHEDULE_PEAK_DAYS_KEY_INT ("scheduler/schedule_peak_days");
const QString SYNC_SCHEDULE_PEAK_START_TIME_KEY_INT ("scheduler/schedule_peak_start_time");
const QString SYNC_SCHEDULE_PEAK_END_TIME_KEY_INT ("scheduler/schedule_peak_end_time");
const QString SYNC_SCHEDULE_PEAK_SCHEDULE_KEY_INT ("scheduler/schedule_peak");
const QString SYNC_SCHEDULE_OFFPEAK_SCHEDULE_KEY_INT ("scheduler/schedule_off_peak");

class SyncSchedule
{
    Q_GADGET
    Q_PROPERTY(QTime time READ time)
    Q_PROPERTY(Days days READ days)
    Q_PROPERTY(unsigned interval READ interval)
    Q_PROPERTY(bool enabled READ scheduleEnabled)
    Q_PROPERTY(QTime rushBegin READ rushBegin)
    Q_PROPERTY(QTime rushEnd READ rushEnd)
    Q_PROPERTY(Days rushDays READ rushDays)
    Q_PROPERTY(unsigned rushInterval READ rushInterval)
    Q_PROPERTY(bool rushEnabled READ rushEnabled)
public:
    enum Day {
        NoDays    = 0x00,
        Monday    = 0x01,
        Tuesday   = 0x02,
        Wednesday = 0x04,
        Thursday  = 0x08,
        Friday    = 0x10,
        Saturday  = 0x20,
        Sunday    = 0x40
    };
    Q_DECLARE_FLAGS(Days, Day)
    Q_FLAG(Days)
 
    
    SyncSchedule();

    SyncSchedule(const SyncSchedule &aSource);

    explicit SyncSchedule(const QDomElement &aRoot);

    ~SyncSchedule();

    SyncSchedule &operator=(const SyncSchedule &aRhs);

    bool operator==(const SyncSchedule &aRhs) const;

    QDomElement toXml(QDomDocument &aDoc) const;

    QString toString() const;

    Days days() const;

    void setDays(Days aDays);

    QTime time() const;

    void setTime(const QTime &aTime);

    void setScheduleConfiguredTime(const QDateTime &aDateTime);

    QDateTime scheduleConfiguredTime();

    unsigned interval() const;

    void setInterval(unsigned aInterval);

    bool scheduleEnabled() const;

    void setScheduleEnabled(bool aEnabled);
 
    // ============== RUSH HOUR SETTINGS ============================
 

    bool rushEnabled() const;

    void setRushEnabled(bool aEnabled);

    bool syncExternallyDuringRush() const;

    void setSyncExternallyDuringRush(bool aEnabled);

    Days rushDays() const;

    void setRushDays(Days aDays);

    QTime rushBegin() const;

    QTime rushEnd() const;

    void setRushTime(const QTime &aBegin, const QTime &aEnd);

    unsigned rushInterval() const;

    void setRushInterval(unsigned aInterval);

    bool inExternalSyncRushPeriod(const QDateTime &aDateTime) const;

    QDateTime nextSyncTime(const QDateTime &aPrevSync) const;

    QDateTime nextRushSwitchTime(const QDateTime &aFromTime) const;

    bool isSyncScheduled(const QDateTime &aActualDateTime, const QDateTime &aPreviousSyncTime = QDateTime()) const;
 
private:
    SyncSchedulePrivate *d_ptr;
 
#ifdef SYNCFW_UNIT_TESTS
    friend class SyncScheduleTest;
#endif
 
};
 
}
 
Q_DECLARE_METATYPE(Buteo::SyncSchedule)
 
#endif // SYNCSCHEDULE_H