Mercurial > hg > orthanc
annotate OrthancFramework/Sources/RestApi/RestApiPath.cpp @ 5839:7aef730c0859 default tip
cont
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Wed, 16 Oct 2024 19:34:42 +0200 |
parents | f7adfb22e20e |
children |
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 |
5640
f7adfb22e20e
updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5485
diff
changeset
|
5 * Copyright (C) 2017-2023 Osimis S.A., Belgium |
f7adfb22e20e
updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5485
diff
changeset
|
6 * Copyright (C) 2024-2024 Orthanc Team SRL, Belgium |
5485
48b8dae6dc77
upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
7 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium |
209 | 8 * |
9 * 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
|
10 * 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
|
11 * 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
|
12 * the License, or (at your option) any later version. |
209 | 13 * |
14 * This program is distributed in the hope that it will be useful, but | |
15 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 * 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
|
17 * Lesser General Public License for more details. |
209 | 18 * |
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
|
19 * 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
|
20 * 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
|
21 * <http://www.gnu.org/licenses/>. |
209 | 22 **/ |
23 | |
24 | |
824
a811bdf8b8eb
precompiled headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
25 #include "../PrecompiledHeaders.h" |
209 | 26 #include "RestApiPath.h" |
27 | |
966
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
28 #include "../OrthancException.h" |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
29 |
209 | 30 #include <cassert> |
31 | |
32 namespace Orthanc | |
33 { | |
34 RestApiPath::RestApiPath(const std::string& uri) | |
35 { | |
36 Toolbox::SplitUriComponents(uri_, uri); | |
37 | |
38 if (uri_.size() == 0) | |
39 { | |
218 | 40 hasTrailing_ = false; |
209 | 41 return; |
42 } | |
43 | |
44 if (uri_.back() == "*") | |
45 { | |
46 hasTrailing_ = true; | |
47 uri_.pop_back(); | |
48 } | |
49 else | |
50 { | |
51 hasTrailing_ = false; | |
52 } | |
53 | |
54 components_.resize(uri_.size()); | |
55 for (size_t i = 0; i < uri_.size(); i++) | |
56 { | |
57 size_t s = uri_[i].size(); | |
58 assert(s > 0); | |
59 | |
60 if (uri_[i][0] == '{' && | |
61 uri_[i][s - 1] == '}') | |
62 { | |
63 components_[i] = uri_[i].substr(1, s - 2); | |
64 uri_[i] = ""; | |
65 } | |
66 else | |
67 { | |
68 components_[i] = ""; | |
69 } | |
70 } | |
71 } | |
72 | |
4330
a01b1c9cbef4
moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4300
diff
changeset
|
73 bool RestApiPath::Match(HttpToolbox::Arguments& components, |
209 | 74 UriComponents& trailing, |
75 const std::string& uriRaw) const | |
76 { | |
77 UriComponents uri; | |
78 Toolbox::SplitUriComponents(uri, uriRaw); | |
79 return Match(components, trailing, uri); | |
80 } | |
81 | |
4330
a01b1c9cbef4
moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4300
diff
changeset
|
82 bool RestApiPath::Match(HttpToolbox::Arguments& components, |
209 | 83 UriComponents& trailing, |
84 const UriComponents& uri) const | |
85 { | |
966
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
86 assert(uri_.size() == components_.size()); |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
87 |
209 | 88 if (uri.size() < uri_.size()) |
89 { | |
90 return false; | |
91 } | |
92 | |
93 if (!hasTrailing_ && uri.size() > uri_.size()) | |
94 { | |
95 return false; | |
96 } | |
97 | |
98 components.clear(); | |
99 trailing.clear(); | |
100 | |
101 assert(uri_.size() <= uri.size()); | |
102 for (size_t i = 0; i < uri_.size(); i++) | |
103 { | |
104 if (components_[i].size() == 0) | |
105 { | |
106 // This URI component is not a free parameter | |
107 if (uri_[i] != uri[i]) | |
108 { | |
109 return false; | |
110 } | |
111 } | |
112 else | |
113 { | |
114 // This URI component is a free parameter | |
115 components[components_[i]] = uri[i]; | |
116 } | |
117 } | |
118 | |
119 if (hasTrailing_) | |
120 { | |
121 trailing.assign(uri.begin() + uri_.size(), uri.end()); | |
122 } | |
123 | |
124 return true; | |
125 } | |
126 | |
127 | |
128 bool RestApiPath::Match(const UriComponents& uri) const | |
129 { | |
4330
a01b1c9cbef4
moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4300
diff
changeset
|
130 HttpToolbox::Arguments components; |
209 | 131 UriComponents trailing; |
132 return Match(components, trailing, uri); | |
133 } | |
966
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
134 |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
135 |
4300 | 136 size_t RestApiPath::GetLevelCount() const |
137 { | |
138 return uri_.size(); | |
139 } | |
140 | |
141 | |
966
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
142 bool RestApiPath::IsWildcardLevel(size_t level) const |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
143 { |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
144 assert(uri_.size() == components_.size()); |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
145 |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
146 if (level >= uri_.size()) |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
147 { |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
148 throw OrthancException(ErrorCode_ParameterOutOfRange); |
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 |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
151 return uri_[level].length() == 0; |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
152 } |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
153 |
4300 | 154 bool RestApiPath::IsUniversalTrailing() const |
155 { | |
156 return hasTrailing_; | |
157 } | |
158 | |
966
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
159 const std::string& RestApiPath::GetWildcardName(size_t level) const |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
160 { |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
161 assert(uri_.size() == components_.size()); |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
162 |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
163 if (!IsWildcardLevel(level)) |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
164 { |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
165 throw OrthancException(ErrorCode_BadParameterType); |
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 |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
168 return components_[level]; |
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 |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
171 const std::string& RestApiPath::GetLevelName(size_t level) const |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
172 { |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
173 assert(uri_.size() == components_.size()); |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
174 |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
175 if (IsWildcardLevel(level)) |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
176 { |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
177 throw OrthancException(ErrorCode_BadParameterType); |
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 |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
180 return uri_[level]; |
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
181 } |
209 | 182 } |
966
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
183 |