View Javadoc

1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  package org.apache.http.impl.cookie;
28  
29  import org.apache.http.annotation.Immutable;
30  
31  import org.apache.http.cookie.Cookie;
32  import org.apache.http.cookie.CookieAttributeHandler;
33  import org.apache.http.cookie.CookieOrigin;
34  import org.apache.http.cookie.CookieRestrictionViolationException;
35  import org.apache.http.cookie.MalformedCookieException;
36  import org.apache.http.cookie.SetCookie;
37  
38  /**
39   *
40   * @since 4.0
41   */
42  @Immutable
43  public class BasicPathHandler implements CookieAttributeHandler {
44  
45      public BasicPathHandler() {
46          super();
47      }
48  
49      public void parse(final SetCookie cookie, String value)
50              throws MalformedCookieException {
51          if (cookie == null) {
52              throw new IllegalArgumentException("Cookie may not be null");
53          }
54          if (value == null || value.trim().length() == 0) {
55              value = "/";
56          }
57          cookie.setPath(value);
58      }
59  
60      public void validate(final Cookie cookie, final CookieOrigin origin)
61              throws MalformedCookieException {
62          if (!match(cookie, origin)) {
63              throw new CookieRestrictionViolationException(
64                  "Illegal path attribute \"" + cookie.getPath()
65                  + "\". Path of origin: \"" + origin.getPath() + "\"");
66          }
67      }
68  
69      public boolean match(final Cookie cookie, final CookieOrigin origin) {
70          if (cookie == null) {
71              throw new IllegalArgumentException("Cookie may not be null");
72          }
73          if (origin == null) {
74              throw new IllegalArgumentException("Cookie origin may not be null");
75          }
76          String targetpath = origin.getPath();
77          String topmostPath = cookie.getPath();
78          if (topmostPath == null) {
79              topmostPath = "/";
80          }
81          if (topmostPath.length() > 1 && topmostPath.endsWith("/")) {
82              topmostPath = topmostPath.substring(0, topmostPath.length() - 1);
83          }
84          boolean match = targetpath.startsWith (topmostPath);
85          // if there is a match and these values are not exactly the same we have
86          // to make sure we're not matcing "/foobar" and "/foo"
87          if (match && targetpath.length() != topmostPath.length()) {
88              if (!topmostPath.endsWith("/")) {
89                  match = (targetpath.charAt(topmostPath.length()) == '/');
90              }
91          }
92          return match;
93      }
94  
95  }