Merge pull request #4 from wizpanda/amazon-s3

Amazon S3 implementation

Author: Shashank Agrawal

build.gradle

@@ -11,8 +11,8 @@ buildscript {
     }
 }
 
-version "0.1"
-group "multi.file.upload"
+version "0.0.3"
+group "com.wizpanda.plugins"
 
 apply plugin:"eclipse"
 apply plugin:"idea"
@@ -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"

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>

grails-app/domain/com/wizpanda/file/StoredFile.groovy

@@ -0,0 +1,12 @@
+package com.wizpanda.file
+
+class StoredFile {
+
+    String originalName
+    String name
+    String url
+    String groupName
+    Long size
+    Date uploadedOn = new Date()
+    Map meta = [:]
+}

grails-app/services/com/wizpanda/file/FileUploadService.groovy

@@ -1,47 +1,46 @@
 package com.wizpanda.file
 
-import org.springframework.context.MessageSource
-import org.springframework.web.multipart.commons.CommonsMultipartFile
+import com.wizpanda.file.exception.FileUploadException
+import com.wizpanda.file.exception.InvalidFileGroupException
+import com.wizpanda.file.service.UploaderService
+import org.springframework.web.multipart.MultipartFile
 
-import java.nio.file.Files
+import javax.annotation.PostConstruct
 
 class FileUploadService {
 
-    MessageSource messageSource
-
-    /**
-     * Save the uploaded multipart file in the temporary directory of the local server which will be cleaned
-     * automatically by the system itself.
-     *
-     * @param multipartFile
-     * @return Saved file in a temporary location
-     * @throws FileNotFoundException
-     * @throws IOException
-     */
-    File saveTemporarily(CommonsMultipartFile multipartFile) throws FileNotFoundException, IOException {
-        if (!multipartFile || multipartFile.isEmpty()) {
-            log.debug "Received file is either empty or does not exists"
-
-            throw new FileNotFoundException(messageSource.getMessage("kernel.uploaded.file.empty", null, null))
-        }
+    private static Map<String, UploaderService> services = [:]
+
+    StoredFile save(MultipartFile multipartFile, String groupName) throws FileUploadException {
+        // TODO Add check for validating group name
+
+        return services.get(groupName).instance().save(multipartFile)
+    }
+
+    @PostConstruct
+    void verifyConfig() {
+        //log.debug "Verifying all service"
+        println "Verifying all service"
 
-        try {
-            String originalFilename = multipartFile.getOriginalFilename()
-            File temporaryDirectory = Files.createTempDirectory(null).toFile()
+        ConfigHelper.allGroups.each { Map.Entry groupConfigEntry ->
+            String groupName = groupConfigEntry.key.toString()
+            Map groupConfigValue = groupConfigEntry.value
 
-            log.debug "Uploaded file [$originalFilename] will be saved in [${temporaryDirectory.absolutePath}]"
+            if (!groupConfigValue.service) {
+                throw new InvalidFileGroupException("The service API missing for [${groupName}]")
+            }
 
-            File temporaryFile = new File(temporaryDirectory, originalFilename)
-            multipartFile.transferTo(temporaryFile)
+            Class<? extends UploaderService> serviceClass = groupConfigValue.service
 
-            return temporaryFile
-        } catch (IllegalStateException e) {
-            log.error "Problem saving file", e
-            throw new FileNotFoundException(e.message)
+            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");
+            }
 
-        } catch (IOException e) {
-            log.error "Exception saving file", e
-            throw e
+            services[service.groupName] = service
         }
     }
 }

src/main/groovy/multi/file/upload/MultiFileUploadGrailsPlugin.groovy renamed to src/main/groovy/com/wizpanda/MultiFileUploadGrailsPlugin.groovy

@@ -1,4 +1,4 @@
-package multi.file.upload
+package com.wizpanda
 
 import grails.plugins.Plugin
 

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
+    }
+}

src/main/groovy/com/wizpanda/file/api/AbstractStorageApi.groovy

@@ -0,0 +1,54 @@
+package com.wizpanda.file.api
+
+import com.wizpanda.file.StoredFile
+import com.wizpanda.file.exception.FileUploadException
+import com.wizpanda.file.utils.FileUtils
+import org.springframework.web.multipart.MultipartFile
+
+abstract class AbstractStorageApi implements StorageApi {
+
+    File rawFile
+    StoredFile gormFile
+
+    StoredFile save(MultipartFile multipartFile) throws FileUploadException {
+        File temporaryFile
+        try {
+            temporaryFile = FileUtils.saveTemporarily(multipartFile)
+        } catch (IllegalStateException | IOException e) {
+            throw new FileUploadException(e.message)
+        }
+
+        return save(temporaryFile)
+    }
+
+    StoredFile save(File rawFile) throws FileUploadException {
+        this.rawFile = rawFile
+        this.gormFile = new StoredFile()
+        this.gormFile.originalName = rawFile.name
+        this.gormFile.groupName = service.groupName
+        this.gormFile.size = rawFile.size()
+
+        this.validateRawFile()
+        this.saveNativeFile()
+
+        return this.saveGORMFile()
+    }
+
+    @Override
+    StoredFile saveGORMFile() throws FileUploadException {
+        this.gormFile.save()
+
+        if (this.gormFile.hasErrors()) {
+            println this.gormFile.errors
+            // TODO Delete the native file and then throw the exception
+            throw new FileUploadException()
+        }
+
+        return this.gormFile
+    }
+
+    @Override
+    void delete(StoredFile file) {
+        deleteNativeFile(file)
+    }
+}

src/main/groovy/com/wizpanda/file/api/AmazonS3Api.groovy

@@ -0,0 +1,80 @@
+package com.wizpanda.file.api
+
+import com.wizpanda.file.StoredFile
+import com.wizpanda.file.service.AmazonS3UploaderService
+import grails.util.Environment
+import grails.util.GrailsStringUtils
+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 extends AbstractStorageApi {
+
+    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) {
+        String name = UUID.randomUUID().toString()
+        String originalFileName = file.name
+        String extension = GrailsStringUtils.substringAfterLast(originalFileName, ".")
+
+        return name + "." + extension
+    }
+
+    String getContainerName() {
+        String name = service.container
+        if (Environment.current != Environment.PRODUCTION) {
+            name += "-" + Environment.current.name.toLowerCase()
+        }
+
+        return name
+    }
+
+    String getDirectory() {
+
+    }
+
+    @Override
+    void validateRawFile() {
+
+    }
+
+    @Override
+    void deleteNativeFile(StoredFile file) {
+        // TODO implement me
+    }
+}

src/main/groovy/com/wizpanda/file/api/AmazonS3PermanentURLApi.groovy

@@ -0,0 +1,41 @@
+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.s3.domain.CannedAccessPolicy
+import org.jclouds.s3.domain.S3Object
+import org.jclouds.s3.domain.internal.MutableObjectMetadataImpl
+import org.jclouds.s3.domain.internal.S3ObjectImpl
+
+class AmazonS3PermanentURLApi extends AmazonS3Api {
+
+    AmazonS3PermanentURLApi(AmazonS3UploaderService service) {
+        this.service = service
+    }
+
+    @Override
+    void saveNativeFile() {
+        this.authenticate()
+
+        AWSS3PutObjectOptions fileOptions = new AWSS3PutObjectOptions()
+        fileOptions.withAcl(CannedAccessPolicy.PUBLIC_READ)
+
+        String fileName = getFileName(this.rawFile)
+        String containerName = getContainerName()
+
+        MutableObjectMetadataImpl mutableObjectMetadata = new MutableObjectMetadataImpl()
+        mutableObjectMetadata.setKey(fileName)
+        setContentType(mutableObjectMetadata, this.rawFile)
+
+        S3Object s3Object = new S3ObjectImpl(mutableObjectMetadata)
+        s3Object.setPayload(this.rawFile)
+
+        client.putObject(containerName, s3Object, fileOptions)
+
+        this.gormFile.name = fileName
+        this.gormFile.url = client.getObject(containerName, fileName, null).metadata.uri
+
+        this.close()
+    }
+}

src/main/groovy/com/wizpanda/file/api/StorageApi.groovy

@@ -0,0 +1,38 @@
+package com.wizpanda.file.api
+
+import com.wizpanda.file.StoredFile
+import com.wizpanda.file.exception.FileUploadException
+import com.wizpanda.file.service.UploaderService
+import org.springframework.web.multipart.MultipartFile
+
+interface StorageApi {
+
+    UploaderService service
+
+    void saveNativeFile()
+
+    void validateRawFile()
+
+    void deleteNativeFile(StoredFile file)
+
+    String getFileName(File file)
+
+    StoredFile saveGORMFile() throws FileUploadException
+
+    /**
+     * The entry point of the Storage API instance which will accept a raw file to be saved/uploaded via an API.
+     * @param rawFile
+     * @return Newly saved GORM StoredFile instance
+     */
+    StoredFile save(File rawFile) throws FileUploadException
+
+    /**
+     * The entry point of the Storage API instance which will accept an uploaded multipart file to be saved/uploaded via
+     * an API.
+     * @param multipartFile
+     * @return Newly saved GORM StoredFile instance
+     */
+    StoredFile save(MultipartFile multipartFile) throws FileUploadException
+
+    void delete(StoredFile file)
+}