Mercurial > hg > orthanc-authorization
annotate Plugin/ResourceHierarchyCache.cpp @ 109:7381a7674b36
wip: adding labels
| author | Alain Mazy <am@osimis.io> |
|---|---|
| date | Fri, 18 Aug 2023 12:08:49 +0200 |
| parents | a2e5ea1869bd |
| children | aa56dcf599b9 |
| rev | line source |
|---|---|
| 1 | 1 /** |
| 2 * Advanced authorization plugin for Orthanc | |
| 68 | 3 * Copyright (C) 2017-2023 Osimis S.A., Belgium |
| 1 | 4 * |
| 5 * This program is free software: you can redistribute it and/or | |
| 6 * modify it under the terms of the GNU Affero General Public License | |
| 7 * as published by the Free Software Foundation, either version 3 of | |
| 8 * the License, or (at your option) any later version. | |
| 9 * | |
| 10 * This program is distributed in the hope that it will be useful, but | |
| 11 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 * Affero General Public License for more details. | |
| 14 * | |
| 15 * You should have received a copy of the GNU Affero General Public License | |
| 16 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 17 **/ | |
| 18 | |
| 19 #include "ResourceHierarchyCache.h" | |
| 20 | |
| 32 | 21 #include <Logging.h> |
| 22 #include <OrthancException.h> | |
| 1 | 23 |
| 24 #include <boost/lexical_cast.hpp> | |
| 109 | 25 #include <Toolbox.h> |
| 1 | 26 |
| 27 namespace OrthancPlugins | |
| 28 { | |
| 29 std::string ResourceHierarchyCache::ComputeKey(Orthanc::ResourceType level, | |
| 43 | 30 const std::string& identifier) const |
| 1 | 31 { |
| 32 return boost::lexical_cast<std::string>(level) + "|" + identifier; | |
| 33 } | |
| 34 | |
| 35 | |
| 36 void ResourceHierarchyCache::LinkParent(const OrthancResource& child, | |
| 37 const OrthancResource& parent) | |
| 38 { | |
| 39 LOG(INFO) << "Linking " << Orthanc::EnumerationToString(child.GetLevel()) | |
| 40 << " \"" << child.GetIdentifier() << "\" to its parent " | |
| 41 << Orthanc::EnumerationToString(parent.GetLevel()) | |
| 42 << " \"" << parent.GetIdentifier() << "\""; | |
| 43 | |
| 44 cache_->Store(ComputeKey(child), parent.GetIdentifier(), 0 /* no expiration */); | |
| 45 } | |
| 46 | |
| 109 | 47 void ResourceHierarchyCache::GetLabels(std::set<std::string>& labels, |
| 48 const OrthancResource& resource) | |
| 49 { | |
| 50 labels.clear(); | |
| 51 | |
| 52 std::string key = ComputeKey(resource); | |
| 53 | |
| 54 std::string serializedLabels; | |
| 55 if (!labels_->Retrieve(serializedLabels, key)) | |
| 56 { | |
| 57 // The labels were not already stored in the cache or they have expired | |
| 58 OrthancResource parent; | |
| 59 UpdateResourceFromOrthanc(parent, labels, resource); | |
| 60 } | |
| 61 else | |
| 62 { | |
| 63 Orthanc::Toolbox::SplitString(labels, serializedLabels, ','); | |
| 64 } | |
| 65 } | |
| 66 | |
| 67 | |
| 68 void ResourceHierarchyCache::UpdateResourceFromOrthanc(OrthancResource& parent, | |
| 69 std::set<std::string>& labels, | |
| 70 const OrthancResource& resource) | |
| 71 { | |
| 72 std::string key = ComputeKey(resource); | |
| 73 | |
| 74 // Not in the cache, reading the resource from the Orthanc store | |
| 75 std::string dicomUid; | |
| 76 std::list<OrthancResource> children; | |
| 77 | |
| 78 if (!resource.GetHierarchy(dicomUid, parent, children, labels)) | |
| 79 { | |
| 80 // The resource is non-existing (*) | |
| 81 return; | |
| 82 } | |
| 83 | |
| 84 orthancToDicom_->Store(key, dicomUid, 0 /* no expiration */); | |
| 85 dicomToOrthanc_->Store(ComputeKey(resource.GetLevel(), dicomUid), | |
| 86 resource.GetIdentifier(), 0 /* no expiration */); | |
| 87 std::string serializedLabels; | |
| 88 Orthanc::Toolbox::JoinStrings(serializedLabels, labels, ","); | |
| 89 labels_->Store(key, serializedLabels, 60); | |
| 90 | |
| 91 for (std::list<OrthancResource>::const_iterator | |
| 92 it = children.begin(); it != children.end(); ++it) | |
| 93 { | |
| 94 // Cache the relation of the resource with its children | |
| 95 LinkParent(*it, resource); | |
| 96 } | |
| 97 | |
| 98 if (parent.IsValid()) | |
| 99 { | |
| 100 LinkParent(resource, parent); | |
| 101 } | |
| 102 } | |
| 103 | |
| 1 | 104 |
| 105 bool ResourceHierarchyCache::LookupParent(std::string& target, | |
| 106 const OrthancResource& resource) | |
| 107 { | |
| 108 std::string key = ComputeKey(resource); | |
| 109 | |
| 110 if (cache_->Retrieve(target, key)) | |
| 111 { | |
| 112 // The parent was already stored in the cache | |
| 113 return true; | |
| 114 } | |
| 115 | |
| 116 OrthancResource parent; | |
| 109 | 117 std::set<std::string> labels; |
| 118 UpdateResourceFromOrthanc(parent, labels, resource); | |
| 1 | 119 |
| 120 if (parent.IsValid()) | |
| 121 { | |
| 122 target = parent.GetIdentifier(); | |
| 123 return true; | |
| 124 } | |
| 125 else | |
| 126 { | |
| 127 // We reached the patient level, or the resource was removed | |
| 128 // from Orthanc since (*) | |
| 129 return false; | |
| 130 } | |
| 131 } | |
| 132 | |
| 133 | |
|
29
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
134 ResourceHierarchyCache::ResourceHierarchyCache(ICacheFactory& factory) : |
| 1 | 135 cache_(factory.Create()), |
| 136 orthancToDicom_(factory.Create()), | |
| 109 | 137 dicomToOrthanc_(factory.Create()), |
| 138 labels_(factory.Create()) | |
| 1 | 139 { |
| 140 if (cache_.get() == NULL) | |
| 141 { | |
| 142 throw Orthanc::OrthancException(Orthanc::ErrorCode_InternalError); | |
| 143 } | |
| 144 } | |
| 145 | |
| 146 | |
| 147 void ResourceHierarchyCache::Invalidate(Orthanc::ResourceType level, | |
| 148 const std::string& identifier) | |
| 149 { | |
| 150 LOG(INFO) << "Invalidating " << Orthanc::EnumerationToString(level) | |
| 151 << " resource with ID: " << identifier; | |
| 152 | |
| 153 std::string key = ComputeKey(level, identifier); | |
| 154 cache_->Invalidate(key); | |
| 155 orthancToDicom_->Invalidate(key); | |
| 109 | 156 labels_->Invalidate(key); |
| 1 | 157 } |
| 158 | |
| 159 | |
| 160 bool ResourceHierarchyCache::LookupSeries(std::string& patient, | |
| 161 std::string& study, | |
| 162 const std::string& series) | |
| 163 { | |
| 164 if (LookupParent(study, Orthanc::ResourceType_Series, series)) | |
| 165 { | |
| 166 return LookupStudy(patient, study); | |
| 167 } | |
| 168 else | |
| 169 { | |
| 170 return false; | |
| 171 } | |
| 172 } | |
| 173 | |
| 174 | |
| 175 bool ResourceHierarchyCache::LookupInstance(std::string& patient, | |
| 176 std::string& study, | |
| 177 std::string& series, | |
| 178 const std::string& instance) | |
| 179 { | |
| 180 if (LookupParent(series, Orthanc::ResourceType_Instance, instance)) | |
| 181 { | |
| 182 return LookupSeries(patient, study, series); | |
| 183 } | |
| 184 else | |
| 185 { | |
| 186 return false; | |
| 187 } | |
| 188 } | |
| 189 | |
| 190 | |
| 191 bool ResourceHierarchyCache::LookupDicomUid(std::string& target, | |
| 192 Orthanc::ResourceType level, | |
| 193 const std::string& orthancId) | |
| 194 { | |
| 195 std::string key = ComputeKey(level, orthancId); | |
| 196 | |
| 197 if (orthancToDicom_->Retrieve(target, key)) | |
| 198 { | |
| 199 return true; | |
| 200 } | |
| 201 | |
| 202 OrthancResource resource(level, orthancId); | |
| 203 | |
|
29
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
204 if (resource.GetDicomUid(target)) |
| 1 | 205 { |
| 206 orthancToDicom_->Store(key, target, 0 /* no expiration */); | |
| 207 return true; | |
| 208 } | |
| 209 else | |
| 210 { | |
| 211 return false; | |
| 212 } | |
| 213 } | |
| 214 | |
| 215 | |
| 216 bool ResourceHierarchyCache::LookupOrthancId(std::string& target, | |
| 217 Orthanc::ResourceType level, | |
| 218 const std::string& dicomUid) | |
| 219 { | |
| 220 std::string key = ComputeKey(level, dicomUid); | |
| 221 | |
| 222 if (dicomToOrthanc_->Retrieve(target, key)) | |
| 223 { | |
| 224 return true; | |
| 225 } | |
| 226 | |
|
29
bc0431cb6b8f
fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
22
diff
changeset
|
227 if (OrthancResource::LookupOrthancId(target, level, dicomUid)) |
| 1 | 228 { |
| 229 dicomToOrthanc_->Store(key, target, 0 /* no expiration */); | |
| 230 return true; | |
| 231 } | |
| 232 else | |
| 233 { | |
| 234 return false; | |
| 235 } | |
| 236 } | |
|
77
94a9484d7f8f
fix security issues allowing to browse remote dicom servers + introduced UnitTests
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
237 |
| 78 | 238 #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
|
239 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
|
240 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
|
241 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
|
242 { |
|
94a9484d7f8f
fix security issues allowing to browse remote dicom servers + introduced UnitTests
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
243 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
|
244 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
|
245 } |
|
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 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
|
248 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
|
249 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
|
250 { |
|
94a9484d7f8f
fix security issues allowing to browse remote dicom servers + introduced UnitTests
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
251 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
|
252 } |
| 78 | 253 #endif |
|
77
94a9484d7f8f
fix security issues allowing to browse remote dicom servers + introduced UnitTests
Alain Mazy <am@osimis.io>
parents:
68
diff
changeset
|
254 |
| 1 | 255 } |