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  import org.apache.http.cookie.Cookie;
31  import org.apache.http.cookie.CookieAttributeHandler;
32  import org.apache.http.cookie.CookieOrigin;
33  import org.apache.http.cookie.CookieRestrictionViolationException;
34  import org.apache.http.cookie.MalformedCookieException;
35  import org.apache.http.cookie.SetCookie;
36  import org.apache.http.util.Args;
37  import org.apache.http.util.TextUtils;
38  
39  /**
40   *
41   * @since 4.0
42   */
43  @Immutable
44  public class BasicPathHandler implements CookieAttributeHandler {
45  
46      public BasicPathHandler() {
47          super();
48      }
49  
50      @Override
51      public void parse(
52              final SetCookie cookie, final String value) throws MalformedCookieException {
53          Args.notNull(cookie, "Cookie");
54          cookie.setPath(!TextUtils.isBlank(value) ? value : "/");
55      }
56  
57      @Override
58      public void validate(final Cookie cookie, final CookieOrigin origin)
59              throws MalformedCookieException {
60          if (!match(cookie, origin)) {
61              throw new CookieRestrictionViolationException(
62                  "Illegal path attribute \"" + cookie.getPath()
63                  + "\". Path of origin: \"" + origin.getPath() + "\"");
64          }
65      }
66  
67      @Override
68      public boolean match(final Cookie cookie, final CookieOrigin origin) {
69          Args.notNull(cookie, "Cookie");
70          Args.notNull(origin, "Cookie origin");
71          final String targetpath = origin.getPath();
72          String topmostPath = cookie.getPath();
73          if (topmostPath == null) {
74              topmostPath = "/";
75          }
76          if (topmostPath.length() > 1 && topmostPath.endsWith("/")) {
77              topmostPath = topmostPath.substring(0, topmostPath.length() - 1);
78          }
79          boolean match = targetpath.startsWith (topmostPath);
80          // if there is a match and these values are not exactly the same we have
81          // to make sure we're not matcing "/foobar" and "/foo"
82          if (match && targetpath.length() != topmostPath.length()) {
83              if (!topmostPath.endsWith("/")) {
84                  match = (targetpath.charAt(topmostPath.length()) == '/');
85              }
86          }
87          return match;
88      }
89  
90  }