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