Support for folder hierarchies

7 files changed, 93 insertions, 30 deletions

diff --git a/examples/imapresource/imapresource.cpp b/examples/imapresource/imapresource.cpp
index baa88b9..49cbb20 100644
--- a/examples/imapresource/imapresource.cpp
+++ b/examples/imapresource/imapresource.cpp
@@ -49,6 +49,7 @@
 #undef DEBUG_AREA
 #define DEBUG_AREA "resource.imap"
 
+using namespace Imap;
 
 ImapResource::ImapResource(const QByteArray &instanceIdentifier, const QSharedPointer<Sink::Pipeline> &pipeline)
     : Sink::GenericResource(instanceIdentifier, pipeline),
@@ -71,20 +72,22 @@ QByteArray ImapResource::createFolder(const QString &folderPath, const QByteArra
     auto remoteId = folderPath.toUtf8();
     auto bufferType = ENTITY_TYPE_FOLDER;
     Sink::ApplicationDomain::Folder folder;
-    folder.setProperty("name", folderPath.split('/').last());
+    auto folderPathParts = folderPath.split('/');
+    const auto name = folderPathParts.takeLast();
+    folder.setProperty("name", name);
     folder.setProperty("icon", icon);
 
-    // if (!md.isRoot()) {
-    //     folder.setProperty("parent", resolveRemoteId(ENTITY_TYPE_FOLDER, md.parent().path().toUtf8(), synchronizationTransaction));
-    // }
+    if (!folderPathParts.isEmpty()) {
+        folder.setProperty("parent", resolveRemoteId(ENTITY_TYPE_FOLDER, folderPathParts.join('/').toUtf8(), synchronizationTransaction));
+    }
     createOrModify(transaction, synchronizationTransaction, *mFolderAdaptorFactory, bufferType, remoteId, folder);
     return remoteId;
 }
 
-void ImapResource::synchronizeFolders(const QStringList &folderList, Sink::Storage::Transaction &transaction, Sink::Storage::Transaction &synchronizationTransaction)
+void ImapResource::synchronizeFolders(const QVector<Folder> &folderList, Sink::Storage::Transaction &transaction, Sink::Storage::Transaction &synchronizationTransaction)
 {
     const QByteArray bufferType = ENTITY_TYPE_FOLDER;
-    Trace() << "Found folders " << folderList;
+    Trace() << "Found folders " << folderList.size();
 
     scanForRemovals(transaction, synchronizationTransaction, bufferType,
         [&bufferType, &transaction](const std::function<void(const QByteArray &)> &callback) {
@@ -99,12 +102,18 @@ void ImapResource::synchronizeFolders(const QStringList &folderList, Sink::Stora
             });
         },
         [&folderList](const QByteArray &remoteId) -> bool {
-            return folderList.contains(remoteId);
+            //folderList.contains(remoteId)
+            for (const auto folderPath : folderList) {
+                if (folderPath.pathParts.join('/') == remoteId) {
+                    return true;
+                }
+            }
+            return false;
         }
     );
 
     for (const auto folderPath : folderList) {
-        createFolder(folderPath, "folder", transaction, synchronizationTransaction);
+        createFolder(folderPath.pathParts.join('/'), "folder", transaction, synchronizationTransaction);
     }
 }
 
@@ -176,9 +185,8 @@ KAsync::Job<void> ImapResource::synchronizeWithSource(Sink::Storage &mainStore,
     Log() << " Synchronizing";
     return KAsync::start<void>([this, &mainStore, &synchronizationStore](KAsync::Future<void> future) {
         ImapServerProxy imap(mServer, mPort);
-        QStringList folderList;
-        // QList<KAsync::Future<void>> waitCondition;
-        auto folderFuture = imap.fetchFolders([this, &imap, &mainStore, &synchronizationStore, &folderList](const QStringList &folders) {
+        QVector<Folder> folderList;
+        auto folderFuture = imap.fetchFolders([this, &imap, &mainStore, &synchronizationStore, &folderList](const QVector<Folder> &folders) {
             auto transaction = mainStore.createTransaction(Sink::Storage::ReadOnly);
             auto syncTransaction = synchronizationStore.createTransaction(Sink::Storage::ReadWrite);
             synchronizeFolders(folders, transaction, syncTransaction);
@@ -215,16 +223,17 @@ KAsync::Job<void> ImapResource::synchronizeWithSource(Sink::Storage &mainStore,
             auto messagesFuture = imap.fetchMessages(folder, [this, &mainStore, &synchronizationStore, folder](const QVector<Message> &messages) {
                 auto transaction = mainStore.createTransaction(Sink::Storage::ReadOnly);
                 auto syncTransaction = synchronizationStore.createTransaction(Sink::Storage::ReadWrite);
-                Trace() << "Synchronizing mails" << folder;
-                synchronizeMails(transaction, syncTransaction, folder, messages);
+                Trace() << "Synchronizing mails" << folder.pathParts.join('/');
+                synchronizeMails(transaction, syncTransaction, folder.pathParts.join('/'), messages);
                 transaction.commit();
                 syncTransaction.commit();
             });
             messagesFuture.waitForFinished();
             if (messagesFuture.errorCode()) {
-                future.setError(1, "Folder sync failed: " + folder);
+                future.setError(1, "Folder sync failed: " + folder.pathParts.join('/'));
                 return;
             }
+            Trace() << "Folder synchronized: " << folder.pathParts.join('/');
         }
 
 
diff --git a/examples/imapresource/imapresource.h b/examples/imapresource/imapresource.h
index 6fe15dd..23b7e1a 100644
--- a/examples/imapresource/imapresource.h
+++ b/examples/imapresource/imapresource.h
@@ -30,7 +30,11 @@
 
 class ImapMailAdaptorFactory;
 class ImapFolderAdaptorFactory;
+
+namespace Imap {
 struct Message;
+struct Folder;
+}
 
 /**
  * An imap resource.
@@ -46,8 +50,8 @@ private:
     KAsync::Job<void> replay(Sink::Storage &synchronizationStore, const QByteArray &type, const QByteArray &key, const QByteArray &value) Q_DECL_OVERRIDE;
 
     QByteArray createFolder(const QString &folderPath, const QByteArray &icon, Sink::Storage::Transaction &transaction, Sink::Storage::Transaction &synchronizationTransaction);
-    void synchronizeFolders(const QStringList &folderList, Sink::Storage::Transaction &transaction, Sink::Storage::Transaction &synchronizationTransaction);
-    void synchronizeMails(Sink::Storage::Transaction &transaction, Sink::Storage::Transaction &synchronizationTransaction, const QString &path, const QVector<Message> &messages);
+    void synchronizeFolders(const QVector<Imap::Folder> &folderList, Sink::Storage::Transaction &transaction, Sink::Storage::Transaction &synchronizationTransaction);
+    void synchronizeMails(Sink::Storage::Transaction &transaction, Sink::Storage::Transaction &synchronizationTransaction, const QString &path, const QVector<Imap::Message> &messages);
 
     QSharedPointer<ImapMailAdaptorFactory> mMailAdaptorFactory;
     QSharedPointer<ImapFolderAdaptorFactory> mFolderAdaptorFactory;
diff --git a/examples/imapresource/imapserverproxy.cpp b/examples/imapresource/imapserverproxy.cpp
index 9630096..836a9bc 100644
--- a/examples/imapresource/imapserverproxy.cpp
+++ b/examples/imapresource/imapserverproxy.cpp
@@ -23,12 +23,15 @@
 #include <KIMAP/KIMAP/LoginJob>
 #include <KIMAP/KIMAP/SelectJob>
 #include <KIMAP/KIMAP/AppendJob>
+#include <KIMAP/KIMAP/CreateJob>
 
 #include <KIMAP/KIMAP/SessionUiProxy>
 #include <KCoreAddons/KJob>
 
 #include "log.h"
 
+using namespace Imap;
+
 static KAsync::Job<void> runJob(KJob *job)
 {
     return KAsync::start<void>([job](KAsync::Future<void> &future) {
@@ -94,6 +97,16 @@ KAsync::Job<void> ImapServerProxy::append(const QString &mailbox, const QByteArr
     return runJob(append);
 }
 
+KAsync::Job<void> ImapServerProxy::create(const QString &mailbox)
+{
+    if (mSession->state() == KIMAP::Session::State::Disconnected) {
+        return KAsync::error<void>(1, "Not connected");
+    }
+    auto create = new KIMAP::CreateJob(mSession);
+    create->setMailBox(mailbox);
+    return runJob(create);
+}
+
 KAsync::Job<void> ImapServerProxy::fetch(const KIMAP::ImapSet &set, KIMAP::FetchJob::FetchScope scope, FetchCallback callback)
 {
     if (mSession->state() == KIMAP::Session::State::Disconnected) {
@@ -154,14 +167,14 @@ KAsync::Job<void> ImapServerProxy::list(KIMAP::ListJob::Option option, const std
     return runJob(listJob);
 }
 
-KAsync::Future<void> ImapServerProxy::fetchFolders(std::function<void(const QStringList &)> callback)
+KAsync::Future<void> ImapServerProxy::fetchFolders(std::function<void(const QVector<Folder> &)> callback)
 {
     Trace() << "Fetching folders";
     auto job =  login("doe", "doe").then<void>(list(KIMAP::ListJob::IncludeUnsubscribed, [callback](const QList<KIMAP::MailBoxDescriptor> &mailboxes, const QList<QList<QByteArray> > &flags){
-        QStringList list;
+        QVector<Folder> list;
         for (const auto &mailbox : mailboxes) {
             Trace() << "Found mailbox: " << mailbox.name;
-            list << mailbox.name;
+            list << Folder{mailbox.name.split(mailbox.separator)};
         }
         callback(list);
     }),
@@ -171,10 +184,11 @@ KAsync::Future<void> ImapServerProxy::fetchFolders(std::function<void(const QStr
     return job.exec();
 }
 
-KAsync::Future<void> ImapServerProxy::fetchMessages(const QString &folder, std::function<void(const QVector<Message> &)> callback)
+KAsync::Future<void> ImapServerProxy::fetchMessages(const Folder &folder, std::function<void(const QVector<Message> &)> callback)
 {
-    auto job = login("doe", "doe").then<void>(select(folder)).then<void, KAsync::Job<void>>([this, callback, folder]() -> KAsync::Job<void> {
-        return fetchHeaders(folder).then<void, KAsync::Job<void>, QList<qint64>>([this, callback](const QList<qint64> &uidsToFetch){
+    //TODO use the right separator
+    auto job = login("doe", "doe").then<void>(select(folder.pathParts.join('.'))).then<void, KAsync::Job<void>>([this, callback, folder]() -> KAsync::Job<void> {
+        return fetchHeaders(folder.pathParts.join('.')).then<void, KAsync::Job<void>, QList<qint64>>([this, callback](const QList<qint64> &uidsToFetch){
             Trace() << "Uids to fetch: " << uidsToFetch;
             if (uidsToFetch.isEmpty()) {
                 Trace() << "Nothing to fetch";
diff --git a/examples/imapresource/imapserverproxy.h b/examples/imapresource/imapserverproxy.h
index 2beb28c..475a45d 100644
--- a/examples/imapresource/imapserverproxy.h
+++ b/examples/imapresource/imapserverproxy.h
@@ -26,6 +26,8 @@
 #include <KIMAP/KIMAP/Session>
 #include <KIMAP/KIMAP/FetchJob>
 
+namespace Imap {
+
 struct Message {
     qint64 uid;
     qint64 size;
@@ -34,6 +36,10 @@ struct Message {
     KMime::Message::Ptr msg;
 };
 
+struct Folder {
+    QList<QString> pathParts;
+};
+
 class ImapServerProxy {
     KIMAP::Session *mSession;
 public:
@@ -43,6 +49,7 @@ public:
     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<void> create(const QString &mailbox);
 
     typedef std::function<void(const QString &,
                         const QMap<qint64,qint64> &,
@@ -57,6 +64,8 @@ public:
     //Composed calls that do login etc.
     KAsync::Job<QList<qint64>> fetchHeaders(const QString &mailbox);
 
-    KAsync::Future<void> fetchFolders(std::function<void(const QStringList &)> callback);
-    KAsync::Future<void> fetchMessages(const QString &folder, std::function<void(const QVector<Message> &)> callback);
+    KAsync::Future<void> fetchFolders(std::function<void(const QVector<Folder> &)> callback);
+    KAsync::Future<void> fetchMessages(const Folder &folder, std::function<void(const QVector<Message> &)> callback);
 };
+
+}
diff --git a/examples/imapresource/tests/imapresourcetest.cpp b/examples/imapresource/tests/imapresourcetest.cpp
index d8fc46e..8ce32c2 100644
--- a/examples/imapresource/tests/imapresourcetest.cpp
+++ b/examples/imapresource/tests/imapresourcetest.cpp
@@ -100,7 +100,32 @@ private slots:
                 names << folder->getName();
             }
             QVERIFY(names.contains("INBOX"));
-            QVERIFY(names.contains("INBOX.test"));
+            QVERIFY(names.contains("test"));
+        });
+        VERIFYEXEC(job);
+    }
+
+    void testListFolderHierarchy()
+    {
+        Sink::Query query;
+        query.resources << "org.kde.imap.instance1";
+        query.request<Folder::Name>().request<Folder::Parent>();
+
+        Imap::ImapServerProxy imap("localhost", 993);
+        VERIFYEXEC(imap.login("doe", "doe"));
+        VERIFYEXEC(imap.create("INBOX.test.sub"));
+
+        // Ensure all local data is processed
+        VERIFYEXEC(Store::synchronize(query));
+        ResourceControl::flushMessageQueue(query.resources).exec().waitForFinished();
+
+        auto job = Store::fetchAll<Folder>(query).then<void, QList<Folder::Ptr>>([](const QList<Folder::Ptr> &folders) {
+            QCOMPARE(folders.size(), 3);
+            QHash<QString, Folder::Ptr> map;
+            for (const auto &folder : folders) {
+                map.insert(folder->getName(), folder);
+            }
+            QCOMPARE(map.value("sub")->getParent(), map.value("test")->identifier());
         });
         VERIFYEXEC(job);
     }
diff --git a/examples/imapresource/tests/imapserverproxytest.cpp b/examples/imapresource/tests/imapserverproxytest.cpp
index d13a937..139597a 100644
--- a/examples/imapresource/tests/imapserverproxytest.cpp
+++ b/examples/imapresource/tests/imapserverproxytest.cpp
@@ -36,6 +36,8 @@ do {\
         return;\
 } while (0)
 
+using namespace Imap;
+
 /**
  */
 class ImapServerProxyTest : public QObject
@@ -77,7 +79,7 @@ private slots:
     void testFetchFolders()
     {
         ImapServerProxy imap("localhost", 993);
-        auto future = imap.fetchFolders([](const QStringList &){});
+        auto future = imap.fetchFolders([](const QVector<Folder> &){});
         future.waitForFinished();
         QVERIFY(!future.errorCode());
     }
@@ -85,7 +87,7 @@ private slots:
     void testFetchFoldersFailure()
     {
         ImapServerProxy imap("foobar", 993);
-        auto future = imap.fetchFolders([](const QStringList &){});
+        auto future = imap.fetchFolders([](const QVector<Folder> &){});
         auto future2 = future;
         future2.waitForFinished();
         QVERIFY(future2.errorCode());
diff --git a/examples/imapresource/tests/resetmailbox.sh b/examples/imapresource/tests/resetmailbox.sh
index 966115a..fc78f60 100644
--- a/examples/imapresource/tests/resetmailbox.sh
+++ b/examples/imapresource/tests/resetmailbox.sh
@@ -1,9 +1,9 @@
 #!/bin/bash
- 
-sudo echo "dm user.doe.test" | cyradm --auth PLAIN -u cyrus -w admin localhost
+
+sudo echo "sam user.doe.* cyrus c" | cyradm --auth PLAIN -u cyrus -w admin localhost
+sudo echo "dm user.doe.*" | cyradm --auth PLAIN -u cyrus -w admin localhost
 sudo echo "cm user.doe.test" | cyradm --auth PLAIN -u cyrus -w admin localhost
 sudo echo "sam user.doe cyrus c" | cyradm --auth PLAIN -u cyrus -w admin localhost
-sudo echo "sam user.doe.test cyrus c" | cyradm --auth PLAIN -u cyrus -w admin localhost
 # sudo rm -R /var/spool/imap/d/user/doe/*
 sudo cp /work/source/Sink/tests/data/maildir1/cur/1365777830.R28.localhost.localdomain\:2\,S /var/spool/imap/d/user/doe/test/1.
 sudo chown cyrus:mail /var/spool/imap/d/user/doe/test/1.