Mercurial > hg > orthanc-wsi
annotate Resources/Orthanc/Plugins/OrthancPluginCppWrapper.cpp @ 214:1e864138f0da
upgrade to year 2021
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Wed, 06 Jan 2021 18:10:07 +0100 |
parents | f1ea48f92d66 |
children | 443f219a68fd |
rev | line source |
---|---|
194 | 1 /** |
2 * Orthanc - A Lightweight, RESTful DICOM Store | |
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
4 * Department, University Hospital of Liege, Belgium | |
214
1e864138f0da
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
212
diff
changeset
|
5 * Copyright (C) 2017-2021 Osimis S.A., Belgium |
194 | 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. | |
203 | 11 * |
194 | 12 * This program is distributed in the hope that it will be useful, but |
13 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
15 * General Public License for more details. | |
16 * | |
17 * You should have received a copy of the GNU General Public License | |
18 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
19 **/ | |
20 | |
21 | |
22 #include "OrthancPluginCppWrapper.h" | |
23 | |
24 #include <boost/algorithm/string/predicate.hpp> | |
25 #include <boost/move/unique_ptr.hpp> | |
26 #include <boost/thread.hpp> | |
212 | 27 |
28 | |
194 | 29 #include <json/reader.h> |
212 | 30 #include <json/version.h> |
194 | 31 #include <json/writer.h> |
32 | |
212 | 33 #if !defined(JSONCPP_VERSION_MAJOR) || !defined(JSONCPP_VERSION_MINOR) |
34 # error Cannot access the version of JsonCpp | |
35 #endif | |
36 | |
37 | |
38 /** | |
39 * We use deprecated "Json::Reader", "Json::StyledWriter" and | |
40 * "Json::FastWriter" if JsonCpp < 1.7.0. This choice is rather | |
41 * arbitrary, but if Json >= 1.9.0, gcc generates explicit deprecation | |
42 * warnings (clang was warning in earlier versions). For reference, | |
43 * these classes seem to have been deprecated since JsonCpp 1.4.0 (on | |
44 * February 2015) by the following changeset: | |
45 * https://github.com/open-source-parsers/jsoncpp/commit/8df98f6112890d6272734975dd6d70cf8999bb22 | |
46 **/ | |
47 #if (JSONCPP_VERSION_MAJOR >= 2 || \ | |
48 (JSONCPP_VERSION_MAJOR == 1 && JSONCPP_VERSION_MINOR >= 8)) | |
49 # define JSONCPP_USE_DEPRECATED 0 | |
50 #else | |
51 # define JSONCPP_USE_DEPRECATED 1 | |
52 #endif | |
53 | |
194 | 54 |
55 #if !ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 2, 0) | |
56 static const OrthancPluginErrorCode OrthancPluginErrorCode_NullPointer = OrthancPluginErrorCode_Plugin; | |
57 #endif | |
58 | |
59 | |
60 namespace OrthancPlugins | |
61 { | |
62 static OrthancPluginContext* globalContext_ = NULL; | |
63 | |
64 | |
65 void SetGlobalContext(OrthancPluginContext* context) | |
66 { | |
67 if (context == NULL) | |
68 { | |
69 ORTHANC_PLUGINS_THROW_EXCEPTION(NullPointer); | |
70 } | |
71 else if (globalContext_ == NULL) | |
72 { | |
73 globalContext_ = context; | |
74 } | |
75 else | |
76 { | |
77 ORTHANC_PLUGINS_THROW_EXCEPTION(BadSequenceOfCalls); | |
78 } | |
79 } | |
80 | |
81 | |
82 bool HasGlobalContext() | |
83 { | |
84 return globalContext_ != NULL; | |
85 } | |
86 | |
87 | |
88 OrthancPluginContext* GetGlobalContext() | |
89 { | |
90 if (globalContext_ == NULL) | |
91 { | |
92 ORTHANC_PLUGINS_THROW_EXCEPTION(BadSequenceOfCalls); | |
93 } | |
94 else | |
95 { | |
96 return globalContext_; | |
97 } | |
98 } | |
99 | |
100 | |
101 void MemoryBuffer::Check(OrthancPluginErrorCode code) | |
102 { | |
103 if (code != OrthancPluginErrorCode_Success) | |
104 { | |
105 // Prevent using garbage information | |
106 buffer_.data = NULL; | |
107 buffer_.size = 0; | |
108 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(code); | |
109 } | |
110 } | |
111 | |
112 | |
113 bool MemoryBuffer::CheckHttp(OrthancPluginErrorCode code) | |
114 { | |
115 if (code != OrthancPluginErrorCode_Success) | |
116 { | |
117 // Prevent using garbage information | |
118 buffer_.data = NULL; | |
119 buffer_.size = 0; | |
120 } | |
121 | |
122 if (code == OrthancPluginErrorCode_Success) | |
123 { | |
124 return true; | |
125 } | |
126 else if (code == OrthancPluginErrorCode_UnknownResource || | |
127 code == OrthancPluginErrorCode_InexistentItem) | |
128 { | |
129 return false; | |
130 } | |
131 else | |
132 { | |
133 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(code); | |
134 } | |
135 } | |
136 | |
137 | |
138 MemoryBuffer::MemoryBuffer() | |
139 { | |
140 buffer_.data = NULL; | |
141 buffer_.size = 0; | |
142 } | |
143 | |
144 | |
145 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
146 MemoryBuffer::MemoryBuffer(const void* buffer, | |
147 size_t size) | |
148 { | |
149 uint32_t s = static_cast<uint32_t>(size); | |
150 if (static_cast<size_t>(s) != size) | |
151 { | |
152 ORTHANC_PLUGINS_THROW_EXCEPTION(NotEnoughMemory); | |
153 } | |
154 else if (OrthancPluginCreateMemoryBuffer(GetGlobalContext(), &buffer_, s) != | |
155 OrthancPluginErrorCode_Success) | |
156 { | |
157 ORTHANC_PLUGINS_THROW_EXCEPTION(NotEnoughMemory); | |
158 } | |
159 else | |
160 { | |
161 memcpy(buffer_.data, buffer, size); | |
162 } | |
163 } | |
164 #endif | |
165 | |
166 | |
167 void MemoryBuffer::Clear() | |
168 { | |
169 if (buffer_.data != NULL) | |
170 { | |
171 OrthancPluginFreeMemoryBuffer(GetGlobalContext(), &buffer_); | |
172 buffer_.data = NULL; | |
173 buffer_.size = 0; | |
174 } | |
175 } | |
176 | |
177 | |
178 void MemoryBuffer::Assign(OrthancPluginMemoryBuffer& other) | |
179 { | |
180 Clear(); | |
181 | |
182 buffer_.data = other.data; | |
183 buffer_.size = other.size; | |
184 | |
185 other.data = NULL; | |
186 other.size = 0; | |
187 } | |
188 | |
189 | |
190 void MemoryBuffer::Swap(MemoryBuffer& other) | |
191 { | |
192 std::swap(buffer_.data, other.buffer_.data); | |
193 std::swap(buffer_.size, other.buffer_.size); | |
194 } | |
195 | |
196 | |
197 OrthancPluginMemoryBuffer MemoryBuffer::Release() | |
198 { | |
199 OrthancPluginMemoryBuffer result = buffer_; | |
200 | |
201 buffer_.data = NULL; | |
202 buffer_.size = 0; | |
203 | |
204 return result; | |
205 } | |
206 | |
207 | |
208 void MemoryBuffer::ToString(std::string& target) const | |
209 { | |
210 if (buffer_.size == 0) | |
211 { | |
212 target.clear(); | |
213 } | |
214 else | |
215 { | |
216 target.assign(reinterpret_cast<const char*>(buffer_.data), buffer_.size); | |
217 } | |
218 } | |
219 | |
220 | |
221 void MemoryBuffer::ToJson(Json::Value& target) const | |
222 { | |
223 if (buffer_.data == NULL || | |
224 buffer_.size == 0) | |
225 { | |
226 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError); | |
227 } | |
228 | |
212 | 229 if (!ReadJson(target, buffer_.data, buffer_.size)) |
194 | 230 { |
231 LogError("Cannot convert some memory buffer to JSON"); | |
232 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
233 } | |
234 } | |
235 | |
236 | |
237 bool MemoryBuffer::RestApiGet(const std::string& uri, | |
238 bool applyPlugins) | |
239 { | |
240 Clear(); | |
241 | |
242 if (applyPlugins) | |
243 { | |
244 return CheckHttp(OrthancPluginRestApiGetAfterPlugins(GetGlobalContext(), &buffer_, uri.c_str())); | |
245 } | |
246 else | |
247 { | |
248 return CheckHttp(OrthancPluginRestApiGet(GetGlobalContext(), &buffer_, uri.c_str())); | |
249 } | |
250 } | |
251 | |
252 bool MemoryBuffer::RestApiGet(const std::string& uri, | |
253 const std::map<std::string, std::string>& httpHeaders, | |
254 bool applyPlugins) | |
255 { | |
256 Clear(); | |
257 | |
258 std::vector<const char*> headersKeys; | |
259 std::vector<const char*> headersValues; | |
260 | |
261 for (std::map<std::string, std::string>::const_iterator | |
262 it = httpHeaders.begin(); it != httpHeaders.end(); it++) | |
263 { | |
264 headersKeys.push_back(it->first.c_str()); | |
265 headersValues.push_back(it->second.c_str()); | |
266 } | |
267 | |
268 return CheckHttp(OrthancPluginRestApiGet2( | |
269 GetGlobalContext(), &buffer_, uri.c_str(), httpHeaders.size(), | |
270 (headersKeys.empty() ? NULL : &headersKeys[0]), | |
271 (headersValues.empty() ? NULL : &headersValues[0]), applyPlugins)); | |
272 } | |
273 | |
274 bool MemoryBuffer::RestApiPost(const std::string& uri, | |
275 const void* body, | |
276 size_t bodySize, | |
277 bool applyPlugins) | |
278 { | |
279 Clear(); | |
280 | |
281 // Cast for compatibility with Orthanc SDK <= 1.5.6 | |
282 const char* b = reinterpret_cast<const char*>(body); | |
283 | |
284 if (applyPlugins) | |
285 { | |
286 return CheckHttp(OrthancPluginRestApiPostAfterPlugins(GetGlobalContext(), &buffer_, uri.c_str(), b, bodySize)); | |
287 } | |
288 else | |
289 { | |
290 return CheckHttp(OrthancPluginRestApiPost(GetGlobalContext(), &buffer_, uri.c_str(), b, bodySize)); | |
291 } | |
292 } | |
293 | |
294 | |
295 bool MemoryBuffer::RestApiPut(const std::string& uri, | |
296 const void* body, | |
297 size_t bodySize, | |
298 bool applyPlugins) | |
299 { | |
300 Clear(); | |
301 | |
302 // Cast for compatibility with Orthanc SDK <= 1.5.6 | |
303 const char* b = reinterpret_cast<const char*>(body); | |
304 | |
305 if (applyPlugins) | |
306 { | |
307 return CheckHttp(OrthancPluginRestApiPutAfterPlugins(GetGlobalContext(), &buffer_, uri.c_str(), b, bodySize)); | |
308 } | |
309 else | |
310 { | |
311 return CheckHttp(OrthancPluginRestApiPut(GetGlobalContext(), &buffer_, uri.c_str(), b, bodySize)); | |
312 } | |
313 } | |
314 | |
315 | |
212 | 316 bool ReadJson(Json::Value& target, |
317 const std::string& source) | |
318 { | |
319 return ReadJson(target, source.empty() ? NULL : source.c_str(), source.size()); | |
320 } | |
321 | |
322 | |
323 bool ReadJson(Json::Value& target, | |
324 const void* buffer, | |
325 size_t size) | |
326 { | |
327 #if JSONCPP_USE_DEPRECATED == 1 | |
328 Json::Reader reader; | |
329 return reader.parse(reinterpret_cast<const char*>(buffer), | |
330 reinterpret_cast<const char*>(buffer) + size, target); | |
331 #else | |
332 Json::CharReaderBuilder builder; | |
333 const std::unique_ptr<Json::CharReader> reader(builder.newCharReader()); | |
334 assert(reader.get() != NULL); | |
335 JSONCPP_STRING err; | |
336 if (reader->parse(reinterpret_cast<const char*>(buffer), | |
337 reinterpret_cast<const char*>(buffer) + size, &target, &err)) | |
338 { | |
339 return true; | |
340 } | |
341 else | |
342 { | |
343 LogError("Cannot parse JSON: " + err); | |
344 return false; | |
345 } | |
346 #endif | |
347 } | |
348 | |
349 | |
350 void WriteFastJson(std::string& target, | |
351 const Json::Value& source) | |
352 { | |
353 #if JSONCPP_USE_DEPRECATED == 1 | |
354 Json::FastWriter writer; | |
355 target = writer.write(source); | |
356 #else | |
357 Json::StreamWriterBuilder builder; | |
358 builder.settings_["indentation"] = ""; | |
359 target = Json::writeString(builder, source); | |
360 #endif | |
361 } | |
362 | |
363 | |
364 void WriteStyledJson(std::string& target, | |
365 const Json::Value& source) | |
366 { | |
367 #if JSONCPP_USE_DEPRECATED == 1 | |
368 Json::StyledWriter writer; | |
369 target = writer.write(source); | |
370 #else | |
371 Json::StreamWriterBuilder builder; | |
372 builder.settings_["indentation"] = " "; | |
373 target = Json::writeString(builder, source); | |
374 #endif | |
375 } | |
376 | |
377 | |
194 | 378 bool MemoryBuffer::RestApiPost(const std::string& uri, |
379 const Json::Value& body, | |
380 bool applyPlugins) | |
381 { | |
212 | 382 std::string s; |
383 WriteFastJson(s, body); | |
384 return RestApiPost(uri, s, applyPlugins); | |
194 | 385 } |
386 | |
387 | |
388 bool MemoryBuffer::RestApiPut(const std::string& uri, | |
389 const Json::Value& body, | |
390 bool applyPlugins) | |
391 { | |
212 | 392 std::string s; |
393 WriteFastJson(s, body); | |
394 return RestApiPut(uri, s, applyPlugins); | |
194 | 395 } |
396 | |
397 | |
398 void MemoryBuffer::CreateDicom(const Json::Value& tags, | |
399 OrthancPluginCreateDicomFlags flags) | |
400 { | |
401 Clear(); | |
402 | |
212 | 403 std::string s; |
404 WriteFastJson(s, tags); | |
194 | 405 |
406 Check(OrthancPluginCreateDicom(GetGlobalContext(), &buffer_, s.c_str(), NULL, flags)); | |
407 } | |
408 | |
409 void MemoryBuffer::CreateDicom(const Json::Value& tags, | |
410 const OrthancImage& pixelData, | |
411 OrthancPluginCreateDicomFlags flags) | |
412 { | |
413 Clear(); | |
414 | |
212 | 415 std::string s; |
416 WriteFastJson(s, tags); | |
194 | 417 |
418 Check(OrthancPluginCreateDicom(GetGlobalContext(), &buffer_, s.c_str(), pixelData.GetObject(), flags)); | |
419 } | |
420 | |
421 | |
422 void MemoryBuffer::ReadFile(const std::string& path) | |
423 { | |
424 Clear(); | |
425 Check(OrthancPluginReadFile(GetGlobalContext(), &buffer_, path.c_str())); | |
426 } | |
427 | |
428 | |
429 void MemoryBuffer::GetDicomQuery(const OrthancPluginWorklistQuery* query) | |
430 { | |
431 Clear(); | |
432 Check(OrthancPluginWorklistGetDicomQuery(GetGlobalContext(), &buffer_, query)); | |
433 } | |
434 | |
435 | |
436 void OrthancString::Assign(char* str) | |
437 { | |
438 Clear(); | |
439 | |
440 if (str != NULL) | |
441 { | |
442 str_ = str; | |
443 } | |
444 } | |
445 | |
446 | |
447 void OrthancString::Clear() | |
448 { | |
449 if (str_ != NULL) | |
450 { | |
451 OrthancPluginFreeString(GetGlobalContext(), str_); | |
452 str_ = NULL; | |
453 } | |
454 } | |
455 | |
456 | |
457 void OrthancString::ToString(std::string& target) const | |
458 { | |
459 if (str_ == NULL) | |
460 { | |
461 target.clear(); | |
462 } | |
463 else | |
464 { | |
465 target.assign(str_); | |
466 } | |
467 } | |
468 | |
469 | |
470 void OrthancString::ToJson(Json::Value& target) const | |
471 { | |
472 if (str_ == NULL) | |
473 { | |
474 LogError("Cannot convert an empty memory buffer to JSON"); | |
475 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError); | |
476 } | |
477 | |
212 | 478 if (!ReadJson(target, str_)) |
194 | 479 { |
480 LogError("Cannot convert some memory buffer to JSON"); | |
481 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
482 } | |
483 } | |
484 | |
485 | |
486 void MemoryBuffer::DicomToJson(Json::Value& target, | |
487 OrthancPluginDicomToJsonFormat format, | |
488 OrthancPluginDicomToJsonFlags flags, | |
489 uint32_t maxStringLength) | |
490 { | |
491 OrthancString str; | |
492 str.Assign(OrthancPluginDicomBufferToJson | |
493 (GetGlobalContext(), GetData(), GetSize(), format, flags, maxStringLength)); | |
494 str.ToJson(target); | |
495 } | |
496 | |
497 | |
498 bool MemoryBuffer::HttpGet(const std::string& url, | |
499 const std::string& username, | |
500 const std::string& password) | |
501 { | |
502 Clear(); | |
503 return CheckHttp(OrthancPluginHttpGet(GetGlobalContext(), &buffer_, url.c_str(), | |
504 username.empty() ? NULL : username.c_str(), | |
505 password.empty() ? NULL : password.c_str())); | |
506 } | |
507 | |
508 | |
509 bool MemoryBuffer::HttpPost(const std::string& url, | |
510 const std::string& body, | |
511 const std::string& username, | |
512 const std::string& password) | |
513 { | |
514 Clear(); | |
515 return CheckHttp(OrthancPluginHttpPost(GetGlobalContext(), &buffer_, url.c_str(), | |
516 body.c_str(), body.size(), | |
517 username.empty() ? NULL : username.c_str(), | |
518 password.empty() ? NULL : password.c_str())); | |
519 } | |
520 | |
521 | |
522 bool MemoryBuffer::HttpPut(const std::string& url, | |
523 const std::string& body, | |
524 const std::string& username, | |
525 const std::string& password) | |
526 { | |
527 Clear(); | |
528 return CheckHttp(OrthancPluginHttpPut(GetGlobalContext(), &buffer_, url.c_str(), | |
529 body.empty() ? NULL : body.c_str(), | |
530 body.size(), | |
531 username.empty() ? NULL : username.c_str(), | |
532 password.empty() ? NULL : password.c_str())); | |
533 } | |
534 | |
535 | |
536 void MemoryBuffer::GetDicomInstance(const std::string& instanceId) | |
537 { | |
538 Clear(); | |
539 Check(OrthancPluginGetDicomForInstance(GetGlobalContext(), &buffer_, instanceId.c_str())); | |
540 } | |
541 | |
542 | |
543 bool HttpDelete(const std::string& url, | |
544 const std::string& username, | |
545 const std::string& password) | |
546 { | |
547 OrthancPluginErrorCode error = OrthancPluginHttpDelete | |
548 (GetGlobalContext(), url.c_str(), | |
549 username.empty() ? NULL : username.c_str(), | |
550 password.empty() ? NULL : password.c_str()); | |
551 | |
552 if (error == OrthancPluginErrorCode_Success) | |
553 { | |
554 return true; | |
555 } | |
556 else if (error == OrthancPluginErrorCode_UnknownResource || | |
557 error == OrthancPluginErrorCode_InexistentItem) | |
558 { | |
559 return false; | |
560 } | |
561 else | |
562 { | |
563 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(error); | |
564 } | |
565 } | |
566 | |
567 | |
568 void LogError(const std::string& message) | |
569 { | |
570 if (HasGlobalContext()) | |
571 { | |
572 OrthancPluginLogError(GetGlobalContext(), message.c_str()); | |
573 } | |
574 } | |
575 | |
576 | |
577 void LogWarning(const std::string& message) | |
578 { | |
579 if (HasGlobalContext()) | |
580 { | |
581 OrthancPluginLogWarning(GetGlobalContext(), message.c_str()); | |
582 } | |
583 } | |
584 | |
585 | |
586 void LogInfo(const std::string& message) | |
587 { | |
588 if (HasGlobalContext()) | |
589 { | |
590 OrthancPluginLogInfo(GetGlobalContext(), message.c_str()); | |
591 } | |
592 } | |
593 | |
594 | |
595 void OrthancConfiguration::LoadConfiguration() | |
596 { | |
597 OrthancString str; | |
598 str.Assign(OrthancPluginGetConfiguration(GetGlobalContext())); | |
599 | |
600 if (str.GetContent() == NULL) | |
601 { | |
602 LogError("Cannot access the Orthanc configuration"); | |
603 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError); | |
604 } | |
605 | |
606 str.ToJson(configuration_); | |
607 | |
608 if (configuration_.type() != Json::objectValue) | |
609 { | |
610 LogError("Unable to read the Orthanc configuration"); | |
611 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError); | |
612 } | |
613 } | |
614 | |
615 | |
616 OrthancConfiguration::OrthancConfiguration() | |
617 { | |
618 LoadConfiguration(); | |
619 } | |
620 | |
621 | |
622 OrthancConfiguration::OrthancConfiguration(bool loadConfiguration) | |
623 { | |
624 if (loadConfiguration) | |
625 { | |
626 LoadConfiguration(); | |
627 } | |
628 else | |
629 { | |
630 configuration_ = Json::objectValue; | |
631 } | |
632 } | |
633 | |
634 | |
635 std::string OrthancConfiguration::GetPath(const std::string& key) const | |
636 { | |
637 if (path_.empty()) | |
638 { | |
639 return key; | |
640 } | |
641 else | |
642 { | |
643 return path_ + "." + key; | |
644 } | |
645 } | |
646 | |
647 | |
648 bool OrthancConfiguration::IsSection(const std::string& key) const | |
649 { | |
650 assert(configuration_.type() == Json::objectValue); | |
651 | |
652 return (configuration_.isMember(key) && | |
653 configuration_[key].type() == Json::objectValue); | |
654 } | |
655 | |
656 | |
657 void OrthancConfiguration::GetSection(OrthancConfiguration& target, | |
658 const std::string& key) const | |
659 { | |
660 assert(configuration_.type() == Json::objectValue); | |
661 | |
662 target.path_ = GetPath(key); | |
663 | |
664 if (!configuration_.isMember(key)) | |
665 { | |
666 target.configuration_ = Json::objectValue; | |
667 } | |
668 else | |
669 { | |
670 if (configuration_[key].type() != Json::objectValue) | |
671 { | |
672 LogError("The configuration section \"" + target.path_ + | |
673 "\" is not an associative array as expected"); | |
674 | |
675 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
676 } | |
677 | |
678 target.configuration_ = configuration_[key]; | |
679 } | |
680 } | |
681 | |
682 | |
683 bool OrthancConfiguration::LookupStringValue(std::string& target, | |
684 const std::string& key) const | |
685 { | |
686 assert(configuration_.type() == Json::objectValue); | |
687 | |
688 if (!configuration_.isMember(key)) | |
689 { | |
690 return false; | |
691 } | |
692 | |
693 if (configuration_[key].type() != Json::stringValue) | |
694 { | |
695 LogError("The configuration option \"" + GetPath(key) + | |
696 "\" is not a string as expected"); | |
697 | |
698 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
699 } | |
700 | |
701 target = configuration_[key].asString(); | |
702 return true; | |
703 } | |
704 | |
705 | |
706 bool OrthancConfiguration::LookupIntegerValue(int& target, | |
707 const std::string& key) const | |
708 { | |
709 assert(configuration_.type() == Json::objectValue); | |
710 | |
711 if (!configuration_.isMember(key)) | |
712 { | |
713 return false; | |
714 } | |
715 | |
716 switch (configuration_[key].type()) | |
717 { | |
718 case Json::intValue: | |
719 target = configuration_[key].asInt(); | |
720 return true; | |
721 | |
722 case Json::uintValue: | |
723 target = configuration_[key].asUInt(); | |
724 return true; | |
725 | |
726 default: | |
727 LogError("The configuration option \"" + GetPath(key) + | |
728 "\" is not an integer as expected"); | |
729 | |
730 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
731 } | |
732 } | |
733 | |
734 | |
735 bool OrthancConfiguration::LookupUnsignedIntegerValue(unsigned int& target, | |
736 const std::string& key) const | |
737 { | |
738 int tmp; | |
739 if (!LookupIntegerValue(tmp, key)) | |
740 { | |
741 return false; | |
742 } | |
743 | |
744 if (tmp < 0) | |
745 { | |
746 LogError("The configuration option \"" + GetPath(key) + | |
747 "\" is not a positive integer as expected"); | |
748 | |
749 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
750 } | |
751 else | |
752 { | |
753 target = static_cast<unsigned int>(tmp); | |
754 return true; | |
755 } | |
756 } | |
757 | |
758 | |
759 bool OrthancConfiguration::LookupBooleanValue(bool& target, | |
760 const std::string& key) const | |
761 { | |
762 assert(configuration_.type() == Json::objectValue); | |
763 | |
764 if (!configuration_.isMember(key)) | |
765 { | |
766 return false; | |
767 } | |
768 | |
769 if (configuration_[key].type() != Json::booleanValue) | |
770 { | |
771 LogError("The configuration option \"" + GetPath(key) + | |
772 "\" is not a Boolean as expected"); | |
773 | |
774 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
775 } | |
776 | |
777 target = configuration_[key].asBool(); | |
778 return true; | |
779 } | |
780 | |
781 | |
782 bool OrthancConfiguration::LookupFloatValue(float& target, | |
783 const std::string& key) const | |
784 { | |
785 assert(configuration_.type() == Json::objectValue); | |
786 | |
787 if (!configuration_.isMember(key)) | |
788 { | |
789 return false; | |
790 } | |
791 | |
792 switch (configuration_[key].type()) | |
793 { | |
794 case Json::realValue: | |
795 target = configuration_[key].asFloat(); | |
796 return true; | |
797 | |
798 case Json::intValue: | |
799 target = static_cast<float>(configuration_[key].asInt()); | |
800 return true; | |
801 | |
802 case Json::uintValue: | |
803 target = static_cast<float>(configuration_[key].asUInt()); | |
804 return true; | |
805 | |
806 default: | |
807 LogError("The configuration option \"" + GetPath(key) + | |
808 "\" is not an integer as expected"); | |
809 | |
810 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
811 } | |
812 } | |
813 | |
814 | |
815 bool OrthancConfiguration::LookupListOfStrings(std::list<std::string>& target, | |
816 const std::string& key, | |
817 bool allowSingleString) const | |
818 { | |
819 assert(configuration_.type() == Json::objectValue); | |
820 | |
821 target.clear(); | |
822 | |
823 if (!configuration_.isMember(key)) | |
824 { | |
825 return false; | |
826 } | |
827 | |
828 switch (configuration_[key].type()) | |
829 { | |
830 case Json::arrayValue: | |
831 { | |
832 bool ok = true; | |
833 | |
834 for (Json::Value::ArrayIndex i = 0; ok && i < configuration_[key].size(); i++) | |
835 { | |
836 if (configuration_[key][i].type() == Json::stringValue) | |
837 { | |
838 target.push_back(configuration_[key][i].asString()); | |
839 } | |
840 else | |
841 { | |
842 ok = false; | |
843 } | |
844 } | |
845 | |
846 if (ok) | |
847 { | |
848 return true; | |
849 } | |
850 | |
851 break; | |
852 } | |
853 | |
854 case Json::stringValue: | |
855 if (allowSingleString) | |
856 { | |
857 target.push_back(configuration_[key].asString()); | |
858 return true; | |
859 } | |
860 | |
861 break; | |
862 | |
863 default: | |
864 break; | |
865 } | |
866 | |
867 LogError("The configuration option \"" + GetPath(key) + | |
868 "\" is not a list of strings as expected"); | |
869 | |
870 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
871 } | |
872 | |
873 | |
874 bool OrthancConfiguration::LookupSetOfStrings(std::set<std::string>& target, | |
875 const std::string& key, | |
876 bool allowSingleString) const | |
877 { | |
878 std::list<std::string> lst; | |
879 | |
880 if (LookupListOfStrings(lst, key, allowSingleString)) | |
881 { | |
882 target.clear(); | |
883 | |
884 for (std::list<std::string>::const_iterator | |
885 it = lst.begin(); it != lst.end(); ++it) | |
886 { | |
887 target.insert(*it); | |
888 } | |
889 | |
890 return true; | |
891 } | |
892 else | |
893 { | |
894 return false; | |
895 } | |
896 } | |
897 | |
898 | |
899 std::string OrthancConfiguration::GetStringValue(const std::string& key, | |
900 const std::string& defaultValue) const | |
901 { | |
902 std::string tmp; | |
903 if (LookupStringValue(tmp, key)) | |
904 { | |
905 return tmp; | |
906 } | |
907 else | |
908 { | |
909 return defaultValue; | |
910 } | |
911 } | |
912 | |
913 | |
914 int OrthancConfiguration::GetIntegerValue(const std::string& key, | |
915 int defaultValue) const | |
916 { | |
917 int tmp; | |
918 if (LookupIntegerValue(tmp, key)) | |
919 { | |
920 return tmp; | |
921 } | |
922 else | |
923 { | |
924 return defaultValue; | |
925 } | |
926 } | |
927 | |
928 | |
929 unsigned int OrthancConfiguration::GetUnsignedIntegerValue(const std::string& key, | |
930 unsigned int defaultValue) const | |
931 { | |
932 unsigned int tmp; | |
933 if (LookupUnsignedIntegerValue(tmp, key)) | |
934 { | |
935 return tmp; | |
936 } | |
937 else | |
938 { | |
939 return defaultValue; | |
940 } | |
941 } | |
942 | |
943 | |
944 bool OrthancConfiguration::GetBooleanValue(const std::string& key, | |
945 bool defaultValue) const | |
946 { | |
947 bool tmp; | |
948 if (LookupBooleanValue(tmp, key)) | |
949 { | |
950 return tmp; | |
951 } | |
952 else | |
953 { | |
954 return defaultValue; | |
955 } | |
956 } | |
957 | |
958 | |
959 float OrthancConfiguration::GetFloatValue(const std::string& key, | |
960 float defaultValue) const | |
961 { | |
962 float tmp; | |
963 if (LookupFloatValue(tmp, key)) | |
964 { | |
965 return tmp; | |
966 } | |
967 else | |
968 { | |
969 return defaultValue; | |
970 } | |
971 } | |
972 | |
973 | |
974 void OrthancConfiguration::GetDictionary(std::map<std::string, std::string>& target, | |
975 const std::string& key) const | |
976 { | |
977 assert(configuration_.type() == Json::objectValue); | |
978 | |
979 target.clear(); | |
980 | |
981 if (!configuration_.isMember(key)) | |
982 { | |
983 return; | |
984 } | |
985 | |
986 if (configuration_[key].type() != Json::objectValue) | |
987 { | |
988 LogError("The configuration option \"" + GetPath(key) + | |
989 "\" is not a string as expected"); | |
990 | |
991 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
992 } | |
993 | |
994 Json::Value::Members members = configuration_[key].getMemberNames(); | |
995 | |
996 for (size_t i = 0; i < members.size(); i++) | |
997 { | |
998 const Json::Value& value = configuration_[key][members[i]]; | |
999 | |
1000 if (value.type() == Json::stringValue) | |
1001 { | |
1002 target[members[i]] = value.asString(); | |
1003 } | |
1004 else | |
1005 { | |
1006 LogError("The configuration option \"" + GetPath(key) + | |
1007 "\" is not a dictionary mapping strings to strings"); | |
1008 | |
1009 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
1010 } | |
1011 } | |
1012 } | |
1013 | |
1014 | |
1015 void OrthancImage::Clear() | |
1016 { | |
1017 if (image_ != NULL) | |
1018 { | |
1019 OrthancPluginFreeImage(GetGlobalContext(), image_); | |
1020 image_ = NULL; | |
1021 } | |
1022 } | |
1023 | |
1024 | |
1025 void OrthancImage::CheckImageAvailable() const | |
1026 { | |
1027 if (image_ == NULL) | |
1028 { | |
1029 LogError("Trying to access a NULL image"); | |
1030 ORTHANC_PLUGINS_THROW_EXCEPTION(ParameterOutOfRange); | |
1031 } | |
1032 } | |
1033 | |
1034 | |
1035 OrthancImage::OrthancImage() : | |
1036 image_(NULL) | |
1037 { | |
1038 } | |
1039 | |
1040 | |
1041 OrthancImage::OrthancImage(OrthancPluginImage* image) : | |
1042 image_(image) | |
1043 { | |
1044 } | |
1045 | |
1046 | |
1047 OrthancImage::OrthancImage(OrthancPluginPixelFormat format, | |
1048 uint32_t width, | |
1049 uint32_t height) | |
1050 { | |
1051 image_ = OrthancPluginCreateImage(GetGlobalContext(), format, width, height); | |
1052 | |
1053 if (image_ == NULL) | |
1054 { | |
1055 LogError("Cannot create an image"); | |
1056 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError); | |
1057 } | |
1058 } | |
1059 | |
1060 | |
1061 OrthancImage::OrthancImage(OrthancPluginPixelFormat format, | |
1062 uint32_t width, | |
1063 uint32_t height, | |
1064 uint32_t pitch, | |
1065 void* buffer) | |
1066 { | |
1067 image_ = OrthancPluginCreateImageAccessor | |
1068 (GetGlobalContext(), format, width, height, pitch, buffer); | |
1069 | |
1070 if (image_ == NULL) | |
1071 { | |
1072 LogError("Cannot create an image accessor"); | |
1073 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError); | |
1074 } | |
1075 } | |
1076 | |
1077 void OrthancImage::UncompressPngImage(const void* data, | |
1078 size_t size) | |
1079 { | |
1080 Clear(); | |
1081 | |
1082 image_ = OrthancPluginUncompressImage(GetGlobalContext(), data, size, OrthancPluginImageFormat_Png); | |
1083 | |
1084 if (image_ == NULL) | |
1085 { | |
1086 LogError("Cannot uncompress a PNG image"); | |
1087 ORTHANC_PLUGINS_THROW_EXCEPTION(ParameterOutOfRange); | |
1088 } | |
1089 } | |
1090 | |
1091 | |
1092 void OrthancImage::UncompressJpegImage(const void* data, | |
1093 size_t size) | |
1094 { | |
1095 Clear(); | |
1096 image_ = OrthancPluginUncompressImage(GetGlobalContext(), data, size, OrthancPluginImageFormat_Jpeg); | |
1097 if (image_ == NULL) | |
1098 { | |
1099 LogError("Cannot uncompress a JPEG image"); | |
1100 ORTHANC_PLUGINS_THROW_EXCEPTION(ParameterOutOfRange); | |
1101 } | |
1102 } | |
1103 | |
1104 | |
1105 void OrthancImage::DecodeDicomImage(const void* data, | |
1106 size_t size, | |
1107 unsigned int frame) | |
1108 { | |
1109 Clear(); | |
1110 image_ = OrthancPluginDecodeDicomImage(GetGlobalContext(), data, size, frame); | |
1111 if (image_ == NULL) | |
1112 { | |
1113 LogError("Cannot uncompress a DICOM image"); | |
1114 ORTHANC_PLUGINS_THROW_EXCEPTION(ParameterOutOfRange); | |
1115 } | |
1116 } | |
1117 | |
1118 | |
1119 OrthancPluginPixelFormat OrthancImage::GetPixelFormat() const | |
1120 { | |
1121 CheckImageAvailable(); | |
1122 return OrthancPluginGetImagePixelFormat(GetGlobalContext(), image_); | |
1123 } | |
1124 | |
1125 | |
1126 unsigned int OrthancImage::GetWidth() const | |
1127 { | |
1128 CheckImageAvailable(); | |
1129 return OrthancPluginGetImageWidth(GetGlobalContext(), image_); | |
1130 } | |
1131 | |
1132 | |
1133 unsigned int OrthancImage::GetHeight() const | |
1134 { | |
1135 CheckImageAvailable(); | |
1136 return OrthancPluginGetImageHeight(GetGlobalContext(), image_); | |
1137 } | |
1138 | |
1139 | |
1140 unsigned int OrthancImage::GetPitch() const | |
1141 { | |
1142 CheckImageAvailable(); | |
1143 return OrthancPluginGetImagePitch(GetGlobalContext(), image_); | |
1144 } | |
1145 | |
1146 | |
1147 void* OrthancImage::GetBuffer() const | |
1148 { | |
1149 CheckImageAvailable(); | |
1150 return OrthancPluginGetImageBuffer(GetGlobalContext(), image_); | |
1151 } | |
1152 | |
1153 | |
1154 void OrthancImage::CompressPngImage(MemoryBuffer& target) const | |
1155 { | |
1156 CheckImageAvailable(); | |
1157 | |
1158 OrthancPlugins::MemoryBuffer answer; | |
1159 OrthancPluginCompressPngImage(GetGlobalContext(), *answer, GetPixelFormat(), | |
1160 GetWidth(), GetHeight(), GetPitch(), GetBuffer()); | |
1161 | |
1162 target.Swap(answer); | |
1163 } | |
1164 | |
1165 | |
1166 void OrthancImage::CompressJpegImage(MemoryBuffer& target, | |
1167 uint8_t quality) const | |
1168 { | |
1169 CheckImageAvailable(); | |
1170 | |
1171 OrthancPlugins::MemoryBuffer answer; | |
1172 OrthancPluginCompressJpegImage(GetGlobalContext(), *answer, GetPixelFormat(), | |
1173 GetWidth(), GetHeight(), GetPitch(), GetBuffer(), quality); | |
1174 | |
1175 target.Swap(answer); | |
1176 } | |
1177 | |
1178 | |
1179 void OrthancImage::AnswerPngImage(OrthancPluginRestOutput* output) const | |
1180 { | |
1181 CheckImageAvailable(); | |
1182 OrthancPluginCompressAndAnswerPngImage(GetGlobalContext(), output, GetPixelFormat(), | |
1183 GetWidth(), GetHeight(), GetPitch(), GetBuffer()); | |
1184 } | |
1185 | |
1186 | |
1187 void OrthancImage::AnswerJpegImage(OrthancPluginRestOutput* output, | |
1188 uint8_t quality) const | |
1189 { | |
1190 CheckImageAvailable(); | |
1191 OrthancPluginCompressAndAnswerJpegImage(GetGlobalContext(), output, GetPixelFormat(), | |
1192 GetWidth(), GetHeight(), GetPitch(), GetBuffer(), quality); | |
1193 } | |
1194 | |
1195 | |
1196 OrthancPluginImage* OrthancImage::Release() | |
1197 { | |
1198 CheckImageAvailable(); | |
1199 OrthancPluginImage* tmp = image_; | |
1200 image_ = NULL; | |
1201 return tmp; | |
1202 } | |
1203 | |
1204 | |
1205 #if HAS_ORTHANC_PLUGIN_FIND_MATCHER == 1 | |
1206 FindMatcher::FindMatcher(const OrthancPluginWorklistQuery* worklist) : | |
1207 matcher_(NULL), | |
1208 worklist_(worklist) | |
1209 { | |
1210 if (worklist_ == NULL) | |
1211 { | |
1212 ORTHANC_PLUGINS_THROW_EXCEPTION(ParameterOutOfRange); | |
1213 } | |
1214 } | |
1215 | |
1216 | |
1217 void FindMatcher::SetupDicom(const void* query, | |
1218 uint32_t size) | |
1219 { | |
1220 worklist_ = NULL; | |
1221 | |
1222 matcher_ = OrthancPluginCreateFindMatcher(GetGlobalContext(), query, size); | |
1223 if (matcher_ == NULL) | |
1224 { | |
1225 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError); | |
1226 } | |
1227 } | |
1228 | |
1229 | |
1230 FindMatcher::~FindMatcher() | |
1231 { | |
1232 // The "worklist_" field | |
1233 | |
1234 if (matcher_ != NULL) | |
1235 { | |
1236 OrthancPluginFreeFindMatcher(GetGlobalContext(), matcher_); | |
1237 } | |
1238 } | |
1239 | |
1240 | |
1241 | |
1242 bool FindMatcher::IsMatch(const void* dicom, | |
1243 uint32_t size) const | |
1244 { | |
1245 int32_t result; | |
1246 | |
1247 if (matcher_ != NULL) | |
1248 { | |
1249 result = OrthancPluginFindMatcherIsMatch(GetGlobalContext(), matcher_, dicom, size); | |
1250 } | |
1251 else if (worklist_ != NULL) | |
1252 { | |
1253 result = OrthancPluginWorklistIsMatch(GetGlobalContext(), worklist_, dicom, size); | |
1254 } | |
1255 else | |
1256 { | |
1257 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError); | |
1258 } | |
1259 | |
1260 if (result == 0) | |
1261 { | |
1262 return false; | |
1263 } | |
1264 else if (result == 1) | |
1265 { | |
1266 return true; | |
1267 } | |
1268 else | |
1269 { | |
1270 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError); | |
1271 } | |
1272 } | |
1273 | |
1274 #endif /* HAS_ORTHANC_PLUGIN_FIND_MATCHER == 1 */ | |
1275 | |
1276 void AnswerJson(const Json::Value& value, | |
212 | 1277 OrthancPluginRestOutput* output) |
194 | 1278 { |
212 | 1279 std::string bodyString; |
1280 WriteStyledJson(bodyString, value); | |
194 | 1281 OrthancPluginAnswerBuffer(GetGlobalContext(), output, bodyString.c_str(), bodyString.size(), "application/json"); |
1282 } | |
1283 | |
1284 void AnswerString(const std::string& answer, | |
1285 const char* mimeType, | |
212 | 1286 OrthancPluginRestOutput* output) |
194 | 1287 { |
1288 OrthancPluginAnswerBuffer(GetGlobalContext(), output, answer.c_str(), answer.size(), mimeType); | |
1289 } | |
1290 | |
1291 void AnswerHttpError(uint16_t httpError, OrthancPluginRestOutput *output) | |
1292 { | |
1293 OrthancPluginSendHttpStatusCode(GetGlobalContext(), output, httpError); | |
1294 } | |
1295 | |
1296 void AnswerMethodNotAllowed(OrthancPluginRestOutput *output, const char* allowedMethods) | |
1297 { | |
1298 OrthancPluginSendMethodNotAllowed(GetGlobalContext(), output, allowedMethods); | |
1299 } | |
1300 | |
1301 bool RestApiGetString(std::string& result, | |
1302 const std::string& uri, | |
1303 bool applyPlugins) | |
1304 { | |
1305 MemoryBuffer answer; | |
1306 if (!answer.RestApiGet(uri, applyPlugins)) | |
1307 { | |
1308 return false; | |
1309 } | |
1310 else | |
1311 { | |
1312 answer.ToString(result); | |
1313 return true; | |
1314 } | |
1315 } | |
1316 | |
1317 bool RestApiGetString(std::string& result, | |
1318 const std::string& uri, | |
1319 const std::map<std::string, std::string>& httpHeaders, | |
1320 bool applyPlugins) | |
1321 { | |
1322 MemoryBuffer answer; | |
1323 if (!answer.RestApiGet(uri, httpHeaders, applyPlugins)) | |
1324 { | |
1325 return false; | |
1326 } | |
1327 else | |
1328 { | |
1329 answer.ToString(result); | |
1330 return true; | |
1331 } | |
1332 } | |
1333 | |
1334 | |
1335 | |
1336 bool RestApiGet(Json::Value& result, | |
1337 const std::string& uri, | |
1338 bool applyPlugins) | |
1339 { | |
1340 MemoryBuffer answer; | |
1341 | |
1342 if (!answer.RestApiGet(uri, applyPlugins)) | |
1343 { | |
1344 return false; | |
1345 } | |
1346 else | |
1347 { | |
1348 if (!answer.IsEmpty()) | |
1349 { | |
1350 answer.ToJson(result); | |
1351 } | |
1352 return true; | |
1353 } | |
1354 } | |
1355 | |
1356 | |
1357 bool RestApiPost(std::string& result, | |
1358 const std::string& uri, | |
1359 const void* body, | |
1360 size_t bodySize, | |
1361 bool applyPlugins) | |
1362 { | |
1363 MemoryBuffer answer; | |
1364 | |
1365 if (!answer.RestApiPost(uri, body, bodySize, applyPlugins)) | |
1366 { | |
1367 return false; | |
1368 } | |
1369 else | |
1370 { | |
1371 if (!answer.IsEmpty()) | |
1372 { | |
1373 result.assign(answer.GetData(), answer.GetSize()); | |
1374 } | |
1375 return true; | |
1376 } | |
1377 } | |
1378 | |
1379 | |
1380 bool RestApiPost(Json::Value& result, | |
1381 const std::string& uri, | |
1382 const void* body, | |
1383 size_t bodySize, | |
1384 bool applyPlugins) | |
1385 { | |
1386 MemoryBuffer answer; | |
1387 | |
1388 if (!answer.RestApiPost(uri, body, bodySize, applyPlugins)) | |
1389 { | |
1390 return false; | |
1391 } | |
1392 else | |
1393 { | |
1394 if (!answer.IsEmpty()) | |
1395 { | |
1396 answer.ToJson(result); | |
1397 } | |
1398 return true; | |
1399 } | |
1400 } | |
1401 | |
1402 | |
1403 bool RestApiPost(Json::Value& result, | |
1404 const std::string& uri, | |
1405 const Json::Value& body, | |
1406 bool applyPlugins) | |
1407 { | |
212 | 1408 std::string s; |
1409 WriteFastJson(s, body); | |
1410 return RestApiPost(result, uri, s, applyPlugins); | |
194 | 1411 } |
1412 | |
1413 | |
1414 bool RestApiPut(Json::Value& result, | |
1415 const std::string& uri, | |
1416 const void* body, | |
1417 size_t bodySize, | |
1418 bool applyPlugins) | |
1419 { | |
1420 MemoryBuffer answer; | |
1421 | |
1422 if (!answer.RestApiPut(uri, body, bodySize, applyPlugins)) | |
1423 { | |
1424 return false; | |
1425 } | |
1426 else | |
1427 { | |
1428 if (!answer.IsEmpty()) // i.e, on a PUT to metadata/..., orthanc returns an empty response | |
1429 { | |
1430 answer.ToJson(result); | |
1431 } | |
1432 return true; | |
1433 } | |
1434 } | |
1435 | |
1436 | |
1437 bool RestApiPut(Json::Value& result, | |
1438 const std::string& uri, | |
1439 const Json::Value& body, | |
1440 bool applyPlugins) | |
1441 { | |
212 | 1442 std::string s; |
1443 WriteFastJson(s, body); | |
1444 return RestApiPut(result, uri, s, applyPlugins); | |
194 | 1445 } |
1446 | |
1447 | |
1448 bool RestApiDelete(const std::string& uri, | |
1449 bool applyPlugins) | |
1450 { | |
1451 OrthancPluginErrorCode error; | |
1452 | |
1453 if (applyPlugins) | |
1454 { | |
1455 error = OrthancPluginRestApiDeleteAfterPlugins(GetGlobalContext(), uri.c_str()); | |
1456 } | |
1457 else | |
1458 { | |
1459 error = OrthancPluginRestApiDelete(GetGlobalContext(), uri.c_str()); | |
1460 } | |
1461 | |
1462 if (error == OrthancPluginErrorCode_Success) | |
1463 { | |
1464 return true; | |
1465 } | |
1466 else if (error == OrthancPluginErrorCode_UnknownResource || | |
1467 error == OrthancPluginErrorCode_InexistentItem) | |
1468 { | |
1469 return false; | |
1470 } | |
1471 else | |
1472 { | |
1473 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(error); | |
1474 } | |
1475 } | |
1476 | |
1477 | |
1478 void ReportMinimalOrthancVersion(unsigned int major, | |
1479 unsigned int minor, | |
1480 unsigned int revision) | |
1481 { | |
1482 LogError("Your version of the Orthanc core (" + | |
1483 std::string(GetGlobalContext()->orthancVersion) + | |
1484 ") is too old to run this plugin (version " + | |
1485 boost::lexical_cast<std::string>(major) + "." + | |
1486 boost::lexical_cast<std::string>(minor) + "." + | |
1487 boost::lexical_cast<std::string>(revision) + | |
1488 " is required)"); | |
1489 } | |
1490 | |
1491 | |
1492 bool CheckMinimalOrthancVersion(unsigned int major, | |
1493 unsigned int minor, | |
1494 unsigned int revision) | |
1495 { | |
1496 if (!HasGlobalContext()) | |
1497 { | |
1498 LogError("Bad Orthanc context in the plugin"); | |
1499 return false; | |
1500 } | |
1501 | |
1502 if (!strcmp(GetGlobalContext()->orthancVersion, "mainline")) | |
1503 { | |
1504 // Assume compatibility with the mainline | |
1505 return true; | |
1506 } | |
1507 | |
1508 // Parse the version of the Orthanc core | |
1509 int aa, bb, cc; | |
1510 if ( | |
1511 #ifdef _MSC_VER | |
1512 sscanf_s | |
1513 #else | |
1514 sscanf | |
1515 #endif | |
1516 (GetGlobalContext()->orthancVersion, "%4d.%4d.%4d", &aa, &bb, &cc) != 3 || | |
1517 aa < 0 || | |
1518 bb < 0 || | |
1519 cc < 0) | |
1520 { | |
1521 return false; | |
1522 } | |
1523 | |
1524 unsigned int a = static_cast<unsigned int>(aa); | |
1525 unsigned int b = static_cast<unsigned int>(bb); | |
1526 unsigned int c = static_cast<unsigned int>(cc); | |
1527 | |
1528 // Check the major version number | |
1529 | |
1530 if (a > major) | |
1531 { | |
1532 return true; | |
1533 } | |
1534 | |
1535 if (a < major) | |
1536 { | |
1537 return false; | |
1538 } | |
1539 | |
1540 | |
1541 // Check the minor version number | |
1542 assert(a == major); | |
1543 | |
1544 if (b > minor) | |
1545 { | |
1546 return true; | |
1547 } | |
1548 | |
1549 if (b < minor) | |
1550 { | |
1551 return false; | |
1552 } | |
1553 | |
1554 // Check the patch level version number | |
1555 assert(a == major && b == minor); | |
1556 | |
1557 if (c >= revision) | |
1558 { | |
1559 return true; | |
1560 } | |
1561 else | |
1562 { | |
1563 return false; | |
1564 } | |
1565 } | |
1566 | |
1567 | |
1568 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 5, 0) | |
1569 const char* AutodetectMimeType(const std::string& path) | |
1570 { | |
1571 const char* mime = OrthancPluginAutodetectMimeType(GetGlobalContext(), path.c_str()); | |
1572 | |
1573 if (mime == NULL) | |
1574 { | |
1575 // Should never happen, just for safety | |
1576 return "application/octet-stream"; | |
1577 } | |
1578 else | |
1579 { | |
1580 return mime; | |
1581 } | |
1582 } | |
1583 #endif | |
1584 | |
1585 | |
1586 #if HAS_ORTHANC_PLUGIN_PEERS == 1 | |
1587 size_t OrthancPeers::GetPeerIndex(const std::string& name) const | |
1588 { | |
1589 size_t index; | |
1590 if (LookupName(index, name)) | |
1591 { | |
1592 return index; | |
1593 } | |
1594 else | |
1595 { | |
1596 LogError("Inexistent peer: " + name); | |
1597 ORTHANC_PLUGINS_THROW_EXCEPTION(UnknownResource); | |
1598 } | |
1599 } | |
1600 | |
1601 | |
1602 OrthancPeers::OrthancPeers() : | |
1603 peers_(NULL), | |
1604 timeout_(0) | |
1605 { | |
1606 peers_ = OrthancPluginGetPeers(GetGlobalContext()); | |
1607 | |
1608 if (peers_ == NULL) | |
1609 { | |
1610 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_Plugin); | |
1611 } | |
1612 | |
1613 uint32_t count = OrthancPluginGetPeersCount(GetGlobalContext(), peers_); | |
1614 | |
1615 for (uint32_t i = 0; i < count; i++) | |
1616 { | |
1617 const char* name = OrthancPluginGetPeerName(GetGlobalContext(), peers_, i); | |
1618 if (name == NULL) | |
1619 { | |
1620 OrthancPluginFreePeers(GetGlobalContext(), peers_); | |
1621 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_Plugin); | |
1622 } | |
1623 | |
1624 index_[name] = i; | |
1625 } | |
1626 } | |
1627 | |
1628 | |
1629 OrthancPeers::~OrthancPeers() | |
1630 { | |
1631 if (peers_ != NULL) | |
1632 { | |
1633 OrthancPluginFreePeers(GetGlobalContext(), peers_); | |
1634 } | |
1635 } | |
1636 | |
1637 | |
1638 bool OrthancPeers::LookupName(size_t& target, | |
1639 const std::string& name) const | |
1640 { | |
1641 Index::const_iterator found = index_.find(name); | |
1642 | |
1643 if (found == index_.end()) | |
1644 { | |
1645 return false; | |
1646 } | |
1647 else | |
1648 { | |
1649 target = found->second; | |
1650 return true; | |
1651 } | |
1652 } | |
1653 | |
1654 | |
1655 std::string OrthancPeers::GetPeerName(size_t index) const | |
1656 { | |
1657 if (index >= index_.size()) | |
1658 { | |
1659 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_ParameterOutOfRange); | |
1660 } | |
1661 else | |
1662 { | |
1663 const char* s = OrthancPluginGetPeerName(GetGlobalContext(), peers_, static_cast<uint32_t>(index)); | |
1664 if (s == NULL) | |
1665 { | |
1666 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_Plugin); | |
1667 } | |
1668 else | |
1669 { | |
1670 return s; | |
1671 } | |
1672 } | |
1673 } | |
1674 | |
1675 | |
1676 std::string OrthancPeers::GetPeerUrl(size_t index) const | |
1677 { | |
1678 if (index >= index_.size()) | |
1679 { | |
1680 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_ParameterOutOfRange); | |
1681 } | |
1682 else | |
1683 { | |
1684 const char* s = OrthancPluginGetPeerUrl(GetGlobalContext(), peers_, static_cast<uint32_t>(index)); | |
1685 if (s == NULL) | |
1686 { | |
1687 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_Plugin); | |
1688 } | |
1689 else | |
1690 { | |
1691 return s; | |
1692 } | |
1693 } | |
1694 } | |
1695 | |
1696 | |
1697 std::string OrthancPeers::GetPeerUrl(const std::string& name) const | |
1698 { | |
1699 return GetPeerUrl(GetPeerIndex(name)); | |
1700 } | |
1701 | |
1702 | |
1703 bool OrthancPeers::LookupUserProperty(std::string& value, | |
1704 size_t index, | |
1705 const std::string& key) const | |
1706 { | |
1707 if (index >= index_.size()) | |
1708 { | |
1709 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_ParameterOutOfRange); | |
1710 } | |
1711 else | |
1712 { | |
1713 const char* s = OrthancPluginGetPeerUserProperty(GetGlobalContext(), peers_, static_cast<uint32_t>(index), key.c_str()); | |
1714 if (s == NULL) | |
1715 { | |
1716 return false; | |
1717 } | |
1718 else | |
1719 { | |
1720 value.assign(s); | |
1721 return true; | |
1722 } | |
1723 } | |
1724 } | |
1725 | |
1726 | |
1727 bool OrthancPeers::LookupUserProperty(std::string& value, | |
1728 const std::string& peer, | |
1729 const std::string& key) const | |
1730 { | |
1731 return LookupUserProperty(value, GetPeerIndex(peer), key); | |
1732 } | |
1733 | |
1734 | |
1735 bool OrthancPeers::DoGet(MemoryBuffer& target, | |
1736 size_t index, | |
1737 const std::string& uri) const | |
1738 { | |
1739 if (index >= index_.size()) | |
1740 { | |
1741 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_ParameterOutOfRange); | |
1742 } | |
1743 | |
1744 OrthancPlugins::MemoryBuffer answer; | |
1745 uint16_t status; | |
1746 OrthancPluginErrorCode code = OrthancPluginCallPeerApi | |
1747 (GetGlobalContext(), *answer, NULL, &status, peers_, | |
1748 static_cast<uint32_t>(index), OrthancPluginHttpMethod_Get, uri.c_str(), | |
1749 0, NULL, NULL, NULL, 0, timeout_); | |
1750 | |
1751 if (code == OrthancPluginErrorCode_Success) | |
1752 { | |
1753 target.Swap(answer); | |
1754 return (status == 200); | |
1755 } | |
1756 else | |
1757 { | |
1758 return false; | |
1759 } | |
1760 } | |
1761 | |
1762 | |
1763 bool OrthancPeers::DoGet(MemoryBuffer& target, | |
1764 const std::string& name, | |
1765 const std::string& uri) const | |
1766 { | |
1767 size_t index; | |
1768 return (LookupName(index, name) && | |
1769 DoGet(target, index, uri)); | |
1770 } | |
1771 | |
1772 | |
1773 bool OrthancPeers::DoGet(Json::Value& target, | |
1774 size_t index, | |
1775 const std::string& uri) const | |
1776 { | |
1777 MemoryBuffer buffer; | |
1778 | |
1779 if (DoGet(buffer, index, uri)) | |
1780 { | |
1781 buffer.ToJson(target); | |
1782 return true; | |
1783 } | |
1784 else | |
1785 { | |
1786 return false; | |
1787 } | |
1788 } | |
1789 | |
1790 | |
1791 bool OrthancPeers::DoGet(Json::Value& target, | |
1792 const std::string& name, | |
1793 const std::string& uri) const | |
1794 { | |
1795 MemoryBuffer buffer; | |
1796 | |
1797 if (DoGet(buffer, name, uri)) | |
1798 { | |
1799 buffer.ToJson(target); | |
1800 return true; | |
1801 } | |
1802 else | |
1803 { | |
1804 return false; | |
1805 } | |
1806 } | |
1807 | |
1808 | |
1809 bool OrthancPeers::DoPost(MemoryBuffer& target, | |
1810 const std::string& name, | |
1811 const std::string& uri, | |
1812 const std::string& body) const | |
1813 { | |
1814 size_t index; | |
1815 return (LookupName(index, name) && | |
1816 DoPost(target, index, uri, body)); | |
1817 } | |
1818 | |
1819 | |
1820 bool OrthancPeers::DoPost(Json::Value& target, | |
1821 size_t index, | |
1822 const std::string& uri, | |
1823 const std::string& body) const | |
1824 { | |
1825 MemoryBuffer buffer; | |
1826 | |
1827 if (DoPost(buffer, index, uri, body)) | |
1828 { | |
1829 buffer.ToJson(target); | |
1830 return true; | |
1831 } | |
1832 else | |
1833 { | |
1834 return false; | |
1835 } | |
1836 } | |
1837 | |
1838 | |
1839 bool OrthancPeers::DoPost(Json::Value& target, | |
1840 const std::string& name, | |
1841 const std::string& uri, | |
1842 const std::string& body) const | |
1843 { | |
1844 MemoryBuffer buffer; | |
1845 | |
1846 if (DoPost(buffer, name, uri, body)) | |
1847 { | |
1848 buffer.ToJson(target); | |
1849 return true; | |
1850 } | |
1851 else | |
1852 { | |
1853 return false; | |
1854 } | |
1855 } | |
1856 | |
1857 | |
1858 bool OrthancPeers::DoPost(MemoryBuffer& target, | |
1859 size_t index, | |
1860 const std::string& uri, | |
1861 const std::string& body) const | |
1862 { | |
1863 if (index >= index_.size()) | |
1864 { | |
1865 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_ParameterOutOfRange); | |
1866 } | |
1867 | |
1868 OrthancPlugins::MemoryBuffer answer; | |
1869 uint16_t status; | |
1870 OrthancPluginErrorCode code = OrthancPluginCallPeerApi | |
1871 (GetGlobalContext(), *answer, NULL, &status, peers_, | |
1872 static_cast<uint32_t>(index), OrthancPluginHttpMethod_Post, uri.c_str(), | |
1873 0, NULL, NULL, body.empty() ? NULL : body.c_str(), body.size(), timeout_); | |
1874 | |
1875 if (code == OrthancPluginErrorCode_Success) | |
1876 { | |
1877 target.Swap(answer); | |
1878 return (status == 200); | |
1879 } | |
1880 else | |
1881 { | |
1882 return false; | |
1883 } | |
1884 } | |
1885 | |
1886 | |
1887 bool OrthancPeers::DoPut(size_t index, | |
1888 const std::string& uri, | |
1889 const std::string& body) const | |
1890 { | |
1891 if (index >= index_.size()) | |
1892 { | |
1893 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_ParameterOutOfRange); | |
1894 } | |
1895 | |
1896 OrthancPlugins::MemoryBuffer answer; | |
1897 uint16_t status; | |
1898 OrthancPluginErrorCode code = OrthancPluginCallPeerApi | |
1899 (GetGlobalContext(), *answer, NULL, &status, peers_, | |
1900 static_cast<uint32_t>(index), OrthancPluginHttpMethod_Put, uri.c_str(), | |
1901 0, NULL, NULL, body.empty() ? NULL : body.c_str(), body.size(), timeout_); | |
1902 | |
1903 if (code == OrthancPluginErrorCode_Success) | |
1904 { | |
1905 return (status == 200); | |
1906 } | |
1907 else | |
1908 { | |
1909 return false; | |
1910 } | |
1911 } | |
1912 | |
1913 | |
1914 bool OrthancPeers::DoPut(const std::string& name, | |
1915 const std::string& uri, | |
1916 const std::string& body) const | |
1917 { | |
1918 size_t index; | |
1919 return (LookupName(index, name) && | |
1920 DoPut(index, uri, body)); | |
1921 } | |
1922 | |
1923 | |
1924 bool OrthancPeers::DoDelete(size_t index, | |
1925 const std::string& uri) const | |
1926 { | |
1927 if (index >= index_.size()) | |
1928 { | |
1929 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_ParameterOutOfRange); | |
1930 } | |
1931 | |
1932 OrthancPlugins::MemoryBuffer answer; | |
1933 uint16_t status; | |
1934 OrthancPluginErrorCode code = OrthancPluginCallPeerApi | |
1935 (GetGlobalContext(), *answer, NULL, &status, peers_, | |
1936 static_cast<uint32_t>(index), OrthancPluginHttpMethod_Delete, uri.c_str(), | |
1937 0, NULL, NULL, NULL, 0, timeout_); | |
1938 | |
1939 if (code == OrthancPluginErrorCode_Success) | |
1940 { | |
1941 return (status == 200); | |
1942 } | |
1943 else | |
1944 { | |
1945 return false; | |
1946 } | |
1947 } | |
1948 | |
1949 | |
1950 bool OrthancPeers::DoDelete(const std::string& name, | |
1951 const std::string& uri) const | |
1952 { | |
1953 size_t index; | |
1954 return (LookupName(index, name) && | |
1955 DoDelete(index, uri)); | |
1956 } | |
1957 #endif | |
1958 | |
1959 | |
1960 | |
1961 | |
1962 | |
1963 /****************************************************************** | |
1964 ** JOBS | |
1965 ******************************************************************/ | |
1966 | |
1967 #if HAS_ORTHANC_PLUGIN_JOB == 1 | |
1968 void OrthancJob::CallbackFinalize(void* job) | |
1969 { | |
1970 if (job != NULL) | |
1971 { | |
1972 delete reinterpret_cast<OrthancJob*>(job); | |
1973 } | |
1974 } | |
1975 | |
1976 | |
1977 float OrthancJob::CallbackGetProgress(void* job) | |
1978 { | |
1979 assert(job != NULL); | |
1980 | |
1981 try | |
1982 { | |
1983 return reinterpret_cast<OrthancJob*>(job)->progress_; | |
1984 } | |
1985 catch (...) | |
1986 { | |
1987 return 0; | |
1988 } | |
1989 } | |
1990 | |
1991 | |
1992 const char* OrthancJob::CallbackGetContent(void* job) | |
1993 { | |
1994 assert(job != NULL); | |
1995 | |
1996 try | |
1997 { | |
1998 return reinterpret_cast<OrthancJob*>(job)->content_.c_str(); | |
1999 } | |
2000 catch (...) | |
2001 { | |
2002 return 0; | |
2003 } | |
2004 } | |
2005 | |
2006 | |
2007 const char* OrthancJob::CallbackGetSerialized(void* job) | |
2008 { | |
2009 assert(job != NULL); | |
2010 | |
2011 try | |
2012 { | |
2013 const OrthancJob& tmp = *reinterpret_cast<OrthancJob*>(job); | |
2014 | |
2015 if (tmp.hasSerialized_) | |
2016 { | |
2017 return tmp.serialized_.c_str(); | |
2018 } | |
2019 else | |
2020 { | |
2021 return NULL; | |
2022 } | |
2023 } | |
2024 catch (...) | |
2025 { | |
2026 return 0; | |
2027 } | |
2028 } | |
2029 | |
2030 | |
2031 OrthancPluginJobStepStatus OrthancJob::CallbackStep(void* job) | |
2032 { | |
2033 assert(job != NULL); | |
2034 | |
2035 try | |
2036 { | |
2037 return reinterpret_cast<OrthancJob*>(job)->Step(); | |
2038 } | |
2039 catch (ORTHANC_PLUGINS_EXCEPTION_CLASS&) | |
2040 { | |
2041 return OrthancPluginJobStepStatus_Failure; | |
2042 } | |
2043 catch (...) | |
2044 { | |
2045 return OrthancPluginJobStepStatus_Failure; | |
2046 } | |
2047 } | |
2048 | |
2049 | |
2050 OrthancPluginErrorCode OrthancJob::CallbackStop(void* job, | |
2051 OrthancPluginJobStopReason reason) | |
2052 { | |
2053 assert(job != NULL); | |
2054 | |
2055 try | |
2056 { | |
2057 reinterpret_cast<OrthancJob*>(job)->Stop(reason); | |
2058 return OrthancPluginErrorCode_Success; | |
2059 } | |
2060 catch (ORTHANC_PLUGINS_EXCEPTION_CLASS& e) | |
2061 { | |
2062 return static_cast<OrthancPluginErrorCode>(e.GetErrorCode()); | |
2063 } | |
2064 catch (...) | |
2065 { | |
2066 return OrthancPluginErrorCode_Plugin; | |
2067 } | |
2068 } | |
2069 | |
2070 | |
2071 OrthancPluginErrorCode OrthancJob::CallbackReset(void* job) | |
2072 { | |
2073 assert(job != NULL); | |
2074 | |
2075 try | |
2076 { | |
2077 reinterpret_cast<OrthancJob*>(job)->Reset(); | |
2078 return OrthancPluginErrorCode_Success; | |
2079 } | |
2080 catch (ORTHANC_PLUGINS_EXCEPTION_CLASS& e) | |
2081 { | |
2082 return static_cast<OrthancPluginErrorCode>(e.GetErrorCode()); | |
2083 } | |
2084 catch (...) | |
2085 { | |
2086 return OrthancPluginErrorCode_Plugin; | |
2087 } | |
2088 } | |
2089 | |
2090 | |
2091 void OrthancJob::ClearContent() | |
2092 { | |
2093 Json::Value empty = Json::objectValue; | |
2094 UpdateContent(empty); | |
2095 } | |
2096 | |
2097 | |
2098 void OrthancJob::UpdateContent(const Json::Value& content) | |
2099 { | |
2100 if (content.type() != Json::objectValue) | |
2101 { | |
2102 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_BadFileFormat); | |
2103 } | |
2104 else | |
2105 { | |
212 | 2106 WriteFastJson(content_, content); |
194 | 2107 } |
2108 } | |
2109 | |
2110 | |
2111 void OrthancJob::ClearSerialized() | |
2112 { | |
2113 hasSerialized_ = false; | |
2114 serialized_.clear(); | |
2115 } | |
2116 | |
2117 | |
2118 void OrthancJob::UpdateSerialized(const Json::Value& serialized) | |
2119 { | |
2120 if (serialized.type() != Json::objectValue) | |
2121 { | |
2122 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_BadFileFormat); | |
2123 } | |
2124 else | |
2125 { | |
212 | 2126 WriteFastJson(serialized_, serialized); |
194 | 2127 hasSerialized_ = true; |
2128 } | |
2129 } | |
2130 | |
2131 | |
2132 void OrthancJob::UpdateProgress(float progress) | |
2133 { | |
2134 if (progress < 0 || | |
2135 progress > 1) | |
2136 { | |
2137 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_ParameterOutOfRange); | |
2138 } | |
2139 | |
2140 progress_ = progress; | |
2141 } | |
2142 | |
2143 | |
2144 OrthancJob::OrthancJob(const std::string& jobType) : | |
2145 jobType_(jobType), | |
2146 progress_(0) | |
2147 { | |
2148 ClearContent(); | |
2149 ClearSerialized(); | |
2150 } | |
2151 | |
2152 | |
2153 OrthancPluginJob* OrthancJob::Create(OrthancJob* job) | |
2154 { | |
2155 if (job == NULL) | |
2156 { | |
2157 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_NullPointer); | |
2158 } | |
2159 | |
2160 OrthancPluginJob* orthanc = OrthancPluginCreateJob( | |
2161 GetGlobalContext(), job, CallbackFinalize, job->jobType_.c_str(), | |
2162 CallbackGetProgress, CallbackGetContent, CallbackGetSerialized, | |
2163 CallbackStep, CallbackStop, CallbackReset); | |
2164 | |
2165 if (orthanc == NULL) | |
2166 { | |
2167 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_Plugin); | |
2168 } | |
2169 else | |
2170 { | |
2171 return orthanc; | |
2172 } | |
2173 } | |
2174 | |
2175 | |
2176 std::string OrthancJob::Submit(OrthancJob* job, | |
2177 int priority) | |
2178 { | |
2179 if (job == NULL) | |
2180 { | |
2181 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_NullPointer); | |
2182 } | |
2183 | |
2184 OrthancPluginJob* orthanc = Create(job); | |
2185 | |
2186 char* id = OrthancPluginSubmitJob(GetGlobalContext(), orthanc, priority); | |
2187 | |
2188 if (id == NULL) | |
2189 { | |
2190 LogError("Plugin cannot submit job"); | |
2191 OrthancPluginFreeJob(GetGlobalContext(), orthanc); | |
2192 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_Plugin); | |
2193 } | |
2194 else | |
2195 { | |
2196 std::string tmp(id); | |
2197 tmp.assign(id); | |
2198 OrthancPluginFreeString(GetGlobalContext(), id); | |
2199 | |
2200 return tmp; | |
2201 } | |
2202 } | |
2203 | |
2204 | |
2205 void OrthancJob::SubmitAndWait(Json::Value& result, | |
2206 OrthancJob* job /* takes ownership */, | |
2207 int priority) | |
2208 { | |
2209 std::string id = Submit(job, priority); | |
2210 | |
2211 for (;;) | |
2212 { | |
2213 boost::this_thread::sleep(boost::posix_time::milliseconds(100)); | |
2214 | |
2215 Json::Value status; | |
2216 if (!RestApiGet(status, "/jobs/" + id, false) || | |
2217 !status.isMember("State") || | |
2218 status["State"].type() != Json::stringValue) | |
2219 { | |
2220 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_InexistentItem); | |
2221 } | |
2222 | |
2223 const std::string state = status["State"].asString(); | |
2224 if (state == "Success") | |
2225 { | |
2226 if (status.isMember("Content")) | |
2227 { | |
2228 result = status["Content"]; | |
2229 } | |
2230 else | |
2231 { | |
2232 result = Json::objectValue; | |
2233 } | |
2234 | |
2235 return; | |
2236 } | |
2237 else if (state == "Running") | |
2238 { | |
2239 continue; | |
2240 } | |
2241 else if (!status.isMember("ErrorCode") || | |
2242 status["ErrorCode"].type() != Json::intValue) | |
2243 { | |
2244 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(OrthancPluginErrorCode_InternalError); | |
2245 } | |
2246 else | |
2247 { | |
2248 if (!status.isMember("ErrorDescription") || | |
2249 status["ErrorDescription"].type() != Json::stringValue) | |
2250 { | |
2251 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(status["ErrorCode"].asInt()); | |
2252 } | |
2253 else | |
2254 { | |
2255 #if HAS_ORTHANC_EXCEPTION == 1 | |
2256 throw Orthanc::OrthancException(static_cast<Orthanc::ErrorCode>(status["ErrorCode"].asInt()), | |
2257 status["ErrorDescription"].asString()); | |
2258 #else | |
2259 LogError("Exception while executing the job: " + status["ErrorDescription"].asString()); | |
2260 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(status["ErrorCode"].asInt()); | |
2261 #endif | |
2262 } | |
2263 } | |
2264 } | |
2265 } | |
2266 | |
2267 | |
2268 void OrthancJob::SubmitFromRestApiPost(OrthancPluginRestOutput* output, | |
2269 const Json::Value& body, | |
2270 OrthancJob* job) | |
2271 { | |
2272 static const char* KEY_SYNCHRONOUS = "Synchronous"; | |
2273 static const char* KEY_ASYNCHRONOUS = "Asynchronous"; | |
2274 static const char* KEY_PRIORITY = "Priority"; | |
2275 | |
2276 boost::movelib::unique_ptr<OrthancJob> protection(job); | |
2277 | |
2278 if (body.type() != Json::objectValue) | |
2279 { | |
2280 #if HAS_ORTHANC_EXCEPTION == 1 | |
2281 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadFileFormat, | |
2282 "Expected a JSON object in the body"); | |
2283 #else | |
2284 LogError("Expected a JSON object in the body"); | |
2285 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
2286 #endif | |
2287 } | |
2288 | |
2289 bool synchronous = true; | |
2290 | |
2291 if (body.isMember(KEY_SYNCHRONOUS)) | |
2292 { | |
2293 if (body[KEY_SYNCHRONOUS].type() != Json::booleanValue) | |
2294 { | |
2295 #if HAS_ORTHANC_EXCEPTION == 1 | |
2296 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadFileFormat, | |
2297 "Option \"" + std::string(KEY_SYNCHRONOUS) + | |
2298 "\" must be Boolean"); | |
2299 #else | |
2300 LogError("Option \"" + std::string(KEY_SYNCHRONOUS) + "\" must be Boolean"); | |
2301 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
2302 #endif | |
2303 } | |
2304 else | |
2305 { | |
2306 synchronous = body[KEY_SYNCHRONOUS].asBool(); | |
2307 } | |
2308 } | |
2309 | |
2310 if (body.isMember(KEY_ASYNCHRONOUS)) | |
2311 { | |
2312 if (body[KEY_ASYNCHRONOUS].type() != Json::booleanValue) | |
2313 { | |
2314 #if HAS_ORTHANC_EXCEPTION == 1 | |
2315 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadFileFormat, | |
2316 "Option \"" + std::string(KEY_ASYNCHRONOUS) + | |
2317 "\" must be Boolean"); | |
2318 #else | |
2319 LogError("Option \"" + std::string(KEY_ASYNCHRONOUS) + "\" must be Boolean"); | |
2320 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
2321 #endif | |
2322 } | |
2323 else | |
2324 { | |
2325 synchronous = !body[KEY_ASYNCHRONOUS].asBool(); | |
2326 } | |
2327 } | |
2328 | |
2329 int priority = 0; | |
2330 | |
2331 if (body.isMember(KEY_PRIORITY)) | |
2332 { | |
2333 if (body[KEY_PRIORITY].type() != Json::booleanValue) | |
2334 { | |
2335 #if HAS_ORTHANC_EXCEPTION == 1 | |
2336 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadFileFormat, | |
2337 "Option \"" + std::string(KEY_PRIORITY) + | |
2338 "\" must be an integer"); | |
2339 #else | |
2340 LogError("Option \"" + std::string(KEY_PRIORITY) + "\" must be an integer"); | |
2341 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
2342 #endif | |
2343 } | |
2344 else | |
2345 { | |
2346 priority = !body[KEY_PRIORITY].asInt(); | |
2347 } | |
2348 } | |
2349 | |
2350 Json::Value result; | |
2351 | |
2352 if (synchronous) | |
2353 { | |
2354 OrthancPlugins::OrthancJob::SubmitAndWait(result, protection.release(), priority); | |
2355 } | |
2356 else | |
2357 { | |
2358 std::string id = OrthancPlugins::OrthancJob::Submit(protection.release(), priority); | |
2359 | |
2360 result = Json::objectValue; | |
2361 result["ID"] = id; | |
2362 result["Path"] = "/jobs/" + id; | |
2363 } | |
2364 | |
2365 std::string s = result.toStyledString(); | |
2366 OrthancPluginAnswerBuffer(OrthancPlugins::GetGlobalContext(), output, s.c_str(), | |
2367 s.size(), "application/json"); | |
2368 } | |
2369 | |
2370 #endif | |
2371 | |
2372 | |
2373 | |
2374 | |
2375 /****************************************************************** | |
2376 ** METRICS | |
2377 ******************************************************************/ | |
2378 | |
2379 #if HAS_ORTHANC_PLUGIN_METRICS == 1 | |
2380 MetricsTimer::MetricsTimer(const char* name) : | |
2381 name_(name) | |
2382 { | |
2383 start_ = boost::posix_time::microsec_clock::universal_time(); | |
2384 } | |
2385 | |
2386 MetricsTimer::~MetricsTimer() | |
2387 { | |
2388 const boost::posix_time::ptime stop = boost::posix_time::microsec_clock::universal_time(); | |
2389 const boost::posix_time::time_duration diff = stop - start_; | |
2390 OrthancPluginSetMetricsValue(GetGlobalContext(), name_.c_str(), static_cast<float>(diff.total_milliseconds()), | |
2391 OrthancPluginMetricsType_Timer); | |
2392 } | |
2393 #endif | |
2394 | |
2395 | |
2396 | |
2397 | |
2398 /****************************************************************** | |
2399 ** HTTP CLIENT | |
2400 ******************************************************************/ | |
2401 | |
2402 #if HAS_ORTHANC_PLUGIN_HTTP_CLIENT == 1 | |
2403 class HttpClient::RequestBodyWrapper : public boost::noncopyable | |
2404 { | |
2405 private: | |
2406 static RequestBodyWrapper& GetObject(void* body) | |
2407 { | |
2408 assert(body != NULL); | |
2409 return *reinterpret_cast<RequestBodyWrapper*>(body); | |
2410 } | |
2411 | |
2412 IRequestBody& body_; | |
2413 bool done_; | |
2414 std::string chunk_; | |
2415 | |
2416 public: | |
2417 RequestBodyWrapper(IRequestBody& body) : | |
2418 body_(body), | |
2419 done_(false) | |
2420 { | |
2421 } | |
2422 | |
2423 static uint8_t IsDone(void* body) | |
2424 { | |
2425 return GetObject(body).done_; | |
2426 } | |
2427 | |
2428 static const void* GetChunkData(void* body) | |
2429 { | |
2430 return GetObject(body).chunk_.c_str(); | |
2431 } | |
2432 | |
2433 static uint32_t GetChunkSize(void* body) | |
2434 { | |
2435 return static_cast<uint32_t>(GetObject(body).chunk_.size()); | |
2436 } | |
2437 | |
2438 static OrthancPluginErrorCode Next(void* body) | |
2439 { | |
2440 RequestBodyWrapper& that = GetObject(body); | |
2441 | |
2442 if (that.done_) | |
2443 { | |
2444 return OrthancPluginErrorCode_BadSequenceOfCalls; | |
2445 } | |
2446 else | |
2447 { | |
2448 try | |
2449 { | |
2450 that.done_ = !that.body_.ReadNextChunk(that.chunk_); | |
2451 return OrthancPluginErrorCode_Success; | |
2452 } | |
2453 catch (ORTHANC_PLUGINS_EXCEPTION_CLASS& e) | |
2454 { | |
2455 return static_cast<OrthancPluginErrorCode>(e.GetErrorCode()); | |
2456 } | |
2457 catch (...) | |
2458 { | |
2459 return OrthancPluginErrorCode_InternalError; | |
2460 } | |
2461 } | |
2462 } | |
2463 }; | |
2464 | |
2465 | |
2466 #if HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_CLIENT == 1 | |
2467 static OrthancPluginErrorCode AnswerAddHeaderCallback(void* answer, | |
2468 const char* key, | |
2469 const char* value) | |
2470 { | |
2471 assert(answer != NULL && key != NULL && value != NULL); | |
2472 | |
2473 try | |
2474 { | |
2475 reinterpret_cast<HttpClient::IAnswer*>(answer)->AddHeader(key, value); | |
2476 return OrthancPluginErrorCode_Success; | |
2477 } | |
2478 catch (ORTHANC_PLUGINS_EXCEPTION_CLASS& e) | |
2479 { | |
2480 return static_cast<OrthancPluginErrorCode>(e.GetErrorCode()); | |
2481 } | |
2482 catch (...) | |
2483 { | |
2484 return OrthancPluginErrorCode_Plugin; | |
2485 } | |
2486 } | |
2487 #endif | |
2488 | |
2489 | |
2490 #if HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_CLIENT == 1 | |
2491 static OrthancPluginErrorCode AnswerAddChunkCallback(void* answer, | |
2492 const void* data, | |
2493 uint32_t size) | |
2494 { | |
2495 assert(answer != NULL); | |
2496 | |
2497 try | |
2498 { | |
2499 reinterpret_cast<HttpClient::IAnswer*>(answer)->AddChunk(data, size); | |
2500 return OrthancPluginErrorCode_Success; | |
2501 } | |
2502 catch (ORTHANC_PLUGINS_EXCEPTION_CLASS& e) | |
2503 { | |
2504 return static_cast<OrthancPluginErrorCode>(e.GetErrorCode()); | |
2505 } | |
2506 catch (...) | |
2507 { | |
2508 return OrthancPluginErrorCode_Plugin; | |
2509 } | |
2510 } | |
2511 #endif | |
2512 | |
2513 | |
2514 HttpClient::HttpClient() : | |
2515 httpStatus_(0), | |
2516 method_(OrthancPluginHttpMethod_Get), | |
2517 timeout_(0), | |
2518 pkcs11_(false), | |
2519 chunkedBody_(NULL), | |
2520 allowChunkedTransfers_(true) | |
2521 { | |
2522 } | |
2523 | |
2524 | |
2525 void HttpClient::AddHeaders(const HttpHeaders& headers) | |
2526 { | |
2527 for (HttpHeaders::const_iterator it = headers.begin(); | |
2528 it != headers.end(); ++it) | |
2529 { | |
2530 headers_[it->first] = it->second; | |
2531 } | |
2532 } | |
2533 | |
2534 | |
2535 void HttpClient::SetCredentials(const std::string& username, | |
2536 const std::string& password) | |
2537 { | |
2538 username_ = username; | |
2539 password_ = password; | |
2540 } | |
2541 | |
2542 | |
2543 void HttpClient::ClearCredentials() | |
2544 { | |
2545 username_.empty(); | |
2546 password_.empty(); | |
2547 } | |
2548 | |
2549 | |
2550 void HttpClient::SetCertificate(const std::string& certificateFile, | |
2551 const std::string& keyFile, | |
2552 const std::string& keyPassword) | |
2553 { | |
2554 certificateFile_ = certificateFile; | |
2555 certificateKeyFile_ = keyFile; | |
2556 certificateKeyPassword_ = keyPassword; | |
2557 } | |
2558 | |
2559 | |
2560 void HttpClient::ClearCertificate() | |
2561 { | |
2562 certificateFile_.clear(); | |
2563 certificateKeyFile_.clear(); | |
2564 certificateKeyPassword_.clear(); | |
2565 } | |
2566 | |
2567 | |
2568 void HttpClient::ClearBody() | |
2569 { | |
2570 fullBody_.clear(); | |
2571 chunkedBody_ = NULL; | |
2572 } | |
2573 | |
2574 | |
2575 void HttpClient::SwapBody(std::string& body) | |
2576 { | |
2577 fullBody_.swap(body); | |
2578 chunkedBody_ = NULL; | |
2579 } | |
2580 | |
2581 | |
2582 void HttpClient::SetBody(const std::string& body) | |
2583 { | |
2584 fullBody_ = body; | |
2585 chunkedBody_ = NULL; | |
2586 } | |
2587 | |
2588 | |
2589 void HttpClient::SetBody(IRequestBody& body) | |
2590 { | |
2591 fullBody_.clear(); | |
2592 chunkedBody_ = &body; | |
2593 } | |
2594 | |
2595 | |
2596 namespace | |
2597 { | |
2598 class HeadersWrapper : public boost::noncopyable | |
2599 { | |
2600 private: | |
2601 std::vector<const char*> headersKeys_; | |
2602 std::vector<const char*> headersValues_; | |
2603 | |
2604 public: | |
2605 HeadersWrapper(const HttpClient::HttpHeaders& headers) | |
2606 { | |
2607 headersKeys_.reserve(headers.size()); | |
2608 headersValues_.reserve(headers.size()); | |
2609 | |
2610 for (HttpClient::HttpHeaders::const_iterator it = headers.begin(); it != headers.end(); ++it) | |
2611 { | |
2612 headersKeys_.push_back(it->first.c_str()); | |
2613 headersValues_.push_back(it->second.c_str()); | |
2614 } | |
2615 } | |
2616 | |
2617 void AddStaticString(const char* key, | |
2618 const char* value) | |
2619 { | |
2620 headersKeys_.push_back(key); | |
2621 headersValues_.push_back(value); | |
2622 } | |
2623 | |
2624 uint32_t GetCount() const | |
2625 { | |
2626 return headersKeys_.size(); | |
2627 } | |
2628 | |
2629 const char* const* GetKeys() const | |
2630 { | |
2631 return headersKeys_.empty() ? NULL : &headersKeys_[0]; | |
2632 } | |
2633 | |
2634 const char* const* GetValues() const | |
2635 { | |
2636 return headersValues_.empty() ? NULL : &headersValues_[0]; | |
2637 } | |
2638 }; | |
2639 | |
2640 | |
2641 class MemoryRequestBody : public HttpClient::IRequestBody | |
2642 { | |
2643 private: | |
2644 std::string body_; | |
2645 bool done_; | |
2646 | |
2647 public: | |
2648 MemoryRequestBody(const std::string& body) : | |
2649 body_(body), | |
2650 done_(false) | |
2651 { | |
2652 if (body_.empty()) | |
2653 { | |
2654 done_ = true; | |
2655 } | |
2656 } | |
2657 | |
2658 virtual bool ReadNextChunk(std::string& chunk) | |
2659 { | |
2660 if (done_) | |
2661 { | |
2662 return false; | |
2663 } | |
2664 else | |
2665 { | |
2666 chunk.swap(body_); | |
2667 done_ = true; | |
2668 return true; | |
2669 } | |
2670 } | |
2671 }; | |
2672 | |
2673 | |
2674 // This class mimics Orthanc::ChunkedBuffer | |
2675 class ChunkedBuffer : public boost::noncopyable | |
2676 { | |
2677 private: | |
2678 typedef std::list<std::string*> Content; | |
2679 | |
2680 Content content_; | |
2681 size_t size_; | |
2682 | |
2683 public: | |
2684 ChunkedBuffer() : | |
2685 size_(0) | |
2686 { | |
2687 } | |
2688 | |
2689 ~ChunkedBuffer() | |
2690 { | |
2691 Clear(); | |
2692 } | |
2693 | |
2694 void Clear() | |
2695 { | |
2696 for (Content::iterator it = content_.begin(); it != content_.end(); ++it) | |
2697 { | |
2698 assert(*it != NULL); | |
2699 delete *it; | |
2700 } | |
2701 | |
2702 content_.clear(); | |
2703 } | |
2704 | |
2705 void Flatten(std::string& target) const | |
2706 { | |
2707 target.resize(size_); | |
2708 | |
2709 size_t pos = 0; | |
2710 | |
2711 for (Content::const_iterator it = content_.begin(); it != content_.end(); ++it) | |
2712 { | |
2713 assert(*it != NULL); | |
2714 size_t s = (*it)->size(); | |
2715 | |
2716 if (s != 0) | |
2717 { | |
2718 memcpy(&target[pos], (*it)->c_str(), s); | |
2719 pos += s; | |
2720 } | |
2721 } | |
2722 | |
2723 assert(size_ == 0 || | |
2724 pos == target.size()); | |
2725 } | |
2726 | |
2727 void AddChunk(const void* data, | |
2728 size_t size) | |
2729 { | |
2730 content_.push_back(new std::string(reinterpret_cast<const char*>(data), size)); | |
2731 size_ += size; | |
2732 } | |
2733 | |
2734 void AddChunk(const std::string& chunk) | |
2735 { | |
2736 content_.push_back(new std::string(chunk)); | |
2737 size_ += chunk.size(); | |
2738 } | |
2739 }; | |
2740 | |
2741 | |
2742 #if HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_CLIENT == 1 | |
2743 class MemoryAnswer : public HttpClient::IAnswer | |
2744 { | |
2745 private: | |
2746 HttpClient::HttpHeaders headers_; | |
2747 ChunkedBuffer body_; | |
2748 | |
2749 public: | |
2750 const HttpClient::HttpHeaders& GetHeaders() const | |
2751 { | |
2752 return headers_; | |
2753 } | |
2754 | |
2755 const ChunkedBuffer& GetBody() const | |
2756 { | |
2757 return body_; | |
2758 } | |
2759 | |
2760 virtual void AddHeader(const std::string& key, | |
2761 const std::string& value) | |
2762 { | |
2763 headers_[key] = value; | |
2764 } | |
2765 | |
2766 virtual void AddChunk(const void* data, | |
2767 size_t size) | |
2768 { | |
2769 body_.AddChunk(data, size); | |
2770 } | |
2771 }; | |
2772 #endif | |
2773 } | |
2774 | |
2775 | |
2776 #if HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_CLIENT == 1 | |
2777 void HttpClient::ExecuteWithStream(uint16_t& httpStatus, | |
2778 IAnswer& answer, | |
2779 IRequestBody& body) const | |
2780 { | |
2781 HeadersWrapper h(headers_); | |
2782 | |
2783 if (method_ == OrthancPluginHttpMethod_Post || | |
2784 method_ == OrthancPluginHttpMethod_Put) | |
2785 { | |
2786 // Automatically set the "Transfer-Encoding" header if absent | |
2787 bool found = false; | |
2788 | |
2789 for (HttpHeaders::const_iterator it = headers_.begin(); it != headers_.end(); ++it) | |
2790 { | |
2791 if (boost::iequals(it->first, "Transfer-Encoding")) | |
2792 { | |
2793 found = true; | |
2794 break; | |
2795 } | |
2796 } | |
2797 | |
2798 if (!found) | |
2799 { | |
2800 h.AddStaticString("Transfer-Encoding", "chunked"); | |
2801 } | |
2802 } | |
2803 | |
2804 RequestBodyWrapper request(body); | |
2805 | |
2806 OrthancPluginErrorCode error = OrthancPluginChunkedHttpClient( | |
2807 GetGlobalContext(), | |
2808 &answer, | |
2809 AnswerAddChunkCallback, | |
2810 AnswerAddHeaderCallback, | |
2811 &httpStatus, | |
2812 method_, | |
2813 url_.c_str(), | |
2814 h.GetCount(), | |
2815 h.GetKeys(), | |
2816 h.GetValues(), | |
2817 &request, | |
2818 RequestBodyWrapper::IsDone, | |
2819 RequestBodyWrapper::GetChunkData, | |
2820 RequestBodyWrapper::GetChunkSize, | |
2821 RequestBodyWrapper::Next, | |
2822 username_.empty() ? NULL : username_.c_str(), | |
2823 password_.empty() ? NULL : password_.c_str(), | |
2824 timeout_, | |
2825 certificateFile_.empty() ? NULL : certificateFile_.c_str(), | |
2826 certificateFile_.empty() ? NULL : certificateKeyFile_.c_str(), | |
2827 certificateFile_.empty() ? NULL : certificateKeyPassword_.c_str(), | |
2828 pkcs11_ ? 1 : 0); | |
2829 | |
2830 if (error != OrthancPluginErrorCode_Success) | |
2831 { | |
2832 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(error); | |
2833 } | |
2834 } | |
2835 #endif | |
2836 | |
2837 | |
2838 void HttpClient::ExecuteWithoutStream(uint16_t& httpStatus, | |
2839 HttpHeaders& answerHeaders, | |
2840 std::string& answerBody, | |
2841 const std::string& body) const | |
2842 { | |
2843 HeadersWrapper headers(headers_); | |
2844 | |
2845 MemoryBuffer answerBodyBuffer, answerHeadersBuffer; | |
2846 | |
2847 OrthancPluginErrorCode error = OrthancPluginHttpClient( | |
2848 GetGlobalContext(), | |
2849 *answerBodyBuffer, | |
2850 *answerHeadersBuffer, | |
2851 &httpStatus, | |
2852 method_, | |
2853 url_.c_str(), | |
2854 headers.GetCount(), | |
2855 headers.GetKeys(), | |
2856 headers.GetValues(), | |
2857 body.empty() ? NULL : body.c_str(), | |
2858 body.size(), | |
2859 username_.empty() ? NULL : username_.c_str(), | |
2860 password_.empty() ? NULL : password_.c_str(), | |
2861 timeout_, | |
2862 certificateFile_.empty() ? NULL : certificateFile_.c_str(), | |
2863 certificateFile_.empty() ? NULL : certificateKeyFile_.c_str(), | |
2864 certificateFile_.empty() ? NULL : certificateKeyPassword_.c_str(), | |
2865 pkcs11_ ? 1 : 0); | |
2866 | |
2867 if (error != OrthancPluginErrorCode_Success) | |
2868 { | |
2869 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(error); | |
2870 } | |
2871 | |
2872 Json::Value v; | |
2873 answerHeadersBuffer.ToJson(v); | |
2874 | |
2875 if (v.type() != Json::objectValue) | |
2876 { | |
2877 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError); | |
2878 } | |
2879 | |
2880 Json::Value::Members members = v.getMemberNames(); | |
2881 answerHeaders.clear(); | |
2882 | |
2883 for (size_t i = 0; i < members.size(); i++) | |
2884 { | |
2885 const Json::Value& h = v[members[i]]; | |
2886 if (h.type() != Json::stringValue) | |
2887 { | |
2888 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError); | |
2889 } | |
2890 else | |
2891 { | |
2892 answerHeaders[members[i]] = h.asString(); | |
2893 } | |
2894 } | |
2895 | |
2896 answerBodyBuffer.ToString(answerBody); | |
2897 } | |
2898 | |
2899 | |
2900 void HttpClient::Execute(IAnswer& answer) | |
2901 { | |
2902 #if HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_CLIENT == 1 | |
2903 if (allowChunkedTransfers_) | |
2904 { | |
2905 if (chunkedBody_ != NULL) | |
2906 { | |
2907 ExecuteWithStream(httpStatus_, answer, *chunkedBody_); | |
2908 } | |
2909 else | |
2910 { | |
2911 MemoryRequestBody wrapper(fullBody_); | |
2912 ExecuteWithStream(httpStatus_, answer, wrapper); | |
2913 } | |
2914 | |
2915 return; | |
2916 } | |
2917 #endif | |
2918 | |
2919 // Compatibility mode for Orthanc SDK <= 1.5.6 or if chunked | |
2920 // transfers are disabled. This results in higher memory usage | |
2921 // (all chunks from the answer body are sent at once) | |
2922 | |
2923 HttpHeaders answerHeaders; | |
2924 std::string answerBody; | |
2925 Execute(answerHeaders, answerBody); | |
2926 | |
2927 for (HttpHeaders::const_iterator it = answerHeaders.begin(); | |
2928 it != answerHeaders.end(); ++it) | |
2929 { | |
2930 answer.AddHeader(it->first, it->second); | |
2931 } | |
2932 | |
2933 if (!answerBody.empty()) | |
2934 { | |
2935 answer.AddChunk(answerBody.c_str(), answerBody.size()); | |
2936 } | |
2937 } | |
2938 | |
2939 | |
2940 void HttpClient::Execute(HttpHeaders& answerHeaders /* out */, | |
2941 std::string& answerBody /* out */) | |
2942 { | |
2943 #if HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_CLIENT == 1 | |
2944 if (allowChunkedTransfers_) | |
2945 { | |
2946 MemoryAnswer answer; | |
2947 Execute(answer); | |
2948 answerHeaders = answer.GetHeaders(); | |
2949 answer.GetBody().Flatten(answerBody); | |
2950 return; | |
2951 } | |
2952 #endif | |
2953 | |
2954 // Compatibility mode for Orthanc SDK <= 1.5.6 or if chunked | |
2955 // transfers are disabled. This results in higher memory usage | |
2956 // (all chunks from the request body are sent at once) | |
2957 | |
2958 if (chunkedBody_ != NULL) | |
2959 { | |
2960 ChunkedBuffer buffer; | |
2961 | |
2962 std::string chunk; | |
2963 while (chunkedBody_->ReadNextChunk(chunk)) | |
2964 { | |
2965 buffer.AddChunk(chunk); | |
2966 } | |
2967 | |
2968 std::string body; | |
2969 buffer.Flatten(body); | |
2970 | |
2971 ExecuteWithoutStream(httpStatus_, answerHeaders, answerBody, body); | |
2972 } | |
2973 else | |
2974 { | |
2975 ExecuteWithoutStream(httpStatus_, answerHeaders, answerBody, fullBody_); | |
2976 } | |
2977 } | |
2978 | |
2979 | |
2980 void HttpClient::Execute(HttpHeaders& answerHeaders /* out */, | |
2981 Json::Value& answerBody /* out */) | |
2982 { | |
2983 std::string body; | |
2984 Execute(answerHeaders, body); | |
2985 | |
212 | 2986 if (!ReadJson(answerBody, body)) |
194 | 2987 { |
2988 LogError("Cannot convert HTTP answer body to JSON"); | |
2989 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat); | |
2990 } | |
2991 } | |
2992 | |
2993 | |
2994 void HttpClient::Execute() | |
2995 { | |
2996 HttpHeaders answerHeaders; | |
2997 std::string body; | |
2998 Execute(answerHeaders, body); | |
2999 } | |
3000 | |
3001 #endif /* HAS_ORTHANC_PLUGIN_HTTP_CLIENT == 1 */ | |
3002 | |
3003 | |
3004 | |
3005 | |
3006 | |
3007 /****************************************************************** | |
3008 ** CHUNKED HTTP SERVER | |
3009 ******************************************************************/ | |
3010 | |
3011 namespace Internals | |
3012 { | |
3013 void NullRestCallback(OrthancPluginRestOutput* output, | |
3014 const char* url, | |
3015 const OrthancPluginHttpRequest* request) | |
3016 { | |
3017 } | |
3018 | |
3019 IChunkedRequestReader *NullChunkedRestCallback(const char* url, | |
3020 const OrthancPluginHttpRequest* request) | |
3021 { | |
3022 return NULL; | |
3023 } | |
3024 | |
3025 | |
3026 #if HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_SERVER == 1 | |
3027 | |
3028 OrthancPluginErrorCode ChunkedRequestReaderAddChunk( | |
3029 OrthancPluginServerChunkedRequestReader* reader, | |
3030 const void* data, | |
3031 uint32_t size) | |
3032 { | |
3033 try | |
3034 { | |
3035 if (reader == NULL) | |
3036 { | |
3037 return OrthancPluginErrorCode_InternalError; | |
3038 } | |
3039 | |
3040 reinterpret_cast<IChunkedRequestReader*>(reader)->AddChunk(data, size); | |
3041 return OrthancPluginErrorCode_Success; | |
3042 } | |
3043 catch (ORTHANC_PLUGINS_EXCEPTION_CLASS& e) | |
3044 { | |
3045 return static_cast<OrthancPluginErrorCode>(e.GetErrorCode()); | |
3046 } | |
3047 catch (boost::bad_lexical_cast&) | |
3048 { | |
3049 return OrthancPluginErrorCode_BadFileFormat; | |
3050 } | |
3051 catch (...) | |
3052 { | |
3053 return OrthancPluginErrorCode_Plugin; | |
3054 } | |
3055 } | |
3056 | |
3057 | |
3058 OrthancPluginErrorCode ChunkedRequestReaderExecute( | |
3059 OrthancPluginServerChunkedRequestReader* reader, | |
3060 OrthancPluginRestOutput* output) | |
3061 { | |
3062 try | |
3063 { | |
3064 if (reader == NULL) | |
3065 { | |
3066 return OrthancPluginErrorCode_InternalError; | |
3067 } | |
3068 | |
3069 reinterpret_cast<IChunkedRequestReader*>(reader)->Execute(output); | |
3070 return OrthancPluginErrorCode_Success; | |
3071 } | |
3072 catch (ORTHANC_PLUGINS_EXCEPTION_CLASS& e) | |
3073 { | |
3074 return static_cast<OrthancPluginErrorCode>(e.GetErrorCode()); | |
3075 } | |
3076 catch (boost::bad_lexical_cast&) | |
3077 { | |
3078 return OrthancPluginErrorCode_BadFileFormat; | |
3079 } | |
3080 catch (...) | |
3081 { | |
3082 return OrthancPluginErrorCode_Plugin; | |
3083 } | |
3084 } | |
3085 | |
3086 | |
3087 void ChunkedRequestReaderFinalize( | |
3088 OrthancPluginServerChunkedRequestReader* reader) | |
3089 { | |
3090 if (reader != NULL) | |
3091 { | |
3092 delete reinterpret_cast<IChunkedRequestReader*>(reader); | |
3093 } | |
3094 } | |
3095 | |
3096 #else | |
3097 | |
3098 OrthancPluginErrorCode ChunkedRestCompatibility(OrthancPluginRestOutput* output, | |
3099 const char* url, | |
3100 const OrthancPluginHttpRequest* request, | |
3101 RestCallback GetHandler, | |
3102 ChunkedRestCallback PostHandler, | |
3103 RestCallback DeleteHandler, | |
3104 ChunkedRestCallback PutHandler) | |
3105 { | |
3106 try | |
3107 { | |
3108 std::string allowed; | |
3109 | |
3110 if (GetHandler != Internals::NullRestCallback) | |
3111 { | |
3112 allowed += "GET"; | |
3113 } | |
3114 | |
3115 if (PostHandler != Internals::NullChunkedRestCallback) | |
3116 { | |
3117 if (!allowed.empty()) | |
3118 { | |
3119 allowed += ","; | |
3120 } | |
3121 | |
3122 allowed += "POST"; | |
3123 } | |
3124 | |
3125 if (DeleteHandler != Internals::NullRestCallback) | |
3126 { | |
3127 if (!allowed.empty()) | |
3128 { | |
3129 allowed += ","; | |
3130 } | |
3131 | |
3132 allowed += "DELETE"; | |
3133 } | |
3134 | |
3135 if (PutHandler != Internals::NullChunkedRestCallback) | |
3136 { | |
3137 if (!allowed.empty()) | |
3138 { | |
3139 allowed += ","; | |
3140 } | |
3141 | |
3142 allowed += "PUT"; | |
3143 } | |
3144 | |
3145 switch (request->method) | |
3146 { | |
3147 case OrthancPluginHttpMethod_Get: | |
3148 if (GetHandler == Internals::NullRestCallback) | |
3149 { | |
3150 OrthancPluginSendMethodNotAllowed(GetGlobalContext(), output, allowed.c_str()); | |
3151 } | |
3152 else | |
3153 { | |
3154 GetHandler(output, url, request); | |
3155 } | |
3156 | |
3157 break; | |
3158 | |
3159 case OrthancPluginHttpMethod_Post: | |
3160 if (PostHandler == Internals::NullChunkedRestCallback) | |
3161 { | |
3162 OrthancPluginSendMethodNotAllowed(GetGlobalContext(), output, allowed.c_str()); | |
3163 } | |
3164 else | |
3165 { | |
3166 boost::movelib::unique_ptr<IChunkedRequestReader> reader(PostHandler(url, request)); | |
3167 if (reader.get() == NULL) | |
3168 { | |
3169 ORTHANC_PLUGINS_THROW_EXCEPTION(Plugin); | |
3170 } | |
3171 else | |
3172 { | |
3173 reader->AddChunk(request->body, request->bodySize); | |
3174 reader->Execute(output); | |
3175 } | |
3176 } | |
3177 | |
3178 break; | |
3179 | |
3180 case OrthancPluginHttpMethod_Delete: | |
3181 if (DeleteHandler == Internals::NullRestCallback) | |
3182 { | |
3183 OrthancPluginSendMethodNotAllowed(GetGlobalContext(), output, allowed.c_str()); | |
3184 } | |
3185 else | |
3186 { | |
3187 DeleteHandler(output, url, request); | |
3188 } | |
3189 | |
3190 break; | |
3191 | |
3192 case OrthancPluginHttpMethod_Put: | |
3193 if (PutHandler == Internals::NullChunkedRestCallback) | |
3194 { | |
3195 OrthancPluginSendMethodNotAllowed(GetGlobalContext(), output, allowed.c_str()); | |
3196 } | |
3197 else | |
3198 { | |
3199 boost::movelib::unique_ptr<IChunkedRequestReader> reader(PutHandler(url, request)); | |
3200 if (reader.get() == NULL) | |
3201 { | |
3202 ORTHANC_PLUGINS_THROW_EXCEPTION(Plugin); | |
3203 } | |
3204 else | |
3205 { | |
3206 reader->AddChunk(request->body, request->bodySize); | |
3207 reader->Execute(output); | |
3208 } | |
3209 } | |
3210 | |
3211 break; | |
3212 | |
3213 default: | |
3214 ORTHANC_PLUGINS_THROW_EXCEPTION(InternalError); | |
3215 } | |
3216 | |
3217 return OrthancPluginErrorCode_Success; | |
3218 } | |
3219 catch (ORTHANC_PLUGINS_EXCEPTION_CLASS& e) | |
3220 { | |
3221 #if HAS_ORTHANC_EXCEPTION == 1 && HAS_ORTHANC_PLUGIN_EXCEPTION_DETAILS == 1 | |
3222 if (HasGlobalContext() && | |
3223 e.HasDetails()) | |
3224 { | |
3225 // The "false" instructs Orthanc not to log the detailed | |
3226 // error message. This is to avoid duplicating the details, | |
3227 // because "OrthancException" already does it on construction. | |
3228 OrthancPluginSetHttpErrorDetails | |
3229 (GetGlobalContext(), output, e.GetDetails(), false); | |
3230 } | |
3231 #endif | |
3232 | |
3233 return static_cast<OrthancPluginErrorCode>(e.GetErrorCode()); | |
3234 } | |
3235 catch (boost::bad_lexical_cast&) | |
3236 { | |
3237 return OrthancPluginErrorCode_BadFileFormat; | |
3238 } | |
3239 catch (...) | |
3240 { | |
3241 return OrthancPluginErrorCode_Plugin; | |
3242 } | |
3243 } | |
3244 #endif | |
3245 } | |
3246 | |
3247 | |
3248 #if HAS_ORTHANC_PLUGIN_STORAGE_COMMITMENT_SCP == 1 | |
3249 OrthancPluginErrorCode IStorageCommitmentScpHandler::Lookup( | |
3250 OrthancPluginStorageCommitmentFailureReason* target, | |
3251 void* rawHandler, | |
3252 const char* sopClassUid, | |
3253 const char* sopInstanceUid) | |
3254 { | |
3255 assert(target != NULL && | |
3256 rawHandler != NULL); | |
3257 | |
3258 try | |
3259 { | |
3260 IStorageCommitmentScpHandler& handler = *reinterpret_cast<IStorageCommitmentScpHandler*>(rawHandler); | |
3261 *target = handler.Lookup(sopClassUid, sopInstanceUid); | |
3262 return OrthancPluginErrorCode_Success; | |
3263 } | |
3264 catch (ORTHANC_PLUGINS_EXCEPTION_CLASS& e) | |
3265 { | |
3266 return static_cast<OrthancPluginErrorCode>(e.GetErrorCode()); | |
3267 } | |
3268 catch (...) | |
3269 { | |
3270 return OrthancPluginErrorCode_Plugin; | |
3271 } | |
3272 } | |
3273 #endif | |
3274 | |
3275 | |
3276 #if HAS_ORTHANC_PLUGIN_STORAGE_COMMITMENT_SCP == 1 | |
3277 void IStorageCommitmentScpHandler::Destructor(void* rawHandler) | |
3278 { | |
3279 assert(rawHandler != NULL); | |
3280 delete reinterpret_cast<IStorageCommitmentScpHandler*>(rawHandler); | |
3281 } | |
3282 #endif | |
3283 | |
3284 | |
3285 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 6, 1) | |
3286 DicomInstance::DicomInstance(const OrthancPluginDicomInstance* instance) : | |
3287 toFree_(false), | |
3288 instance_(instance) | |
3289 { | |
3290 } | |
3291 #else | |
3292 DicomInstance::DicomInstance(OrthancPluginDicomInstance* instance) : | |
3293 toFree_(false), | |
3294 instance_(instance) | |
3295 { | |
3296 } | |
3297 #endif | |
3298 | |
3299 | |
3300 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
3301 DicomInstance::DicomInstance(const void* buffer, | |
3302 size_t size) : | |
3303 toFree_(true), | |
3304 instance_(OrthancPluginCreateDicomInstance(GetGlobalContext(), buffer, size)) | |
3305 { | |
3306 if (instance_ == NULL) | |
3307 { | |
3308 ORTHANC_PLUGINS_THROW_EXCEPTION(NullPointer); | |
3309 } | |
3310 } | |
3311 #endif | |
3312 | |
3313 | |
3314 DicomInstance::~DicomInstance() | |
3315 { | |
3316 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
3317 if (toFree_ && | |
3318 instance_ != NULL) | |
3319 { | |
3320 OrthancPluginFreeDicomInstance( | |
3321 GetGlobalContext(), const_cast<OrthancPluginDicomInstance*>(instance_)); | |
3322 } | |
3323 #endif | |
3324 } | |
3325 | |
3326 | |
3327 std::string DicomInstance::GetRemoteAet() const | |
3328 { | |
3329 const char* s = OrthancPluginGetInstanceRemoteAet(GetGlobalContext(), instance_); | |
3330 if (s == NULL) | |
3331 { | |
3332 ORTHANC_PLUGINS_THROW_EXCEPTION(Plugin); | |
3333 } | |
3334 else | |
3335 { | |
3336 return std::string(s); | |
3337 } | |
3338 } | |
3339 | |
3340 | |
3341 void DicomInstance::GetJson(Json::Value& target) const | |
3342 { | |
3343 OrthancString s; | |
3344 s.Assign(OrthancPluginGetInstanceJson(GetGlobalContext(), instance_)); | |
3345 s.ToJson(target); | |
3346 } | |
3347 | |
3348 | |
3349 void DicomInstance::GetSimplifiedJson(Json::Value& target) const | |
3350 { | |
3351 OrthancString s; | |
3352 s.Assign(OrthancPluginGetInstanceSimplifiedJson(GetGlobalContext(), instance_)); | |
3353 s.ToJson(target); | |
3354 } | |
3355 | |
3356 | |
3357 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 6, 1) | |
3358 std::string DicomInstance::GetTransferSyntaxUid() const | |
3359 { | |
3360 OrthancString s; | |
3361 s.Assign(OrthancPluginGetInstanceTransferSyntaxUid(GetGlobalContext(), instance_)); | |
3362 | |
3363 std::string result; | |
3364 s.ToString(result); | |
3365 return result; | |
3366 } | |
3367 #endif | |
3368 | |
3369 | |
3370 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 6, 1) | |
3371 bool DicomInstance::HasPixelData() const | |
3372 { | |
3373 int32_t result = OrthancPluginHasInstancePixelData(GetGlobalContext(), instance_); | |
3374 if (result < 0) | |
3375 { | |
3376 ORTHANC_PLUGINS_THROW_EXCEPTION(Plugin); | |
3377 } | |
3378 else | |
3379 { | |
3380 return (result != 0); | |
3381 } | |
3382 } | |
3383 #endif | |
3384 | |
3385 | |
3386 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
3387 void DicomInstance::GetRawFrame(std::string& target, | |
3388 unsigned int frameIndex) const | |
3389 { | |
3390 MemoryBuffer buffer; | |
3391 OrthancPluginErrorCode code = OrthancPluginGetInstanceRawFrame( | |
3392 GetGlobalContext(), *buffer, instance_, frameIndex); | |
3393 | |
3394 if (code == OrthancPluginErrorCode_Success) | |
3395 { | |
3396 buffer.ToString(target); | |
3397 } | |
3398 else | |
3399 { | |
3400 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(code); | |
3401 } | |
3402 } | |
3403 #endif | |
3404 | |
3405 | |
3406 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
3407 OrthancImage* DicomInstance::GetDecodedFrame(unsigned int frameIndex) const | |
3408 { | |
3409 OrthancPluginImage* image = OrthancPluginGetInstanceDecodedFrame( | |
3410 GetGlobalContext(), instance_, frameIndex); | |
3411 | |
3412 if (image == NULL) | |
3413 { | |
3414 ORTHANC_PLUGINS_THROW_EXCEPTION(Plugin); | |
3415 } | |
3416 else | |
3417 { | |
3418 return new OrthancImage(image); | |
3419 } | |
3420 } | |
3421 #endif | |
3422 | |
3423 | |
3424 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
3425 void DicomInstance::Serialize(std::string& target) const | |
3426 { | |
3427 MemoryBuffer buffer; | |
3428 OrthancPluginErrorCode code = OrthancPluginSerializeDicomInstance( | |
3429 GetGlobalContext(), *buffer, instance_); | |
3430 | |
3431 if (code == OrthancPluginErrorCode_Success) | |
3432 { | |
3433 buffer.ToString(target); | |
3434 } | |
3435 else | |
3436 { | |
3437 ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(code); | |
3438 } | |
3439 } | |
3440 #endif | |
3441 | |
3442 | |
3443 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
3444 DicomInstance* DicomInstance::Transcode(const void* buffer, | |
3445 size_t size, | |
3446 const std::string& transferSyntax) | |
3447 { | |
3448 OrthancPluginDicomInstance* instance = OrthancPluginTranscodeDicomInstance( | |
3449 GetGlobalContext(), buffer, size, transferSyntax.c_str()); | |
3450 | |
3451 if (instance == NULL) | |
3452 { | |
3453 ORTHANC_PLUGINS_THROW_EXCEPTION(Plugin); | |
3454 } | |
3455 else | |
3456 { | |
3457 boost::movelib::unique_ptr<DicomInstance> result(new DicomInstance(instance)); | |
3458 result->toFree_ = true; | |
3459 return result.release(); | |
3460 } | |
3461 } | |
3462 #endif | |
3463 } |