Merge pull request #1303 from smartdevicelink/add_Overwrite_Property

Add overwrite property

Author: bilal-alsharifi

android/sdl_android/src/androidTest/java/com/smartdevicelink/managers/file/FileManagerTests.java

@@ -842,4 +842,87 @@ public void testFileManagerConfig() {
 		assertEquals(fileManagerConfig.getArtworkRetryCount(), 2);
 		assertEquals(fileManagerConfig.getFileRetryCount(), 2);
 	}
+
+	/**
+	 * Tests overwrite property for uploading a file.
+	 * Checks to make sure file does not overwrite itself if overwrite property is set to false
+	 */
+	public void testOverwriteFileProperty() {
+		ISdl internalInterface = mock(ISdl.class);
+
+		doAnswer(onListFilesSuccess).when(internalInterface).sendRPC(any(ListFiles.class));
+		doAnswer(onPutFileSuccess).when(internalInterface).sendRPC(any(PutFile.class));
+
+		FileManagerConfig fileManagerConfig = new FileManagerConfig();
+
+		final FileManager fileManager = new FileManager(internalInterface, mTestContext, fileManagerConfig);
+		fileManager.start(new CompletionListener() {
+			@Override
+			public void onComplete(boolean success) {
+				assertTrue(success);
+				fileManager.uploadFile(validFile, new CompletionListener() {
+					@Override
+					public void onComplete(boolean success) {
+						assertTrue(success);
+						validFile.setOverwrite(false);
+						fileManager.uploadFile(validFile, new CompletionListener() {
+							@Override
+							public void onComplete(boolean success) {
+								assertTrue(success);
+							}
+						});
+
+					}
+				});
+			}
+		});
+		verify(internalInterface, times(2)).sendRPC(any(RPCMessage.class));
+	}
+
+	/**
+	 * Tests overwrite property for uploading a list of files.
+	 * Checks to make sure files do not overwrite themselves if overwrite property is set to false.
+	 */
+	public void testOverWriteFilePropertyListFiles() {
+		final ISdl internalInterface = mock(ISdl.class);
+
+		doAnswer(onListFilesSuccess).when(internalInterface).sendRPC(any(ListFiles.class));
+		doAnswer(onListFileUploadSuccess).when(internalInterface).sendRequests(any(List.class), any(OnMultipleRequestListener.class));
+
+		final SdlFile validFile2 = new SdlFile();
+		validFile2.setName(Test.GENERAL_STRING + "2");
+		validFile2.setFileData(Test.GENERAL_BYTE_ARRAY);
+		validFile2.setPersistent(false);
+		validFile2.setType(FileType.GRAPHIC_JPEG);
+
+		final List<SdlFile> list = new ArrayList<>();
+		list.add(validFile);
+		list.add(validFile2);
+
+		FileManagerConfig fileManagerConfig = new FileManagerConfig();
+		fileManagerConfig.setArtworkRetryCount(2);
+		fileManagerConfig.setFileRetryCount(4);
+
+		final FileManager fileManager = new FileManager(internalInterface, mTestContext, fileManagerConfig);
+		fileManager.start(new CompletionListener() {
+			@Override
+			public void onComplete(boolean success) {
+				fileManager.uploadFiles(list, new MultipleFileCompletionListener() {
+					@Override
+					public void onComplete(Map<String, String> errors) {
+						validFile.setOverwrite(false);
+						validFile2.setOverwrite(false);
+						fileManager.uploadFiles(list, new MultipleFileCompletionListener() {
+							@Override
+							public void onComplete(Map<String, String> errors) {
+								assertNull(errors);
+							}
+						});
+					}
+				});
+
+			}
+		});
+		verify(internalInterface, times(1)).sendRequests(any(List.class), any(OnMultipleRequestListener.class));
+	}
 }

android/sdl_android/src/main/java/com/smartdevicelink/managers/file/filetypes/SdlArtwork.java

@@ -51,7 +51,7 @@ public class SdlArtwork extends SdlFile implements Cloneable{
     /**
      * Creates a new instance of SdlArtwork
      */
-    public SdlArtwork(){}
+    public SdlArtwork() {}
 
     /**
      * Creates a new instance of SdlArtwork

android/sdl_android/src/main/java/com/smartdevicelink/managers/file/filetypes/SdlFile.java

@@ -42,18 +42,20 @@
  * A class representing data to be uploaded to core
  */
 public class SdlFile{
-    private String      fileName;
-    private int         id = -1;
-    private Uri         uri;
-    private byte[]      fileData;
-    private FileType    fileType;
-    private boolean     persistentFile;
-    private boolean     isStaticIcon;
+    private String fileName;
+    private int id = -1;
+    private Uri uri;
+    private byte[] fileData;
+    private FileType fileType;
+    private boolean persistentFile;
+    private boolean isStaticIcon;
+    // Overwrite property by default is set to true in SdlFile constructors indicating that a file can be overwritten
+    private boolean overwrite = true;
 
     /**
      * Creates a new instance of SdlFile
      */
-    public SdlFile(){}
+    public SdlFile() { }
 
     /**
      * Creates a new instance of SdlFile
@@ -219,4 +221,20 @@ public void setStaticIcon(boolean staticIcon) {
     public boolean isStaticIcon() {
         return isStaticIcon;
     }
+
+    /**
+     * Gets the overwrite property for an SdlFile by default its set to true
+     * @return a boolean value that indicates if a file can be overwritten.
+     */
+    public boolean getOverwrite() {
+        return overwrite;
+    }
+
+    /**
+     * Sets the overwrite property for an SdlFile by default its set to true
+     * @param overwrite a boolean value that indicates if a file can be overwritten
+     */
+    public void setOverwrite(boolean overwrite) {
+        this.overwrite = overwrite;
+    }
 }

base/src/main/java/com/smartdevicelink/managers/file/BaseFileManager.java

@@ -325,7 +325,12 @@ public void onResponse(int correlationId, RPCResponse response) {
 	 */
 	public void uploadFile(@NonNull final SdlFile file, final CompletionListener listener) {
 		if (file.isStaticIcon()) {
-			Log.w(TAG, "Static icons don't need to be uploaded");
+			Log.w(TAG, String.format("%s is a static icon and doesn't need to be uploaded", file.getName()));
+			listener.onComplete(true);
+			return;
+		}
+		if (!file.getOverwrite() && hasUploadedFile(file)) {
+			Log.w(TAG, String.format("%s has already been uploaded and the overwrite property is set to false. It will not be uploaded again", file.getName()));
 			listener.onComplete(true);
 			return;
 		}
@@ -392,13 +397,18 @@ public void uploadFiles(@NonNull List<? extends SdlFile> files, final MultipleFi
 		}
 		final List<PutFile> putFileRequests = new ArrayList<>();
 		for (SdlFile file : files) {
-			if (!file.isStaticIcon()) {
-				putFileRequests.add(createPutFile(file));
+			if (file.isStaticIcon()) {
+				Log.w(TAG, String.format("%s is a static icon and doesn't need to be uploaded", file.getName()));
+				continue;
+			}
+			if (!file.getOverwrite() && hasUploadedFile(file)) {
+				Log.w(TAG, String.format("%s has already been uploaded and the overwrite property is set to false. It will not be uploaded again", file.getName()));
+				continue;
 			}
+			putFileRequests.add(createPutFile(file));
 		}
 		// if all files are static icons we complete listener with no errors
 		if (putFileRequests.isEmpty()) {
-			Log.w(TAG, "Static icons don't need to be uploaded");
 			listener.onComplete(null);
 		} else {
 			final Map<String, String> errors = new HashMap<>();

javaSE/src/main/java/com/smartdevicelink/managers/file/filetypes/SdlFile.java

@@ -39,12 +39,14 @@
  * A class representing data to be uploaded to core
  */
 public class SdlFile{
-    private String      fileName;
-    private String      filePath;
-    private byte[]      fileData;
-    private FileType    fileType;
-    private boolean     persistentFile;
-    private boolean     isStaticIcon;
+    private String fileName;
+    private String filePath;
+    private byte[] fileData;
+    private FileType fileType;
+    private boolean persistentFile;
+    private boolean isStaticIcon;
+    // Overwrite property by default is set to true in SdlFile constructors indicating that a file can be overwritten
+    private boolean overwrite = true;
 
     /**
      * Creates a new instance of SdlFile
@@ -185,4 +187,20 @@ public void setStaticIcon(boolean staticIcon) {
     public boolean isStaticIcon() {
         return isStaticIcon;
     }
+
+    /**
+     * Gets the overwrite property for an SdlFile by default its set to true
+     * @return a boolean value that indicates if a file can be overwritten.
+     */
+    public boolean getOverwrite() {
+        return overwrite;
+    }
+
+    /**
+     * Sets the overwrite property for an SdlFile by default its set to true
+     * @param overwrite a boolean value that indicates if a file can be overwritten
+     */
+    public void setOverwrite(boolean overwrite) {
+        this.overwrite = overwrite;
+    }
 }