ProxyServer.java

/*
 * Copyright 2010 Ning, Inc.
 *
 * This program is licensed 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.
 *
 */
package org.asynchttpclient.proxy;

import io.netty.resolver.AddressResolverGroup;
import org.asynchttpclient.Realm;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import static org.asynchttpclient.util.Assertions.assertNotNull;
import static org.asynchttpclient.util.MiscUtils.isNonEmpty;

/**
 * Represents a proxy server.
 */
public class ProxyServer {

  private final String host;
  private final int port;
  private final int securedPort;
  private final Realm realm;
  private final List<String> nonProxyHosts;
  private final ProxyType proxyType;
  private AddressResolverGroup addressResolverGroup;
  // server can resolve domain in socks 5

  public ProxyServer(String host, int port, int securedPort, Realm realm, List<String> nonProxyHosts,
                     ProxyType proxyType) {
    this.host = host;
    this.port = port;
    this.securedPort = securedPort;
    this.realm = realm;
    this.nonProxyHosts = nonProxyHosts;
    this.proxyType = proxyType;
  }

  public ProxyServer(String host, int port, int securedPort, Realm realm, List<String> nonProxyHosts,
                     ProxyType proxyType, AddressResolverGroup addressResolverGroup) {
    this(host, port, securedPort, realm, nonProxyHosts, proxyType);
    this.addressResolverGroup = addressResolverGroup;
  }

  public String getHost() {
    return host;
  }

  public int getPort() {
    return port;
  }

  public int getSecuredPort() {
    return securedPort;
  }

  public List<String> getNonProxyHosts() {
    return nonProxyHosts;
  }

  public Realm getRealm() {
    return realm;
  }

  public ProxyType getProxyType() {
    return proxyType;
  }

  public AddressResolverGroup getAddressResolverGroup() {
    return addressResolverGroup;
  }

  public boolean isResolveDomain() {
    return addressResolverGroup != null;
  }

  /**
   * Checks whether proxy should be used according to nonProxyHosts settings of
   * it, or we want to go directly to target host. If <code>null</code> proxy is
   * passed in, this method returns true -- since there is NO proxy, we should
   * avoid to use it. Simple hostname pattern matching using "*" are supported,
   * but only as prefixes.
   *
   * @param hostname the hostname
   * @return true if we have to ignore proxy use (obeying non-proxy hosts
   * settings), false otherwise.
   * @see <a href=
   * "https://docs.oracle.com/javase/8/docs/api/java/net/doc-files/net-properties.html">Networking
   * Properties</a>
   */
  public boolean isIgnoredForHost(String hostname) {
    assertNotNull(hostname, "hostname");
    if (isNonEmpty(nonProxyHosts)) {
      for (String nonProxyHost : nonProxyHosts) {
        if (matchNonProxyHost(hostname, nonProxyHost))
          return true;
      }
    }

    return false;
  }

  private boolean matchNonProxyHost(String targetHost, String nonProxyHost) {

    if (nonProxyHost.length() > 1) {
      if (nonProxyHost.charAt(0) == '*') {
        return targetHost.regionMatches(true, targetHost.length() - nonProxyHost.length() + 1, nonProxyHost, 1,
                nonProxyHost.length() - 1);
      } else if (nonProxyHost.charAt(nonProxyHost.length() - 1) == '*')
        return targetHost.regionMatches(true, 0, nonProxyHost, 0, nonProxyHost.length() - 1);
    }

    return nonProxyHost.equalsIgnoreCase(targetHost);
  }

  public static class Builder {

    private String host;
    private int port;
    private int securedPort;
    private Realm realm;
    private List<String> nonProxyHosts;
    private ProxyType proxyType;
    private AddressResolverGroup addressResolverGroup;

    public Builder(String host, int port) {
      this.host = host;
      this.port = port;
      this.securedPort = port;
    }

    public Builder setSecuredPort(int securedPort) {
      this.securedPort = securedPort;
      return this;
    }

    public Builder setRealm(Realm realm) {
      this.realm = realm;
      return this;
    }

    public Builder setRealm(Realm.Builder realm) {
      this.realm = realm.build();
      return this;
    }

    public Builder setNonProxyHost(String nonProxyHost) {
      if (nonProxyHosts == null)
        nonProxyHosts = new ArrayList<>(1);
      nonProxyHosts.add(nonProxyHost);
      return this;
    }

    public Builder setNonProxyHosts(List<String> nonProxyHosts) {
      this.nonProxyHosts = nonProxyHosts;
      return this;
    }

    public Builder setProxyType(ProxyType proxyType) {
      this.proxyType = proxyType;
      return this;
    }

    public Builder setAddressResolverGroup(AddressResolverGroup addressResolverGroup) {
      this.addressResolverGroup = addressResolverGroup;
      return this;
    }

    public ProxyServer build() {
      List<String> nonProxyHosts = this.nonProxyHosts != null ? Collections.unmodifiableList(this.nonProxyHosts)
              : Collections.emptyList();
      ProxyType proxyType = this.proxyType != null ? this.proxyType : ProxyType.HTTP;
      return new ProxyServer(host, port, securedPort, realm, nonProxyHosts, proxyType, this.addressResolverGroup);
    }
  }
}