carddav_p.h

/*
 * This file is part of buteo-sync-plugin-carddav package
 *
 * Copyright (C) 2014 Jolla Ltd. and/or its subsidiary(-ies).
 *
 * Contributors: Chris Adams <chris.adams@jolla.com>
 *
 * This program/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 program/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 program/library; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 */

#ifndef CARDDAV_P_H
#define CARDDAV_P_H

#include "requestgenerator_p.h"
#include "replyparser_p.h"

#include <QObject>
#include <QMultiMap>
#include <QList>
#include <QMap>
#include <QString>
#include <QSet>
#include <QSslError>

#include <QContact>
#include <QContactCollection>
#include <QVersitContactImporterPropertyHandlerV2>
#include <QVersitContactExporterDetailHandlerV2>

QTCONTACTS_USE_NAMESPACE
QTVERSIT_USE_NAMESPACE

class Syncer;
class CardDavVCardConverter;
class CardDav : public QObject
{
    Q_OBJECT

public:
    CardDav(Syncer *parent,
            const QString &serverUrl,
            const QString &addressbookPath,
            const QString &username,
            const QString &password);
    CardDav(Syncer *parent,
            const QString &serverUrl,
            const QString &addressbookPath,
            const QString &accessToken);
    ~CardDav();

    void determineAddressbooksList();
    bool downsyncAddressbookContent(
            const QString &addressbookUrl,
            const QString &newSyncToken,
            const QString &newCtag,
            const QString &oldSyncToken,
            const QString &oldCtag);
    bool upsyncUpdates(const QString &addressbookUrl,
                       const QList<QContact> &added,
                       const QList<QContact> &modified,
                       const QList<QContact> &removed);

Q_SIGNALS:
    void error(int errorCode = 0);
    void remoteChanges(const QList<QContact> &added,
                       const QList<QContact> &modified,
                       const QList<QContact> &removed);
    void upsyncCompleted();
    void addressbooksList(const QList<ReplyParser::AddressBookInformation> &paths);

private:
    void determineRemoteAMR();
    void fetchUserInformation();
    void fetchAddressbookUrls(const QString &userPath);
    void fetchAddressbooksInformation(const QString &addressbooksHomePath);
    bool fetchImmediateDelta(const QString &addressbookUrl, const QString &syncToken);
    bool fetchContactMetadata(const QString &addressbookUrl);
    void fetchContacts(const QString &addressbookUrl, const QList<ReplyParser::ContactInformation> &amrInfo);

private Q_SLOTS:
    void sslErrorsOccurred(const QList<QSslError> &errors);
    void userInformationResponse();
    void addressbookUrlsResponse();
    void addressbooksInformationResponse();
    void immediateDeltaResponse();
    void contactMetadataResponse();
    void contactsResponse();
    void upsyncResponse();
    void upsyncComplete(const QString &addressbookUrl);
    void errorOccurred(int httpError);

private:
    void calculateContactChanges(const QString &addressbookUrl, const QList<QContact> &added, const QList<QContact> &modified);

    enum DiscoveryStage {
        DiscoveryStarted = 0,
        DiscoveryRedirected,
        DiscoveryTryRoot
    };

    Syncer *q;
    CardDavVCardConverter *m_converter;
    RequestGenerator *m_request;
    ReplyParser *m_parser;
    QString m_serverUrl;
    QString m_addressbookPath;
    DiscoveryStage m_discoveryStage;
    bool m_addressbooksListOnly;
    bool m_triedAddressbookPathAsHomeSetUrl;

    struct UpsyncedContacts {
        QList<QContact> additions;
        QList<QContact> modifications;
    };
    QHash<QString, UpsyncedContacts> m_upsyncedChanges;
    QHash<QString, int> m_upsyncRequests;
};

class CardDavVCardConverter : public QVersitContactImporterPropertyHandlerV2,
                              public QVersitContactExporterDetailHandlerV2
{
public:
    CardDavVCardConverter();
    ~CardDavVCardConverter();

    // QVersitContactImporterPropertyHandlerV2
    void propertyProcessed(const QVersitDocument &d, const QVersitProperty &property,
                           const QContact &c, bool *alreadyProcessed,
                           QList<QContactDetail> *updatedDetails);
    void documentProcessed(const QVersitDocument &d, QContact *c);

    // QVersitContactExporterDetailHandlerV2
    void contactProcessed(const QContact &c, QVersitDocument *d);
    void detailProcessed(const QContact &c, const QContactDetail &detail,
                         const QVersitDocument &d, QSet<int> *processedFields,
                         QList<QVersitProperty> *toBeRemoved, QList<QVersitProperty> *toBeAdded);

    // API exposed to clients
    QPair<QContact, QStringList> convertVCardToContact(const QString &vcard, bool *ok);
    QString convertContactToVCard(const QContact &c, const QStringList &unsupportedProperties);

private:
    static QStringList supportedPropertyNames();
    QString convertPropertyToString(const QVersitProperty &p) const;
    QMap<QString, QStringList> m_unsupportedProperties; // uid -> unsupported properties
    QStringList m_tempUnsupportedProperties;
};

#endif // CARDDAV_P_H