File indexing completed on 2024-11-24 04:44:13

 /*
  * SPDX-FileCopyrightText: 2012 Christian Mollekopf <mollekopf@kolabsys.com>
  *
  * SPDX-License-Identifier: LGPL-3.0-or-later
  */
 
 #pragma once
 
 #include "kolab_export.h"
 
 #include <Akonadi/Item>
 #include <Akonadi/Relation>
 #include <Akonadi/Tag>
 #include <KCalendarCore/Event>
 #include <KCalendarCore/Incidence>
 #include <KCalendarCore/Journal>
 #include <KCalendarCore/Todo>
 #include <KContacts/Addressee>
 #include <KContacts/ContactGroup>
 #include <KMime/Message>
 
 #include "kolabdefinitions.h"
 
 #include <memory>
 
 namespace Kolab
 {
 class Freebusy;
 
 KOLAB_EXPORT KCalendarCore::Event::Ptr readV2EventXML(const QByteArray &xmlData, QStringList &attachments);
 
 struct KOLAB_EXPORT RelationMember {
     QString messageId;
     QString subject;
     QString date;
     QList<QByteArray> mailbox;
     QString user;
     qint64 uid;
     QString gid;
 };
 KOLAB_EXPORT RelationMember parseMemberUrl(const QString &url);
 KOLAB_EXPORT QString generateMemberUrl(const RelationMember &url);
 
 class KolabObjectReaderPrivate;
 
 /**
  * Class to read Kolab Mime files
  *
  * It implements the Kolab specifics of Mime message handling.
  * This class is not reusable and only meant to read a single object.
  * Parse the mime message and then call the correct getter, based on the type
  *
  */
 class KOLAB_EXPORT KolabObjectReader
 {
 public:
     KolabObjectReader();
     explicit KolabObjectReader(const KMime::Message::Ptr &msg);
     ~KolabObjectReader();
 
     ObjectType parseMimeMessage(const KMime::Message::Ptr &msg);
 
     /**
      * Set to override the autodetected object type, before parsing the message.
      */
     void setObjectType(ObjectType);
 
     /**
      * Set to override the autodetected version, before parsing the message.
      */
     void setVersion(Version);
 
     /**
      * Returns the Object type of the parsed kolab object.
      */
     ObjectType getType() const;
     /**
      * Returns the kolab-format version of the parsed kolab object.
      */
     Version getVersion() const;
 
     /**
      * Getter to get the retrieved object.
      * Only the correct one will return a valid object.
      *
      * Use getType() to determine the correct one to call.
      */
     KCalendarCore::Event::Ptr getEvent() const;
     KCalendarCore::Todo::Ptr getTodo() const;
     KCalendarCore::Journal::Ptr getJournal() const;
     KCalendarCore::Incidence::Ptr getIncidence() const;
     KContacts::Addressee getContact() const;
     KContacts::ContactGroup getDistlist() const;
     KMime::Message::Ptr getNote() const;
     QStringList getDictionary(QString &lang) const;
     Freebusy getFreebusy() const;
     bool isTag() const;
     Akonadi::Tag getTag() const;
     QStringList getTagMembers() const;
     bool isRelation() const;
     Akonadi::Relation getRelation() const;
 
 private:
     //@cond PRIVATE
     KolabObjectReader(const KolabObjectReader &other) = delete;
     KolabObjectReader &operator=(const KolabObjectReader &rhs) = delete;
 
 private:
     std::unique_ptr<KolabObjectReaderPrivate> const d;
     //@endcond
 };
 
 /**
  * Class to write Kolab Mime files
  *
  */
 class KOLAB_EXPORT KolabObjectWriter
 {
 public:
     static KMime::Message::Ptr
     writeEvent(const KCalendarCore::Event::Ptr &, Version v = KolabV3, const QString &productId = QString(), const QString &tz = QString());
     static KMime::Message::Ptr
     writeTodo(const KCalendarCore::Todo::Ptr &, Version v = KolabV3, const QString &productId = QString(), const QString &tz = QString());
     static KMime::Message::Ptr
     writeJournal(const KCalendarCore::Journal::Ptr &, Version v = KolabV3, const QString &productId = QString(), const QString &tz = QString());
     static KMime::Message::Ptr
     writeIncidence(const KCalendarCore::Incidence::Ptr &, Version v = KolabV3, const QString &productId = QString(), const QString &tz = QString());
     static KMime::Message::Ptr writeContact(const KContacts::Addressee &, Version v = KolabV3, const QString &productId = QString());
     static KMime::Message::Ptr writeDistlist(const KContacts::ContactGroup &, Version v = KolabV3, const QString &productId = QString());
     static KMime::Message::Ptr writeNote(const KMime::Message::Ptr &, Version v = KolabV3, const QString &productId = QString());
     static KMime::Message::Ptr writeDictionary(const QStringList &, const QString &lang, Version v = KolabV3, const QString &productId = QString());
     static KMime::Message::Ptr writeFreebusy(const Kolab::Freebusy &, Version v = KolabV3, const QString &productId = QString());
     static KMime::Message::Ptr writeTag(const Akonadi::Tag &, const QStringList &items, Version v = KolabV3, const QString &productId = QString());
     static KMime::Message::Ptr writeRelation(const Akonadi::Relation &, const QStringList &items, Version v = KolabV3, const QString &productId = QString());
 };
 } // Namespace