nextcloud-desktop/src/gui/macOS/fileprovidersocketserver.h
Claudio Cambra a44454daf8 Simplify and clarify utility of socket system for file provider
Signed-off-by: Claudio Cambra <claudio.cambra@nextcloud.com>
2024-02-19 22:39:37 +08:00

62 lines
1.9 KiB
C++

/*
* Copyright (C) 2022 by Claudio Cambra <claudio.cambra@nextcloud.com>
*
* 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.
*/
#pragma once
#include <QObject>
#include <QLocalServer>
namespace OCC {
namespace Mac {
class FileProviderSocketController;
using FileProviderSocketControllerPtr = QPointer<FileProviderSocketController>;
QString fileProviderSocketPath();
/*
* Establishes communication between the app and the file provider extension.
* This is done via a local socket server.
* Note that this should be used for extension->client communication.
*
* We can communicate bidirectionally, but the File Provider XPC API is a better interface for this as we cannot account
* for the lifetime of a file provider extension when using sockets, and cannot control this on the client side.
* Use FileProviderXPC for client->extension communication when possible.
*
* This socket system is critical for the file provider extensions to be able to request authentication details.
*
* TODO: This should rewritten to use XPC instead of sockets
*/
class FileProviderSocketServer : public QObject
{
Q_OBJECT
public:
explicit FileProviderSocketServer(QObject *parent = nullptr);
private slots:
void startListening();
void slotNewConnection();
void slotSocketDestroyed(const QLocalSocket * const socket);
private:
QString _socketPath;
QLocalServer _socketServer;
QHash<const QLocalSocket*, FileProviderSocketControllerPtr> _socketControllers;
};
} // namespace Mac
} // namespace OCC