google-nomulus/java/google/registry/flows/domain/DomainInfoFlow.java

// Copyright 2016 The Domain Registry Authors. All Rights Reserved.
//
// Licensed 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 google.registry.flows.domain;

import static google.registry.flows.ResourceFlowUtils.loadAndVerifyExistence;
import static google.registry.flows.ResourceFlowUtils.verifyOptionalAuthInfoForResource;
import static google.registry.flows.domain.DomainFlowUtils.addSecDnsExtensionIfPresent;
import static google.registry.flows.domain.DomainFlowUtils.handleFeeRequest;
import static google.registry.model.eppoutput.Result.Code.SUCCESS;
import static google.registry.util.CollectionUtils.forceEmptyToNull;

import com.google.common.base.Optional;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.google.common.net.InternetDomainName;
import google.registry.flows.EppException;
import google.registry.flows.FlowModule.ClientId;
import google.registry.flows.FlowModule.TargetId;
import google.registry.flows.LoggedInFlow;
import google.registry.model.domain.DomainCommand.Info;
import google.registry.model.domain.DomainCommand.Info.HostsRequest;
import google.registry.model.domain.DomainResource;
import google.registry.model.domain.DomainResource.Builder;
import google.registry.model.domain.fee06.FeeInfoCommandExtensionV06;
import google.registry.model.domain.fee06.FeeInfoResponseExtensionV06;
import google.registry.model.domain.flags.FlagsInfoResponseExtension;
import google.registry.model.domain.rgp.GracePeriodStatus;
import google.registry.model.domain.rgp.RgpInfoExtension;
import google.registry.model.eppcommon.AuthInfo;
import google.registry.model.eppinput.ResourceCommand;
import google.registry.model.eppoutput.EppOutput;
import google.registry.model.eppoutput.EppResponse.ResponseExtension;
import java.util.List;
import javax.inject.Inject;

/**
 * An EPP flow that returns information about a domain.
 *
 * <p>The registrar that owns the domain, and any registrar presenting a valid authInfo for the
 * domain, will get a rich result with all of the domain's fields. All other requests will be
 * answered with a minimal result containing only basic information about the domain.
 *
 * @error {@link google.registry.flows.ResourceFlowUtils.BadAuthInfoForResourceException}
 * @error {@link google.registry.flows.ResourceFlowUtils.ResourceDoesNotExistException}
 * @error {@link DomainFlowUtils.BadPeriodUnitException}
 * @error {@link DomainFlowUtils.CurrencyUnitMismatchException}
 * @error {@link DomainFlowUtils.FeeChecksDontSupportPhasesException}
 * @error {@link DomainFlowUtils.RestoresAreAlwaysForOneYearException}
 */
public final class DomainInfoFlow extends LoggedInFlow {

  @Inject Optional<AuthInfo> authInfo;
  @Inject @ClientId String clientId;
  @Inject @TargetId String targetId;
  @Inject ResourceCommand resourceCommand;
  @Inject DomainInfoFlow() {}

  @Override
  protected void initLoggedInFlow() throws EppException {
    registerExtensions(FeeInfoCommandExtensionV06.class);
  }

  @Override
  public final EppOutput run() throws EppException {
    DomainResource domain = loadAndVerifyExistence(DomainResource.class, targetId, now);
    verifyOptionalAuthInfoForResource(authInfo, domain);
    return createOutput(
        SUCCESS,
        getResourceInfo(domain),
        getDomainResponseExtensions(domain));
  }

  private DomainResource getResourceInfo(DomainResource domain) {
    // If authInfo is non-null, then the caller is authorized to see the full information since we
    // will have already verified the authInfo is valid.
    if (!(clientId.equals(domain.getCurrentSponsorClientId()) || authInfo.isPresent())) {
      // Registrars can only see a few fields on unauthorized domains.
      // This is a policy decision that is left up to us by the rfcs.
      return new DomainResource.Builder()
          .setFullyQualifiedDomainName(domain.getFullyQualifiedDomainName())
          .setRepoId(domain.getRepoId())
          .setCurrentSponsorClientId(domain.getCurrentSponsorClientId())
          .setRegistrant(domain.getRegistrant())
          // If we didn't do this, we'd get implicit status values.
          .buildWithoutImplicitStatusValues();
    }
    HostsRequest hostsRequest = ((Info) resourceCommand).getHostsRequest();
    Builder info = domain.asBuilder();
    if (!hostsRequest.requestSubordinate()) {
      info.setSubordinateHosts(null);
    }
    if (!hostsRequest.requestDelegated()) {
      // Delegated hosts are present by default, so clear them out if they aren't wanted.
      // This requires overriding the implicit status values so that we don't get INACTIVE added due
      // to the missing nameservers.
      return info.setNameservers(null).buildWithoutImplicitStatusValues();
    }
    return info.build();
  }

  private ImmutableList<ResponseExtension> getDomainResponseExtensions(DomainResource domain)
      throws EppException {
    ImmutableList.Builder<ResponseExtension> extensions = new ImmutableList.Builder<>();
    addSecDnsExtensionIfPresent(extensions, domain.getDsData());
    ImmutableSet<GracePeriodStatus> gracePeriodStatuses = domain.getGracePeriodStatuses();
    if (!gracePeriodStatuses.isEmpty()) {
      extensions.add(RgpInfoExtension.create(gracePeriodStatuses));
    }
    FeeInfoCommandExtensionV06 feeInfo =
        eppInput.getSingleExtension(FeeInfoCommandExtensionV06.class);
    if (feeInfo != null) {  // Fee check was requested.
      FeeInfoResponseExtensionV06.Builder builder = new FeeInfoResponseExtensionV06.Builder();
      handleFeeRequest(
          feeInfo,
          builder,
          InternetDomainName.from(targetId),
          clientId,
          null,
          now,
          eppInput);
      extensions.add(builder.build());
    }
    // If the TLD uses the flags extension, add it to the info response.
    Optional<RegistryExtraFlowLogic> extraLogicManager =
        RegistryExtraFlowLogicProxy.newInstanceForDomain(domain);
    if (extraLogicManager.isPresent()) {
      List<String> flags = extraLogicManager.get().getExtensionFlags(
          domain, clientId, now); // As-of date is always now for info commands.
      if (!flags.isEmpty()) {
        extensions.add(FlagsInfoResponseExtension.create(flags));
      }
    }
    return forceEmptyToNull(extensions.build());
  }
}