content: /*
   * The Alluxio Open Foundation licenses this work under the Apache License, version 2.0
   * (the "License"). You may not use this work except in compliance with the License, which is
   * available at www.apache.org/licenses/LICENSE-2.0
   *
   * This software is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
   * either express or implied, as more fully set forth in the License.
   *
   * See the NOTICE file distributed with this work for information regarding copyright ownership.
   */
  
  package alluxio.underfs.s3a;
  
  import alluxio.conf.AlluxioConfiguration;
  import alluxio.conf.PropertyKey;
  import alluxio.underfs.ObjectLowLevelOutputStream;
  
  import com.amazonaws.SdkClientException;
  import com.amazonaws.services.s3.AmazonS3;
  import com.amazonaws.services.s3.internal.Mimetypes;
  import com.amazonaws.services.s3.model.AbortMultipartUploadRequest;
  import com.amazonaws.services.s3.model.CompleteMultipartUploadRequest;
  import com.amazonaws.services.s3.model.InitiateMultipartUploadRequest;
  import com.amazonaws.services.s3.model.ObjectMetadata;
  import com.amazonaws.services.s3.model.PartETag;
  import com.amazonaws.services.s3.model.PutObjectRequest;
  import com.amazonaws.services.s3.model.UploadPartRequest;
  import com.google.common.base.Preconditions;
  import com.google.common.util.concurrent.ListeningExecutorService;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  import java.io.ByteArrayInputStream;
  import java.io.File;
  import java.io.IOException;
  import java.util.ArrayList;
  import java.util.Collections;
  import java.util.List;
  import java.util.Optional;
  import javax.annotation.Nullable;
  import javax.annotation.concurrent.NotThreadSafe;
  
  /**
   * Object storage low output stream for aws s3.
   */
  @NotThreadSafe
  public class S3ALowLevelOutputStream extends ObjectLowLevelOutputStream {
    private static final Logger LOG = LoggerFactory.getLogger(S3ALowLevelOutputStream.class);
  
    /** Server side encrypt enabled. */
    private final boolean mSseEnabled;
    /** The Amazon S3 client to interact with S3. */
    protected AmazonS3 mClient;
    /** Tags for the uploaded part, provided by S3 after uploading. */
    private final List<PartETag> mTags = Collections.synchronizedList(new ArrayList<>());
  
    /** The upload id of this multipart upload. */
    protected volatile String mUploadId;
  
    private String mContentHash;
  
    /**
     * Constructs a new stream for writing a file.
     *
     * @param bucketName the name of the bucket
     * @param key the key of the file
     * @param s3Client the Amazon S3 client to upload the file with
     * @param executor a thread pool executor
     * @param ufsConf the object store under file system configuration
     */
    public S3ALowLevelOutputStream(
        String bucketName,
        String key,
        AmazonS3 s3Client,
        ListeningExecutorService executor,
        AlluxioConfiguration ufsConf) {
      super(bucketName, key, executor,
          ufsConf.getBytes(PropertyKey.UNDERFS_S3_STREAMING_UPLOAD_PARTITION_SIZE), ufsConf);
      mClient = Preconditions.checkNotNull(s3Client);
      mSseEnabled = ufsConf.getBoolean(PropertyKey.UNDERFS_S3_SERVER_SIDE_ENCRYPTION_ENABLED);
    }
  
    @Override
    protected void uploadPartInternal(
        File file,
        int partNumber,
        boolean isLastPart,
        @Nullable String md5)
        throws IOException {
      try {
        final UploadPartRequest uploadRequest = new UploadPartRequest()
            .withBucketName(mBucketName)
            .withKey(mKey)
            .withUploadId(mUploadId)
            .withPartNumber(partNumber)
            .withFile(file)
            .withPartSize(file.length());
        if (md5 != null) {
          uploadRequest.setMd5Digest(md5);
        }
        uploadRequest.setLastPart(isLastPart);
        PartETag partETag = getClient().uploadPart(uploadRequest).getPartETag();
        mTags.add(partETag);
      } catch (SdkClientException e) {
        LOG.debug("failed to upload part.", e);
        throw new IOException(String.format(
            "failed to upload part. key: %s part number: %s uploadId: %s",
            mKey, partNumber, mUploadId), e);
      }
    }
  
    @Override
    protected void initMultiPartUploadInternal() throws IOException {
      try {
        ObjectMetadata meta = new ObjectMetadata();
        if (mSseEnabled) {
          meta.setSSEAlgorithm(ObjectMetadata.AES_256_SERVER_SIDE_ENCRYPTION);
        }
        meta.setContentType(Mimetypes.MIMETYPE_OCTET_STREAM);
        mUploadId = getClient()
            .initiateMultipartUpload(new InitiateMultipartUploadRequest(mBucketName, mKey, meta))
            .getUploadId();
      } catch (SdkClientException e) {
        LOG.debug("failed to init multi part upload", e);
        throw new IOException("failed to init multi part upload", e);
      }
    }
  
    @Override
    protected void completeMultiPartUploadInternal() throws IOException {
      try {
        LOG.debug("complete multi part {}", mUploadId);
        mContentHash = getClient().completeMultipartUpload(new CompleteMultipartUploadRequest(
            mBucketName, mKey, mUploadId, mTags)).getETag();
      } catch (SdkClientException e) {
        LOG.debug("failed to complete multi part upload", e);
        throw new IOException(
            String.format("failed to complete multi part upload, key: %s, upload id: %s",
                mKey, mUploadId), e);
      }
    }
  
    @Override
    protected void abortMultiPartUploadInternal() throws IOException {
      try {
        getClient().abortMultipartUpload(
            new AbortMultipartUploadRequest(mBucketName, mKey, mUploadId));
      } catch (SdkClientException e) {
        LOG.debug("failed to abort multi part upload", e);
        throw new IOException(
            String.format("failed to abort multi part upload, key: %s, upload id: %s", mKey,
                mUploadId), e);
      }
    }
  
    @Override
    protected void createEmptyObject(String key) throws IOException {
      try {
        ObjectMetadata meta = new ObjectMetadata();
        meta.setContentLength(0);
        meta.setContentType(Mimetypes.MIMETYPE_OCTET_STREAM);
        mContentHash = getClient().putObject(
            new PutObjectRequest(mBucketName, key, new ByteArrayInputStream(new byte[0]), meta))
            .getETag();
      } catch (SdkClientException e) {
        throw new IOException(e);
      }
    }
  
    @Override
    protected void putObject(String key, File file, @Nullable String md5) throws IOException {
      try {
        ObjectMetadata meta = new ObjectMetadata();
        if (mSseEnabled) {
          meta.setSSEAlgorithm(ObjectMetadata.AES_256_SERVER_SIDE_ENCRYPTION);
        }
        if (md5 != null) {
          meta.setContentMD5(md5);
        }
        meta.setContentLength(file.length());
        meta.setContentType(Mimetypes.MIMETYPE_OCTET_STREAM);
        PutObjectRequest putReq = new PutObjectRequest(mBucketName, key, file);
        putReq.setMetadata(meta);
        mContentHash = getClient().putObject(putReq).getETag();
      } catch (Exception e) {
        throw new IOException(e);
      }
    }
  
    protected AmazonS3 getClient() {
      return mClient;
    }
  
    @Override
    public Optional<String> getContentHash() {
      return Optional.ofNullable(mContentHash);
    }
  }
  