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