Use property transformation for the mimeMessage

The filepath changes with every flag change. It is thus easier to only
store a limited path that remains stable, and figure out the rest as
the property is requested (we'll have to translate it anyways once we
the file handoff protocol is implemented).

The reason why we don't update the mimeMessage path on every
modification is because we move the message during change replay,
and not while storing the modification in the db. This would lead to
the message-path on disk not correspond to what is in the db for some
time.

6 files changed, 83 insertions, 4 deletions

diff --git a/examples/maildirresource/facade.cpp b/examples/maildirresource/facade.cpp
index 7178ab9..a10a18b 100644
--- a/examples/maildirresource/facade.cpp
+++ b/examples/maildirresource/facade.cpp
@@ -19,17 +19,47 @@
 
 #include "facade.h"
 
+#include <QDir>
+#include <QFileInfo>
+
 #include "domainadaptor.h"
+#include "queryrunner.h"
 
 MaildirResourceMailFacade::MaildirResourceMailFacade(const QByteArray &instanceIdentifier)
     : Sink::GenericFacade<Sink::ApplicationDomain::Mail>(instanceIdentifier, QSharedPointer<MaildirMailAdaptorFactory>::create())
 {
+    mResultTransformation = [](Sink::ApplicationDomain::ApplicationDomainType &value) {
+        const auto property = value.getProperty("mimeMessage");
+        if (property.isValid()) {
+            //Transform the mime message property into the actual path on disk.
+            const auto mimeMessage = property.toString();
+            auto parts = mimeMessage.split('/');
+            auto key = parts.takeLast();
+            const auto folderPath = parts.join('/');
+            const auto path =  folderPath + "/cur/";
+
+            Trace() << "Looking for mail in: " << path << key;
+            QDir dir(path);
+            const QFileInfoList list = dir.entryInfoList(QStringList() << (key+"*"), QDir::Files);
+            if (list.size() != 1) {
+                Warning() << "Failed to find message " << path << key << list.size();
+                value.setProperty("mimeMessage", QVariant());
+            } else {
+                value.setProperty("mimeMessage", list.at(0).filePath());
+            }
+        }
+    };
 }
 
 MaildirResourceMailFacade::~MaildirResourceMailFacade()
 {
 }
 
+QPair<KAsync::Job<void>, Sink::ResultEmitter<Sink::ApplicationDomain::Mail::Ptr>::Ptr> MaildirResourceMailFacade::load(const Sink::Query &query)
+{
+    return Sink::GenericFacade<Sink::ApplicationDomain::Mail>::load(query);
+}
+
 
 MaildirResourceFolderFacade::MaildirResourceFolderFacade(const QByteArray &instanceIdentifier)
     : Sink::GenericFacade<Sink::ApplicationDomain::Folder>(instanceIdentifier, QSharedPointer<MaildirFolderAdaptorFactory>::create())
diff --git a/examples/maildirresource/facade.h b/examples/maildirresource/facade.h
index a243b0d..38981d0 100644
--- a/examples/maildirresource/facade.h
+++ b/examples/maildirresource/facade.h
@@ -26,6 +26,7 @@ class MaildirResourceMailFacade : public Sink::GenericFacade<Sink::ApplicationDo
 public:
     MaildirResourceMailFacade(const QByteArray &instanceIdentifier);
     virtual ~MaildirResourceMailFacade();
+    QPair<KAsync::Job<void>, Sink::ResultEmitter<Sink::ApplicationDomain::Mail::Ptr>::Ptr> load(const Sink::Query &query) Q_DECL_OVERRIDE;
 };
 
 class MaildirResourceFolderFacade : public Sink::GenericFacade<Sink::ApplicationDomain::Folder>
diff --git a/examples/maildirresource/libmaildir/maildir.cpp b/examples/maildirresource/libmaildir/maildir.cpp
index 0057b26..59e7e5c 100644
--- a/examples/maildirresource/libmaildir/maildir.cpp
+++ b/examples/maildirresource/libmaildir/maildir.cpp
@@ -177,6 +177,13 @@ public:
         return realKey;
     }
 
+    static QString stripFlags(const QString& key)
+    {
+        const QRegExp rx = *(statusSeparatorRx());
+        const int index = key.indexOf(rx);
+        return key.mid(0, index);
+    }
+
     static QString subDirNameForFolderName(const QString &folderName)
     {
         return QString::fromLatin1(".%1.directory").arg(folderName);
@@ -559,6 +566,19 @@ QDateTime Maildir::lastModified(const QString& key) const
     return info.lastModified();
 }
 
+QString Maildir::getKeyFromFile(const QString& file)
+{
+    return Maildir::Private::stripFlags(file.split('/').last());
+}
+
+QString Maildir::getDirectoryFromFile( const QString& file )
+{
+    auto parts = file.split('/');
+    parts.removeLast(); //File
+    parts.removeLast(); //cur/new/tmp
+    return parts.join('/') + "/";
+}
+
 QByteArray Maildir::readEntryHeadersFromFile(const QString& file)
 {
     QByteArray result;
diff --git a/examples/maildirresource/libmaildir/maildir.h b/examples/maildirresource/libmaildir/maildir.h
index 5936515..6c68656 100644
--- a/examples/maildirresource/libmaildir/maildir.h
+++ b/examples/maildirresource/libmaildir/maildir.h
@@ -262,6 +262,19 @@ public:
      querying the last error string. */
     QString lastError() const;
 
+    /**
+     * Returns the key from the file identified by the full path @param file.
+     */
+    static QString getKeyFromFile( const QString& file );
+
+    /**
+     * Returns the directory from a file.
+     * 
+     * Strips key and new/cur/tmp.
+     * The returned path is ended with a trailing slash.
+     */
+    static QString getDirectoryFromFile( const QString& file );
+
 private:
     void swap( const Maildir& );
     class Private;
diff --git a/examples/maildirresource/maildirresource.cpp b/examples/maildirresource/maildirresource.cpp
index 87623ca..d5cc24b 100644
--- a/examples/maildirresource/maildirresource.cpp
+++ b/examples/maildirresource/maildirresource.cpp
@@ -175,6 +175,7 @@ void MaildirResource::synchronizeMails(Sink::Storage::Transaction &transaction,
         msg->parse();
 
         const auto flags = maildir.readEntryFlags(fileName);
+        const auto maildirKey = maildir.getKeyFromFile(fileName);
 
         Trace() << "Found a mail " << filePath << " : " << fileName << msg->subject(true)->asUnicodeString();
 
@@ -184,7 +185,8 @@ void MaildirResource::synchronizeMails(Sink::Storage::Transaction &transaction,
         mail.setProperty("senderName", msg->from(true)->asUnicodeString());
         mail.setProperty("date", msg->date(true)->dateTime());
         mail.setProperty("folder", folderLocalId);
-        mail.setProperty("mimeMessage", filePath);
+        //We only store the directory path + key, so we facade can add the changing bits (flags)
+        mail.setProperty("mimeMessage", KPIM::Maildir::getDirectoryFromFile(filePath) + maildirKey);
         mail.setProperty("unread", !flags.testFlag(KPIM::Maildir::Seen));
         mail.setProperty("important", flags.testFlag(KPIM::Maildir::Flagged));
 
@@ -274,7 +276,7 @@ KAsync::Job<void> MaildirResource::replay(Sink::Storage &synchronizationStore, c
             if (!maildir.isValid(true)) {
                 return KAsync::error<void>(1, "Invalid folder " + parentFolderPath);
             }
-            //FIXME assemble the MIME message
+            //FIXME move the mime message from the mimeMessage property to the proper place.
             Trace() << "Creating a new mail.";
             const auto remoteId = maildir.addEntry("foobar");
             if (remoteId.isEmpty()) {
diff --git a/tests/maildirresourcetest.cpp b/tests/maildirresourcetest.cpp
index 7cdfc36..e502d10 100644
--- a/tests/maildirresourcetest.cpp
+++ b/tests/maildirresourcetest.cpp
@@ -158,6 +158,9 @@ private Q_SLOTS:
         QVERIFY(!mail->getProperty("subject").toString().isEmpty());
         QVERIFY(!mail->getProperty("mimeMessage").toString().isEmpty());
         QVERIFY(mail->getProperty("date").toDateTime().isValid());
+
+        QFileInfo info(mail->getProperty("mimeMessage").toString());
+        QVERIFY(info.exists());
     }
 
 
@@ -368,10 +371,11 @@ private Q_SLOTS:
         result.waitForFinished();
         QVERIFY(!result.errorCode());
 
+        //Verify that we can still query for all relevant information
         auto result2 = Store::fetchAll<Mail>(
-            Query::ResourceFilter("org.kde.maildir.instance1") + Query::PropertyFilter("folder", f) + Query::RequestedProperties(QByteArrayList() << "folder" << "subject")
+            Query::ResourceFilter("org.kde.maildir.instance1") + Query::PropertyFilter("folder", f) + Query::RequestedProperties(QByteArrayList() << "folder" << "subject" << "mimeMessage" << "unread")
         )
-        .then<void, KAsync::Job<void>, QList<Mail::Ptr> >([query](const QList<Mail::Ptr> &mails) {
+        .then<void, KAsync::Job<void>, QList<Mail::Ptr> >([](const QList<Mail::Ptr> &mails) {
             //Can't use QCOMPARE because it tries to return FIXME Implement ASYNCCOMPARE
             if (mails.size() != 1) {
                 qWarning() << "Wrong number of mails";
@@ -382,6 +386,15 @@ private Q_SLOTS:
                 qWarning() << "Wrong subject";
                 return KAsync::error<void>(1, "Wrong subject.");
             }
+            if (mail->getProperty("unread").toBool() != true) {
+                qWarning() << "Not unread";
+                return KAsync::error<void>(1, "Not unread.");
+            }
+            QFileInfo info(mail->getProperty("mimeMessage").toString());
+            if (!info.exists()) {
+                qWarning() << "Wrong subject";
+                return KAsync::error<void>(1, "Can't find mime message.");
+            }
             return KAsync::null<void>();
         })
         .exec();