org.apache.http.conn.util.PublicSuffixMatcher Maven / Gradle / Ivy
Show all versions of httpclient Show documentation
/*
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
*
* An up-to-date list of suffixes can be obtained from
* publicsuffix.org
*
* @see org.apache.http.conn.util.PublicSuffixList
*
* @since 4.4
*/
@Contract(threading = ThreadingBehavior.SAFE)
public final class PublicSuffixMatcher {
private final Map rules;
private final Map exceptions;
public PublicSuffixMatcher(final Collection rules, final Collection exceptions) {
this(DomainType.UNKNOWN, rules, exceptions);
}
/**
* @since 4.5
*/
public PublicSuffixMatcher(
final DomainType domainType, final Collection rules, final Collection exceptions) {
Args.notNull(domainType, "Domain type");
Args.notNull(rules, "Domain suffix rules");
this.rules = new ConcurrentHashMap(rules.size());
for (final String rule: rules) {
this.rules.put(rule, domainType);
}
this.exceptions = new ConcurrentHashMap();
if (exceptions != null) {
for (final String exception: exceptions) {
this.exceptions.put(exception, domainType);
}
}
}
/**
* @since 4.5
*/
public PublicSuffixMatcher(final Collection lists) {
Args.notNull(lists, "Domain suffix lists");
this.rules = new ConcurrentHashMap();
this.exceptions = new ConcurrentHashMap();
for (final PublicSuffixList list: lists) {
final DomainType domainType = list.getType();
final List rules = list.getRules();
for (final String rule: rules) {
this.rules.put(rule, domainType);
}
final List exceptions = list.getExceptions();
if (exceptions != null) {
for (final String exception: exceptions) {
this.exceptions.put(exception, domainType);
}
}
}
}
private static boolean hasEntry(final Map map, final String rule, final DomainType expectedType) {
if (map == null) {
return false;
}
final DomainType domainType = map.get(rule);
return domainType == null ? false : expectedType == null || domainType.equals(expectedType);
}
private boolean hasRule(final String rule, final DomainType expectedType) {
return hasEntry(this.rules, rule, expectedType);
}
private boolean hasException(final String exception, final DomainType expectedType) {
return hasEntry(this.exceptions, exception, expectedType);
}
/**
* Returns registrable part of the domain for the given domain name or {@code null}
* if given domain represents a public suffix.
*
* @param domain
* @return domain root
*/
public String getDomainRoot(final String domain) {
return getDomainRoot(domain, null);
}
/**
* Returns registrable part of the domain for the given domain name or {@code null}
* if given domain represents a public suffix.
*
* @param domain
* @param expectedType expected domain type or {@code null} if any.
* @return domain root
*
* @since 4.5
*/
public String getDomainRoot(final String domain, final DomainType expectedType) {
if (domain == null) {
return null;
}
if (domain.startsWith(".")) {
return null;
}
final String normalized = domain.toLowerCase(Locale.ROOT);
String segment = normalized;
String result = null;
while (segment != null) {
// An exception rule takes priority over any other matching rule.
final String key = IDN.toUnicode(segment);
if (hasException(key, expectedType)) {
return segment;
}
if (hasRule(key, expectedType)) {
return result;
}
final int nextdot = segment.indexOf('.');
final String nextSegment = nextdot != -1 ? segment.substring(nextdot + 1) : null;
if (nextSegment != null) {
if (hasRule("*." + IDN.toUnicode(nextSegment), expectedType)) {
return result;
}
}
result = segment;
segment = nextSegment;
}
return result;
}
/**
* Tests whether the given domain matches any of entry from the public suffix list.
*/
public boolean matches(final String domain) {
return matches(domain, null);
}
/**
* Tests whether the given domain matches any of entry from the public suffix list.
*
* @param domain
* @param expectedType expected domain type or {@code null} if any.
* @return {@code true} if the given domain matches any of the public suffixes.
*
* @since 4.5
*/
public boolean matches(final String domain, final DomainType expectedType) {
if (domain == null) {
return false;
}
final String domainRoot = getDomainRoot(
domain.startsWith(".") ? domain.substring(1) : domain, expectedType);
return domainRoot == null;
}
}