Mercurial > hg > orthanc-authorization
annotate Resources/Orthanc/Plugins/OrthancPluginCppWrapper.h @ 164:a1fbf3f982f8
sync
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Fri, 26 Apr 2024 17:27:13 +0200 |
parents | 6673a963ddf0 |
children | c4b908970ae4 |
rev | line source |
---|---|
34 | 1 /** |
2 * Orthanc - A Lightweight, RESTful DICOM Store | |
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
4 * Department, University Hospital of Liege, Belgium | |
155 | 5 * Copyright (C) 2017-2024 Osimis S.A., Belgium |
6 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium | |
34 | 7 * |
8 * This program is free software: you can redistribute it and/or | |
9 * modify it under the terms of the GNU General Public License as | |
10 * published by the Free Software Foundation, either version 3 of the | |
11 * License, or (at your option) any later version. | |
40 | 12 * |
34 | 13 * This program is distributed in the hope that it will be useful, but |
14 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
16 * General Public License for more details. | |
17 * | |
18 * You should have received a copy of the GNU General Public License | |
19 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
20 **/ | |
21 | |
22 | |
23 #pragma once | |
24 | |
25 #include "OrthancPluginException.h" | |
26 | |
27 #include <orthanc/OrthancCPlugin.h> | |
28 #include <boost/noncopyable.hpp> | |
29 #include <boost/lexical_cast.hpp> | |
30 #include <boost/date_time/posix_time/posix_time.hpp> | |
31 #include <json/value.h> | |
32 #include <vector> | |
33 #include <list> | |
34 #include <set> | |
35 #include <map> | |
36 | |
37 | |
38 | |
39 /** | |
40 * The definition of ORTHANC_PLUGINS_VERSION_IS_ABOVE below is for | |
41 * backward compatibility with Orthanc SDK <= 1.3.0. | |
42 * | |
43 * $ hg diff -r Orthanc-1.3.0:Orthanc-1.3.1 ../../../Plugins/Include/orthanc/OrthancCPlugin.h | |
44 * | |
45 **/ | |
46 #if !defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE) | |
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 #endif | |
54 | |
55 | |
56 #if !defined(ORTHANC_FRAMEWORK_VERSION_IS_ABOVE) | |
57 #define ORTHANC_FRAMEWORK_VERSION_IS_ABOVE(major, minor, revision) \ | |
58 (ORTHANC_VERSION_MAJOR > major || \ | |
59 (ORTHANC_VERSION_MAJOR == major && \ | |
60 (ORTHANC_VERSION_MINOR > minor || \ | |
61 (ORTHANC_VERSION_MINOR == minor && \ | |
62 ORTHANC_VERSION_REVISION >= revision)))) | |
63 #endif | |
64 | |
65 | |
66 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 2, 0) | |
67 // The "OrthancPluginFindMatcher()" primitive was introduced in Orthanc 1.2.0 | |
68 # define HAS_ORTHANC_PLUGIN_FIND_MATCHER 1 | |
69 #else | |
70 # define HAS_ORTHANC_PLUGIN_FIND_MATCHER 0 | |
71 #endif | |
72 | |
73 | |
74 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 4, 2) | |
75 # define HAS_ORTHANC_PLUGIN_PEERS 1 | |
76 # define HAS_ORTHANC_PLUGIN_JOB 1 | |
77 #else | |
78 # define HAS_ORTHANC_PLUGIN_PEERS 0 | |
79 # define HAS_ORTHANC_PLUGIN_JOB 0 | |
80 #endif | |
81 | |
82 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 5, 0) | |
83 # define HAS_ORTHANC_PLUGIN_EXCEPTION_DETAILS 1 | |
84 #else | |
85 # define HAS_ORTHANC_PLUGIN_EXCEPTION_DETAILS 0 | |
86 #endif | |
87 | |
88 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 5, 4) | |
89 # define HAS_ORTHANC_PLUGIN_METRICS 1 | |
90 #else | |
91 # define HAS_ORTHANC_PLUGIN_METRICS 0 | |
92 #endif | |
93 | |
94 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 1, 0) | |
95 # define HAS_ORTHANC_PLUGIN_HTTP_CLIENT 1 | |
96 #else | |
97 # define HAS_ORTHANC_PLUGIN_HTTP_CLIENT 0 | |
98 #endif | |
99 | |
100 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 5, 7) | |
101 # define HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_CLIENT 1 | |
102 #else | |
103 # define HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_CLIENT 0 | |
104 #endif | |
105 | |
106 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 5, 7) | |
107 # define HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_SERVER 1 | |
108 #else | |
109 # define HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_SERVER 0 | |
110 #endif | |
111 | |
112 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 6, 0) | |
113 # define HAS_ORTHANC_PLUGIN_STORAGE_COMMITMENT_SCP 1 | |
114 #else | |
115 # define HAS_ORTHANC_PLUGIN_STORAGE_COMMITMENT_SCP 0 | |
116 #endif | |
117 | |
69
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
118 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 9, 2) |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
119 # define HAS_ORTHANC_PLUGIN_GENERIC_CALL_REST_API 1 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
120 #else |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
121 # define HAS_ORTHANC_PLUGIN_GENERIC_CALL_REST_API 0 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
122 #endif |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
123 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
124 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 10, 1) |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
125 # define HAS_ORTHANC_PLUGIN_WEBDAV 1 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
126 #else |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
127 # define HAS_ORTHANC_PLUGIN_WEBDAV 0 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
128 #endif |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
129 |
164 | 130 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 12, 4) |
131 # define HAS_ORTHANC_PLUGIN_LOG_MESSAGE 1 | |
132 #else | |
133 # define HAS_ORTHANC_PLUGIN_LOG_MESSAGE 0 | |
134 #endif | |
135 | |
136 | |
137 // Macro to tag a function as having been deprecated | |
138 #if (__cplusplus >= 201402L) // C++14 | |
139 # define ORTHANC_PLUGIN_CPP_WRAPPER_DEPRECATED(f) [[deprecated]] f | |
140 #elif defined(__GNUC__) || defined(__clang__) | |
141 # define ORTHANC_PLUGIN_CPP_WRAPPER_DEPRECATED(f) f __attribute__((deprecated)) | |
142 #elif defined(_MSC_VER) | |
143 # define ORTHANC_PLUGIN_CPP_WRAPPER_DEPRECATED(f) __declspec(deprecated) f | |
144 #else | |
145 # define ORTHANC_PLUGIN_CPP_WRAPPER_DEPRECATED | |
146 #endif | |
147 | |
148 | |
149 #if !defined(__ORTHANC_FILE__) | |
150 # if defined(_MSC_VER) | |
151 # pragma message("Warning: Macro __ORTHANC_FILE__ is not defined, this will leak the full path of the source files in the binaries") | |
152 # else | |
153 # warning Warning: Macro __ORTHANC_FILE__ is not defined, this will leak the full path of the source files in the binaries | |
154 # endif | |
155 # define __ORTHANC_FILE__ __FILE__ | |
156 #endif | |
157 | |
158 | |
159 #if HAS_ORTHANC_PLUGIN_LOG_MESSAGE == 1 | |
160 # define ORTHANC_PLUGINS_LOG_ERROR(msg) ::OrthancPlugins::LogMessage(OrthancPluginLogLevel_Error, __ORTHANC_FILE__, __LINE__, msg) | |
161 # define ORTHANC_PLUGINS_LOG_WARNING(msg) ::OrthancPlugins::LogMessage(OrthancPluginLogLevel_Warning, __ORTHANC_FILE__, __LINE__, msg) | |
162 # define ORTHANC_PLUGINS_LOG_INFO(msg) ::OrthancPlugins::LogMessage(OrthancPluginLogLevel_Info, __ORTHANC_FILE__, __LINE__, msg) | |
163 #else | |
164 # define ORTHANC_PLUGINS_LOG_ERROR(msg) ::OrthancPlugins::LogError(msg) | |
165 # define ORTHANC_PLUGINS_LOG_WARNING(msg) ::OrthancPlugins::LogWarning(msg) | |
166 # define ORTHANC_PLUGINS_LOG_INFO(msg) ::OrthancPlugins::LogInfo(msg) | |
167 #endif | |
34 | 168 |
169 | |
170 namespace OrthancPlugins | |
171 { | |
172 typedef void (*RestCallback) (OrthancPluginRestOutput* output, | |
173 const char* url, | |
174 const OrthancPluginHttpRequest* request); | |
175 | |
176 void SetGlobalContext(OrthancPluginContext* context); | |
177 | |
164 | 178 void SetGlobalContext(OrthancPluginContext* context, |
179 const char* pluginName); | |
180 | |
131
11530895e0b2
run SyncOrthancFolder.py
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
71
diff
changeset
|
181 void ResetGlobalContext(); |
11530895e0b2
run SyncOrthancFolder.py
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
71
diff
changeset
|
182 |
34 | 183 bool HasGlobalContext(); |
184 | |
185 OrthancPluginContext* GetGlobalContext(); | |
186 | |
187 | |
188 class OrthancImage; | |
189 | |
190 | |
191 class MemoryBuffer : public boost::noncopyable | |
192 { | |
193 private: | |
194 OrthancPluginMemoryBuffer buffer_; | |
195 | |
196 void Check(OrthancPluginErrorCode code); | |
197 | |
198 bool CheckHttp(OrthancPluginErrorCode code); | |
199 | |
200 public: | |
201 MemoryBuffer(); | |
202 | |
203 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
204 // This constructor makes a copy of the given buffer in the memory | |
205 // handled by the Orthanc core | |
206 MemoryBuffer(const void* buffer, | |
207 size_t size); | |
208 #endif | |
209 | |
210 ~MemoryBuffer() | |
211 { | |
212 Clear(); | |
213 } | |
214 | |
215 OrthancPluginMemoryBuffer* operator*() | |
216 { | |
217 return &buffer_; | |
218 } | |
219 | |
220 // This transfers ownership from "other" to "this" | |
221 void Assign(OrthancPluginMemoryBuffer& other); | |
222 | |
223 void Swap(MemoryBuffer& other); | |
224 | |
225 OrthancPluginMemoryBuffer Release(); | |
226 | |
227 const char* GetData() const | |
228 { | |
229 if (buffer_.size > 0) | |
230 { | |
231 return reinterpret_cast<const char*>(buffer_.data); | |
232 } | |
233 else | |
234 { | |
235 return NULL; | |
236 } | |
237 } | |
238 | |
239 size_t GetSize() const | |
240 { | |
241 return buffer_.size; | |
242 } | |
243 | |
244 bool IsEmpty() const | |
245 { | |
246 return GetSize() == 0 || GetData() == NULL; | |
247 } | |
248 | |
249 void Clear(); | |
250 | |
251 void ToString(std::string& target) const; | |
252 | |
253 void ToJson(Json::Value& target) const; | |
254 | |
255 bool RestApiGet(const std::string& uri, | |
256 bool applyPlugins); | |
257 | |
258 bool RestApiGet(const std::string& uri, | |
259 const std::map<std::string, std::string>& httpHeaders, | |
260 bool applyPlugins); | |
261 | |
262 bool RestApiPost(const std::string& uri, | |
263 const void* body, | |
264 size_t bodySize, | |
265 bool applyPlugins); | |
266 | |
267 bool RestApiPut(const std::string& uri, | |
268 const void* body, | |
269 size_t bodySize, | |
270 bool applyPlugins); | |
271 | |
272 bool RestApiPost(const std::string& uri, | |
273 const Json::Value& body, | |
274 bool applyPlugins); | |
275 | |
69
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
276 #if HAS_ORTHANC_PLUGIN_GENERIC_CALL_REST_API == 1 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
277 bool RestApiPost(const std::string& uri, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
278 const Json::Value& body, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
279 const std::map<std::string, std::string>& httpHeaders, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
280 bool applyPlugins); |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
281 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
282 bool RestApiPost(const std::string& uri, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
283 const void* body, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
284 size_t bodySize, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
285 const std::map<std::string, std::string>& httpHeaders, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
286 bool applyPlugins); |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
287 #endif |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
288 |
34 | 289 bool RestApiPut(const std::string& uri, |
290 const Json::Value& body, | |
291 bool applyPlugins); | |
292 | |
293 bool RestApiPost(const std::string& uri, | |
294 const std::string& body, | |
295 bool applyPlugins) | |
296 { | |
297 return RestApiPost(uri, body.empty() ? NULL : body.c_str(), body.size(), applyPlugins); | |
298 } | |
299 | |
300 bool RestApiPut(const std::string& uri, | |
301 const std::string& body, | |
302 bool applyPlugins) | |
303 { | |
304 return RestApiPut(uri, body.empty() ? NULL : body.c_str(), body.size(), applyPlugins); | |
305 } | |
306 | |
307 void CreateDicom(const Json::Value& tags, | |
308 OrthancPluginCreateDicomFlags flags); | |
309 | |
310 void CreateDicom(const Json::Value& tags, | |
311 const OrthancImage& pixelData, | |
312 OrthancPluginCreateDicomFlags flags); | |
313 | |
314 void ReadFile(const std::string& path); | |
315 | |
316 void GetDicomQuery(const OrthancPluginWorklistQuery* query); | |
317 | |
318 void DicomToJson(Json::Value& target, | |
319 OrthancPluginDicomToJsonFormat format, | |
320 OrthancPluginDicomToJsonFlags flags, | |
321 uint32_t maxStringLength); | |
322 | |
323 bool HttpGet(const std::string& url, | |
324 const std::string& username, | |
325 const std::string& password); | |
326 | |
327 bool HttpPost(const std::string& url, | |
328 const std::string& body, | |
329 const std::string& username, | |
330 const std::string& password); | |
331 | |
332 bool HttpPut(const std::string& url, | |
333 const std::string& body, | |
334 const std::string& username, | |
335 const std::string& password); | |
336 | |
337 void GetDicomInstance(const std::string& instanceId); | |
338 }; | |
339 | |
340 | |
341 class OrthancString : public boost::noncopyable | |
342 { | |
343 private: | |
344 char* str_; | |
345 | |
346 void Clear(); | |
347 | |
348 public: | |
349 OrthancString() : | |
350 str_(NULL) | |
351 { | |
352 } | |
353 | |
354 ~OrthancString() | |
355 { | |
356 Clear(); | |
357 } | |
358 | |
359 // This transfers ownership, warning: The string must have been | |
360 // allocated by the Orthanc core | |
361 void Assign(char* str); | |
362 | |
363 const char* GetContent() const | |
364 { | |
365 return str_; | |
366 } | |
367 | |
69
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
368 bool IsNullOrEmpty() const |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
369 { |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
370 return str_ == NULL || str_[0] == 0; |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
371 } |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
372 |
34 | 373 void ToString(std::string& target) const; |
374 | |
375 void ToJson(Json::Value& target) const; | |
69
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
376 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
377 void ToJsonWithoutComments(Json::Value& target) const; |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
378 }; |
34 | 379 |
380 | |
381 class OrthancConfiguration : public boost::noncopyable | |
382 { | |
383 private: | |
384 Json::Value configuration_; // Necessarily a Json::objectValue | |
385 std::string path_; | |
386 | |
387 std::string GetPath(const std::string& key) const; | |
388 | |
389 void LoadConfiguration(); | |
390 | |
391 public: | |
71 | 392 OrthancConfiguration(); // loads the full Orthanc configuration |
34 | 393 |
394 explicit OrthancConfiguration(bool load); | |
395 | |
71 | 396 explicit OrthancConfiguration(const Json::Value& configuration, const std::string& path); // e.g. to load a section from a default json content |
397 | |
34 | 398 const Json::Value& GetJson() const |
399 { | |
400 return configuration_; | |
401 } | |
402 | |
403 bool IsSection(const std::string& key) const; | |
404 | |
405 void GetSection(OrthancConfiguration& target, | |
406 const std::string& key) const; | |
407 | |
408 bool LookupStringValue(std::string& target, | |
409 const std::string& key) const; | |
410 | |
411 bool LookupIntegerValue(int& target, | |
412 const std::string& key) const; | |
413 | |
414 bool LookupUnsignedIntegerValue(unsigned int& target, | |
415 const std::string& key) const; | |
416 | |
417 bool LookupBooleanValue(bool& target, | |
418 const std::string& key) const; | |
419 | |
420 bool LookupFloatValue(float& target, | |
421 const std::string& key) const; | |
422 | |
423 bool LookupListOfStrings(std::list<std::string>& target, | |
424 const std::string& key, | |
425 bool allowSingleString) const; | |
426 | |
427 bool LookupSetOfStrings(std::set<std::string>& target, | |
428 const std::string& key, | |
429 bool allowSingleString) const; | |
430 | |
431 std::string GetStringValue(const std::string& key, | |
432 const std::string& defaultValue) const; | |
433 | |
434 int GetIntegerValue(const std::string& key, | |
435 int defaultValue) const; | |
436 | |
437 unsigned int GetUnsignedIntegerValue(const std::string& key, | |
438 unsigned int defaultValue) const; | |
439 | |
440 bool GetBooleanValue(const std::string& key, | |
441 bool defaultValue) const; | |
442 | |
443 float GetFloatValue(const std::string& key, | |
444 float defaultValue) const; | |
445 | |
446 void GetDictionary(std::map<std::string, std::string>& target, | |
447 const std::string& key) const; | |
448 }; | |
449 | |
450 class OrthancImage : public boost::noncopyable | |
451 { | |
452 private: | |
453 OrthancPluginImage* image_; | |
454 | |
455 void Clear(); | |
456 | |
457 void CheckImageAvailable() const; | |
458 | |
459 public: | |
460 OrthancImage(); | |
461 | |
462 explicit OrthancImage(OrthancPluginImage* image); | |
463 | |
464 OrthancImage(OrthancPluginPixelFormat format, | |
465 uint32_t width, | |
466 uint32_t height); | |
467 | |
468 OrthancImage(OrthancPluginPixelFormat format, | |
469 uint32_t width, | |
470 uint32_t height, | |
471 uint32_t pitch, | |
472 void* buffer); | |
473 | |
474 ~OrthancImage() | |
475 { | |
476 Clear(); | |
477 } | |
478 | |
479 void UncompressPngImage(const void* data, | |
480 size_t size); | |
481 | |
482 void UncompressJpegImage(const void* data, | |
483 size_t size); | |
484 | |
485 void DecodeDicomImage(const void* data, | |
486 size_t size, | |
487 unsigned int frame); | |
488 | |
489 OrthancPluginPixelFormat GetPixelFormat() const; | |
490 | |
491 unsigned int GetWidth() const; | |
492 | |
493 unsigned int GetHeight() const; | |
494 | |
495 unsigned int GetPitch() const; | |
496 | |
497 void* GetBuffer() const; | |
498 | |
499 const OrthancPluginImage* GetObject() const | |
500 { | |
501 return image_; | |
502 } | |
503 | |
504 void CompressPngImage(MemoryBuffer& target) const; | |
505 | |
506 void CompressJpegImage(MemoryBuffer& target, | |
507 uint8_t quality) const; | |
508 | |
509 void AnswerPngImage(OrthancPluginRestOutput* output) const; | |
510 | |
511 void AnswerJpegImage(OrthancPluginRestOutput* output, | |
512 uint8_t quality) const; | |
513 | |
514 void* GetWriteableBuffer(); | |
515 | |
516 OrthancPluginImage* Release(); | |
517 }; | |
518 | |
519 | |
520 #if HAS_ORTHANC_PLUGIN_FIND_MATCHER == 1 | |
521 class FindMatcher : public boost::noncopyable | |
522 { | |
523 private: | |
524 OrthancPluginFindMatcher* matcher_; | |
525 const OrthancPluginWorklistQuery* worklist_; | |
526 | |
527 void SetupDicom(const void* query, | |
528 uint32_t size); | |
529 | |
530 public: | |
531 explicit FindMatcher(const OrthancPluginWorklistQuery* worklist); | |
532 | |
533 FindMatcher(const void* query, | |
534 uint32_t size) | |
535 { | |
536 SetupDicom(query, size); | |
537 } | |
538 | |
539 explicit FindMatcher(const MemoryBuffer& dicom) | |
540 { | |
541 SetupDicom(dicom.GetData(), dicom.GetSize()); | |
542 } | |
543 | |
544 ~FindMatcher(); | |
545 | |
546 bool IsMatch(const void* dicom, | |
547 uint32_t size) const; | |
548 | |
549 bool IsMatch(const MemoryBuffer& dicom) const | |
550 { | |
551 return IsMatch(dicom.GetData(), dicom.GetSize()); | |
552 } | |
553 }; | |
554 #endif | |
555 | |
556 | |
46
914b8113fd46
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
42
diff
changeset
|
557 bool ReadJson(Json::Value& target, |
914b8113fd46
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
42
diff
changeset
|
558 const std::string& source); |
914b8113fd46
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
42
diff
changeset
|
559 |
914b8113fd46
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
42
diff
changeset
|
560 bool ReadJson(Json::Value& target, |
914b8113fd46
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
42
diff
changeset
|
561 const void* buffer, |
914b8113fd46
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
42
diff
changeset
|
562 size_t size); |
914b8113fd46
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
42
diff
changeset
|
563 |
47
28d7d7598fdb
sync + no more need of "-DORTHANC_FRAMEWORK_ADDITIONAL_LIBRARIES" to dynamically link against system-wide orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
46
diff
changeset
|
564 bool ReadJsonWithoutComments(Json::Value& target, |
28d7d7598fdb
sync + no more need of "-DORTHANC_FRAMEWORK_ADDITIONAL_LIBRARIES" to dynamically link against system-wide orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
46
diff
changeset
|
565 const std::string& source); |
28d7d7598fdb
sync + no more need of "-DORTHANC_FRAMEWORK_ADDITIONAL_LIBRARIES" to dynamically link against system-wide orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
46
diff
changeset
|
566 |
28d7d7598fdb
sync + no more need of "-DORTHANC_FRAMEWORK_ADDITIONAL_LIBRARIES" to dynamically link against system-wide orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
46
diff
changeset
|
567 bool ReadJsonWithoutComments(Json::Value& target, |
28d7d7598fdb
sync + no more need of "-DORTHANC_FRAMEWORK_ADDITIONAL_LIBRARIES" to dynamically link against system-wide orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
46
diff
changeset
|
568 const void* buffer, |
28d7d7598fdb
sync + no more need of "-DORTHANC_FRAMEWORK_ADDITIONAL_LIBRARIES" to dynamically link against system-wide orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
46
diff
changeset
|
569 size_t size); |
28d7d7598fdb
sync + no more need of "-DORTHANC_FRAMEWORK_ADDITIONAL_LIBRARIES" to dynamically link against system-wide orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
46
diff
changeset
|
570 |
46
914b8113fd46
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
42
diff
changeset
|
571 void WriteFastJson(std::string& target, |
914b8113fd46
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
42
diff
changeset
|
572 const Json::Value& source); |
914b8113fd46
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
42
diff
changeset
|
573 |
914b8113fd46
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
42
diff
changeset
|
574 void WriteStyledJson(std::string& target, |
914b8113fd46
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
42
diff
changeset
|
575 const Json::Value& source); |
914b8113fd46
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
42
diff
changeset
|
576 |
34 | 577 bool RestApiGet(Json::Value& result, |
578 const std::string& uri, | |
579 bool applyPlugins); | |
580 | |
131
11530895e0b2
run SyncOrthancFolder.py
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
71
diff
changeset
|
581 bool RestApiGet(Json::Value& result, |
11530895e0b2
run SyncOrthancFolder.py
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
71
diff
changeset
|
582 const std::string& uri, |
11530895e0b2
run SyncOrthancFolder.py
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
71
diff
changeset
|
583 const std::map<std::string, std::string>& httpHeaders, |
11530895e0b2
run SyncOrthancFolder.py
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
71
diff
changeset
|
584 bool applyPlugins); |
11530895e0b2
run SyncOrthancFolder.py
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
71
diff
changeset
|
585 |
34 | 586 bool RestApiGetString(std::string& result, |
587 const std::string& uri, | |
588 bool applyPlugins); | |
589 | |
590 bool RestApiGetString(std::string& result, | |
591 const std::string& uri, | |
592 const std::map<std::string, std::string>& httpHeaders, | |
593 bool applyPlugins); | |
594 | |
595 bool RestApiPost(std::string& result, | |
596 const std::string& uri, | |
597 const void* body, | |
598 size_t bodySize, | |
599 bool applyPlugins); | |
600 | |
601 bool RestApiPost(Json::Value& result, | |
602 const std::string& uri, | |
603 const void* body, | |
604 size_t bodySize, | |
605 bool applyPlugins); | |
606 | |
69
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
607 #if HAS_ORTHANC_PLUGIN_GENERIC_CALL_REST_API == 1 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
608 bool RestApiPost(Json::Value& result, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
609 const std::string& uri, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
610 const Json::Value& body, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
611 const std::map<std::string, std::string>& httpHeaders, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
612 bool applyPlugins); |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
613 #endif |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
614 |
34 | 615 bool RestApiPost(Json::Value& result, |
616 const std::string& uri, | |
617 const Json::Value& body, | |
618 bool applyPlugins); | |
619 | |
620 inline bool RestApiPost(Json::Value& result, | |
621 const std::string& uri, | |
622 const std::string& body, | |
623 bool applyPlugins) | |
624 { | |
625 return RestApiPost(result, uri, body.empty() ? NULL : body.c_str(), | |
626 body.size(), applyPlugins); | |
627 } | |
628 | |
629 inline bool RestApiPost(Json::Value& result, | |
630 const std::string& uri, | |
631 const MemoryBuffer& body, | |
632 bool applyPlugins) | |
633 { | |
634 return RestApiPost(result, uri, body.GetData(), | |
635 body.GetSize(), applyPlugins); | |
636 } | |
637 | |
638 bool RestApiPut(Json::Value& result, | |
639 const std::string& uri, | |
640 const void* body, | |
641 size_t bodySize, | |
642 bool applyPlugins); | |
643 | |
644 bool RestApiPut(Json::Value& result, | |
645 const std::string& uri, | |
646 const Json::Value& body, | |
647 bool applyPlugins); | |
648 | |
649 inline bool RestApiPut(Json::Value& result, | |
650 const std::string& uri, | |
651 const std::string& body, | |
652 bool applyPlugins) | |
653 { | |
654 return RestApiPut(result, uri, body.empty() ? NULL : body.c_str(), | |
655 body.size(), applyPlugins); | |
656 } | |
657 | |
658 bool RestApiDelete(const std::string& uri, | |
659 bool applyPlugins); | |
660 | |
661 bool HttpDelete(const std::string& url, | |
662 const std::string& username, | |
663 const std::string& password); | |
664 | |
665 void AnswerJson(const Json::Value& value, | |
666 OrthancPluginRestOutput* output); | |
667 | |
668 void AnswerString(const std::string& answer, | |
669 const char* mimeType, | |
670 OrthancPluginRestOutput* output); | |
671 | |
672 void AnswerHttpError(uint16_t httpError, | |
673 OrthancPluginRestOutput* output); | |
674 | |
675 void AnswerMethodNotAllowed(OrthancPluginRestOutput* output, const char* allowedMethods); | |
676 | |
677 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 5, 0) | |
678 const char* AutodetectMimeType(const std::string& path); | |
679 #endif | |
680 | |
164 | 681 #if HAS_ORTHANC_PLUGIN_LOG_MESSAGE == 1 |
682 void LogMessage(OrthancPluginLogLevel level, | |
683 const char* file, | |
684 uint32_t line, | |
685 const std::string& message); | |
686 #endif | |
687 | |
688 #if HAS_ORTHANC_PLUGIN_LOG_MESSAGE == 1 | |
689 // Use macro ORTHANC_PLUGINS_LOG_ERROR() instead | |
690 ORTHANC_PLUGIN_CPP_WRAPPER_DEPRECATED(void LogError(const std::string& message)); | |
691 #else | |
34 | 692 void LogError(const std::string& message); |
164 | 693 #endif |
34 | 694 |
164 | 695 #if HAS_ORTHANC_PLUGIN_LOG_MESSAGE == 1 |
696 // Use macro ORTHANC_PLUGINS_LOG_WARNING() instead | |
697 ORTHANC_PLUGIN_CPP_WRAPPER_DEPRECATED(void LogWarning(const std::string& message)); | |
698 #else | |
34 | 699 void LogWarning(const std::string& message); |
164 | 700 #endif |
34 | 701 |
164 | 702 #if HAS_ORTHANC_PLUGIN_LOG_MESSAGE == 1 |
703 // Use macro ORTHANC_PLUGINS_LOG_INFO() instead | |
704 ORTHANC_PLUGIN_CPP_WRAPPER_DEPRECATED(void LogInfo(const std::string& message)); | |
705 #else | |
34 | 706 void LogInfo(const std::string& message); |
164 | 707 #endif |
34 | 708 |
709 void ReportMinimalOrthancVersion(unsigned int major, | |
710 unsigned int minor, | |
711 unsigned int revision); | |
712 | |
713 bool CheckMinimalOrthancVersion(unsigned int major, | |
714 unsigned int minor, | |
715 unsigned int revision); | |
716 | |
69
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
717 bool CheckMinimalVersion(const char* version, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
718 unsigned int major, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
719 unsigned int minor, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
720 unsigned int revision); |
34 | 721 |
722 namespace Internals | |
723 { | |
724 template <RestCallback Callback> | |
725 static OrthancPluginErrorCode Protect(OrthancPluginRestOutput* output, | |
726 const char* url, | |
727 const OrthancPluginHttpRequest* request) | |
728 { | |
729 try | |
730 { | |
731 Callback(output, url, request); | |
732 return OrthancPluginErrorCode_Success; | |
733 } | |
734 catch (ORTHANC_PLUGINS_EXCEPTION_CLASS& e) | |
735 { | |
736 #if HAS_ORTHANC_EXCEPTION == 1 && HAS_ORTHANC_PLUGIN_EXCEPTION_DETAILS == 1 | |
737 if (HasGlobalContext() && | |
738 e.HasDetails()) | |
739 { | |
740 // The "false" instructs Orthanc not to log the detailed | |
741 // error message. This is to avoid duplicating the details, | |
742 // because "OrthancException" already does it on construction. | |
743 OrthancPluginSetHttpErrorDetails | |
744 (GetGlobalContext(), output, e.GetDetails(), false); | |
745 } | |
746 #endif | |
747 | |
748 return static_cast<OrthancPluginErrorCode>(e.GetErrorCode()); | |
749 } | |
750 catch (boost::bad_lexical_cast&) | |
751 { | |
752 return OrthancPluginErrorCode_BadFileFormat; | |
753 } | |
754 catch (...) | |
755 { | |
756 return OrthancPluginErrorCode_Plugin; | |
757 } | |
758 } | |
759 } | |
760 | |
761 | |
762 template <RestCallback Callback> | |
763 void RegisterRestCallback(const std::string& uri, | |
764 bool isThreadSafe) | |
765 { | |
766 if (isThreadSafe) | |
767 { | |
768 OrthancPluginRegisterRestCallbackNoLock | |
769 (GetGlobalContext(), uri.c_str(), Internals::Protect<Callback>); | |
770 } | |
771 else | |
772 { | |
773 OrthancPluginRegisterRestCallback | |
774 (GetGlobalContext(), uri.c_str(), Internals::Protect<Callback>); | |
775 } | |
776 } | |
777 | |
778 | |
779 #if HAS_ORTHANC_PLUGIN_PEERS == 1 | |
780 class OrthancPeers : public boost::noncopyable | |
781 { | |
782 private: | |
783 typedef std::map<std::string, uint32_t> Index; | |
784 | |
785 OrthancPluginPeers *peers_; | |
786 Index index_; | |
787 uint32_t timeout_; | |
788 | |
789 size_t GetPeerIndex(const std::string& name) const; | |
790 | |
791 public: | |
792 OrthancPeers(); | |
793 | |
794 ~OrthancPeers(); | |
795 | |
796 uint32_t GetTimeout() const | |
797 { | |
798 return timeout_; | |
799 } | |
800 | |
801 void SetTimeout(uint32_t timeout) | |
802 { | |
803 timeout_ = timeout; | |
804 } | |
805 | |
806 bool LookupName(size_t& target, | |
807 const std::string& name) const; | |
808 | |
809 std::string GetPeerName(size_t index) const; | |
810 | |
811 std::string GetPeerUrl(size_t index) const; | |
812 | |
813 std::string GetPeerUrl(const std::string& name) const; | |
814 | |
815 size_t GetPeersCount() const | |
816 { | |
817 return index_.size(); | |
818 } | |
819 | |
820 bool LookupUserProperty(std::string& value, | |
821 size_t index, | |
822 const std::string& key) const; | |
823 | |
824 bool LookupUserProperty(std::string& value, | |
825 const std::string& peer, | |
826 const std::string& key) const; | |
827 | |
828 bool DoGet(MemoryBuffer& target, | |
829 size_t index, | |
69
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
830 const std::string& uri, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
831 const std::map<std::string, std::string>& headers) const; |
34 | 832 |
833 bool DoGet(MemoryBuffer& target, | |
834 const std::string& name, | |
69
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
835 const std::string& uri, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
836 const std::map<std::string, std::string>& headers) const; |
34 | 837 |
838 bool DoGet(Json::Value& target, | |
839 size_t index, | |
69
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
840 const std::string& uri, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
841 const std::map<std::string, std::string>& headers) const; |
34 | 842 |
843 bool DoGet(Json::Value& target, | |
844 const std::string& name, | |
69
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
845 const std::string& uri, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
846 const std::map<std::string, std::string>& headers) const; |
34 | 847 |
848 bool DoPost(MemoryBuffer& target, | |
849 size_t index, | |
850 const std::string& uri, | |
69
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
851 const std::string& body, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
852 const std::map<std::string, std::string>& headers) const; |
34 | 853 |
854 bool DoPost(MemoryBuffer& target, | |
855 const std::string& name, | |
856 const std::string& uri, | |
69
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
857 const std::string& body, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
858 const std::map<std::string, std::string>& headers) const; |
34 | 859 |
860 bool DoPost(Json::Value& target, | |
861 size_t index, | |
862 const std::string& uri, | |
69
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
863 const std::string& body, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
864 const std::map<std::string, std::string>& headers) const; |
34 | 865 |
866 bool DoPost(Json::Value& target, | |
867 const std::string& name, | |
868 const std::string& uri, | |
69
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
869 const std::string& body, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
870 const std::map<std::string, std::string>& headers) const; |
34 | 871 |
872 bool DoPut(size_t index, | |
873 const std::string& uri, | |
69
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
874 const std::string& body, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
875 const std::map<std::string, std::string>& headers) const; |
34 | 876 |
877 bool DoPut(const std::string& name, | |
878 const std::string& uri, | |
69
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
879 const std::string& body, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
880 const std::map<std::string, std::string>& headers) const; |
34 | 881 |
882 bool DoDelete(size_t index, | |
69
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
883 const std::string& uri, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
884 const std::map<std::string, std::string>& headers) const; |
34 | 885 |
886 bool DoDelete(const std::string& name, | |
69
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
887 const std::string& uri, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
888 const std::map<std::string, std::string>& headers) const; |
34 | 889 }; |
890 #endif | |
891 | |
892 | |
893 | |
894 #if HAS_ORTHANC_PLUGIN_JOB == 1 | |
895 class OrthancJob : public boost::noncopyable | |
896 { | |
897 private: | |
898 std::string jobType_; | |
899 std::string content_; | |
900 bool hasSerialized_; | |
901 std::string serialized_; | |
902 float progress_; | |
903 | |
904 static void CallbackFinalize(void* job); | |
905 | |
906 static float CallbackGetProgress(void* job); | |
907 | |
69
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
908 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 11, 3) |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
909 static OrthancPluginErrorCode CallbackGetContent(OrthancPluginMemoryBuffer* target, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
910 void* job); |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
911 #else |
34 | 912 static const char* CallbackGetContent(void* job); |
69
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
913 #endif |
34 | 914 |
69
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
915 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 11, 3) |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
916 static int32_t CallbackGetSerialized(OrthancPluginMemoryBuffer* target, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
917 void* job); |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
918 #else |
34 | 919 static const char* CallbackGetSerialized(void* job); |
69
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
920 #endif |
34 | 921 |
922 static OrthancPluginJobStepStatus CallbackStep(void* job); | |
923 | |
924 static OrthancPluginErrorCode CallbackStop(void* job, | |
925 OrthancPluginJobStopReason reason); | |
926 | |
927 static OrthancPluginErrorCode CallbackReset(void* job); | |
928 | |
929 protected: | |
930 void ClearContent(); | |
931 | |
932 void UpdateContent(const Json::Value& content); | |
933 | |
934 void ClearSerialized(); | |
935 | |
936 void UpdateSerialized(const Json::Value& serialized); | |
937 | |
938 void UpdateProgress(float progress); | |
939 | |
940 public: | |
42 | 941 explicit OrthancJob(const std::string& jobType); |
34 | 942 |
943 virtual ~OrthancJob() | |
944 { | |
945 } | |
946 | |
947 virtual OrthancPluginJobStepStatus Step() = 0; | |
948 | |
949 virtual void Stop(OrthancPluginJobStopReason reason) = 0; | |
950 | |
951 virtual void Reset() = 0; | |
952 | |
953 static OrthancPluginJob* Create(OrthancJob* job /* takes ownership */); | |
954 | |
955 static std::string Submit(OrthancJob* job /* takes ownership */, | |
956 int priority); | |
957 | |
958 static void SubmitAndWait(Json::Value& result, | |
959 OrthancJob* job /* takes ownership */, | |
960 int priority); | |
961 | |
962 // Submit a job from a POST on the REST API with the same | |
963 // conventions as in the Orthanc core (according to the | |
964 // "Synchronous" and "Priority" options) | |
965 static void SubmitFromRestApiPost(OrthancPluginRestOutput* output, | |
966 const Json::Value& body, | |
967 OrthancJob* job); | |
968 }; | |
969 #endif | |
970 | |
971 | |
972 #if HAS_ORTHANC_PLUGIN_METRICS == 1 | |
973 inline void SetMetricsValue(char* name, | |
974 float value) | |
975 { | |
976 OrthancPluginSetMetricsValue(GetGlobalContext(), name, | |
977 value, OrthancPluginMetricsType_Default); | |
978 } | |
979 | |
980 class MetricsTimer : public boost::noncopyable | |
981 { | |
982 private: | |
983 std::string name_; | |
984 boost::posix_time::ptime start_; | |
985 | |
986 public: | |
987 explicit MetricsTimer(const char* name); | |
988 | |
989 ~MetricsTimer(); | |
990 }; | |
991 #endif | |
992 | |
993 | |
994 #if HAS_ORTHANC_PLUGIN_HTTP_CLIENT == 1 | |
995 class HttpClient : public boost::noncopyable | |
996 { | |
997 public: | |
998 typedef std::map<std::string, std::string> HttpHeaders; | |
999 | |
1000 class IRequestBody : public boost::noncopyable | |
1001 { | |
1002 public: | |
1003 virtual ~IRequestBody() | |
1004 { | |
1005 } | |
1006 | |
1007 virtual bool ReadNextChunk(std::string& chunk) = 0; | |
1008 }; | |
1009 | |
1010 | |
1011 class IAnswer : public boost::noncopyable | |
1012 { | |
1013 public: | |
1014 virtual ~IAnswer() | |
1015 { | |
1016 } | |
1017 | |
1018 virtual void AddHeader(const std::string& key, | |
1019 const std::string& value) = 0; | |
1020 | |
1021 virtual void AddChunk(const void* data, | |
1022 size_t size) = 0; | |
1023 }; | |
1024 | |
1025 | |
1026 private: | |
1027 class RequestBodyWrapper; | |
1028 | |
1029 uint16_t httpStatus_; | |
1030 OrthancPluginHttpMethod method_; | |
1031 std::string url_; | |
1032 HttpHeaders headers_; | |
1033 std::string username_; | |
1034 std::string password_; | |
1035 uint32_t timeout_; | |
1036 std::string certificateFile_; | |
1037 std::string certificateKeyFile_; | |
1038 std::string certificateKeyPassword_; | |
1039 bool pkcs11_; | |
1040 std::string fullBody_; | |
1041 IRequestBody* chunkedBody_; | |
1042 bool allowChunkedTransfers_; | |
1043 | |
1044 #if HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_CLIENT == 1 | |
1045 void ExecuteWithStream(uint16_t& httpStatus, // out | |
1046 IAnswer& answer, // out | |
1047 IRequestBody& body) const; | |
1048 #endif | |
1049 | |
1050 void ExecuteWithoutStream(uint16_t& httpStatus, // out | |
1051 HttpHeaders& answerHeaders, // out | |
1052 std::string& answerBody, // out | |
1053 const std::string& body) const; | |
1054 | |
1055 public: | |
1056 HttpClient(); | |
1057 | |
1058 uint16_t GetHttpStatus() const | |
1059 { | |
1060 return httpStatus_; | |
1061 } | |
1062 | |
1063 void SetMethod(OrthancPluginHttpMethod method) | |
1064 { | |
1065 method_ = method; | |
1066 } | |
1067 | |
1068 const std::string& GetUrl() const | |
1069 { | |
1070 return url_; | |
1071 } | |
1072 | |
1073 void SetUrl(const std::string& url) | |
1074 { | |
1075 url_ = url; | |
1076 } | |
1077 | |
1078 void SetHeaders(const HttpHeaders& headers) | |
1079 { | |
1080 headers_ = headers; | |
1081 } | |
1082 | |
1083 void AddHeader(const std::string& key, | |
1084 const std::string& value) | |
1085 { | |
1086 headers_[key] = value; | |
1087 } | |
1088 | |
1089 void AddHeaders(const HttpHeaders& headers); | |
1090 | |
1091 void SetCredentials(const std::string& username, | |
1092 const std::string& password); | |
1093 | |
1094 void ClearCredentials(); | |
1095 | |
1096 void SetTimeout(unsigned int timeout) // 0 for default timeout | |
1097 { | |
1098 timeout_ = timeout; | |
1099 } | |
1100 | |
1101 void SetCertificate(const std::string& certificateFile, | |
1102 const std::string& keyFile, | |
1103 const std::string& keyPassword); | |
1104 | |
1105 void ClearCertificate(); | |
1106 | |
1107 void SetPkcs11(bool pkcs11) | |
1108 { | |
1109 pkcs11_ = pkcs11; | |
1110 } | |
1111 | |
1112 void ClearBody(); | |
1113 | |
1114 void SwapBody(std::string& body); | |
1115 | |
1116 void SetBody(const std::string& body); | |
1117 | |
1118 void SetBody(IRequestBody& body); | |
1119 | |
1120 // This function can be used to disable chunked transfers if the | |
1121 // remote server is Orthanc with a version <= 1.5.6. | |
1122 void SetChunkedTransfersAllowed(bool allow) | |
1123 { | |
1124 allowChunkedTransfers_ = allow; | |
1125 } | |
1126 | |
1127 bool IsChunkedTransfersAllowed() const | |
1128 { | |
1129 return allowChunkedTransfers_; | |
1130 } | |
1131 | |
1132 void Execute(IAnswer& answer); | |
1133 | |
1134 void Execute(HttpHeaders& answerHeaders /* out */, | |
1135 std::string& answerBody /* out */); | |
1136 | |
1137 void Execute(HttpHeaders& answerHeaders /* out */, | |
1138 Json::Value& answerBody /* out */); | |
1139 | |
1140 void Execute(); | |
1141 }; | |
1142 #endif | |
1143 | |
1144 | |
1145 | |
1146 class IChunkedRequestReader : public boost::noncopyable | |
1147 { | |
1148 public: | |
1149 virtual ~IChunkedRequestReader() | |
1150 { | |
1151 } | |
1152 | |
1153 virtual void AddChunk(const void* data, | |
1154 size_t size) = 0; | |
1155 | |
1156 virtual void Execute(OrthancPluginRestOutput* output) = 0; | |
1157 }; | |
1158 | |
1159 | |
1160 typedef IChunkedRequestReader* (*ChunkedRestCallback) (const char* url, | |
1161 const OrthancPluginHttpRequest* request); | |
1162 | |
1163 | |
1164 namespace Internals | |
1165 { | |
1166 void NullRestCallback(OrthancPluginRestOutput* output, | |
1167 const char* url, | |
1168 const OrthancPluginHttpRequest* request); | |
1169 | |
1170 IChunkedRequestReader *NullChunkedRestCallback(const char* url, | |
1171 const OrthancPluginHttpRequest* request); | |
1172 | |
1173 | |
1174 #if HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_SERVER == 1 | |
1175 template <ChunkedRestCallback Callback> | |
1176 static OrthancPluginErrorCode ChunkedProtect(OrthancPluginServerChunkedRequestReader** reader, | |
1177 const char* url, | |
1178 const OrthancPluginHttpRequest* request) | |
1179 { | |
1180 try | |
1181 { | |
1182 if (reader == NULL) | |
1183 { | |
1184 return OrthancPluginErrorCode_InternalError; | |
1185 } | |
1186 else | |
1187 { | |
1188 *reader = reinterpret_cast<OrthancPluginServerChunkedRequestReader*>(Callback(url, request)); | |
1189 if (*reader == NULL) | |
1190 { | |
1191 return OrthancPluginErrorCode_Plugin; | |
1192 } | |
1193 else | |
1194 { | |
1195 return OrthancPluginErrorCode_Success; | |
1196 } | |
1197 } | |
1198 } | |
1199 catch (ORTHANC_PLUGINS_EXCEPTION_CLASS& e) | |
1200 { | |
1201 return static_cast<OrthancPluginErrorCode>(e.GetErrorCode()); | |
1202 } | |
1203 catch (boost::bad_lexical_cast&) | |
1204 { | |
1205 return OrthancPluginErrorCode_BadFileFormat; | |
1206 } | |
1207 catch (...) | |
1208 { | |
1209 return OrthancPluginErrorCode_Plugin; | |
1210 } | |
1211 } | |
1212 | |
1213 OrthancPluginErrorCode ChunkedRequestReaderAddChunk( | |
1214 OrthancPluginServerChunkedRequestReader* reader, | |
1215 const void* data, | |
1216 uint32_t size); | |
1217 | |
1218 OrthancPluginErrorCode ChunkedRequestReaderExecute( | |
1219 OrthancPluginServerChunkedRequestReader* reader, | |
1220 OrthancPluginRestOutput* output); | |
1221 | |
1222 void ChunkedRequestReaderFinalize( | |
1223 OrthancPluginServerChunkedRequestReader* reader); | |
1224 | |
1225 #else | |
1226 | |
1227 OrthancPluginErrorCode ChunkedRestCompatibility(OrthancPluginRestOutput* output, | |
1228 const char* url, | |
1229 const OrthancPluginHttpRequest* request, | |
1230 RestCallback GetHandler, | |
1231 ChunkedRestCallback PostHandler, | |
1232 RestCallback DeleteHandler, | |
1233 ChunkedRestCallback PutHandler); | |
1234 | |
1235 template< | |
1236 RestCallback GetHandler, | |
1237 ChunkedRestCallback PostHandler, | |
1238 RestCallback DeleteHandler, | |
1239 ChunkedRestCallback PutHandler | |
1240 > | |
1241 inline OrthancPluginErrorCode ChunkedRestCompatibility(OrthancPluginRestOutput* output, | |
1242 const char* url, | |
1243 const OrthancPluginHttpRequest* request) | |
1244 { | |
1245 return ChunkedRestCompatibility(output, url, request, GetHandler, | |
1246 PostHandler, DeleteHandler, PutHandler); | |
1247 } | |
1248 #endif | |
1249 } | |
1250 | |
1251 | |
1252 | |
1253 // NB: We use a templated class instead of a templated function, because | |
1254 // default values are only available in functions since C++11 | |
1255 template< | |
1256 RestCallback GetHandler = Internals::NullRestCallback, | |
1257 ChunkedRestCallback PostHandler = Internals::NullChunkedRestCallback, | |
1258 RestCallback DeleteHandler = Internals::NullRestCallback, | |
1259 ChunkedRestCallback PutHandler = Internals::NullChunkedRestCallback | |
1260 > | |
1261 class ChunkedRestRegistration : public boost::noncopyable | |
1262 { | |
1263 public: | |
1264 static void Apply(const std::string& uri) | |
1265 { | |
1266 #if HAS_ORTHANC_PLUGIN_CHUNKED_HTTP_SERVER == 1 | |
1267 OrthancPluginRegisterChunkedRestCallback( | |
1268 GetGlobalContext(), uri.c_str(), | |
1269 GetHandler == Internals::NullRestCallback ? NULL : Internals::Protect<GetHandler>, | |
1270 PostHandler == Internals::NullChunkedRestCallback ? NULL : Internals::ChunkedProtect<PostHandler>, | |
1271 DeleteHandler == Internals::NullRestCallback ? NULL : Internals::Protect<DeleteHandler>, | |
1272 PutHandler == Internals::NullChunkedRestCallback ? NULL : Internals::ChunkedProtect<PutHandler>, | |
1273 Internals::ChunkedRequestReaderAddChunk, | |
1274 Internals::ChunkedRequestReaderExecute, | |
1275 Internals::ChunkedRequestReaderFinalize); | |
1276 #else | |
1277 OrthancPluginRegisterRestCallbackNoLock( | |
1278 GetGlobalContext(), uri.c_str(), | |
1279 Internals::ChunkedRestCompatibility<GetHandler, PostHandler, DeleteHandler, PutHandler>); | |
1280 #endif | |
1281 } | |
1282 }; | |
1283 | |
1284 | |
1285 | |
1286 #if HAS_ORTHANC_PLUGIN_STORAGE_COMMITMENT_SCP == 1 | |
1287 class IStorageCommitmentScpHandler : public boost::noncopyable | |
1288 { | |
1289 public: | |
1290 virtual ~IStorageCommitmentScpHandler() | |
1291 { | |
1292 } | |
1293 | |
1294 virtual OrthancPluginStorageCommitmentFailureReason Lookup(const std::string& sopClassUid, | |
1295 const std::string& sopInstanceUid) = 0; | |
1296 | |
1297 static OrthancPluginErrorCode Lookup(OrthancPluginStorageCommitmentFailureReason* target, | |
1298 void* rawHandler, | |
1299 const char* sopClassUid, | |
1300 const char* sopInstanceUid); | |
1301 | |
1302 static void Destructor(void* rawHandler); | |
1303 }; | |
1304 #endif | |
1305 | |
1306 | |
1307 class DicomInstance : public boost::noncopyable | |
1308 { | |
1309 private: | |
1310 bool toFree_; | |
1311 | |
1312 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 6, 1) | |
1313 const OrthancPluginDicomInstance* instance_; | |
1314 #else | |
1315 OrthancPluginDicomInstance* instance_; | |
1316 #endif | |
1317 | |
1318 public: | |
1319 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 6, 1) | |
41 | 1320 explicit DicomInstance(const OrthancPluginDicomInstance* instance); |
34 | 1321 #else |
41 | 1322 explicit DicomInstance(OrthancPluginDicomInstance* instance); |
34 | 1323 #endif |
1324 | |
1325 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
1326 DicomInstance(const void* buffer, | |
1327 size_t size); | |
1328 #endif | |
1329 | |
1330 ~DicomInstance(); | |
1331 | |
131
11530895e0b2
run SyncOrthancFolder.py
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
71
diff
changeset
|
1332 const OrthancPluginDicomInstance* GetObject() const |
11530895e0b2
run SyncOrthancFolder.py
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
71
diff
changeset
|
1333 { |
11530895e0b2
run SyncOrthancFolder.py
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
71
diff
changeset
|
1334 return instance_; |
11530895e0b2
run SyncOrthancFolder.py
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
71
diff
changeset
|
1335 } |
11530895e0b2
run SyncOrthancFolder.py
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
71
diff
changeset
|
1336 |
34 | 1337 std::string GetRemoteAet() const; |
1338 | |
1339 const void* GetBuffer() const | |
1340 { | |
1341 return OrthancPluginGetInstanceData(GetGlobalContext(), instance_); | |
1342 } | |
1343 | |
1344 size_t GetSize() const | |
1345 { | |
1346 return static_cast<size_t>(OrthancPluginGetInstanceSize(GetGlobalContext(), instance_)); | |
1347 } | |
1348 | |
1349 void GetJson(Json::Value& target) const; | |
1350 | |
1351 void GetSimplifiedJson(Json::Value& target) const; | |
1352 | |
1353 OrthancPluginInstanceOrigin GetOrigin() const | |
1354 { | |
1355 return OrthancPluginGetInstanceOrigin(GetGlobalContext(), instance_); | |
1356 } | |
1357 | |
1358 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 6, 1) | |
1359 std::string GetTransferSyntaxUid() const; | |
1360 #endif | |
1361 | |
1362 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 6, 1) | |
1363 bool HasPixelData() const; | |
1364 #endif | |
1365 | |
1366 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
1367 unsigned int GetFramesCount() const | |
1368 { | |
1369 return OrthancPluginGetInstanceFramesCount(GetGlobalContext(), instance_); | |
1370 } | |
1371 #endif | |
1372 | |
1373 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
1374 void GetRawFrame(std::string& target, | |
1375 unsigned int frameIndex) const; | |
1376 #endif | |
1377 | |
1378 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
1379 OrthancImage* GetDecodedFrame(unsigned int frameIndex) const; | |
1380 #endif | |
1381 | |
1382 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
1383 void Serialize(std::string& target) const; | |
1384 #endif | |
1385 | |
1386 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 7, 0) | |
1387 static DicomInstance* Transcode(const void* buffer, | |
1388 size_t size, | |
1389 const std::string& transferSyntax); | |
1390 #endif | |
131
11530895e0b2
run SyncOrthancFolder.py
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
71
diff
changeset
|
1391 |
11530895e0b2
run SyncOrthancFolder.py
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
71
diff
changeset
|
1392 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 12, 1) |
11530895e0b2
run SyncOrthancFolder.py
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
71
diff
changeset
|
1393 static DicomInstance* Load(const std::string& instanceId, |
11530895e0b2
run SyncOrthancFolder.py
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
71
diff
changeset
|
1394 OrthancPluginLoadDicomInstanceMode mode); |
11530895e0b2
run SyncOrthancFolder.py
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
71
diff
changeset
|
1395 #endif |
34 | 1396 }; |
69
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1397 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1398 // helper method to convert Http headers from the plugin SDK to a std::map |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1399 void GetHttpHeaders(std::map<std::string, std::string>& result, const OrthancPluginHttpRequest* request); |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1400 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1401 #if HAS_ORTHANC_PLUGIN_WEBDAV == 1 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1402 class IWebDavCollection : public boost::noncopyable |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1403 { |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1404 public: |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1405 class FileInfo |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1406 { |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1407 private: |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1408 std::string name_; |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1409 uint64_t contentSize_; |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1410 std::string mime_; |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1411 std::string dateTime_; |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1412 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1413 public: |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1414 FileInfo(const std::string& name, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1415 uint64_t contentSize, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1416 const std::string& dateTime) : |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1417 name_(name), |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1418 contentSize_(contentSize), |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1419 dateTime_(dateTime) |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1420 { |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1421 } |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1422 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1423 const std::string& GetName() const |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1424 { |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1425 return name_; |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1426 } |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1427 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1428 uint64_t GetContentSize() const |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1429 { |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1430 return contentSize_; |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1431 } |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1432 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1433 void SetMimeType(const std::string& mime) |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1434 { |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1435 mime_ = mime; |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1436 } |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1437 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1438 const std::string& GetMimeType() const |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1439 { |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1440 return mime_; |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1441 } |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1442 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1443 const std::string& GetDateTime() const |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1444 { |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1445 return dateTime_; |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1446 } |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1447 }; |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1448 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1449 class FolderInfo |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1450 { |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1451 private: |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1452 std::string name_; |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1453 std::string dateTime_; |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1454 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1455 public: |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1456 FolderInfo(const std::string& name, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1457 const std::string& dateTime) : |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1458 name_(name), |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1459 dateTime_(dateTime) |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1460 { |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1461 } |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1462 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1463 const std::string& GetName() const |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1464 { |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1465 return name_; |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1466 } |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1467 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1468 const std::string& GetDateTime() const |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1469 { |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1470 return dateTime_; |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1471 } |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1472 }; |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1473 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1474 virtual ~IWebDavCollection() |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1475 { |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1476 } |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1477 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1478 virtual bool IsExistingFolder(const std::vector<std::string>& path) = 0; |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1479 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1480 virtual bool ListFolder(std::list<FileInfo>& files, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1481 std::list<FolderInfo>& subfolders, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1482 const std::vector<std::string>& path) = 0; |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1483 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1484 virtual bool GetFile(std::string& content /* out */, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1485 std::string& mime /* out */, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1486 std::string& dateTime /* out */, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1487 const std::vector<std::string>& path) = 0; |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1488 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1489 virtual bool StoreFile(const std::vector<std::string>& path, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1490 const void* data, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1491 size_t size) = 0; |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1492 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1493 virtual bool CreateFolder(const std::vector<std::string>& path) = 0; |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1494 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1495 virtual bool DeleteItem(const std::vector<std::string>& path) = 0; |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1496 |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1497 static void Register(const std::string& uri, |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1498 IWebDavCollection& collection); |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1499 }; |
af44dce56328
new 'auth/user-profile' Rest API route
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
1500 #endif |
155 | 1501 |
1502 void SetRootUri(const std::string& pluginIdentifier, | |
1503 const std::string& uri); | |
1504 | |
1505 void SetDescription(const std::string& pluginIdentifier, | |
1506 const std::string& description); | |
1507 | |
1508 void ExtendOrthancExplorer(const std::string& pluginIdentifier, | |
1509 const std::string& javascript); | |
34 | 1510 } |