Mercurial > hg > orthanc-authorization
annotate Plugin/ResourceHierarchyCache.cpp @ 158:1bc074f956f1 0.7.1
0.7.1
author | Alain Mazy <am@osimis.io> |
---|---|
date | Mon, 25 Mar 2024 13:03:20 +0100 |
parents | 9be1ee2b8fe1 |
children | c4b908970ae4 |
rev | line source |
---|---|
1 | 1 /** |
2 * Advanced authorization plugin for Orthanc | |
68 | 3 * Copyright (C) 2017-2023 Osimis S.A., Belgium |
150 | 4 * Copyright (C) 2024-2024 Orthanc Team SRL, Belgium |
1 | 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 #include "ResourceHierarchyCache.h" | |
21 | |
32 | 22 #include <Logging.h> |
23 #include <OrthancException.h> | |
1 | 24 |
25 #include <boost/lexical_cast.hpp> | |
109 | 26 #include <Toolbox.h> |
1 | 27 |
28 namespace OrthancPlugins | |
29 { | |
30 std::string ResourceHierarchyCache::ComputeKey(Orthanc::ResourceType level, | |
43 | 31 const std::string& identifier) const |
1 | 32 { |
33 return boost::lexical_cast<std::string>(level) + "|" + identifier; | |
34 } | |
35 | |
36 | |
37 void ResourceHierarchyCache::LinkParent(const OrthancResource& child, | |
38 const OrthancResource& parent) | |
39 { | |
40 LOG(INFO) << "Linking " << Orthanc::EnumerationToString(child.GetLevel()) | |
41 << " \"" << child.GetIdentifier() << "\" to its parent " | |
42 << Orthanc::EnumerationToString(parent.GetLevel()) | |
43 << " \"" << parent.GetIdentifier() << "\""; | |
44 | |
45 cache_->Store(ComputeKey(child), parent.GetIdentifier(), 0 /* no expiration */); | |
46 } | |
47 | |
109 | 48 void ResourceHierarchyCache::GetLabels(std::set<std::string>& labels, |
49 const OrthancResource& resource) | |
50 { | |
51 labels.clear(); | |
52 | |
53 std::string key = ComputeKey(resource); | |
54 | |
55 std::string serializedLabels; | |
56 if (!labels_->Retrieve(serializedLabels, key)) | |
57 { | |
58 // The labels were not already stored in the cache or they have expired | |
59 OrthancResource parent; | |
60 UpdateResourceFromOrthanc(parent, labels, resource); | |
61 } | |
62 else | |
63 { | |
64 Orthanc::Toolbox::SplitString(labels, serializedLabels, ','); | |
65 } | |
66 } | |
67 | |
68 | |
69 void ResourceHierarchyCache::UpdateResourceFromOrthanc(OrthancResource& parent, | |
70 std::set<std::string>& labels, | |
71 const OrthancResource& resource) | |
72 { | |
73 std::string key = ComputeKey(resource); | |
74 | |
75 // Not in the cache, reading the resource from the Orthanc store | |
76 std::string dicomUid; | |
77 std::list<OrthancResource> children; | |
78 | |
79 if (!resource.GetHierarchy(dicomUid, parent, children, labels)) | |
80 { | |
81 // The resource is non-existing (*) | |
82 return; | |
83 } | |
84 | |
85 orthancToDicom_->Store(key, dicomUid, 0 /* no expiration */); | |
86 dicomToOrthanc_->Store(ComputeKey(resource.GetLevel(), dicomUid), | |
87 resource.GetIdentifier(), 0 /* no expiration */); | |
88 std::string serializedLabels; | |
89 Orthanc::Toolbox::JoinStrings(serializedLabels, labels, ","); | |
90 labels_->Store(key, serializedLabels, 60); | |
91 | |
92 for (std::list<OrthancResource>::const_iterator | |
93 it = children.begin(); it != children.end(); ++it) | |
94 { | |
95 // Cache the relation of the resource with its children | |
96 LinkParent(*it, resource); | |
97 } | |
98 | |
99 if (parent.IsValid()) | |
100 { | |
101 LinkParent(resource, parent); | |
102 } | |
103 } | |
104 | |
1 | 105 |
106 bool ResourceHierarchyCache::LookupParent(std::string& target, | |
107 const OrthancResource& resource) | |
108 { | |
109 std::string key = ComputeKey(resource); | |
110 | |
111 if (cache_->Retrieve(target, key)) | |
112 { | |
113 // The parent was already stored in the cache | |
114 return true; | |
115 } | |
116 | |
117 OrthancResource parent; | |
109 | 118 std::set<std::string> labels; |
119 UpdateResourceFromOrthanc(parent, labels, resource); | |
1 | 120 |
121 if (parent.IsValid()) | |
122 { | |
123 target = parent.GetIdentifier(); | |
124 return true; | |
125 } | |
126 else | |
127 { | |
128 // We reached the patient level, or the resource was removed | |
129 // from Orthanc since (*) | |
130 return false; | |
131 } | |
132 } | |
133 | |
134 | |
29
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
135 ResourceHierarchyCache::ResourceHierarchyCache(ICacheFactory& factory) : |
1 | 136 cache_(factory.Create()), |
137 orthancToDicom_(factory.Create()), | |
109 | 138 dicomToOrthanc_(factory.Create()), |
139 labels_(factory.Create()) | |
1 | 140 { |
141 if (cache_.get() == NULL) | |
142 { | |
143 throw Orthanc::OrthancException(Orthanc::ErrorCode_InternalError); | |
144 } | |
145 } | |
146 | |
147 | |
148 void ResourceHierarchyCache::Invalidate(Orthanc::ResourceType level, | |
149 const std::string& identifier) | |
150 { | |
151 LOG(INFO) << "Invalidating " << Orthanc::EnumerationToString(level) | |
152 << " resource with ID: " << identifier; | |
153 | |
154 std::string key = ComputeKey(level, identifier); | |
155 cache_->Invalidate(key); | |
156 orthancToDicom_->Invalidate(key); | |
109 | 157 labels_->Invalidate(key); |
1 | 158 } |
159 | |
160 | |
161 bool ResourceHierarchyCache::LookupSeries(std::string& patient, | |
162 std::string& study, | |
163 const std::string& series) | |
164 { | |
165 if (LookupParent(study, Orthanc::ResourceType_Series, series)) | |
166 { | |
167 return LookupStudy(patient, study); | |
168 } | |
169 else | |
170 { | |
171 return false; | |
172 } | |
173 } | |
174 | |
175 | |
176 bool ResourceHierarchyCache::LookupInstance(std::string& patient, | |
177 std::string& study, | |
178 std::string& series, | |
179 const std::string& instance) | |
180 { | |
181 if (LookupParent(series, Orthanc::ResourceType_Instance, instance)) | |
182 { | |
183 return LookupSeries(patient, study, series); | |
184 } | |
185 else | |
186 { | |
187 return false; | |
188 } | |
189 } | |
190 | |
191 | |
192 bool ResourceHierarchyCache::LookupDicomUid(std::string& target, | |
193 Orthanc::ResourceType level, | |
194 const std::string& orthancId) | |
195 { | |
196 std::string key = ComputeKey(level, orthancId); | |
197 | |
198 if (orthancToDicom_->Retrieve(target, key)) | |
199 { | |
200 return true; | |
201 } | |
202 | |
203 OrthancResource resource(level, orthancId); | |
204 | |
29
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
205 if (resource.GetDicomUid(target)) |
1 | 206 { |
207 orthancToDicom_->Store(key, target, 0 /* no expiration */); | |
208 return true; | |
209 } | |
210 else | |
211 { | |
212 return false; | |
213 } | |
214 } | |
215 | |
216 | |
217 bool ResourceHierarchyCache::LookupOrthancId(std::string& target, | |
218 Orthanc::ResourceType level, | |
219 const std::string& dicomUid) | |
220 { | |
221 std::string key = ComputeKey(level, dicomUid); | |
222 | |
223 if (dicomToOrthanc_->Retrieve(target, key)) | |
224 { | |
225 return true; | |
226 } | |
227 | |
29
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
228 if (OrthancResource::LookupOrthancId(target, level, dicomUid)) |
1 | 229 { |
230 dicomToOrthanc_->Store(key, target, 0 /* no expiration */); | |
231 return true; | |
232 } | |
233 else | |
234 { | |
235 return false; | |
236 } | |
237 } | |
77
94a9484d7f8f
fix security issues allowing to browse remote dicom servers + introduced UnitTests
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
238 |
78 | 239 #if BUILD_UNIT_TESTS == 1 |
77
94a9484d7f8f
fix security issues allowing to browse remote dicom servers + introduced UnitTests
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
240 void ResourceHierarchyCache::AddOrthancDicomMapping(Orthanc::ResourceType level, |
94a9484d7f8f
fix security issues allowing to browse remote dicom servers + introduced UnitTests
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
241 const std::string& orthancId, |
94a9484d7f8f
fix security issues allowing to browse remote dicom servers + introduced UnitTests
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
242 const std::string& dicomUid) |
94a9484d7f8f
fix security issues allowing to browse remote dicom servers + introduced UnitTests
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
243 { |
94a9484d7f8f
fix security issues allowing to browse remote dicom servers + introduced UnitTests
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
244 dicomToOrthanc_->Store(ComputeKey(level, dicomUid), orthancId, 0 /* no expiration */); |
94a9484d7f8f
fix security issues allowing to browse remote dicom servers + introduced UnitTests
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
245 orthancToDicom_->Store(ComputeKey(level, orthancId), dicomUid, 0 /* no expiration */); |
94a9484d7f8f
fix security issues allowing to browse remote dicom servers + introduced UnitTests
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
246 } |
94a9484d7f8f
fix security issues allowing to browse remote dicom servers + introduced UnitTests
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
247 |
94a9484d7f8f
fix security issues allowing to browse remote dicom servers + introduced UnitTests
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
248 void ResourceHierarchyCache::AddParentLink(Orthanc::ResourceType childLevel, |
94a9484d7f8f
fix security issues allowing to browse remote dicom servers + introduced UnitTests
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
249 const std::string& childOrthancId, |
94a9484d7f8f
fix security issues allowing to browse remote dicom servers + introduced UnitTests
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
250 const std::string& parentOrthancId) |
94a9484d7f8f
fix security issues allowing to browse remote dicom servers + introduced UnitTests
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
251 { |
94a9484d7f8f
fix security issues allowing to browse remote dicom servers + introduced UnitTests
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
252 cache_->Store(ComputeKey(childLevel, childOrthancId), parentOrthancId, 0 /* no expiration */); |
94a9484d7f8f
fix security issues allowing to browse remote dicom servers + introduced UnitTests
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
253 } |
110 | 254 |
255 void ResourceHierarchyCache::AddLabels(Orthanc::ResourceType level, | |
256 const std::string& orthancId, | |
257 const std::string& serializedLabels) | |
258 { | |
259 labels_->Store(ComputeKey(level, orthancId), serializedLabels, 0 /* no expiration */); | |
260 } | |
261 | |
78 | 262 #endif |
77
94a9484d7f8f
fix security issues allowing to browse remote dicom servers + introduced UnitTests
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
263 |
1 | 264 } |