org.gradle.internal.resource.transfer.AccessorBackedExternalResource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Gradle 6.9.1 API redistribution.
There is a newer version: 8.11.1
/*
 * Copyright 2017 the original author or authors.
 *
 * 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 org.gradle.internal.resource.transfer;

import com.google.common.io.CountingInputStream;
import org.apache.commons.io.IOUtils;
import org.gradle.api.Action;
import org.gradle.api.Transformer;
import org.gradle.api.resources.ResourceException;
import org.gradle.internal.resource.AbstractExternalResource;
import org.gradle.internal.resource.ExternalResourceName;
import org.gradle.internal.resource.ExternalResourceReadResult;
import org.gradle.internal.resource.ExternalResourceWriteResult;
import org.gradle.internal.resource.ReadableContent;
import org.gradle.internal.resource.ResourceExceptions;
import org.gradle.internal.resource.metadata.ExternalResourceMetaData;

import javax.annotation.Nullable;
import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URI;
import java.util.List;

public class AccessorBackedExternalResource extends AbstractExternalResource {
    private final ExternalResourceName name;
    private final ExternalResourceAccessor accessor;
    private final ExternalResourceUploader uploader;
    private final ExternalResourceLister lister;
    // Should really be a parameter to the 'withContent' methods or baked into the accessor
    private final boolean revalidate;

    public AccessorBackedExternalResource(ExternalResourceName name, ExternalResourceAccessor accessor, ExternalResourceUploader uploader, ExternalResourceLister lister, boolean revalidate) {
        this.name = name;
        this.accessor = accessor;
        this.uploader = uploader;
        this.lister = lister;
        this.revalidate = revalidate;
    }

    @Override
    public URI getURI() {
        return name.getUri();
    }

    @Override
    public String getDisplayName() {
        return name.getDisplayName();
    }

    @Nullable
    @Override
    public ExternalResourceReadResult writeToIfPresent(File destination) throws ResourceException {
        try {
            ExternalResourceReadResponse response = accessor.openResource(name.getUri(), revalidate);
            if (response == null) {
                return null;
            }
            try {
                CountingInputStream input = new CountingInputStream(response.openStream());
                try {
                    FileOutputStream output = new FileOutputStream(destination);
                    try {
                        IOUtils.copyLarge(input, output);
                        return ExternalResourceReadResult.of(input.getCount());
                    } finally {
                        output.close();
                    }
                } finally {
                    input.close();
                }
            } finally {
                response.close();
            }
        } catch (IOException e) {
            throw ResourceExceptions.getFailed(getURI(), e);
        }
    }

    @Override
    public ExternalResourceReadResult writeTo(OutputStream destination) throws ResourceException {
        throw new UnsupportedOperationException();
    }

    @Nullable
    @Override
    public  ExternalResourceReadResult withContentIfPresent(Transformer transformer) throws ResourceException {
        try {
            ExternalResourceReadResponse response = accessor.openResource(name.getUri(), revalidate);
            if (response == null) {
                return null;
            }
            try {
                CountingInputStream input = new CountingInputStream(new BufferedInputStream(response.openStream()));
                try {
                    T value = transformer.transform(input);
                    return ExternalResourceReadResult.of(input.getCount(), value);
                } finally {
                    input.close();
                }
            } finally {
                response.close();
            }
        } catch (IOException e) {
            throw ResourceExceptions.getFailed(name.getUri(), e);
        }
    }

    @Nullable
    @Override
    public  ExternalResourceReadResult withContentIfPresent(ContentAction readAction) throws ResourceException {
        try {
            ExternalResourceReadResponse response = accessor.openResource(name.getUri(), revalidate);
            if (response == null) {
                return null;
            }
            try {
                CountingInputStream stream = new CountingInputStream(new BufferedInputStream(response.openStream()));
                try {
                    T value = readAction.execute(stream, response.getMetaData());
                    return ExternalResourceReadResult.of(stream.getCount(), value);
                } finally {
                    stream.close();
                }
            } finally {
                response.close();
            }
        } catch (IOException e) {
            throw ResourceExceptions.getFailed(name.getUri(), e);
        }
    }

    @Override
    public ExternalResourceReadResult withContent(Action readAction) throws ResourceException {
        try {
            ExternalResourceReadResponse response = accessor.openResource(name.getUri(), revalidate);
            if (response == null) {
                throw ResourceExceptions.getMissing(getURI());
            }
            try {
                CountingInputStream inputStream = new CountingInputStream(response.openStream());
                readAction.execute(inputStream);
                return ExternalResourceReadResult.of(inputStream.getCount());
            } finally {
                response.close();
            }
        } catch (IOException e) {
            throw ResourceExceptions.getFailed(name.getUri(), e);
        }
    }

    @Override
    public  ExternalResourceReadResult withContent(ContentAction readAction) throws ResourceException {
        ExternalResourceReadResult result = withContentIfPresent(readAction);
        if (result == null) {
            throw ResourceExceptions.getMissing(getURI());
        }
        return result;
    }

    @Override
    public ExternalResourceWriteResult put(final ReadableContent source) throws ResourceException {
        try {
            CountingReadableContent countingResource = new CountingReadableContent(source);
            uploader.upload(countingResource, getURI());
            return new ExternalResourceWriteResult(countingResource.getCount());
        } catch (IOException e) {
            throw ResourceExceptions.putFailed(getURI(), e);
        }
    }

    @Nullable
    @Override
    public List list() throws ResourceException {
        try {
            return lister.list(getURI());
        } catch (Exception e) {
            throw ResourceExceptions.getFailed(getURI(), e);
        }
    }

    @Override
    public ExternalResourceMetaData getMetaData() {
        return accessor.getMetaData(getURI(), revalidate);
    }

    private static class CountingReadableContent implements ReadableContent {
        private final ReadableContent source;
        private CountingInputStream instr;
        private long count;

        CountingReadableContent(ReadableContent source) {
            this.source = source;
        }

        @Override
        public InputStream open() throws ResourceException {
            if (instr != null) {
                count += instr.getCount();
            }
            instr = new CountingInputStream(source.open());
            return instr;
        }

        @Override
        public long getContentLength() {
            return source.getContentLength();
        }

        public long getCount() {
            return instr != null ? count + instr.getCount() : count;
        }
    }
}