Major refactor of item handling code

The new implementation moves all actions specific to item type into a dedicated set of classes. This way the core resource code is generic and doesn't have to worry about type-specific actions.
KrissN · Feb 1, 2016 · c60be7f · c60be7f
1 parent a01edaf
commit c60be7f
Show file tree

Hide file tree

Showing 34 changed files with 1,310 additions and 216 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -52,12 +52,24 @@ include_directories(${CMAKE_CURRENT_SOURCE_DIR}/ewsclient)
 add_definitions(-DTRANSLATION_DOMAIN=\"akonadi_ews_resource\")
 
 set(ewsresource_SRCS
+    calendar/ewscalendarhandler.cpp
+    calendar/ewsfetchcalendardetailjob.cpp
+    calendar/ewsmodifycalendarjob.cpp
+    contact/ewscontacthandler.cpp
+    contact/ewsfetchcontactdetailjob.cpp
+    contact/ewsmodifycontactjob.cpp
+    mail/ewsfetchmaildetailjob.cpp
+    mail/ewsmailhandler.cpp
+    mail/ewsmodifymailjob.cpp
+    task/ewsfetchtaskdetailjob.cpp
+    task/ewsmodifytaskjob.cpp
+    task/ewstaskhandler.cpp
     configdialog.cpp
     ewsfetchfoldersjob.cpp
     ewsfetchitemsjob.cpp
     ewsfetchitemdetailjob.cpp
-    ewsfetchmaildetailjob.cpp
-    ewsfetchcalendardetailjob.cpp
+    ewsitemhandler.cpp
+    ewsmodifyitemjob.cpp
     ewsresource.cpp
     ewssubscriptionmanager.cpp)
 

diff --git a/calendar/ewscalendarhandler.cpp b/calendar/ewscalendarhandler.cpp
@@ -0,0 +1,73 @@
+/*  This file is part of Akonadi EWS Resource
+    Copyright (C) 2015-2016 Krzysztof Nowicki <krissn@op.pl>
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Library General Public
+    License as published by the Free Software Foundation; either
+    version 2 of the License, or (at your option) any later version.
+
+    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
+    Library General Public License for more details.
+
+    You should have received a copy of the GNU Library General Public License
+    along with this library; see the file COPYING.LIB.  If not, write to
+    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+    Boston, MA 02110-1301, USA.
+*/
+
+#include "ewscalendarhandler.h"
+
+#include <KCalCore/Event>
+
+#include "ewsfetchcalendardetailjob.h"
+#include "ewsmodifycalendarjob.h"
+
+using namespace Akonadi;
+
+EwsCalendarHandler::EwsCalendarHandler()
+{
+}
+
+EwsCalendarHandler::~EwsCalendarHandler()
+{
+}
+
+EwsItemHandler *EwsCalendarHandler::factory()
+{
+    return new EwsCalendarHandler();
+}
+
+EwsFetchItemDetailJob *EwsCalendarHandler::fetchItemDetailJob(EwsClient &client, QObject *parent,
+                                                          const Akonadi::Collection &collection)
+{
+    return new EwsFetchCalendarDetailJob(client, parent, collection);
+}
+
+void EwsCalendarHandler::setSeenFlag(Item &item, bool value)
+{
+    Q_UNUSED(item)
+    Q_UNUSED(value)
+}
+
+QString EwsCalendarHandler::mimeType()
+{
+    return KCalCore::Event::eventMimeType();
+}
+
+bool EwsCalendarHandler::setItemPayload(Akonadi::Item &item, const EwsItem &ewsItem)
+{
+    Q_UNUSED(item)
+    Q_UNUSED(ewsItem)
+
+    return true;
+}
+
+EwsModifyItemJob *EwsCalendarHandler::modifyItemJob(EwsClient& client, const Akonadi::Item &item,
+                                                    const QSet<QByteArray> &parts, QObject *parent)
+{
+    return new EwsModifyCalendarJob(client, item, parts, parent);
+}
+
+EWS_DECLARE_ITEM_HANDLER(EwsCalendarHandler, EwsItemTypeCalendarItem)
diff --git a/calendar/ewscalendarhandler.h b/calendar/ewscalendarhandler.h
@@ -0,0 +1,43 @@
+/*  This file is part of Akonadi EWS Resource
+    Copyright (C) 2015-2016 Krzysztof Nowicki <krissn@op.pl>
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Library General Public
+    License as published by the Free Software Foundation; either
+    version 2 of the License, or (at your option) any later version.
+
+    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
+    Library General Public License for more details.
+
+    You should have received a copy of the GNU Library General Public License
+    along with this library; see the file COPYING.LIB.  If not, write to
+    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+    Boston, MA 02110-1301, USA.
+*/
+
+#ifndef EWSCALENDARHANDLER_H
+#define EWSCALENDARHANDLER_H
+
+#include "ewsitemhandler.h"
+
+class EwsCalendarHandler : public EwsItemHandler
+{
+public:
+    EwsCalendarHandler();
+    virtual ~EwsCalendarHandler();
+
+    virtual EwsFetchItemDetailJob *fetchItemDetailJob(EwsClient &client, QObject *parent,
+                                                      const Akonadi::Collection &collection) Q_DECL_OVERRIDE;
+    virtual void setSeenFlag(Akonadi::Item &item, bool value) Q_DECL_OVERRIDE;
+    virtual QString mimeType() Q_DECL_OVERRIDE;
+    virtual bool setItemPayload(Akonadi::Item &item, const EwsItem &ewsItem) Q_DECL_OVERRIDE;
+    virtual EwsModifyItemJob *modifyItemJob(EwsClient& client, const Akonadi::Item &item,
+                                            const QSet<QByteArray> &parts, QObject *parent) Q_DECL_OVERRIDE;
+
+    static EwsItemHandler *factory();
+private:
+};
+
+#endif
diff --git a/ewsfetchcalendardetailjob.cpp → calendar/ewsfetchcalendardetailjob.cpp b/ewsfetchcalendardetailjob.cpp → calendar/ewsfetchcalendardetailjob.cpp
@@ -236,12 +236,6 @@ void EwsFetchCalendarDetailJob::exceptionItemsFetched(KJob *job)
     emitResult();
 }
 
-EwsFetchItemDetailJob *EwsFetchCalendarDetailJob::factory(EwsClient &client, QObject *parent,
-                                                          const Akonadi::Collection &collection)
-{
-    return new EwsFetchCalendarDetailJob(client, parent, collection);
-}
-
 /*
  *  This method does its best to convert the timezone found in the EWS calendar event to a IANA
  *  timezone. This is a cumbersome process as there is no guarantee that the
@@ -301,5 +295,3 @@ void EwsFetchCalendarDetailJob::convertTimezone(KDateTime &currentTime, QString
 
     currentTime = resultDt;
 }
-
-EWS_DECLARE_FETCH_ITEM_DETAIL_JOB(EwsFetchCalendarDetailJob, EwsItemTypeCalendarItem)
diff --git a/ewsfetchcalendardetailjob.h → calendar/ewsfetchcalendardetailjob.h b/ewsfetchcalendardetailjob.h → calendar/ewsfetchcalendardetailjob.h
@@ -30,7 +30,6 @@ class EwsFetchCalendarDetailJob : public EwsFetchItemDetailJob
 public:
     EwsFetchCalendarDetailJob(EwsClient &client, QObject *parent, const Akonadi::Collection &collection);
     virtual ~EwsFetchCalendarDetailJob();
-    static EwsFetchItemDetailJob *factory(EwsClient &client, QObject *parent, const Akonadi::Collection &collection);
 protected:
     virtual void processItems(const QList<EwsGetItemRequest::Response> &responses) Q_DECL_OVERRIDE;
     void convertTimezone(KDateTime &currentTime, QString msTimezone, QString culture);

diff --git a/calendar/ewsmodifycalendarjob.cpp b/calendar/ewsmodifycalendarjob.cpp
@@ -0,0 +1,37 @@
+/*  This file is part of Akonadi EWS Resource
+    Copyright (C) 2015-2016 Krzysztof Nowicki <krissn@op.pl>
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Library General Public
+    License as published by the Free Software Foundation; either
+    version 2 of the License, or (at your option) any later version.
+
+    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
+    Library General Public License for more details.
+
+    You should have received a copy of the GNU Library General Public License
+    along with this library; see the file COPYING.LIB.  If not, write to
+    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+    Boston, MA 02110-1301, USA.
+*/
+
+#include "ewsmodifycalendarjob.h"
+
+#include "ewsclient_debug.h"
+
+EwsModifyCalendarJob::EwsModifyCalendarJob(EwsClient& client, const Akonadi::Item &item,
+                                           const QSet<QByteArray> &parts, QObject *parent)
+    : EwsModifyItemJob(client, item, parts, parent)
+{
+}
+EwsModifyCalendarJob::~EwsModifyCalendarJob()
+{
+}
+
+void EwsModifyCalendarJob::start()
+{
+    qCWarning(EWSRES_LOG) << QStringLiteral("Calendar item modification not implemented!");
+    emitResult();
+}
diff --git a/calendar/ewsmodifycalendarjob.h b/calendar/ewsmodifycalendarjob.h
@@ -0,0 +1,35 @@
+/*  This file is part of Akonadi EWS Resource
+    Copyright (C) 2015-2016 Krzysztof Nowicki <krissn@op.pl>
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Library General Public
+    License as published by the Free Software Foundation; either
+    version 2 of the License, or (at your option) any later version.
+
+    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
+    Library General Public License for more details.
+
+    You should have received a copy of the GNU Library General Public License
+    along with this library; see the file COPYING.LIB.  If not, write to
+    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+    Boston, MA 02110-1301, USA.
+*/
+
+#ifndef EWSMODIFYCALENDARJOB_H
+#define EWSMODIFYCALENDARJOB_H
+
+#include "ewsmodifyitemjob.h"
+
+class EwsModifyCalendarJob : public EwsModifyItemJob
+{
+    Q_OBJECT
+public:
+    EwsModifyCalendarJob(EwsClient& client, const Akonadi::Item &item, const QSet<QByteArray> &parts,
+                         QObject *parent);
+    virtual ~EwsModifyCalendarJob();
+    virtual void start() Q_DECL_OVERRIDE;
+};
+
+#endif
diff --git a/contact/ewscontacthandler.cpp b/contact/ewscontacthandler.cpp
@@ -0,0 +1,74 @@
+/*  This file is part of Akonadi EWS Resource
+    Copyright (C) 2015-2016 Krzysztof Nowicki <krissn@op.pl>
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Library General Public
+    License as published by the Free Software Foundation; either
+    version 2 of the License, or (at your option) any later version.
+
+    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
+    Library General Public License for more details.
+
+    You should have received a copy of the GNU Library General Public License
+    along with this library; see the file COPYING.LIB.  If not, write to
+    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+    Boston, MA 02110-1301, USA.
+*/
+
+#include "ewscontacthandler.h"
+
+#include <KContacts/Addressee>
+#include <KContacts/ContactGroup>
+
+#include "ewsfetchcontactdetailjob.h"
+#include "ewsmodifycontactjob.h"
+
+using namespace Akonadi;
+
+EwsContactHandler::EwsContactHandler()
+{
+}
+
+EwsContactHandler::~EwsContactHandler()
+{
+}
+
+EwsItemHandler *EwsContactHandler::factory()
+{
+    return new EwsContactHandler();
+}
+
+EwsFetchItemDetailJob *EwsContactHandler::fetchItemDetailJob(EwsClient &client, QObject *parent,
+                                                             const Akonadi::Collection &collection)
+{
+    return new EwsFetchContactDetailJob(client, parent, collection);
+}
+
+void EwsContactHandler::setSeenFlag(Item &item, bool value)
+{
+    Q_UNUSED(item)
+    Q_UNUSED(value)
+}
+
+QString EwsContactHandler::mimeType()
+{
+    return KContacts::Addressee::mimeType();
+}
+
+bool EwsContactHandler::setItemPayload(Akonadi::Item &item, const EwsItem &ewsItem)
+{
+    Q_UNUSED(item)
+    Q_UNUSED(ewsItem)
+
+    return true;
+}
+
+EwsModifyItemJob *EwsContactHandler::modifyItemJob(EwsClient& client, const Akonadi::Item &item,
+                                                   const QSet<QByteArray> &parts, QObject *parent)
+{
+    return new EwsModifyContactJob(client, item, parts, parent);
+}
+
+EWS_DECLARE_ITEM_HANDLER(EwsContactHandler, EwsItemTypeTask)
diff --git a/contact/ewscontacthandler.h b/contact/ewscontacthandler.h
@@ -0,0 +1,43 @@
+/*  This file is part of Akonadi EWS Resource
+    Copyright (C) 2015-2016 Krzysztof Nowicki <krissn@op.pl>
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Library General Public
+    License as published by the Free Software Foundation; either
+    version 2 of the License, or (at your option) any later version.
+
+    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
+    Library General Public License for more details.
+
+    You should have received a copy of the GNU Library General Public License
+    along with this library; see the file COPYING.LIB.  If not, write to
+    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+    Boston, MA 02110-1301, USA.
+*/
+
+#ifndef EWSCONTACTHANDLER_H
+#define EWSCONTACTHANDLER_H
+
+#include "ewsitemhandler.h"
+
+class EwsContactHandler : public EwsItemHandler
+{
+public:
+    EwsContactHandler();
+    virtual ~EwsContactHandler();
+
+    virtual EwsFetchItemDetailJob *fetchItemDetailJob(EwsClient &client, QObject *parent,
+                                                      const Akonadi::Collection &collection) Q_DECL_OVERRIDE;
+    virtual void setSeenFlag(Akonadi::Item &item, bool value) Q_DECL_OVERRIDE;
+    virtual QString mimeType() Q_DECL_OVERRIDE;
+    virtual bool setItemPayload(Akonadi::Item &item, const EwsItem &ewsItem) Q_DECL_OVERRIDE;
+    virtual EwsModifyItemJob *modifyItemJob(EwsClient& client, const Akonadi::Item &item,
+                                            const QSet<QByteArray> &parts, QObject *parent) Q_DECL_OVERRIDE;
+
+    static EwsItemHandler *factory();
+private:
+};
+
+#endif