Mercurial > hg > orthanc
annotate Core/RestApi/RestApiOutput.cpp @ 2320:09cce85735b9
updated release notes
| author | amazy |
|---|---|
| date | Thu, 13 Jul 2017 12:45:37 +0200 |
| parents | a3a65de1840f |
| children | 878b59270859 |
| rev | line source |
|---|---|
| 209 | 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:
1194
diff
changeset
|
4 * Department, University Hospital of Liege, Belgium |
|
2244
a3a65de1840f
shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2142
diff
changeset
|
5 * Copyright (C) 2017 Osimis, Belgium |
| 209 | 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 | |
|
824
a811bdf8b8eb
precompiled headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
34 #include "../PrecompiledHeaders.h" |
| 209 | 35 #include "RestApiOutput.h" |
| 36 | |
|
1486
f967bdf8534e
refactoring to Logging.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1368
diff
changeset
|
37 #include "../Logging.h" |
|
f967bdf8534e
refactoring to Logging.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1368
diff
changeset
|
38 #include "../OrthancException.h" |
| 2142 | 39 #include "../Toolbox.h" |
|
1486
f967bdf8534e
refactoring to Logging.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1368
diff
changeset
|
40 |
| 330 | 41 #include <boost/lexical_cast.hpp> |
| 42 | |
| 211 | 43 |
| 209 | 44 namespace Orthanc |
| 45 { | |
| 1368 | 46 RestApiOutput::RestApiOutput(HttpOutput& output, |
| 47 HttpMethod method) : | |
|
1046
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
48 output_(output), |
| 1368 | 49 method_(method), |
|
1046
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
50 convertJsonToXml_(false) |
|
210
96b7918a6a18
start of the refactoring of the Orthanc REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
51 { |
|
216
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
52 alreadySent_ = false; |
|
210
96b7918a6a18
start of the refactoring of the Orthanc REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
53 } |
|
96b7918a6a18
start of the refactoring of the Orthanc REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
54 |
|
96b7918a6a18
start of the refactoring of the Orthanc REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
55 RestApiOutput::~RestApiOutput() |
|
96b7918a6a18
start of the refactoring of the Orthanc REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
56 { |
|
96b7918a6a18
start of the refactoring of the Orthanc REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
57 } |
|
1113
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1100
diff
changeset
|
58 |
|
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1100
diff
changeset
|
59 void RestApiOutput::Finalize() |
|
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1100
diff
changeset
|
60 { |
|
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1100
diff
changeset
|
61 if (!alreadySent_) |
|
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1100
diff
changeset
|
62 { |
| 1368 | 63 if (method_ == HttpMethod_Post) |
| 64 { | |
| 65 output_.SendStatus(HttpStatus_400_BadRequest); | |
| 66 } | |
| 67 else | |
| 68 { | |
| 69 output_.SendStatus(HttpStatus_404_NotFound); | |
| 70 } | |
|
1113
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1100
diff
changeset
|
71 } |
|
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1100
diff
changeset
|
72 } |
| 211 | 73 |
| 74 void RestApiOutput::CheckStatus() | |
| 75 { | |
|
216
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
76 if (alreadySent_) |
| 211 | 77 { |
| 78 throw OrthancException(ErrorCode_BadSequenceOfCalls); | |
| 79 } | |
| 80 } | |
|
210
96b7918a6a18
start of the refactoring of the Orthanc REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
81 |
|
1514
d73a2178b319
support of deflate and gzip content-types
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1511
diff
changeset
|
82 |
|
1519
8bd0d897763f
refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1518
diff
changeset
|
83 void RestApiOutput::AnswerStream(IHttpStreamAnswer& stream) |
| 209 | 84 { |
| 211 | 85 CheckStatus(); |
|
1519
8bd0d897763f
refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1518
diff
changeset
|
86 output_.Answer(stream); |
|
216
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
87 alreadySent_ = true; |
| 209 | 88 } |
| 89 | |
| 90 void RestApiOutput::AnswerJson(const Json::Value& value) | |
| 91 { | |
| 211 | 92 CheckStatus(); |
|
1046
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
93 |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
94 if (convertJsonToXml_) |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
95 { |
|
2136
dd609a99d39a
uniformization of the macro naming
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2118
diff
changeset
|
96 #if ORTHANC_ENABLE_PUGIXML == 1 |
| 1517 | 97 std::string s; |
|
1046
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
98 Toolbox::JsonToXml(s, value); |
|
2118
9cf176bc21ad
Content-Type for JSON documents is now "application/json; charset=utf-8"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1900
diff
changeset
|
99 output_.SetContentType("application/xml; charset=utf-8"); |
| 1521 | 100 output_.Answer(s); |
|
1046
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
101 #else |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
102 LOG(ERROR) << "Orthanc was compiled without XML support"; |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
103 throw OrthancException(ErrorCode_InternalError); |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
104 #endif |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
105 } |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
106 else |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
107 { |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
108 Json::StyledWriter writer; |
|
2118
9cf176bc21ad
Content-Type for JSON documents is now "application/json; charset=utf-8"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1900
diff
changeset
|
109 output_.SetContentType("application/json; charset=utf-8"); |
| 1521 | 110 output_.Answer(writer.write(value)); |
|
1046
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
111 } |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
112 |
|
216
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
113 alreadySent_ = true; |
| 209 | 114 } |
| 115 | |
| 116 void RestApiOutput::AnswerBuffer(const std::string& buffer, | |
| 117 const std::string& contentType) | |
| 118 { | |
|
1514
d73a2178b319
support of deflate and gzip content-types
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1511
diff
changeset
|
119 AnswerBuffer(buffer.size() == 0 ? NULL : buffer.c_str(), |
|
d73a2178b319
support of deflate and gzip content-types
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1511
diff
changeset
|
120 buffer.size(), contentType); |
| 209 | 121 } |
| 122 | |
| 339 | 123 void RestApiOutput::AnswerBuffer(const void* buffer, |
| 124 size_t length, | |
| 125 const std::string& contentType) | |
| 126 { | |
| 127 CheckStatus(); | |
|
1113
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1100
diff
changeset
|
128 output_.SetContentType(contentType.c_str()); |
| 1521 | 129 output_.Answer(buffer, length); |
| 339 | 130 alreadySent_ = true; |
| 131 } | |
| 132 | |
|
215
c07170f3f4f7
refactoring of access to images in REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
211
diff
changeset
|
133 void RestApiOutput::Redirect(const std::string& path) |
| 209 | 134 { |
| 211 | 135 CheckStatus(); |
| 209 | 136 output_.Redirect(path); |
|
216
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
137 alreadySent_ = true; |
|
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
138 } |
|
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
139 |
|
1567
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1521
diff
changeset
|
140 void RestApiOutput::SignalErrorInternal(HttpStatus status, |
|
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1521
diff
changeset
|
141 const char* message, |
|
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1521
diff
changeset
|
142 size_t messageSize) |
|
216
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
143 { |
| 1194 | 144 if (status != HttpStatus_400_BadRequest && |
| 145 status != HttpStatus_403_Forbidden && | |
|
1165
0561f2087cc9
Fix reporting of errors in Orthanc Explorer when sending images to peers/modalities
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1113
diff
changeset
|
146 status != HttpStatus_500_InternalServerError && |
|
473
c9a5d72f8481
changing the namespace of HTTP enumerations
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
147 status != HttpStatus_415_UnsupportedMediaType) |
|
216
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
148 { |
|
1582
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1567
diff
changeset
|
149 throw OrthancException(ErrorCode_BadHttpStatusInRest); |
|
216
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
150 } |
|
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
151 |
|
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
152 CheckStatus(); |
|
1567
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1521
diff
changeset
|
153 output_.SendStatus(status, message, messageSize); |
|
216
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
154 alreadySent_ = true; |
| 209 | 155 } |
| 330 | 156 |
|
1567
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1521
diff
changeset
|
157 void RestApiOutput::SignalError(HttpStatus status) |
|
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1521
diff
changeset
|
158 { |
|
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1521
diff
changeset
|
159 SignalErrorInternal(status, NULL, 0); |
|
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1521
diff
changeset
|
160 } |
|
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1521
diff
changeset
|
161 |
|
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1521
diff
changeset
|
162 void RestApiOutput::SignalError(HttpStatus status, |
|
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1521
diff
changeset
|
163 const std::string& message) |
|
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1521
diff
changeset
|
164 { |
|
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1521
diff
changeset
|
165 SignalErrorInternal(status, message.c_str(), message.size()); |
|
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1521
diff
changeset
|
166 } |
|
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1521
diff
changeset
|
167 |
| 330 | 168 void RestApiOutput::SetCookie(const std::string& name, |
| 169 const std::string& value, | |
| 170 unsigned int maxAge) | |
| 171 { | |
| 172 if (name.find(";") != std::string::npos || | |
| 173 name.find(" ") != std::string::npos || | |
| 174 value.find(";") != std::string::npos || | |
| 175 value.find(" ") != std::string::npos) | |
| 176 { | |
| 177 throw OrthancException(ErrorCode_NotImplemented); | |
| 178 } | |
| 179 | |
| 180 CheckStatus(); | |
| 181 | |
| 182 std::string v = value + ";path=/"; | |
| 183 | |
| 184 if (maxAge != 0) | |
| 185 { | |
| 186 v += ";max-age=" + boost::lexical_cast<std::string>(maxAge); | |
| 187 } | |
| 188 | |
|
1042
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
189 output_.SetCookie(name, v); |
| 330 | 190 } |
| 191 | |
| 192 void RestApiOutput::ResetCookie(const std::string& name) | |
| 193 { | |
| 194 // This marks the cookie to be deleted by the browser in 1 second, | |
| 195 // and before it actually gets deleted, its value is set to the | |
| 196 // empty string | |
| 197 SetCookie(name, "", 1); | |
| 198 } | |
| 209 | 199 } |