Mercurial > hg > orthanc-wsi
annotate Resources/Orthanc/Plugins/Samples/Common/OrthancPluginCppWrapper.h @ 114:481eb5d78722
provision for recently-release OpenJPEG 2.3
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Thu, 12 Oct 2017 17:25:12 +0200 |
parents | a3e8ac8b7256 |
children | a18bfe1fdd62 |
rev | line source |
---|---|
1 | 1 /** |
2 * Orthanc - A Lightweight, RESTful DICOM Store | |
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
4 * Department, University Hospital of Liege, Belgium | |
98
ff0ef01c332c
shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
88
diff
changeset
|
5 * Copyright (C) 2017 Osimis, Belgium |
1 | 6 * |
7 * This program is free software: you can redistribute it and/or | |
8 * modify it under the terms of the GNU General Public License as | |
9 * published by the Free Software Foundation, either version 3 of the | |
10 * License, or (at your option) any later version. | |
11 * | |
12 * In addition, as a special exception, the copyright holders of this | |
13 * program give permission to link the code of its release with the | |
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it | |
15 * that use the same license as the "OpenSSL" library), and distribute | |
16 * the linked executables. You must obey the GNU General Public License | |
17 * in all respects for all of the code used other than "OpenSSL". If you | |
18 * modify file(s) with this exception, you may extend this exception to | |
19 * your version of the file(s), but you are not obligated to do so. If | |
20 * you do not wish to do so, delete this exception statement from your | |
21 * version. If you delete this exception statement from all source files | |
22 * in the program, then also delete it here. | |
23 * | |
24 * This program is distributed in the hope that it will be useful, but | |
25 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
27 * General Public License for more details. | |
28 * | |
29 * You should have received a copy of the GNU General Public License | |
30 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
31 **/ | |
32 | |
33 | |
34 #pragma once | |
35 | |
86 | 36 #include "OrthancPluginException.h" |
37 | |
1 | 38 #include <orthanc/OrthancCPlugin.h> |
39 #include <boost/noncopyable.hpp> | |
40 #include <boost/lexical_cast.hpp> | |
41 #include <json/value.h> | |
107 | 42 #include <list> |
43 #include <set> | |
44 | |
1 | 45 |
46 | |
107 | 47 #define ORTHANC_PLUGINS_VERSION_IS_ABOVE(major, minor, revision) \ |
48 (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER > major || \ | |
49 (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER == major && \ | |
50 (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER > minor || \ | |
51 (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER == minor && \ | |
52 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER >= revision)))) | |
53 | |
54 | |
55 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 2, 0) | |
82 | 56 // The "OrthancPluginFindMatcher()" primitive was introduced in Orthanc 1.2.0 |
57 # define HAS_ORTHANC_PLUGIN_FIND_MATCHER 1 | |
58 #else | |
59 # define HAS_ORTHANC_PLUGIN_FIND_MATCHER 0 | |
60 #endif | |
61 | |
62 | |
63 | |
1 | 64 namespace OrthancPlugins |
65 { | |
66 typedef void (*RestCallback) (OrthancPluginRestOutput* output, | |
67 const char* url, | |
68 const OrthancPluginHttpRequest* request); | |
69 | |
70 class MemoryBuffer : public boost::noncopyable | |
71 { | |
72 private: | |
73 OrthancPluginContext* context_; | |
74 OrthancPluginMemoryBuffer buffer_; | |
75 | |
76 void Check(OrthancPluginErrorCode code); | |
77 | |
107 | 78 bool CheckHttp(OrthancPluginErrorCode code); |
79 | |
1 | 80 public: |
81 MemoryBuffer(OrthancPluginContext* context); | |
82 | |
83 ~MemoryBuffer() | |
84 { | |
85 Clear(); | |
86 } | |
87 | |
88 OrthancPluginMemoryBuffer* operator*() | |
89 { | |
90 return &buffer_; | |
91 } | |
92 | |
93 // This transfers ownership | |
94 void Assign(OrthancPluginMemoryBuffer& other); | |
95 | |
96 const char* GetData() const | |
97 { | |
98 if (buffer_.size > 0) | |
99 { | |
100 return reinterpret_cast<const char*>(buffer_.data); | |
101 } | |
102 else | |
103 { | |
104 return NULL; | |
105 } | |
106 } | |
107 | |
108 size_t GetSize() const | |
109 { | |
110 return buffer_.size; | |
111 } | |
112 | |
113 void Clear(); | |
114 | |
115 void ToString(std::string& target) const; | |
116 | |
117 void ToJson(Json::Value& target) const; | |
118 | |
119 bool RestApiGet(const std::string& uri, | |
120 bool applyPlugins); | |
121 | |
122 bool RestApiPost(const std::string& uri, | |
123 const char* body, | |
124 size_t bodySize, | |
125 bool applyPlugins); | |
126 | |
127 bool RestApiPut(const std::string& uri, | |
128 const char* body, | |
129 size_t bodySize, | |
130 bool applyPlugins); | |
131 | |
132 bool RestApiPost(const std::string& uri, | |
133 const Json::Value& body, | |
134 bool applyPlugins); | |
135 | |
136 bool RestApiPut(const std::string& uri, | |
137 const Json::Value& body, | |
138 bool applyPlugins); | |
139 | |
140 bool RestApiPost(const std::string& uri, | |
141 const std::string& body, | |
142 bool applyPlugins) | |
143 { | |
144 return RestApiPost(uri, body.empty() ? NULL : body.c_str(), body.size(), applyPlugins); | |
145 } | |
146 | |
147 bool RestApiPut(const std::string& uri, | |
148 const std::string& body, | |
149 bool applyPlugins) | |
150 { | |
151 return RestApiPut(uri, body.empty() ? NULL : body.c_str(), body.size(), applyPlugins); | |
152 } | |
153 | |
154 void CreateDicom(const Json::Value& tags, | |
155 OrthancPluginCreateDicomFlags flags); | |
156 | |
157 void ReadFile(const std::string& path); | |
82 | 158 |
159 void GetDicomQuery(const OrthancPluginWorklistQuery* query); | |
160 | |
161 void DicomToJson(Json::Value& target, | |
162 OrthancPluginDicomToJsonFormat format, | |
163 OrthancPluginDicomToJsonFlags flags, | |
164 uint32_t maxStringLength); | |
107 | 165 |
166 bool HttpGet(const std::string& url, | |
167 const std::string& username, | |
168 const std::string& password); | |
169 | |
170 bool HttpPost(const std::string& url, | |
171 const std::string& body, | |
172 const std::string& username, | |
173 const std::string& password); | |
174 | |
175 bool HttpPut(const std::string& url, | |
176 const std::string& body, | |
177 const std::string& username, | |
178 const std::string& password); | |
1 | 179 }; |
180 | |
181 | |
182 class OrthancString : public boost::noncopyable | |
183 { | |
184 private: | |
185 OrthancPluginContext* context_; | |
186 char* str_; | |
187 | |
82 | 188 void Clear(); |
189 | |
1 | 190 public: |
82 | 191 OrthancString(OrthancPluginContext* context) : |
192 context_(context), | |
193 str_(NULL) | |
194 { | |
195 } | |
1 | 196 |
197 ~OrthancString() | |
198 { | |
199 Clear(); | |
200 } | |
201 | |
82 | 202 // This transfers ownership, warning: The string must have been |
203 // allocated by the Orthanc core | |
204 void Assign(char* str); | |
1 | 205 |
206 const char* GetContent() const | |
207 { | |
208 return str_; | |
209 } | |
210 | |
211 void ToString(std::string& target) const; | |
212 | |
213 void ToJson(Json::Value& target) const; | |
214 }; | |
215 | |
216 | |
217 class OrthancConfiguration : public boost::noncopyable | |
218 { | |
219 private: | |
220 OrthancPluginContext* context_; | |
54 | 221 Json::Value configuration_; // Necessarily a Json::objectValue |
1 | 222 std::string path_; |
223 | |
224 std::string GetPath(const std::string& key) const; | |
225 | |
226 public: | |
227 OrthancConfiguration() : context_(NULL) | |
228 { | |
229 } | |
230 | |
231 OrthancConfiguration(OrthancPluginContext* context); | |
232 | |
233 OrthancPluginContext* GetContext() const; | |
234 | |
235 const Json::Value& GetJson() const | |
236 { | |
237 return configuration_; | |
238 } | |
239 | |
54 | 240 bool IsSection(const std::string& key) const; |
241 | |
1 | 242 void GetSection(OrthancConfiguration& target, |
243 const std::string& key) const; | |
244 | |
245 bool LookupStringValue(std::string& target, | |
246 const std::string& key) const; | |
247 | |
248 bool LookupIntegerValue(int& target, | |
249 const std::string& key) const; | |
250 | |
251 bool LookupUnsignedIntegerValue(unsigned int& target, | |
252 const std::string& key) const; | |
253 | |
254 bool LookupBooleanValue(bool& target, | |
255 const std::string& key) const; | |
256 | |
257 bool LookupFloatValue(float& target, | |
258 const std::string& key) const; | |
259 | |
107 | 260 bool LookupListOfStrings(std::list<std::string>& target, |
261 const std::string& key, | |
262 bool allowSingleString) const; | |
263 | |
264 bool LookupSetOfStrings(std::set<std::string>& target, | |
265 const std::string& key, | |
266 bool allowSingleString) const; | |
267 | |
1 | 268 std::string GetStringValue(const std::string& key, |
269 const std::string& defaultValue) const; | |
270 | |
271 int GetIntegerValue(const std::string& key, | |
272 int defaultValue) const; | |
273 | |
274 unsigned int GetUnsignedIntegerValue(const std::string& key, | |
275 unsigned int defaultValue) const; | |
276 | |
277 bool GetBooleanValue(const std::string& key, | |
278 bool defaultValue) const; | |
279 | |
280 float GetFloatValue(const std::string& key, | |
281 float defaultValue) const; | |
282 }; | |
283 | |
82 | 284 class OrthancImage : public boost::noncopyable |
1 | 285 { |
286 private: | |
287 OrthancPluginContext* context_; | |
288 OrthancPluginImage* image_; | |
289 | |
290 void Clear(); | |
291 | |
292 void CheckImageAvailable(); | |
293 | |
294 public: | |
295 OrthancImage(OrthancPluginContext* context); | |
296 | |
297 OrthancImage(OrthancPluginContext* context, | |
298 OrthancPluginImage* image); | |
299 | |
300 OrthancImage(OrthancPluginContext* context, | |
301 OrthancPluginPixelFormat format, | |
302 uint32_t width, | |
303 uint32_t height); | |
304 | |
305 ~OrthancImage() | |
306 { | |
307 Clear(); | |
308 } | |
309 | |
310 void UncompressPngImage(const void* data, | |
311 size_t size); | |
312 | |
313 void UncompressJpegImage(const void* data, | |
314 size_t size); | |
315 | |
316 void DecodeDicomImage(const void* data, | |
317 size_t size, | |
318 unsigned int frame); | |
319 | |
320 OrthancPluginPixelFormat GetPixelFormat(); | |
321 | |
322 unsigned int GetWidth(); | |
323 | |
324 unsigned int GetHeight(); | |
325 | |
326 unsigned int GetPitch(); | |
327 | |
328 const void* GetBuffer(); | |
329 | |
330 void CompressPngImage(MemoryBuffer& target); | |
331 | |
332 void CompressJpegImage(MemoryBuffer& target, | |
333 uint8_t quality); | |
334 | |
335 void AnswerPngImage(OrthancPluginRestOutput* output); | |
336 | |
337 void AnswerJpegImage(OrthancPluginRestOutput* output, | |
338 uint8_t quality); | |
339 }; | |
340 | |
341 | |
82 | 342 #if HAS_ORTHANC_PLUGIN_FIND_MATCHER == 1 |
343 class FindMatcher : public boost::noncopyable | |
344 { | |
345 private: | |
346 OrthancPluginContext* context_; | |
347 OrthancPluginFindMatcher* matcher_; | |
348 const OrthancPluginWorklistQuery* worklist_; | |
349 | |
350 void SetupDicom(OrthancPluginContext* context, | |
351 const void* query, | |
352 uint32_t size); | |
353 | |
354 public: | |
355 FindMatcher(OrthancPluginContext* context, | |
356 const OrthancPluginWorklistQuery* worklist); | |
357 | |
358 FindMatcher(OrthancPluginContext* context, | |
359 const void* query, | |
360 uint32_t size) | |
361 { | |
362 SetupDicom(context, query, size); | |
363 } | |
364 | |
365 FindMatcher(OrthancPluginContext* context, | |
366 const MemoryBuffer& dicom) | |
367 { | |
368 SetupDicom(context, dicom.GetData(), dicom.GetSize()); | |
369 } | |
370 | |
371 ~FindMatcher(); | |
372 | |
373 bool IsMatch(const void* dicom, | |
374 uint32_t size) const; | |
375 | |
376 bool IsMatch(const MemoryBuffer& dicom) const | |
377 { | |
378 return IsMatch(dicom.GetData(), dicom.GetSize()); | |
379 } | |
380 }; | |
381 #endif | |
382 | |
383 | |
1 | 384 bool RestApiGet(Json::Value& result, |
385 OrthancPluginContext* context, | |
386 const std::string& uri, | |
387 bool applyPlugins); | |
388 | |
389 bool RestApiPost(Json::Value& result, | |
390 OrthancPluginContext* context, | |
391 const std::string& uri, | |
392 const char* body, | |
393 size_t bodySize, | |
394 bool applyPlugins); | |
395 | |
396 bool RestApiPost(Json::Value& result, | |
397 OrthancPluginContext* context, | |
398 const std::string& uri, | |
399 const Json::Value& body, | |
400 bool applyPlugins); | |
401 | |
402 inline bool RestApiPost(Json::Value& result, | |
403 OrthancPluginContext* context, | |
404 const std::string& uri, | |
405 const std::string& body, | |
406 bool applyPlugins) | |
407 { | |
408 return RestApiPost(result, context, uri, body.empty() ? NULL : body.c_str(), | |
409 body.size(), applyPlugins); | |
410 } | |
411 | |
412 bool RestApiPut(Json::Value& result, | |
413 OrthancPluginContext* context, | |
414 const std::string& uri, | |
415 const char* body, | |
416 size_t bodySize, | |
417 bool applyPlugins); | |
418 | |
419 bool RestApiPut(Json::Value& result, | |
420 OrthancPluginContext* context, | |
421 const std::string& uri, | |
422 const Json::Value& body, | |
423 bool applyPlugins); | |
424 | |
425 inline bool RestApiPut(Json::Value& result, | |
426 OrthancPluginContext* context, | |
427 const std::string& uri, | |
428 const std::string& body, | |
429 bool applyPlugins) | |
430 { | |
431 return RestApiPut(result, context, uri, body.empty() ? NULL : body.c_str(), | |
432 body.size(), applyPlugins); | |
433 } | |
434 | |
435 bool RestApiDelete(OrthancPluginContext* context, | |
436 const std::string& uri, | |
437 bool applyPlugins); | |
438 | |
107 | 439 bool HttpDelete(OrthancPluginContext* context, |
440 const std::string& url, | |
441 const std::string& username, | |
442 const std::string& password); | |
443 | |
1 | 444 inline void LogError(OrthancPluginContext* context, |
445 const std::string& message) | |
446 { | |
447 if (context != NULL) | |
448 { | |
449 OrthancPluginLogError(context, message.c_str()); | |
450 } | |
451 } | |
452 | |
453 inline void LogWarning(OrthancPluginContext* context, | |
454 const std::string& message) | |
455 { | |
456 if (context != NULL) | |
457 { | |
458 OrthancPluginLogWarning(context, message.c_str()); | |
459 } | |
460 } | |
461 | |
462 inline void LogInfo(OrthancPluginContext* context, | |
463 const std::string& message) | |
464 { | |
465 if (context != NULL) | |
466 { | |
467 OrthancPluginLogInfo(context, message.c_str()); | |
468 } | |
469 } | |
470 | |
107 | 471 void ReportMinimalOrthancVersion(OrthancPluginContext* context, |
472 unsigned int major, | |
473 unsigned int minor, | |
474 unsigned int revision); | |
475 | |
5
77b76c1a213f
check the version of the Orthanc core
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1
diff
changeset
|
476 bool CheckMinimalOrthancVersion(OrthancPluginContext* context, |
77b76c1a213f
check the version of the Orthanc core
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1
diff
changeset
|
477 unsigned int major, |
77b76c1a213f
check the version of the Orthanc core
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1
diff
changeset
|
478 unsigned int minor, |
77b76c1a213f
check the version of the Orthanc core
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1
diff
changeset
|
479 unsigned int revision); |
77b76c1a213f
check the version of the Orthanc core
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1
diff
changeset
|
480 |
1 | 481 |
482 namespace Internals | |
483 { | |
484 template <RestCallback Callback> | |
485 OrthancPluginErrorCode Protect(OrthancPluginRestOutput* output, | |
486 const char* url, | |
487 const OrthancPluginHttpRequest* request) | |
488 { | |
489 try | |
490 { | |
491 Callback(output, url, request); | |
492 return OrthancPluginErrorCode_Success; | |
493 } | |
88 | 494 catch (ORTHANC_PLUGINS_EXCEPTION_CLASS& e) |
1 | 495 { |
496 return static_cast<OrthancPluginErrorCode>(e.GetErrorCode()); | |
497 } | |
498 catch (boost::bad_lexical_cast&) | |
499 { | |
500 return OrthancPluginErrorCode_BadFileFormat; | |
501 } | |
502 catch (...) | |
503 { | |
504 return OrthancPluginErrorCode_Plugin; | |
505 } | |
506 } | |
507 } | |
508 | |
509 | |
510 template <RestCallback Callback> | |
511 void RegisterRestCallback(OrthancPluginContext* context, | |
512 const std::string& uri, | |
513 bool isThreadSafe) | |
514 { | |
515 if (isThreadSafe) | |
516 { | |
517 OrthancPluginRegisterRestCallbackNoLock(context, uri.c_str(), Internals::Protect<Callback>); | |
518 } | |
519 else | |
520 { | |
521 OrthancPluginRegisterRestCallback(context, uri.c_str(), Internals::Protect<Callback>); | |
522 } | |
523 } | |
524 } |