Package ghidra.formats.gfilesystem
Class GFileSystemBase
java.lang.Object
ghidra.formats.gfilesystem.GFileSystemBase
- All Implemented Interfaces:
GFileSystem
,ExtensionPoint
,Closeable
,AutoCloseable
This is the original GFileSystem implementation abstract base class, with most of the
initially implemented filesystem types extending this class.
The new GFileSystem interface is being retro-fitted into this equation to support better probing and factory syntax, and new implementations should be based on the interface instead of extending this abstract class.
NOTE: ALL GFileSystem sub-CLASSES MUST END IN "FileSystem". If not, the ClassSearcher will not find them. Yes, it is an implementation detail.
GFileSystemBase instances are constructed when probing a container file and are queried
with isValid(TaskMonitor)
to determine if the container file is handled
by the GFileSystemBase subclass.
The ByteProvider
given to the constructor is not considered 'owned' by
the GFileSystemBase instance until after it passes the isValid
check and is opened
.
-
Field Summary
Modifier and TypeFieldDescriptionprotected String
protected FileSystemService
protected ByteProvider
protected GFileImpl
-
Constructor Summary
ModifierConstructorDescriptionprotected
GFileSystemBase
(String fileSystemName, ByteProvider provider) -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Closes the file system.protected void
Writes the given bytes to a tempfile in the temp directory.protected Comparator
<String> Override to specify a file-system specific name comparator.getFSRL()
File system's FSRLgetListing
(GFile directory) Returns a list offiles
that reside in the specified directory on this filesystem.final String
getName()
Returns the name of this file system.Returns theref manager
that is responsible for creating and releasingrefs
to this filesystem.boolean
isClosed()
Returns true if the filesystem has beenclosed
abstract boolean
isValid
(TaskMonitor monitor) Returns true if this file system implementation can handle the bytes provided.Retrieves aGFile
from this filesystem based on its full path and filename, using this filesystem's default name comparison logic (eg.abstract void
open
(TaskMonitor monitor) Opens the file system.void
setFilesystemService
(FileSystemService fsService) void
toString()
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface ghidra.formats.gfilesystem.GFileSystem
getByteProvider, getDescription, getFileAttributes, getFileCount, getInputStream, getRootDir, getType, isStatic, resolveSymlinks
-
Field Details
-
fileSystemName
-
root
-
provider
-
fsService
-
-
Constructor Details
-
GFileSystemBase
-
-
Method Details
-
toString
-
getFSRL
Description copied from interface:GFileSystem
File system's FSRL- Specified by:
getFSRL
in interfaceGFileSystem
- Returns:
FSRLRoot
of this filesystem.
-
setFSRL
-
setFilesystemService
-
isValid
Returns true if this file system implementation can handle the bytes provided. This method should perform the minimal amount of checks required to determine validity. Keep it quick and tight!- Parameters:
monitor
- a task monitor- Returns:
- true if valid for the byte provider
- Throws:
IOException
- if an I/O error occurs
-
open
public abstract void open(TaskMonitor monitor) throws IOException, CryptoException, CancelledException Opens the file system.- Throws:
IOException
- if an I/O error occursCryptoException
- if an encryption error occursCancelledException
-
close
Closes the file system. All resources should be released. (programs, temporary files, etc.)- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Throws:
IOException
- if an I/O error occurs
-
isClosed
public boolean isClosed()Description copied from interface:GFileSystem
Returns true if the filesystem has beenclosed
- Specified by:
isClosed
in interfaceGFileSystem
- Returns:
- boolean true if the filesystem has been closed.
-
getName
Returns the name of this file system.- Specified by:
getName
in interfaceGFileSystem
- Returns:
- the name of this file system
-
getListing
Description copied from interface:GFileSystem
Returns a list offiles
that reside in the specified directory on this filesystem.- Specified by:
getListing
in interfaceGFileSystem
- Parameters:
directory
- NULL means root of filesystem.- Returns:
List
ofGFile
instances of file in the requested directory.- Throws:
IOException
- if IO problem.
-
debug
Writes the given bytes to a tempfile in the temp directory.- Parameters:
bytes
- the bytes to writefileName
- the prefix of the temp file name
-
getFilenameComparator
Override to specify a file-system specific name comparator.- Returns:
Comparator
such asString.compareTo(String)
orString.compareToIgnoreCase(String)
-
lookup
Description copied from interface:GFileSystem
Retrieves aGFile
from this filesystem based on its full path and filename, using this filesystem's default name comparison logic (eg. case sensitive vs insensitive).- Specified by:
lookup
in interfaceGFileSystem
- Parameters:
path
- string path and filename of a file located in this filesystem. Usenull
or "/" to retrieve the root directory- Returns:
GFile
instance of requested file, null if not found.- Throws:
IOException
- if IO error when looking up file.
-
getRefManager
Description copied from interface:GFileSystem
Returns theref manager
that is responsible for creating and releasingrefs
to this filesystem.- Specified by:
getRefManager
in interfaceGFileSystem
- Returns:
FileSystemRefManager
that manages references to this filesystem.
-