mirror of
https://github.com/google/nomulus.git
synced 2025-07-22 18:55:58 +02:00
d2ee63cf69
There was no reason to have several different modules all providing a single thing. This approach, which creates a single UtilsModule for everything in the util package, is cleaner. This also removes provisioning of Random and StringGenerator objects in RegistryConfig.ConfigModule, which don't belong there because they aren't configuration options. This also removes insecure random entirely; it was only used in a single place to generate 24 bytes a couple times per day. We can live with the lower speed if it means we don't have to worry about multiple types of Random, or possibly using an insecure random accidentally in a place that security actually does matter. ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=229751915
292 lines
12 KiB
Java
292 lines
12 KiB
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.rde.imports;
|
|
|
|
import static google.registry.flows.domain.DomainTransferUtils.createLosingTransferPollMessage;
|
|
import static google.registry.flows.domain.DomainTransferUtils.createPendingTransferData;
|
|
import static google.registry.flows.domain.DomainTransferUtils.createTransferServerApproveEntities;
|
|
import static google.registry.mapreduce.MapreduceRunner.PARAM_MAP_SHARDS;
|
|
import static google.registry.model.domain.DomainResource.extendRegistrationWithCap;
|
|
import static google.registry.model.ofy.ObjectifyService.ofy;
|
|
import static google.registry.pricing.PricingEngineProxy.getDomainRenewCost;
|
|
import static google.registry.rde.imports.RdeImportUtils.createAutoRenewBillingEventForDomainImport;
|
|
import static google.registry.rde.imports.RdeImportUtils.createAutoRenewPollMessageForDomainImport;
|
|
import static google.registry.rde.imports.RdeImportUtils.createHistoryEntryForDomainImport;
|
|
import static google.registry.rde.imports.RdeImportsModule.PATH;
|
|
import static google.registry.util.PreconditionsUtils.checkArgumentNotNull;
|
|
|
|
import com.google.appengine.tools.cloudstorage.GcsService;
|
|
import com.google.appengine.tools.cloudstorage.GcsServiceFactory;
|
|
import com.google.appengine.tools.cloudstorage.RetryParams;
|
|
import com.google.appengine.tools.mapreduce.Mapper;
|
|
import com.google.common.collect.ImmutableList;
|
|
import com.google.common.collect.ImmutableSet;
|
|
import com.google.common.flogger.FluentLogger;
|
|
import google.registry.config.RegistryConfig.Config;
|
|
import google.registry.config.RegistryConfig.ConfigModule;
|
|
import google.registry.dns.DnsQueue;
|
|
import google.registry.gcs.GcsUtils;
|
|
import google.registry.mapreduce.MapreduceRunner;
|
|
import google.registry.model.billing.BillingEvent;
|
|
import google.registry.model.domain.DomainResource;
|
|
import google.registry.model.domain.Period;
|
|
import google.registry.model.domain.Period.Unit;
|
|
import google.registry.model.domain.rgp.GracePeriodStatus;
|
|
import google.registry.model.poll.PollMessage;
|
|
import google.registry.model.reporting.HistoryEntry;
|
|
import google.registry.model.transfer.TransferData;
|
|
import google.registry.model.transfer.TransferData.TransferServerApproveEntity;
|
|
import google.registry.model.transfer.TransferStatus;
|
|
import google.registry.request.Action;
|
|
import google.registry.request.Parameter;
|
|
import google.registry.request.Response;
|
|
import google.registry.request.auth.Auth;
|
|
import google.registry.util.StringGenerator;
|
|
import google.registry.util.SystemClock;
|
|
import google.registry.xjc.JaxbFragment;
|
|
import google.registry.xjc.rdedomain.XjcRdeDomain;
|
|
import google.registry.xjc.rdedomain.XjcRdeDomainElement;
|
|
import java.util.Optional;
|
|
import javax.inject.Inject;
|
|
import javax.inject.Named;
|
|
import org.joda.money.Money;
|
|
import org.joda.time.DateTime;
|
|
|
|
/**
|
|
* A mapreduce that imports domains from an escrow file.
|
|
*
|
|
* <p>Specify the escrow file to import with the "path" parameter.
|
|
*/
|
|
@Action(
|
|
service = Action.Service.BACKEND,
|
|
path = "/_dr/task/importRdeDomains",
|
|
auth = Auth.AUTH_INTERNAL_ONLY)
|
|
public class RdeDomainImportAction implements Runnable {
|
|
|
|
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
|
|
private static final GcsService GCS_SERVICE =
|
|
GcsServiceFactory.createGcsService(RetryParams.getDefaultInstance());
|
|
|
|
protected final MapreduceRunner mrRunner;
|
|
protected final Response response;
|
|
protected final String importBucketName;
|
|
protected final String importFileName;
|
|
protected final Optional<Integer> mapShards;
|
|
protected final StringGenerator stringGenerator;
|
|
|
|
@Inject
|
|
public RdeDomainImportAction(
|
|
MapreduceRunner mrRunner,
|
|
Response response,
|
|
@Config("rdeImportBucket") String importBucketName,
|
|
@Parameter(PATH) String importFileName,
|
|
@Parameter(PARAM_MAP_SHARDS) Optional<Integer> mapShards,
|
|
@Named("base64StringGenerator") StringGenerator stringGenerator) {
|
|
this.mrRunner = mrRunner;
|
|
this.response = response;
|
|
this.importBucketName = importBucketName;
|
|
this.importFileName = importFileName;
|
|
this.mapShards = mapShards;
|
|
this.stringGenerator = stringGenerator;
|
|
}
|
|
|
|
@Override
|
|
public void run() {
|
|
logger.atInfo().log(
|
|
"Launching domains import mapreduce: bucket=%s, filename=%s",
|
|
this.importBucketName, this.importFileName);
|
|
mrRunner
|
|
.setJobName("Import domains from escrow file")
|
|
.setModuleName("backend")
|
|
.runMapOnly(createMapper(), ImmutableList.of(createInput()))
|
|
.sendLinkToMapreduceConsole(response);
|
|
}
|
|
|
|
/**
|
|
* Creates a new {@link RdeDomainInput}
|
|
*/
|
|
private RdeDomainInput createInput() {
|
|
return new RdeDomainInput(mapShards, importBucketName, importFileName);
|
|
}
|
|
|
|
/**
|
|
* Creates a new {@link RdeDomainImportMapper}
|
|
*/
|
|
private RdeDomainImportMapper createMapper() {
|
|
return new RdeDomainImportMapper(importBucketName, stringGenerator);
|
|
}
|
|
|
|
/** Mapper to import domains from an escrow file. */
|
|
public static class RdeDomainImportMapper
|
|
extends Mapper<JaxbFragment<XjcRdeDomainElement>, Void, Void> {
|
|
|
|
private static final long serialVersionUID = -7645091075256589374L;
|
|
|
|
private final String importBucketName;
|
|
private final StringGenerator stringGenerator;
|
|
private transient RdeImportUtils importUtils;
|
|
private transient DnsQueue dnsQueue;
|
|
|
|
public RdeDomainImportMapper(String importBucketName, StringGenerator stringGenerator) {
|
|
this.importBucketName = importBucketName;
|
|
this.stringGenerator = stringGenerator;
|
|
}
|
|
|
|
private RdeImportUtils getImportUtils() {
|
|
if (importUtils == null) {
|
|
importUtils = createRdeImportUtils();
|
|
}
|
|
return importUtils;
|
|
}
|
|
|
|
private DnsQueue getDnsQueue() {
|
|
if (dnsQueue == null) {
|
|
dnsQueue = DnsQueue.create();
|
|
}
|
|
return dnsQueue;
|
|
}
|
|
|
|
/**
|
|
* Creates a new instance of RdeImportUtils.
|
|
*/
|
|
private RdeImportUtils createRdeImportUtils() {
|
|
return new RdeImportUtils(
|
|
ofy(),
|
|
new SystemClock(),
|
|
importBucketName,
|
|
new GcsUtils(GCS_SERVICE, ConfigModule.provideGcsBufferSize()));
|
|
}
|
|
|
|
@Override
|
|
public void map(JaxbFragment<XjcRdeDomainElement> fragment) {
|
|
final XjcRdeDomain xjcDomain = fragment.getInstance().getValue();
|
|
try {
|
|
// Record number of attempted map operations
|
|
getContext().incrementCounter("domain imports attempted");
|
|
logger.atInfo().log("Saving domain %s", xjcDomain.getName());
|
|
|
|
ofy().transact(() -> saveDomain(xjcDomain));
|
|
|
|
// Record the number of domains imported
|
|
getContext().incrementCounter("domains saved");
|
|
logger.atInfo().log("Domain %s was imported successfully", xjcDomain.getName());
|
|
} catch (ResourceExistsException e) {
|
|
// Record the number of domains already in the registry
|
|
getContext().incrementCounter("existing domains skipped");
|
|
logger.atInfo().log("Domain %s already exists", xjcDomain.getName());
|
|
} catch (Exception e) {
|
|
getContext().incrementCounter("domain import errors");
|
|
logger.atSevere().withCause(e).log(
|
|
"Error processing domain %s; xml=%s", xjcDomain.getName(), xjcDomain);
|
|
}
|
|
}
|
|
|
|
private void saveDomain(XjcRdeDomain xjcDomain) {
|
|
HistoryEntry historyEntry = createHistoryEntryForDomainImport(xjcDomain);
|
|
BillingEvent.Recurring autorenewBillingEvent =
|
|
createAutoRenewBillingEventForDomainImport(xjcDomain, historyEntry);
|
|
PollMessage.Autorenew autorenewPollMessage =
|
|
createAutoRenewPollMessageForDomainImport(xjcDomain, historyEntry);
|
|
DomainResource domain =
|
|
XjcToDomainResourceConverter.convertDomain(
|
|
xjcDomain, autorenewBillingEvent, autorenewPollMessage, stringGenerator);
|
|
getDnsQueue().addDomainRefreshTask(domain.getFullyQualifiedDomainName());
|
|
// Keep a list of "extra objects" that need to be saved along with the domain
|
|
// and add to it if necessary.
|
|
ImmutableSet<Object> extraEntitiesToSave =
|
|
getImportUtils().createIndexesForEppResource(domain);
|
|
// Create speculative server approval entities for pending transfers
|
|
if (domain.getTransferData().getTransferStatus() == TransferStatus.PENDING) {
|
|
TransferData transferData = domain.getTransferData();
|
|
checkArgumentNotNull(
|
|
transferData,
|
|
"Domain %s is in pending transfer but has no transfer data",
|
|
domain.getFullyQualifiedDomainName());
|
|
Money transferCost =
|
|
getDomainRenewCost(
|
|
domain.getFullyQualifiedDomainName(),
|
|
transferData.getPendingTransferExpirationTime(),
|
|
1);
|
|
DateTime automaticTransferTime = transferData.getPendingTransferExpirationTime();
|
|
// If the transfer will occur within the autorenew grace period, it should
|
|
// subsume the autorenew, so we don't add the normal extra year. See the
|
|
// original logic in DomainTransferRequestFlow (which is very similar) for
|
|
// more information. That said, note that here we stop 1 millisecond before
|
|
// the actual transfer time to avoid hitting the transfer-handling part of
|
|
// cloneProjectedAtTime(), since unlike in the DomainTransferRequestFlow case,
|
|
// this domain already has a pending transfer.
|
|
DomainResource domainAtTransferTime =
|
|
domain.cloneProjectedAtTime(automaticTransferTime.minusMillis(1));
|
|
boolean inAutorenewGraceAtTransfer =
|
|
!domainAtTransferTime.getGracePeriodsOfType(GracePeriodStatus.AUTO_RENEW).isEmpty();
|
|
int extraYears = inAutorenewGraceAtTransfer ? 0 : 1;
|
|
// Construct the capped new expiration time.
|
|
DateTime serverApproveNewExpirationTime =
|
|
extendRegistrationWithCap(
|
|
automaticTransferTime,
|
|
domainAtTransferTime.getRegistrationExpirationTime(),
|
|
extraYears);
|
|
// Create speculative entities in anticipation of an automatic server
|
|
// approval.
|
|
ImmutableSet<TransferServerApproveEntity> serverApproveEntities =
|
|
createTransferServerApproveEntities(
|
|
automaticTransferTime,
|
|
serverApproveNewExpirationTime,
|
|
historyEntry,
|
|
domain,
|
|
historyEntry.getTrid(),
|
|
transferData.getGainingClientId(),
|
|
Optional.of(transferCost),
|
|
transferData.getTransferRequestTime());
|
|
transferData =
|
|
createPendingTransferData(
|
|
transferData.asBuilder(), serverApproveEntities, Period.create(1, Unit.YEARS));
|
|
// Create a poll message to notify the losing registrar that a transfer was
|
|
// requested.
|
|
PollMessage requestPollMessage =
|
|
createLosingTransferPollMessage(
|
|
domain.getRepoId(), transferData, serverApproveNewExpirationTime, historyEntry)
|
|
.asBuilder()
|
|
.setEventTime(transferData.getTransferRequestTime())
|
|
.build();
|
|
domain = domain.asBuilder().setTransferData(transferData).build();
|
|
autorenewBillingEvent =
|
|
autorenewBillingEvent
|
|
.asBuilder()
|
|
.setRecurrenceEndTime(transferData.getPendingTransferExpirationTime())
|
|
.build();
|
|
autorenewPollMessage =
|
|
autorenewPollMessage
|
|
.asBuilder()
|
|
.setAutorenewEndTime(transferData.getPendingTransferExpirationTime())
|
|
.build();
|
|
extraEntitiesToSave =
|
|
new ImmutableSet.Builder<>()
|
|
.add(requestPollMessage)
|
|
.addAll(extraEntitiesToSave)
|
|
.addAll(serverApproveEntities)
|
|
.build();
|
|
} // End pending transfer check
|
|
ofy()
|
|
.save()
|
|
.entities(
|
|
new ImmutableSet.Builder<>()
|
|
.add(domain, historyEntry, autorenewBillingEvent, autorenewPollMessage)
|
|
.addAll(extraEntitiesToSave)
|
|
.build())
|
|
.now();
|
|
}
|
|
}
|
|
}
|