Package ghidra.framework.model
Interface DomainFile
- All Superinterfaces:
Comparable<DomainFile>
- All Known Subinterfaces:
LinkedDomainFile
- All Known Implementing Classes:
DomainFileProxy
,GhidraFile
DomainFile
provides a storage interface for project files. A
DomainFile
is an immutable reference to file contained within a project. The state
of a DomainFile
object does not track name/parent changes made to the referenced
project file.-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addToVersionControl
(String comment, boolean keepCheckedOut, TaskMonitor monitor) Adds this private file to version control.boolean
Returns true if this private file may be added to the associated repository.boolean
Returns true if this file may be checked-in to the associated repository.boolean
Returns true if this file may be checked-out from the associated repository.boolean
canMerge()
Returns true if this file can be merged with the current versioned file.boolean
Prior to invoking getDomainObject, this method can be used to determine if unsaved changes can be recovered on the next open.boolean
canSave()
Return whether this domain object can be saved (i.e., updated/overwritten).default void
checkin
(CheckinHandler checkinHandler, boolean okToUpgrade, TaskMonitor monitor) Deprecated, for removal: This API element is subject to removal in a future version.void
checkin
(CheckinHandler checkinHandler, TaskMonitor monitor) Performs check in to associated repository.boolean
checkout
(boolean exclusive, TaskMonitor monitor) Checkout this file for update.copyTo
(DomainFolder newParent, TaskMonitor monitor) Copy this file into the newParent folder as a private file.copyToAsLink
(DomainFolder newParent) Copy this file into the newParent folder as a link file.copyVersionTo
(int version, DomainFolder destFolder, TaskMonitor monitor) Copy a specific version of this file to the specified destFolder.void
delete()
Delete the entire database for this file, including any version files.void
delete
(int version) Deletes a specific version of a file from the versioned filesystem.boolean
exists()
Check for existence of domain file.If this is a folder-link file get the corresponding linked folder.Returns changes made to versioned file by others since checkout was performed.Get a list of checkouts by all users for the associated versioned file.Get checkout status associated with a versioned file.List
<?> Get the list of consumers (Objects) for this domain file.Returns content-type string for this filegetDomainObject
(Object consumer, boolean okToUpgrade, boolean okToRecover, TaskMonitor monitor) Opens and returns the current domain object.Class
<? extends DomainObject> Returns the underlying Class for the domain object in this domain file.Returns a unique file-ID if one has been established or null.getIcon
(boolean disabled) Get the state based Icon image for the domain file based upon its content class.getImmutableDomainObject
(Object consumer, int version, TaskMonitor monitor) Returns a new DomainObject that cannot be changed or saved to its original file.long
Get a long value representing the time when the data was last modified.int
Return the latest versiongetLocalProjectURL
(String ref) Get a local Ghidra URL for this domain file if available within the associated non-transient local project.Returns an ordered map containing the metadata that has been associated with the corresponding domain object.getName()
Get the name of this project filegetOpenedDomainObject
(Object consumer) Returns the domainObject for this DomainFile only if it is already open.Get the parent domain folder for this domain file.Returns the full path name to this fileReturns the local storage location for the project that this DomainFile belongs to.getReadOnlyDomainObject
(Object consumer, int version, TaskMonitor monitor) Returns a "read-only" version of the domain object.Get a remote Ghidra URL for this domain file if available within an associated shared project repository.int
Return either the latest version if the file is not checked-out or the version that was checked-out or a specific version that was requested.Version[]
Returns list of all available versions.boolean
isBusy()
Returns true if the domain object in this domain file exists and has an open transaction.boolean
Return whether the domain object in this domain file has changed.boolean
Returns true if this is a checked-out file.boolean
Returns true if this a checked-out file with exclusive access.boolean
Returns true if the file is versioned but a private copy also exists.boolean
Returns true if this file is in a writable project.boolean
Returns true if this file represents the latest version of the associated domain object.boolean
Determine if this file is a link file which corresponds to either a file or folder link.boolean
Determine if this file's content type supports linking.boolean
isOpen()
Returns true if there is an open domainObject for this file.boolean
Returns whether this file is explicitly marked as read-only.boolean
Return true if this is a versioned database, else falselong
length()
Returns the length of this domain file.void
merge
(boolean okToUpgrade, TaskMonitor monitor) Performs merge from current version of versioned file into local checked-out file.boolean
Returns true if this is a checked-out file which has been modified since it was checked-out.moveTo
(DomainFolder newParent) Move this file into the newParent folder.void
packFile
(File file, TaskMonitor monitor) Pack domain file into specified file.void
save
(TaskMonitor monitor) Save theDomainObject
associated with this file.Set the name on this domain file.void
setReadOnly
(boolean state) Sets the object to read-only.boolean
If the file has an updatable domain object with unsaved changes, generate a recovery snapshot.void
terminateCheckout
(long checkoutId) Forcefully terminate a checkout for the associated versioned file.void
undoCheckout
(boolean keep) Undo "checked-out" file.void
undoCheckout
(boolean keep, boolean force) Undo "checked-out" file.Methods inherited from interface java.lang.Comparable
compareTo
-
Field Details
-
UNSUPPORTED_FILE_ICON
-
DEFAULT_VERSION
static final int DEFAULT_VERSIONUse with getDomainObject to request the default version. The default version is the private file or check-out file if one exists, or the latest version from the version controlled file system.- See Also:
-
READ_ONLY_PROPERTY
Event property name for Read-only setting.- See Also:
-
-
Method Details
-
getName
String getName()Get the name of this project file- Returns:
- the name
-
exists
boolean exists()Check for existence of domain file.- Returns:
- true if file exists. A proxy domain file will always return false.
-
getFileID
String getFileID()Returns a unique file-ID if one has been established or null. Examples which may result in null ID:- Very old project file which pre-dates introduction of file ID, or
- Remote versioned file with lost connection
- Returns:
- the file-ID or null if failed to obtain ID.
-
setName
Set the name on this domain file.- Parameters:
newName
- domain file name- Returns:
- renamed domain file (the original DomainFile object becomes invalid since it is immutable)
- Throws:
InvalidNameException
- if newName contains illegal charactersDuplicateFileException
- if a file named newName already exists in this files domain folder.FileInUseException
- if this file is in-use / checked-out.IOException
- if an IO or access error occurs.
-
getPathname
String getPathname()Returns the full path name to this file- Returns:
- the path name
-
getLocalProjectURL
Get a local Ghidra URL for this domain file if available within the associated non-transient local project. A null value will be returned if project is transient.- Parameters:
ref
- reference within a file, may be null. NOTE: such reference interpretation is specific to a domain object and tooling with limited support.- Returns:
- local Ghidra URL for this file or null if transient or not applicable
-
getProjectLocator
ProjectLocator getProjectLocator()Returns the local storage location for the project that this DomainFile belongs to.- Returns:
- the location
-
getContentType
String getContentType()Returns content-type string for this file- Returns:
- the file content type or a reserved content type
ContentHandler.MISSING_CONTENT
orContentHandler.UNKNOWN_CONTENT
.
-
getDomainObjectClass
Class<? extends DomainObject> getDomainObjectClass()Returns the underlying Class for the domain object in this domain file.- Returns:
- the class or null if does not correspond to a domain object.
-
getParent
DomainFolder getParent()Get the parent domain folder for this domain file.- Returns:
- the parent
-
getChangesByOthersSinceCheckout
Returns changes made to versioned file by others since checkout was performed. NOTE: This method is unable to cope with version issues which may require an upgrade.- Returns:
- change set or null
- Throws:
VersionException
- latest version was created with a different version of software which prevents rapid determination of change set.IOException
- if a folder item access error occurs or change set was produced by newer version of software and can not be read
-
getDomainObject
DomainObject getDomainObject(Object consumer, boolean okToUpgrade, boolean okToRecover, TaskMonitor monitor) throws VersionException, IOException, CancelledException Opens and returns the current domain object. If the domain object is already opened, then the existing open domain object is returned.- Parameters:
consumer
- consumer of the domain object which is responsible for releasing it after use. When all the consumers using the domain object release it, then the object is closed and its resources released.okToUpgrade
- if true, allows the system to upgrade out of data domain objects to be in compliance with the current version of Ghidra. A Version exception will be thrown if the domain object cannot be upgraded OR okToUpgrade is false and the domain object is out of date.okToRecover
- if true, allows the system to recover unsaved file changes which resulted from a crash. If false, any existing recovery data will be deleted. This flag is only relevant if project is open for update (isInProject) and the file can be opened for update.monitor
- permits monitoring of open progress.- Returns:
- an open domain object can be modified and saved. (Not read-only)
- Throws:
VersionException
- if the domain object could not be read due to a version format change. If okToUpgrade is true, then a VersionException indicates that the domain object cannot be upgraded to the current format. If okToUpgrade is false, then the VersionException only means the object is not in the current format - it may or may not be possible to upgrade.IOException
- if an IO or access error occurs.CancelledException
- if monitor cancelled operation
-
getOpenedDomainObject
Returns the domainObject for this DomainFile only if it is already open.- Parameters:
consumer
- the consumer that will use the object.- Returns:
- the already opened domainObject or null if it is not currently open.
-
getReadOnlyDomainObject
DomainObject getReadOnlyDomainObject(Object consumer, int version, TaskMonitor monitor) throws VersionException, IOException, CancelledException Returns a "read-only" version of the domain object. "Read-only" means that the domain object cannot be saved back into its original domain object. It can still be modified and saved to a new domain file. The domain object will be assigned a temporary domain file that will not allow a "save" operation. The user must do a "save as" to a new filename.- Parameters:
consumer
- consumer of the domain object which is responsible for releasing it after use.version
- the domain object version requested. DEFAULT_VERSION should be specified to open the current version.monitor
- permits monitoring of open progress.- Returns:
- a new domain object that is disassociated from its original domain file.
- Throws:
VersionException
- if the domain object could not be read due to a version format change.FileNotFoundException
- if the stored file/version was not found.IOException
- if an IO or access error occurs.CancelledException
- if monitor cancelled operation
-
getImmutableDomainObject
DomainObject getImmutableDomainObject(Object consumer, int version, TaskMonitor monitor) throws VersionException, IOException, CancelledException Returns a new DomainObject that cannot be changed or saved to its original file. NOTE: The use of this method should generally be avoided since it can't handle version changes that may have occured and require a data upgrade (e.g., DB schema change).- Parameters:
consumer
- consumer of the domain object which is responsible for releasing it after use.version
- the domain object version requested. DEFAULT_VERSION should be specified to open the current version.monitor
- permits monitoring of open progress.- Returns:
- a new domain object that is disassociated from its original domain file and cannot be modified
- Throws:
VersionException
- if the domain object could not be read due to a version format change.FileNotFoundException
- if the stored file/version was not found.IOException
- if an IO or access error occurs.CancelledException
- if monitor cancelled operation
-
save
Save theDomainObject
associated with this file.- Parameters:
monitor
- monitor for the task that is doing the save on the file- Throws:
FileInUseException
- if the file is open for update by someone else, or a transient-read is in progress.IOException
- if an IO error occurs.CancelledException
- if monitor cancelled operation
-
canSave
boolean canSave()Return whether this domain object can be saved (i.e., updated/overwritten).- Returns:
- true if the user is the owner AND the file is in the active project AND the file is not read-only.
-
canRecover
boolean canRecover()Prior to invoking getDomainObject, this method can be used to determine if unsaved changes can be recovered on the next open.- Returns:
- true if recovery data exists.
-
takeRecoverySnapshot
If the file has an updatable domain object with unsaved changes, generate a recovery snapshot.- Returns:
- true if snapshot successful or not needed, false if file is busy which prevents snapshot, or snapshot was cancelled.
- Throws:
IOException
- if there is an exception saving the snapshot
-
isInWritableProject
boolean isInWritableProject()Returns true if this file is in a writable project.- Returns:
- true if writable
-
getLastModifiedTime
long getLastModifiedTime()Get a long value representing the time when the data was last modified.- Returns:
- the time
-
getIcon
Get the state based Icon image for the domain file based upon its content class.- Parameters:
disabled
- true if the icon return should be rendered as not enabled- Returns:
- image icon
-
isCheckedOut
boolean isCheckedOut()Returns true if this is a checked-out file.- Returns:
- true if checked-out
-
isCheckedOutExclusive
boolean isCheckedOutExclusive()Returns true if this a checked-out file with exclusive access.- Returns:
- true if checked-out exclusively
-
modifiedSinceCheckout
boolean modifiedSinceCheckout()Returns true if this is a checked-out file which has been modified since it was checked-out.- Returns:
- true if modified since check-out
-
canCheckout
boolean canCheckout()Returns true if this file may be checked-out from the associated repository. User's with read-only repository access will not have checkout ability.- Returns:
- true if can checkout
-
canCheckin
boolean canCheckin()Returns true if this file may be checked-in to the associated repository. Note: this does not take into consideration cases where the file is currently in-use which may cause a failure if a checkin is attempted.- Returns:
- true if a check-in can be attempted (i.e., file is checked-out with changes), else false
-
canMerge
boolean canMerge()Returns true if this file can be merged with the current versioned file. Note: this does not take into consideration cases where the file is currently in-use which may cause a failure if a merge is attempted.- Returns:
- true if a merge can be attempted (i.e., file is checked-out and a newer version exists), else false
-
canAddToRepository
boolean canAddToRepository()Returns true if this private file may be added to the associated repository. Note: this does not take into consideration cases where the file is currently in-use which may cause a failure if add to repository is attempted.- Returns:
- true if add to the repository can be attempted (i.e., file in active project is not versioned or hijacked)
-
setReadOnly
Sets the object to read-only. This method may only be invoked for private files (i.e., not versioned).- Parameters:
state
- if true file will be read-only and may not be updated, if false the file may be updated.- Throws:
IOException
- if an IO error occurs.
-
isReadOnly
boolean isReadOnly()Returns whether this file is explicitly marked as read-only. This method is only supported by the local file system and does not apply to a versioned file that is not checked-out. A versioned file that is not checked-out will always return false, while aDomainFileProxy
will always return true. From a framework point of view a read-only file can never be changed.- Returns:
- true if this file is marked read-only
-
isVersioned
boolean isVersioned()Return true if this is a versioned database, else false- Returns:
- true if versioned
-
isHijacked
boolean isHijacked()Returns true if the file is versioned but a private copy also exists.- Returns:
- true if hijacked
-
getLatestVersion
int getLatestVersion()Return the latest version- Returns:
- the version
-
isLatestVersion
boolean isLatestVersion()Returns true if this file represents the latest version of the associated domain object.- Returns:
- true if the latest version
-
getVersion
int getVersion()Return either the latest version if the file is not checked-out or the version that was checked-out or a specific version that was requested.- Returns:
- the version
-
getVersionHistory
Returns list of all available versions.- Returns:
- the versions
- Throws:
IOException
- if there is an exception getting the history
-
addToVersionControl
void addToVersionControl(String comment, boolean keepCheckedOut, TaskMonitor monitor) throws IOException, CancelledException Adds this private file to version control.- Parameters:
comment
- new version commentkeepCheckedOut
- if true, the file will be initially checked-out. This option will be ignored if file is currently open in which case file will remain checked-out.monitor
- progress monitor- Throws:
FileInUseException
- if this file is in-use.IOException
- if an IO or access error occurs. Also if file is not private.CancelledException
- if the monitor cancelled the operation
-
checkout
Checkout this file for update. If this file is already private, this method does nothing.- Parameters:
exclusive
- if true an exclusive checkout will be requestedmonitor
- progress monitor- Returns:
- true if checkout successful, false if an exclusive checkout was not possible due to other users having checkouts of this file. A request for a non-exclusive checkout will never return false.
- Throws:
IOException
- if an IO or access error occurs.CancelledException
- if task monitor cancelled operation.
-
checkin
void checkin(CheckinHandler checkinHandler, TaskMonitor monitor) throws IOException, VersionException, CancelledException Performs check in to associated repository. File must be checked-out and modified since checkout.- Parameters:
checkinHandler
- provides user input data to complete checkin process. The keep-checked-out option supplied by this handler will be ignored if file is currently open in which case file will remain checked-out.monitor
- the TaskMonitor.- Throws:
IOException
- if an IO or access error occursVersionException
- if unable to handle domain object version in versioned filesystem. We are unable to upgrade since this would only occur if checkout is not exclusive.CancelledException
- if task monitor cancelled operation
-
checkin
@Deprecated(since="11.1", forRemoval=true) default void checkin(CheckinHandler checkinHandler, boolean okToUpgrade, TaskMonitor monitor) throws IOException, VersionException, CancelledException Deprecated, for removal: This API element is subject to removal in a future version.use alternativecheckin(CheckinHandler, TaskMonitor)
method since okToUpgrade cannot be respected and is ignored. Upgrade cannot be performed during checkin.Performs check in to associated repository. File must be checked-out and modified since checkout.- Parameters:
checkinHandler
- provides user input data to complete checkin process. This keep-checked-out option supplied by this handler will be ignored and forced true if file is currently open.okToUpgrade
- if true an upgrade will be performed if needed (ignored)monitor
- the TaskMonitor.- Throws:
IOException
- if an IO or access error occursVersionException
- if unable to handle domain object version in versioned filesystem. If okToUpgrade was false, check exception to see if it can be upgraded sometime after doing a checkout.CancelledException
- if task monitor cancelled operation
-
merge
void merge(boolean okToUpgrade, TaskMonitor monitor) throws IOException, VersionException, CancelledException Performs merge from current version of versioned file into local checked-out file.- Parameters:
okToUpgrade
- if true an upgrade will be performed if neededmonitor
- task monitor- Throws:
IOException
- if an IO or access error occursVersionException
- if unable to handle domain object version in versioned filesystem. If okToUpgrade was false, check exception to see if it can be upgradedCancelledException
- if task monitor cancelled operation
-
undoCheckout
Undo "checked-out" file. The original repository file is restored.- Parameters:
keep
- if true, the private database will be renamed with a .keep extension.- Throws:
NotConnectedException
- if shared project and not connected to repositoryFileInUseException
- if this file is in-use.IOException
- if file is not checked-out or an IO / access error occurs.
-
undoCheckout
Undo "checked-out" file. The original repository file is restored.- Parameters:
keep
- if true, the private database will be renamed with a .keep extension.force
- if not connected to the repository the local checkout file will be removed. Warning: forcing undo checkout will leave a stale checkout in place for the associated repository if not connected.- Throws:
NotConnectedException
- if shared project and not connected to repository and force is falseFileInUseException
- if this file is in-use / checked-out.IOException
- thrown if file is not checked-out or an IO / access error occurs.
-
terminateCheckout
Forcefully terminate a checkout for the associated versioned file. The user must be the owner of the checkout or have administrator privilege on the versioned filesystem (i.e., repository).- Parameters:
checkoutId
- checkout ID- Throws:
IOException
- if an IO or access error occurs
-
getCheckouts
Get a list of checkouts by all users for the associated versioned file.- Returns:
- list of checkouts
- Throws:
IOException
- if an IO or access error occurs
-
getCheckoutStatus
Get checkout status associated with a versioned file.- Returns:
- checkout status or null if not checked-out to current associated project.
- Throws:
IOException
- if an IO or access error occurs
-
delete
Delete the entire database for this file, including any version files.- Throws:
FileInUseException
- if this file is in-use / checked-out.UserAccessException
- if the user does not have permission to delete the file.IOException
- if an IO or access error occurs.
-
delete
Deletes a specific version of a file from the versioned filesystem.- Parameters:
version
- specific version to be deleted. The version must either be the oldest or latest, or -1 which will attempt to remove all versions. When deleting the latest version, this method could take a long time to return since the previous version must be reconstructed within the versioned filesystem.- Throws:
IOException
- if an IO error occurs, including the inability to delete a version because this item is checked-out, the user does not have permission, or the specified version is not the oldest or latest.
-
moveTo
Move this file into the newParent folder.- Parameters:
newParent
- new parent folder within the same project- Returns:
- the newly relocated domain file (the original DomainFile object becomes invalid since it is immutable)
- Throws:
DuplicateFileException
- if a file with the same name already exists in newParent folder.FileInUseException
- if this file is in-use / checked-out.IOException
- if an IO or access error occurs.
-
copyTo
DomainFile copyTo(DomainFolder newParent, TaskMonitor monitor) throws IOException, CancelledException Copy this file into the newParent folder as a private file.- Parameters:
newParent
- new parent foldermonitor
- task monitor- Returns:
- newly created domain file
- Throws:
FileInUseException
- if this file is in-use / checked-out.IOException
- if an IO or access error occurs.CancelledException
- if task monitor cancelled operation.
-
copyVersionTo
DomainFile copyVersionTo(int version, DomainFolder destFolder, TaskMonitor monitor) throws IOException, CancelledException Copy a specific version of this file to the specified destFolder.- Parameters:
version
- version to copydestFolder
- destination parent foldermonitor
- task monitor- Returns:
- the copied file
- Throws:
IOException
- if an IO or access error occurs.CancelledException
- if task monitor cancelled operation.
-
copyToAsLink
Copy this file into the newParent folder as a link file. Restrictions:- Specified newParent must reside within a different project since internal linking is not currently supported.
- Content type must support linking (see
isLinkingSupported()
).
- Parameters:
newParent
- new parent folder- Returns:
- newly created domain file or null if content type does not support link use.
- Throws:
IOException
- if an IO or access error occurs.
-
isLinkingSupported
boolean isLinkingSupported()Determine if this file's content type supports linking.- Returns:
- true if linking is supported, else false.
-
getConsumers
List<?> getConsumers()Get the list of consumers (Objects) for this domain file.- Returns:
- true if linking is supported allowing a link-file to be created which references this file, else false.
-
isChanged
boolean isChanged()Return whether the domain object in this domain file has changed.- Returns:
- true if changed
-
isOpen
boolean isOpen()Returns true if there is an open domainObject for this file.- Returns:
- true if open
-
isBusy
boolean isBusy()Returns true if the domain object in this domain file exists and has an open transaction.- Returns:
- true if busy
-
packFile
Pack domain file into specified file. Specified file will be overwritten if it already exists.- Parameters:
file
- destination filemonitor
- the task monitor- Throws:
IOException
- if there is an exception packing the fileCancelledException
- if monitor cancels operation
-
getMetadata
Returns an ordered map containing the metadata that has been associated with the corresponding domain object. The map contains key,value pairs and are ordered by their insertion order.- Returns:
- a map containing the metadata that has been associated with the corresponding domain object.
-
length
Returns the length of this domain file. This size is the minimum disk space used for storing this file, but does not account for additional storage space used to track changes, etc.- Returns:
- file length
- Throws:
IOException
- if IO or access error occurs
-
isLinkFile
boolean isLinkFile()Determine if this file is a link file which corresponds to either a file or folder link. TheDomainObject
referenced by a link-file may be opened usinggetReadOnlyDomainObject(Object, int, TaskMonitor)
. ThegetDomainObject(Object, boolean, boolean, TaskMonitor)
method may also be used to obtain a read-only instance.getImmutableDomainObject(Object, int, TaskMonitor)
use is not supported. If the link-file content type equals "FolderLink" the methodfollowLink()
can be used to get the linked domain folder. The associated link URL may be obtained withLinkHandler.getURL(DomainFile)
. The content type (seegetContentType()
of a link file will differ from that of the linked object (e.g., "LinkedProgram" vs "Program").- Returns:
- true if link file else false for a normal domain file
-
followLink
DomainFolder followLink()If this is a folder-link file get the corresponding linked folder.- Returns:
- a linked domain folder or null if not a folder-link.
-
checkin(CheckinHandler, TaskMonitor)
method since okToUpgrade cannot be respected and is ignored.