- * A collection of methods to help manipulate the model, with regard to uploaded - * files. - *
- *- * Some of the public methods are static, since the Individual that is passed as - * a parameter holds all necessary references for the operation. Other methods - * require an instance, which is initialized with a {@link WebappDaoFactory}. - *
- *- * TODO: This should be based around FileInfo and ImageInfo, as much as - * possible. - *
- */ -public class FileModelHelper { - private static final Log log = LogFactory.getLog(FileModelHelper.class); - - // ---------------------------------------------------------------------- - // Methods based around FileInfo - // ---------------------------------------------------------------------- - - public static FileInfo createFile(FileStorage fileStorage, - WebappDaoFactory wadf, String filename, String mimeType, - InputStream inputStream) throws FileAlreadyExistsException, - IOException { - FileModelHelper fmh = new FileModelHelper(wadf); - - // Create the file individuals in the model - Individual byteStream = fmh.createByteStreamIndividual(); - String bytestreamUri = byteStream.getURI(); - Individual file = fmh.createFileIndividual(mimeType, filename, - byteStream); - String fileUri = file.getURI(); - - // Store the file in the FileStorage system. - fileStorage.createFile(bytestreamUri, filename, inputStream); - - // Figure out the alias URL - String aliasUrl = FileServingHelper.getBytestreamAliasUrl( - bytestreamUri, filename); - - // And wrap it all up in a tidy little package. - return new FileInfo.Builder().setFilename(filename).setMimeType( - mimeType).setUri(fileUri).setBytestreamUri(bytestreamUri) - .setBytestreamAliasUrl(aliasUrl).build(); - } - - /** - * Record this image file and thumbnail on this entity. NOTE: after this - * update, the entity object is stale. - */ - public static void setImagesOnEntity(WebappDaoFactory wadf, - Individual entity, FileInfo mainInfo, FileInfo thumbInfo) { - IndividualDao individualDao = wadf.getIndividualDao(); - - // Add the thumbnail file to the main image file. - ObjectPropertyStatementDao opsd = wadf.getObjectPropertyStatementDao(); - opsd.insertNewObjectPropertyStatement(new ObjectPropertyStatementImpl( - mainInfo.getUri(), VitroVocabulary.FS_THUMBNAIL_IMAGE, - thumbInfo.getUri())); - - // Add the main image file to the entity. - entity.setMainImageUri(mainInfo.getUri()); - individualDao.updateIndividual(entity); - - log.debug("Set images on '" + entity.getURI() + "': main=" + mainInfo - + ", thumb=" + thumbInfo); - } - - // ---------------------------------------------------------------------- - // Static methods -- the Individual holds all necessary references. - // ---------------------------------------------------------------------- - - /** - * Is this a FileByteStream individual? - */ - public static boolean isFileBytestream(Individual entity) { - for (VClass vClass : entity.getVClasses()) { - if (VitroVocabulary.FS_BYTESTREAM_CLASS.equals(vClass.getURI())) { - log.debug("Entity '" + entity.getURI() + "' is a bytestream"); - return true; - } - } - log.debug("Entity '" + entity.getURI() + "' is not a bytestream"); - return false; - } - - /** - * Locate the file surrogate for the main image of this entity. - * - * @return the surrogate, ornull if there is no such image, or
- * if the entity itself is null.
- */
- public static Individual getMainImage(Individual entity) {
- if (entity == null) {
- return null;
- }
-
- Individual mainFile = entity
- .getRelatedIndividual(VitroVocabulary.IND_MAIN_IMAGE);
-
- if (mainFile == null) {
- log.debug("Entity '" + entity.getURI()
- + "' had no associated main image: mainImageURI="
- + entity.getMainImageUri());
- return null;
- } else {
- log.debug("Entity '" + entity.getURI()
- + "' had associated main image: '" + mainFile.getURI()
- + "'");
- return mainFile;
- }
- }
-
- /**
- * Locate the file surrogate for the thumbnail of this file.
- *
- * @return the surrogate, or null if there is no thumbnail, or
- * if the file itself is null.
- */
- public static Individual getThumbnailForImage(Individual fileSurrogate) {
- if (fileSurrogate == null) {
- return null;
- }
-
- Individual thumbFile = fileSurrogate
- .getRelatedIndividual(VitroVocabulary.FS_THUMBNAIL_IMAGE);
-
- if (thumbFile == null) {
- log.warn("Main image file '" + fileSurrogate.getURI()
- + "' had no associated thumbnail.");
- return null;
- } else {
- log.debug("Main image file '" + fileSurrogate.getURI()
- + "' had associated thumbnail: '" + thumbFile.getURI()
- + "'");
- return thumbFile;
- }
- }
-
- /**
- * Locate the bytestream object for this file.
- *
- * @return the bytestream object, or null if there is no
- * bytestream, or if the file itself is null.
- */
- public static Individual getBytestreamForFile(Individual fileSurrogate) {
- if (fileSurrogate == null) {
- return null;
- }
-
- Individual byteStream = fileSurrogate
- .getRelatedIndividual(VitroVocabulary.FS_DOWNLOAD_LOCATION);
-
- if (byteStream == null) {
- log.error("File surrogate '" + fileSurrogate.getURI()
- + "' had no associated bytestream.");
- return null;
- } else {
- log.debug("File surroage'" + fileSurrogate.getURI()
- + "' had associated bytestream: '" + byteStream.getURI()
- + "'");
- return byteStream;
- }
- }
-
- /**
- * Find the filename for this file.
- *
- * @return the filename, or null if the file itself is
- * null.
- */
- public static String getFilename(Individual fileSurrogate) {
- if (fileSurrogate == null) {
- return null;
- }
-
- String filename = fileSurrogate
- .getDataValue(VitroVocabulary.FS_FILENAME);
-
- if (filename == null) {
- log.error("File had no filename: '" + fileSurrogate.getURI() + "'");
- } else {
- log.debug("Filename for '" + fileSurrogate.getURI() + "' was '"
- + filename + "'");
- }
- return filename;
- }
-
- /**
- * Find the MIME type for this file.
- *
- * @return the MIME type, or null if the file itself is
- * null.
- */
- public static String getMimeType(Individual fileSurrogate) {
- if (fileSurrogate == null) {
- return null;
- }
-
- String mimeType = fileSurrogate
- .getDataValue(VitroVocabulary.FS_MIME_TYPE);
-
- if (mimeType == null) {
- log.error("File had no mimeType: '" + fileSurrogate.getURI() + "'");
- } else {
- log.debug("mimeType for '" + fileSurrogate.getURI() + "' was '"
- + mimeType + "'");
- }
- return mimeType;
- }
-
- /**
- * Return the URI for this individual, or null if the
- * individual is null.
- */
- private static String getUri(Individual entity) {
- if (entity == null) {
- return null;
- } else {
- return entity.getURI();
- }
- }
-
- /**
- * Locate the URI of the bytestream of the main image for this entity.
- *
- * @return the URI, or null if there is no such bytestream, or
- * if the entity itself is null.
- */
- public static String getMainImageBytestreamUri(Individual entity) {
- Individual mainFile = getMainImage(entity);
- Individual byteStream = getBytestreamForFile(mainFile);
- return getUri(byteStream);
- }
-
- /**
- * Find the filename of the main image for this entity.
- *
- * @return the filename, or null if there is no such image.
- */
- public static String getMainImageFilename(Individual entity) {
- Individual mainFile = getMainImage(entity);
- return getFilename(mainFile);
- }
-
- /**
- * Locate the individual that represents the bytestream of the thumbnail of
- * the main image for this entity.
- *
- * @return the URI, or null if there is no such thumbnail
- * image, or if the entity itself is null.
- */
- public static String getThumbnailBytestreamUri(Individual entity) {
- Individual mainFile = getMainImage(entity);
- Individual thumbFile = getThumbnailForImage(mainFile);
- Individual byteStream = getBytestreamForFile(thumbFile);
- return getUri(byteStream);
- }
-
- /**
- * Find the filename of the thumbnail of the main image.
- *
- * @return the filename, or null if there is no such thumbnail
- * image, or if the entity itself is null.
- */
- public static String getThumbnailFilename(Individual entity) {
- Individual mainFile = getMainImage(entity);
- Individual thumbFile = getThumbnailForImage(mainFile);
- return getFilename(thumbFile);
- }
-
- // ----------------------------------------------------------------------
- // Instance methods -- need access to a WebappDaoFactory
- // ----------------------------------------------------------------------
-
- private final IndividualDao individualDao;
- private final ObjectPropertyStatementDao objectPropertyStatementDao;
- private final DataPropertyStatementDao dataPropertyStatementDao;
-
- public FileModelHelper(WebappDaoFactory webappDaoFactory) {
- this.individualDao = webappDaoFactory.getIndividualDao();
- this.objectPropertyStatementDao = webappDaoFactory
- .getObjectPropertyStatementDao();
- this.dataPropertyStatementDao = webappDaoFactory
- .getDataPropertyStatementDao();
- }
-
- /**
- * Some of these methods require an Individual as an argument.
- */
- public Individual getIndividualByUri(String uri) {
- return individualDao.getIndividualByURI(uri);
- }
-
- /**
- * If this URI represents a ByteStream object, we need to find it's
- * surrogate object in order to find the mime type.
- *
- * @return the mime type, or null if we couldn't find the mime
- * type, or if the bytestream object itself is null.
- */
- public String getMimeTypeForBytestream(String bytestreamUri) {
- if (bytestreamUri == null) {
- return null;
- }
-
- ObjectPropertyStatement opStmt = new ObjectPropertyStatementImpl(null,
- VitroVocabulary.FS_DOWNLOAD_LOCATION, bytestreamUri);
- Listnull if there was none.
- */
- public Individual removeMainImage(Individual person) {
- Individual mainImage = getMainImage(person);
- person.setMainImageUri(null);
- individualDao.updateIndividual(person);
- log.debug("Removed main image '" + getUri(mainImage) + "' from '"
- + person.getURI() + "'");
- return mainImage;
- }
-
- /**
- * Remove the current thumbnail from this entity;
- *
- * @return the file surrogate, or null if there was none.
- */
- public Individual removeThumbnail(Individual person) {
- Individual mainImage = getMainImage(person);
- Individual thumbnail = getThumbnailForImage(mainImage);
- if (thumbnail == null) {
- log.debug("No thumbnail to remove from '" + person.getURI() + "'");
- return null;
- }
- ObjectPropertyStatement stmt = new ObjectPropertyStatementImpl(
- mainImage.getURI(), VitroVocabulary.FS_THUMBNAIL_IMAGE,
- thumbnail.getURI());
- objectPropertyStatementDao.deleteObjectPropertyStatement(stmt);
- return thumbnail;
- }
-
- /**
- * Store this file surrogate as the thumbnail on this entity.
- */
- public void setThumbnailOnIndividual(Individual entity,
- Individual thumbnailSurrogate) {
- String mainImageUri = entity.getMainImageUri();
- objectPropertyStatementDao
- .insertNewObjectPropertyStatement(new ObjectPropertyStatementImpl(
- mainImageUri, VitroVocabulary.FS_THUMBNAIL_IMAGE,
- thumbnailSurrogate.getURI()));
- }
-
- /**
- * Are there any ObjectPropertyStatements in the model whose object is this
- * file surrogate?
- */
- public boolean isFileReferenced(Individual surrogate) {
- if (surrogate == null) {
- return false;
- }
- ObjectPropertyStatement opStmt = new ObjectPropertyStatementImpl(null,
- null, surrogate.getURI());
- List
@@ -79,9 +78,10 @@ public class FileServingServlet extends VitroHttpServlet {
String path = request.getServletPath() + request.getPathInfo();
log.debug("Path is '" + path + "'");
- String uri = FileServingHelper.getBytestreamUri(path);
- log.debug("Bytestream URI is '" + uri + "'");
- if (uri == null) {
+ FileInfo fileInfo = FileInfo.instanceFromAliasUrl(request
+ .getFullWebappDaoFactory(), path);
+ log.debug("File info is '" + fileInfo + "'");
+ if (fileInfo == null) {
String message = "The request path is not valid for the File servlet: '"
+ path + "'";
log.error(message);
@@ -91,12 +91,7 @@ public class FileServingServlet extends VitroHttpServlet {
// Validate that the file exists, with the requested URI and filename.
String requestedFilename = getFilename(path);
- String actualFilename = fileStorage.getFilename(uri);
- if (actualFilename == null) {
- log.debug("Requested a non-existent file: " + path);
- response.sendError(SC_NOT_FOUND, ("File not found: " + path));
- return;
- }
+ String actualFilename = fileInfo.getFilename();
if (!actualFilename.equals(requestedFilename)
&& !actualFilename.equals(decode(requestedFilename))) {
log.warn("The requested filename does not match the "
@@ -107,13 +102,12 @@ public class FileServingServlet extends VitroHttpServlet {
}
// Get the MIME type.
- String mimeType = new FileModelHelper(request.getFullWebappDaoFactory())
- .getMimeTypeForBytestream(uri);
+ String mimeType = fileInfo.getMimeType();
// Open the actual byte stream.
InputStream in;
try {
- in = fileStorage.getInputStream(uri, actualFilename);
+ in = fileStorage.getInputStream(fileInfo.getBytestreamUri(), actualFilename);
} catch (FileNotFoundException e) {
log.error(e, e);
response.sendError(SC_INTERNAL_SERVER_ERROR, e.toString());
diff --git a/webapp/src/edu/cornell/mannlib/vitro/webapp/filestorage/updater/FSUController.java b/webapp/src/edu/cornell/mannlib/vitro/webapp/filestorage/updater/FSUController.java
index fd2b35a10..bc45ad247 100644
--- a/webapp/src/edu/cornell/mannlib/vitro/webapp/filestorage/updater/FSUController.java
+++ b/webapp/src/edu/cornell/mannlib/vitro/webapp/filestorage/updater/FSUController.java
@@ -6,7 +6,7 @@ import java.io.File;
import com.hp.hpl.jena.rdf.model.Model;
-import edu.cornell.mannlib.vitro.webapp.filestorage.FileModelHelper;
+import edu.cornell.mannlib.vitro.webapp.filestorage.UploadedFileHelper;
import edu.cornell.mannlib.vitro.webapp.filestorage.backend.FileStorage;
/**
@@ -23,12 +23,12 @@ public interface FSUController {
/** The place to find or to create image files. */
ImageDirectoryWithBackup getImageDirectoryWithBackup();
+ /** A helper with access to the DAO layer and the file storage system. */
+ UploadedFileHelper getUploadedFileHelper();
+
/** The file storage system. */
FileStorage getFileStorage();
- /** A file model helper with access to the DAO layer. */
- FileModelHelper getFileModelHelper();
-
/** Where to store the files that were translated. */
File getTranslatedDirectory();
diff --git a/webapp/src/edu/cornell/mannlib/vitro/webapp/filestorage/updater/FileStorageUpdater.java b/webapp/src/edu/cornell/mannlib/vitro/webapp/filestorage/updater/FileStorageUpdater.java
index faf53f367..b7262e6a8 100644
--- a/webapp/src/edu/cornell/mannlib/vitro/webapp/filestorage/updater/FileStorageUpdater.java
+++ b/webapp/src/edu/cornell/mannlib/vitro/webapp/filestorage/updater/FileStorageUpdater.java
@@ -13,7 +13,7 @@ import com.hp.hpl.jena.rdf.model.Model;
import edu.cornell.mannlib.vitro.webapp.dao.VitroVocabulary;
import edu.cornell.mannlib.vitro.webapp.dao.WebappDaoFactory;
-import edu.cornell.mannlib.vitro.webapp.filestorage.FileModelHelper;
+import edu.cornell.mannlib.vitro.webapp.filestorage.UploadedFileHelper;
import edu.cornell.mannlib.vitro.webapp.filestorage.backend.FileStorage;
/**
@@ -104,7 +104,7 @@ public class FileStorageUpdater implements FSUController {
private final Model model;
private final FileStorage fileStorage;
- private final FileModelHelper fileModelHelper;
+ private final UploadedFileHelper uploadedFileHelper;
private final ImageDirectoryWithBackup imageDirectoryWithBackup;
private final File upgradeDirectory;
@@ -115,7 +115,7 @@ public class FileStorageUpdater implements FSUController {
File webappImageDirectory) {
this.model = model;
this.fileStorage = fileStorage;
- this.fileModelHelper = new FileModelHelper(wadf);
+ this.uploadedFileHelper = new UploadedFileHelper(fileStorage, wadf);
this.upgradeDirectory = new File(uploadDirectory, "upgrade");
this.imageDirectoryWithBackup = new ImageDirectoryWithBackup(new File(
@@ -201,7 +201,7 @@ public class FileStorageUpdater implements FSUController {
model.createProperty(IMAGETHUMB)).isEmpty()) {
return true;
}
-
+
return false;
}
@@ -238,8 +238,8 @@ public class FileStorageUpdater implements FSUController {
}
@Override
- public FileModelHelper getFileModelHelper() {
- return this.fileModelHelper;
+ public UploadedFileHelper getUploadedFileHelper() {
+ return this.uploadedFileHelper;
}
@Override
diff --git a/webapp/src/edu/cornell/mannlib/vitro/webapp/filestorage/updater/ImageSchemaTranslater.java b/webapp/src/edu/cornell/mannlib/vitro/webapp/filestorage/updater/ImageSchemaTranslater.java
index 753bba376..39409487b 100644
--- a/webapp/src/edu/cornell/mannlib/vitro/webapp/filestorage/updater/ImageSchemaTranslater.java
+++ b/webapp/src/edu/cornell/mannlib/vitro/webapp/filestorage/updater/ImageSchemaTranslater.java
@@ -16,9 +16,9 @@ import org.apache.commons.io.FilenameUtils;
import com.hp.hpl.jena.rdf.model.ResIterator;
import com.hp.hpl.jena.rdf.model.Resource;
-import edu.cornell.mannlib.vitro.webapp.beans.Individual;
-import edu.cornell.mannlib.vitro.webapp.filestorage.FileModelHelper;
+import edu.cornell.mannlib.vitro.webapp.filestorage.UploadedFileHelper;
import edu.cornell.mannlib.vitro.webapp.filestorage.backend.FileStorage;
+import edu.cornell.mannlib.vitro.webapp.filestorage.model.FileInfo;
/**
* Make copies of the main image and thumbnail in the new file storage system,
@@ -27,15 +27,15 @@ import edu.cornell.mannlib.vitro.webapp.filestorage.backend.FileStorage;
*/
public class ImageSchemaTranslater extends FsuScanner {
private final ImageDirectoryWithBackup imageDirectoryWithBackup;
- protected final FileModelHelper fileModelHelper;
protected final FileStorage fileStorage;
+ protected final UploadedFileHelper uploadedFileHelper;
public ImageSchemaTranslater(FSUController controller) {
super(controller);
this.imageDirectoryWithBackup = controller
.getImageDirectoryWithBackup();
this.fileStorage = controller.getFileStorage();
- this.fileModelHelper = controller.getFileModelHelper();
+ this.uploadedFileHelper = controller.getUploadedFileHelper();
}
/**
@@ -79,10 +79,6 @@ public class ImageSchemaTranslater extends FsuScanner {
return;
}
- translateMainImage(resource, mainImages.get(0));
- translated.add(mainImages.get(0));
- ResourceWrapper.removeAll(resource, imageProperty);
-
List
- *
- *
- * @return the new File surrogate.
*/
- private Individual translateFile(Resource resource, String path,
- String label) {
+ private FileInfo translateFile(Resource resource, String path, String label) {
File oldFile = imageDirectoryWithBackup.getExistingFile(path);
String filename = getSimpleFilename(path);
String mimeType = guessMimeType(resource, filename);
- // Create the file individuals in the model
- Individual byteStream = fileModelHelper.createByteStreamIndividual();
- Individual file = fileModelHelper.createFileIndividual(mimeType,
- filename, byteStream);
-
- updateLog.log(resource, "translating " + label + " '" + path
- + "' into the file storage as '" + file.getURI() + "'");
-
InputStream inputStream = null;
try {
- // Store the file in the FileStorage system.
inputStream = new FileInputStream(oldFile);
- fileStorage.createFile(byteStream.getURI(), filename, inputStream);
+ // Create the file individuals in the model
+ FileInfo fileInfo = uploadedFileHelper.createFile(filename,
+ mimeType, inputStream);
+ updateLog.log(resource, "translating " + label + " '" + path
+ + "' into the file storage as '" + fileInfo.getUri() + "'");
+ return fileInfo;
} catch (IOException e) {
updateLog.error(resource, "Can't create the " + label + " file. ",
e);
+ return null;
} finally {
if (inputStream != null) {
try {
@@ -156,8 +136,6 @@ public class ImageSchemaTranslater extends FsuScanner {
}
}
}
-
- return file;
}
/**
diff --git a/webapp/src/edu/cornell/mannlib/vitro/webapp/web/jsptags/PropertyEditLinks.java b/webapp/src/edu/cornell/mannlib/vitro/webapp/web/jsptags/PropertyEditLinks.java
index 35709659d..0f8df88ea 100644
--- a/webapp/src/edu/cornell/mannlib/vitro/webapp/web/jsptags/PropertyEditLinks.java
+++ b/webapp/src/edu/cornell/mannlib/vitro/webapp/web/jsptags/PropertyEditLinks.java
@@ -43,9 +43,10 @@ import edu.cornell.mannlib.vitro.webapp.beans.Individual;
import edu.cornell.mannlib.vitro.webapp.beans.ObjectProperty;
import edu.cornell.mannlib.vitro.webapp.beans.ObjectPropertyStatement;
import edu.cornell.mannlib.vitro.webapp.beans.ObjectPropertyStatementImpl;
+import edu.cornell.mannlib.vitro.webapp.controller.VitroRequest;
import edu.cornell.mannlib.vitro.webapp.dao.VitroVocabulary;
import edu.cornell.mannlib.vitro.webapp.edit.n3editing.RdfLiteralHash;
-import edu.cornell.mannlib.vitro.webapp.filestorage.FileModelHelper;
+import edu.cornell.mannlib.vitro.webapp.filestorage.model.ImageInfo;
import edu.cornell.mannlib.vitro.webapp.utils.FrontEndEditingUtils;
import edu.cornell.mannlib.vitro.webapp.utils.StringUtils;
@@ -470,19 +471,22 @@ public class PropertyEditLinks extends TagSupport{
protected LinkStruct[] doImageLinks(Individual entity,
IdentifierBundle ids, PolicyIface policy, String contextPath) {
- Individual mainImage = FileModelHelper.getMainImage(entity);
- Individual thumbnail = FileModelHelper.getThumbnailForImage(mainImage);
+ VitroRequest vreq = new VitroRequest((HttpServletRequest) pageContext
+ .getRequest());
+ ImageInfo imageInfo = ImageInfo.instanceFromEntityUri(vreq
+ .getFullWebappDaoFactory(), entity);
String subjectUri = entity.getURI();
String predicateUri = VitroVocabulary.IND_MAIN_IMAGE;
- if (thumbnail == null) {
+ if (imageInfo == null) {
EditLinkAccess[] accesses = policyToAccess(ids, policy, subjectUri,
predicateUri);
if (contains(accesses, EditLinkAccess.ADDNEW)) {
log.debug("permission to ADD main image to " + subjectUri);
- boolean isPerson = entity.isVClass("http://xmlns.com/foaf/0.1/Person");
+ boolean isPerson = entity
+ .isVClass("http://xmlns.com/foaf/0.1/Person");
if (isPerson) {
return new LinkStruct[] { getImageLink(subjectUri,
contextPath, "edit", "upload an image", "add") };
@@ -496,7 +500,7 @@ public class PropertyEditLinks extends TagSupport{
}
} else {
ObjectPropertyStatement prop = new ObjectPropertyStatementImpl(
- subjectUri, predicateUri, mainImage.getURI());
+ subjectUri, predicateUri, imageInfo.getMainImage().getUri());
EditLinkAccess[] allowedAccessTypeArray = policyToAccess(ids,
policy, prop);
@@ -520,8 +524,7 @@ public class PropertyEditLinks extends TagSupport{
}
return links.toArray(new LinkStruct[links.size()]);
}
- }
-
+ }
/* ********************* utility methods ********************************* */
protected static String makeRelativeHref( String baseUrl, String ... queries ) {