Package ghidra.framework.data
Class ProjectFileManager
java.lang.Object
ghidra.framework.data.ProjectFileManager
- All Implemented Interfaces:
ProjectData
- Direct Known Subclasses:
TransientProjectData
Helper class to manage files within a project.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionProjectFileManager
(ProjectLocator localStorageLocator, boolean isInWritableProject, boolean resetOwner) Constructor for existing projects.ProjectFileManager
(ProjectLocator localStorageLocator, RepositoryAdapter repository, boolean isInWritableProject) Constructor for a new project. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a listener that will be notified when any folder or file changes in the project.void
close()
Close the project storage associated with this project data object.void
convertProjectToShared
(RepositoryAdapter newRepository, TaskMonitor monitor) Convert a local project to a shared project.void
dispose()
findCheckedOutFiles
(TaskMonitor monitor) Find all project files which are currently checked-outvoid
findOpenFiles
(List<DomainFile> list) Finds all changed domain files and appends them to the specified list.Get domain file specified by an absolute data path.getFileByID
(String fileID) Get domain file specified by its unique fileID.int
Get the approximate number of files contained within the project.Get domain folder specified by an absolute data path.Class<? extends LocalFileSystem>
int
getOwner()
Returns the owner of the project that is associated with this ProjectFileManager.Get monitor which will be cancelled if project is closedReturns the projectLocator for the this ProjectData.Return the repository for this project data.Returns the root folder of the project.getSharedFileURL
(String path) Get a URL for a shared domain file which is available within a remote repository.getUser()
Returns User object associated with remote repository or null if a remote repository is not used.static String
getUserDataFilename
(String associatedFileID) Returns the standard user data filename associated with the specified file ID.boolean
hasInvalidCheckouts
(List<DomainFile> checkoutList, RepositoryAdapter newRepository, TaskMonitor monitor) Determine if any domain files listed does not correspond to a checkout in the specified newRespository.makeValidName
(String name) Transform the specified name into an acceptable folder or file item name.void
refresh
(boolean force) Sync the Domain folder/file structure with the underlying file structure.void
releaseDomainFiles
(Object consumer) void
Removes the listener to be notified of folder and file changes.void
removeFromIndex
(String fileID) Remove specified fileID from index.void
testValidName
(String name, boolean isPath) Validate a folder/item name or path.void
updateFileIndex
(GhidraFileData fileData) Update the file index for the specified file datavoid
updateRepositoryInfo
(RepositoryAdapter newRepository, boolean force, TaskMonitor monitor) Update the repository for this project; the server may have changed or a different repository is being used.
-
Field Details
-
MANGLED_DATA_FOLDER_NAME
Name of folder that stores user's data- See Also:
-
INDEXED_DATA_FOLDER_NAME
- See Also:
-
USER_FOLDER_NAME
- See Also:
-
VERSIONED_FOLDER_NAME
- See Also:
-
-
Constructor Details
-
ProjectFileManager
public ProjectFileManager(ProjectLocator localStorageLocator, boolean isInWritableProject, boolean resetOwner) throws NotOwnerException, IOException Constructor for existing projects.- Parameters:
localStorageLocator
- the location of the projectisInWritableProject
- true if project content is writable, false if project is read-onlyresetOwner
- true to reset the project owner- Throws:
IOException
- if an i/o error occursNotOwnerException
- if inProject is true and user is not ownerFileNotFoundException
- if project directory not found
-
ProjectFileManager
public ProjectFileManager(ProjectLocator localStorageLocator, RepositoryAdapter repository, boolean isInWritableProject) throws IOException Constructor for a new project.- Parameters:
localStorageLocator
- the location of the projectrepository
- a repository if this is a shared project or null if it is a private projectisInWritableProject
- true if project content is writable, false if project is read-only- Throws:
IOException
- if an i/o error occurs
-
-
Method Details
-
getMaxNameLength
public int getMaxNameLength()- Specified by:
getMaxNameLength
in interfaceProjectData
- Returns:
- the maximum name length permitted for folders or items.
-
testValidName
Description copied from interface:ProjectData
Validate a folder/item name or path.- Specified by:
testValidName
in interfaceProjectData
- Parameters:
name
- folder or item nameisPath
- if true name represents full path- Throws:
InvalidNameException
- if name is invalid
-
getUser
Description copied from interface:ProjectData
Returns User object associated with remote repository or null if a remote repository is not used.- Specified by:
getUser
in interfaceProjectData
-
getLocalStorageClass
- Specified by:
getLocalStorageClass
in interfaceProjectData
- Returns:
- local storage implementation class
-
getOwner
Returns the owner of the project that is associated with this ProjectFileManager. A value of null indicates an old multiuser project.- Returns:
- the owner of the project
-
getRootFolder
Description copied from interface:ProjectData
Returns the root folder of the project.- Specified by:
getRootFolder
in interfaceProjectData
-
getFolder
Description copied from interface:ProjectData
Get domain folder specified by an absolute data path.- Specified by:
getFolder
in interfaceProjectData
- Parameters:
path
- the absolute path of domain folder relative to the data folder.- Returns:
- domain folder or null if folder not found
-
getFileCount
public int getFileCount()Description copied from interface:ProjectData
Get the approximate number of files contained within the project. The number may be reduced if not connected to the shared repository. Only the newer indexed file-system supports this capability, a value of -1 will be returned for older projects utilizing the mangled file-system or if an IO Error occurs. An approximate number is provided since the two underlying file systems are consulted separately and the local private file-system does not distinguish between checked-out files and private files. This number is currently intended as a rough sizing number to disable certain features when very large projects are in use. Generally the larger of the two file counts will be returned.- Specified by:
getFileCount
in interfaceProjectData
- Returns:
- number of project files or -1 if unknown.
-
getFile
Description copied from interface:ProjectData
Get domain file specified by an absolute data path.- Specified by:
getFile
in interfaceProjectData
- Parameters:
path
- the absolute path of domain file relative to the root folder.- Returns:
- domain file or null if file not found
-
getFileByID
Description copied from interface:ProjectData
Get domain file specified by its unique fileID.- Specified by:
getFileByID
in interfaceProjectData
- Parameters:
fileID
- domain file ID- Returns:
- domain file or null if file not found
-
releaseDomainFiles
-
findOpenFiles
Finds all changed domain files and appends them to the specified list.- Specified by:
findOpenFiles
in interfaceProjectData
- Parameters:
list
- the list to receive the changed domain files
-
getProjectLocator
Description copied from interface:ProjectData
Returns the projectLocator for the this ProjectData.- Specified by:
getProjectLocator
in interfaceProjectData
-
addDomainFolderChangeListener
Description copied from interface:ProjectData
Adds a listener that will be notified when any folder or file changes in the project.- Specified by:
addDomainFolderChangeListener
in interfaceProjectData
- Parameters:
l
- the listener to be notified of folder and file changes.
-
removeDomainFolderChangeListener
Description copied from interface:ProjectData
Removes the listener to be notified of folder and file changes.- Specified by:
removeDomainFolderChangeListener
in interfaceProjectData
- Parameters:
l
- the listener to be removed.
-
getPrivateFileSystem
-
getRepository
Description copied from interface:ProjectData
Return the repository for this project data.- Specified by:
getRepository
in interfaceProjectData
- Returns:
- null if the project is not associated with a repository
-
refresh
Description copied from interface:ProjectData
Sync the Domain folder/file structure with the underlying file structure.- Specified by:
refresh
in interfaceProjectData
- Parameters:
force
- if true all folders will be be visited and refreshed, if false only those folders previously visited will be refreshed.- Throws:
IOException
-
updateRepositoryInfo
public void updateRepositoryInfo(RepositoryAdapter newRepository, boolean force, TaskMonitor monitor) throws IOException, CancelledException Description copied from interface:ProjectData
Update the repository for this project; the server may have changed or a different repository is being used. Any existing checkout which is not recognized/valid by newRepository will be terminated and a local .keep file created. NOTE: The project should be closed and then reopened after this method is called.- Specified by:
updateRepositoryInfo
in interfaceProjectData
- Parameters:
newRepository
- new repository to useforce
- if true any existing local checkout which is not recognized/valid for newRepository will be forceably terminated if offline with old repository.monitor
- task monitor- Throws:
IOException
- thrown if files are still checked out, or if there was a problem accessing the filesystemCancelledException
- if the user canceled the update
-
hasInvalidCheckouts
public boolean hasInvalidCheckouts(List<DomainFile> checkoutList, RepositoryAdapter newRepository, TaskMonitor monitor) throws IOException, CancelledException Determine if any domain files listed does not correspond to a checkout in the specified newRespository.- Specified by:
hasInvalidCheckouts
in interfaceProjectData
- Parameters:
checkoutList
- project domain files to checknewRepository
- repository to check against before updatingmonitor
- task monitor- Returns:
- true if one or more files are not valid checkouts in newRepository
- Throws:
IOException
- if IO error occursCancelledException
- if task cancelled
-
findCheckedOutFiles
public List<DomainFile> findCheckedOutFiles(TaskMonitor monitor) throws IOException, CancelledException Find all project files which are currently checked-out- Specified by:
findCheckedOutFiles
in interfaceProjectData
- Parameters:
monitor
- task monitor (no progress updates)- Returns:
- list of current checkout files
- Throws:
IOException
- if IO error occursCancelledException
- if task cancelled
-
getUserDataFilename
Returns the standard user data filename associated with the specified file ID.- Parameters:
associatedFileID
- the file id- Returns:
- user data filename
-
makeValidName
Description copied from interface:ProjectData
Transform the specified name into an acceptable folder or file item name. Only an individual folder or file name should be specified, since any separators will be stripped-out. NOTE: Uniqueness of name within the intended target folder is not considered.- Specified by:
makeValidName
in interfaceProjectData
- Returns:
- valid name or "unknown" if no valid characters exist within name provided
-
getProjectDir
-
close
public void close()Description copied from interface:ProjectData
Close the project storage associated with this project data object. NOTE: This should not be invoked if this object is utilized by a Project instance.- Specified by:
close
in interfaceProjectData
-
dispose
public void dispose() -
updateFileIndex
Update the file index for the specified file data- Parameters:
fileData
- file data
-
removeFromIndex
Remove specified fileID from index.- Parameters:
fileID
- the file ID
-
getProjectDisposalMonitor
Get monitor which will be cancelled if project is closed- Returns:
- cancel monitor
-