Mercurial > hg > orthanc
annotate Core/RestApi/RestApiOutput.cpp @ 2905:ae20fccdd867
refactoring mime types
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Tue, 30 Oct 2018 11:55:23 +0100 |
| parents | 878b59270859 |
| children | 9d277f8ad698 |
| 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 |
|
2447
878b59270859
upgrade to year 2018
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
5 * Copyright (C) 2017-2018 Osimis S.A., 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); |
|
2905
ae20fccdd867
refactoring mime types
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2447
diff
changeset
|
99 |
|
ae20fccdd867
refactoring mime types
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2447
diff
changeset
|
100 std::string mime = std::string(MIME_XML) + "; charset=utf-8"; |
|
ae20fccdd867
refactoring mime types
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2447
diff
changeset
|
101 output_.SetContentType(mime.c_str()); |
|
ae20fccdd867
refactoring mime types
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2447
diff
changeset
|
102 |
| 1521 | 103 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
|
104 #else |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
105 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
|
106 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
|
107 #endif |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
108 } |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
109 else |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
110 { |
|
2905
ae20fccdd867
refactoring mime types
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2447
diff
changeset
|
111 std::string mime = std::string(MIME_JSON) + "; charset=utf-8"; |
|
ae20fccdd867
refactoring mime types
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2447
diff
changeset
|
112 output_.SetContentType(mime.c_str()); |
|
ae20fccdd867
refactoring mime types
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2447
diff
changeset
|
113 |
|
1046
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
114 Json::StyledWriter writer; |
| 1521 | 115 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
|
116 } |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
117 |
|
216
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
118 alreadySent_ = true; |
| 209 | 119 } |
| 120 | |
| 121 void RestApiOutput::AnswerBuffer(const std::string& buffer, | |
| 122 const std::string& contentType) | |
| 123 { | |
|
1514
d73a2178b319
support of deflate and gzip content-types
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1511
diff
changeset
|
124 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
|
125 buffer.size(), contentType); |
| 209 | 126 } |
| 127 | |
| 339 | 128 void RestApiOutput::AnswerBuffer(const void* buffer, |
| 129 size_t length, | |
| 130 const std::string& contentType) | |
| 131 { | |
| 132 CheckStatus(); | |
|
1113
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1100
diff
changeset
|
133 output_.SetContentType(contentType.c_str()); |
| 1521 | 134 output_.Answer(buffer, length); |
| 339 | 135 alreadySent_ = true; |
| 136 } | |
| 137 | |
|
215
c07170f3f4f7
refactoring of access to images in REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
211
diff
changeset
|
138 void RestApiOutput::Redirect(const std::string& path) |
| 209 | 139 { |
| 211 | 140 CheckStatus(); |
| 209 | 141 output_.Redirect(path); |
|
216
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
142 alreadySent_ = true; |
|
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
143 } |
|
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
144 |
|
1567
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1521
diff
changeset
|
145 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
|
146 const char* message, |
|
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1521
diff
changeset
|
147 size_t messageSize) |
|
216
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
148 { |
| 1194 | 149 if (status != HttpStatus_400_BadRequest && |
| 150 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
|
151 status != HttpStatus_500_InternalServerError && |
|
473
c9a5d72f8481
changing the namespace of HTTP enumerations
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
152 status != HttpStatus_415_UnsupportedMediaType) |
|
216
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
153 { |
|
1582
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1567
diff
changeset
|
154 throw OrthancException(ErrorCode_BadHttpStatusInRest); |
|
216
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
155 } |
|
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
156 |
|
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
157 CheckStatus(); |
|
1567
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1521
diff
changeset
|
158 output_.SendStatus(status, message, messageSize); |
|
216
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
159 alreadySent_ = true; |
| 209 | 160 } |
| 330 | 161 |
|
1567
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 { |
|
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1521
diff
changeset
|
164 SignalErrorInternal(status, NULL, 0); |
|
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1521
diff
changeset
|
165 } |
|
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 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
|
168 const std::string& message) |
|
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1521
diff
changeset
|
169 { |
|
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1521
diff
changeset
|
170 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
|
171 } |
|
9c5d93510414
If error while calling the REST API, the answer body contains an error description
jodogne
parents:
1521
diff
changeset
|
172 |
| 330 | 173 void RestApiOutput::SetCookie(const std::string& name, |
| 174 const std::string& value, | |
| 175 unsigned int maxAge) | |
| 176 { | |
| 177 if (name.find(";") != std::string::npos || | |
| 178 name.find(" ") != std::string::npos || | |
| 179 value.find(";") != std::string::npos || | |
| 180 value.find(" ") != std::string::npos) | |
| 181 { | |
| 182 throw OrthancException(ErrorCode_NotImplemented); | |
| 183 } | |
| 184 | |
| 185 CheckStatus(); | |
| 186 | |
| 187 std::string v = value + ";path=/"; | |
| 188 | |
| 189 if (maxAge != 0) | |
| 190 { | |
| 191 v += ";max-age=" + boost::lexical_cast<std::string>(maxAge); | |
| 192 } | |
| 193 | |
|
1042
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
194 output_.SetCookie(name, v); |
| 330 | 195 } |
| 196 | |
| 197 void RestApiOutput::ResetCookie(const std::string& name) | |
| 198 { | |
| 199 // This marks the cookie to be deleted by the browser in 1 second, | |
| 200 // and before it actually gets deleted, its value is set to the | |
| 201 // empty string | |
| 202 SetCookie(name, "", 1); | |
| 203 } | |
| 209 | 204 } |