/* * Copyright (C) 2015 Christian Mollekopf * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program 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 General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the * Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ #include "maildirresource.h" #include "facade.h" #include "entitybuffer.h" #include "pipeline.h" #include "mail_generated.h" #include "createentity_generated.h" #include "modifyentity_generated.h" #include "deleteentity_generated.h" #include "domainadaptor.h" #include "resourceconfig.h" #include "commands.h" #include "index.h" #include "log.h" #include "domain/mail.h" #include "definitions.h" #include "facadefactory.h" #include "indexupdater.h" #include "libmaildir/maildir.h" #include "inspection.h" #include #include #include #include #include //This is the resources entity type, and not the domain type #define ENTITY_TYPE_MAIL "mail" #define ENTITY_TYPE_FOLDER "folder" MaildirResource::MaildirResource(const QByteArray &instanceIdentifier, const QSharedPointer &pipeline) : Akonadi2::GenericResource(instanceIdentifier, pipeline), mMailAdaptorFactory(QSharedPointer::create()), mFolderAdaptorFactory(QSharedPointer::create()) { addType(ENTITY_TYPE_MAIL, mMailAdaptorFactory, QVector() << new DefaultIndexUpdater); addType(ENTITY_TYPE_FOLDER, mFolderAdaptorFactory, QVector() << new DefaultIndexUpdater); auto config = ResourceConfig::getConfiguration(instanceIdentifier); mMaildirPath = QDir::cleanPath(QDir::fromNativeSeparators(config.value("path").toString())); //Chop a trailing slash if necessary if (mMaildirPath.endsWith("/")) { mMaildirPath.chop(1); } Trace() << "Started maildir resource for maildir: " << mMaildirPath; } static QStringList listRecursive( const QString &root, const KPIM::Maildir &dir ) { QStringList list; foreach (const QString &sub, dir.subFolderList()) { const KPIM::Maildir md = dir.subFolder(sub); if (!md.isValid()) { continue; } QString path = root + "/" + sub; list << path; list += listRecursive(path, md ); } return list; } QStringList MaildirResource::listAvailableFolders() { KPIM::Maildir dir(mMaildirPath, true); if (!dir.isValid()) { return QStringList(); } QStringList folderList; folderList << mMaildirPath; folderList += listRecursive(mMaildirPath, dir); return folderList; } void MaildirResource::synchronizeFolders(Akonadi2::Storage::Transaction &transaction, Akonadi2::Storage::Transaction &synchronizationTransaction) { const QByteArray bufferType = ENTITY_TYPE_FOLDER; QStringList folderList = listAvailableFolders(); Trace() << "Found folders " << folderList; scanForRemovals(transaction, synchronizationTransaction, bufferType, [&bufferType, &transaction](const std::function &callback) { //TODO Instead of iterating over all entries in the database, which can also pick up the same item multiple times, //we should rather iterate over an index that contains every uid exactly once. The remoteId index would be such an index, //but we currently fail to iterate over all entries in an index it seems. // auto remoteIds = synchronizationTransaction.openDatabase("rid.mapping." + bufferType, std::function(), true); auto mainDatabase = transaction.openDatabase(bufferType + ".main"); mainDatabase.scan("", [&](const QByteArray &key, const QByteArray &) { callback(key); return true; }); }, [&folderList](const QByteArray &remoteId) -> bool { return folderList.contains(remoteId); } ); for (const auto folderPath : folderList) { const auto remoteId = folderPath.toUtf8(); Trace() << "Processing folder " << remoteId; KPIM::Maildir md(folderPath, folderPath == mMaildirPath); Akonadi2::ApplicationDomain::Folder folder; folder.setProperty("name", md.name()); folder.setProperty("icon", "folder"); if (!md.isRoot()) { folder.setProperty("parent", resolveRemoteId(ENTITY_TYPE_FOLDER, md.parent().path().toUtf8(), synchronizationTransaction)); } createOrModify(transaction, synchronizationTransaction, *mFolderAdaptorFactory, bufferType, remoteId, folder); } } void MaildirResource::synchronizeMails(Akonadi2::Storage::Transaction &transaction, Akonadi2::Storage::Transaction &synchronizationTransaction, const QString &path) { Trace() << "Synchronizing mails" << path; const QByteArray bufferType = ENTITY_TYPE_MAIL; KPIM::Maildir maildir(path, true); if (!maildir.isValid()) { Warning() << "Failed to sync folder " << maildir.lastError(); return; } auto listingPath = maildir.pathToCurrent(); auto entryIterator = QSharedPointer::create(listingPath, QDir::Files); Trace() << "Looking into " << listingPath; const auto folderLocalId = resolveRemoteId(ENTITY_TYPE_FOLDER, path.toUtf8(), synchronizationTransaction); auto property = "folder"; scanForRemovals(transaction, synchronizationTransaction, bufferType, [&](const std::function &callback) { Index index(bufferType + ".index." + property, transaction); index.lookup(folderLocalId, [&](const QByteArray &akonadiId) { callback(akonadiId); }, [&](const Index::Error &error) { Warning() << "Error in index: " << error.message << property; }); }, [](const QByteArray &remoteId) -> bool { return QFile(remoteId).exists(); } ); while (entryIterator->hasNext()) { const QString filePath = QDir::fromNativeSeparators(entryIterator->next()); const QString fileName = entryIterator->fileName(); const auto remoteId = filePath.toUtf8(); KMime::Message *msg = new KMime::Message; msg->setHead(KMime::CRLFtoLF(maildir.readEntryHeadersFromFile(filePath))); msg->parse(); const auto flags = maildir.readEntryFlags(fileName); Trace() << "Found a mail " << filePath << " : " << fileName << msg->subject(true)->asUnicodeString(); Akonadi2::ApplicationDomain::Mail mail; mail.setProperty("subject", msg->subject(true)->asUnicodeString()); mail.setProperty("sender", msg->from(true)->asUnicodeString()); mail.setProperty("senderName", msg->from(true)->asUnicodeString()); mail.setProperty("date", msg->date(true)->dateTime()); mail.setProperty("folder", folderLocalId); mail.setProperty("mimeMessage", filePath); mail.setProperty("unread", !flags.testFlag(KPIM::Maildir::Seen)); mail.setProperty("important", flags.testFlag(KPIM::Maildir::Flagged)); createOrModify(transaction, synchronizationTransaction, *mMailAdaptorFactory, bufferType, remoteId, mail); } } KAsync::Job MaildirResource::synchronizeWithSource(Akonadi2::Storage &mainStore, Akonadi2::Storage &synchronizationStore) { Log() << " Synchronizing"; return KAsync::start([this, &mainStore, &synchronizationStore]() { auto transaction = mainStore.createTransaction(Akonadi2::Storage::ReadOnly); { auto synchronizationTransaction = synchronizationStore.createTransaction(Akonadi2::Storage::ReadWrite); synchronizeFolders(transaction, synchronizationTransaction); //The next sync needs the folders available synchronizationTransaction.commit(); } for (const auto &folder : listAvailableFolders()) { auto synchronizationTransaction = synchronizationStore.createTransaction(Akonadi2::Storage::ReadWrite); synchronizeMails(transaction, synchronizationTransaction, folder); //Don't let the transaction grow too much synchronizationTransaction.commit(); } Log() << "Done Synchronizing"; }); } KAsync::Job MaildirResource::replay(Akonadi2::Storage &synchronizationStore, const QByteArray &type, const QByteArray &key, const QByteArray &value) { auto synchronizationTransaction = synchronizationStore.createTransaction(Akonadi2::Storage::ReadWrite); Trace() << "Replaying " << key << type; if (type == ENTITY_TYPE_FOLDER) { Akonadi2::EntityBuffer buffer(value.data(), value.size()); const Akonadi2::Entity &entity = buffer.entity(); const auto metadataBuffer = Akonadi2::EntityBuffer::readBuffer(entity.metadata()); if (metadataBuffer && !metadataBuffer->replayToSource()) { Trace() << "Change is coming from the source"; return KAsync::null(); } const qint64 revision = metadataBuffer ? metadataBuffer->revision() : -1; const auto operation = metadataBuffer ? metadataBuffer->operation() : Akonadi2::Operation_Creation; if (operation == Akonadi2::Operation_Creation) { const Akonadi2::ApplicationDomain::Folder folder(mResourceInstanceIdentifier, Akonadi2::Storage::uidFromKey(key), revision, mFolderAdaptorFactory->createAdaptor(entity)); auto folderName = folder.getProperty("name").toString(); //TODO handle non toplevel folders auto path = mMaildirPath + "/" + folderName; Trace() << "Creating a new folder: " << path; KPIM::Maildir maildir(path, false); maildir.create(); recordRemoteId(ENTITY_TYPE_FOLDER, folder.identifier(), path.toUtf8(), synchronizationTransaction); } else if (operation == Akonadi2::Operation_Removal) { const auto uid = Akonadi2::Storage::uidFromKey(key); const auto remoteId = resolveLocalId(ENTITY_TYPE_FOLDER, uid, synchronizationTransaction); const auto path = remoteId; Trace() << "Removing a folder: " << path; KPIM::Maildir maildir(path, false); maildir.remove(); removeRemoteId(ENTITY_TYPE_FOLDER, uid, remoteId, synchronizationTransaction); } else if (operation == Akonadi2::Operation_Modification) { Warning() << "Folder modifications are not implemented"; } else { Warning() << "Unkown operation" << operation; } } else if (type == ENTITY_TYPE_MAIL) { Akonadi2::EntityBuffer buffer(value.data(), value.size()); const Akonadi2::Entity &entity = buffer.entity(); const auto metadataBuffer = Akonadi2::EntityBuffer::readBuffer(entity.metadata()); if (metadataBuffer && !metadataBuffer->replayToSource()) { Trace() << "Change is coming from the source"; return KAsync::null(); } const qint64 revision = metadataBuffer ? metadataBuffer->revision() : -1; const auto operation = metadataBuffer ? metadataBuffer->operation() : Akonadi2::Operation_Creation; if (operation == Akonadi2::Operation_Creation) { const Akonadi2::ApplicationDomain::Mail mail(mResourceInstanceIdentifier, Akonadi2::Storage::uidFromKey(key), revision, mMailAdaptorFactory->createAdaptor(entity)); auto parentFolder = mail.getProperty("folder").toByteArray(); QByteArray parentFolderRemoteId; if (!parentFolder.isEmpty()) { parentFolderRemoteId = resolveLocalId(ENTITY_TYPE_FOLDER, parentFolder, synchronizationTransaction); } else { parentFolderRemoteId = mMaildirPath.toUtf8(); } const auto parentFolderPath = parentFolderRemoteId; KPIM::Maildir maildir(parentFolderPath, false); //FIXME assemble the MIME message const auto id = maildir.addEntry("foobar"); Trace() << "Creating a new mail: " << id; recordRemoteId(ENTITY_TYPE_MAIL, mail.identifier(), id.toUtf8(), synchronizationTransaction); } else if (operation == Akonadi2::Operation_Removal) { const auto uid = Akonadi2::Storage::uidFromKey(key); const auto remoteId = resolveLocalId(ENTITY_TYPE_MAIL, uid, synchronizationTransaction); Trace() << "Removing a mail: " << remoteId; QFile::remove(remoteId); removeRemoteId(ENTITY_TYPE_MAIL, uid, remoteId, synchronizationTransaction); } else if (operation == Akonadi2::Operation_Modification) { Warning() << "Mail modifications are not implemented"; } else { Warning() << "Unkown operation" << operation; } } return KAsync::null(); } void MaildirResource::removeFromDisk(const QByteArray &instanceIdentifier) { GenericResource::removeFromDisk(instanceIdentifier); Akonadi2::Storage(Akonadi2::storageLocation(), instanceIdentifier + ".synchronization", Akonadi2::Storage::ReadWrite).removeFromDisk(); } KAsync::Job MaildirResource::inspect(int inspectionType, const QByteArray &inspectionId, const QByteArray &domainType, const QByteArray &entityId, const QByteArray &property, const QVariant &expectedValue) { Trace() << "Inspecting " << inspectionType << domainType << entityId << property << expectedValue; } MaildirResourceFactory::MaildirResourceFactory(QObject *parent) : Akonadi2::ResourceFactory(parent) { } Akonadi2::Resource *MaildirResourceFactory::createResource(const QByteArray &instanceIdentifier) { return new MaildirResource(instanceIdentifier); } void MaildirResourceFactory::registerFacades(Akonadi2::FacadeFactory &factory) { factory.registerFacade(PLUGIN_NAME); factory.registerFacade(PLUGIN_NAME); }