Mercurial > hg > orthanc
annotate Core/RestApi/RestApiOutput.cpp @ 1443:895ab369d63c
refactoring: OrthancHttpHandler
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Wed, 01 Jul 2015 11:30:19 +0200 |
| parents | b22ba8c5edbe |
| children | f967bdf8534e |
| rev | line source |
|---|---|
| 209 | 1 /** |
| 2 * Orthanc - A Lightweight, RESTful DICOM Store | |
|
1288
6e7e5ed91c2d
upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1194
diff
changeset
|
3 * Copyright (C) 2012-2015 Sebastien Jodogne, Medical Physics |
|
6e7e5ed91c2d
upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1194
diff
changeset
|
4 * Department, University Hospital of Liege, Belgium |
| 209 | 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 | |
|
824
a811bdf8b8eb
precompiled headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
33 #include "../PrecompiledHeaders.h" |
| 209 | 34 #include "RestApiOutput.h" |
| 35 | |
| 330 | 36 #include <boost/lexical_cast.hpp> |
| 1048 | 37 #include <glog/logging.h> |
| 330 | 38 |
| 211 | 39 #include "../OrthancException.h" |
| 40 | |
| 209 | 41 namespace Orthanc |
| 42 { | |
| 1368 | 43 RestApiOutput::RestApiOutput(HttpOutput& output, |
| 44 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
|
45 output_(output), |
| 1368 | 46 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
|
47 convertJsonToXml_(false) |
|
210
96b7918a6a18
start of the refactoring of the Orthanc REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
48 { |
|
216
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
49 alreadySent_ = false; |
|
210
96b7918a6a18
start of the refactoring of the Orthanc REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
50 } |
|
96b7918a6a18
start of the refactoring of the Orthanc REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
51 |
|
96b7918a6a18
start of the refactoring of the Orthanc REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
52 RestApiOutput::~RestApiOutput() |
|
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 } |
|
1113
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1100
diff
changeset
|
55 |
|
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1100
diff
changeset
|
56 void RestApiOutput::Finalize() |
|
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1100
diff
changeset
|
57 { |
|
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1100
diff
changeset
|
58 if (!alreadySent_) |
|
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1100
diff
changeset
|
59 { |
| 1368 | 60 if (method_ == HttpMethod_Post) |
| 61 { | |
| 62 output_.SendStatus(HttpStatus_400_BadRequest); | |
| 63 } | |
| 64 else | |
| 65 { | |
| 66 output_.SendStatus(HttpStatus_404_NotFound); | |
| 67 } | |
|
1113
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1100
diff
changeset
|
68 } |
|
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1100
diff
changeset
|
69 } |
| 211 | 70 |
| 71 void RestApiOutput::CheckStatus() | |
| 72 { | |
|
216
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
73 if (alreadySent_) |
| 211 | 74 { |
| 75 throw OrthancException(ErrorCode_BadSequenceOfCalls); | |
| 76 } | |
| 77 } | |
|
210
96b7918a6a18
start of the refactoring of the Orthanc REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
78 |
| 209 | 79 void RestApiOutput::AnswerFile(HttpFileSender& sender) |
| 80 { | |
| 211 | 81 CheckStatus(); |
| 209 | 82 sender.Send(output_); |
|
216
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
83 alreadySent_ = true; |
| 209 | 84 } |
| 85 | |
| 86 void RestApiOutput::AnswerJson(const Json::Value& value) | |
| 87 { | |
| 211 | 88 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
|
89 |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
90 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
|
91 { |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
92 #if ORTHANC_PUGIXML_ENABLED == 1 |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
93 std::string s; |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
94 Toolbox::JsonToXml(s, value); |
|
1113
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1100
diff
changeset
|
95 output_.SetContentType("application/xml"); |
|
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1100
diff
changeset
|
96 output_.SendBody(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
|
97 #else |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
98 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
|
99 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
|
100 #endif |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
101 } |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
102 else |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
103 { |
|
00f9f36bcd94
on-the-fly conversion of JSON to XML according to HTTP Accept
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
104 Json::StyledWriter writer; |
|
1113
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1100
diff
changeset
|
105 output_.SetContentType("application/json"); |
|
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1100
diff
changeset
|
106 output_.SendBody(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
|
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 |
|
216
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
109 alreadySent_ = true; |
| 209 | 110 } |
| 111 | |
| 112 void RestApiOutput::AnswerBuffer(const std::string& buffer, | |
| 113 const std::string& contentType) | |
| 114 { | |
| 211 | 115 CheckStatus(); |
|
1113
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1100
diff
changeset
|
116 output_.SetContentType(contentType.c_str()); |
|
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1100
diff
changeset
|
117 output_.SendBody(buffer); |
|
216
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
118 alreadySent_ = true; |
| 209 | 119 } |
| 120 | |
| 339 | 121 void RestApiOutput::AnswerBuffer(const void* buffer, |
| 122 size_t length, | |
| 123 const std::string& contentType) | |
| 124 { | |
| 125 CheckStatus(); | |
|
1113
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1100
diff
changeset
|
126 output_.SetContentType(contentType.c_str()); |
|
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1100
diff
changeset
|
127 output_.SendBody(buffer, length); |
| 339 | 128 alreadySent_ = true; |
| 129 } | |
| 130 | |
|
215
c07170f3f4f7
refactoring of access to images in REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
211
diff
changeset
|
131 void RestApiOutput::Redirect(const std::string& path) |
| 209 | 132 { |
| 211 | 133 CheckStatus(); |
| 209 | 134 output_.Redirect(path); |
|
216
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
135 alreadySent_ = true; |
|
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
136 } |
|
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
137 |
|
473
c9a5d72f8481
changing the namespace of HTTP enumerations
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
138 void RestApiOutput::SignalError(HttpStatus status) |
|
216
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
139 { |
| 1194 | 140 if (status != HttpStatus_400_BadRequest && |
| 141 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
|
142 status != HttpStatus_500_InternalServerError && |
|
473
c9a5d72f8481
changing the namespace of HTTP enumerations
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
143 status != HttpStatus_415_UnsupportedMediaType) |
|
216
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
144 { |
|
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
145 throw OrthancException("This HTTP status is not allowed in a REST API"); |
|
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
146 } |
|
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
147 |
|
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
148 CheckStatus(); |
|
1113
ba5c0908600c
Refactoring of HttpOutput ("Content-Length" header is now always sent)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1100
diff
changeset
|
149 output_.SendStatus(status); |
|
216
e5d5d4a9a326
refactored upload of dicom through http
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
215
diff
changeset
|
150 alreadySent_ = true; |
| 209 | 151 } |
| 330 | 152 |
| 153 void RestApiOutput::SetCookie(const std::string& name, | |
| 154 const std::string& value, | |
| 155 unsigned int maxAge) | |
| 156 { | |
| 157 if (name.find(";") != std::string::npos || | |
| 158 name.find(" ") != std::string::npos || | |
| 159 value.find(";") != std::string::npos || | |
| 160 value.find(" ") != std::string::npos) | |
| 161 { | |
| 162 throw OrthancException(ErrorCode_NotImplemented); | |
| 163 } | |
| 164 | |
| 165 CheckStatus(); | |
| 166 | |
| 167 std::string v = value + ";path=/"; | |
| 168 | |
| 169 if (maxAge != 0) | |
| 170 { | |
| 171 v += ";max-age=" + boost::lexical_cast<std::string>(maxAge); | |
| 172 } | |
| 173 | |
|
1042
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
174 output_.SetCookie(name, v); |
| 330 | 175 } |
| 176 | |
| 177 void RestApiOutput::ResetCookie(const std::string& name) | |
| 178 { | |
| 179 // This marks the cookie to be deleted by the browser in 1 second, | |
| 180 // and before it actually gets deleted, its value is set to the | |
| 181 // empty string | |
| 182 SetCookie(name, "", 1); | |
| 183 } | |
| 209 | 184 } |