delphimvcframework/sources/MVCFramework.JSONRPC.pas

1036 lines
27 KiB
ObjectPascal
Raw Normal View History

// ***************************************************************************
//
// Delphi MVC Framework
//
// Copyright (c) 2010-2018 Daniele Teti and the DMVCFramework Team
//
// https://github.com/danieleteti/delphimvcframework
//
// ***************************************************************************
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// *************************************************************************** }
2017-09-24 19:40:40 +02:00
unit MVCFramework.JSONRPC;
{
JSON-RPC over HTTP implemented as described here
https://www.jsonrpc.org/historical/json-rpc-over-http.html
}
2017-09-24 19:40:40 +02:00
interface
uses
System.Classes,
Data.DB,
System.SysUtils,
jsondataobjects,
MVCFramework,
MVCFramework.Commons,
System.Rtti,
System.Generics.Collections,
MVCFramework.Serializer.Commons,
MVCFramework.Serializer.jsondataobjects;
2017-09-24 19:40:40 +02:00
const
JSONRPC_VERSION = '2.0';
JSONRPC_HEADER = 'jsonrpc';
JSONRPC_METHOD = 'method';
JSONRPC_PARAMS = 'params';
JSONRPC_ID = 'id';
JSONRPC_RESULT = 'result';
JSONRPC_ERROR = 'error';
JSONRPC_CODE = 'code';
JSONRPC_MESSAGE = 'message';
JSONRPC_DATA = 'data';
type
IMVCJSONRPCMessage = interface
['{73B8D463-75E1-404B-8437-EF4B3C950D2F}']
function AsJSONRPCMessage: string;
end;
TMVCJSONRPCMessage = class abstract(TInterfacedObject, IMVCJSONRPCMessage)
2017-09-24 19:40:40 +02:00
private
fJSON: TJsonObject;
protected
class procedure CheckVersion(const aJSON: TJsonObject);
class procedure CheckMethod(const aJSON: TJsonObject);
class procedure CheckID(const aJSON: TJsonObject; out aIsNotification: Boolean);
constructor Create; overload;
procedure Build(const aJSON: TJsonObject); virtual; abstract;
{ IMVCJSONRPCMessage }
function AsJSONRPCMessage: string;
public
function AsJSON: TJsonObject; virtual;
end;
TJSONRPCObject = class(TObject)
protected
procedure SetJsonString(const Value: string); virtual;
function GetJSONString: string; virtual;
function GetJSON: TJsonObject; virtual;
procedure SetJSON(const Value: TJsonObject); virtual;
public
constructor Create; virtual;
property AsJSON: TJsonObject read GetJSON write SetJSON;
property AsJSONString: string read GetJSONString write SetJsonString;
end;
TJSONRPCNotification = class(TJSONRPCObject)
protected type
TJSONRPCRequestParams = TList<TValue>;
protected
FMethod: string;
FParams: TJSONRPCRequestParams;
procedure SetMethod(const Value: string);
protected
function GetJSON: TJsonObject; override;
2017-09-24 19:40:40 +02:00
public
constructor Create; override;
destructor Destroy; override;
property Method: string read FMethod write SetMethod;
property Params: TJSONRPCRequestParams read FParams;
2017-09-24 19:40:40 +02:00
end;
{$SCOPEDENUMS ON}
TJSONRPCRequestType = (Request, Notification);
TJSONRPCRequest = class(TJSONRPCNotification)
2017-09-24 19:40:40 +02:00
private
FID: TValue;
function GetRequestType: TJSONRPCRequestType;
protected
procedure SetJSON(const JSON: TJsonObject); override;
function GetJSON: TJsonObject; override;
procedure SetID(const Value: TValue);
public
constructor Create; override;
destructor Destroy; override;
property RequestType: TJSONRPCRequestType read GetRequestType;
property RequestID: TValue read FID write SetID;
end;
TJSONRPCResponse = class(TJSONRPCObject)
private type
TJSONRPCResponseError = class
private
FCode: Integer;
FMessage: string;
procedure SetCode(const Value: Integer);
procedure SetMessage(const Value: string);
public
property Code: Integer read FCode write SetCode;
property ErrMessage: string read FMessage write SetMessage;
end;
private
FResult: TValue;
FError: TJSONRPCResponseError;
FID: TValue;
procedure SetID(const Value: TValue);
procedure SetResult(const Value: TValue);
procedure SetError(const Value: TJSONRPCResponseError);
2017-09-24 19:40:40 +02:00
protected
function GetJSON: TJsonObject; override;
procedure SetJSON(const JSON: TJsonObject); override;
2017-09-24 19:40:40 +02:00
public
constructor Create; override;
2017-09-24 19:40:40 +02:00
destructor Destroy; override;
property Result: TValue read FResult write SetResult;
property Error: TJSONRPCResponseError read FError write SetError;
property RequestID: TValue read FID write SetID;
2017-09-24 19:40:40 +02:00
end;
EMVCJSONRPCInvalidVersion = class(Exception)
end;
EMVCJSONRPCException = class(Exception)
end;
EMVCJSONRPCErrorResponse = class abstract(Exception)
2017-09-24 19:40:40 +02:00
private
FJSONRPCErrorCode: Integer;
public
property JSONRPCErrorCode: Integer read FJSONRPCErrorCode;
end;
EMVCJSONRPCParseError = class(EMVCJSONRPCErrorResponse)
2017-09-24 19:40:40 +02:00
public
constructor Create;
end;
EMVCJSONRPCInvalidRequest = class(EMVCJSONRPCErrorResponse)
2017-09-24 19:40:40 +02:00
public
constructor Create;
end;
EMVCJSONRPCMethodNotFound = class(EMVCJSONRPCErrorResponse)
2017-09-24 19:40:40 +02:00
public
constructor Create(const MethodName: string);
2017-09-24 19:40:40 +02:00
end;
EMVCJSONRPCInvalidParams = class(EMVCJSONRPCErrorResponse)
2017-09-24 19:40:40 +02:00
public
constructor Create(const message: string);
2017-09-24 19:40:40 +02:00
end;
EMVCJSONRPCInternalError = class(EMVCJSONRPCErrorResponse)
2017-09-24 19:40:40 +02:00
public
constructor Create;
end;
{ -32000 to -32099 Server error Reserved for implementation-defined server-errors. }
EMVCJSONRPCServerError = class(EMVCJSONRPCErrorResponse)
2017-09-24 19:40:40 +02:00
public
constructor Create(const JSONRPCError: Integer; const message: string);
2017-09-24 19:40:40 +02:00
end;
TMVCJSONObject = TJsonObject;
2017-09-24 19:40:40 +02:00
TMVCJSONArray = TJDOJsonArray;
TMVCJSONRPCController = class(TMVCController)
private
fSerializer: TMVCJsonDataObjectsSerializer;
fRPCInstance: TObject;
fOwsRPCInstance: Boolean;
function GetSerializer: TMVCJsonDataObjectsSerializer;
procedure InjectParams(lJSONRPCReq: TJSONRPCRequest; lRTTIMethod: TRttiMethod);
2017-09-24 19:40:40 +02:00
protected
function CreateError(const RequestID: TValue; const ErrorCode: Integer; const message: string): TJsonObject;
function CreateResponse(const RequestID: TValue; const Value: TValue): TJSONRPCResponse;
function CreateRequest(const JSON: TJsonObject): TJSONRPCRequest;
function JSONObjectAs<T: class, constructor>(const JSON: TJsonObject): T;
2017-09-24 19:40:40 +02:00
public
[MVCPath]
[MVCHTTPMethods([httpPOST])]
[MVCConsumes(TMVCMediaType.APPLICATION_JSON)]
[MVCProduces(TMVCMediaType.APPLICATION_JSON)]
procedure Index; virtual;
constructor Create; overload; override;
destructor Destroy; override;
2017-09-24 19:40:40 +02:00
end;
TMVCJSONRPCPublisher = class(TMVCJSONRPCController)
public
constructor Create(const RPCInstance: TObject; const Owns: Boolean = True); reintroduce; overload;
end;
2017-09-24 19:40:40 +02:00
implementation
uses
MVCFramework.Serializer.Intf,
System.TypInfo;
function JSONDataValueToTValue(const JSONDataValue: TJsonDataValueHelper): TValue;
begin
case JSONDataValue.Typ of
jdtString:
begin
Result := JSONDataValue.Value;
end;
jdtFloat:
begin
Result := JSONDataValue.FloatValue;
end;
jdtBool:
begin
Result := JSONDataValue.BoolValue;
end;
jdtArray:
begin
Result := TJsonArray.Parse(JSONDataValue.ArrayValue.ToJSON) as TJsonArray;
end;
jdtObject:
begin
Result := TJsonObject.Parse(JSONDataValue.ObjectValue.ToJSON) as TJsonObject;
end;
jdtInt:
begin
Result := JSONDataValue.IntValue;
end;
jdtLong:
begin
Result := JSONDataValue.LongValue;
end;
jdtULong:
begin
Result := JSONDataValue.ULongValue;
end;
else
raise EMVCJSONRPCException.Create('Invalid parameter type');
end;
end;
procedure TValueToJsonElement(const Value: TValue; const JSON: TJsonObject; const KeyName: string);
var
lSer: TMVCJsonDataObjectsSerializer;
begin
case Value.Kind of
tkInteger:
begin
JSON.I[KeyName] := Value.AsInteger;
end;
tkFloat:
begin
JSON.D[KeyName] := Value.AsExtended;
end;
tkString, tkUString, tkWChar, tkLString, tkWString:
begin
JSON.S[KeyName] := Value.AsString;
end;
tkInt64:
begin
JSON.I[KeyName] := Value.AsInt64;
end;
tkClass:
begin
if Value.AsObject is TJsonObject then
begin
JSON.O[KeyName] := TJsonObject.Create;
JSON.O[KeyName].Assign(TJsonObject(Value.AsObject));
end
else if Value.AsObject is TJsonArray then
begin
JSON.A[KeyName] := TJsonArray.Create;
JSON.A[KeyName].Assign(TJsonArray(Value.AsObject));
end
else if Value.AsObject is TDataSet then
begin
lSer := TMVCJsonDataObjectsSerializer.Create;
try
JSON.A[KeyName] := TJsonArray.Create;
lSer.DataSetToJsonArray(TDataSet(Value.AsObject), JSON.A[KeyName], TMVCNameCase.ncLowerCase, []);
finally
lSer.Free;
end;
end
else
begin
lSer := TMVCJsonDataObjectsSerializer.Create;
try
JSON.O[KeyName] := TJsonObject.Create;
lSer.ObjectToJsonObject(Value.AsObject, JSON.O[KeyName], TMVCSerializationType.stProperties, []);
finally
lSer.Free;
end;
end;
end;
else
raise EMVCJSONRPCException.Create('Invalid parameter type');
end;
end;
procedure AppendTValueToJsonArray(const Value: TValue; const JSONArr: TJsonArray);
var
lSer: TMVCJsonDataObjectsSerializer;
lJArr: TJsonArray;
lJObj: TJsonObject;
begin
case Value.Kind of
tkInteger:
begin
JSONArr.Add(Value.AsInteger);
end;
tkFloat:
begin
JSONArr.Add(Value.AsExtended);
end;
tkString, tkUString, tkWChar, tkLString, tkWString:
begin
JSONArr.Add(Value.AsString);
end;
tkInt64:
begin
JSONArr.Add(Value.AsInt64);
end;
tkClass:
begin
if Value.AsObject is TJsonObject then
begin
lJObj := TJsonObject.Create;
JSONArr.Add(lJObj);
lJObj.Assign(TJsonObject(Value.AsObject));
end
else if Value.AsObject is TJsonArray then
begin
lJArr := TJsonArray.Create;
JSONArr.Add(lJArr);
lJArr.Assign(TJsonArray(Value.AsObject));
end
else if Value.AsObject is TDataSet then
begin
lSer := TMVCJsonDataObjectsSerializer.Create;
try
lJArr := TJsonArray.Create;
JSONArr.Add(lJArr);
lSer.DataSetToJsonArray(TDataSet(Value.AsObject), lJArr, TMVCNameCase.ncLowerCase, []);
finally
lSer.Free;
end
end
else
begin
lSer := TMVCJsonDataObjectsSerializer.Create;
try
lJObj := TJsonObject.Create;
JSONArr.Add(lJObj);
lSer.ObjectToJsonObject(Value.AsObject, lJObj, TMVCSerializationType.stProperties, []);
finally
lSer.Free;
end;
end;
end;
else
raise EMVCJSONRPCException.Create('Invalid parameter type');
end;
end;
function StringToJSON(const aValue: string): TJsonObject;
var
lJSON: TJsonObject;
begin
lJSON := nil;
try
lJSON := TJsonObject.Parse(aValue) as TJsonObject;
Result := lJSON;
except
on E: Exception do
begin
lJSON.Free;
raise EMVCJSONRPCParseError.Create;
end;
end;
end;
2017-09-24 19:40:40 +02:00
{ TMVCJSONRPCMessage }
function TMVCJSONRPCMessage.AsJSON: TJsonObject;
2017-09-24 19:40:40 +02:00
begin
Result := TMVCJSONObject.Create;
Result.S[JSONRPC_HEADER] := JSONRPC_VERSION;
end;
function TMVCJSONRPCMessage.AsJSONRPCMessage: string;
begin
Result := fJSON.ToJSON();
end;
class procedure TMVCJSONRPCMessage.CheckID(const aJSON: TMVCJSONObject; out aIsNotification: Boolean);
2017-09-24 19:40:40 +02:00
begin
{
id
An identifier established by the Client that MUST contain a String, Number, or NULL value if included.
If it is not included it is assumed to be a notification.
The value SHOULD normally not be Null [1] and Numbers SHOULD NOT contain fractional parts [2]
}
aIsNotification := not aJSON.Contains(JSONRPC_ID);
if not aIsNotification then
begin
if not(aJSON.Types[JSONRPC_ID] in [jdtString, jdtInt, jdtLong, jdtULong, jdtNone]) then
raise EMVCJSONRPCException.Create('Message is not a notification but its ''id'' property is not valid');
2017-09-24 19:40:40 +02:00
end;
end;
class procedure TMVCJSONRPCMessage.CheckMethod(const aJSON: TMVCJSONObject);
2017-09-24 19:40:40 +02:00
begin
if (aJSON.Types[JSONRPC_METHOD] <> jdtString) then
raise EMVCJSONRPCException.Create('Invalid ''method''');
end;
class procedure TMVCJSONRPCMessage.CheckVersion(const aJSON: TMVCJSONObject);
2017-09-24 19:40:40 +02:00
begin
if not Assigned(aJSON) then
raise EMVCJSONRPCException.Create('JSON not assigned');
if aJSON.S[JSONRPC_HEADER] <> JSONRPC_VERSION then
raise EMVCJSONRPCInvalidVersion.Create(JSONRPC_HEADER + ' must be "2.0"');
end;
constructor TMVCJSONRPCMessage.Create;
2017-09-24 19:40:40 +02:00
begin
inherited Create;
end;
{ TMVCJSONRPCController }
2017-09-24 19:40:40 +02:00
constructor TMVCJSONRPCPublisher.Create(const RPCInstance: TObject; const Owns: Boolean);
begin
inherited Create;
fRPCInstance := RPCInstance;
fOwsRPCInstance := Owns;
end;
constructor TMVCJSONRPCController.Create;
begin
inherited Create;
fRPCInstance := Self;
fOwsRPCInstance := False;
end;
function TMVCJSONRPCController.CreateError(const RequestID: TValue; const ErrorCode: Integer; const message: string): TJsonObject;
var
lErrResp: TJSONRPCResponse;
2017-09-24 19:40:40 +02:00
begin
lErrResp := TJSONRPCResponse.Create;
try
lErrResp.RequestID := RequestID;
lErrResp.Error := TJSONRPCResponse.TJSONRPCResponseError.Create;
lErrResp.Error.Code := ErrorCode;
lErrResp.Error.ErrMessage := message;
Result := lErrResp.AsJSON;
finally
lErrResp.Free;
end;
2017-09-24 19:40:40 +02:00
end;
function TMVCJSONRPCController.CreateRequest(const JSON: TJsonObject): TJSONRPCRequest;
var
I: Integer;
lParams: TJsonArray;
2017-09-24 19:40:40 +02:00
begin
try
Result := TJSONRPCRequest.Create;
if JSON.Types[JSONRPC_ID] = jdtString then
Result.RequestID := JSON.S[JSONRPC_ID]
else if JSON.Types[JSONRPC_ID] = jdtInt then
Result.RequestID := JSON.I[JSONRPC_ID]
else if JSON.Types[JSONRPC_ID] = jdtLong then
Result.RequestID := JSON.L[JSONRPC_ID]
else if JSON.Types[JSONRPC_ID] = jdtULong then
Result.RequestID := JSON.U[JSONRPC_ID]
else
Result.RequestID := TValue.Empty;
2017-09-24 19:40:40 +02:00
Result.Method := JSON.S[JSONRPC_METHOD];
if JSON.Types[JSONRPC_PARAMS] = jdtArray then
begin
lParams := JSON.A[JSONRPC_PARAMS];
for I := 0 to lParams.Count - 1 do
begin
Result.Params.Add(JSONDataValueToTValue(lParams[I]));
end;
end
else if JSON.Types[JSONRPC_PARAMS] <> jdtNone then
begin
raise EMVCJSONRPCException.Create('Params must be a JSON array or null');
end;
finally
JSON.Free;
end;
2017-09-24 19:40:40 +02:00
end;
function TMVCJSONRPCController.CreateResponse(const RequestID: TValue; const Value: TValue): TJSONRPCResponse;
2017-09-24 19:40:40 +02:00
begin
Result := TJSONRPCResponse.Create;
Result.RequestID := RequestID;
Result.Result := Value;
2017-09-24 19:40:40 +02:00
end;
destructor TMVCJSONRPCController.Destroy;
begin
if Assigned(fRPCInstance) and fOwsRPCInstance then
begin
fRPCInstance.Free;
end;
fSerializer.Free;
inherited;
end;
procedure TMVCJSONRPCController.InjectParams(lJSONRPCReq: TJSONRPCRequest; lRTTIMethod: TRttiMethod);
var
lRTTIMethodParams: TArray<TRttiParameter>;
lRTTIMethodParam: TRttiParameter;
begin
lRTTIMethodParams := lRTTIMethod.GetParameters;
if (Length(lRTTIMethodParams) <> lJSONRPCReq.Params.Count) then
raise EMVCJSONRPCInvalidParams.CreateFmt('Wrong parameters count. Expected %d got %d.',
[Length(lRTTIMethodParams), lJSONRPCReq.Params.Count]);
for lRTTIMethodParam in lRTTIMethodParams do
begin
if lRTTIMethodParam.Flags * [pfVar, pfOut, pfArray, pfReference] <> [] then
raise EMVCJSONRPCInvalidParams.CreateFmt
('Parameter modifier not supported for formal parameter [%s]. Only const and value modifiers are allowed.',
[lRTTIMethodParam.Name]);
end;
end;
function TMVCJSONRPCController.GetSerializer: TMVCJsonDataObjectsSerializer;
begin
if not Assigned(fSerializer) then
fSerializer := TMVCJsonDataObjectsSerializer.Create;
Result := fSerializer;
end;
procedure TMVCJSONRPCController.Index;
2017-09-24 19:40:40 +02:00
var
lJSONRPCReq: TJSONRPCRequest;
2017-09-24 19:40:40 +02:00
lMethod: string;
lRTTI: TRTTIContext;
lRTTIType: TRttiType;
lRTTIMethod: TRttiMethod;
lRes: TValue;
lJSONRPCResponse: TJSONRPCResponse;
2017-09-24 19:40:40 +02:00
lParamsToInject: TArray<TValue>;
lReqID: TValue;
lJSON: TJsonObject;
2017-09-24 19:40:40 +02:00
begin
lReqID := TValue.Empty;
2017-09-24 19:40:40 +02:00
SetLength(lParamsToInject, 0);
try
lJSON := StringToJSON(Context.Request.Body);
if not Assigned(lJSON) then
raise EMVCJSONRPCParseError.Create;
lJSONRPCReq := CreateRequest(lJSON);
2017-09-24 19:40:40 +02:00
try
lMethod := lJSONRPCReq.Method;
if lJSONRPCReq.RequestType = TJSONRPCRequestType.Request then
begin
if lJSONRPCReq.RequestID.IsEmpty then
raise EMVCJSONRPCInvalidRequest.Create;
lReqID := lJSONRPCReq.RequestID;
end;
lRTTI := TRTTIContext.Create;
try
lRTTIType := lRTTI.GetType(fRPCInstance.ClassType);
lRTTIMethod := lRTTIType.GetMethod(lMethod);
if Assigned(lRTTIMethod) then
2017-09-24 19:40:40 +02:00
begin
InjectParams(lJSONRPCReq, lRTTIMethod);
try
lRes := lRTTIMethod.Invoke(fRPCInstance, lJSONRPCReq.Params.ToArray);
except
on E: EInvalidCast do
begin
raise EMVCJSONRPCInvalidParams.Create('Check your input parameters types');
end;
end;
case lJSONRPCReq.RequestType of
TJSONRPCRequestType.Notification:
begin
if lRes.IsObjectInstance then
lRes.AsObject.Free;
ResponseStatus(HTTP_STATUS.NoContent);
end;
TJSONRPCRequestType.Request:
begin
lJSONRPCResponse := CreateResponse(lJSONRPCReq.RequestID, lRes);
try
ResponseStatus(200);
Render(lJSONRPCResponse.AsJSON);
finally
lJSONRPCResponse.Free;
end;
end;
else
raise EMVCJSONRPCException.Create('Invalid RequestType');
2017-09-24 19:40:40 +02:00
end;
end
else
raise EMVCJSONRPCMethodNotFound.Create(lMethod);
finally
lRTTI.Free;
end;
2017-09-24 19:40:40 +02:00
finally
lJSONRPCReq.Free;
2017-09-24 19:40:40 +02:00
end;
except
on E: EMVCJSONRPCErrorResponse do
begin
{
http://www.jsonrpc.org/historical/json-rpc-over-http.html#response-codes
HTTP Status code message
500 -32700 Parse error.
400 -32600 Invalid Request.
404 -32601 Method not found.
500 -32602 Invalid params.
500 -32603 Internal error.
500 -32099..-32000 Server error.
}
case E.JSONRPCErrorCode of
- 32700:
ResponseStatus(500);
-32600:
ResponseStatus(400);
-32601:
ResponseStatus(404);
-32602:
ResponseStatus(500);
-32603:
ResponseStatus(500);
-32099 .. -32000:
ResponseStatus(500);
2017-09-24 19:40:40 +02:00
end;
Render(CreateError(lReqID, E.JSONRPCErrorCode, E.message), True);
end;
on E: Exception do
begin
Render(CreateError(lReqID, 0, E.message), True);
end;
2017-09-24 19:40:40 +02:00
end;
end;
function TMVCJSONRPCController.JSONObjectAs<T>(const JSON: TJsonObject): T;
begin
Result := T.Create;
try
GetSerializer.JsonObjectToObject(JSON, Result, TMVCSerializationType.stProperties, []);
except
Result.Free;
raise;
end;
end;
2017-09-24 19:40:40 +02:00
{ EMVCJSONRPCParseError }
constructor EMVCJSONRPCParseError.Create;
begin
inherited Create('Parse error. Invalid JSON was received by the server. An error occurred on the server while parsing the JSON text');
2017-09-24 19:40:40 +02:00
FJSONRPCErrorCode := -32700;
end;
{ EMVCJSONRPCInvalidRequest }
constructor EMVCJSONRPCInvalidRequest.Create;
begin
inherited Create('Invalid Request. The JSON sent is not a valid Request object.');
2017-09-24 19:40:40 +02:00
FJSONRPCErrorCode := -32600;
end;
{ EMVCJSONRPCMethodNotFound }
constructor EMVCJSONRPCMethodNotFound.Create(const MethodName: string);
2017-09-24 19:40:40 +02:00
begin
inherited CreateFmt('Method "%s" not found. The method does not exist or is not available.', [MethodName]);
2017-09-24 19:40:40 +02:00
FJSONRPCErrorCode := -32601;
end;
{ EMVCJSONRPCInvalidParams }
constructor EMVCJSONRPCInvalidParams.Create(const message: string);
2017-09-24 19:40:40 +02:00
begin
inherited Create('Invalid params. [hint: ' + message + ']');
FJSONRPCErrorCode := -32602;
end;
{ EMVCJSONRPCInternalError }
constructor EMVCJSONRPCInternalError.Create;
begin
inherited Create('Internal JSON-RPC error');
FJSONRPCErrorCode := -32603;
end;
{ EMVCJSONRPCServerError }
constructor EMVCJSONRPCServerError.Create(const JSONRPCError: Integer; const message: string);
2017-09-24 19:40:40 +02:00
begin
inherited Create(message);
FJSONRPCErrorCode := JSONRPCError;
end;
{ TJSONRPCRequest }
constructor TJSONRPCRequest.Create;
begin
inherited Create;
end;
destructor TJSONRPCRequest.Destroy;
begin
inherited;
end;
function TJSONRPCRequest.GetRequestType: TJSONRPCRequestType;
begin
if FID.IsEmpty then
Result := TJSONRPCRequestType.Notification
else
Result := TJSONRPCRequestType.Request;
end;
procedure TJSONRPCRequest.SetJSON(const JSON: TJsonObject);
var
I: Integer;
lParams: TJsonArray;
begin
if JSON.Types[JSONRPC_ID] = jdtString then
RequestID := JSON.S[JSONRPC_ID]
else if JSON.Types[JSONRPC_ID] = jdtInt then
RequestID := JSON.I[JSONRPC_ID]
else if JSON.Types[JSONRPC_ID] = jdtLong then
RequestID := JSON.L[JSONRPC_ID]
else if JSON.Types[JSONRPC_ID] = jdtULong then
RequestID := JSON.U[JSONRPC_ID]
else
RequestID := TValue.Empty;
Method := JSON.S[JSONRPC_METHOD];
Params.Clear;
if JSON.Types[JSONRPC_PARAMS] = jdtArray then
begin
lParams := JSON.A[JSONRPC_PARAMS];
for I := 0 to lParams.Count - 1 do
begin
Params.Add(JSONDataValueToTValue(lParams[I]));
end;
end
else if JSON.Types[JSONRPC_PARAMS] <> jdtNone then
begin
raise EMVCJSONRPCException.Create('Params must be a JSON array or null');
end;
end;
destructor TJSONRPCNotification.Destroy;
var
lValue: TValue;
begin
for lValue in FParams do
begin
if lValue.IsObjectInstance then
lValue.AsObject.Free;
end;
FParams.Free;
inherited;
end;
function TJSONRPCNotification.GetJSON: TJsonObject;
var
I: Integer;
begin
if FMethod.IsEmpty then
raise EMVCJSONRPCException.Create('JSON-RPC "Method" cannot be empty');
Result := inherited;
Result.S[JSONRPC_METHOD] := FMethod;
if FParams.Count > 0 then
begin
for I := 0 to FParams.Count - 1 do
begin
AppendTValueToJsonArray(FParams[I], Result.A[JSONRPC_PARAMS]);
end;
end;
end;
procedure TJSONRPCNotification.SetMethod(const Value: string);
begin
FMethod := Value;
end;
{ TJSONRCPResponse }
constructor TJSONRPCResponse.Create;
begin
inherited;
FError := nil;
end;
destructor TJSONRPCResponse.Destroy;
begin
FreeAndNil(FError);
if FResult.IsObjectInstance then
FResult.AsObject.Free;
inherited;
end;
function TJSONRPCResponse.GetJSON: TJsonObject;
begin
Result := inherited;
// Must generate something like the following:
// {"jsonrpc": "2.0", "error": {"code": -32601, "message": "Method not found"}, "id": "1"}
if FID.IsEmpty then
begin
Result.Values[JSONRPC_ID] := jdtNone;
end
else if FID.IsType<string> then
begin
Result.S[JSONRPC_ID] := FID.AsString;
end
else if FID.IsType<Int32> then
begin
Result.I[JSONRPC_ID] := FID.AsInteger;
end
else if FID.IsType<Int64> then
begin
Result.I[JSONRPC_ID] := FID.AsInt64;
end
else
raise EMVCJSONRPCException.Create('ID can be only Int32, Int64 or String');
try
if Assigned(FError) then
begin
Result.O[JSONRPC_ERROR].I[JSONRPC_CODE] := FError.Code;
Result.O[JSONRPC_ERROR].S[JSONRPC_MESSAGE] := FError.ErrMessage;
end
else
begin
TValueToJsonElement(Self.FResult, Result, JSONRPC_RESULT);
end;
except
Result.Free;
raise;
end;
end;
procedure TJSONRPCResponse.SetError(const Value: TJSONRPCResponseError);
begin
FError := Value;
end;
procedure TJSONRPCResponse.SetID(const Value: TValue);
begin
FID := Value;
end;
procedure TJSONRPCResponse.SetJSON(const JSON: TJsonObject);
begin
if JSON.Types[JSONRPC_ID] = jdtString then
RequestID := JSON.S[JSONRPC_ID]
else if JSON.Types[JSONRPC_ID] = jdtInt then
RequestID := JSON.I[JSONRPC_ID]
else if JSON.Types[JSONRPC_ID] = jdtLong then
RequestID := JSON.L[JSONRPC_ID]
else if JSON.Types[JSONRPC_ID] = jdtULong then
RequestID := JSON.U[JSONRPC_ID]
else
RequestID := TValue.Empty;
if JSON.Contains(JSONRPC_RESULT) then
begin
FreeAndNil(FError);
FResult := JSONDataValueToTValue(JSON.Values[JSONRPC_RESULT]);
end
else
begin
FResult := TValue.Empty;
if JSON.Contains(JSONRPC_ERROR) then
begin
FError := TJSONRPCResponseError.Create;
FError.Code := JSON.O[JSONRPC_ERROR].I[JSONRPC_CODE];
FError.ErrMessage := JSON.O[JSONRPC_ERROR].S[JSONRPC_MESSAGE];
end
else
raise EMVCJSONRPCException.Create('Response message must have ''result'' or ''error''');
end;
end;
procedure TJSONRPCResponse.SetResult(const Value: TValue);
begin
FResult := Value;
end;
{ TJSONRPCNotification }
constructor TJSONRPCNotification.Create;
begin
inherited;
FParams := TJSONRPCRequestParams.Create;
end;
constructor TJSONRPCObject.Create;
begin
inherited;
end;
function TJSONRPCObject.GetJSON: TJsonObject;
begin
Result := TJsonObject.Create;
Result.S[JSONRPC_HEADER] := JSONRPC_VERSION;
end;
function TJSONRPCObject.GetJSONString: string;
var
lJSON: TJsonObject;
begin
lJSON := GetJSON;
try
Result := lJSON.ToJSON;
finally
lJSON.Free;
end;
end;
procedure TJSONRPCRequest.SetID(const Value: TValue);
begin
FID := Value;
end;
procedure TJSONRPCObject.SetJSON(const Value: TJsonObject);
begin
// not implemented
raise Exception.Create('This method must be overwritten by child');
end;
procedure TJSONRPCObject.SetJsonString(const Value: string);
var
lJSON: TJsonObject;
begin
try
lJSON := TJsonObject.Parse(Value) as TJsonObject;
except
raise EMVCJSONRPCParseError.Create;
end;
try
AsJSON := lJSON;
finally
lJSON.Free;
end;
end;
{ TJSONRPCResponseError }
procedure TJSONRPCResponse.TJSONRPCResponseError.SetCode(const Value: Integer);
begin
FCode := Value;
end;
procedure TJSONRPCResponse.TJSONRPCResponseError.SetMessage(const Value: string);
begin
FMessage := Value;
end;
{ TJSONRPCMessage }
function TJSONRPCRequest.GetJSON: TJsonObject;
begin
Result := inherited GetJSON;
if not FID.IsEmpty then
begin
if FID.IsType<string> then
begin
Result.S[JSONRPC_ID] := FID.AsString;
end
else if FID.IsType<Int32> then
begin
Result.I[JSONRPC_ID] := FID.AsInteger;
end
else if FID.IsType<Int64> then
begin
Result.I[JSONRPC_ID] := FID.AsInt64;
end
else
raise EMVCJSONRPCException.Create('ID can be only Int32, Int64 or String');
end;
end;
2017-09-24 19:40:40 +02:00
end.