google-nomulus/java/google/registry/flows/domain/DomainDeleteFlow.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 com.google.common.base.Preconditions.checkNotNull;
import static google.registry.flows.domain.DomainFlowUtils.checkAllowedAccessToTld;
import static google.registry.flows.domain.DomainFlowUtils.updateAutorenewRecurrenceEndTime;
import static google.registry.model.eppoutput.Result.Code.Success;
import static google.registry.model.eppoutput.Result.Code.SuccessWithActionPending;
import static google.registry.model.ofy.ObjectifyService.ofy;
import static google.registry.pricing.PricingEngineProxy.getDomainRenewCost;
import static google.registry.util.CollectionUtils.nullToEmpty;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.googlecode.objectify.Key;
import google.registry.dns.DnsQueue;
import google.registry.flows.EppException;
import google.registry.flows.EppException.AssociationProhibitsOperationException;
import google.registry.flows.ResourceSyncDeleteFlow;
import google.registry.model.billing.BillingEvent;
import google.registry.model.common.TimeOfYear;
import google.registry.model.domain.DomainCommand.Delete;
import google.registry.model.domain.DomainResource;
import google.registry.model.domain.DomainResource.Builder;
import google.registry.model.domain.GracePeriod;
import google.registry.model.domain.fee.Credit;
import google.registry.model.domain.fee.FeeTransformResponseExtension;
import google.registry.model.domain.fee06.FeeDeleteResponseExtensionV06;
import google.registry.model.domain.fee11.FeeDeleteResponseExtensionV11;
import google.registry.model.domain.fee12.FeeDeleteResponseExtensionV12;
import google.registry.model.domain.rgp.GracePeriodStatus;
import google.registry.model.domain.secdns.SecDnsUpdateExtension;
import google.registry.model.eppcommon.ProtocolDefinition.ServiceExtension;
import google.registry.model.eppcommon.StatusValue;
import google.registry.model.eppoutput.EppResponse.ResponseExtension;
import google.registry.model.eppoutput.Result.Code;
import google.registry.model.poll.PendingActionNotificationResponse.DomainPendingActionNotificationResponse;
import google.registry.model.poll.PollMessage;
import google.registry.model.registry.Registry;
import google.registry.model.reporting.HistoryEntry;
import java.util.Set;
import javax.annotation.Nullable;
import javax.inject.Inject;
import org.joda.money.CurrencyUnit;
import org.joda.money.Money;
import org.joda.time.DateTime;

/**
 * An EPP flow that deletes a domain resource.
 *
 * @error {@link google.registry.flows.ResourceCreateOrMutateFlow.OnlyToolCanPassMetadataException}
 * @error {@link google.registry.flows.domain.DomainFlowUtils.NotAuthorizedForTldException}
 * @error {@link google.registry.flows.ResourceFlowUtils.ResourceNotOwnedException}
 * @error {@link google.registry.flows.ResourceMutateFlow.ResourceToMutateDoesNotExistException}
 * @error {@link google.registry.flows.SingleResourceFlow.ResourceStatusProhibitsOperationException}
 * @error {@link DomainDeleteFlow.DomainToDeleteHasHostsException}
 */
public class DomainDeleteFlow extends ResourceSyncDeleteFlow<DomainResource, Builder, Delete> {

  PollMessage.OneTime deletePollMessage;

  CurrencyUnit creditsCurrencyUnit;

  ImmutableList<Credit> credits;

  @Inject DomainDeleteFlow() {}

  @Override
  protected void initResourceCreateOrMutateFlow() throws EppException {
    registerExtensions(SecDnsUpdateExtension.class);
  }

  @Override
  protected final void verifyMutationOnOwnedResourceAllowed() throws EppException {
    checkRegistryStateForTld(existingResource.getTld());
    checkAllowedAccessToTld(getAllowedTlds(), existingResource.getTld());
    if (!existingResource.getSubordinateHosts().isEmpty()) {
      throw new DomainToDeleteHasHostsException();
    }
  }

  @Override
  protected final void setDeleteProperties(Builder builder) {
    // Only set to PENDING_DELETE if this domain is not in the Add Grace Period. If domain is in Add
    // Grace Period, we delete it immediately.
    // The base class code already handles the immediate delete case, so we only have to handle the
    // pending delete case here.
    if (!existingResource.getGracePeriodStatuses().contains(GracePeriodStatus.ADD)) {
      Registry registry = Registry.get(existingResource.getTld());
      // By default, this should be 30 days of grace, and 5 days of pending delete. */
      DateTime deletionTime = now
          .plus(registry.getRedemptionGracePeriodLength())
          .plus(registry.getPendingDeleteLength());
      deletePollMessage = new PollMessage.OneTime.Builder()
          .setClientId(existingResource.getCurrentSponsorClientId())
          .setEventTime(deletionTime)
          .setMsg("Domain deleted.")
          .setResponseData(ImmutableList.of(DomainPendingActionNotificationResponse.create(
              existingResource.getFullyQualifiedDomainName(), true, trid, deletionTime)))
          .setParent(historyEntry)
          .build();
      builder.setStatusValues(ImmutableSet.of(StatusValue.PENDING_DELETE))
          .setDeletionTime(deletionTime)
          // Clear out all old grace periods and add REDEMPTION, which does not include a key to a
          // billing event because there isn't one for a domain delete.
          .setGracePeriods(ImmutableSet.of(GracePeriod.createWithoutBillingEvent(
              GracePeriodStatus.REDEMPTION,
              now.plus(registry.getRedemptionGracePeriodLength()),
              getClientId())))
          .setDeletePollMessage(Key.create(deletePollMessage));
    }
  }

  @Override
  protected final void enqueueTasks() {
    DnsQueue.create().addDomainRefreshTask(existingResource.getFullyQualifiedDomainName());
  }

  @Override
  protected final void modifySyncDeleteRelatedResources() {
    // Cancel any grace periods that were still active.
    ImmutableList.Builder<Credit> creditsBuilder = new ImmutableList.Builder<>();
    for (GracePeriod gracePeriod : existingResource.getGracePeriods()) {
      // No cancellation is written if the grace period was not for a billable event.
      if (gracePeriod.hasBillingEvent()) {
        ofy().save().entity(
            BillingEvent.Cancellation.forGracePeriod(gracePeriod, historyEntry, targetId));

        Money cost;
        if (gracePeriod.getType() == GracePeriodStatus.AUTO_RENEW) {
          TimeOfYear recurrenceTimeOfYear =
              ofy().load().key(checkNotNull(gracePeriod.getRecurringBillingEvent())).now()
                  .getRecurrenceTimeOfYear();
          DateTime autoRenewTime = recurrenceTimeOfYear.getLastInstanceBeforeOrAt(now);
          cost = getDomainRenewCost(targetId, autoRenewTime, 1);
        } else {
          cost =
              ofy().load().key(checkNotNull(gracePeriod.getOneTimeBillingEvent())).now().getCost();
        }
        creditsBuilder.add(Credit.create(
            cost.negated().getAmount(),
            String.format("%s credit", gracePeriod.getType().getXmlName())));
        creditsCurrencyUnit = cost.getCurrencyUnit();
      }
    }
    credits = creditsBuilder.build();

    // If the delete isn't immediate, save the poll message for when the delete will happen.
    if (deletePollMessage != null) {
      ofy().save().entity(deletePollMessage);
    }
    // Close the autorenew billing event and poll message. This may delete the poll message.
    updateAutorenewRecurrenceEndTime(existingResource, now);

    // If there's a pending transfer, the gaining client's autorenew billing
    // event and poll message will already have been deleted in
    // ResourceDeleteFlow since it's listed in serverApproveEntities.
  }

  @Override
  protected final Code getDeleteResultCode() {
    return newResource.getDeletionTime().isAfter(now)
        ? SuccessWithActionPending : Success;
  }

  @Nullable
  private FeeTransformResponseExtension.Builder getDeleteResponseBuilder() {
    Set<String> uris = nullToEmpty(sessionMetadata.getServiceExtensionUris());
    if (uris.contains(ServiceExtension.FEE_0_12.getUri())) {
      return new FeeDeleteResponseExtensionV12.Builder();
    }
    if (uris.contains(ServiceExtension.FEE_0_11.getUri())) {
      return new FeeDeleteResponseExtensionV11.Builder();
    }
    if (uris.contains(ServiceExtension.FEE_0_6.getUri())) {
      return new FeeDeleteResponseExtensionV06.Builder();
    }
    return null;
  }

  @Override
  @Nullable
  protected final ImmutableList<? extends ResponseExtension> getDeleteResponseExtensions() {
    if (credits.isEmpty()) {
      return null;
    }
    FeeTransformResponseExtension.Builder feeResponseBuilder = getDeleteResponseBuilder();
    if (feeResponseBuilder == null) {
      return null;
    }
    return ImmutableList.of(feeResponseBuilder
        .setCurrency(checkNotNull(creditsCurrencyUnit))
        .setCredits(credits)
        .build());
  }

  @Override
  protected final HistoryEntry.Type getHistoryEntryType() {
    return HistoryEntry.Type.DOMAIN_DELETE;
  }

  /** Domain to be deleted has subordinate hosts. */
  static class DomainToDeleteHasHostsException extends AssociationProhibitsOperationException {
    public DomainToDeleteHasHostsException() {
      super("Domain to be deleted has subordinate hosts");
    }
  }
}