/*
    * ====================================================================
    * 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
   * <http://www.apache.org/>.
   *
   */
  package org.apache.hc.client5.http.auth;
  
  import java.util.Locale;
  import java.util.Objects;
  
  import org.apache.hc.core5.annotation.Contract;
  import org.apache.hc.core5.annotation.ThreadingBehavior;
  import org.apache.hc.core5.http.HttpHost;
  import org.apache.hc.core5.util.Args;
  import org.apache.hc.core5.util.LangUtils;
  
  /**
   * {@code AuthScope} represents an authentication scope consisting of
   * an application protocol, a host name, a port number, a realm name
   * and an authentication scheme name.
   *
   * @since 4.0
   */
  @Contract(threading = ThreadingBehavior.IMMUTABLE)
  public class AuthScope {
  
      private final String protocol;
      private final String host;
      private final int port;
      private final String realm;
      private final String schemeName;
  
      /**
       * Defines auth scope with the given {@code protocol}, {@code host}, {@code port},
       * {@code realm}, and {@code schemeName}.
       *
       * @param protocol application protocol. May be {@code null} if applies
       *   to any protocol.
       * @param host authentication host. May be {@code null} if applies
       *   to any host.
       * @param port authentication port. May be {@code -1} if applies
       *   to any port of the host.
       * @param realm authentication realm. May be {@code null} if applies
       *   to any realm on the host.
       * @param schemeName authentication scheme name. May be {@code null} if applies
       *   to any auth scheme supported by the host.
       */
      public AuthScope(
              final String protocol,
              final String host,
              final int port,
              final String realm,
              final String schemeName) {
          this.protocol = protocol != null ? protocol.toLowerCase(Locale.ROOT) : null;
          this.host = host != null ? host.toLowerCase(Locale.ROOT) : null;
          this.port = port >= 0 ? port: -1;
          this.realm = realm;
          this.schemeName = schemeName != null ? schemeName.toUpperCase(Locale.ROOT) : null;
      }
  
      /**
       * Defines auth scope for a specific host of origin.
       *
       * @param origin host of origin
       * @param realm authentication realm. May be {@code null} if applies
       *   to any realm on the host.
       * @param schemeName authentication scheme name. May be {@code null} if applies
       *   to any auth scheme supported by the host.
       *
       * @since 4.2
       */
      public AuthScope(
              final HttpHost origin,
              final String realm,
              final String schemeName) {
          Args.notNull(origin, "Host");
          this.protocol = origin.getSchemeName().toLowerCase(Locale.ROOT);
          this.host = origin.getHostName().toLowerCase(Locale.ROOT);
         this.port = origin.getPort() >= 0 ? origin.getPort() : -1;
         this.realm = realm;
         this.schemeName = schemeName != null ? schemeName.toUpperCase(Locale.ROOT) : null;
     }
 
     /**
      * Defines auth scope for a specific host of origin.
      *
      * @param origin host of origin
      *
      * @since 4.2
      */
     public AuthScope(final HttpHost origin) {
         this(origin, null, null);
     }
 
     /**
      * Defines auth scope with the given {@code host} and {@code port}.
      *
      * @param host authentication host. May be {@code null} if applies
      *   to any host.
      * @param port authentication port. May be {@code -1} if applies
      *   to any port of the host.
      */
     public AuthScope(final String host, final int port) {
         this(null, host, port, null, null);
     }
 
     /**
      * Creates a copy of the given credentials scope.
      */
     public AuthScope(final AuthScope authScope) {
         super();
         Args.notNull(authScope, "Scope");
         this.protocol = authScope.getProtocol();
         this.host = authScope.getHost();
         this.port = authScope.getPort();
         this.realm = authScope.getRealm();
         this.schemeName = authScope.getSchemeName();
     }
 
     public String getProtocol() {
         return protocol;
     }
 
     public String getHost() {
         return this.host;
     }
 
     public int getPort() {
         return this.port;
     }
 
     public String getRealm() {
         return this.realm;
     }
 
     public String getSchemeName() {
         return this.schemeName;
     }
 
     /**
      * Tests if the authentication scopes match.
      *
      * @return the match factor. Negative value signifies no match.
      *    Non-negative signifies a match. The greater the returned value
      *    the closer the match.
      */
     public int match(final AuthScope that) {
         int factor = 0;
         if (Objects.equals(this.schemeName, that.schemeName)) {
             factor += 1;
         } else {
             if (this.schemeName != null && that.schemeName != null) {
                 return -1;
             }
         }
         if (Objects.equals(this.realm, that.realm)) {
             factor += 2;
         } else {
             if (this.realm != null && that.realm != null) {
                 return -1;
             }
         }
         if (this.port == that.port) {
             factor += 4;
         } else {
             if (this.port != -1 && that.port != -1) {
                 return -1;
             }
         }
         if (Objects.equals(this.protocol, that.protocol)) {
             factor += 8;
         } else {
             if (this.protocol != null && that.protocol != null) {
                 return -1;
             }
         }
         if (Objects.equals(this.host, that.host)) {
             factor += 16;
         } else {
             if (this.host != null && that.host != null) {
                 return -1;
             }
         }
         return factor;
     }
 
     @Override
     public boolean equals(final Object obj) {
         if (this == obj) {
             return true;
         }
         if (obj instanceof AuthScope) {
             final AuthScope that = (AuthScope) obj;
             return Objects.equals(this.protocol, that.protocol)
                     && Objects.equals(this.host, that.host)
                     && this.port == that.port
                     && Objects.equals(this.realm, that.realm)
                     && Objects.equals(this.schemeName, that.schemeName);
         }
         return false;
     }
 
     @Override
     public int hashCode() {
         int hash = LangUtils.HASH_SEED;
         hash = LangUtils.hashCode(hash, this.protocol);
         hash = LangUtils.hashCode(hash, this.host);
         hash = LangUtils.hashCode(hash, this.port);
         hash = LangUtils.hashCode(hash, this.realm);
         hash = LangUtils.hashCode(hash, this.schemeName);
         return hash;
     }
 
     @Override
     public String toString() {
         final StringBuilder buffer = new StringBuilder();
         if (this.schemeName != null) {
             buffer.append(this.schemeName);
         } else {
             buffer.append("<any auth scheme>");
         }
         buffer.append(' ');
         if (this.realm != null) {
             buffer.append('\'');
             buffer.append(this.realm);
             buffer.append('\'');
         } else {
             buffer.append("<any realm>");
         }
         buffer.append(' ');
         if (this.protocol != null) {
             buffer.append(this.protocol);
         } else {
             buffer.append("<any protocol>");
         }
         buffer.append("://");
         if (this.host != null) {
             buffer.append(this.host);
         } else {
             buffer.append("<any host>");
         }
         buffer.append(':');
         if (this.port >= 0) {
             buffer.append(this.port);
         } else {
             buffer.append("<any port>");
         }
         return buffer.toString();
     }
 
 }