3pp-mirror/snapcast
1
0
Fork 0
mirror of https://github.com/badaix/snapcast.git synced 2025-06-02 10:51:45 +02:00
Code Issues Projects Releases Packages Wiki Activity

cleaned up json rpc exceptions

Browse source
This commit is contained in:
badaix 2015-09-06 22:15:55 +02:00
parent 86a9b6ca90
commit 11a45d3508
4 changed files with 165 additions and 101 deletions
Download patch file Download diff file Expand all files Collapse all files

20
server/json/jsonrpc.cpp
View file

@ -50,15 +50,23 @@ void JsonRequest::parse(const std::string& json)
throw JsonRequestException(e.what(), -32700);
}
if (json_.count("id") == 0)
throw JsonInvalidRequestException("id is missing", -1);
id = json_["id"].get<int>();
if (id < 0)
throw JsonInvalidRequestException("id must be a positive integer", id);
if (json_.count("jsonrpc") == 0)
throw JsonInvalidRequestException("jsonrpc is missing", id);
string jsonrpc = json_["jsonrpc"].get<string>();
if (jsonrpc != "2.0")
throw JsonRequestException("invalid jsonrpc value: " + jsonrpc, -32600);
throw JsonInvalidRequestException("invalid jsonrpc value: " + jsonrpc, id);
if (json_.count("method") == 0)
throw JsonInvalidRequestException("method is missing", id);
method = json_["method"].get<string>();
if (method.empty())
throw JsonRequestException("method must not be empty", -32600);
if (id < 0)
throw JsonRequestException("id must be a positive integer", -32600);
throw JsonInvalidRequestException("method must not be empty", id);
params.clear();
try
@ -72,7 +80,7 @@ void JsonRequest::parse(const std::string& json)
}
catch (const exception& e)
{
throw JsonRequestException(e.what(), -32602);
throw JsonInvalidParamsException(e.what(), id);
}
}
catch (const JsonRequestException& e)
@ -81,7 +89,7 @@ void JsonRequest::parse(const std::string& json)
}
catch (const exception& e)
{
throw JsonRequestException(e.what(), -32603, id);
throw JsonInternalErrorException(e.what(), id);
}
}

96
server/json/jsonrpc.h
View file

@ -23,107 +23,13 @@
#include <vector>
#include <boost/lexical_cast.hpp>
#include "json.hpp"
#include "common/snapException.h"
#include "jsonrpcException.h"
using Json = nlohmann::json;
class JsonRequestException : public SnapException
{
int errorCode_, id_;
public:
JsonRequestException(const char* text, int errorCode = 0, int requestId = -1) : SnapException(text), errorCode_(errorCode), id_(requestId)
{
}
JsonRequestException(const std::string& text, int errorCode = 0, int requestId = -1) : SnapException(text), errorCode_(errorCode), id_(requestId)
{
}
// JsonRequestException(const JsonRequest& request, const std::string& text, int errorCode = 0) : SnapException(text), errorCode_(errorCode), id_(request.id)
// {
// }
JsonRequestException(const JsonRequestException& e) : SnapException(e.what()), errorCode_(e.errorCode()), id_(e.id_)
{
}
virtual int errorCode() const noexcept
{
return errorCode_;
}
Json getResponse() const noexcept
{
int errorCode = errorCode_;
if (errorCode == 0)
errorCode = -32603;
Json response = {
{"jsonrpc", "2.0"},
{"error", {
{"code", errorCode},
{"message", what()}
}},
};
if (id_ == -1)
response["id"] = nullptr;
else
response["id"] = id_;
return response;
}
};
// -32601 Method not found The method does not exist / is not available.
// -32602 Invalid params Invalid method parameter(s).
// -32603 Internal error Internal JSON-RPC error.
class JsonMethodNotFoundException : public JsonRequestException
{
public:
JsonMethodNotFoundException(int requestId = -1) : JsonRequestException("method not found", -32601, requestId)
{
}
JsonMethodNotFoundException(const std::string& message, int requestId = -1) : JsonRequestException(message, -32601, requestId)
{
}
};
class JsonInvalidParamsException : public JsonRequestException
{
public:
JsonInvalidParamsException(int requestId = -1) : JsonRequestException("invalid params", -32602, requestId)
{
}
JsonInvalidParamsException(const std::string& message, int requestId = -1) : JsonRequestException(message, -32602, requestId)
{
}
};
class JsonInternalErrorException : public JsonRequestException
{
public:
JsonInternalErrorException(int requestId = -1) : JsonRequestException("internal error", -32603, requestId)
{
}
JsonInternalErrorException(const std::string& message, int requestId = -1) : JsonRequestException(message, -32603, requestId)
{
}
};
/// JSON-RPC 2.0 request
/**
* Simple jsonrpc 2.0 parser with getters

140
server/json/jsonrpcException.h Normal file
View file

@ -0,0 +1,140 @@
/***
This file is part of snapcast
Copyright (C) 2015 Johannes Pohl
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 3 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, see <http://www.gnu.org/licenses/>.
***/
#ifndef JSON_RPC_EXCEPTION_H
#define JSON_RPC_EXCEPTION_H
#include <string>
#include <boost/lexical_cast.hpp>
#include "json.hpp"
#include "common/snapException.h"
using Json = nlohmann::json;
class JsonRequestException : public SnapException
{
int errorCode_, id_;
public:
JsonRequestException(const char* text, int errorCode = 0, int requestId = -1) : SnapException(text), errorCode_(errorCode), id_(requestId)
{
}
JsonRequestException(const std::string& text, int errorCode = 0, int requestId = -1) : SnapException(text), errorCode_(errorCode), id_(requestId)
{
}
// JsonRequestException(const JsonRequest& request, const std::string& text, int errorCode = 0) : SnapException(text), errorCode_(errorCode), id_(request.id)
// {
// }
JsonRequestException(const JsonRequestException& e) : SnapException(e.what()), errorCode_(e.errorCode()), id_(e.id_)
{
}
virtual int errorCode() const noexcept
{
return errorCode_;
}
Json getResponse() const noexcept
{
int errorCode = errorCode_;
if (errorCode == 0)
errorCode = -32603;
Json response = {
{"jsonrpc", "2.0"},
{"error", {
{"code", errorCode},
{"message", what()}
}},
};
if (id_ == -1)
response["id"] = nullptr;
else
response["id"] = id_;
return response;
}
};
// -32600 Invalid Request The JSON sent is not a valid Request object.
// -32601 Method not found The method does not exist / is not available.
// -32602 Invalid params Invalid method parameter(s).
// -32603 Internal error Internal JSON-RPC error.
class JsonInvalidRequestException : public JsonRequestException
{
public:
JsonInvalidRequestException(int requestId = -1) : JsonRequestException("invalid request", -32600, requestId)
{
}
JsonInvalidRequestException(const std::string& message, int requestId = -1) : JsonRequestException(message, -32600, requestId)
{
}
};
class JsonMethodNotFoundException : public JsonRequestException
{
public:
JsonMethodNotFoundException(int requestId = -1) : JsonRequestException("method not found", -32601, requestId)
{
}
JsonMethodNotFoundException(const std::string& message, int requestId = -1) : JsonRequestException(message, -32601, requestId)
{
}
};
class JsonInvalidParamsException : public JsonRequestException
{
public:
JsonInvalidParamsException(int requestId = -1) : JsonRequestException("invalid params", -32602, requestId)
{
}
JsonInvalidParamsException(const std::string& message, int requestId = -1) : JsonRequestException(message, -32602, requestId)
{
}
};
class JsonInternalErrorException : public JsonRequestException
{
public:
JsonInternalErrorException(int requestId = -1) : JsonRequestException("internal error", -32603, requestId)
{
}
JsonInternalErrorException(const std::string& message, int requestId = -1) : JsonRequestException(message, -32603, requestId)
{
}
};
#endif

10
testClient.py
View file

@ -48,6 +48,16 @@ doRequest("{\"jsonrpc\": \"2.0\", \"method\": \"Client.SetMute\", \"params\": {\
doRequest("{\"jsonrpc\": \"2.0\", \"method\": \"Client.SetMute\", \"params\": {\"client\": \"00:21:6a:7d:74:fc\", \"mute\": false}, \"id\": 9}\r\n")
doRequest("{\"jsonrpc\": \"2.0\", \"method\": \"Client.SetLatency\", \"params\": {\"client\": \"00:21:6a:7d:74:fc\", \"latency\": 10}, \"id\": 7}\r\n")
doRequest("{\"jsonrpc\": \"2.0\", \"method\": \"Client.SetName\", \"params\": {\"client\": \"00:21:6a:7d:74:fc\", \"name\": \"living room\"}, \"id\": 8}\r\n")
#invalid json
doRequest("some message to test invalid requests\r\n")
#missing id
doRequest("{\"jsonrpc\": \"2.0\", \"method\": \"Client.SetName\", \"params\": {\"client\": \"00:21:6a:7d:74:fc\", \"name\": \"living room\"}}\r\n")
#missing parameter
doRequest("{\"jsonrpc\": \"2.0\", \"method\": \"Client.SetName\", \"params\": {\"client\": \"00:21:6a:7d:74:fc\"}, \"id\": 8}\r\n")
#invalid method
doRequest("{\"jsonrpc\": \"2.0\", \"method\": \"NonExistingMethod\", \"params\": {\"client\": \"00:21:6a:7d:74:fc\"}, \"id\": 8}\r\n")
#out of range
doRequest("{\"jsonrpc\": \"2.0\", \"method\": \"Client.SetVolume\", \"params\": {\"client\": \"00:21:6a:7d:74:fc\", \"volume\": 101}, \"id\": 3}\r\n")
s = raw_input("")
print(s)