GP-4455 Changed RemoteFileItem to cache FileID

Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/remote/RepositoryItem.java

@@ -48,6 +48,7 @@ public class RepositoryItem implements java.io.Serializable {
 	 * Constructor.
 	 * @param folderPath path of folder containing item.
 	 * @param itemName name of item
+	 * @param fileID unique file ID
 	 * @param itemType type of item (FILE or DATABASE)
 	 * @param contentType content type associated with item
 	 * @param version repository item version or -1 if versioning not supported
@@ -66,8 +67,8 @@ public class RepositoryItem implements java.io.Serializable {
 
 	/**
 	 * Serialization method
-	 * @param out
+	 * @param out serialization output stream
-	 * @throws IOException
+	 * @throws IOException if an IO error occurs
 	 */
 	private void writeObject(java.io.ObjectOutputStream out) throws IOException {
 		out.writeLong(serialVersionUID);
@@ -82,9 +83,9 @@ public class RepositoryItem implements java.io.Serializable {
 
 	/**
 	 * Deserialization method
-	 * @param in
+	 * @param in deserialization input stream
-	 * @throws IOException
+	 * @throws IOException if IO error occurs
-	 * @throws ClassNotFoundException
+	 * @throws ClassNotFoundException if unrecognized serialVersionUID detected
 	 */
 	private void readObject(java.io.ObjectInputStream in) throws IOException,
 			ClassNotFoundException {

Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/remote/RemoteDatabaseItem.java

@@ -57,13 +57,13 @@ public class RemoteDatabaseItem extends RemoteFolderItem implements DatabaseItem
 	}
 
 	@Override
-	public ManagedBufferFileAdapter open(int version, int minChangeDataVer) throws IOException {
+	public ManagedBufferFileAdapter open(int fileVersion, int minChangeDataVer) throws IOException {
-		return repository.openDatabase(parentPath, itemName, version, minChangeDataVer);
+		return repository.openDatabase(parentPath, itemName, fileVersion, minChangeDataVer);
 	}
 
 	@Override
-	public ManagedBufferFileAdapter open(int version) throws IOException {
+	public ManagedBufferFileAdapter open(int fileVersion) throws IOException {
-		return repository.openDatabase(parentPath, itemName, version, -1);
+		return repository.openDatabase(parentPath, itemName, fileVersion, -1);
 	}
 
 	@Override
@@ -82,9 +82,6 @@ public class RemoteDatabaseItem extends RemoteFolderItem implements DatabaseItem
 		repository.updateCheckoutVersion(parentPath, itemName, checkoutId, checkoutVersion);
 	}
 
-	/*
-	 * @see ghidra.framework.store.FolderItem#hasCheckouts()
-	 */
 	@Override
 	public boolean hasCheckouts() throws IOException {
 		return repository.hasCheckouts(parentPath, itemName);
@@ -96,10 +93,10 @@ public class RemoteDatabaseItem extends RemoteFolderItem implements DatabaseItem
 	}
 
 	@Override
-	public void output(File outputFile, int version, TaskMonitor monitor)
+	public void output(File outputFile, int fileVersion, TaskMonitor monitor)
 			throws IOException, CancelledException {
 
-		BufferFile bf = repository.openDatabase(parentPath, itemName, version, -1);
+		BufferFile bf = repository.openDatabase(parentPath, itemName, fileVersion, -1);
 		try {
 			File tmpFile = File.createTempFile("ghidra", LocalBufferFile.TEMP_FILE_EXT);
 			tmpFile.delete();
@@ -108,18 +105,10 @@ public class RemoteDatabaseItem extends RemoteFolderItem implements DatabaseItem
 				LocalBufferFile.copyFile(bf, tmpBf, null, monitor);
 				tmpBf.close();
 
-				InputStream itemIn = new FileInputStream(tmpFile);
+				try (InputStream itemIn = new FileInputStream(tmpFile)) {
-				try {
 					ItemSerializer.outputItem(getName(), getContentType(), DATABASE_FILE_TYPE,
 						tmpFile.length(), itemIn, outputFile, monitor);
 				}
-				finally {
-					try {
-						itemIn.close();
-					}
-					catch (IOException e) {
-					}
-				}
 			}
 			finally {
 				tmpBf.close();

Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/remote/RemoteFolderItem.java

@@ -27,9 +27,11 @@ import ghidra.framework.store.*;
  */
 public abstract class RemoteFolderItem implements FolderItem {
 
-	protected String parentPath;
+	protected final String parentPath;
-	protected String itemName;
+	protected final String itemName;
-	protected String contentType;
+	protected final String contentType;
+	protected final String fileID;
+
 	protected int version;
 	protected long versionTime;
 
@@ -45,26 +47,26 @@ public abstract class RemoteFolderItem implements FolderItem {
 		parentPath = item.getParentPath();
 		itemName = item.getName();
 		contentType = item.getContentType();
+		fileID = item.getFileID();
+
 		version = item.getVersion();
 		versionTime = item.getVersionTime();
 	}
 
 	/**
-	 * Returns the item type as defined by RepositoryItem.
+	 * Returns the item type as defined by RepositoryItem which corresponds to specific 
+	 * implementation of this class.
+	 * @return item type (Only {@link RepositoryItem#DATABASE} is supported).
 	 * @see ghidra.framework.remote.RepositoryItem
 	 */
 	abstract int getItemType();
 
-	/*
+	@Override
-	 * @see ghidra.framework.store.FolderItem#getName()
-	 */
 	public String getName() {
 		return itemName;
 	}
 
-	/*
+	@Override
-	 * @see ghidra.framework.store.FolderItem#refresh()
-	 */
 	public RemoteFolderItem refresh() throws IOException {
 		RepositoryItem item = repository.getItem(parentPath, itemName);
 		if (item == null) {
@@ -75,42 +77,27 @@ public abstract class RemoteFolderItem implements FolderItem {
 		return this;
 	}
 
-	/**
+	@Override
-	 * @throws IOException 
+	public String getFileID() {
-	 * @see ghidra.framework.store.FolderItem#getFileID()
+		return fileID;
-	 */
-	public String getFileID() throws IOException {
-		RepositoryItem item = repository.getItem(parentPath, itemName);
-		if (item != null) {
-			return item.getFileID();
-		}
-		return null;
 	}
 
-	/**
+	@Override
-	 * @see ghidra.framework.store.FolderItem#resetFileID()
-	 */
 	public String resetFileID() {
 		throw new UnsupportedOperationException();
 	}
 
-	/*
+	@Override
-	 * @see ghidra.framework.store.FolderItem#getContentType()
-	 */
 	public String getContentType() {
 		return contentType;
 	}
 
-	/*
+	@Override
-	 * @see ghidra.framework.store.FolderItem#getParentPath()
-	 */
 	public String getParentPath() {
 		return parentPath;
 	}
 
-	/*
+	@Override
-	 * @see ghidra.framework.store.FolderItem#getPathName()
-	 */
 	public String getPathName() {
 		String path = parentPath;
 		if (path.length() != 1) {
@@ -119,149 +106,110 @@ public abstract class RemoteFolderItem implements FolderItem {
 		return path + itemName;
 	}
 
-	/*
+	@Override
-	 * @see ghidra.framework.store.FolderItem#isReadOnly()
-	 */
 	public boolean isReadOnly() {
 		throw new UnsupportedOperationException("isReadOnly is not applicable to versioned item");
 	}
 
-	/*
+	@Override
-	 * @see ghidra.framework.store.FolderItem#setReadOnly(boolean)
-	 */
 	public void setReadOnly(boolean state) {
 		throw new UnsupportedOperationException("setReadOnly is not applicable to versioned item");
 	}
 
-	/**
+	@Override
-	 * Returns the version of content type.  Note this is the version of the structure/storage
-	 * for the content type, Not the users version of their data.
-	 */
 	public int getContentTypeVersion() {
 		throw new UnsupportedOperationException(
 			"getContentTypeVersion is not applicable to versioned item");
 	}
 
-	/**
+	@Override
-	 * @see ghidra.framework.store.FolderItem#setContentTypeVersion(int)
-	 */
 	public void setContentTypeVersion(int version) throws IOException {
 		throw new UnsupportedOperationException(
 			"setContentTypeVersion is not applicable to versioned item");
 	}
 
-	/*
+	@Override
-	 * @see ghidra.framework.store.FolderItem#lastModified()
-	 */
 	public long lastModified() {
 		return versionTime;
 	}
 
-	/*
+	@Override
-	 * @see ghidra.framework.store.FolderItem#getCurrentVersion()
-	 */
 	public int getCurrentVersion() {
 		return version;
 	}
 
-	/*
+	@Override
-	 * @see ghidra.framework.store.FolderItem#isVersioned()
-	 */
 	public boolean isVersioned() {
 		return (version != -1);
 	}
 
-	/*
+	@Override
-	 * @see ghidra.framework.store.FolderItem#getVersions()
-	 */
 	public Version[] getVersions() throws IOException {
 		return repository.getVersions(parentPath, itemName);
 	}
 
-	/*
+	@Override
-	 * @see ghidra.framework.store.FolderItem#delete(int, java.lang.String)
-	 */
 	public void delete(int ver, String user) throws IOException {
 		repository.deleteItem(parentPath, itemName, ver);
 	}
 
-	/*
+	@Override
-	 * @see ghidra.framework.store.FolderItem#isPrivate()
-	 */
 	public boolean isCheckedOut() {
 		throw new UnsupportedOperationException("isCheckedOut is not applicable to versioned item");
 	}
 
-	/*
+	@Override
-	 * @see ghidra.framework.store.FolderItem#isCheckedOutExclusive()
-	 */
 	public boolean isCheckedOutExclusive() {
 		throw new UnsupportedOperationException(
 			"isCheckedOutExclusive is not applicable to versioned item");
 	}
 
-	/*
+	@Override
-	 * @see ghidra.framework.store.FolderItem#checkout(boolean, java.lang.String, java.lang.String)
-	 */
 	public ItemCheckoutStatus checkout(CheckoutType checkoutType, String user, String projectPath)
 			throws IOException {
 		return repository.checkout(parentPath, itemName, checkoutType, projectPath);
 	}
 
-	/*
+	@Override
-	 * @see ghidra.framework.store.FolderItem#terminateCheckout(long, boolean)
-	 */
 	public void terminateCheckout(long checkoutId, boolean notify) throws IOException {
 		repository.terminateCheckout(parentPath, itemName, checkoutId, notify);
 	}
 
-	/*
+	@Override
-	 * @see ghidra.framework.store.FolderItem#getCheckout(long)
-	 */
 	public ItemCheckoutStatus getCheckout(long checkoutId) throws IOException {
 		return repository.getCheckout(parentPath, itemName, checkoutId);
 	}
 
-	/*
+	@Override
-	 * @see ghidra.framework.store.FolderItem#getCheckouts()
-	 */
 	public ItemCheckoutStatus[] getCheckouts() throws IOException {
 		return repository.getCheckouts(parentPath, itemName);
 	}
 
-	/*
+	@Override
-	 * @see ghidra.framework.store.FolderItem#clearCheckout()
-	 */
 	public void clearCheckout() throws IOException {
-		throw new UnsupportedOperationException("clearCheckout is not applicable to versioned item");
+		throw new UnsupportedOperationException(
+			"clearCheckout is not applicable to versioned item");
 	}
 
-	/*
+	@Override
-	 * @see ghidra.framework.store.FolderItem#getCheckoutId()
-	 */
 	public long getCheckoutId() throws IOException {
-		throw new UnsupportedOperationException("getCheckoutId is not applicable to versioned item");
+		throw new UnsupportedOperationException(
+			"getCheckoutId is not applicable to versioned item");
 	}
 
-	/*
+	@Override
-	 * @see ghidra.framework.store.FolderItem#getCheckoutVersion()
-	 */
 	public int getCheckoutVersion() throws IOException {
 		throw new UnsupportedOperationException(
 			"getCheckoutVersion is not applicable to versioned item");
 	}
 
-	/*
+	@Override
-	 * @see ghidra.framework.store.FolderItem#getLocalCheckoutVersion()
-	 */
 	public int getLocalCheckoutVersion() {
 		throw new UnsupportedOperationException(
 			"getLocalCheckoutVersion is not applicable to versioned item");
 	}
 
-	/*
+	@Override
-	 * @see ghidra.framework.store.FolderItem#setCheckout(long, boolean, int, int)
-	 */
 	public void setCheckout(long checkoutId, boolean exclusive, int checkoutVersion,
 			int localVersion) throws IOException {
 		throw new UnsupportedOperationException("setCheckout is not applicable to versioned item");