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.hc.client5.http.impl.cookie;
28  
29  import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler;
30  import org.apache.hc.client5.http.cookie.Cookie;
31  import org.apache.hc.client5.http.cookie.CookieOrigin;
32  import org.apache.hc.client5.http.cookie.MalformedCookieException;
33  import org.apache.hc.client5.http.cookie.SetCookie;
34  import org.apache.hc.core5.annotation.Contract;
35  import org.apache.hc.core5.annotation.ThreadingBehavior;
36  import org.apache.hc.core5.util.Args;
37  import org.apache.hc.core5.util.TextUtils;
38  
39  /**
40   * Cookie {@code path} attribute handler.
41   *
42   * @since 4.0
43   */
44  @Contract(threading = ThreadingBehavior.STATELESS)
45  public class BasicPathHandler implements CommonCookieAttributeHandler {
46  
47      /**
48       * Singleton instance.
49       *
50       * @since 5.2
51       */
52      public static final BasicPathHandler INSTANCE = new BasicPathHandler();
53  
54      public BasicPathHandler() {
55          super();
56      }
57  
58      @Override
59      public void parse(
60              final SetCookie cookie, final String value) throws MalformedCookieException {
61          Args.notNull(cookie, "Cookie");
62          cookie.setPath(!TextUtils.isBlank(value) ? value : "/");
63      }
64  
65      @Override
66      public void validate(final Cookie cookie, final CookieOrigin origin)
67              throws MalformedCookieException {
68      }
69  
70      static boolean pathMatch(final String uriPath, final String cookiePath) {
71          String normalizedCookiePath = cookiePath;
72          if (normalizedCookiePath == null) {
73              normalizedCookiePath = "/";
74          }
75          if (normalizedCookiePath.length() > 1 && normalizedCookiePath.endsWith("/")) {
76              normalizedCookiePath = normalizedCookiePath.substring(0, normalizedCookiePath.length() - 1);
77          }
78          if (uriPath.startsWith(normalizedCookiePath)) {
79              if (normalizedCookiePath.equals("/")) {
80                  return true;
81              }
82              if (uriPath.length() == normalizedCookiePath.length()) {
83                  return true;
84              }
85              return uriPath.charAt(normalizedCookiePath.length()) == '/';
86          }
87          return false;
88      }
89  
90      @Override
91      public boolean match(final Cookie cookie, final CookieOrigin origin) {
92          Args.notNull(cookie, "Cookie");
93          Args.notNull(origin, "Cookie origin");
94          return pathMatch(origin.getPath(), cookie.getPath());
95      }
96  
97      @Override
98      public String getAttributeName() {
99          return Cookie.PATH_ATTR;
100     }
101 
102 }