Merge pull request #5 from nikhilsharma8193/option-to-delete

Added option to delete stored file from Amazon S3.

Author: sagrawal31

README.md

@@ -4,7 +4,7 @@ A plugin for multi purpose file upload functionality for Grails 3 application. T
 to the following destinations:
 
 1. To the local server or the local system
-2. To the Amazon S3 storage (coming soon)
+2. To the Amazon S3 storage (can be deleted as well)
 3. To the Rackspace cloud storage (coming soon)
 
 ## Installation

build.gradle

@@ -9,7 +9,7 @@ buildscript {
     }
 }
 
-version "0.0.5"
+version "0.0.6"
 group "com.wizpanda.plugins"
 
 apply plugin:"eclipse"

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

@@ -1,5 +1,7 @@
 package com.wizpanda.file
 
+import grails.util.Holders
+
 class StoredFile {
 
     String originalName
@@ -9,4 +11,23 @@ class StoredFile {
     Long size
     Date uploadedOn = new Date()
     Map meta = [:]
+
+    FileUploadService getFileUploadService() {
+        FileUploadService fileUploadService = Holders.getApplicationContext()['fileUploadService']
+
+        if (!fileUploadService) {
+            log.warn "FileUploadService bean not injected!"
+            return
+        }
+
+        return fileUploadService
+    }
+
+    void remove() {
+        fileUploadService?.delete(this)
+    }
+
+    void cloneFile(String newGroupName) {
+        fileUploadService?.cloneFile(this, newGroupName)
+    }
 }

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

@@ -23,6 +23,29 @@ class FileUploadService {
         return services.get(groupName).instance().save(file)
     }
 
+    void delete(StoredFile file) {
+        if (!file) {
+            log.warn 'StoredFile is null.'
+            return
+        }
+
+        services.get(file.groupName).instance().delete(file)
+    }
+
+    void cloneFile(StoredFile file, String newGroupName) {
+        if (!file) {
+            log.warn 'StoredFile cannot be null.'
+            return
+        }
+
+        if (!newGroupName) {
+            log.warn 'New Group Name cannot be null.'
+            return
+        }
+
+        services.get(newGroupName).instance().cloneStoredFile(file, newGroupName)
+    }
+
     @PostConstruct
     void verifyConfig() {
         //log.debug "Verifying all service"

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

@@ -1,17 +1,23 @@
 package com.wizpanda.file.api
 
+import com.wizpanda.file.ConfigHelper
 import com.wizpanda.file.StoredFile
 import com.wizpanda.file.service.AmazonS3UploaderService
 import grails.util.Environment
 import grails.util.GrailsStringUtils
+import groovy.util.logging.Slf4j
 import org.jclouds.ContextBuilder
 import org.jclouds.aws.s3.AWSS3Client
 import org.jclouds.blobstore.BlobStore
 import org.jclouds.blobstore.BlobStoreContext
+import org.jclouds.http.HttpResponseException
+import org.jclouds.s3.domain.CannedAccessPolicy
 import org.jclouds.s3.domain.internal.MutableObjectMetadataImpl
+import org.jclouds.s3.options.CopyObjectOptions
 
 import javax.activation.MimetypesFileTypeMap
 
+@Slf4j
 abstract class AmazonS3Api extends AbstractStorageApi {
 
     BlobStore blobStore
@@ -20,15 +26,15 @@ abstract class AmazonS3Api extends AbstractStorageApi {
     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}"
+
+        log.info "Context created ${context.class}"
 
         blobStore = context.getBlobStore()
-        println "BlobStore ${blobStore.class}"
+
+        log.info "BlobStore ${blobStore.class}"
 
         // Storing wrapped Api of S3Client with Apache JCloud
         client = context.unwrap().getApi()
@@ -55,6 +61,15 @@ abstract class AmazonS3Api extends AbstractStorageApi {
         return name + "." + extension
     }
 
+    @Override
+    String getFileName(StoredFile file) {
+        String name = UUID.randomUUID().toString()
+        String originalFileName = file.originalName
+        String extension = GrailsStringUtils.substringAfterLast(originalFileName, ".")
+
+        return name + "." + extension
+    }
+
     String getContainerName() {
         String name = service.container
         if (Environment.current != Environment.PRODUCTION) {
@@ -75,6 +90,62 @@ abstract class AmazonS3Api extends AbstractStorageApi {
 
     @Override
     void deleteNativeFile(StoredFile file) {
-        // TODO implement me
+        String container = this.containerName
+        String fileName = file.name
+
+        log.info "Deleting file ${file} with name ${fileName} from container ${container}."
+
+        this.authenticate()
+
+        if (!client.objectExists(container, fileName)) {
+            log.warn "File not present in the S3 bucket, deleting the Stored file instance."
+
+            file.delete()
+            this.close()
+
+            return
+        }
+
+        client.deleteObject(container, fileName)
+        file.delete()
+
+        this.close()
+    }
+
+    @Override
+    StoredFile cloneStoredFile(StoredFile file, String newGroupName) {
+        StoredFile clonedFile = new StoredFile()
+        clonedFile.originalName = file.originalName
+        clonedFile.groupName = newGroupName
+        clonedFile.size = file.size
+        clonedFile.name = getFileName(file)
+
+        String currentContainer = ConfigHelper.getGroup(file.groupName).container ?:
+                ConfigHelper.getFlatConfig("global.amazon.container")
+
+        String newContainer = getContainerName()
+
+        CopyObjectOptions fileOptions = new CopyObjectOptions()
+        // For now using the same policy of original file, it gets changed to private scope if not overridden.
+        fileOptions.overrideAcl(CannedAccessPolicy.PUBLIC_READ)
+
+        try {
+            this.authenticate()
+            client.copyObject(currentContainer, file.name, newContainer, clonedFile.name, fileOptions)
+            clonedFile.url = client.getObject(newContainer, clonedFile.name, null).metadata.uri
+
+            this.gormFile = clonedFile
+            this.gormFile.uploadedOn = new Date()
+
+            this.saveGORMFile()
+
+            log.info "Successfully cloned StoredFile: ${file} as ${this.gormFile}"
+
+            return this.gormFile
+        } catch (HttpResponseException hre) {
+            log.warn 'Could not copy StoredFile!', hre
+        } finally {
+            this.close()
+        }
     }
 }

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

@@ -17,6 +17,8 @@ interface StorageApi {
 
     String getFileName(File file)
 
+    String getFileName(StoredFile file)
+
     StoredFile saveGORMFile() throws FileUploadException
 
     /**
@@ -35,4 +37,7 @@ interface StorageApi {
     StoredFile save(MultipartFile multipartFile) throws FileUploadException
 
     void delete(StoredFile file)
+
+    // Used to clone an instance of StoredFile and get the new StoredFile instance.
+    StoredFile cloneStoredFile(StoredFile file, String newGroupName)
 }