From dd86c15b48f33c120c510327569fb1cc3ffa3d45 Mon Sep 17 00:00:00 2001 From: Christian Mollekopf Date: Tue, 28 Jul 2015 20:49:08 +0200 Subject: Moved listener to common So we can use it in tests as well. --- synchronizer/CMakeLists.txt | 1 - synchronizer/listener.cpp | 391 -------------------------------------------- synchronizer/listener.h | 101 ------------ 3 files changed, 493 deletions(-) delete mode 100644 synchronizer/listener.cpp delete mode 100644 synchronizer/listener.h (limited to 'synchronizer') diff --git a/synchronizer/CMakeLists.txt b/synchronizer/CMakeLists.txt index fe938e9..f0c235d 100644 --- a/synchronizer/CMakeLists.txt +++ b/synchronizer/CMakeLists.txt @@ -4,7 +4,6 @@ include_directories(${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR}) set(akonadi2synchronizer_SRCS main.cpp - listener.cpp ) add_executable(${PROJECT_NAME} ${akonadi2synchronizer_SRCS}) diff --git a/synchronizer/listener.cpp b/synchronizer/listener.cpp deleted file mode 100644 index 4316c63..0000000 --- a/synchronizer/listener.cpp +++ /dev/null @@ -1,391 +0,0 @@ -/* - * Copyright (C) 2014 Aaron Seigo - * - * 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 "listener.h" - -#include "common/clientapi.h" -#include "common/commands.h" -#include "common/resource.h" -#include "common/log.h" - -// commands -#include "common/commandcompletion_generated.h" -#include "common/handshake_generated.h" -#include "common/revisionupdate_generated.h" -#include "common/synchronize_generated.h" -#include "common/notification_generated.h" - -#include -#include -#include - -Listener::Listener(const QByteArray &resourceInstanceIdentifier, QObject *parent) - : QObject(parent), - m_server(new QLocalServer(this)), - m_resourceName(Akonadi2::Store::resourceName(resourceInstanceIdentifier)), - m_resourceInstanceIdentifier(resourceInstanceIdentifier), - m_resource(0), - m_pipeline(new Akonadi2::Pipeline(resourceInstanceIdentifier, parent)), - m_clientBufferProcessesTimer(new QTimer(this)), - m_messageId(0) -{ - connect(m_pipeline, &Akonadi2::Pipeline::revisionUpdated, - this, &Listener::refreshRevision); - connect(m_server, &QLocalServer::newConnection, - this, &Listener::acceptConnection); - Trace() << "Trying to open " << m_resourceInstanceIdentifier; - - m_lockfile = new QLockFile(m_resourceInstanceIdentifier + ".lock"); - m_lockfile->setStaleLockTime(0); - if (!m_lockfile->tryLock(0)) { - Warning() << "Failed to acquire exclusive lock on socket."; - exit(-1); - } - - if (!m_server->listen(QString::fromLatin1(m_resourceInstanceIdentifier))) { - // FIXME: multiple starts need to be handled here - m_server->removeServer(m_resourceInstanceIdentifier); - if (!m_server->listen(QString::fromLatin1(m_resourceInstanceIdentifier))) { - Warning() << "Utter failure to start server"; - exit(-1); - } - } - - if (m_server->isListening()) { - Log() << QString("Listening on %1").arg(m_server->serverName()); - } - - m_checkConnectionsTimer = new QTimer; - m_checkConnectionsTimer->setSingleShot(true); - m_checkConnectionsTimer->setInterval(1000); - connect(m_checkConnectionsTimer, &QTimer::timeout, [this]() { - if (m_connections.isEmpty()) { - Log() << QString("No connections, shutting down."); - quit(); - } - }); - - //TODO: experiment with different timeouts - // or even just drop down to invoking the method queued? => invoke queued unless we need throttling - m_clientBufferProcessesTimer->setInterval(0); - m_clientBufferProcessesTimer->setSingleShot(true); - connect(m_clientBufferProcessesTimer, &QTimer::timeout, - this, &Listener::processClientBuffers); -} - -Listener::~Listener() -{ -} - -void Listener::closeAllConnections() -{ - for (Client &client: m_connections) { - if (client.socket) { - disconnect(client.socket, 0, this, 0); - client.socket->close(); - delete client.socket; - client.socket = 0; - } - } - - m_connections.clear(); -} - -void Listener::acceptConnection() -{ - Trace() << "Accepting connection"; - QLocalSocket *socket = m_server->nextPendingConnection(); - - if (!socket) { - return; - } - - Log() << "Got a connection"; - m_connections << Client("Unknown Client", socket); - connect(socket, &QIODevice::readyRead, - this, &Listener::onDataAvailable); - connect(socket, &QLocalSocket::disconnected, - this, &Listener::clientDropped); - m_checkConnectionsTimer->stop(); - - if (socket->bytesAvailable()) { - readFromSocket(socket); - } -} - -void Listener::clientDropped() -{ - QLocalSocket *socket = qobject_cast(sender()); - if (!socket) { - return; - } - - bool dropped = false; - QMutableVectorIterator it(m_connections); - while (it.hasNext()) { - const Client &client = it.next(); - if (client.socket == socket) { - dropped = true; - Log() << QString("Dropped connection: %1").arg(client.name) << socket; - it.remove(); - break; - } - } - if (!dropped) { - Warning() << "Failed to find connection for disconnected socket: " << socket; - } - - checkConnections(); -} - -void Listener::checkConnections() -{ - m_checkConnectionsTimer->start(); -} - -void Listener::onDataAvailable() -{ - QLocalSocket *socket = qobject_cast(sender()); - if (!socket) { - return; - } - readFromSocket(socket); -} - -void Listener::readFromSocket(QLocalSocket *socket) -{ - Trace() << "Reading from socket..."; - for (Client &client: m_connections) { - if (client.socket == socket) { - client.commandBuffer += socket->readAll(); - if (!m_clientBufferProcessesTimer->isActive()) { - m_clientBufferProcessesTimer->start(); - } - break; - } - } -} - -void Listener::processClientBuffers() -{ - //TODO: we should not process all clients, but iterate async over them and process - // one command from each in turn to ensure all clients get fair handling of - // commands? - bool again = false; - for (Client &client: m_connections) { - if (!client.socket || !client.socket->isValid() || client.commandBuffer.isEmpty()) { - continue; - } - - if (processClientBuffer(client)) { - again = true; - } - } - - if (again) { - m_clientBufferProcessesTimer->start(); - } -} - -void Listener::processCommand(int commandId, uint messageId, const QByteArray &commandBuffer, Client &client, const std::function &callback) -{ - switch (commandId) { - case Akonadi2::Commands::HandshakeCommand: { - flatbuffers::Verifier verifier((const uint8_t *)commandBuffer.constData(), commandBuffer.size()); - if (Akonadi2::VerifyHandshakeBuffer(verifier)) { - auto buffer = Akonadi2::GetHandshake(commandBuffer.constData()); - client.name = buffer->name()->c_str(); - } else { - Warning() << "received invalid command"; - } - break; - } - case Akonadi2::Commands::SynchronizeCommand: { - flatbuffers::Verifier verifier((const uint8_t *)commandBuffer.constData(), commandBuffer.size()); - if (Akonadi2::VerifySynchronizeBuffer(verifier)) { - auto buffer = Akonadi2::GetSynchronize(commandBuffer.constData()); - Log() << QString("\tSynchronize request (id %1) from %2").arg(messageId).arg(client.name); - loadResource(); - if (!m_resource) { - Warning() << "No resource loaded"; - break; - } - auto job = KAsync::null(); - if (buffer->sourceSync()) { - job = m_resource->synchronizeWithSource(m_pipeline); - } - if (buffer->localSync()) { - job = job.then(m_resource->processAllMessages()); - } - job.then([callback]() { - callback(); - }).exec(); - return; - } else { - Warning() << "received invalid command"; - } - break; - } - case Akonadi2::Commands::FetchEntityCommand: - case Akonadi2::Commands::DeleteEntityCommand: - case Akonadi2::Commands::ModifyEntityCommand: - case Akonadi2::Commands::CreateEntityCommand: - Log() << "\tCommand id " << messageId << " of type \"" << Akonadi2::Commands::name(commandId) << "\" from " << client.name; - loadResource(); - if (m_resource) { - m_resource->processCommand(commandId, commandBuffer, m_pipeline); - } - break; - case Akonadi2::Commands::ShutdownCommand: - Log() << QString("\tReceived shutdown command from %1").arg(client.name); - //Immediately reject new connections - m_server->close(); - QTimer::singleShot(0, this, &Listener::quit); - break; - default: - if (commandId > Akonadi2::Commands::CustomCommand) { - Log() << QString("\tReceived custom command from %1: ").arg(client.name) << commandId; - loadResource(); - if (m_resource) { - m_resource->processCommand(commandId, commandBuffer, m_pipeline); - } - } else { - Warning() << QString("\tReceived invalid command from %1: ").arg(client.name) << commandId; - //TODO: handle error: we don't know wtf this command is - } - break; - } - callback(); -} - -void Listener::quit() -{ - //Broadcast shutdown notifications to open clients, so they don't try to restart the resource - auto command = Akonadi2::CreateNotification(m_fbb, Akonadi2::NotificationType::NotificationType_Shutdown); - Akonadi2::FinishNotificationBuffer(m_fbb, command); - for (Client &client : m_connections) { - if (client.socket && client.socket->isOpen()) { - Akonadi2::Commands::write(client.socket, ++m_messageId, Akonadi2::Commands::NotificationCommand, m_fbb); - } - } - m_fbb.Clear(); - - //Connections will be cleaned up later - emit noClients(); -} - -bool Listener::processClientBuffer(Client &client) -{ - static const int headerSize = Akonadi2::Commands::headerSize(); - if (client.commandBuffer.size() < headerSize) { - return false; - } - - const uint messageId = *(uint*)client.commandBuffer.constData(); - const int commandId = *(int*)(client.commandBuffer.constData() + sizeof(uint)); - const uint size = *(uint*)(client.commandBuffer.constData() + sizeof(int) + sizeof(uint)); - - //TODO: reject messages above a certain size? - - if (size <= uint(client.commandBuffer.size() - headerSize)) { - client.commandBuffer.remove(0, headerSize); - - auto socket = QPointer(client.socket); - auto clientName = client.name; - const QByteArray commandBuffer = client.commandBuffer.left(size); - client.commandBuffer.remove(0, size); - processCommand(commandId, messageId, commandBuffer, client, [this, messageId, commandId, socket, clientName]() { - Log() << QString("\tCompleted command messageid %1 of type \"%2\" from %3").arg(messageId).arg(QString(Akonadi2::Commands::name(commandId))).arg(clientName); - if (socket) { - sendCommandCompleted(socket.data(), messageId); - } else { - Log() << QString("Socket became invalid before we could send a response. client: %1").arg(clientName); - } - }); - - return client.commandBuffer.size() >= headerSize; - } - - return false; -} - -void Listener::sendCurrentRevision(Client &client) -{ - if (!client.socket || !client.socket->isValid()) { - return; - } - - auto command = Akonadi2::CreateRevisionUpdate(m_fbb, m_pipeline->storage().maxRevision()); - Akonadi2::FinishRevisionUpdateBuffer(m_fbb, command); - Akonadi2::Commands::write(client.socket, ++m_messageId, Akonadi2::Commands::RevisionUpdateCommand, m_fbb); - m_fbb.Clear(); -} - -void Listener::sendCommandCompleted(QLocalSocket *socket, uint messageId) -{ - if (!socket || !socket->isValid()) { - return; - } - - auto command = Akonadi2::CreateCommandCompletion(m_fbb, messageId); - Akonadi2::FinishCommandCompletionBuffer(m_fbb, command); - Akonadi2::Commands::write(socket, ++m_messageId, Akonadi2::Commands::CommandCompletion, m_fbb); - m_fbb.Clear(); -} - -void Listener::refreshRevision() -{ - updateClientsWithRevision(); -} - -void Listener::updateClientsWithRevision() -{ - //FIXME don't send revision updates for revisions that are still being processed. - auto command = Akonadi2::CreateRevisionUpdate(m_fbb, m_pipeline->storage().maxRevision()); - Akonadi2::FinishRevisionUpdateBuffer(m_fbb, command); - - for (const Client &client: m_connections) { - if (!client.socket || !client.socket->isValid()) { - continue; - } - - Akonadi2::Commands::write(client.socket, ++m_messageId, Akonadi2::Commands::RevisionUpdateCommand, m_fbb); - } - m_fbb.Clear(); -} - -void Listener::loadResource() -{ - if (m_resource) { - return; - } - - Akonadi2::ResourceFactory *resourceFactory = Akonadi2::ResourceFactory::load(m_resourceName); - if (resourceFactory) { - m_resource = resourceFactory->createResource(m_resourceInstanceIdentifier); - Log() << QString("Resource factory: %1").arg((qlonglong)resourceFactory); - Log() << QString("\tResource: %1").arg((qlonglong)m_resource); - m_resource->configurePipeline(m_pipeline); - } else { - ErrorMsg() << "Failed to load resource " << m_resourceName; - } - //TODO: on failure ... what? - //Enter broken state? -} - diff --git a/synchronizer/listener.h b/synchronizer/listener.h deleted file mode 100644 index 560f052..0000000 --- a/synchronizer/listener.h +++ /dev/null @@ -1,101 +0,0 @@ -/* - * Copyright (C) 2014 Aaron Seigo - * - * 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. - */ - -#pragma once - -#include -#include -#include - -#include - -#include "common/pipeline.h" - -namespace Akonadi2 -{ - class Resource; -} - -class QTimer; - -class Client -{ -public: - Client() - : socket(nullptr) - { - } - - Client(const QString &n, QLocalSocket *s) - : name(n), - socket(s) - { - } - - QString name; - QPointer socket; - QByteArray commandBuffer; -}; - -class QLockFile; - -class Listener : public QObject -{ - Q_OBJECT - -public: - Listener(const QByteArray &resourceName, QObject *parent = 0); - ~Listener(); - -Q_SIGNALS: - void noClients(); - -public Q_SLOTS: - void closeAllConnections(); - -private Q_SLOTS: - void acceptConnection(); - void clientDropped(); - void checkConnections(); - void onDataAvailable(); - void processClientBuffers(); - void refreshRevision(); - void quit(); - -private: - void processCommand(int commandId, uint messageId, const QByteArray &commandBuffer, Client &client, const std::function &callback); - bool processClientBuffer(Client &client); - void sendCurrentRevision(Client &client); - void sendCommandCompleted(QLocalSocket *socket, uint messageId); - void updateClientsWithRevision(); - void loadResource(); - void readFromSocket(QLocalSocket *socket); - - QLocalServer *m_server; - QVector m_connections; - flatbuffers::FlatBufferBuilder m_fbb; - const QByteArray m_resourceName; - const QByteArray m_resourceInstanceIdentifier; - Akonadi2::Resource *m_resource; - Akonadi2::Pipeline *m_pipeline; - QTimer *m_clientBufferProcessesTimer; - QTimer *m_checkConnectionsTimer; - int m_messageId; - QLockFile *m_lockfile; -}; -- cgit v1.2.3