Mercurial > hg > orthanc
annotate OrthancFramework/Sources/RestApi/RestApiPath.cpp @ 5561:0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
| author | Alain Mazy <am@orthanc.team> |
|---|---|
| date | Tue, 23 Apr 2024 09:34:02 +0200 |
| parents | 48b8dae6dc77 |
| children | f7adfb22e20e |
| rev | line source |
|---|---|
| 209 | 1 /** |
| 2 * Orthanc - A Lightweight, RESTful DICOM Store | |
| 1900 | 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics |
|
1288
6e7e5ed91c2d
upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
975
diff
changeset
|
4 * Department, University Hospital of Liege, Belgium |
|
5485
48b8dae6dc77
upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
5 * Copyright (C) 2017-2024 Osimis S.A., Belgium |
|
48b8dae6dc77
upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
6 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium |
| 209 | 7 * |
| 8 * This program is free software: you can redistribute it and/or | |
|
4119
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
9 * modify it under the terms of the GNU Lesser General Public License |
|
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
10 * as published by the Free Software Foundation, either version 3 of |
|
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
11 * the License, or (at your option) any later version. |
| 209 | 12 * |
| 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 | |
|
4119
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
16 * Lesser General Public License for more details. |
| 209 | 17 * |
|
4119
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
18 * You should have received a copy of the GNU Lesser General Public |
|
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
19 * License along with this program. If not, see |
|
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
20 * <http://www.gnu.org/licenses/>. |
| 209 | 21 **/ |
| 22 | |
| 23 | |
|
824
a811bdf8b8eb
precompiled headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
24 #include "../PrecompiledHeaders.h" |
| 209 | 25 #include "RestApiPath.h" |
| 26 | |
|
966
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
27 #include "../OrthancException.h" |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
28 |
| 209 | 29 #include <cassert> |
| 30 | |
| 31 namespace Orthanc | |
| 32 { | |
| 33 RestApiPath::RestApiPath(const std::string& uri) | |
| 34 { | |
| 35 Toolbox::SplitUriComponents(uri_, uri); | |
| 36 | |
| 37 if (uri_.size() == 0) | |
| 38 { | |
| 218 | 39 hasTrailing_ = false; |
| 209 | 40 return; |
| 41 } | |
| 42 | |
| 43 if (uri_.back() == "*") | |
| 44 { | |
| 45 hasTrailing_ = true; | |
| 46 uri_.pop_back(); | |
| 47 } | |
| 48 else | |
| 49 { | |
| 50 hasTrailing_ = false; | |
| 51 } | |
| 52 | |
| 53 components_.resize(uri_.size()); | |
| 54 for (size_t i = 0; i < uri_.size(); i++) | |
| 55 { | |
| 56 size_t s = uri_[i].size(); | |
| 57 assert(s > 0); | |
| 58 | |
| 59 if (uri_[i][0] == '{' && | |
| 60 uri_[i][s - 1] == '}') | |
| 61 { | |
| 62 components_[i] = uri_[i].substr(1, s - 2); | |
| 63 uri_[i] = ""; | |
| 64 } | |
| 65 else | |
| 66 { | |
| 67 components_[i] = ""; | |
| 68 } | |
| 69 } | |
| 70 } | |
| 71 | |
|
4330
a01b1c9cbef4
moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4300
diff
changeset
|
72 bool RestApiPath::Match(HttpToolbox::Arguments& components, |
| 209 | 73 UriComponents& trailing, |
| 74 const std::string& uriRaw) const | |
| 75 { | |
| 76 UriComponents uri; | |
| 77 Toolbox::SplitUriComponents(uri, uriRaw); | |
| 78 return Match(components, trailing, uri); | |
| 79 } | |
| 80 | |
|
4330
a01b1c9cbef4
moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4300
diff
changeset
|
81 bool RestApiPath::Match(HttpToolbox::Arguments& components, |
| 209 | 82 UriComponents& trailing, |
| 83 const UriComponents& uri) const | |
| 84 { | |
|
966
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
85 assert(uri_.size() == components_.size()); |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
86 |
| 209 | 87 if (uri.size() < uri_.size()) |
| 88 { | |
| 89 return false; | |
| 90 } | |
| 91 | |
| 92 if (!hasTrailing_ && uri.size() > uri_.size()) | |
| 93 { | |
| 94 return false; | |
| 95 } | |
| 96 | |
| 97 components.clear(); | |
| 98 trailing.clear(); | |
| 99 | |
| 100 assert(uri_.size() <= uri.size()); | |
| 101 for (size_t i = 0; i < uri_.size(); i++) | |
| 102 { | |
| 103 if (components_[i].size() == 0) | |
| 104 { | |
| 105 // This URI component is not a free parameter | |
| 106 if (uri_[i] != uri[i]) | |
| 107 { | |
| 108 return false; | |
| 109 } | |
| 110 } | |
| 111 else | |
| 112 { | |
| 113 // This URI component is a free parameter | |
| 114 components[components_[i]] = uri[i]; | |
| 115 } | |
| 116 } | |
| 117 | |
| 118 if (hasTrailing_) | |
| 119 { | |
| 120 trailing.assign(uri.begin() + uri_.size(), uri.end()); | |
| 121 } | |
| 122 | |
| 123 return true; | |
| 124 } | |
| 125 | |
| 126 | |
| 127 bool RestApiPath::Match(const UriComponents& uri) const | |
| 128 { | |
|
4330
a01b1c9cbef4
moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4300
diff
changeset
|
129 HttpToolbox::Arguments components; |
| 209 | 130 UriComponents trailing; |
| 131 return Match(components, trailing, uri); | |
| 132 } | |
|
966
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
133 |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
134 |
| 4300 | 135 size_t RestApiPath::GetLevelCount() const |
| 136 { | |
| 137 return uri_.size(); | |
| 138 } | |
| 139 | |
| 140 | |
|
966
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
141 bool RestApiPath::IsWildcardLevel(size_t level) const |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
142 { |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
143 assert(uri_.size() == components_.size()); |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
144 |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
145 if (level >= uri_.size()) |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
146 { |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
147 throw OrthancException(ErrorCode_ParameterOutOfRange); |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
148 } |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
149 |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
150 return uri_[level].length() == 0; |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
151 } |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
152 |
| 4300 | 153 bool RestApiPath::IsUniversalTrailing() const |
| 154 { | |
| 155 return hasTrailing_; | |
| 156 } | |
| 157 | |
|
966
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
158 const std::string& RestApiPath::GetWildcardName(size_t level) const |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
159 { |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
160 assert(uri_.size() == components_.size()); |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
161 |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
162 if (!IsWildcardLevel(level)) |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
163 { |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
164 throw OrthancException(ErrorCode_BadParameterType); |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
165 } |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
166 |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
167 return components_[level]; |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
168 } |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
169 |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
170 const std::string& RestApiPath::GetLevelName(size_t level) const |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
171 { |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
172 assert(uri_.size() == components_.size()); |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
173 |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
174 if (IsWildcardLevel(level)) |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
175 { |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
176 throw OrthancException(ErrorCode_BadParameterType); |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
177 } |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
178 |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
179 return uri_[level]; |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
180 } |
| 209 | 181 } |
|
966
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
182 |