io.micronaut.http.server.netty.multipart.NettyCompletedFileUpload Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017-2020 original 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
 *
 * https://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 io.micronaut.http.server.netty.multipart;

import io.micronaut.core.annotation.Internal;
import io.micronaut.core.naming.NameUtils;
import io.micronaut.core.util.SupplierUtil;
import io.micronaut.http.MediaType;
import io.micronaut.http.multipart.CompletedFileUpload;
import io.micronaut.http.server.netty.MicronautHttpData;
import io.netty.buffer.ByteBuf;
import io.netty.buffer.ByteBufUtil;
import io.netty.handler.codec.http.multipart.FileUpload;
import io.netty.util.ResourceLeakDetector;
import io.netty.util.ResourceLeakDetectorFactory;
import io.netty.util.ResourceLeakTracker;

import java.io.IOException;
import java.io.InputStream;
import java.nio.ByteBuffer;
import java.util.Optional;
import java.util.function.Supplier;

/**
 * A Netty implementation of {@link CompletedFileUpload}.
 *
 * @author Zachary Klein
 * @since 1.0.0
 */
@Internal
public class NettyCompletedFileUpload implements CompletedFileUpload {
    //to avoid initializing Netty at build time
    private static final Supplier> RESOURCE_LEAK_DETECTOR = SupplierUtil.memoized(() ->
            ResourceLeakDetectorFactory.instance().newResourceLeakDetector(NettyCompletedFileUpload.class));

    private final FileUpload fileUpload;
    private final boolean controlRelease;

    private final ResourceLeakTracker tracker;

    /**
     * @param fileUpload The file upload
     */
    public NettyCompletedFileUpload(FileUpload fileUpload) {
        this(fileUpload, true);
    }

    /**
     * @param fileUpload The file upload
     * @param controlRelease If true, release after retrieving the data
     */
    public NettyCompletedFileUpload(FileUpload fileUpload, boolean controlRelease) {
        this.fileUpload = fileUpload;
        this.controlRelease = controlRelease;
        if (controlRelease) {
            tracker = RESOURCE_LEAK_DETECTOR.get().track(this);
        } else {
            tracker = null;
        }
    }

    /**
     * Gets the content of this part as a {@code InputStream}.
     *
     * The contents of the file will be released when the stream is closed.
     * This method should only be called once
     *
     * @return The content of this part as a {@code InputStream}
     * @throws IOException If an error occurs in retrieving the content
     */
    @Override
    public InputStream getInputStream() throws IOException {
        try {
            return ((MicronautHttpData) fileUpload).toStream();
        } finally {
            fileUpload.release(); // it's retained by toStream, and released by InputStream.close
            closeTracker(); // discard won't be called
        }
    }

    /**
     * Gets the content of this part as a {@code byte[]}.
     *
     * Because the contents of the file are released after being retrieved,
     * this method can only be called once
     *
     * @return The content of this part as a {@code byte[]}
     * @throws IOException If an error occurs in retrieving the content
     */
    @Override
    public byte[] getBytes() throws IOException {
        ByteBuf byteBuf = fileUpload.getByteBuf();
        if (byteBuf == null) {
            throw new IOException("The bytes have already been released");
        }
        try {
            return ByteBufUtil.getBytes(byteBuf);
        } finally {
            discard();
        }
    }

    /**
     * Gets the content of this part as a {@code ByteBuffer}.
     *
     * Because the contents of the file are released after being retrieved,
     * this method can only be called once
     *
     * @return The content of this part as a {@code ByteBuffer}
     * @throws IOException If an error occurs in retrieving the content
     */
    @Override
    public ByteBuffer getByteBuffer() throws IOException {
        ByteBuf byteBuf = fileUpload.getByteBuf();
        if (byteBuf == null) {
            throw new IOException("The byte buffer has already been released");
        }
        try {
            return byteBuf.nioBuffer();
        } finally {
            discard();
        }
    }

    @Override
    public Optional getContentType() {
        return Optional.of(new MediaType(fileUpload.getContentType(), NameUtils.extension(fileUpload.getFilename())));
    }

    @Override
    public String getName() {
        return fileUpload.getName();
    }

    @Override
    public String getFilename() {
        return fileUpload.getFilename();
    }

    @Override
    public long getSize() {
        return fileUpload.length();
    }

    @Override
    public long getDefinedSize() {
        return fileUpload.definedLength();
    }

    @Override
    public boolean isComplete() {
        return fileUpload.isCompleted();
    }

    @Override
    public final void discard() {
        if (controlRelease) {
            fileUpload.release();
        }
        closeTracker();
    }

    private void closeTracker() {
        if (tracker != null) {
            tracker.close(this);
        }
    }
}