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