Generate name for SdlFile if not provided by dev (javaSE)

Author: bilal-alsharifi

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

@@ -116,18 +116,18 @@ public SdlFile(@NonNull StaticIconName staticIconName){
      * Sets the name of the file
      * @param fileName a String value representing the name that will be used to store the file in the head unit. You can pass null if you want the library to auto generate the name
      */
-    public void setName(String fileName){
+    public void setName(String fileName) {
         if (fileName != null) {
             this.shouldAutoGenerateName = false;
             this.fileName = fileName;
         } else {
             this.shouldAutoGenerateName = true;
             if (this.getFileData() != null) {
                 this.fileName = generateFileNameFromData(this.getFileData());
-            } else if (this.getUri() != null){
-                this.fileName = generateFileNameFromUri(uri);
-            } else if (this.getResourceId() != 0){
-                this.fileName = generateFileNameFromResourceId(this.id);
+            } else if (this.getUri() != null) {
+                this.fileName = generateFileNameFromUri(this.getUri());
+            } else if (this.getResourceId() != 0) {
+                this.fileName = generateFileNameFromResourceId(this.getResourceId());
             }
         }
     }
@@ -273,7 +273,7 @@ private String generateFileNameFromData(@NonNull byte[] data) {
     }
 
     /**
-     * Generates a file name from data by hashing the uri and returning the last 16 chars
+     * Generates a file name from uri by hashing the uri string and returning the last 16 chars
      * @param uri a URI value representing a file's location
      * @return a String value representing the name that will be used to store the file in the head unit
      */
@@ -282,7 +282,7 @@ private String generateFileNameFromUri(@NonNull Uri uri) {
     }
 
     /**
-     * Generates a file name from data by hashing the id and returning the last 16 chars
+     * Generates a file name from resourceId by hashing the id and returning the last 16 chars
      * @param id an int value representing the android resource id of the file
      * @return a String value representing the name that will be used to store the file in the head unit
      */

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

@@ -52,23 +52,23 @@ public SdlArtwork(){}
 
     /**
      * Creates a new instance of SdlArtwork
-     * @param fileName a String value representing the name that will be used to store the file in the head unit
+     * @param fileName a String value representing the name that will be used to store the file in the head unit. You can pass null if you want the library to auto generate the name
      * @param fileType a FileType enum value representing the type of the file
      * @param filePath a String value representing the the location of the file
      * @param persistentFile a boolean value that indicates if the file is meant to persist between sessions / ignition cycles
      */
-    public SdlArtwork(@NonNull String fileName, @NonNull FileType fileType, String filePath, boolean persistentFile) {
+    public SdlArtwork(String fileName, @NonNull FileType fileType, String filePath, boolean persistentFile) {
         super(fileName, fileType, filePath, persistentFile);
     }
 
     /**
      * Creates a new instance of SdlArtwork
-     * @param fileName a String value representing the name that will be used to store the file in the head unit
+     * @param fileName a String value representing the name that will be used to store the file in the head unit. You can pass null if you want the library to auto generate the name
      * @param fileType a FileType enum value representing the type of the file
      * @param data a byte array representing the data of the file
      * @param persistentFile a boolean value that indicates if the file is meant to persist between sessions / ignition cycles
      */
-    public SdlArtwork(@NonNull String fileName, @NonNull FileType fileType, byte[] data, boolean persistentFile) {
+    public SdlArtwork(String fileName, @NonNull FileType fileType, byte[] data, boolean persistentFile) {
         super(fileName, fileType, data, persistentFile);
     }
 

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

@@ -32,9 +32,13 @@
 package com.smartdevicelink.managers.file.filetypes;
 
 import android.support.annotation.NonNull;
+
 import com.smartdevicelink.proxy.rpc.enums.FileType;
 import com.smartdevicelink.proxy.rpc.enums.StaticIconName;
 
+import java.security.MessageDigest;
+import java.security.NoSuchAlgorithmException;
+
 /**
  * A class representing data to be uploaded to core
  */
@@ -45,6 +49,8 @@ public class SdlFile{
     private FileType    fileType;
     private boolean     persistentFile;
     private boolean     isStaticIcon;
+    private boolean     shouldAutoGenerateName;
+
 
     /**
      * Creates a new instance of SdlFile
@@ -53,49 +59,59 @@ public SdlFile(){}
 
     /**
      * Creates a new instance of SdlFile
-     * @param fileName a String value representing the name that will be used to store the file in the head unit
+     * @param fileName a String value representing the name that will be used to store the file in the head unit. You can pass null if you want the library to auto generate the name
      * @param fileType a FileType enum value representing the type of the file
      * @param filePath a String value representing the the location of the file
      * @param persistentFile a boolean value that indicates if the file is meant to persist between sessions / ignition cycles
      */
-    public SdlFile(@NonNull String fileName, @NonNull FileType fileType, String filePath, boolean persistentFile){
-        this.fileName = fileName;
-        this.fileType = fileType;
-        this.filePath = filePath;
-        this.persistentFile = persistentFile;
+    public SdlFile(String fileName, @NonNull FileType fileType, String filePath, boolean persistentFile){
+        setName(fileName);
+        setType(fileType);
+        setFilePath(filePath);
+        setPersistent(persistentFile);
     }
 
     /**
      * Creates a new instance of SdlFile
-     * @param fileName a String value representing the name that will be used to store the file in the head unit
+     * @param fileName a String value representing the name that will be used to store the file in the head unit. You can pass null if you want the library to auto generate the name
      * @param fileType a FileType enum value representing the type of the file
      * @param data a byte array representing the data of the file
      * @param persistentFile a boolean value that indicates if the file is meant to persist between sessions / ignition cycles
      */
-    public SdlFile(@NonNull String fileName, @NonNull FileType fileType, byte[] data, boolean persistentFile){
-        this.fileName = fileName;
-        this.fileType = fileType;
-        this.fileData = data;
-        this.persistentFile = persistentFile;
+    public SdlFile(String fileName, @NonNull FileType fileType, byte[] data, boolean persistentFile){
+        setName(fileName);
+        setType(fileType);
+        setFileData(data);
+        setPersistent(persistentFile);
     }
 
     /**
      * Creates a new instance of SdlFile
      * @param staticIconName a StaticIconName enum value representing the name of a static file that comes pre-shipped with the head unit
      */
     public SdlFile(@NonNull StaticIconName staticIconName){
-        this.fileName = staticIconName.toString();
-        this.fileData = staticIconName.toString().getBytes();
-        this.persistentFile = false;
-        this.isStaticIcon = true;
+        setName(staticIconName.toString());
+        setFileData(staticIconName.toString().getBytes());
+        setPersistent(false);
+        setStaticIcon(true);
     }
 
     /**
      * Sets the name of the file
-     * @param fileName a String value representing the name that will be used to store the file in the head unit
-     */
-    public void setName(@NonNull String fileName){
-        this.fileName = fileName;
+     * @param fileName a String value representing the name that will be used to store the file in the head unit. You can pass null if you want the library to auto generate the name
+     */
+    public void setName(String fileName) {
+        if (fileName != null) {
+            this.shouldAutoGenerateName = false;
+            this.fileName = fileName;
+        } else {
+            this.shouldAutoGenerateName = true;
+            if (this.getFileData() != null) {
+                this.fileName = generateFileNameFromData(this.getFileData());
+            } else if (this.getFilePath() != null) {
+                this.fileName = generateFileNameFromFilePath(this.getFilePath());
+            }
+        }
     }
 
     /**
@@ -112,6 +128,9 @@ public String getName(){
      */
     public void setFilePath(String filePath){
         this.filePath = filePath;
+        if (shouldAutoGenerateName && filePath != null) {
+            this.fileName = generateFileNameFromFilePath(filePath);
+        }
     }
 
     /**
@@ -128,6 +147,9 @@ public String getFilePath(){
      */
     public void setFileData(byte[] data){
         this.fileData = data;
+        if (shouldAutoGenerateName && data != null) {
+            this.fileName = generateFileNameFromData(data);
+        }
     }
 
     /**
@@ -185,4 +207,40 @@ public void setStaticIcon(boolean staticIcon) {
     public boolean isStaticIcon() {
         return isStaticIcon;
     }
+
+    /**
+     * Generates a file name from data by hashing the data and returning the last 16 chars
+     * @param data a byte array representing the data of the file
+     * @return a String value representing the name that will be used to store the file in the head unit
+     */
+    private String generateFileNameFromData(@NonNull byte[] data) {
+        String result;
+        MessageDigest messageDigest;
+        try {
+            messageDigest = MessageDigest.getInstance("md5");
+        } catch (NoSuchAlgorithmException e) {
+            e.printStackTrace();
+            return null;
+        }
+        byte[] hash = new byte[0];
+        if (messageDigest != null) {
+            hash = messageDigest.digest(data);
+        }
+        StringBuilder stringBuilder = new StringBuilder(2 * hash.length);
+        for (byte b : hash) {
+            stringBuilder.append(String.format("%02x", b & 0xff));
+        }
+        String hashString = stringBuilder.toString();
+        result = hashString.substring(hashString.length() - 16);
+        return result;
+    }
+
+    /**
+     * Generates a file name from filePath by hashing the filePath and returning the last 16 chars
+     * @param filePath a String value representing the the location of the file
+     * @return a String value representing the name that will be used to store the file in the head unit
+     */
+    private String generateFileNameFromFilePath(String filePath) {
+        return generateFileNameFromData(filePath.getBytes());
+    }
 }