1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
|
--- a/web/src/main/java/org/apache/shiro/web/util/WebUtils.java
+++ b/web/src/main/java/org/apache/shiro/web/util/WebUtils.java
@@ -108,16 +108,7 @@
* @return the path within the web application
*/
public static String getPathWithinApplication(HttpServletRequest request) {
- String contextPath = getContextPath(request);
- String requestUri = getRequestUri(request);
- if (StringUtils.startsWithIgnoreCase(requestUri, contextPath)) {
- // Normal case: URI contains context path.
- String path = requestUri.substring(contextPath.length());
- return (StringUtils.hasText(path) ? path : "/");
- } else {
- // Special case: rather unusual.
- return requestUri;
- }
+ return normalize(removeSemicolon(getServletPath(request) + getPathInfo(request)));
}
/**
@@ -131,7 +122,9 @@
*
* @param request current HTTP request
* @return the request URI
+ * @deprecated use getPathWithinApplication() to get the path minus the context path, or call HttpServletRequest.getRequestURI() directly from your code.
*/
+ @Deprecated
public static String getRequestUri(HttpServletRequest request) {
String uri = (String) request.getAttribute(INCLUDE_REQUEST_URI_ATTRIBUTE);
if (uri == null) {
@@ -140,6 +133,23 @@
return normalize(decodeAndCleanUriString(request, uri));
}
+ private static String getServletPath(HttpServletRequest request) {
+ String servletPath = (String) request.getAttribute(INCLUDE_SERVLET_PATH_ATTRIBUTE);
+ return servletPath != null ? servletPath : valueOrEmpty(request.getServletPath());
+ }
+
+ private static String getPathInfo(HttpServletRequest request) {
+ String pathInfo = (String) request.getAttribute(INCLUDE_PATH_INFO_ATTRIBUTE);
+ return pathInfo != null ? pathInfo : valueOrEmpty(request.getPathInfo());
+ }
+
+ private static String valueOrEmpty(String input) {
+ if (input == null) {
+ return "";
+ }
+ return input;
+ }
+
/**
* Normalize a relative URI path that may have relative values ("/./",
* "/../", and so on ) it it. <strong>WARNING</strong> - This method is
@@ -230,6 +240,10 @@
*/
private static String decodeAndCleanUriString(HttpServletRequest request, String uri) {
uri = decodeRequestString(request, uri);
+ return removeSemicolon(uri);
+ }
+
+ private static String removeSemicolon(String uri) {
int semicolonIndex = uri.indexOf(';');
return (semicolonIndex != -1 ? uri.substring(0, semicolonIndex) : uri);
}
--- a/support/guice/src/test/java/org/apache/shiro/guice/web/FilterConfigTest.java
+++ b/support/guice/src/test/java/org/apache/shiro/guice/web/FilterConfigTest.java
@@ -85,9 +85,8 @@
private HttpServletRequest createMockRequest(String path) {
HttpServletRequest request = createNiceMock(HttpServletRequest.class);
- expect(request.getAttribute(WebUtils.INCLUDE_CONTEXT_PATH_ATTRIBUTE)).andReturn(null).anyTimes();
- expect(request.getContextPath()).andReturn("");
- expect(request.getRequestURI()).andReturn(path);
+ expect(request.getServletPath()).andReturn("");
+ expect(request.getPathInfo()).andReturn(path);
replay(request);
return request;
}
--- a/web/src/test/groovy/org/apache/shiro/web/util/WebUtilsTest.groovy
+++ b/web/src/test/groovy/org/apache/shiro/web/util/WebUtilsTest.groovy
@@ -140,34 +140,90 @@
}
+ @Test
+ void testGetRequestUriWithServlet() {
+
+ dotTestGetPathWithinApplicationFromRequest("/servlet", "/foobar", "/servlet/foobar")
+ dotTestGetPathWithinApplicationFromRequest("/servlet", "/foobar", "/servlet/foobar")
+ dotTestGetPathWithinApplicationFromRequest("servlet", "/foobar", "/servlet/foobar")
+ dotTestGetPathWithinApplicationFromRequest("servlet", "/foobar", "/servlet/foobar")
+ dotTestGetPathWithinApplicationFromRequest("servlet", "/foobar", "/servlet/foobar")
+ dotTestGetPathWithinApplicationFromRequest("//servlet", "//foobar", "/servlet/foobar")
+ dotTestGetPathWithinApplicationFromRequest("/servlet", "/foobar", "/servlet/foobar")
+ dotTestGetPathWithinApplicationFromRequest("//servlet", "//foobar", "/servlet/foobar")
+ dotTestGetPathWithinApplicationFromRequest("/servlet", "/../servlet/other", "/servlet/other")
+ dotTestGetPathWithinApplicationFromRequest("/asdf", "/../servlet/other", "/servlet/other")
+ dotTestGetPathWithinApplicationFromRequest("/asdf/foo", ";/../servlet/other", "/asdf/foo")
+ dotTestGetPathWithinApplicationFromRequest("/servlet", "/foobar", "/servlet/foobar")
+ dotTestGetPathWithinApplicationFromRequest("/servlet", "/foobar", "/servlet/foobar")
+ dotTestGetPathWithinApplicationFromRequest("/servlet", "/foobar", "/servlet/foobar")
+ dotTestGetPathWithinApplicationFromRequest(null, null, "/")
+ dotTestGetPathWithinApplicationFromRequest("index.jsp", null, "/index.jsp")
+ }
@Test
void testGetPathWithinApplication() {
- doTestGetPathWithinApplication("/", "/foobar", "/foobar");
- doTestGetPathWithinApplication("", "/foobar", "/foobar");
- doTestGetPathWithinApplication("", "foobar", "/foobar");
- doTestGetPathWithinApplication("/", "foobar", "/foobar");
- doTestGetPathWithinApplication("//", "foobar", "/foobar");
- doTestGetPathWithinApplication("//", "//foobar", "/foobar");
- doTestGetPathWithinApplication("/context-path", "/context-path/foobar", "/foobar");
- doTestGetPathWithinApplication("/context-path", "/context-path/foobar/", "/foobar/");
- doTestGetPathWithinApplication("//context-path", "//context-path/foobar", "/foobar");
- doTestGetPathWithinApplication("//context-path", "//context-path//foobar", "/foobar");
- doTestGetPathWithinApplication("//context-path", "//context-path/remove-one/remove-two/../../././/foobar", "/foobar");
- doTestGetPathWithinApplication("//context-path", "//context-path//../../././/foobar", null);
- doTestGetPathWithinApplication("/context%2525path", "/context%2525path/foobar", "/foobar");
- doTestGetPathWithinApplication("/c%6Fntext%20path", "/c%6Fntext%20path/foobar", "/foobar");
- doTestGetPathWithinApplication("/context path", "/context path/foobar", "/foobar");
+ doTestGetPathWithinApplication("/foobar", null, "/foobar");
+ doTestGetPathWithinApplication("/foobar", "", "/foobar");
+ doTestGetPathWithinApplication("", "/", "/");
+ doTestGetPathWithinApplication("", null, "/");
+ doTestGetPathWithinApplication("/foobar", "//", "/foobar/");
+ doTestGetPathWithinApplication("/foobar", "//extra", "/foobar/extra");
+ doTestGetPathWithinApplication("/foobar", "//extra///", "/foobar/extra/");
+ doTestGetPathWithinApplication("/foo bar", "/path info" ,"/foo bar/path info");
+ }
+ @Test
+ void testGetRequestURI() {
+ doTestGetRequestURI("/foobar", "/foobar")
+ doTestGetRequestURI( "/foobar/", "/foobar/")
+ doTestGetRequestURI("", "/");
+ doTestGetRequestURI("foobar", "/foobar");
+ doTestGetRequestURI("//foobar", "/foobar");
+ doTestGetRequestURI("//foobar///", "/foobar/");
+ doTestGetRequestURI("/context-path/foobar", "/context-path/foobar");
+ doTestGetRequestURI("/context-path/foobar/", "/context-path/foobar/");
+ doTestGetRequestURI("//context-path/foobar", "/context-path/foobar");
+ doTestGetRequestURI("//context-path//foobar", "/context-path/foobar");
+ doTestGetRequestURI("//context-path/remove-one/remove-two/../../././/foobar", "/context-path/foobar");
+ doTestGetRequestURI("//context-path//../../././/foobar", null);
+ doTestGetRequestURI("/context%2525path/foobar", "/context%25path/foobar");
+ doTestGetRequestURI("/c%6Fntext%20path/foobar", "/context path/foobar");
+ doTestGetRequestURI("/context path/foobar", "/context path/foobar");
}
- void doTestGetPathWithinApplication(String contextPath, String requestUri, String expectedValue) {
+ void doTestGetPathWithinApplication(String servletPath, String pathInfo, String expectedValue) {
def request = createMock(HttpServletRequest)
- expect(request.getAttribute(WebUtils.INCLUDE_CONTEXT_PATH_ATTRIBUTE)).andReturn(contextPath)
- expect(request.getAttribute(WebUtils.INCLUDE_REQUEST_URI_ATTRIBUTE)).andReturn(requestUri)
- expect(request.getCharacterEncoding()).andReturn("UTF-8").times(2)
+ expect(request.getAttribute(WebUtils.INCLUDE_SERVLET_PATH_ATTRIBUTE)).andReturn(servletPath)
+ expect(request.getAttribute(WebUtils.INCLUDE_PATH_INFO_ATTRIBUTE)).andReturn(pathInfo)
+ if (pathInfo == null) {
+ expect(request.getPathInfo()).andReturn(null) // path info can be null
+ }
+ replay request
+ assertEquals expectedValue, WebUtils.getPathWithinApplication(request)
+ verify request
+ }
+
+ void doTestGetRequestURI(String rawRequestUri, String expectedValue) {
+
+ def request = createMock(HttpServletRequest)
+ expect(request.getAttribute(WebUtils.INCLUDE_REQUEST_URI_ATTRIBUTE)).andReturn(rawRequestUri)
+ expect(request.getCharacterEncoding()).andReturn("UTF-8").times(1)
+ replay request
+ assertEquals expectedValue, WebUtils.getRequestUri(request)
+ verify request
+ }
+
+ void dotTestGetPathWithinApplicationFromRequest(String servletPath, String pathInfo, String expectedValue) {
+
+ HttpServletRequest request = createMock(HttpServletRequest)
+ expect(request.getAttribute(WebUtils.INCLUDE_SERVLET_PATH_ATTRIBUTE)).andReturn(null)
+ expect(request.getAttribute(WebUtils.INCLUDE_PATH_INFO_ATTRIBUTE)).andReturn(null)
+ expect(request.getServletPath()).andReturn(servletPath)
+ expect(request.getPathInfo()).andReturn(pathInfo)
+ expect(request.getCharacterEncoding()).andReturn("UTF-8").anyTimes()
replay request
assertEquals expectedValue, WebUtils.getPathWithinApplication(request)
verify request
--- a/web/src/test/java/org/apache/shiro/web/filter/PathMatchingFilterTest.java
+++ b/web/src/test/java/org/apache/shiro/web/filter/PathMatchingFilterTest.java
@@ -112,6 +112,8 @@
expect(request.getContextPath()).andReturn(CONTEXT_PATH).anyTimes();
expect(request.getRequestURI()).andReturn(ENABLED_PATH).anyTimes();
+ expect(request.getServletPath()).andReturn("").anyTimes();
+ expect(request.getPathInfo()).andReturn(ENABLED_PATH).anyTimes();
replay(request);
boolean continueFilterChain = filter.preHandle(request, response);
--- a/web/src/test/java/org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolverTest.java
+++ b/web/src/test/java/org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolverTest.java
@@ -97,9 +97,8 @@
//ensure at least one chain is defined:
resolver.getFilterChainManager().addToChain("/index.html", "authcBasic");
- expect(request.getAttribute(WebUtils.INCLUDE_CONTEXT_PATH_ATTRIBUTE)).andReturn(null).anyTimes();
- expect(request.getContextPath()).andReturn("");
- expect(request.getRequestURI()).andReturn("/index.html");
+ expect(request.getServletPath()).andReturn("");
+ expect(request.getPathInfo()).andReturn("/index.html");
replay(request);
FilterChain resolved = resolver.getChain(request, response, chain);
@@ -116,9 +115,8 @@
//ensure at least one chain is defined:
resolver.getFilterChainManager().addToChain("/index.html", "authcBasic");
- expect(request.getAttribute(WebUtils.INCLUDE_CONTEXT_PATH_ATTRIBUTE)).andReturn(null).anyTimes();
- expect(request.getContextPath()).andReturn("");
- expect(request.getRequestURI()).andReturn("/./index.html");
+ expect(request.getServletPath()).andReturn("/");
+ expect(request.getPathInfo()).andReturn("./index.html");
replay(request);
FilterChain resolved = resolver.getChain(request, response, chain);
@@ -135,9 +133,8 @@
//ensure at least one chain is defined:
resolver.getFilterChainManager().addToChain("/index.html", "authcBasic");
- expect(request.getAttribute(WebUtils.INCLUDE_CONTEXT_PATH_ATTRIBUTE)).andReturn(null).anyTimes();
- expect(request.getContextPath()).andReturn("");
- expect(request.getRequestURI()).andReturn("/public/../index.html");
+ expect(request.getServletPath()).andReturn("/public/");
+ expect(request.getPathInfo()).andReturn("../index.html");
replay(request);
FilterChain resolved = resolver.getChain(request, response, chain);
@@ -154,9 +151,8 @@
//ensure at least one chain is defined:
resolver.getFilterChainManager().addToChain("/index.html", "authcBasic");
- expect(request.getAttribute(WebUtils.INCLUDE_CONTEXT_PATH_ATTRIBUTE)).andReturn(null).anyTimes();
- expect(request.getContextPath()).andReturn("");
- expect(request.getRequestURI()).andReturn("/");
+ expect(request.getServletPath()).andReturn("/");
+ expect(request.getPathInfo()).andReturn(null);
replay(request);
FilterChain resolved = resolver.getChain(request, response, chain);
--- a/support/guice/src/test/java/org/apache/shiro/guice/web/SimpleFilterChainResolverTest.java
+++ b/support/guice/src/test/java/org/apache/shiro/guice/web/SimpleFilterChainResolverTest.java
@@ -82,8 +82,8 @@
ServletResponse response = ctrl.createMock(HttpServletResponse.class);
FilterChain originalChain = ctrl.createMock(FilterChain.class);
- expect(request.getAttribute(WebUtils.INCLUDE_CONTEXT_PATH_ATTRIBUTE)).andReturn("/context");
- expect(request.getAttribute(WebUtils.INCLUDE_REQUEST_URI_ATTRIBUTE)).andReturn("/mychain");
+ expect(request.getAttribute(WebUtils.INCLUDE_SERVLET_PATH_ATTRIBUTE)).andReturn("/mychain");
+ expect(request.getAttribute(WebUtils.INCLUDE_PATH_INFO_ATTRIBUTE)).andReturn("");
expect(request.getCharacterEncoding()).andStubReturn(null);
@@ -113,8 +113,8 @@
ctrl.reset();
- expect(request.getAttribute(WebUtils.INCLUDE_CONTEXT_PATH_ATTRIBUTE)).andReturn("/context");
- expect(request.getAttribute(WebUtils.INCLUDE_REQUEST_URI_ATTRIBUTE)).andReturn("/nochain");
+ expect(request.getAttribute(WebUtils.INCLUDE_SERVLET_PATH_ATTRIBUTE)).andReturn("/nochain");
+ expect(request.getAttribute(WebUtils.INCLUDE_PATH_INFO_ATTRIBUTE)).andReturn("");
expect(request.getCharacterEncoding()).andStubReturn(null);
--- a/support/guice/src/test/java/org/apache/shiro/guice/web/ShiroWebModuleTest.java
+++ b/support/guice/src/test/java/org/apache/shiro/guice/web/ShiroWebModuleTest.java
@@ -177,11 +177,13 @@
servletContext.setAttribute(eq(EnvironmentLoader.ENVIRONMENT_ATTRIBUTE_KEY), EasyMock.anyObject());
expect(request.getAttribute("javax.servlet.include.context_path")).andReturn("").anyTimes();
expect(request.getCharacterEncoding()).andReturn("UTF-8").anyTimes();
- expect(request.getAttribute("javax.servlet.include.request_uri")).andReturn("/test_authc");
- expect(request.getAttribute("javax.servlet.include.request_uri")).andReturn("/test_custom_filter");
- expect(request.getAttribute("javax.servlet.include.request_uri")).andReturn("/test_authc_basic");
- expect(request.getAttribute("javax.servlet.include.request_uri")).andReturn("/test_perms");
- expect(request.getAttribute("javax.servlet.include.request_uri")).andReturn("/multiple_configs");
+ expect(request.getAttribute("javax.servlet.include.path_info")).andReturn(null).anyTimes();
+ expect(request.getPathInfo()).andReturn(null).anyTimes();
+ expect(request.getAttribute("javax.servlet.include.servlet_path")).andReturn("/test_authc");
+ expect(request.getAttribute("javax.servlet.include.servlet_path")).andReturn("/test_custom_filter");
+ expect(request.getAttribute("javax.servlet.include.servlet_path")).andReturn("/test_authc_basic");
+ expect(request.getAttribute("javax.servlet.include.servlet_path")).andReturn("/test_perms");
+ expect(request.getAttribute("javax.servlet.include.servlet_path")).andReturn("/multiple_configs");
replay(servletContext, request);
Injector injector = Guice.createInjector(new ShiroWebModule(servletContext) {
|
