Mercurial > hg > orthanc

comparison OrthancFramework/Sources/RestApi/RestApiCall.h @ 4044:d25f4c0fa160 framework

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
splitting code into OrthancFramework and OrthancServer
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 10 Jun 2020 20:30:34 +0200
parents Core/RestApi/RestApiCall.h@94f4a18a79cc
children bf7b9edf6b81
comparison
equal deleted inserted replaced
4043:6c6239aec462 4044:d25f4c0fa160
1 /**
2 * Orthanc - A Lightweight, RESTful DICOM Store
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
4 * Department, University Hospital of Liege, Belgium
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
6 *
7 * This program is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
11 *
12 * In addition, as a special exception, the copyright holders of this
13 * program give permission to link the code of its release with the
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
15 * that use the same license as the "OpenSSL" library), and distribute
16 * the linked executables. You must obey the GNU General Public License
17 * in all respects for all of the code used other than "OpenSSL". If you
18 * modify file(s) with this exception, you may extend this exception to
19 * your version of the file(s), but you are not obligated to do so. If
20 * you do not wish to do so, delete this exception statement from your
21 * version. If you delete this exception statement from all source files
22 * in the program, then also delete it here.
23 *
24 * This program is distributed in the hope that it will be useful, but
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
27 * General Public License for more details.
28 *
29 * You should have received a copy of the GNU General Public License
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 **/
32
33
34 #pragma once
35
36 #include "../HttpServer/IHttpHandler.h"
37 #include "../HttpServer/HttpToolbox.h"
38 #include "RestApiPath.h"
39 #include "RestApiOutput.h"
40
41 #include <boost/noncopyable.hpp>
42
43 namespace Orthanc
44 {
45 class RestApi;
46
47 class RestApiCall : public boost::noncopyable
48 {
49 private:
50 RestApiOutput& output_;
51 RestApi& context_;
52 RequestOrigin origin_;
53 const char* remoteIp_;
54 const char* username_;
55 const IHttpHandler::Arguments& httpHeaders_;
56 const IHttpHandler::Arguments& uriComponents_;
57 const UriComponents& trailing_;
58 const UriComponents& fullUri_;
59
60 protected:
61 static bool ParseJsonRequestInternal(Json::Value& result,
62 const void* body,
63 size_t size);
64
65 public:
66 RestApiCall(RestApiOutput& output,
67 RestApi& context,
68 RequestOrigin origin,
69 const char* remoteIp,
70 const char* username,
71 const IHttpHandler::Arguments& httpHeaders,
72 const IHttpHandler::Arguments& uriComponents,
73 const UriComponents& trailing,
74 const UriComponents& fullUri) :
75 output_(output),
76 context_(context),
77 origin_(origin),
78 remoteIp_(remoteIp),
79 username_(username),
80 httpHeaders_(httpHeaders),
81 uriComponents_(uriComponents),
82 trailing_(trailing),
83 fullUri_(fullUri)
84 {
85 }
86
87 RestApiOutput& GetOutput()
88 {
89 return output_;
90 }
91
92 RestApi& GetContext()
93 {
94 return context_;
95 }
96
97 const UriComponents& GetFullUri() const
98 {
99 return fullUri_;
100 }
101
102 const UriComponents& GetTrailingUri() const
103 {
104 return trailing_;
105 }
106
107 std::string GetUriComponent(const std::string& name,
108 const std::string& defaultValue) const
109 {
110 return HttpToolbox::GetArgument(uriComponents_, name, defaultValue);
111 }
112
113 std::string GetHttpHeader(const std::string& name,
114 const std::string& defaultValue) const
115 {
116 return HttpToolbox::GetArgument(httpHeaders_, name, defaultValue);
117 }
118
119 const IHttpHandler::Arguments& GetHttpHeaders() const
120 {
121 return httpHeaders_;
122 }
123
124 void ParseCookies(IHttpHandler::Arguments& result) const
125 {
126 HttpToolbox::ParseCookies(result, httpHeaders_);
127 }
128
129 std::string FlattenUri() const;
130
131 RequestOrigin GetRequestOrigin() const
132 {
133 return origin_;
134 }
135
136 const char* GetRemoteIp() const
137 {
138 return remoteIp_;
139 }
140
141 const char* GetUsername() const
142 {
143 return username_;
144 }
145
146 virtual bool ParseJsonRequest(Json::Value& result) const = 0;
147 };
148 }