CalDAVHelper.hpp

Go to the documentation of this file.

/*
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
#ifndef CALDAVHELPER_HPP_
#define CALDAVHELPER_HPP_

#include "helpers/Http.hpp"
#include "DAVHelper.hpp"
#include "PIMItem/PIMItem.hpp"

class CalDAVHelper
{
  public:
    CalDAVHelper(const std::string& serverUrl,
                 bool isCalendarUrl,
                 OpenAB::HttpSession* httpSession,
                 OpenAB::HttpAuthorizer* httpAuthorizer);

    virtual ~CalDAVHelper();

    bool findPrincipalUrl();

    bool findCalendarHomeSet();

    bool findCalendars();

    struct CalendarInfo;
    bool queryCalendarInfo(const std::string& calendarURL,
                           CalendarInfo& info);

    bool queryCalendarMetadata(const std::string& calendarURL);

    bool queryEventsMetadata(const std::string& calendarURL);

    bool queryChangedEventsMetadata(const std::string& calendarURL,
                                    const std::string& syncToken,
                                    std::vector<OpenAB::PIMItem::ID>& removed);

    bool downloadEvents(const std::string& calendarURL,
                        unsigned int offset, unsigned int size,
                        std::vector<std::string>& icals);

    bool downloadEvents(const std::string& calendarURL,
                        std::vector<std::string>& uris,
                        std::vector<std::string>& icals);

    bool addEvent(const std::string& calendarURL,
                  const std::string& ical,
                  std::string& uri,
                  std::string& etag);

    bool removeEvent(const std::string& uri,
                     const std::string& etag="");

    bool modifyEvent(const std::string& uri,
                     const std::string& ical,
                     std::string& etag);

    unsigned int getTotalCount() const
    {
      return eventsMetadata.size();
    }

    std::string getSyncToken() const
    {
      return calendarSyncToken;
    }

    typedef struct
    {
        /*Current ETAG (revision) of item*/
        std::string etag;
        /*Item Uri that uniquely identifies item on server*/
        std::string uri;
    } EventMetadata;

    typedef std::vector<EventMetadata> EventsMetadata;

    EventsMetadata getEventsMetadata() const
    {
      return eventsMetadata;
    }

    enum CalendarItemTypes
    {
      EVENT = 0,  //< Event
      TODO,       //< Task
      JOURNAL     //< Journal/Memo
    };

    class CalendarInfo
    {
      public:
        CalendarInfo();
        CalendarInfo(const std::string& url,
                     const std::string& name,
                     const std::vector<CalendarItemTypes>& types);
        ~CalendarInfo();

        std::string getUrl() const;

        std::string getDisplayName() const;

        bool supportsType(CalendarItemTypes type) const;

        std::vector<CalendarItemTypes> getSupportedCalendarTypes() const;

      private:
        std::string url;
        std::string displayName;

        std::vector<CalendarItemTypes> supportedTypes;
    };

    typedef std::vector<CalendarInfo> Calendars;

    Calendars getCalendars() const
    {
      return calendars;
    }

  private:
    CalDAVHelper(CalDAVHelper const &other);

    CalDAVHelper& operator=(CalDAVHelper const &other);

    //CalDAV server url
    std::string       serverUrl;

    //Parsed part of server url containing only host address
    std::string       serverHostUrl;

    std::string       principalUrl;
    std::string       principalCalendarHomeSetUrl;
    std::string       principalCalendarSetHostUrl;
    std::string       principalCalendarUrl;

    //list of available calendars
    Calendars calendars;

    int getIndexFromUris(const std::vector<std::string>& uris, const std::string& uri);

    bool processCalendarsInfo(const std::string& davResponse,
                              Calendars& cals);

    DAVHelper            davHelper;
    OpenAB::HttpSession*    httpSession;
    OpenAB::HttpAuthorizer* httpAuthorizer;

    EventsMetadata eventsMetadata;
    std::string calendarCTag;
    std::string calendarSyncToken;

    std::string userAgent;
};

#endif // CALDAVHELPER_HPP_