Mercurial > hg > orthanc-wsi
annotate Framework/Orthanc/Plugins/Samples/Common/OrthancPluginCppWrapper.h @ 54:06847108819c
sync
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Thu, 24 Nov 2016 12:59:50 +0100 |
parents | 77b76c1a213f |
children |
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 | |
35 #include <orthanc/OrthancCPlugin.h> | |
36 #include <boost/noncopyable.hpp> | |
37 #include <boost/lexical_cast.hpp> | |
38 #include <json/value.h> | |
39 | |
40 #if HAS_ORTHANC_EXCEPTION == 1 | |
41 # include "../../../Core/OrthancException.h" | |
42 #endif | |
43 | |
44 | |
45 namespace OrthancPlugins | |
46 { | |
47 typedef void (*RestCallback) (OrthancPluginRestOutput* output, | |
48 const char* url, | |
49 const OrthancPluginHttpRequest* request); | |
50 | |
51 | |
52 class PluginException | |
53 { | |
54 private: | |
55 OrthancPluginErrorCode code_; | |
56 | |
57 public: | |
58 PluginException(OrthancPluginErrorCode code) : code_(code) | |
59 { | |
60 } | |
61 | |
62 OrthancPluginErrorCode GetErrorCode() const | |
63 { | |
64 return code_; | |
65 } | |
66 | |
67 const char* GetErrorDescription(OrthancPluginContext* context) const; | |
68 | |
69 static void Check(OrthancPluginErrorCode code); | |
70 }; | |
71 | |
72 | |
73 class MemoryBuffer : public boost::noncopyable | |
74 { | |
75 private: | |
76 OrthancPluginContext* context_; | |
77 OrthancPluginMemoryBuffer buffer_; | |
78 | |
79 void Check(OrthancPluginErrorCode code); | |
80 | |
81 public: | |
82 MemoryBuffer(OrthancPluginContext* context); | |
83 | |
84 ~MemoryBuffer() | |
85 { | |
86 Clear(); | |
87 } | |
88 | |
89 OrthancPluginMemoryBuffer* operator*() | |
90 { | |
91 return &buffer_; | |
92 } | |
93 | |
94 // This transfers ownership | |
95 void Assign(OrthancPluginMemoryBuffer& other); | |
96 | |
97 const char* GetData() const | |
98 { | |
99 if (buffer_.size > 0) | |
100 { | |
101 return reinterpret_cast<const char*>(buffer_.data); | |
102 } | |
103 else | |
104 { | |
105 return NULL; | |
106 } | |
107 } | |
108 | |
109 size_t GetSize() const | |
110 { | |
111 return buffer_.size; | |
112 } | |
113 | |
114 void Clear(); | |
115 | |
116 void ToString(std::string& target) const; | |
117 | |
118 void ToJson(Json::Value& target) const; | |
119 | |
120 bool RestApiGet(const std::string& uri, | |
121 bool applyPlugins); | |
122 | |
123 bool RestApiPost(const std::string& uri, | |
124 const char* body, | |
125 size_t bodySize, | |
126 bool applyPlugins); | |
127 | |
128 bool RestApiPut(const std::string& uri, | |
129 const char* body, | |
130 size_t bodySize, | |
131 bool applyPlugins); | |
132 | |
133 bool RestApiPost(const std::string& uri, | |
134 const Json::Value& body, | |
135 bool applyPlugins); | |
136 | |
137 bool RestApiPut(const std::string& uri, | |
138 const Json::Value& body, | |
139 bool applyPlugins); | |
140 | |
141 bool RestApiPost(const std::string& uri, | |
142 const std::string& body, | |
143 bool applyPlugins) | |
144 { | |
145 return RestApiPost(uri, body.empty() ? NULL : body.c_str(), body.size(), applyPlugins); | |
146 } | |
147 | |
148 bool RestApiPut(const std::string& uri, | |
149 const std::string& body, | |
150 bool applyPlugins) | |
151 { | |
152 return RestApiPut(uri, body.empty() ? NULL : body.c_str(), body.size(), applyPlugins); | |
153 } | |
154 | |
155 void CreateDicom(const Json::Value& tags, | |
156 OrthancPluginCreateDicomFlags flags); | |
157 | |
158 void ReadFile(const std::string& path); | |
159 }; | |
160 | |
161 | |
162 class OrthancString : public boost::noncopyable | |
163 { | |
164 private: | |
165 OrthancPluginContext* context_; | |
166 char* str_; | |
167 | |
168 public: | |
169 OrthancString(OrthancPluginContext* context, | |
170 char* str); | |
171 | |
172 ~OrthancString() | |
173 { | |
174 Clear(); | |
175 } | |
176 | |
177 void Clear(); | |
178 | |
179 const char* GetContent() const | |
180 { | |
181 return str_; | |
182 } | |
183 | |
184 void ToString(std::string& target) const; | |
185 | |
186 void ToJson(Json::Value& target) const; | |
187 }; | |
188 | |
189 | |
190 class OrthancConfiguration : public boost::noncopyable | |
191 { | |
192 private: | |
193 OrthancPluginContext* context_; | |
54 | 194 Json::Value configuration_; // Necessarily a Json::objectValue |
1 | 195 std::string path_; |
196 | |
197 std::string GetPath(const std::string& key) const; | |
198 | |
199 public: | |
200 OrthancConfiguration() : context_(NULL) | |
201 { | |
202 } | |
203 | |
204 OrthancConfiguration(OrthancPluginContext* context); | |
205 | |
206 OrthancPluginContext* GetContext() const; | |
207 | |
208 const Json::Value& GetJson() const | |
209 { | |
210 return configuration_; | |
211 } | |
212 | |
54 | 213 bool IsSection(const std::string& key) const; |
214 | |
1 | 215 void GetSection(OrthancConfiguration& target, |
216 const std::string& key) const; | |
217 | |
218 bool LookupStringValue(std::string& target, | |
219 const std::string& key) const; | |
220 | |
221 bool LookupIntegerValue(int& target, | |
222 const std::string& key) const; | |
223 | |
224 bool LookupUnsignedIntegerValue(unsigned int& target, | |
225 const std::string& key) const; | |
226 | |
227 bool LookupBooleanValue(bool& target, | |
228 const std::string& key) const; | |
229 | |
230 bool LookupFloatValue(float& target, | |
231 const std::string& key) const; | |
232 | |
233 std::string GetStringValue(const std::string& key, | |
234 const std::string& defaultValue) const; | |
235 | |
236 int GetIntegerValue(const std::string& key, | |
237 int defaultValue) const; | |
238 | |
239 unsigned int GetUnsignedIntegerValue(const std::string& key, | |
240 unsigned int defaultValue) const; | |
241 | |
242 bool GetBooleanValue(const std::string& key, | |
243 bool defaultValue) const; | |
244 | |
245 float GetFloatValue(const std::string& key, | |
246 float defaultValue) const; | |
247 }; | |
248 | |
249 class OrthancImage | |
250 { | |
251 private: | |
252 OrthancPluginContext* context_; | |
253 OrthancPluginImage* image_; | |
254 | |
255 void Clear(); | |
256 | |
257 void CheckImageAvailable(); | |
258 | |
259 public: | |
260 OrthancImage(OrthancPluginContext* context); | |
261 | |
262 OrthancImage(OrthancPluginContext* context, | |
263 OrthancPluginImage* image); | |
264 | |
265 OrthancImage(OrthancPluginContext* context, | |
266 OrthancPluginPixelFormat format, | |
267 uint32_t width, | |
268 uint32_t height); | |
269 | |
270 ~OrthancImage() | |
271 { | |
272 Clear(); | |
273 } | |
274 | |
275 void UncompressPngImage(const void* data, | |
276 size_t size); | |
277 | |
278 void UncompressJpegImage(const void* data, | |
279 size_t size); | |
280 | |
281 void DecodeDicomImage(const void* data, | |
282 size_t size, | |
283 unsigned int frame); | |
284 | |
285 OrthancPluginPixelFormat GetPixelFormat(); | |
286 | |
287 unsigned int GetWidth(); | |
288 | |
289 unsigned int GetHeight(); | |
290 | |
291 unsigned int GetPitch(); | |
292 | |
293 const void* GetBuffer(); | |
294 | |
295 void CompressPngImage(MemoryBuffer& target); | |
296 | |
297 void CompressJpegImage(MemoryBuffer& target, | |
298 uint8_t quality); | |
299 | |
300 void AnswerPngImage(OrthancPluginRestOutput* output); | |
301 | |
302 void AnswerJpegImage(OrthancPluginRestOutput* output, | |
303 uint8_t quality); | |
304 }; | |
305 | |
306 | |
307 bool RestApiGet(Json::Value& result, | |
308 OrthancPluginContext* context, | |
309 const std::string& uri, | |
310 bool applyPlugins); | |
311 | |
312 bool RestApiPost(Json::Value& result, | |
313 OrthancPluginContext* context, | |
314 const std::string& uri, | |
315 const char* body, | |
316 size_t bodySize, | |
317 bool applyPlugins); | |
318 | |
319 bool RestApiPost(Json::Value& result, | |
320 OrthancPluginContext* context, | |
321 const std::string& uri, | |
322 const Json::Value& body, | |
323 bool applyPlugins); | |
324 | |
325 inline bool RestApiPost(Json::Value& result, | |
326 OrthancPluginContext* context, | |
327 const std::string& uri, | |
328 const std::string& body, | |
329 bool applyPlugins) | |
330 { | |
331 return RestApiPost(result, context, uri, body.empty() ? NULL : body.c_str(), | |
332 body.size(), applyPlugins); | |
333 } | |
334 | |
335 bool RestApiPut(Json::Value& result, | |
336 OrthancPluginContext* context, | |
337 const std::string& uri, | |
338 const char* body, | |
339 size_t bodySize, | |
340 bool applyPlugins); | |
341 | |
342 bool RestApiPut(Json::Value& result, | |
343 OrthancPluginContext* context, | |
344 const std::string& uri, | |
345 const Json::Value& body, | |
346 bool applyPlugins); | |
347 | |
348 inline bool RestApiPut(Json::Value& result, | |
349 OrthancPluginContext* context, | |
350 const std::string& uri, | |
351 const std::string& body, | |
352 bool applyPlugins) | |
353 { | |
354 return RestApiPut(result, context, uri, body.empty() ? NULL : body.c_str(), | |
355 body.size(), applyPlugins); | |
356 } | |
357 | |
358 bool RestApiDelete(OrthancPluginContext* context, | |
359 const std::string& uri, | |
360 bool applyPlugins); | |
361 | |
362 bool RestApiDelete(OrthancPluginContext* context, | |
363 const std::string& uri, | |
364 bool applyPlugins); | |
365 | |
366 inline void LogError(OrthancPluginContext* context, | |
367 const std::string& message) | |
368 { | |
369 if (context != NULL) | |
370 { | |
371 OrthancPluginLogError(context, message.c_str()); | |
372 } | |
373 } | |
374 | |
375 inline void LogWarning(OrthancPluginContext* context, | |
376 const std::string& message) | |
377 { | |
378 if (context != NULL) | |
379 { | |
380 OrthancPluginLogWarning(context, message.c_str()); | |
381 } | |
382 } | |
383 | |
384 inline void LogInfo(OrthancPluginContext* context, | |
385 const std::string& message) | |
386 { | |
387 if (context != NULL) | |
388 { | |
389 OrthancPluginLogInfo(context, message.c_str()); | |
390 } | |
391 } | |
392 | |
5
77b76c1a213f
check the version of the Orthanc core
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1
diff
changeset
|
393 bool CheckMinimalOrthancVersion(OrthancPluginContext* context, |
77b76c1a213f
check the version of the Orthanc core
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1
diff
changeset
|
394 unsigned int major, |
77b76c1a213f
check the version of the Orthanc core
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1
diff
changeset
|
395 unsigned int minor, |
77b76c1a213f
check the version of the Orthanc core
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1
diff
changeset
|
396 unsigned int revision); |
77b76c1a213f
check the version of the Orthanc core
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1
diff
changeset
|
397 |
1 | 398 |
399 namespace Internals | |
400 { | |
401 template <RestCallback Callback> | |
402 OrthancPluginErrorCode Protect(OrthancPluginRestOutput* output, | |
403 const char* url, | |
404 const OrthancPluginHttpRequest* request) | |
405 { | |
406 try | |
407 { | |
408 Callback(output, url, request); | |
409 return OrthancPluginErrorCode_Success; | |
410 } | |
411 catch (OrthancPlugins::PluginException& e) | |
412 { | |
413 return e.GetErrorCode(); | |
414 } | |
415 #if HAS_ORTHANC_EXCEPTION == 1 | |
416 catch (Orthanc::OrthancException& e) | |
417 { | |
418 return static_cast<OrthancPluginErrorCode>(e.GetErrorCode()); | |
419 } | |
420 #endif | |
421 catch (boost::bad_lexical_cast&) | |
422 { | |
423 return OrthancPluginErrorCode_BadFileFormat; | |
424 } | |
425 catch (...) | |
426 { | |
427 return OrthancPluginErrorCode_Plugin; | |
428 } | |
429 } | |
430 } | |
431 | |
432 | |
433 template <RestCallback Callback> | |
434 void RegisterRestCallback(OrthancPluginContext* context, | |
435 const std::string& uri, | |
436 bool isThreadSafe) | |
437 { | |
438 if (isThreadSafe) | |
439 { | |
440 OrthancPluginRegisterRestCallbackNoLock(context, uri.c_str(), Internals::Protect<Callback>); | |
441 } | |
442 else | |
443 { | |
444 OrthancPluginRegisterRestCallback(context, uri.c_str(), Internals::Protect<Callback>); | |
445 } | |
446 } | |
447 } |