net.ripe.rpki.validator.fetchers.RsyncRpkiRepositoryObjectFetcher.java Source code

Introduction

Here is the source code for net.ripe.rpki.validator.fetchers.RsyncRpkiRepositoryObjectFetcher.java

Source

/**
 * The BSD License
 *
 * Copyright (c) 2010-2012 RIPE NCC
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *   - Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *   - Redistributions in binary form must reproduce the above copyright notice,
 *     this list of conditions and the following disclaimer in the documentation
 *     and/or other materials provided with the distribution.
 *   - Neither the name of the RIPE NCC nor the names of its contributors may be
 *     used to endorse or promote products derived from this software without
 *     specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package net.ripe.rpki.validator.fetchers;

import net.ripe.rpki.commons.crypto.CertificateRepositoryObject;
import net.ripe.rpki.commons.crypto.util.CertificateRepositoryObjectFactory;
import net.ripe.rpki.commons.rsync.Rsync;
import net.ripe.rpki.commons.util.Specification;
import net.ripe.rpki.commons.validation.ValidationResult;
import net.ripe.rpki.validator.util.HierarchicalUriCache;
import net.ripe.rpki.validator.util.UriToFileMapper;
import org.apache.commons.io.FileUtils;
import org.apache.log4j.Logger;

import java.io.File;
import java.io.IOException;
import java.net.URI;

import static net.ripe.rpki.commons.validation.ValidationString.*;

public class RsyncRpkiRepositoryObjectFetcher implements RpkiRepositoryObjectFetcher {

    public static final String RSYNC_PREFETCH_VALIDATION_METRIC = "rsync.prefetch";
    public static final String RSYNC_FETCH_FILE_VALIDATION_METRIC = "rsync.fetch.file";

    private static final Logger LOG = Logger.getLogger(RsyncRpkiRepositoryObjectFetcher.class);

    private static final String[] STANDARD_OPTIONS = { "--update", "--times", "--copy-links" };
    private static final String[] PREFETCH_OPTIONS = { "--recursive", "--delete" };
    private static final String[] SINGLE_FILE_OPTIONS = {};

    private final HierarchicalUriCache uriCache;
    private final Rsync rsync;
    private final UriToFileMapper uriToFileMapper;

    public RsyncRpkiRepositoryObjectFetcher(Rsync rsync, UriToFileMapper uriToFileMapper) {
        this.rsync = rsync;
        this.uriToFileMapper = uriToFileMapper;
        this.uriCache = new HierarchicalUriCache();
    }

    @Override
    public CertificateRepositoryObject fetch(URI uri, Specification<byte[]> fileContentSpecification,
            ValidationResult result) {
        byte[] contents = fetchContent(uri, fileContentSpecification, result);

        if (result.hasFailureForCurrentLocation() || contents == null) {
            return null;
        } else {
            return CertificateRepositoryObjectFactory.createCertificateRepositoryObject(contents, result);
        }
    }

    public byte[] fetchContent(URI uri, Specification<byte[]> fileContentSpecification, ValidationResult result) {
        File destinationFile = uriToFileMapper.map(uri, result);
        if (destinationFile == null) {
            return null;
        }

        fetchFile(uri, destinationFile, result);
        if (result.hasFailureForCurrentLocation()) {
            return null;
        }

        byte[] contents = readFile(destinationFile, result);
        if (result.hasFailureForCurrentLocation()) {
            return null;
        }

        result.rejectIfFalse(fileContentSpecification.isSatisfiedBy(contents), VALIDATOR_FILE_CONTENT,
                uri.toString());
        if (result.hasFailureForCurrentLocation()) {
            return null;
        }

        return contents;
    }

    @Override
    public void prefetch(URI uri, ValidationResult result) {
        if (uriCache.contains(uri)) {
            LOG.debug("rsync cache hit for URI " + uri);
            return;
        }

        File destinationDirectory = uriToFileMapper.map(uri, result);
        if (result.hasFailureForCurrentLocation()) {
            return;
        }

        rsync.reset();
        rsync.addOptions(STANDARD_OPTIONS);
        rsync.addOptions(PREFETCH_OPTIONS);
        rsync.setSource(uri.toString());
        rsync.setDestination(destinationDirectory.getAbsolutePath());

        destinationDirectory.mkdirs();
        int rc = rsync.execute();
        result.addMetric(RSYNC_PREFETCH_VALIDATION_METRIC, String.valueOf(rsync.elapsedTime()));
        result.rejectIfFalse(rc == 0, VALIDATOR_RSYNC_COMMAND, uri.toString());
        if (rc == 0) {
            uriCache.add(uri);
        }
    }

    private void fetchFile(URI uri, File destinationFile, ValidationResult result) {
        if (uriCache.contains(uri)) {
            LOG.debug("rsync cache hit for URI " + uri);
            return;
        }

        rsync.reset();
        rsync.addOptions(STANDARD_OPTIONS);
        rsync.addOptions(SINGLE_FILE_OPTIONS);
        rsync.setSource(uri.toString());
        rsync.setDestination(destinationFile.getAbsolutePath());

        destinationFile.getParentFile().mkdirs();
        int rc = rsync.execute();
        result.addMetric(RSYNC_FETCH_FILE_VALIDATION_METRIC, String.valueOf(rsync.elapsedTime()));
        result.rejectIfFalse(rc == 0, VALIDATOR_RSYNC_COMMAND, uri.toString());
        if (rc == 0) {
            uriCache.add(uri);
        }
    }

    private byte[] readFile(File destinationFile, ValidationResult validationResult) {
        byte[] result;
        try {
            result = FileUtils.readFileToByteArray(destinationFile);
        } catch (IOException e) {
            result = null;
        }
        validationResult.rejectIfNull(result, VALIDATOR_READ_FILE, destinationFile.getAbsolutePath());
        return result;
    }
}