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

// Copyright 2017 The Nomulus 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 com.google.common.collect.Sets.union;
import static google.registry.flows.FlowUtils.unmarshalEpp;
import static google.registry.flows.FlowUtils.validateClientIsLoggedIn;
import static google.registry.flows.ResourceFlowUtils.verifyExistence;
import static google.registry.flows.ResourceFlowUtils.verifyOptionalAuthInfo;
import static google.registry.flows.ResourceFlowUtils.verifyResourceOwnership;
import static google.registry.flows.domain.DomainFlowUtils.addSecDnsExtensionIfPresent;
import static google.registry.flows.domain.DomainFlowUtils.loadForeignKeyedDesignatedContacts;
import static google.registry.flows.domain.DomainFlowUtils.verifyApplicationDomainMatchesTargetId;
import static google.registry.model.EppResourceUtils.loadDomainApplication;
import static google.registry.model.ofy.ObjectifyService.ofy;

import com.google.common.collect.ImmutableList;
import google.registry.flows.EppException;
import google.registry.flows.EppException.ParameterValuePolicyErrorException;
import google.registry.flows.EppException.RequiredParameterMissingException;
import google.registry.flows.ExtensionManager;
import google.registry.flows.Flow;
import google.registry.flows.FlowModule.ApplicationId;
import google.registry.flows.FlowModule.ClientId;
import google.registry.flows.FlowModule.TargetId;
import google.registry.flows.annotations.ReportingSpec;
import google.registry.model.domain.DomainApplication;
import google.registry.model.domain.DomainCommand.Info;
import google.registry.model.domain.DomainInfoData;
import google.registry.model.domain.launch.LaunchInfoExtension;
import google.registry.model.domain.launch.LaunchInfoResponseExtension;
import google.registry.model.eppcommon.AuthInfo;
import google.registry.model.eppinput.EppInput;
import google.registry.model.eppinput.ResourceCommand;
import google.registry.model.eppoutput.EppResponse;
import google.registry.model.eppoutput.EppResponse.ResponseExtension;
import google.registry.model.mark.Mark;
import google.registry.model.reporting.IcannReportingTypes.ActivityReportField;
import google.registry.model.smd.EncodedSignedMark;
import google.registry.model.smd.SignedMark;
import google.registry.util.Clock;
import java.util.Optional;
import javax.inject.Inject;

/**
 * An EPP flow that returns information about a domain application.
 *
 * <p>Only the registrar that owns the application can see its info. The flow can optionally include
 * delegated hosts in its response.
 *
 * @error {@link google.registry.flows.ResourceFlowUtils.ResourceDoesNotExistException}
 * @error {@link google.registry.flows.ResourceFlowUtils.ResourceNotOwnedException}
 * @error {@link DomainFlowUtils.ApplicationDomainNameMismatchException}
 * @error {@link DomainApplicationInfoFlow.ApplicationLaunchPhaseMismatchException}
 * @error {@link MissingApplicationIdException}
 */
@ReportingSpec(ActivityReportField.DOMAIN_INFO) // Applications are technically domains in EPP.
public final class DomainApplicationInfoFlow implements Flow {

  @Inject ResourceCommand resourceCommand;
  @Inject ExtensionManager extensionManager;
  @Inject EppInput eppInput;
  @Inject Optional<AuthInfo> authInfo;
  @Inject @ClientId String clientId;
  @Inject @TargetId String targetId;
  @Inject @ApplicationId String applicationId;
  @Inject Clock clock;
  @Inject EppResponse.Builder responseBuilder;
  @Inject DomainApplicationInfoFlow() {}

  @Override
  public final EppResponse run() throws EppException {
    extensionManager.register(LaunchInfoExtension.class);
    extensionManager.validate();
    validateClientIsLoggedIn(clientId);
    if (applicationId.isEmpty()) {
      throw new MissingApplicationIdException();
    }
    DomainApplication application =
        verifyExistence(
            DomainApplication.class,
            applicationId,
            loadDomainApplication(applicationId, clock.nowUtc()));
    verifyApplicationDomainMatchesTargetId(application, targetId);
    verifyOptionalAuthInfo(authInfo, application);
    LaunchInfoExtension launchInfo = eppInput.getSingleExtension(LaunchInfoExtension.class).get();
    if (!application.getPhase().equals(launchInfo.getPhase())) {
      throw new ApplicationLaunchPhaseMismatchException();
    }
    // We don't support authInfo for applications, so if it's another registrar always fail.
    verifyResourceOwnership(clientId, application);
    boolean showDelegatedHosts = ((Info) resourceCommand).getHostsRequest().requestDelegated();
    // Prefetch all referenced resources. Calling values() blocks until loading is done.
    ofy().load()
        .values(union(application.getNameservers(), application.getReferencedContacts())).values();
    return responseBuilder
        .setResData(DomainInfoData.newBuilder()
            .setFullyQualifiedDomainName(application.getFullyQualifiedDomainName())
            .setRepoId(application.getRepoId())
            .setStatusValues(application.getStatusValues())
            .setRegistrant(
                ofy().load().key(application.getRegistrant()).now().getContactId())
            .setContacts(loadForeignKeyedDesignatedContacts(application.getContacts()))
            .setNameservers(showDelegatedHosts
                ? application.loadNameserverFullyQualifiedHostNames()
                : null)
            .setCurrentSponsorClientId(application.getCurrentSponsorClientId())
            .setCreationClientId(application.getCreationClientId())
            .setCreationTime(application.getCreationTime())
            .setLastEppUpdateClientId(application.getLastEppUpdateClientId())
            .setLastEppUpdateTime(application.getLastEppUpdateTime())
            .setAuthInfo(application.getAuthInfo())
            .build())
        .setExtensions(getDomainResponseExtensions(application, launchInfo))
        .build();
  }

  ImmutableList<ResponseExtension> getDomainResponseExtensions(
      DomainApplication application, LaunchInfoExtension launchInfo) {
    ImmutableList.Builder<Mark> marksBuilder = new ImmutableList.Builder<>();
    if (Boolean.TRUE.equals(launchInfo.getIncludeMark())) {  // Default to false.
      for (EncodedSignedMark encodedMark : application.getEncodedSignedMarks()) {
        try {
          marksBuilder.add(unmarshalEpp(SignedMark.class, encodedMark.getBytes()).getMark());
        } catch (EppException e) {
          // This is a serious error; don't let the benign EppException propagate.
          throw new IllegalStateException("Could not decode a stored encoded signed mark", e);
        }
      }
    }
    ImmutableList.Builder<ResponseExtension> extensions = new ImmutableList.Builder<>();
    extensions.add(new LaunchInfoResponseExtension.Builder()
        .setPhase(application.getPhase())
        .setApplicationId(application.getForeignKey())
        .setApplicationStatus(application.getApplicationStatus())
        .setMarks(marksBuilder.build())
        .build());
    addSecDnsExtensionIfPresent(extensions, application.getDsData());
    return extensions.build();
  }

  /** Application id is required. */
  static class MissingApplicationIdException extends RequiredParameterMissingException {
    public MissingApplicationIdException() {
      super("Application id is required");
    }
  }

  /** Declared launch extension phase does not match phase of the application. */
  static class ApplicationLaunchPhaseMismatchException extends ParameterValuePolicyErrorException {
    public ApplicationLaunchPhaseMismatchException() {
      super("Declared launch extension phase does not match the phase of the application");
    }
  }
}