Uploading files to Amazon S3 functional.

sagrawal31 · sagrawal31 · commit 5ee7f416249b · 2016-09-22T21:49:55.000+05:30
diff --git a/build.gradle b/build.gradle
@@ -40,6 +40,8 @@ dependencies {
     compile "org.springframework.boot:spring-boot-starter-logging"
     compile "org.springframework.boot:spring-boot-autoconfigure"
     compile "org.grails:grails-core"
+    compile group: "org.apache.jclouds", name: "jclouds-core", version: "1.9.2"
+    compile group: "org.apache.jclouds", name: "jclouds-allblobstore", version: "1.9.2"
     console "org.grails:grails-console"
     profile "org.grails.profiles:plugin"
     provided "org.grails:grails-plugin-services"
diff --git a/grails-app/controllers/com/wizpanda/file/UploadController.groovy b/grails-app/controllers/com/wizpanda/file/UploadController.groovy
@@ -35,7 +35,7 @@ class UploadController {
      *      }
      * </pre>
      *
-     * Note: By default this endpoint is blocked to allow upload. You need to set following to your config in order
+     * Note: By default this endpoint is blocked to allow upload. You need to set following to your service in order
      * to allow uploading files using this endpoint:
      *
      * <pre>
diff --git a/grails-app/domain/com/wizpanda/file/StoredFile.groovy b/grails-app/domain/com/wizpanda/file/StoredFile.groovy
@@ -0,0 +1,8 @@
+package com.wizpanda.file
+
+class StoredFile {
+
+    String originalName
+    String path
+
+}
diff --git a/grails-app/services/com/wizpanda/file/FileUploadService.groovy b/grails-app/services/com/wizpanda/file/FileUploadService.groovy
@@ -1,12 +1,18 @@
 package com.wizpanda.file
 
+import com.wizpanda.file.exception.FileUploadException
+import com.wizpanda.file.exception.InvalidFileGroupException
+import com.wizpanda.file.service.UploaderService
 import org.springframework.context.MessageSource
-import org.springframework.web.multipart.commons.CommonsMultipartFile
+import org.springframework.web.multipart.MultipartFile
 
+import javax.annotation.PostConstruct
 import java.nio.file.Files
 
 class FileUploadService {
 
+    private static Map<String, UploaderService> services = [:]
+
     MessageSource messageSource
 
     /**
@@ -18,7 +24,7 @@ class FileUploadService {
      * @throws FileNotFoundException
      * @throws IOException
      */
-    File saveTemporarily(CommonsMultipartFile multipartFile) throws FileNotFoundException, IOException {
+    File saveTemporarily(MultipartFile multipartFile) throws FileNotFoundException, IllegalStateException, IOException {
         if (!multipartFile || multipartFile.isEmpty()) {
             log.debug "Received file is either empty or does not exists"
 
@@ -29,19 +35,58 @@ class FileUploadService {
             String originalFilename = multipartFile.getOriginalFilename()
             File temporaryDirectory = Files.createTempDirectory(null).toFile()
 
-            log.debug "Uploaded file [$originalFilename] will be saved in [${temporaryDirectory.absolutePath}]"
+            //log.debug "Uploaded file [$originalFilename] will be saved in [${temporaryDirectory.absolutePath}]"
 
             File temporaryFile = new File(temporaryDirectory, originalFilename)
             multipartFile.transferTo(temporaryFile)
 
             return temporaryFile
         } catch (IllegalStateException e) {
             log.error "Problem saving file", e
-            throw new FileNotFoundException(e.message)
+            throw e
 
         } catch (IOException e) {
             log.error "Exception saving file", e
             throw e
         }
     }
+
+    File save(MultipartFile multipartFile, String groupName) throws FileUploadException {
+        // TODO Add check for validating group name
+        File temporaryFile
+        try {
+            temporaryFile = saveTemporarily(multipartFile)
+        } catch (FileNotFoundException | IllegalStateException | IOException e) {
+            throw new FileUploadException(e.message)
+        }
+
+        return services.get(groupName).instance().saveFile(temporaryFile)
+    }
+
+    @PostConstruct
+    void verifyConfig() {
+        //log.debug "Verifying all service"
+        println "Verifying all service"
+
+        ConfigHelper.allGroups.each { Map.Entry groupConfigEntry ->
+            String groupName = groupConfigEntry.key.toString()
+            Map groupConfigValue = groupConfigEntry.value
+
+            if (!groupConfigValue.service) {
+                throw new InvalidFileGroupException("The service API missing for [${groupName}]")
+            }
+
+            Class<? extends UploaderService> serviceClass = groupConfigValue.service
+
+            UploaderService service
+            try {
+                service = serviceClass.newInstance(groupName, groupConfigValue)
+            } catch (IllegalAccessException | InstantiationException | RuntimeException e) {
+                log.error "Error creating uploader service object", e
+                throw new InvalidFileGroupException("Error while creating the uploader service object");
+            }
+
+            services[service.groupName] = service
+        }
+    }
 }
diff --git a/src/main/groovy/com/wizpanda/file/ConfigHelper.groovy b/src/main/groovy/com/wizpanda/file/ConfigHelper.groovy
@@ -0,0 +1,37 @@
+package com.wizpanda.file
+
+import com.wizpanda.file.exception.FileUploadException
+import grails.util.Holders
+
+class ConfigHelper {
+
+    private static final String BASE_CONFIG = "fileUpload"
+
+    static Object getFlatConfig(String suffix) {
+        return Holders.getFlatConfig()[BASE_CONFIG + "." + suffix]
+    }
+
+    static ConfigObject getAllGroups() {
+        return Holders.getConfig()[BASE_CONFIG + ".groups"]
+    }
+
+    static ConfigObject getGroup(String group) {
+        ConfigObject groupConfig = Holders.getConfig()[BASE_CONFIG + ".groups." + group]
+
+        if (!groupConfig || groupConfig.isEmpty()) {
+            throw new FileUploadException("No service found under [${BASE_CONFIG}.${group}]")
+        }
+
+        return groupConfig
+    }
+
+    static void verifyGroup(String group) {
+        ConfigObject groupConfig = Holders.getConfig()[BASE_CONFIG + ".groups." + group]
+
+        if (!groupConfig || groupConfig.isEmpty()) {
+            throw new FileUploadException("No service found under [${BASE_CONFIG}.${group}]")
+        }
+
+        // TODO complete implementation
+    }
+}
diff --git a/src/main/groovy/com/wizpanda/file/api/AmazonS3Api.groovy b/src/main/groovy/com/wizpanda/file/api/AmazonS3Api.groovy
@@ -0,0 +1,64 @@
+package com.wizpanda.file.api
+
+import com.wizpanda.file.service.AmazonS3UploaderService
+import grails.util.Environment
+import org.jclouds.ContextBuilder
+import org.jclouds.aws.s3.AWSS3Client
+import org.jclouds.blobstore.BlobStore
+import org.jclouds.blobstore.BlobStoreContext
+import org.jclouds.s3.domain.internal.MutableObjectMetadataImpl
+
+import javax.activation.MimetypesFileTypeMap
+
+abstract class AmazonS3Api implements StorageApi {
+
+    BlobStore blobStore
+    AWSS3Client client
+    BlobStoreContext context
+    AmazonS3UploaderService service
+
+    void authenticate() {
+        println service.accessKey
+        println service.accessSecret
+        context = ContextBuilder.newBuilder("aws-s3")
+                .credentials(service.accessKey, service.accessSecret)
+                .buildView(BlobStoreContext.class)
+        println "Context created ${context.class}"
+
+        blobStore = context.getBlobStore()
+        println "BlobStore ${blobStore.class}"
+
+        // Storing wrapped Api of S3Client with Apache JCloud
+        client = context.unwrap().getApi()
+    }
+
+    void close() {
+        context.close()
+    }
+
+    void setContentType(MutableObjectMetadataImpl mutableObjectMetadata, File file) {
+        String contentType = new MimetypesFileTypeMap().getContentType(file.name)
+
+        if (contentType) {
+            mutableObjectMetadata.getContentMetadata().setContentType(contentType)
+        }
+    }
+
+    @Override
+    String getFileName(File file) {
+        return UUID.randomUUID().toString()
+    }
+
+    String getContainerName() {
+        String name = service.container
+        if (Environment.current != Environment.PRODUCTION) {
+            name += "-" + Environment.current.name.toLowerCase()
+        }
+
+        return name
+    }
+
+    String getDirectory() {
+
+    }
+}
diff --git a/src/main/groovy/com/wizpanda/file/api/AmazonS3PermanentURLApi.groovy b/src/main/groovy/com/wizpanda/file/api/AmazonS3PermanentURLApi.groovy
@@ -0,0 +1,49 @@
+package com.wizpanda.file.api
+
+import com.wizpanda.file.StoredFile
+import com.wizpanda.file.service.AmazonS3UploaderService
+import org.jclouds.aws.s3.blobstore.options.AWSS3PutObjectOptions
+import org.jclouds.blobstore.domain.Blob
+import org.jclouds.s3.domain.CannedAccessPolicy
+import org.jclouds.s3.domain.S3Object
+import org.jclouds.s3.domain.internal.MutableObjectMetadataImpl
+import org.jclouds.s3.domain.internal.S3ObjectImpl
+import org.springframework.web.multipart.MultipartFile
+
+class AmazonS3PermanentURLApi extends AmazonS3Api {
+
+    AmazonS3PermanentURLApi(AmazonS3UploaderService service) {
+        this.service = service
+    }
+
+    @Override
+    StoredFile saveFile(File file) {
+        authenticate()
+        upload(file)
+        close()
+
+        return null
+    }
+
+    String upload(File file) {
+        AWSS3PutObjectOptions fileOptions = new AWSS3PutObjectOptions()
+        fileOptions.withAcl(CannedAccessPolicy.PUBLIC_READ)
+
+        String fileName = getFileName(file)
+
+        MutableObjectMetadataImpl mutableObjectMetadata = new MutableObjectMetadataImpl()
+        mutableObjectMetadata.setKey(fileName)
+        setContentType(mutableObjectMetadata, file)
+
+        S3Object s3Object = new S3ObjectImpl(mutableObjectMetadata)
+        s3Object.setPayload(file)
+
+        return client.putObject(getContainerName(), s3Object, fileOptions)
+        /*Blob blob = blobStore.blobBuilder("blob-name")
+                .payload(file)
+                .contentLength(file.size())
+                .build()
+
+        blobStore.putBlob(getContainerName(), blob)*/
+    }
+}
diff --git a/src/main/groovy/com/wizpanda/file/api/StorageApi.groovy b/src/main/groovy/com/wizpanda/file/api/StorageApi.groovy
@@ -0,0 +1,14 @@
+package com.wizpanda.file.api
+
+import com.wizpanda.file.StoredFile
+import com.wizpanda.file.service.UploaderService
+import org.springframework.web.multipart.MultipartFile
+
+interface StorageApi {
+
+    UploaderService service
+
+    StoredFile saveFile(File file)
+
+    String getFileName(File file)
+}
diff --git a/src/main/groovy/com/wizpanda/file/exception/FileUploadException.groovy b/src/main/groovy/com/wizpanda/file/exception/FileUploadException.groovy
@@ -0,0 +1,8 @@
+package com.wizpanda.file.exception
+
+class FileUploadException extends Exception {
+
+    FileUploadException(String message = null) {
+        super(message)
+    }
+}
diff --git a/src/main/groovy/com/wizpanda/file/exception/InvalidFileGroupException.groovy b/src/main/groovy/com/wizpanda/file/exception/InvalidFileGroupException.groovy
@@ -0,0 +1,8 @@
+package com.wizpanda.file.exception
+
+class InvalidFileGroupException extends Exception {
+
+    InvalidFileGroupException(String message = null) {
+        super(message)
+    }
+}
diff --git a/src/main/groovy/com/wizpanda/file/service/AmazonS3UploaderService.groovy b/src/main/groovy/com/wizpanda/file/service/AmazonS3UploaderService.groovy
@@ -0,0 +1,55 @@
+package com.wizpanda.file.service
+
+import com.wizpanda.file.ConfigHelper
+import com.wizpanda.file.exception.InvalidFileGroupException
+import com.wizpanda.file.api.AmazonS3PermanentURLApi
+import com.wizpanda.file.api.StorageApi
+
+class AmazonS3UploaderService extends UploaderService {
+
+    String accessKey, accessSecret, container
+
+    AmazonS3UploaderService(String groupName, Map config) {
+        super(groupName, config)
+
+        /**
+         * New bucket region (like Mumbai, Frankfurt) does not support older version of authentication on Amazon S3
+         * and only supports V4 authentication mechanism.
+         *
+         * http://stackoverflow.com/questions/26533245/the-authorization-mechanism-you-have-provided-is-not-supported-please-use-aws4
+         * http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
+         * TODO https://github.com/aws/aws-sdk-java/issues/740
+         * TODO Planned to be released in https://github.com/jclouds/jclouds/pull/678
+         */
+        //System.setProperty("com.amazonaws.services.s3.enableV4", "true")
+    }
+
+    @Override
+    StorageApi instance() {
+        StorageApi uploaderInstance = new AmazonS3PermanentURLApi(this)
+
+        return uploaderInstance
+    }
+
+    @Override
+    void verifyConfig() {
+        container = flatGroupConfig.container ?: ConfigHelper.getFlatConfig("global.amazon.container")
+        accessKey = flatGroupConfig.accessKey ?: ConfigHelper.getFlatConfig("global.amazon.accessKey")
+        accessSecret = flatGroupConfig.accessSecret ?: ConfigHelper.getFlatConfig("global.amazon.accessSecret")
+
+        if (!accessKey) {
+            throw new InvalidFileGroupException("Either group specific or global access key required for Amazon's " +
+                    "[$groupName] group")
+        }
+
+        if (!accessSecret) {
+            throw new InvalidFileGroupException("Either group specific or global access secret required for Amazon's " +
+                    "[$groupName] group")
+        }
+
+        if (!container) {
+            throw new InvalidFileGroupException("Either group specific or global container name required for Amazon's" +
+                    " [$groupName] group")
+        }
+    }
+}
diff --git a/src/main/groovy/com/wizpanda/file/service/UploaderService.groovy b/src/main/groovy/com/wizpanda/file/service/UploaderService.groovy
@@ -0,0 +1,23 @@
+package com.wizpanda.file.service
+
+import com.wizpanda.file.api.StorageApi
+
+abstract class UploaderService {
+
+    UploaderService() {
+    }
+
+    UploaderService(String groupName, Map config) {
+        this.groupName = groupName
+        this.flatGroupConfig = config
+        verifyConfig()
+    }
+
+    String groupName
+
+    Map flatGroupConfig
+
+    abstract StorageApi instance()
+
+    abstract void verifyConfig()
+}

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ class UploadController {`
`35`	`35`	`* }`
`36`	`36`	`* </pre>`
`37`	`37`	`*`
`38`		`- * Note: By default this endpoint is blocked to allow upload. You need to set following to your config in order`
	`38`	`+ * Note: By default this endpoint is blocked to allow upload. You need to set following to your service in order`
`39`	`39`	`* to allow uploading files using this endpoint:`
`40`	`40`	`*`
`41`	`41`	`* <pre>`