1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2023 Jon Evans <jon@craftyjon.com>
* Copyright The KiCad Developers, see AUTHORS.txt for contributors.
*
* 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 KICAD_API_HANDLER_H
#define KICAD_API_HANDLER_H
#include <functional>
#include <optional>
#include <fmt/format.h>
#include <tl/expected.hpp>
#include <wx/debug.h>
#include <wx/string.h>
#include <google/protobuf/message.h>
#include <kicommon.h>
#include <api/common/envelope.pb.h>
#include <core/typeinfo.h>
using kiapi::common::ApiRequest, kiapi::common::ApiResponse;
using kiapi::common::ApiResponseStatus, kiapi::common::ApiStatusCode;
typedef tl::expected<ApiResponse, ApiResponseStatus> API_RESULT;
template <typename T>
using HANDLER_RESULT = tl::expected<T, ApiResponseStatus>;
template <typename RequestMessageType>
struct HANDLER_CONTEXT
{
std::string ClientName;
RequestMessageType Request;
};
class KICOMMON_API API_HANDLER
{
public:
API_HANDLER() {}
virtual ~API_HANDLER() {}
/**
* Attempt to handle the given API request, if a handler exists in this class for the message.
* @param aMsg is a request to attempt to handle
* @return a response to send to the client, or an appropriate error
*/
API_RESULT Handle( ApiRequest& aMsg );
protected:
/**
* A handler for outer messages (envelopes) that will unpack to inner messages and call a
* specific handler function. @see registerHandler.
*/
typedef std::function<HANDLER_RESULT<ApiResponse>( ApiRequest& )> REQUEST_HANDLER;
/**
* Registers an API command handler for the given message types.
*
* When an API request matching the given type comes in, the handler will be called and its
* response will be packed into an envelope for sending back to the API client.
*
* If the given message does not unpack into the request type, an envelope is returned with
* status AS_BAD_REQUEST, which probably indicates corruption in the message.
*
* @tparam RequestType is a protobuf message type containing a command
* @tparam ResponseType is a protobuf message type containing a command response
* @tparam HandlerType is the implied type of the API_HANDLER subclass
* @param aHandler is the handler function for the given request and response types
*/
template <class RequestType, class ResponseType, class HandlerType>
void registerHandler( HANDLER_RESULT<ResponseType> ( HandlerType::*aHandler )(
const HANDLER_CONTEXT<RequestType>& ) )
{
std::string typeName { RequestType().GetTypeName() };
wxASSERT_MSG( !m_handlers.contains( typeName ),
wxString::Format( "Duplicate API handler for type %s", typeName ) );
m_handlers[typeName] =
[this, aHandler]( ApiRequest& aRequest ) -> API_RESULT
{
HANDLER_CONTEXT<RequestType> ctx;
ApiResponse envelope;
if( !tryUnpack( aRequest, envelope, ctx.Request ) )
return envelope;
ctx.ClientName = aRequest.header().client_name();
HANDLER_RESULT<ResponseType> response =
std::invoke( aHandler, static_cast<HandlerType*>( this ), ctx );
if( response.has_value() )
{
envelope.mutable_status()->set_status( ApiStatusCode::AS_OK );
envelope.mutable_message()->PackFrom( *response );
return envelope;
}
else
{
return tl::unexpected( response.error() );
}
};
}
/// Maps type name (without the URL prefix) to a handler method
std::map<std::string, REQUEST_HANDLER> m_handlers;
static const wxString m_defaultCommitMessage;
private:
template<typename MessageType>
bool tryUnpack( ApiRequest& aRequest, ApiResponse& aReply, MessageType& aDest )
{
if( !aRequest.message().UnpackTo( &aDest ) )
{
std::string msg = fmt::format( "could not unpack message of type {} from request",
aDest.GetTypeName() );
aReply.mutable_status()->set_status( ApiStatusCode::AS_BAD_REQUEST );
aReply.mutable_status()->set_error_message( msg );
return false;
}
return true;
}
};
#endif //KICAD_API_HANDLER_H
|
