/**
* Generate the cache validity object.
*
* <p>This validity object should never "over cache" because it will perform the search, and
* serialize the results using the DSpaceValidity object.
*/
public SourceValidity getValidity() {
if (this.validity == null) {
try {
DSpaceValidity validity = new DSpaceValidity();
DSpaceObject scope = getScope();
validity.add(scope);
performSearch();
validity.add("total:" + queryResults.getHitCount());
validity.add("start:" + queryResults.getStart());
@SuppressWarnings("unchecked") // This cast is correct
java.util.List<String> handles = queryResults.getHitHandles();
for (String handle : handles) {
DSpaceObject resultDSO = HandleManager.resolveToObject(context, handle);
validity.add(resultDSO);
}
this.validity = validity.complete();
} catch (RuntimeException re) {
throw re;
} catch (Exception e) {
this.validity = null;
}
// add log message that we are viewing the item
// done here, as the serialization may not occur if the cache is valid
logSearch();
}
return this.validity;
}
protected void logSearch() {
int countCommunities = 0;
int countCollections = 0;
int countItems = 0;
for (Integer type : queryResults.getHitTypes()) {
switch (type.intValue()) {
case Constants.ITEM:
countItems++;
break;
case Constants.COLLECTION:
countCollections++;
break;
case Constants.COMMUNITY:
countCommunities++;
break;
}
}
String logInfo = "";
try {
DSpaceObject dsoScope = getScope();
if (dsoScope instanceof Collection) {
logInfo = "collection_id=" + dsoScope.getID() + ",";
} else if (dsoScope instanceof Community) {
logInfo = "community_id=" + dsoScope.getID() + ",";
}
} catch (SQLException sqle) {
// Ignore, as we are only trying to get the scope to add detail to the log message
}
log.info(
LogManager.getHeader(
context,
"search",
logInfo
+ "query=\""
+ queryArgs.getQuery()
+ "\",results=("
+ countCommunities
+ ","
+ countCollections
+ ","
+ countItems
+ ")"));
}
/**
* Attach a division to the given search division named "search-results" which contains results
* for this search query.
*
* @param search The search division to contain the search-results division.
*/
protected void buildSearchResultsDivision(Division search)
throws IOException, SQLException, WingException {
if (getQuery().length() > 0) {
// Perform the actual search
performSearch();
DSpaceObject searchScope = getScope();
Para para = search.addPara("result-query", "result-query");
String query = getQuery();
int hitCount = queryResults.getHitCount();
para.addContent(T_result_query.parameterize(query, hitCount));
Division results = search.addDivision("search-results", "primary");
if (searchScope instanceof Community) {
Community community = (Community) searchScope;
String communityName = community.getMetadata("name");
results.setHead(T_head1_community.parameterize(communityName));
} else if (searchScope instanceof Collection) {
Collection collection = (Collection) searchScope;
String collectionName = collection.getMetadata("name");
results.setHead(T_head1_collection.parameterize(collectionName));
} else {
results.setHead(T_head1_none);
}
if (queryResults.getHitCount() > 0) {
// Pagination variables.
int itemsTotal = queryResults.getHitCount();
int firstItemIndex = queryResults.getStart() + 1;
int lastItemIndex = queryResults.getStart() + queryResults.getPageSize();
if (itemsTotal < lastItemIndex) {
lastItemIndex = itemsTotal;
}
int currentPage = (queryResults.getStart() / queryResults.getPageSize()) + 1;
int pagesTotal = ((queryResults.getHitCount() - 1) / queryResults.getPageSize()) + 1;
Map<String, String> parameters = new HashMap<String, String>();
parameters.put("page", "{pageNum}");
String pageURLMask = generateURL(parameters);
results.setMaskedPagination(
itemsTotal, firstItemIndex, lastItemIndex, currentPage, pagesTotal, pageURLMask);
// Look for any communities or collections in the mix
ReferenceSet referenceSet = null;
boolean resultsContainsBothContainersAndItems = false;
@SuppressWarnings("unchecked") // This cast is correct
java.util.List<String> containerHandles = queryResults.getHitHandles();
for (String handle : containerHandles) {
DSpaceObject resultDSO = HandleManager.resolveToObject(context, handle);
if (resultDSO instanceof Community || resultDSO instanceof Collection) {
if (referenceSet == null) {
referenceSet =
results.addReferenceSet(
"search-results-repository",
ReferenceSet.TYPE_SUMMARY_LIST,
null,
"repository-search-results");
// Set a heading showing that we will be listing containers that matched:
referenceSet.setHead(T_head2);
resultsContainsBothContainersAndItems = true;
}
referenceSet.addReference(resultDSO);
}
}
// Look for any items in the result set.
referenceSet = null;
@SuppressWarnings("unchecked") // This cast is correct
java.util.List<String> itemHandles = queryResults.getHitHandles();
for (String handle : itemHandles) {
DSpaceObject resultDSO = HandleManager.resolveToObject(context, handle);
if (resultDSO instanceof Item) {
if (referenceSet == null) {
referenceSet =
results.addReferenceSet(
"search-results-repository",
ReferenceSet.TYPE_SUMMARY_LIST,
null,
"repository-search-results");
// Only set a heading if there are both containers and items.
if (resultsContainsBothContainersAndItems) {
referenceSet.setHead(T_head3);
}
}
referenceSet.addReference(resultDSO);
}
}
} else {
results.addPara(T_no_results);
}
} // Empty query
}
protected void doDSGet(Context context, HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException, SQLException, AuthorizeException {
// dispense with simple service document requests
String scope = request.getParameter("scope");
if (scope != null && "".equals(scope)) {
scope = null;
}
String path = request.getPathInfo();
if (path != null && path.endsWith("description.xml")) {
String svcDescrip = OpenSearch.getDescription(scope);
response.setContentType(OpenSearch.getContentType("opensearchdescription"));
response.setContentLength(svcDescrip.length());
response.getWriter().write(svcDescrip);
return;
}
// get enough request parameters to decide on action to take
String format = request.getParameter("format");
if (format == null || "".equals(format)) {
// default to atom
format = "atom";
}
// do some sanity checking
if (!OpenSearch.getFormats().contains(format)) {
response.sendError(HttpServletResponse.SC_BAD_REQUEST);
return;
}
// then the rest - we are processing the query
String query = request.getParameter("query");
int start = Util.getIntParameter(request, "start");
int rpp = Util.getIntParameter(request, "rpp");
int sort = Util.getIntParameter(request, "sort_by");
String order = request.getParameter("order");
String sortOrder =
(order == null || order.length() == 0 || order.toLowerCase().startsWith("asc"))
? SortOption.ASCENDING
: SortOption.DESCENDING;
QueryArgs qArgs = new QueryArgs();
// can't start earlier than 0 in the results!
if (start < 0) {
start = 0;
}
qArgs.setStart(start);
if (rpp > 0) {
qArgs.setPageSize(rpp);
}
qArgs.setSortOrder(sortOrder);
if (sort > 0) {
try {
qArgs.setSortOption(SortOption.getSortOption(sort));
} catch (Exception e) {
// invalid sort id - do nothing
}
}
qArgs.setSortOrder(sortOrder);
// Ensure the query is non-null
if (query == null) {
query = "";
}
// If there is a scope parameter, attempt to dereference it
// failure will only result in its being ignored
DSpaceObject container = (scope != null) ? HandleManager.resolveToObject(context, scope) : null;
// Build log information
String logInfo = "";
// get the start of the query results page
qArgs.setQuery(query);
// Perform the search
QueryResults qResults = null;
if (container == null) {
qResults = DSQuery.doQuery(context, qArgs);
} else if (container instanceof Collection) {
logInfo = "collection_id=" + container.getID() + ",";
qResults = DSQuery.doQuery(context, qArgs, (Collection) container);
} else if (container instanceof Community) {
logInfo = "community_id=" + container.getID() + ",";
qResults = DSQuery.doQuery(context, qArgs, (Community) container);
}
// now instantiate the results
DSpaceObject[] results = new DSpaceObject[qResults.getHitHandles().size()];
for (int i = 0; i < qResults.getHitHandles().size(); i++) {
String myHandle = (String) qResults.getHitHandles().get(i);
DSpaceObject dso = HandleManager.resolveToObject(context, myHandle);
if (dso == null) {
throw new SQLException("Query \"" + query + "\" returned unresolvable handle: " + myHandle);
}
results[i] = dso;
}
// Log
log.info(
LogManager.getHeader(
context,
"search",
logInfo + "query=\"" + query + "\",results=(" + results.length + ")"));
// format and return results
Map<String, String> labelMap = getLabels(request);
Document resultsDoc =
OpenSearch.getResultsDoc(format, query, qResults, container, results, labelMap);
try {
Transformer xf = TransformerFactory.newInstance().newTransformer();
response.setContentType(OpenSearch.getContentType(format));
xf.transform(new DOMSource(resultsDoc), new StreamResult(response.getWriter()));
} catch (TransformerException e) {
log.error(e);
throw new ServletException(e.toString());
}
}
protected void doDSGet(Context context, HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException, SQLException, AuthorizeException {
// Get the query
String query = request.getParameter("query");
int start = UIUtil.getIntParameter(request, "start");
String advanced = request.getParameter("advanced");
String fromAdvanced = request.getParameter("from_advanced");
int sortBy = UIUtil.getIntParameter(request, "sort_by");
String order = request.getParameter("order");
int rpp = UIUtil.getIntParameter(request, "rpp");
String advancedQuery = "";
HashMap queryHash = new HashMap();
// can't start earlier than 0 in the results!
if (start < 0) {
start = 0;
}
int collCount = 0;
int commCount = 0;
int itemCount = 0;
Item[] resultsItems;
Collection[] resultsCollections;
Community[] resultsCommunities;
QueryResults qResults = null;
QueryArgs qArgs = new QueryArgs();
SortOption sortOption = null;
if (request.getParameter("etal") != null)
qArgs.setEtAl(UIUtil.getIntParameter(request, "etal"));
try {
if (sortBy > 0) {
sortOption = SortOption.getSortOption(sortBy);
qArgs.setSortOption(sortOption);
}
if (SortOption.ASCENDING.equalsIgnoreCase(order)) {
qArgs.setSortOrder(SortOption.ASCENDING);
} else {
qArgs.setSortOrder(SortOption.DESCENDING);
}
} catch (Exception e) {
}
if (rpp > 0) {
qArgs.setPageSize(rpp);
}
// if the "advanced" flag is set, build the query string from the
// multiple query fields
if (advanced != null) {
query = qArgs.buildQuery(request);
advancedQuery = qArgs.buildHTTPQuery(request);
}
// Ensure the query is non-null
if (query == null) {
query = "";
}
// Get the location parameter, if any
String location = request.getParameter("location");
String newURL;
// If there is a location parameter, we should redirect to
// do the search with the correct location.
if ((location != null) && !location.equals("")) {
String url = "";
if (!location.equals("/")) {
// Location points to a resource
url = "/resource/" + location;
}
// Encode the query
query = URLEncoder.encode(query, Constants.DEFAULT_ENCODING);
if (advancedQuery.length() > 0) {
query = query + "&from_advanced=true&" + advancedQuery;
}
// Do the redirect
response.sendRedirect(
response.encodeRedirectURL(
request.getContextPath() + url + "/simple-search?query=" + query));
return;
}
// Build log information
String logInfo = "";
// Get our location
Community community = UIUtil.getCommunityLocation(request);
Collection collection = UIUtil.getCollectionLocation(request);
// get the start of the query results page
// List resultObjects = null;
qArgs.setQuery(query);
qArgs.setStart(start);
// Perform the search
if (collection != null) {
logInfo = "collection_id=" + collection.getID() + ",";
// Values for drop-down box
request.setAttribute("community", community);
request.setAttribute("collection", collection);
qResults = DSQuery.doQuery(context, qArgs, collection);
} else if (community != null) {
logInfo = "community_id=" + community.getID() + ",";
request.setAttribute("community", community);
// Get the collections within the community for the dropdown box
request.setAttribute("collection.array", community.getCollections());
qResults = DSQuery.doQuery(context, qArgs, community);
} else {
// Get all communities for dropdown box
// Community[] communities = Community.findAll(context);
Community[] communities =
(Community[]) ApplicationService.findAllCommunities(context).toArray();
request.setAttribute("community.array", communities);
qResults = DSQuery.doQuery(context, qArgs);
}
// now instantiate the results and put them in their buckets
for (int i = 0; i < qResults.getHitTypes().size(); i++) {
String myURI = (String) qResults.getHitURIs().get(i);
Integer myType = (Integer) qResults.getHitTypes().get(i);
// add the URI to the appropriate lists
switch (myType.intValue()) {
case Constants.ITEM:
itemCount++;
break;
case Constants.COLLECTION:
collCount++;
break;
case Constants.COMMUNITY:
commCount++;
break;
}
}
// Make objects from the URIs - make arrays, fill them out
resultsCommunities = new Community[commCount];
resultsCollections = new Collection[collCount];
resultsItems = new Item[itemCount];
for (int i = 0; i < qResults.getHitTypes().size(); i++) {
Integer myId = (Integer) qResults.getHitIds().get(i);
String myURI = (String) qResults.getHitURIs().get(i);
Integer myType = (Integer) qResults.getHitTypes().get(i);
switch (myType.intValue()) {
case Constants.ITEM:
if (myId != null) {
// resultsItems[itemCount] = Item.find(context, myId);
resultsItems[itemCount] = ApplicationService.get(context, Item.class, myId);
} else {
ObjectIdentifier oi = ObjectIdentifier.parseCanonicalForm(myURI);
resultsItems[itemCount] = (Item) oi.getObject(context);
}
if (resultsItems[itemCount] == null) {
throw new SQLException("Query \"" + query + "\" returned unresolvable item");
}
itemCount++;
break;
case Constants.COLLECTION:
if (myId != null) {
// resultsCollections[collCount] = Collection.find(context, myId);
resultsCollections[collCount] = ApplicationService.get(context, Collection.class, myId);
} else {
ObjectIdentifier oi = ObjectIdentifier.parseCanonicalForm(myURI);
resultsCollections[collCount] = (Collection) oi.getObject(context);
}
if (resultsCollections[collCount] == null) {
throw new SQLException("Query \"" + query + "\" returned unresolvable collection");
}
collCount++;
break;
case Constants.COMMUNITY:
if (myId != null) {
// resultsCommunities[commCount] = Community.find(context, myId);
resultsCommunities[commCount] = ApplicationService.get(context, Community.class, myId);
} else {
ObjectIdentifier oi = ObjectIdentifier.parseCanonicalForm(myURI);
resultsCommunities[commCount] = (Community) oi.getObject(context);
}
if (resultsCommunities[commCount] == null) {
throw new SQLException("Query \"" + query + "\" returned unresolvable community");
}
commCount++;
break;
}
}
// Log
log.info(
LogManager.getHeader(
context,
"search",
logInfo
+ "query=\""
+ query
+ "\",results=("
+ resultsCommunities.length
+ ","
+ resultsCollections.length
+ ","
+ resultsItems.length
+ ")"));
// Pass in some page qualities
// total number of pages
int pageTotal = 1 + ((qResults.getHitCount() - 1) / qResults.getPageSize());
// current page being displayed
int pageCurrent = 1 + (qResults.getStart() / qResults.getPageSize());
// pageLast = min(pageCurrent+9,pageTotal)
int pageLast = ((pageCurrent + 9) > pageTotal) ? pageTotal : (pageCurrent + 9);
// pageFirst = max(1,pageCurrent-9)
int pageFirst = ((pageCurrent - 9) > 1) ? (pageCurrent - 9) : 1;
// Pass the results to the display JSP
request.setAttribute("items", resultsItems);
request.setAttribute("communities", resultsCommunities);
request.setAttribute("collections", resultsCollections);
request.setAttribute("pagetotal", new Integer(pageTotal));
request.setAttribute("pagecurrent", new Integer(pageCurrent));
request.setAttribute("pagelast", new Integer(pageLast));
request.setAttribute("pagefirst", new Integer(pageFirst));
request.setAttribute("queryresults", qResults);
// And the original query string
request.setAttribute("query", query);
request.setAttribute("order", qArgs.getSortOrder());
request.setAttribute("sortedBy", sortOption);
if ((fromAdvanced != null) && (qResults.getHitCount() == 0)) {
// send back to advanced form if no results
Community[] communities =
(Community[]) ApplicationService.findAllCommunities(context).toArray();
// Community[] communities = Community.findAll(context);
request.setAttribute("communities", communities);
request.setAttribute("no_results", "yes");
queryHash = qArgs.buildQueryHash(request);
Iterator i = queryHash.keySet().iterator();
while (i.hasNext()) {
String key = (String) i.next();
String value = (String) queryHash.get(key);
request.setAttribute(key, value);
}
JSPManager.showJSP(request, response, "/search/advanced.jsp");
} else {
JSPManager.showJSP(request, response, "/search/results.jsp");
}
}
