Saving StoredFile functional with Amazon S3 upload.

Author: sagrawal31

build.gradle

@@ -11,7 +11,7 @@ buildscript {
     }
 }
 
-version "0.0.2"
+version "0.0.3"
 group "com.wizpanda.plugins"
 
 apply plugin:"eclipse"

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

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

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

@@ -3,64 +3,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.MultipartFile
 
 import javax.annotation.PostConstruct
-import java.nio.file.Files
 
 class FileUploadService {
 
     private static Map<String, UploaderService> services = [:]
 
-    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(MultipartFile multipartFile) throws FileNotFoundException, IllegalStateException, 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))
-        }
-
-        try {
-            String originalFilename = multipartFile.getOriginalFilename()
-            File temporaryDirectory = Files.createTempDirectory(null).toFile()
-
-            //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 e
-
-        } catch (IOException e) {
-            log.error "Exception saving file", e
-            throw e
-        }
-    }
-
-    File save(MultipartFile multipartFile, String groupName) throws FileUploadException {
+    StoredFile 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)
+        return services.get(groupName).instance().save(multipartFile)
     }
 
     @PostConstruct

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

@@ -1,7 +1,9 @@
 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
@@ -10,7 +12,7 @@ import org.jclouds.s3.domain.internal.MutableObjectMetadataImpl
 
 import javax.activation.MimetypesFileTypeMap
 
-abstract class AmazonS3Api implements StorageApi {
+abstract class AmazonS3Api extends AbstractStorageApi {
 
     BlobStore blobStore
     AWSS3Client client
@@ -46,7 +48,11 @@ abstract class AmazonS3Api implements StorageApi {
 
     @Override
     String getFileName(File file) {
-        return UUID.randomUUID().toString()
+        String name = UUID.randomUUID().toString()
+        String originalFileName = file.name
+        String extension = GrailsStringUtils.substringAfterLast(originalFileName, ".")
+
+        return name + "." + extension
     }
 
     String getContainerName() {
@@ -61,4 +67,14 @@ abstract class AmazonS3Api implements StorageApi {
     String getDirectory() {
 
     }
+
+    @Override
+    void validateRawFile() {
+
+    }
+
+    @Override
+    void deleteNativeFile(StoredFile file) {
+        // TODO implement me
+    }
 }

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

@@ -3,12 +3,10 @@ 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 {
 
@@ -17,33 +15,27 @@ class AmazonS3PermanentURLApi extends AmazonS3Api {
     }
 
     @Override
-    StoredFile saveFile(File file) {
-        authenticate()
-        upload(file)
-        close()
+    void saveNativeFile() {
+        this.authenticate()
 
-        return null
-    }
-
-    String upload(File file) {
         AWSS3PutObjectOptions fileOptions = new AWSS3PutObjectOptions()
         fileOptions.withAcl(CannedAccessPolicy.PUBLIC_READ)
 
-        String fileName = getFileName(file)
+        String fileName = getFileName(this.rawFile)
+        String containerName = getContainerName()
 
         MutableObjectMetadataImpl mutableObjectMetadata = new MutableObjectMetadataImpl()
         mutableObjectMetadata.setKey(fileName)
-        setContentType(mutableObjectMetadata, file)
+        setContentType(mutableObjectMetadata, this.rawFile)
 
         S3Object s3Object = new S3ObjectImpl(mutableObjectMetadata)
-        s3Object.setPayload(file)
+        s3Object.setPayload(this.rawFile)
+
+        client.putObject(containerName, s3Object, fileOptions)
 
-        return client.putObject(getContainerName(), s3Object, fileOptions)
-        /*Blob blob = blobStore.blobBuilder("blob-name")
-                .payload(file)
-                .contentLength(file.size())
-                .build()
+        this.gormFile.name = fileName
+        this.gormFile.url = client.getObject(containerName, fileName, null).metadata.uri
 
-        blobStore.putBlob(getContainerName(), blob)*/
+        this.close()
     }
 }

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

@@ -1,14 +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
 
-    StoredFile saveFile(File file)
+    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)
 }

src/main/groovy/com/wizpanda/file/utils/FileUtils.groovy

@@ -0,0 +1,35 @@
+package com.wizpanda.file.utils
+
+import org.springframework.web.multipart.MultipartFile
+
+import java.nio.file.Files
+
+class FileUtils {
+
+    /**
+     * 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
+     */
+    static File saveTemporarily(MultipartFile multipartFile) throws IllegalStateException, IOException {
+        if (!multipartFile || multipartFile.isEmpty()) {
+            throw new FileNotFoundException("Uploaded file is empty or null")
+        }
+
+        try {
+            String originalFilename = multipartFile.getOriginalFilename()
+            File temporaryDirectory = Files.createTempDirectory(null).toFile()
+
+            File temporaryFile = new File(temporaryDirectory, originalFilename)
+            multipartFile.transferTo(temporaryFile)
+
+            return temporaryFile
+        } catch (IllegalStateException | IOException e) {
+            throw e
+        }
+    }
+}