Mercurial > hg > orthanc-webviewer
annotate Plugin/Plugin.cpp @ 59:733d1a162baf
sync
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Sat, 01 Aug 2015 21:24:29 +0200 |
parents | b3259b9c6dfb |
children | ab5218c18b7a |
rev | line source |
---|---|
0 | 1 /** |
2 * Orthanc - A Lightweight, RESTful DICOM Store | |
3 * Copyright (C) 2012-2015 Sebastien Jodogne, Medical Physics | |
4 * Department, University Hospital of Liege, Belgium | |
5 * | |
6 * This program is free software: you can redistribute it and/or | |
7 * modify it under the terms of the GNU Affero General Public License | |
8 * as published by the Free Software Foundation, either version 3 of | |
9 * the License, or (at your option) any later version. | |
10 * | |
11 * This program is distributed in the hope that it will be useful, but | |
12 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
14 * Affero General Public License for more details. | |
15 * | |
16 * You should have received a copy of the GNU Affero General Public License | |
17 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
18 **/ | |
19 | |
20 | |
21 #include <boost/thread.hpp> | |
22 #include <boost/lexical_cast.hpp> | |
23 #include <EmbeddedResources.h> | |
4
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
24 #include <boost/filesystem.hpp> |
0 | 25 |
26 | 26 #include "../Orthanc/Core/OrthancException.h" |
0 | 27 #include "ViewerToolbox.h" |
28 #include "ViewerPrefetchPolicy.h" | |
29 #include "DecodedImageAdapter.h" | |
30 #include "InstanceInformationAdapter.h" | |
31 #include "SeriesInformationAdapter.h" | |
32 | |
33 | |
34 | |
35 class CacheContext | |
36 { | |
37 private: | |
58 | 38 Orthanc::FilesystemStorage storage_; |
39 Orthanc::SQLite::Connection db_; | |
40 | |
0 | 41 std::auto_ptr<OrthancPlugins::CacheManager> cache_; |
42 std::auto_ptr<OrthancPlugins::CacheScheduler> scheduler_; | |
43 | |
44 public: | |
58 | 45 CacheContext(const std::string& path) : storage_(path) |
0 | 46 { |
47 boost::filesystem::path p(path); | |
58 | 48 db_.Open((p / "cache.db").string()); |
0 | 49 |
58 | 50 cache_.reset(new OrthancPlugins::CacheManager(db_, storage_)); |
0 | 51 //cache_->SetSanityCheckEnabled(true); // For debug |
52 | |
53 scheduler_.reset(new OrthancPlugins::CacheScheduler(*cache_, 100)); | |
54 } | |
55 | |
58 | 56 ~CacheContext() |
57 { | |
58 scheduler_.reset(NULL); | |
59 cache_.reset(NULL); | |
60 } | |
61 | |
0 | 62 OrthancPlugins::CacheScheduler& GetScheduler() |
63 { | |
64 return *scheduler_; | |
65 } | |
66 }; | |
67 | |
68 | |
69 static OrthancPluginContext* context_ = NULL; | |
70 static CacheContext* cache_ = NULL; | |
71 | |
72 | |
73 | |
74 static int32_t OnChangeCallback(OrthancPluginChangeType changeType, | |
75 OrthancPluginResourceType resourceType, | |
76 const char* resourceId) | |
77 { | |
78 try | |
79 { | |
80 if (changeType == OrthancPluginChangeType_NewInstance && | |
81 resourceType == OrthancPluginResourceType_Instance) | |
82 { | |
83 // On the reception of a new instance, precompute its spatial position | |
84 cache_->GetScheduler().Prefetch(OrthancPlugins::CacheBundle_InstanceInformation, resourceId); | |
85 | |
86 // Indalidate the parent series of the instance | |
87 std::string uri = "/instances/" + std::string(resourceId); | |
88 Json::Value instance; | |
89 if (OrthancPlugins::GetJsonFromOrthanc(instance, context_, uri)) | |
90 { | |
91 std::string seriesId = instance["ParentSeries"].asString(); | |
92 cache_->GetScheduler().Invalidate(OrthancPlugins::CacheBundle_SeriesInformation, seriesId); | |
93 } | |
94 } | |
95 | |
96 return 0; | |
97 } | |
98 catch (std::runtime_error& e) | |
99 { | |
100 OrthancPluginLogError(context_, e.what()); | |
101 return 0; // Ignore error | |
102 } | |
103 } | |
104 | |
105 | |
106 | |
107 template <enum OrthancPlugins::CacheBundle bundle> | |
108 int32_t ServeCache(OrthancPluginRestOutput* output, | |
109 const char* url, | |
110 const OrthancPluginHttpRequest* request) | |
111 { | |
112 try | |
113 { | |
114 if (request->method != OrthancPluginHttpMethod_Get) | |
115 { | |
116 OrthancPluginSendMethodNotAllowed(context_, output, "GET"); | |
117 return 0; | |
118 } | |
119 | |
120 const std::string id = request->groups[0]; | |
121 std::string content; | |
122 | |
123 if (cache_->GetScheduler().Access(content, bundle, id)) | |
124 { | |
125 OrthancPluginAnswerBuffer(context_, output, content.c_str(), content.size(), "application/json"); | |
126 } | |
127 else | |
128 { | |
129 OrthancPluginSendHttpStatusCode(context_, output, 404); | |
130 } | |
131 | |
132 return 0; | |
133 } | |
134 catch (Orthanc::OrthancException& e) | |
135 { | |
136 OrthancPluginLogError(context_, e.What()); | |
137 return -1; | |
138 } | |
139 catch (std::runtime_error& e) | |
140 { | |
141 OrthancPluginLogError(context_, e.what()); | |
142 return -1; | |
143 } | |
144 catch (boost::bad_lexical_cast&) | |
145 { | |
146 OrthancPluginLogError(context_, "Bad lexical cast"); | |
147 return -1; | |
148 } | |
149 } | |
150 | |
151 | |
152 | |
153 | |
154 #if ORTHANC_STANDALONE == 0 | |
155 static int32_t ServeWebViewer(OrthancPluginRestOutput* output, | |
156 const char* url, | |
157 const OrthancPluginHttpRequest* request) | |
158 { | |
159 if (request->method != OrthancPluginHttpMethod_Get) | |
160 { | |
161 OrthancPluginSendMethodNotAllowed(context_, output, "GET"); | |
162 return 0; | |
163 } | |
164 | |
165 const std::string path = std::string(WEB_VIEWER_PATH) + std::string(request->groups[0]); | |
166 const char* mime = OrthancPlugins::GetMimeType(path); | |
167 | |
168 std::string s; | |
169 if (OrthancPlugins::ReadFile(s, path)) | |
170 { | |
171 const char* resource = s.size() ? s.c_str() : NULL; | |
172 OrthancPluginAnswerBuffer(context_, output, resource, s.size(), mime); | |
173 } | |
174 else | |
175 { | |
176 std::string s = "Inexistent file in served folder: " + path; | |
177 OrthancPluginLogError(context_, s.c_str()); | |
178 OrthancPluginSendHttpStatusCode(context_, output, 404); | |
179 } | |
180 | |
181 return 0; | |
182 } | |
183 #endif | |
184 | |
185 | |
186 | |
31 | 187 template <enum Orthanc::EmbeddedResources::DirectoryResourceId folder> |
0 | 188 static int32_t ServeEmbeddedFolder(OrthancPluginRestOutput* output, |
189 const char* url, | |
190 const OrthancPluginHttpRequest* request) | |
191 { | |
192 if (request->method != OrthancPluginHttpMethod_Get) | |
193 { | |
194 OrthancPluginSendMethodNotAllowed(context_, output, "GET"); | |
195 return 0; | |
196 } | |
197 | |
198 std::string path = "/" + std::string(request->groups[0]); | |
199 const char* mime = OrthancPlugins::GetMimeType(path); | |
200 | |
201 try | |
202 { | |
203 std::string s; | |
31 | 204 Orthanc::EmbeddedResources::GetDirectoryResource(s, folder, path.c_str()); |
0 | 205 |
206 const char* resource = s.size() ? s.c_str() : NULL; | |
207 OrthancPluginAnswerBuffer(context_, output, resource, s.size(), mime); | |
208 | |
209 return 0; | |
210 } | |
211 catch (std::runtime_error&) | |
212 { | |
213 std::string s = "Unknown static resource in plugin: " + std::string(request->groups[0]); | |
214 OrthancPluginLogError(context_, s.c_str()); | |
215 OrthancPluginSendHttpStatusCode(context_, output, 404); | |
216 return 0; | |
217 } | |
218 } | |
219 | |
220 | |
221 | |
19 | 222 static int32_t IsStableSeries(OrthancPluginRestOutput* output, |
223 const char* url, | |
224 const OrthancPluginHttpRequest* request) | |
225 { | |
226 try | |
227 { | |
228 if (request->method != OrthancPluginHttpMethod_Get) | |
229 { | |
230 OrthancPluginSendMethodNotAllowed(context_, output, "GET"); | |
231 return 0; | |
232 } | |
233 | |
234 const std::string id = request->groups[0]; | |
235 Json::Value series; | |
236 | |
237 if (OrthancPlugins::GetJsonFromOrthanc(series, context_, "/series/" + id) && | |
238 series.type() == Json::objectValue) | |
239 { | |
240 bool value = (series["IsStable"].asBool() || | |
241 series["Status"].asString() == "Complete"); | |
242 std::string answer = value ? "true" : "false"; | |
243 OrthancPluginAnswerBuffer(context_, output, answer.c_str(), answer.size(), "application/json"); | |
244 } | |
245 else | |
246 { | |
247 OrthancPluginSendHttpStatusCode(context_, output, 404); | |
248 } | |
249 | |
250 return 0; | |
251 } | |
252 catch (Orthanc::OrthancException& e) | |
253 { | |
254 OrthancPluginLogError(context_, e.What()); | |
255 return -1; | |
256 } | |
257 catch (std::runtime_error& e) | |
258 { | |
259 OrthancPluginLogError(context_, e.what()); | |
260 return -1; | |
261 } | |
262 catch (boost::bad_lexical_cast&) | |
263 { | |
264 OrthancPluginLogError(context_, "Bad lexical cast"); | |
265 return -1; | |
266 } | |
267 } | |
268 | |
0 | 269 |
270 extern "C" | |
271 { | |
272 ORTHANC_PLUGINS_API int32_t OrthancPluginInitialize(OrthancPluginContext* context) | |
273 { | |
274 using namespace OrthancPlugins; | |
275 | |
276 context_ = context; | |
277 OrthancPluginLogWarning(context_, "Initializing the Web viewer"); | |
278 | |
279 | |
280 /* Check the version of the Orthanc core */ | |
281 if (OrthancPluginCheckVersion(context_) == 0) | |
282 { | |
283 char info[1024]; | |
284 sprintf(info, "Your version of Orthanc (%s) must be above %d.%d.%d to run this plugin", | |
285 context_->orthancVersion, | |
286 ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER, | |
287 ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER, | |
288 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER); | |
289 OrthancPluginLogError(context_, info); | |
290 return -1; | |
291 } | |
292 | |
293 OrthancPluginSetDescription(context_, "Provides a Web viewer of DICOM series within Orthanc."); | |
294 | |
295 | |
296 /* By default, use half of the available processing cores for the decoding of DICOM images */ | |
297 int decodingThreads = boost::thread::hardware_concurrency() / 2; | |
298 if (decodingThreads == 0) | |
299 { | |
300 decodingThreads = 1; | |
301 } | |
302 | |
303 | |
304 try | |
305 { | |
306 /* Read the configuration of the Web viewer */ | |
307 Json::Value configuration; | |
308 if (!ReadConfiguration(configuration, context)) | |
309 { | |
310 OrthancPluginLogError(context_, "Unable to read the configuration file of Orthanc"); | |
311 return -1; | |
312 } | |
313 | |
4
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
314 // By default, the cache of the Web viewer is located inside the |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
315 // "StorageDirectory" of Orthanc |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
316 boost::filesystem::path cachePath = GetStringValue(configuration, "StorageDirectory", "."); |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
317 cachePath /= "WebViewerCache"; |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
318 int cacheSize = 100; // By default, a cache of 100 MB is used |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
319 |
0 | 320 if (configuration.isMember("WebViewer")) |
321 { | |
4
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
322 std::string key = "CachePath"; |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
323 if (!configuration["WebViewer"].isMember(key)) |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
324 { |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
325 // For backward compatibility with the initial release of the Web viewer |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
326 key = "Cache"; |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
327 } |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
328 |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
329 cachePath = GetStringValue(configuration["WebViewer"], key, cachePath.string()); |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
330 cacheSize = GetIntegerValue(configuration["WebViewer"], "CacheSize", cacheSize); |
0 | 331 decodingThreads = GetIntegerValue(configuration["WebViewer"], "Threads", decodingThreads); |
332 } | |
333 | |
334 std::string message = ("Web viewer using " + boost::lexical_cast<std::string>(decodingThreads) + | |
335 " threads for the decoding of the DICOM images"); | |
336 OrthancPluginLogWarning(context_, message.c_str()); | |
337 | |
4
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
338 if (decodingThreads <= 0 || |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
339 cacheSize <= 0) |
0 | 340 { |
341 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
342 } | |
343 | |
4
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
344 message = "Storing the cache of the Web viewer in folder: " + cachePath.string(); |
0 | 345 OrthancPluginLogWarning(context_, message.c_str()); |
346 | |
347 | |
348 /* Create the cache */ | |
4
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
349 cache_ = new CacheContext(cachePath.string()); |
0 | 350 cache_->GetScheduler().RegisterPolicy(new ViewerPrefetchPolicy(context_)); |
351 cache_->GetScheduler().Register(CacheBundle_SeriesInformation, | |
352 new SeriesInformationAdapter(context_, cache_->GetScheduler()), 1); | |
353 cache_->GetScheduler().Register(CacheBundle_InstanceInformation, | |
354 new InstanceInformationAdapter(context_), 1); | |
355 cache_->GetScheduler().Register(CacheBundle_DecodedImage, | |
356 new DecodedImageAdapter(context_), decodingThreads); | |
4
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
357 |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
358 |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
359 /* Set the quotas */ |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
360 cache_->GetScheduler().SetQuota(CacheBundle_SeriesInformation, 1000, 0); // Keep info about 1000 series |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
361 cache_->GetScheduler().SetQuota(CacheBundle_InstanceInformation, 10000, 0); // Keep info about 10,000 instances |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
362 |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
363 message = "Web viewer using a cache of " + boost::lexical_cast<std::string>(cacheSize) + " MB"; |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
364 OrthancPluginLogWarning(context_, message.c_str()); |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
365 |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
366 cache_->GetScheduler().SetQuota(CacheBundle_DecodedImage, 0, static_cast<uint64_t>(cacheSize) * 1024 * 1024); |
0 | 367 } |
368 catch (std::runtime_error& e) | |
369 { | |
370 OrthancPluginLogError(context_, e.what()); | |
371 return -1; | |
372 } | |
373 catch (Orthanc::OrthancException& e) | |
374 { | |
375 OrthancPluginLogError(context_, e.What()); | |
376 return -1; | |
377 } | |
378 | |
379 | |
380 /* Install the callbacks */ | |
381 OrthancPluginRegisterRestCallback(context_, "/web-viewer/series/(.*)", ServeCache<CacheBundle_SeriesInformation>); | |
19 | 382 OrthancPluginRegisterRestCallback(context_, "/web-viewer/is-stable-series/(.*)", IsStableSeries); |
0 | 383 OrthancPluginRegisterRestCallback(context_, "/web-viewer/instances/(.*)", ServeCache<CacheBundle_DecodedImage>); |
31 | 384 OrthancPluginRegisterRestCallback(context, "/web-viewer/libs/(.*)", ServeEmbeddedFolder<Orthanc::EmbeddedResources::JAVASCRIPT_LIBS>); |
0 | 385 |
386 #if ORTHANC_STANDALONE == 1 | |
31 | 387 OrthancPluginRegisterRestCallback(context, "/web-viewer/app/(.*)", ServeEmbeddedFolder<Orthanc::EmbeddedResources::WEB_VIEWER>); |
0 | 388 #else |
389 OrthancPluginRegisterRestCallback(context, "/web-viewer/app/(.*)", ServeWebViewer); | |
390 #endif | |
391 | |
392 OrthancPluginRegisterOnChangeCallback(context, OnChangeCallback); | |
393 | |
394 | |
395 /* Extend the default Orthanc Explorer with custom JavaScript */ | |
396 std::string explorer; | |
31 | 397 Orthanc::EmbeddedResources::GetFileResource(explorer, Orthanc::EmbeddedResources::ORTHANC_EXPLORER); |
0 | 398 OrthancPluginExtendOrthancExplorer(context_, explorer.c_str()); |
399 | |
400 return 0; | |
401 } | |
402 | |
403 | |
404 ORTHANC_PLUGINS_API void OrthancPluginFinalize() | |
405 { | |
406 OrthancPluginLogWarning(context_, "Finalizing the Web viewer"); | |
407 | |
408 if (cache_ != NULL) | |
409 { | |
410 delete cache_; | |
411 cache_ = NULL; | |
412 } | |
413 } | |
414 | |
415 | |
416 ORTHANC_PLUGINS_API const char* OrthancPluginGetName() | |
417 { | |
418 return "web-viewer"; | |
419 } | |
420 | |
421 | |
422 ORTHANC_PLUGINS_API const char* OrthancPluginGetVersion() | |
423 { | |
12 | 424 return ORTHANC_WEBVIEWER_VERSION; |
0 | 425 } |
426 } |