Mercurial > hg > orthanc
annotate Core/RestApi/RestApiCall.h @ 2221:e7beca979562
fix Windows build due to overwriting a macro
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Tue, 13 Dec 2016 12:13:12 +0100 |
| parents | b1291df2f780 |
| children | a3a65de1840f |
| 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 |
| 974 | 5 * |
| 6 * This program is free software: you can redistribute it and/or | |
| 7 * modify it under the terms of the GNU General Public License as | |
| 8 * published by the Free Software Foundation, either version 3 of the | |
| 9 * License, or (at your option) any later version. | |
| 10 * | |
| 11 * In addition, as a special exception, the copyright holders of this | |
| 12 * program give permission to link the code of its release with the | |
| 13 * OpenSSL project's "OpenSSL" library (or with modified versions of it | |
| 14 * that use the same license as the "OpenSSL" library), and distribute | |
| 15 * the linked executables. You must obey the GNU General Public License | |
| 16 * in all respects for all of the code used other than "OpenSSL". If you | |
| 17 * modify file(s) with this exception, you may extend this exception to | |
| 18 * your version of the file(s), but you are not obligated to do so. If | |
| 19 * you do not wish to do so, delete this exception statement from your | |
| 20 * version. If you delete this exception statement from all source files | |
| 21 * in the program, then also delete it here. | |
| 22 * | |
| 23 * This program is distributed in the hope that it will be useful, but | |
| 24 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 26 * General Public License for more details. | |
| 27 * | |
| 28 * You should have received a copy of the GNU General Public License | |
| 29 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 30 **/ | |
| 31 | |
| 32 | |
| 33 #pragma once | |
| 34 | |
|
1441
f3672356c121
refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1368
diff
changeset
|
35 #include "../HttpServer/IHttpHandler.h" |
|
f3672356c121
refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1368
diff
changeset
|
36 #include "../HttpServer/HttpToolbox.h" |
| 974 | 37 #include "RestApiPath.h" |
| 38 #include "RestApiOutput.h" | |
| 39 | |
| 978 | 40 #include <boost/noncopyable.hpp> |
| 41 | |
| 974 | 42 namespace Orthanc |
| 43 { | |
| 44 class RestApi; | |
| 45 | |
| 978 | 46 class RestApiCall : public boost::noncopyable |
| 974 | 47 { |
| 48 private: | |
| 49 RestApiOutput& output_; | |
| 50 RestApi& context_; | |
|
1571
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
51 RequestOrigin origin_; |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
52 const char* remoteIp_; |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
53 const char* username_; |
|
1441
f3672356c121
refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1368
diff
changeset
|
54 const IHttpHandler::Arguments& httpHeaders_; |
|
f3672356c121
refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1368
diff
changeset
|
55 const IHttpHandler::Arguments& uriComponents_; |
| 974 | 56 const UriComponents& trailing_; |
| 57 const UriComponents& fullUri_; | |
| 58 | |
| 59 protected: | |
| 60 static bool ParseJsonRequestInternal(Json::Value& result, | |
| 61 const char* request); | |
| 62 | |
| 63 public: | |
| 64 RestApiCall(RestApiOutput& output, | |
| 65 RestApi& context, | |
|
1571
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
66 RequestOrigin origin, |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
67 const char* remoteIp, |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
68 const char* username, |
|
1441
f3672356c121
refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1368
diff
changeset
|
69 const IHttpHandler::Arguments& httpHeaders, |
|
f3672356c121
refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1368
diff
changeset
|
70 const IHttpHandler::Arguments& uriComponents, |
| 974 | 71 const UriComponents& trailing, |
| 72 const UriComponents& fullUri) : | |
| 73 output_(output), | |
| 74 context_(context), | |
|
1571
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
75 origin_(origin), |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
76 remoteIp_(remoteIp), |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
77 username_(username), |
| 974 | 78 httpHeaders_(httpHeaders), |
| 79 uriComponents_(uriComponents), | |
| 80 trailing_(trailing), | |
| 81 fullUri_(fullUri) | |
| 82 { | |
| 83 } | |
| 84 | |
| 85 RestApiOutput& GetOutput() | |
| 86 { | |
| 87 return output_; | |
| 88 } | |
| 89 | |
| 90 RestApi& GetContext() | |
| 91 { | |
| 92 return context_; | |
| 93 } | |
| 94 | |
| 95 const UriComponents& GetFullUri() const | |
| 96 { | |
| 97 return fullUri_; | |
| 98 } | |
| 99 | |
| 100 const UriComponents& GetTrailingUri() const | |
| 101 { | |
| 102 return trailing_; | |
| 103 } | |
| 104 | |
| 105 std::string GetUriComponent(const std::string& name, | |
| 106 const std::string& defaultValue) const | |
| 107 { | |
|
1441
f3672356c121
refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1368
diff
changeset
|
108 return HttpToolbox::GetArgument(uriComponents_, name, defaultValue); |
| 974 | 109 } |
| 110 | |
| 111 std::string GetHttpHeader(const std::string& name, | |
| 112 const std::string& defaultValue) const | |
| 113 { | |
|
1441
f3672356c121
refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1368
diff
changeset
|
114 return HttpToolbox::GetArgument(httpHeaders_, name, defaultValue); |
| 974 | 115 } |
| 116 | |
|
1441
f3672356c121
refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1368
diff
changeset
|
117 const IHttpHandler::Arguments& GetHttpHeaders() const |
| 974 | 118 { |
| 119 return httpHeaders_; | |
| 120 } | |
| 121 | |
|
1441
f3672356c121
refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1368
diff
changeset
|
122 void ParseCookies(IHttpHandler::Arguments& result) const |
| 974 | 123 { |
|
1441
f3672356c121
refactoring: IHttpHandler and HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1368
diff
changeset
|
124 HttpToolbox::ParseCookies(result, httpHeaders_); |
| 974 | 125 } |
| 126 | |
| 1368 | 127 std::string FlattenUri() const; |
| 128 | |
|
1571
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
129 RequestOrigin GetRequestOrigin() const |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
130 { |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
131 return origin_; |
|
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 |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
134 const char* GetRemoteIp() const |
|
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 return remoteIp_; |
|
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 |
|
3232f1c995a5
provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1441
diff
changeset
|
139 const char* GetUsername() const |
|
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 return username_; |
|
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 |
| 974 | 144 virtual bool ParseJsonRequest(Json::Value& result) const = 0; |
| 145 }; | |
| 146 } |