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