de.deepamehta.files

Class FilesPlugin

Show UML class diagram

java.lang.Object

de.deepamehta.core.osgi.PluginActivator

de.deepamehta.files.FilesPlugin

All Implemented Interfaces:

PluginContext, ResourceRequestFilterListener, EventListener, FilesService, PathMapper, org.osgi.framework.BundleActivator

public class FilesPlugin
extends PluginActivator
implements FilesService, ResourceRequestFilterListener, PathMapper

Field Summary

Fields

Modifier and Type	Field and Description
static DeepaMehtaEvent	CHECK_DISK_QUOTA
private ConfigService	configService
static int	DISK_QUOTA_MB
static String	FILE_REPOSITORY_PATH
static boolean	FILE_REPOSITORY_PER_WORKSPACE
private static String	FILE_REPOSITORY_URI
private Logger	logger
private static Pattern	PER_WORKSPACE_PATH_PATTERN
private static String	WORKSPACE_DIRECTORY_PREFIX

Fields inherited from class de.deepamehta.core.osgi.PluginActivator

bundle, dm4, mf

Constructor Summary

Constructors

Constructor and Description
FilesPlugin()

Method Summary

Methods

Modifier and Type	Method and Description
private String	_pathPrefix(long workspaceId)
private File	absolutePath(String repoPath) Maps a repository path to an absolute path.
private void	checkAuthorization(String repoPath, javax.servlet.http.HttpServletRequest request) Checks if the user associated with a request is authorized to access a repository file.
private void	checkExistence(File path)
private File	checkPath(File path) Checks if the absolute path represents a directory traversal attack.
Topic	createFile(InputStream in, String repoPath) Creates a file in the file repository and a corresponding File topic.
private Topic	createFileOrFolderTopic(TopicModel model)
private Topic	createFileTopic(File path) Creates a File topic representing the file at the given absolute path.
void	createFolder(String folderName, String repoPath) Creates a folder in the file repository.
private void	createFolderAssociation(long folderTopicId, Topic topic)
private Topic	createFolderTopic(File path) Creates a Folder topic representing the directory at the given absolute path.
private Topic	createFolderTopic(String folderName, String repoPath) Creates a Folder topic.
private void	createWorkspaceAssignment(DeepaMehtaObject object, String repoPath) Creates a workspace assignment for a File topic, a Folder topic, or a folder association (type "Aggregation").
private void	createWorkspaceFileRepository(File repo)
private Topic	fetchFileTopic(String repoPath) Fetches the File topic representing the file at the given repository path.
private Topic	fetchFolderTopic(String repoPath) Fetches the Folder topic representing the folder at the given repository path.
private Topic	fetchTopic(String repoPath, String topicTypeUri) Fetches the File/Folder topic representing the file/directory at the given repository path.
boolean	fileExists(String repoPath) Checks if a file/directory with the given repository path exists in the file repository.
Topic	getChildFileTopic(long folderTopicId, String repoPath) Returns the File topic representing the file at a given repository path.
Topic	getChildFolderTopic(long folderTopicId, String repoPath) Returns the Folder topic representing the folder at a given repository path.
DirectoryListing	getDirectoryListing(String repoPath)
File	getFile(long fileTopicId) Convenience method to access the file/directory in the file repository that is represented by the given File/Folder topic.
File	getFile(String repoPath) Accesses a file/directory in the file repository by the given repository path.
Topic	getFileTopic(String repoPath) Returns the File topic representing the file at a given repository path.
Topic	getFolderTopic(String repoPath) Returns the Folder topic representing the folder at a given repository path.
String	getRepositoryPath(URL url) Checks if the given URL refers to the file repository of this DeepaMehta installation.
ResourceInfo	getResourceInfo(String repoPath)
private long	getWorkspaceId()
private long	getWorkspaceId(String repoPath)
void	init()
void	openFile(long fileTopicId)
private File	path(File directory, String fileName) Constructs an absolute path from an absolute path and a file name.
String	pathPrefix() Returns a prefix that can be used for constructing a repository path.
String	pathPrefix(long workspaceId) Returns a prefix that can be used for constructing a repository path.
void	preInstall()
String	repoPath(File path) Maps an absolute path to a repository path.
String	repoPath(javax.servlet.http.HttpServletRequest request) Returns the repository path of a filerepo request.
private String	repoPath(long fileTopicId) Returns the repository path of a File/Folder topic.
private String	repoPath(Topic topic) Returns the repository path of a File/Folder topic.
void	resourceRequestFilter(javax.servlet.http.HttpServletRequest request)
void	shutdown()
StoredFile	storeFile(UploadedFile file, String repoPath) Receives an uploaded file, stores it in the file repository, and creates a corresponding File topic.
private File	unusedPath(File directory, UploadedFile file) Constructs an absolute path for storing an uploaded file.
private String	userInfo(String username)

Methods inherited from class de.deepamehta.core.osgi.PluginActivator

getBundleContext, getPluginName, getStaticResource, getUri, publishFileSystem, serviceArrived, serviceGone, setCoreService, start, stop, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

FILE_REPOSITORY_PATH

public static final String FILE_REPOSITORY_PATH

FILE_REPOSITORY_PER_WORKSPACE

public static final boolean FILE_REPOSITORY_PER_WORKSPACE

DISK_QUOTA_MB

public static final int DISK_QUOTA_MB

FILE_REPOSITORY_URI

private static final String FILE_REPOSITORY_URI

See Also:

Constant Field Values

WORKSPACE_DIRECTORY_PREFIX

private static final String WORKSPACE_DIRECTORY_PREFIX

See Also:

Constant Field Values

PER_WORKSPACE_PATH_PATTERN

private static final Pattern PER_WORKSPACE_PATH_PATTERN

CHECK_DISK_QUOTA

public static DeepaMehtaEvent CHECK_DISK_QUOTA

configService

private ConfigService configService

logger

private Logger logger

Constructor Detail

FilesPlugin

public FilesPlugin()

Method Detail

getFileTopic

public Topic getFileTopic(String repoPath)

Description copied from interface: FilesService

Returns the File topic representing the file at a given repository path. If no such File topic exists it is created.

Specified by:

getFileTopic in interface FilesService

Parameters:

repoPath - A repository path. Relative to the repository base path. Must begin with slash, no slash at the end.

If per-workspace file repos are active (dm4.filerepo.per_workspace=true) the repository path must contain the workspace prefix as the first path segment, e.g. "/workspace-1234" where 1234 is the workspace ID.

However there is one exception to that rule: if and only if "/" is passed as the repository path the workspace prefix is determined automatically with the semantics of current workspace, based on the request's workspace cookie.

For support with constructing a repository path see the pathPrefix methods.

Returns:

The File topic. Its child topics ("File Name", "Path", "Media Type", "Size") are included.

getFolderTopic

public Topic getFolderTopic(String repoPath)

Description copied from interface: FilesService

Returns the Folder topic representing the folder at a given repository path. If no such Folder topic exists it is created.

Specified by:

getFolderTopic in interface FilesService

Parameters:

repoPath - A repository path. Relative to the repository base path. Must begin with slash, no slash at the end.

If per-workspace file repos are active (dm4.filerepo.per_workspace=true) the repository path must contain the workspace prefix as the first path segment, e.g. "/workspace-1234" where 1234 is the workspace ID.

However there is one exception to that rule: if and only if "/" is passed as the repository path the workspace prefix is determined automatically with the semantics of current workspace, based on the request's workspace cookie.

For support with constructing a repository path see the pathPrefix methods.

Returns:

The Folder topic. Its child topics ("Folder Name", "Path") are included.

getChildFileTopic

public Topic getChildFileTopic(long folderTopicId,
                      String repoPath)

Description copied from interface: FilesService

Returns the File topic representing the file at a given repository path. If no such File topic exists it is created.

Creates an association (type "Aggregation") between the File topic (role type "Child") and its parent Folder topic (role type "Parent"), if not exists already.

Specified by:

getChildFileTopic in interface FilesService

Parameters:

folderTopicId - ID of the parent Folder topic.

repoPath - A repository path. Relative to the repository base path. Must begin with slash, no slash at the end.

If per-workspace file repos are active (dm4.filerepo.per_workspace=true) the repository path must contain the workspace prefix as the first path segment, e.g. "/workspace-1234" where 1234 is the workspace ID.

However there is one exception to that rule: if and only if "/" is passed as the repository path the workspace prefix is determined automatically with the semantics of current workspace, based on the request's workspace cookie.

For support with constructing a repository path see the pathPrefix methods.

Returns:

The File topic. Its child topics ("File Name", "Path", "Media Type", "Size") are included.

getChildFolderTopic

public Topic getChildFolderTopic(long folderTopicId,
                        String repoPath)

Description copied from interface: FilesService

Returns the Folder topic representing the folder at a given repository path. If no such Folder topic exists it is created.

Creates an association (type "Aggregation") between the Folder topic (role type "Child") and its parent Folder topic (role type "Parent"), if not exists already.

Specified by:

getChildFolderTopic in interface FilesService

Parameters:

folderTopicId - ID of the parent Folder topic.

repoPath - A repository path. Relative to the repository base path. Must begin with slash, no slash at the end.

If per-workspace file repos are active (dm4.filerepo.per_workspace=true) the repository path must contain the workspace prefix as the first path segment, e.g. "/workspace-1234" where 1234 is the workspace ID.

However there is one exception to that rule: if and only if "/" is passed as the repository path the workspace prefix is determined automatically with the semantics of current workspace, based on the request's workspace cookie.

For support with constructing a repository path see the pathPrefix methods.

Returns:

The Folder topic. Its child topics ("Folder Name", "Path") are included.

storeFile

public StoredFile storeFile(UploadedFile file,
                   String repoPath)

Description copied from interface: FilesService

Receives an uploaded file, stores it in the file repository, and creates a corresponding File topic.

Specified by:

storeFile in interface FilesService

repoPath - The directory where to store the uploaded file. The directory must exist.

A repository path. Relative to the repository base path. Must begin with slash, no slash at the end.

If per-workspace file repos are active (dm4.filerepo.per_workspace=true) the repository path must contain the workspace prefix as the first path segment, e.g. "/workspace-1234" where 1234 is the workspace ID.

However there is one exception to that rule: if and only if "/" is passed as the repository path the workspace prefix is determined automatically with the semantics of current workspace, based on the request's workspace cookie.

For support with constructing a repository path see the pathPrefix methods.

Returns:

a StoredFile object which holds 2 information: the name of the uploaded file, and the ID of the created File topic.

createFile

public Topic createFile(InputStream in,
               String repoPath)

Description copied from interface: FilesService

Creates a file in the file repository and a corresponding File topic.

Specified by:

createFile in interface FilesService

Parameters:

in - The input stream the file content is read from.

repoPath - The path and filename of the file to be created. If that file exists already it is overwritten. ### TODO: rethink overwriting

A repository path. Relative to the repository base path. Must begin with slash, no slash at the end.

If per-workspace file repos are active (dm4.filerepo.per_workspace=true) the repository path must contain the workspace prefix as the first path segment, e.g. "/workspace-1234" where 1234 is the workspace ID.

However there is one exception to that rule: if and only if "/" is passed as the repository path the workspace prefix is determined automatically with the semantics of current workspace, based on the request's workspace cookie.

For support with constructing a repository path see the pathPrefix methods.

Returns:

the File topic that corresponds to the created file.

createFolder

public void createFolder(String folderName,
                String repoPath)

Description copied from interface: FilesService

Creates a folder in the file repository. Note: no corresponding Folder topic is created.

Specified by:

createFolder in interface FilesService

repoPath - The directory where to create the folder.

A repository path. Relative to the repository base path. Must begin with slash, no slash at the end.

If per-workspace file repos are active (dm4.filerepo.per_workspace=true) the repository path must contain the workspace prefix as the first path segment, e.g. "/workspace-1234" where 1234 is the workspace ID.

However there is one exception to that rule: if and only if "/" is passed as the repository path the workspace prefix is determined automatically with the semantics of current workspace, based on the request's workspace cookie.

For support with constructing a repository path see the pathPrefix methods.

getResourceInfo

public ResourceInfo getResourceInfo(String repoPath)

Specified by:

getResourceInfo in interface FilesService

getDirectoryListing

public DirectoryListing getDirectoryListing(String repoPath)

Specified by:

getDirectoryListing in interface FilesService

getRepositoryPath

public String getRepositoryPath(URL url)

Description copied from interface: FilesService

Checks if the given URL refers to the file repository of this DeepaMehta installation.

Specified by:

getRepositoryPath in interface FilesService

Returns:

the refered file's/directory's repository path, or null if the URL does not refer to the file repository of this DeepaMehta installation.

getFile

public File getFile(String repoPath)

Description copied from interface: FilesService

Accesses a file/directory in the file repository by the given repository path. If no such file/directory exists a FileRepositoryException is thrown.

Note: this method does not require the corresponding File/Folder topic to exist.

Specified by:

getFile in interface FilesService

Parameters:

repoPath - A repository path. Relative to the repository base path. Must begin with slash, no slash at the end.

If per-workspace file repos are active (dm4.filerepo.per_workspace=true) the repository path must contain the workspace prefix as the first path segment, e.g. "/workspace-1234" where 1234 is the workspace ID.

However there is one exception to that rule: if and only if "/" is passed as the repository path the workspace prefix is determined automatically with the semantics of current workspace, based on the request's workspace cookie.

For support with constructing a repository path see the pathPrefix methods.

getFile

public File getFile(long fileTopicId)

Description copied from interface: FilesService

Convenience method to access the file/directory in the file repository that is represented by the given File/Folder topic.

Specified by:

getFile in interface FilesService

Parameters:

fileTopicId - ID of a File/Folder topic.

fileExists

public boolean fileExists(String repoPath)

Description copied from interface: FilesService

Checks if a file/directory with the given repository path exists in the file repository.

Specified by:

fileExists in interface FilesService

Parameters:

repoPath - A repository path. Relative to the repository base path. Must begin with slash, no slash at the end.

If per-workspace file repos are active (dm4.filerepo.per_workspace=true) the repository path must contain the workspace prefix as the first path segment, e.g. "/workspace-1234" where 1234 is the workspace ID.

However there is one exception to that rule: if and only if "/" is passed as the repository path the workspace prefix is determined automatically with the semantics of current workspace, based on the request's workspace cookie.

For support with constructing a repository path see the pathPrefix methods.

Returns:

true if the file exists, false otherwise.

pathPrefix

public String pathPrefix()

Description copied from interface: FilesService

Returns a prefix that can be used for constructing a repository path. In case of per-workspace file repos are active (dm4.filerepo.per_workspace=true) the prefix represents the current workspace (e.g. "/workspace-1234"), based on the workspace cookie. In case of per-workspace file repos are not active an empty string is returned.

Specified by:

pathPrefix in interface FilesService

pathPrefix

public String pathPrefix(long workspaceId)

Description copied from interface: FilesService

Returns a prefix that can be used for constructing a repository path. In case of per-workspace file repos are active (dm4.filerepo.per_workspace=true) the prefix represents the given workspace (e.g. "/workspace-1234"). In case of per-workspace file repos are not active an empty string is returned.

Specified by:

pathPrefix in interface FilesService

openFile

public void openFile(long fileTopicId)

Specified by:

openFile in interface FilesService

preInstall

public void preInstall()

Specified by:

preInstall in interface PluginContext

Overrides:

preInstall in class PluginActivator

init

public void init()

Specified by:

init in interface PluginContext

Overrides:

init in class PluginActivator

shutdown

public void shutdown()

Specified by:

shutdown in interface PluginContext

Overrides:

shutdown in class PluginActivator

resourceRequestFilter

public void resourceRequestFilter(javax.servlet.http.HttpServletRequest request)

Specified by:

resourceRequestFilter in interface ResourceRequestFilterListener

repoPath

public String repoPath(File path)

Description copied from interface: PathMapper

Maps an absolute path to a repository path.

Specified by:

repoPath in interface PathMapper

Parameters:

path - A canonized absolute path.

Returns:

A repository path. Relative to the repository base path. Begins with slash, no slash at the end.

fetchFileTopic

private Topic fetchFileTopic(String repoPath)

Fetches the File topic representing the file at the given repository path. If no such File topic exists null is returned.

Parameters:

repoPath - A repository path. Must be canonized.

fetchFolderTopic

private Topic fetchFolderTopic(String repoPath)

Fetches the Folder topic representing the folder at the given repository path. If no such Folder topic exists null is returned.

Parameters:

repoPath - A repository path. Must be canonized.

fetchTopic

private Topic fetchTopic(String repoPath,
               String topicTypeUri)

Fetches the File/Folder topic representing the file/directory at the given repository path. If no such File/Folder topic exists null is returned.

Parameters:

repoPath - A repository path. Must be canonized.

topicTypeUri - The type of the topic to fetch: either "dm4.files.file" or "dm4.files.folder".

createFileTopic

private Topic createFileTopic(File path)
                       throws Exception

Creates a File topic representing the file at the given absolute path.

Parameters:

path - A canonized absolute path.

Throws:

Exception

createFolderTopic

private Topic createFolderTopic(File path)
                         throws Exception

Creates a Folder topic representing the directory at the given absolute path.

Parameters:

path - A canonized absolute path.

Throws:

Exception

createFolderTopic

private Topic createFolderTopic(String folderName,
                      String repoPath)
                         throws Exception

Creates a Folder topic.

Parameters:

folderName - The folder name.

repoPath - The folder repository path.

Throws:

Exception

createFileOrFolderTopic

private Topic createFileOrFolderTopic(TopicModel model)
                               throws Exception

Throws:

Exception

createFolderAssociation

private void createFolderAssociation(long folderTopicId,
                           Topic topic)

Parameters:

topic - a File topic, or a Folder topic.

createWorkspaceAssignment

private void createWorkspaceAssignment(DeepaMehtaObject object,
                             String repoPath)

Creates a workspace assignment for a File topic, a Folder topic, or a folder association (type "Aggregation"). The workspce is calculated from both, the "dm4.filerepo.per_workspace" flag and the given repository path.

Parameters:

object - a File topic, a Folder topic, or a folder association (type "Aggregation").

absolutePath

private File absolutePath(String repoPath)
                   throws FileRepositoryException

Maps a repository path to an absolute path. Checks the repository path to fight directory traversal attacks.

Parameters:

repoPath - A repository path. Relative to the repository base path. Must begin with slash, no slash at the end.

Returns:

The canonized absolute path.

Throws:

FileRepositoryException

checkPath

private File checkPath(File path)
                throws FileRepositoryException,
                       IOException

Checks if the absolute path represents a directory traversal attack. If so a FileRepositoryException (403 Forbidden) is thrown.

Parameters:

path - The absolute path to check.

Returns:

The canonized absolute path.

Throws:

FileRepositoryException

IOException

checkExistence

private void checkExistence(File path)
                     throws FileRepositoryException

Throws:

FileRepositoryException

checkAuthorization

private void checkAuthorization(String repoPath,
                      javax.servlet.http.HttpServletRequest request)
                         throws FileRepositoryException

Checks if the user associated with a request is authorized to access a repository file. If not authorized a FileRepositoryException (401 Unauthorized) is thrown.

Parameters:

repoPath - The repository path of the file to check. Must be canonized.

request - The request.

Throws:

FileRepositoryException

userInfo

private String userInfo(String username)

path

private File path(File directory,
        String fileName)

Constructs an absolute path from an absolute path and a file name.

Parameters:

directory - An absolute path.

Returns:

The constructed absolute path.

unusedPath

private File unusedPath(File directory,
              UploadedFile file)

Constructs an absolute path for storing an uploaded file. If a file with that name already exists in the specified directory it remains untouched and the uploaded file is stored with a unique name (by adding a number).

Parameters:

directory - The directory to store the uploaded file to. A canonized absolute path.

Returns:

The canonized absolute path.

repoPath

private String repoPath(long fileTopicId)

Returns the repository path of a File/Folder topic. Note: the returned path is canonized.

repoPath

private String repoPath(Topic topic)

Returns the repository path of a File/Folder topic. Note: the returned path is canonized.

repoPath

public String repoPath(javax.servlet.http.HttpServletRequest request)

Returns the repository path of a filerepo request.

Returns:

The repository path or null if the request is not a filerepo request. Note: the returned path is not canonized.

createWorkspaceFileRepository

private void createWorkspaceFileRepository(File repo)

getWorkspaceId

private long getWorkspaceId()

getWorkspaceId

private long getWorkspaceId(String repoPath)

_pathPrefix

private String _pathPrefix(long workspaceId)