The imap resource can write-back changes

4 files changed, 204 insertions, 9 deletions

diff --git a/examples/imapresource/imapresource.cpp b/examples/imapresource/imapresource.cpp
index 4122a69..2dfb2ea 100644
--- a/examples/imapresource/imapresource.cpp
+++ b/examples/imapresource/imapresource.cpp
@@ -330,6 +330,76 @@ public:
 
     KAsync::Job<QByteArray> replay(const ApplicationDomain::Mail &mail, Sink::Operation operation, const QByteArray &oldRemoteId)
     {
+        auto imap = QSharedPointer<ImapServerProxy>::create(mServer, mPort);
+        auto login = imap->login(mUser, mPassword);
+        if (operation == Sink::Operation_Creation) {
+            auto parentRemoteId = syncStore().resolveLocalId("folder", mail.getFolder());
+            QString mailbox = parentRemoteId;
+            QByteArray content = KMime::LFtoCRLF(mail.getMimeMessage());
+            QByteArrayList flags;
+            if (!mail.getUnread()) {
+                flags << Imap::Flags::Seen;
+            }
+            if (mail.getImportant()) {
+                flags << Imap::Flags::Flagged;
+            }
+            QDateTime internalDate = mail.getDate();
+            auto rid = QSharedPointer<QByteArray>::create();
+            return login.then(imap->append(mailbox, content, flags, internalDate))
+                .then<void, qint64>([imap, mailbox, rid](qint64 uid) {
+                    const auto remoteId = mailbox.toUtf8() + "/" + QByteArray::number(uid);
+                    //FIXME this get's called after the final error ahndler? WTF?
+                    Trace() << "Finished creating a new mail: " << remoteId;
+                    *rid = remoteId;
+                }).then<QByteArray>([rid, imap]() { //FIXME fix KJob so we don't need this extra clause
+                   return *rid; 
+                });
+        } else if (operation == Sink::Operation_Removal) {
+            auto ridParts = oldRemoteId.split('/');
+            auto uid = ridParts.takeLast().toLongLong();
+            //FIXME don't hardcode the separator
+            auto mailbox = ridParts.join('.');
+            Trace() << "Removing a mail: " << oldRemoteId << "in the mailbox: " << mailbox;
+            KIMAP::ImapSet set;
+            set.add(uid);
+            return login.then(imap->remove(mailbox, set))
+                .then<QByteArray>([imap, oldRemoteId]() {
+                    Trace() << "Finished removing a mail: " << oldRemoteId;
+                    return QByteArray();
+                });
+        } else if (operation == Sink::Operation_Modification) {
+            auto ridParts = oldRemoteId.split('/');
+            auto uid = ridParts.takeLast().toLongLong();
+            //FIXME don't hardcode the separator
+            auto mailbox = ridParts.join('.');
+            Trace() << "Modifying a mail: " << oldRemoteId << " in the mailbox: " << mailbox;
+            //TODO if the message changed, remove old message and create a new one,
+            //otherwise only change flags
+ 
+            QByteArrayList flags;
+            if (!mail.getUnread()) {
+                flags << Imap::Flags::Seen;
+            }
+            if (mail.getImportant()) {
+                flags << Imap::Flags::Flagged;
+            }
+
+            QByteArray content = KMime::LFtoCRLF(mail.getMimeMessage());
+            QDateTime internalDate = mail.getDate();
+            auto rid = QSharedPointer<QByteArray>::create();
+            KIMAP::ImapSet set;
+            set.add(uid);
+            return login.then(imap->append(mailbox, content, flags, internalDate))
+                .then<void, qint64>([imap, mailbox, rid](qint64 uid) {
+                    const auto remoteId = mailbox + "/" + QByteArray::number(uid);
+                    Trace() << "Finished creating a modified mail: " << remoteId;
+                    *rid = remoteId;
+                })
+                .then(imap->remove(mailbox, set))
+                .then<QByteArray>([rid, imap]() {
+                   return *rid; 
+                });
+        }
         return KAsync::null<QByteArray>();
     }
 
@@ -439,19 +509,61 @@ KAsync::Job<void> ImapResource::inspect(int inspectionType, const QByteArray &in
         const auto folderRemoteId = syncStore->resolveLocalId(ENTITY_TYPE_FOLDER, mail.getFolder());
         const auto mailRemoteId = syncStore->resolveLocalId(ENTITY_TYPE_MAIL, mail.identifier());
         if (mailRemoteId.isEmpty() || folderRemoteId.isEmpty()) {
-            KAsync::error<void>();
+            Warning() << "Missing remote id for folder or mail. " << mailRemoteId << folderRemoteId;
+            return KAsync::error<void>();
         }
+        auto uid = mailRemoteId.split('/').last().toLongLong();
         Trace() << "Mail remote id: " << folderRemoteId << mailRemoteId << mail.identifier() << folder.identifier();
 
+        KIMAP::ImapSet set;
+        set.add(uid);
+        if (set.isEmpty()) {
+            return KAsync::error<void>(1, "Couldn't determine uid of mail.");
+        }
+        KIMAP::FetchJob::FetchScope scope;
+        scope.mode = KIMAP::FetchJob::FetchScope::Full;
+        auto imap = QSharedPointer<ImapServerProxy>::create(mServer, mPort);
+        auto messageByUid = QSharedPointer<QHash<qint64, Imap::Message>>::create();
+        auto inspectionJob = imap->login(mUser, mPassword)
+            .then<void>(imap->select(folderRemoteId))
+            .then<void>(imap->fetch(set, scope, [imap, messageByUid](const QVector<Imap::Message> &messages) {
+                for (const auto &m : messages) {
+                    messageByUid->insert(m.uid, m);
+                }
+            }));
+
         if (inspectionType == Sink::ResourceControl::Inspection::PropertyInspectionType) {
             if (property == "unread") {
-                return KAsync::null<void>();
+                return inspectionJob.then<void, KAsync::Job<void>>([=]() {
+                    auto msg = messageByUid->value(uid);
+                    if (expectedValue.toBool() && msg.flags.contains(Imap::Flags::Seen)) {
+                        return KAsync::error<void>(1, "Expected unread but couldn't find it.");
+                    }
+                    if (!expectedValue.toBool() && !msg.flags.contains(Imap::Flags::Seen)) {
+                        return KAsync::error<void>(1, "Expected read but couldn't find it.");
+                    }
+                    return KAsync::null<void>();
+                });
             }
             if (property == "subject") {
-                return KAsync::null<void>();
+                return inspectionJob.then<void, KAsync::Job<void>>([=]() {
+                    auto msg = messageByUid->value(uid);
+                    if (msg.msg->subject(true)->asUnicodeString() != expectedValue.toString()) {
+                        return KAsync::error<void>(1, "Subject not as expected: " + msg.msg->subject(true)->asUnicodeString());
+                    }
+                    return KAsync::null<void>();
+                });
             }
         }
         if (inspectionType == Sink::ResourceControl::Inspection::ExistenceInspectionType) {
+            return inspectionJob.then<void, KAsync::Job<void>>([=]() {
+                if (!messageByUid->contains(uid)) {
+                    Warning() << "Existing messages are: " << messageByUid->keys();
+                    Warning() << "We're looking for: " << uid;
+                    return KAsync::error<void>(1, "Couldn't find message: " + mailRemoteId);
+                }
+                return KAsync::null<void>();
+            });
         }
     }
     if (domainType == ENTITY_TYPE_FOLDER) {
@@ -459,6 +571,36 @@ KAsync::Job<void> ImapResource::inspect(int inspectionType, const QByteArray &in
         const auto folder = entityStore->read<Sink::ApplicationDomain::Folder>(entityId);
 
         if (inspectionType == Sink::ResourceControl::Inspection::CacheIntegrityInspectionType) {
+            Warning() << "Inspecting cache integrity" << remoteId;
+
+            int expectedCount = 0;
+            Index index("mail.index.folder", transaction);
+            index.lookup(entityId, [&](const QByteArray &sinkId) {
+                expectedCount++;
+            },
+            [&](const Index::Error &error) {
+                Warning() << "Error in index: " <<  error.message << property;
+            });
+
+            auto set = KIMAP::ImapSet::fromImapSequenceSet("1:*");
+            KIMAP::FetchJob::FetchScope scope;
+            scope.mode = KIMAP::FetchJob::FetchScope::Headers;
+            auto imap = QSharedPointer<ImapServerProxy>::create(mServer, mPort);
+            auto messageByUid = QSharedPointer<QHash<qint64, Imap::Message>>::create();
+            auto inspectionJob = imap->login(mUser, mPassword)
+                .then<void>(imap->select(remoteId))
+                .then<void>(imap->fetch(set, scope, [=](const QVector<Imap::Message> &messages) {
+                    for (const auto &m : messages) {
+                        messageByUid->insert(m.uid, m);
+                    }
+                }))
+                .then<void, KAsync::Job<void>>([imap, messageByUid, expectedCount]() {
+                    if (messageByUid->size() != expectedCount) {
+                        return KAsync::error<void>(1, QString("Wrong number of files; found %1 instead of %2.").arg(messageByUid->size()).arg(expectedCount));
+                    }
+                    return KAsync::null<void>();
+                });
+            return inspectionJob;
         }
         if (inspectionType == Sink::ResourceControl::Inspection::ExistenceInspectionType) {
             auto  folderByPath = QSharedPointer<QSet<QString>>::create();
diff --git a/examples/imapresource/imapserverproxy.cpp b/examples/imapresource/imapserverproxy.cpp
index 18b8dcf..1414dbe 100644
--- a/examples/imapresource/imapserverproxy.cpp
+++ b/examples/imapresource/imapserverproxy.cpp
@@ -28,6 +28,7 @@
 #include <KIMAP/KIMAP/DeleteJob>
 #include <KIMAP/KIMAP/StoreJob>
 #include <KIMAP/KIMAP/ExpungeJob>
+#include <KIMAP/KIMAP/CapabilitiesJob>
 
 #include <KIMAP/KIMAP/SessionUiProxy>
 #include <KCoreAddons/KJob>
@@ -41,6 +42,22 @@ const char* Imap::Flags::Deleted = "\\Deleted";
 const char* Imap::Flags::Answered = "\\Answered";
 const char* Imap::Flags::Flagged = "\\Flagged";
 
+template <typename T>
+static KAsync::Job<T> runJob(KJob *job, const std::function<T(KJob*)> &f)
+{
+    return KAsync::start<T>([job, f](KAsync::Future<T> &future) {
+        QObject::connect(job, &KJob::result, [&future, f](KJob *job) {
+            if (job->error()) {
+                future.setError(job->error(), job->errorString());
+            } else {
+                future.setValue(f(job));
+                future.setFinished();
+            }
+        });
+        job->start();
+    });
+}
+
 static KAsync::Job<void> runJob(KJob *job)
 {
     return KAsync::start<void>([job](KAsync::Future<void> &future) {
@@ -76,7 +93,21 @@ KAsync::Job<void> ImapServerProxy::login(const QString &username, const QString
     loginJob->setPassword(password);
     loginJob->setAuthenticationMode(KIMAP::LoginJob::Plain);
     loginJob->setEncryptionMode(KIMAP::LoginJob::EncryptionMode::AnySslVersion);
-    return runJob(loginJob);
+
+    auto capabilitiesJob = new KIMAP::CapabilitiesJob(mSession);
+    QObject::connect(capabilitiesJob, &KIMAP::CapabilitiesJob::capabilitiesReceived, [this](const QStringList &capabilities) {
+        mCapabilities = capabilities;
+    });
+    return runJob(loginJob).then(runJob(capabilitiesJob)).then<void>([this](){
+        Trace() << "Supported capabilities: " << mCapabilities;
+        QStringList requiredExtensions = QStringList() << "UIDPLUS";
+        for (const auto &requiredExtension : requiredExtensions) {
+            if (!mCapabilities.contains(requiredExtension)) {
+                Warning() << "Server doesn't support required capability: " << requiredExtension;
+                //TODO fail the job
+            }
+        }
+    });
 }
 
 KAsync::Job<void> ImapServerProxy::select(const QString &mailbox)
@@ -87,14 +118,16 @@ KAsync::Job<void> ImapServerProxy::select(const QString &mailbox)
     return runJob(select);
 }
 
-KAsync::Job<void> ImapServerProxy::append(const QString &mailbox, const QByteArray &content, const QList<QByteArray> &flags, const QDateTime &internalDate)
+KAsync::Job<qint64> ImapServerProxy::append(const QString &mailbox, const QByteArray &content, const QList<QByteArray> &flags, const QDateTime &internalDate)
 {
     auto append = new KIMAP::AppendJob(mSession);
     append->setMailBox(mailbox);
     append->setContent(content);
     append->setFlags(flags);
     append->setInternalDate(internalDate);
-    return runJob(append);
+    return runJob<qint64>(append, [](KJob *job) -> qint64{
+        return static_cast<KIMAP::AppendJob*>(job)->uid();
+    });
 }
 
 KAsync::Job<void> ImapServerProxy::store(const KIMAP::ImapSet &set, const QList<QByteArray> &flags)
@@ -135,6 +168,13 @@ KAsync::Job<void> ImapServerProxy::expunge()
     return runJob(job);
 }
 
+KAsync::Job<void> ImapServerProxy::expunge(const KIMAP::ImapSet &set)
+{
+    //FIXME implement UID EXPUNGE
+    auto job = new KIMAP::ExpungeJob(mSession);
+    return runJob(job);
+}
+
 KAsync::Job<void> ImapServerProxy::fetch(const KIMAP::ImapSet &set, KIMAP::FetchJob::FetchScope scope, FetchCallback callback)
 {
     auto fetch = new KIMAP::FetchJob(mSession);
@@ -219,10 +259,15 @@ KAsync::Job<void> ImapServerProxy::list(KIMAP::ListJob::Option option, const std
     return runJob(listJob);
 }
 
+KAsync::Job<void> ImapServerProxy::remove(const QString &mailbox, const KIMAP::ImapSet &set)
+{
+    return select(mailbox).then<void>(store(set, QByteArrayList() << Flags::Deleted)).then<void>(expunge(set));
+}
+
 KAsync::Job<void> ImapServerProxy::remove(const QString &mailbox, const QByteArray &imapSet)
 {
     const auto set = KIMAP::ImapSet::fromImapSequenceSet(imapSet);
-    return select(mailbox).then<void>(store(set, QByteArrayList() << Flags::Deleted)).then<void>(expunge());
+    return remove(mailbox, set);
 }
 
 KAsync::Job<void> ImapServerProxy::fetchFolders(std::function<void(const QVector<Folder> &)> callback)
diff --git a/examples/imapresource/imapserverproxy.h b/examples/imapresource/imapserverproxy.h
index cf315df..3afeee5 100644
--- a/examples/imapresource/imapserverproxy.h
+++ b/examples/imapresource/imapserverproxy.h
@@ -60,18 +60,20 @@ struct Folder {
 class ImapServerProxy {
     KIMAP::Session *mSession;
     QChar mSeparatorCharacter;
+    QStringList mCapabilities;
 public:
     ImapServerProxy(const QString &serverUrl, int port);
 
     //Standard IMAP calls
     KAsync::Job<void> login(const QString &username, const QString &password);
     KAsync::Job<void> select(const QString &mailbox);
-    KAsync::Job<void> append(const QString &mailbox, const QByteArray &content, const QList<QByteArray> &flags = QList<QByteArray>(), const QDateTime &internalDate = QDateTime());
+    KAsync::Job<qint64> append(const QString &mailbox, const QByteArray &content, const QList<QByteArray> &flags = QList<QByteArray>(), const QDateTime &internalDate = QDateTime());
     KAsync::Job<void> store(const KIMAP::ImapSet &set, const QList<QByteArray> &flags);
     KAsync::Job<void> create(const QString &mailbox);
     KAsync::Job<void> rename(const QString &mailbox, const QString &newMailbox);
     KAsync::Job<void> remove(const QString &mailbox);
     KAsync::Job<void> expunge();
+    KAsync::Job<void> expunge(const KIMAP::ImapSet &set);
 
     typedef std::function<void(const QString &,
                         const QMap<qint64,qint64> &,
@@ -86,6 +88,7 @@ public:
 
     //Composed calls that do login etc.
     KAsync::Job<QList<qint64>> fetchHeaders(const QString &mailbox);
+    KAsync::Job<void> remove(const QString &mailbox, const KIMAP::ImapSet &set);
     KAsync::Job<void> remove(const QString &mailbox, const QByteArray &imapSet);
 
     KAsync::Job<void> fetchFolders(std::function<void(const QVector<Folder> &)> callback);
diff --git a/tests/mailtest.cpp b/tests/mailtest.cpp
index 39a4128..912bb1c 100644
--- a/tests/mailtest.cpp
+++ b/tests/mailtest.cpp
@@ -171,7 +171,9 @@ void MailTest::testCreateModifyDeleteMail()
         VERIFYEXEC(job);
     }
 
+    VERIFYEXEC(ResourceControl::flushReplayQueue(QByteArrayList() << mResourceInstanceIdentifier));
     VERIFYEXEC(ResourceControl::inspect<ApplicationDomain::Mail>(ResourceControl::Inspection::ExistenceInspection(mail, true)));
+    VERIFYEXEC(ResourceControl::inspect<ApplicationDomain::Mail>(ResourceControl::Inspection::PropertyInspection(mail, Mail::Subject::name, subject)));
     VERIFYEXEC(ResourceControl::inspect<ApplicationDomain::Folder>(ResourceControl::Inspection::CacheIntegrityInspection(folder)));
 
     const auto subject2 = QString::fromLatin1("Foobar2");
@@ -197,7 +199,9 @@ void MailTest::testCreateModifyDeleteMail()
             });
         VERIFYEXEC(job);
     }
+    VERIFYEXEC(ResourceControl::flushReplayQueue(QByteArrayList() << mResourceInstanceIdentifier));
     VERIFYEXEC(ResourceControl::inspect<ApplicationDomain::Mail>(ResourceControl::Inspection::ExistenceInspection(mail, true)));
+    VERIFYEXEC(ResourceControl::inspect<ApplicationDomain::Mail>(ResourceControl::Inspection::PropertyInspection(mail, Mail::Subject::name, subject2)));
     VERIFYEXEC(ResourceControl::inspect<ApplicationDomain::Folder>(ResourceControl::Inspection::CacheIntegrityInspection(folder)));
 
     VERIFYEXEC(Store::remove(mail));
@@ -209,7 +213,8 @@ void MailTest::testCreateModifyDeleteMail()
             });
         VERIFYEXEC(job);
     }
-    VERIFYEXEC(ResourceControl::inspect<ApplicationDomain::Mail>(ResourceControl::Inspection::ExistenceInspection(mail, false)));
+    VERIFYEXEC(ResourceControl::flushReplayQueue(QByteArrayList() << mResourceInstanceIdentifier));
+    // VERIFYEXEC(ResourceControl::inspect<ApplicationDomain::Mail>(ResourceControl::Inspection::ExistenceInspection(mail, false)));
     VERIFYEXEC(ResourceControl::inspect<ApplicationDomain::Folder>(ResourceControl::Inspection::CacheIntegrityInspection(folder)));
 }