Merge pull request #1470 from smartdevicelink/feature/issue_1469_sdl_file_uri

JavaSE - Add SdlFile constructor that takes URI

Author: Robert Henigan

javaSE/src/main/java/com/smartdevicelink/managers/file/FileManager.java

@@ -36,8 +36,13 @@
 import com.smartdevicelink.managers.file.filetypes.SdlFile;
 import com.smartdevicelink.proxy.interfaces.ISdl;
 import com.smartdevicelink.proxy.rpc.PutFile;
+import com.smartdevicelink.util.DebugTool;
 import com.smartdevicelink.util.FileUtls;
 
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URI;
+
 /**
  * <strong>FileManager</strong> <br>
  *
@@ -94,6 +99,14 @@ PutFile createPutFile(@NonNull final SdlFile file){
 			}else{
 				throw new IllegalArgumentException("File at path was empty");
 			}
+		}else if(file.getURI() != null){
+			// Use URI to upload file
+			byte[] data = contentsOfUri(file.getURI());
+			if(data != null){
+				putFile.setFileData(data);
+			}else{
+				throw new IllegalArgumentException("Uri was empty");
+			}
 		}else if(file.getFileData() != null){
 			// Use file data (raw bytes) to upload file
 			putFile.setFileData(file.getFileData());
@@ -110,4 +123,28 @@ PutFile createPutFile(@NonNull final SdlFile file){
 		return putFile;
 	}
 
+
+	/**
+	 * Helper method to take Uri and turn it into byte array
+	 * @param uri Uri for desired file
+	 * @return Resulting byte array
+	 */
+	private byte[] contentsOfUri(URI uri){
+		InputStream is = null;
+		try{
+			is = uri.toURL().openStream();
+			return contentsOfInputStream(is);
+		} catch (IOException e){
+			DebugTool.logError(TAG, "Can't read from URI", e);
+			return null;
+		} finally {
+			if (is != null) {
+				try {
+					is.close();
+				} catch (IOException e) {
+					e.printStackTrace();
+				}
+			}
+		}
+	}
 }

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

@@ -38,6 +38,8 @@
 import com.smartdevicelink.proxy.rpc.enums.StaticIconName;
 import com.smartdevicelink.util.DebugTool;
 
+import java.net.URI;
+
 /**
  * A class that extends SdlFile, representing artwork (JPEG, PNG, or BMP) to be uploaded to core
  */
@@ -61,6 +63,17 @@ public SdlArtwork(String fileName, @NonNull FileType fileType, String filePath,
         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. 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 uri a URI value representing a file's location. Currently, it only supports local files
+     * @param persistentFile a boolean value that indicates if the file is meant to persist between sessions / ignition cycles
+     */
+    public SdlArtwork(String fileName, @NonNull FileType fileType, URI uri, boolean persistentFile) {
+        super(fileName, fileType, uri, 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. You can pass null if you want the library to auto generate the name

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

@@ -36,6 +36,7 @@
 import com.smartdevicelink.proxy.rpc.enums.FileType;
 import com.smartdevicelink.proxy.rpc.enums.StaticIconName;
 
+import java.net.URI;
 import java.security.MessageDigest;
 import java.security.NoSuchAlgorithmException;
 
@@ -45,6 +46,7 @@
 public class SdlFile{
     private String fileName;
     private String filePath;
+    private URI uri;
     private byte[] fileData;
     private FileType fileType;
     private boolean persistentFile;
@@ -72,6 +74,20 @@ public SdlFile(String fileName, @NonNull FileType fileType, String filePath, boo
         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. 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 uri a URI value representing a file's location. Currently, it only supports local files
+     * @param persistentFile a boolean value that indicates if the file is meant to persist between sessions / ignition cycles
+     */
+    public SdlFile(String fileName, @NonNull FileType fileType, URI uri, boolean persistentFile){
+        setName(fileName);
+        setType(fileType);
+        setURI(uri);
+        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. You can pass null if you want the library to auto generate the name
@@ -109,6 +125,8 @@ public void setName(String fileName) {
             this.shouldAutoGenerateName = true;
             if (this.getFileData() != null) {
                 this.fileName = generateFileNameFromData(this.getFileData());
+            } else if (this.getURI() != null) {
+                this.fileName = generateFileNameFromUri(this.getURI());
             } else if (this.getFilePath() != null) {
                 this.fileName = generateFileNameFromFilePath(this.getFilePath());
             }
@@ -142,6 +160,25 @@ public String getFilePath(){
         return this.filePath;
     }
 
+    /**
+     * Sets the uri of the file
+     * @param uri a URI value representing a file's location. Currently, it only supports local files
+     */
+    public void setURI(URI uri){
+        this.uri = uri;
+        if (shouldAutoGenerateName && uri != null) {
+            this.fileName = generateFileNameFromUri(uri);
+        }
+    }
+
+    /**
+     * Gets the uri of the file
+     * @return a URI value representing a file's location. Currently, it only supports local files
+     */
+    public URI getURI(){
+        return uri;
+    }
+
     /**
      * Sets the byte array that represents the content of the file
      * @param data a byte array representing the data of the file
@@ -261,6 +298,15 @@ private String generateFileNameFromFilePath(String filePath) {
         return generateFileNameFromData(filePath.getBytes());
     }
 
+    /**
+     * 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
+     */
+    private String generateFileNameFromUri(@NonNull URI uri) {
+        return generateFileNameFromData(uri.toString().getBytes());
+    }
+
     /**
      * Used to compile hashcode for SdlFile for use to compare in equals method
      * @return Custom hashcode of SdlFile variables
@@ -269,11 +315,12 @@ private String generateFileNameFromFilePath(String filePath) {
     public int hashCode() {
         int result = 1;
         result += ((getName() == null) ? 0 : Integer.rotateLeft(getName().hashCode(), 1));
-        result += ((getFilePath() == null) ? 0 : Integer.rotateLeft(getFilePath().hashCode(), 2));
-        result += ((getFileData() == null) ? 0 : Integer.rotateLeft(getFileData().hashCode(), 3));
-        result += ((getType() == null) ? 0 : Integer.rotateLeft(getType().hashCode(), 4));
-        result += Integer.rotateLeft(Boolean.valueOf(isStaticIcon()).hashCode(), 5);
-        result += Integer.rotateLeft(Boolean.valueOf(isPersistent()).hashCode(), 6);
+        result += ((getURI() == null) ? 0 : Integer.rotateLeft(getURI().hashCode(), 2));
+        result += ((getFilePath() == null) ? 0 : Integer.rotateLeft(getFilePath().hashCode(), 3));
+        result += ((getFileData() == null) ? 0 : Integer.rotateLeft(getFileData().hashCode(), 4));
+        result += ((getType() == null) ? 0 : Integer.rotateLeft(getType().hashCode(), 5));
+        result += Integer.rotateLeft(Boolean.valueOf(isStaticIcon()).hashCode(), 6);
+        result += Integer.rotateLeft(Boolean.valueOf(isPersistent()).hashCode(), 7);
         return result;
     }