Mercurial > hg > orthanc
annotate Core/RestApi/RestApiCall.h @ 3640:94f4a18a79cc
upgrade to year 2020
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Fri, 31 Jan 2020 17:14:59 +0100 |
| parents | 962e5f00744b |
| children |
| rev | line source |
|---|---|
| 974 | 1 /** |
| 2 * Orthanc - A Lightweight, RESTful DICOM Store | |
| 1900 | 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics |
|
1288
6e7e5ed91c2d
upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
978
diff
changeset
|
4 * Department, University Hospital of Liege, Belgium |
|
3640
94f4a18a79cc
upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3401
diff
changeset
|
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium |
| 974 | 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 | |
|
1441
f3672356c121
refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1368
diff
changeset
|
36 #include "../HttpServer/IHttpHandler.h" |
|
f3672356c121
refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1368
diff
changeset
|
37 #include "../HttpServer/HttpToolbox.h" |
| 974 | 38 #include "RestApiPath.h" |
| 39 #include "RestApiOutput.h" | |
| 40 | |
| 978 | 41 #include <boost/noncopyable.hpp> |
| 42 | |
| 974 | 43 namespace Orthanc |
| 44 { | |
| 45 class RestApi; | |
| 46 | |
| 978 | 47 class RestApiCall : public boost::noncopyable |
| 974 | 48 { |
| 49 private: | |
| 50 RestApiOutput& output_; | |
| 51 RestApi& context_; | |
|
1571
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
52 RequestOrigin origin_; |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
53 const char* remoteIp_; |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
54 const char* username_; |
|
1441
f3672356c121
refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1368
diff
changeset
|
55 const IHttpHandler::Arguments& httpHeaders_; |
|
f3672356c121
refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1368
diff
changeset
|
56 const IHttpHandler::Arguments& uriComponents_; |
| 974 | 57 const UriComponents& trailing_; |
| 58 const UriComponents& fullUri_; | |
| 59 | |
| 60 protected: | |
| 61 static bool ParseJsonRequestInternal(Json::Value& result, | |
| 3401 | 62 const void* body, |
| 63 size_t size); | |
| 974 | 64 |
| 65 public: | |
| 66 RestApiCall(RestApiOutput& output, | |
| 67 RestApi& context, | |
|
1571
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
68 RequestOrigin origin, |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
69 const char* remoteIp, |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
70 const char* username, |
|
1441
f3672356c121
refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1368
diff
changeset
|
71 const IHttpHandler::Arguments& httpHeaders, |
|
f3672356c121
refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1368
diff
changeset
|
72 const IHttpHandler::Arguments& uriComponents, |
| 974 | 73 const UriComponents& trailing, |
| 74 const UriComponents& fullUri) : | |
| 75 output_(output), | |
| 76 context_(context), | |
|
1571
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
77 origin_(origin), |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
78 remoteIp_(remoteIp), |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
79 username_(username), |
| 974 | 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 { | |
|
1441
f3672356c121
refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1368
diff
changeset
|
110 return HttpToolbox::GetArgument(uriComponents_, name, defaultValue); |
| 974 | 111 } |
| 112 | |
| 113 std::string GetHttpHeader(const std::string& name, | |
| 114 const std::string& defaultValue) const | |
| 115 { | |
|
1441
f3672356c121
refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1368
diff
changeset
|
116 return HttpToolbox::GetArgument(httpHeaders_, name, defaultValue); |
| 974 | 117 } |
| 118 | |
|
1441
f3672356c121
refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1368
diff
changeset
|
119 const IHttpHandler::Arguments& GetHttpHeaders() const |
| 974 | 120 { |
| 121 return httpHeaders_; | |
| 122 } | |
| 123 | |
|
1441
f3672356c121
refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1368
diff
changeset
|
124 void ParseCookies(IHttpHandler::Arguments& result) const |
| 974 | 125 { |
|
1441
f3672356c121
refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1368
diff
changeset
|
126 HttpToolbox::ParseCookies(result, httpHeaders_); |
| 974 | 127 } |
| 128 | |
| 1368 | 129 std::string FlattenUri() const; |
| 130 | |
|
1571
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
131 RequestOrigin GetRequestOrigin() const |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
132 { |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
133 return origin_; |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
134 } |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
135 |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
136 const char* GetRemoteIp() const |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
137 { |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
138 return remoteIp_; |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
139 } |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
140 |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
141 const char* GetUsername() const |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
142 { |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
143 return username_; |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
144 } |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
145 |
| 974 | 146 virtual bool ParseJsonRequest(Json::Value& result) const = 0; |
| 147 }; | |
| 148 } |