mirror of
https://github.com/transmission/transmission.git
synced 2025-12-20 10:28:32 +00:00
804fb20a80
* refactor: use api_compat::convert_incoming_data() and convert_outgoing_data() in RpcClient * refactor: use convert_outgoing_data() when saving settings.json in Prefs::~Prefs * refactor: remove all kebab, camel keys from qt client * refactor: rename RpcResponse.result to RpcResponse.errmsg * refactor: parse jsonrpc responses * refactor: build RPC requests in JSON-RPC 2.0 * fix: Qt5 build error
105 lines
2.8 KiB
C++
105 lines
2.8 KiB
C++
// This file Copyright © Mnemosyne LLC.
|
|
// It may be used under GPLv2 (SPDX: GPL-2.0-only), GPLv3 (SPDX: GPL-3.0-only),
|
|
// or any future license endorsed by Mnemosyne LLC.
|
|
// License text can be found in the licenses/ folder.
|
|
|
|
#pragma once
|
|
|
|
#include <cstdint> // int64_t
|
|
#include <memory>
|
|
#include <optional>
|
|
#include <string_view>
|
|
#include <unordered_map>
|
|
|
|
#include <QFuture>
|
|
#include <QFutureInterface>
|
|
#include <QNetworkRequest>
|
|
#include <QNetworkReply>
|
|
#include <QObject>
|
|
#include <QString>
|
|
#include <QUrl>
|
|
|
|
#include <libtransmission/transmission.h>
|
|
|
|
#include <libtransmission/quark.h>
|
|
#include <libtransmission/variant.h>
|
|
|
|
class QNetworkAccessManager;
|
|
|
|
using TrVariantPtr = std::shared_ptr<tr_variant>;
|
|
Q_DECLARE_METATYPE(TrVariantPtr)
|
|
|
|
extern "C"
|
|
{
|
|
struct tr_session;
|
|
}
|
|
|
|
struct RpcResponse
|
|
{
|
|
QString errmsg;
|
|
TrVariantPtr args;
|
|
bool success = false;
|
|
QNetworkReply::NetworkError networkError = QNetworkReply::NoError;
|
|
};
|
|
|
|
Q_DECLARE_METATYPE(QFutureInterface<RpcResponse>)
|
|
|
|
// The response future -- the RPC engine returns one for each request made.
|
|
using RpcResponseFuture = QFuture<RpcResponse>;
|
|
|
|
class RpcClient : public QObject
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
explicit RpcClient(QObject* parent = nullptr);
|
|
RpcClient(RpcClient&&) = delete;
|
|
RpcClient(RpcClient const&) = delete;
|
|
RpcClient& operator=(RpcClient&&) = delete;
|
|
RpcClient& operator=(RpcClient const&) = delete;
|
|
|
|
[[nodiscard]] constexpr auto const& url() const noexcept
|
|
{
|
|
return url_;
|
|
}
|
|
|
|
[[nodiscard]] constexpr auto isLocal() const noexcept
|
|
{
|
|
return session_ != nullptr || url_is_loopback_;
|
|
}
|
|
|
|
void stop();
|
|
void start(tr_session* session);
|
|
void start(QUrl const& url);
|
|
|
|
RpcResponseFuture exec(tr_quark method, tr_variant* args);
|
|
|
|
signals:
|
|
void httpAuthenticationRequired();
|
|
void dataReadProgress();
|
|
void dataSendProgress();
|
|
void networkResponse(QNetworkReply::NetworkError code, QString const& message);
|
|
|
|
private slots:
|
|
void networkRequestFinished(QNetworkReply* reply);
|
|
void localRequestFinished(TrVariantPtr response);
|
|
|
|
private:
|
|
QNetworkAccessManager* networkAccessManager();
|
|
|
|
void sendNetworkRequest(QByteArray const& body, QFutureInterface<RpcResponse> const& promise);
|
|
void sendLocalRequest(tr_variant const& req, QFutureInterface<RpcResponse> const& promise, int64_t id);
|
|
[[nodiscard]] int64_t parseResponseId(tr_variant& response) const;
|
|
[[nodiscard]] RpcResponse parseResponseData(tr_variant& response) const;
|
|
|
|
std::optional<QNetworkRequest> request_;
|
|
|
|
tr_session* session_ = {};
|
|
QString session_id_;
|
|
QUrl url_;
|
|
QNetworkAccessManager* nam_ = {};
|
|
std::unordered_map<int64_t, QFutureInterface<RpcResponse>> local_requests_;
|
|
bool const verbose_ = qEnvironmentVariableIsSet("TR_RPC_VERBOSE");
|
|
bool url_is_loopback_ = false;
|
|
};
|