/**
* $Id: ItemViewer.java 4707 2010-01-19 09:17:47Z mdiggory $
* $URL: http://scm.dspace.org/svn/repo/modules/dspace-discovery/trunk/block/src/main/java/org/dspace/app/xmlui/aspect/discovery/ItemViewer.java $
* *************************************************************************
* Copyright (c) 2002-2009, DuraSpace. All rights reserved
* Licensed under the DuraSpace License.
*
* A copy of the DuraSpace License has been included in this
* distribution and is available at: http://scm.dspace.org/svn/repo/licenses/LICENSE.txt
*/
package org.dspace.app.xmlui.aspect.discovery;
import java.io.IOException;
import java.io.Serializable;
import java.io.StringWriter;
import java.sql.SQLException;
import java.util.List;
import org.apache.cocoon.caching.CacheableProcessingComponent;
import org.apache.cocoon.util.HashUtil;
import org.apache.excalibur.source.SourceValidity;
import org.apache.log4j.Logger;
import org.dspace.app.xmlui.cocoon.AbstractDSpaceTransformer;
import org.dspace.app.xmlui.utils.DSpaceValidity;
import org.dspace.app.xmlui.utils.HandleUtil;
import org.dspace.app.xmlui.utils.UIException;
import org.dspace.app.xmlui.wing.Message;
import org.dspace.app.xmlui.wing.WingException;
import org.dspace.app.xmlui.wing.element.Body;
import org.dspace.app.xmlui.wing.element.Division;
import org.dspace.app.xmlui.wing.element.ReferenceSet;
import org.dspace.app.xmlui.wing.element.PageMeta;
import org.dspace.authorize.AuthorizeException;
import org.dspace.content.Collection;
import org.dspace.content.DCValue;
import org.dspace.content.DSpaceObject;
import org.dspace.content.Item;
import org.dspace.content.crosswalk.CrosswalkException;
import org.dspace.content.crosswalk.DisseminationCrosswalk;
import org.dspace.core.LogManager;
import org.dspace.core.PluginManager;
import org.jdom.Element;
import org.jdom.output.XMLOutputter;
import org.xml.sax.SAXException;
/**
* Display a single item.
*
* @author Scott Phillips
*/
public class ItemViewer extends AbstractDSpaceTransformer implements CacheableProcessingComponent
{
private static final Logger log = Logger.getLogger(ItemViewer.class);
/** Language strings */
private static final Message T_dspace_home = message("xmlui.general.dspace_home");
private static final Message T_trail = message("xmlui.ArtifactBrowser.ItemViewer.trail");
private static final Message T_show_simple = message("xmlui.ArtifactBrowser.ItemViewer.show_simple");
private static final Message T_show_full = message("xmlui.ArtifactBrowser.ItemViewer.show_full");
private static final Message T_head_parent_collections = message("xmlui.ArtifactBrowser.ItemViewer.head_parent_collections");
/** Cached validity object */
private SourceValidity validity = null;
/** XHTML crosswalk instance */
private DisseminationCrosswalk xHTMLHeadCrosswalk = null;
/**
* Generate the unique caching key.
* This key must be unique inside the space of this component.
*/
public Serializable getKey() {
try {
DSpaceObject dso = HandleUtil.obtainHandle(objectModel);
if (dso == null)
return "0"; // no item, something is wrong.
return HashUtil.hash(dso.getHandle());
// return HashUtil.hash(dso.getHandle() + "full:" + showFullItem(objectModel));
}
catch (SQLException sqle)
{
// Ignore all errors and just return that the component is not cachable.
return "0";
}
}
/**
* Generate the cache validity object.
*
* The validity object will include the item being viewed,
* along with all bundles & bitstreams.
*/
public SourceValidity getValidity()
{
DSpaceObject dso = null;
if (this.validity == null)
{
try {
dso = HandleUtil.obtainHandle(objectModel);
DSpaceValidity validity = new DSpaceValidity();
validity.add(dso);
this.validity = validity.complete();
}
catch (Exception e)
{
// Ignore all errors and just invalidate the cache.
}
// add log message that we are viewing the item
// done here, as the serialization may not occur if the cache is valid
log.info(LogManager.getHeader(context, "view_item", "handle=" + (dso == null ? "" : dso.getHandle())));
}
return this.validity;
}
/**
* Add the item's title and trail links to the page's metadata.
*/
@Override
public void addPageMeta(PageMeta pageMeta) throws SAXException,
WingException, UIException, SQLException, IOException,
AuthorizeException
{
DSpaceObject dso = HandleUtil.obtainHandle(objectModel);
if (!(dso instanceof Item))
return;
Item item = (Item) dso;
// Set the page title
String title = getItemTitle(item);
if (title != null)
pageMeta.addMetadata("title").addContent(title);
else
pageMeta.addMetadata("title").addContent(item.getHandle());
// Set the page author
String author = getItemAuthor(item);
if (author != null)
pageMeta.addMetadata("author").addContent(author);
// Set the page author
String type = getItemType(item);
if (type != null)
pageMeta.addMetadata("type").addContent(type);
pageMeta.addTrailLink(contextPath + "/",T_dspace_home);
HandleUtil.buildHandleTrail(item,pageMeta,contextPath);
pageMeta.addTrail().addContent(T_trail);
/**
* TODO: We can use the trail here to reference parent Article and/or original search links
*/
// Metadata for <head> element
if (xHTMLHeadCrosswalk == null)
{
xHTMLHeadCrosswalk = (DisseminationCrosswalk) PluginManager.getNamedPlugin(
DisseminationCrosswalk.class, "XHTML_HEAD_ITEM");
}
// Produce <meta> elements for header from crosswalk
try
{
List l = xHTMLHeadCrosswalk.disseminateList(item);
StringWriter sw = new StringWriter();
XMLOutputter xmlo = new XMLOutputter();
for (int i = 0; i < l.size(); i++)
{
Element e = (Element) l.get(i);
// FIXME: we unset the Namespace so it's not printed.
// This is fairly yucky, but means the same crosswalk should
// work for Manakin as well as the JSP-based UI.
e.setNamespace(null);
xmlo.output(e, sw);
}
pageMeta.addMetadata("xhtml_head_item").addContent(sw.toString());
}
catch (CrosswalkException ce)
{
// TODO: Is this the right exception class?
throw new WingException(ce);
}
}
/**
* Display a single item
*/
public void addBody(Body body) throws SAXException, WingException,
UIException, SQLException, IOException, AuthorizeException
{
DSpaceObject dso = HandleUtil.obtainHandle(objectModel);
if (!(dso instanceof Item))
return;
Item item = (Item) dso;
// Build the item viewer division.
Division division = body.addDivision("item-view","primary");
String title = getItemTitle(item);
if (title != null)
division.setHead(title);
else
division.setHead(item.getHandle());
/*
Para showfullPara = division.addPara(null, "item-view-toggle item-view-toggle-top");
if (showFullItem(objectModel))
{
String link = contextPath + "/handle/" + item.getHandle();
showfullPara.addXref(link).addContent(T_show_simple);
}
else
{
String link = contextPath + "/handle/" + item.getHandle()
+ "?show=full";
showfullPara.addXref(link).addContent(T_show_full);
}*/
ReferenceSet referenceSet;
// if (showFullItem(objectModel))
// {
referenceSet = division.addReferenceSet("collection-viewer",
ReferenceSet.TYPE_DETAIL_VIEW);
// }
// else
// {
// referenceSet = division.addReferenceSet("collection-viewer",
// ReferenceSet.TYPE_SUMMARY_VIEW);
// }
// Refrence the actual Item
//referenceSet.addReference(item);
/*
reference any isPartOf items to create listing...
*/
ReferenceSet appearsInclude = referenceSet.addReference(item).addReferenceSet(ReferenceSet.TYPE_DETAIL_LIST,null,"hierarchy");
appearsInclude.setHead(T_head_parent_collections);
// Reference all collections the item appears in.
for (Collection collection : item.getCollections())
{
appearsInclude.addReference(collection);
}
}
/**
* Determine if the full item should be referenced or just a summary.
*/
/*
public static boolean showFullItem(Map objectModel)
{
Request request = ObjectModelHelper.getRequest(objectModel);
String show = request.getParameter("show");
if (show != null && show.length() > 0)
return true;
return false;
}*/
/**
* Obtain the item's title.
*/
public static String getItemTitle(Item item)
{
DCValue[] titles = item.getDC("title", Item.ANY, Item.ANY);
String title;
if (titles != null && titles.length > 0)
title = titles[0].value;
else
title = null;
return title;
}
/**
* Obtain the item's author.
*/
public static String getItemAuthor(Item item)
{
DCValue[] authors = item.getDC("contributor", "author", Item.ANY);
String author;
if (authors != null && authors.length > 0)
author = authors[0].value;
else
author = null;
return author;
}
/**
* Obtain the item's type.
*/
public static String getItemType(Item item)
{
DCValue[] types = item.getDC("type", null, Item.ANY);
String type;
if (types != null && types.length > 0)
type = types[0].value;
else
type = null;
return type;
}
/**
* Recycle
*/
@Override
public void recycle() {
this.validity = null;
super.recycle();
}
}