diff --git a/docker-compose.yml b/docker-compose.yml index a6ce7e55f6..fad1a0365c 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -20,11 +20,15 @@ services: volumes: - assetstore:/dspace/assetstore - ./dspace/src/main/docker-compose/local.cfg:/dspace/config/local.cfg - # Ensure that the database is ready before starting tomcat + # Ensure that the database is ready BEFORE starting tomcat + # 1. While a TCP connection to dspacedb port 5432 is not available, continue to sleep + # 2. Then, run database migration to init database tables + # 3. Finally, start Tomcat entrypoint: - /bin/bash - '-c' - | + while (! /dev/null 2>&1; do sleep 1; done; /dspace/bin/dspace database migrate catalina.sh run dspacedb: @@ -34,6 +38,9 @@ services: image: dspace/dspace-postgres-pgcrypto networks: dspacenet: + ports: + - published: 5432 + target: 5432 stdin_open: true tty: true volumes: diff --git a/dspace-api/pom.xml b/dspace-api/pom.xml index 13ea5a56c7..620934047e 100644 --- a/dspace-api/pom.xml +++ b/dspace-api/pom.xml @@ -296,16 +296,7 @@ - - org.hibernate - hibernate-core - - - org.jboss.logging - jboss-logging - - - + org.hibernate hibernate-ehcache @@ -315,10 +306,11 @@ hibernate-jpamodelgen - org.hibernate - hibernate-validator-cdi - ${hibernate-validator.version} + org.hibernate.validator + hibernate-validator-cdi + ${hibernate-validator.version} + org.springframework spring-orm @@ -355,28 +347,6 @@ org.apache.jena apache-jena-libs pom - - - com.fasterxml.jackson.core - jackson-core - - - com.fasterxml.jackson.core - jackson-databind - - - org.slf4j - slf4j-log4j12 - - - log4j - log4j - - - - - commons-cli - commons-cli commons-codec @@ -434,18 +404,6 @@ org.jdom jdom - - org.apache.logging.log4j - log4j-api - - - org.apache.logging.log4j - log4j-1.2-api - - - org.apache.logging.log4j - log4j-core - oro oro @@ -458,10 +416,6 @@ org.apache.pdfbox fontbox - - org.apache.poi - poi - org.apache.poi poi-scratchpad @@ -481,12 +435,6 @@ xerces xercesImpl - - - xml-apis - xml-apis - - xml-apis @@ -539,66 +487,21 @@ rome-modules 1.0 - - gr.ekt.bte - bte-core - 0.9.3.5 - - - - org.mockito - mockito-core - - - log4j - log4j - - - gr.ekt.bte bte-io 0.9.3.5 - - org.apache.commons - commons-lang3 - - - - org.mockito - mockito-core - - - log4j - log4j + net.bytebuddy + byte-buddy - - org.apache.httpcomponents - httpcore - org.apache.httpcomponents httpclient - - org.apache.solr - solr-solrj - ${solr.client.version} - - - org.slf4j - jcl-over-slf4j - - - org.slf4j - slf4j-api - - - org.apache.solr @@ -606,10 +509,6 @@ ${solr.client.version} - - org.apache.commons - commons-configuration2 - com.maxmind.geoip2 geoip2 @@ -625,12 +524,6 @@ 2.1.7 - - org.apache.lucene - lucene-core - ${solr.client.version} - - com.coverity.security coverity-escapers @@ -655,11 +548,6 @@ postgresql - - org.slf4j - slf4j-api - - jdbm jdbm @@ -744,12 +632,6 @@ com.amazonaws aws-java-sdk-s3 1.10.50 - - - joda-time - joda-time - - @@ -791,6 +673,7 @@ hibernate-jpa-2.1-api 1.0.0.Final + diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/BulkEditChange.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/BulkEditChange.java index 0dbb8bd7bb..150a6ea20d 100644 --- a/dspace-api/src/main/java/org/dspace/app/bulkedit/BulkEditChange.java +++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/BulkEditChange.java @@ -19,6 +19,7 @@ import org.dspace.content.Item; * @author Stuart Lewis */ public class BulkEditChange { + /** * The item these changes relate to */ diff --git a/dspace-api/src/main/java/org/dspace/app/util/InitializeEntities.java b/dspace-api/src/main/java/org/dspace/app/util/InitializeEntities.java index d26c54d4ec..71141ce7d4 100644 --- a/dspace-api/src/main/java/org/dspace/app/util/InitializeEntities.java +++ b/dspace-api/src/main/java/org/dspace/app/util/InitializeEntities.java @@ -130,7 +130,21 @@ public class InitializeEntities { String rightType = eElement.getElementsByTagName("rightType").item(0).getTextContent(); String leftwardType = eElement.getElementsByTagName("leftwardType").item(0).getTextContent(); String rightwardType = eElement.getElementsByTagName("rightwardType").item(0).getTextContent(); + Node copyToLeftNode = eElement.getElementsByTagName("copyToLeft").item(0); + Boolean copyToLeft; + if (copyToLeftNode == null) { + copyToLeft = false; + } else { + copyToLeft = Boolean.valueOf(copyToLeftNode.getTextContent()); + } + Node copyToRightNode = eElement.getElementsByTagName("copyToRight").item(0); + Boolean copyToRight; + if (copyToRightNode == null) { + copyToRight = false; + } else { + copyToRight = Boolean.valueOf(copyToRightNode.getTextContent()); + } NodeList leftCardinalityList = eElement.getElementsByTagName("leftCardinality"); NodeList rightCardinalityList = eElement.getElementsByTagName("rightCardinality"); @@ -156,7 +170,7 @@ public class InitializeEntities { } populateRelationshipType(context, leftType, rightType, leftwardType, rightwardType, leftCardinalityMin, leftCardinalityMax, - rightCardinalityMin, rightCardinalityMax); + rightCardinalityMin, rightCardinalityMax, copyToLeft, copyToRight); } @@ -175,7 +189,8 @@ public class InitializeEntities { private void populateRelationshipType(Context context, String leftType, String rightType, String leftwardType, String rightwardType, String leftCardinalityMin, String leftCardinalityMax, - String rightCardinalityMin, String rightCardinalityMax) + String rightCardinalityMin, String rightCardinalityMax, + Boolean copyToLeft, Boolean copyToRight) throws SQLException, AuthorizeException { EntityType leftEntityType = entityTypeService.findByEntityType(context,leftType); @@ -215,8 +230,11 @@ public class InitializeEntities { if (relationshipType == null) { relationshipTypeService.create(context, leftEntityType, rightEntityType, leftwardType, rightwardType, leftCardinalityMinInteger, leftCardinalityMaxInteger, - rightCardinalityMinInteger, rightCardinalityMaxInteger); + rightCardinalityMinInteger, rightCardinalityMaxInteger, + copyToLeft, copyToRight); } else { + relationshipType.setCopyToLeft(copyToLeft); + relationshipType.setCopyToRight(copyToRight); relationshipType.setLeftMinCardinality(leftCardinalityMinInteger); relationshipType.setLeftMaxCardinality(leftCardinalityMaxInteger); relationshipType.setRightMinCardinality(rightCardinalityMinInteger); diff --git a/dspace-api/src/main/java/org/dspace/app/util/SyndicationFeed.java b/dspace-api/src/main/java/org/dspace/app/util/SyndicationFeed.java index 4bb89a1739..f72035b4e1 100644 --- a/dspace-api/src/main/java/org/dspace/app/util/SyndicationFeed.java +++ b/dspace-api/src/main/java/org/dspace/app/util/SyndicationFeed.java @@ -50,9 +50,11 @@ import org.dspace.content.service.CollectionService; import org.dspace.content.service.CommunityService; import org.dspace.content.service.ItemService; import org.dspace.core.ConfigurationManager; -import org.dspace.core.Constants; import org.dspace.core.Context; import org.dspace.discovery.IndexableObject; +import org.dspace.discovery.indexobject.IndexableCollection; +import org.dspace.discovery.indexobject.IndexableCommunity; +import org.dspace.discovery.indexobject.IndexableItem; import org.dspace.handle.factory.HandleServiceFactory; import org.dspace.services.ConfigurationService; import org.dspace.services.factory.DSpaceServicesFactory; @@ -200,8 +202,8 @@ public class SyndicationFeed { logoURL = ConfigurationManager.getProperty("webui.feed.logo.url"); } else { Bitstream logo = null; - if (dso.getType() == Constants.COLLECTION) { - Collection col = (Collection) dso; + if (dso instanceof IndexableCollection) { + Collection col = ((IndexableCollection) dso).getIndexedObject(); defaultTitle = col.getName(); feed.setDescription(collectionService.getMetadata(col, "short_description")); logo = col.getLogo(); @@ -210,8 +212,8 @@ public class SyndicationFeed { podcastFeed = true; } objectURL = resolveURL(request, col); - } else if (dso.getType() == Constants.COMMUNITY) { - Community comm = (Community) dso; + } else if (dso instanceof IndexableCommunity) { + Community comm = ((IndexableCommunity) dso).getIndexedObject(); defaultTitle = comm.getName(); feed.setDescription(communityService.getMetadata(comm, "short_description")); logo = comm.getLogo(); @@ -251,10 +253,10 @@ public class SyndicationFeed { if (items != null) { List entries = new ArrayList(); for (IndexableObject idxObj : items) { - if (idxObj.getType() != Constants.ITEM) { + if (!(idxObj instanceof IndexableItem)) { continue; } - Item item = (Item) idxObj; + Item item = ((IndexableItem) idxObj).getIndexedObject(); boolean hasDate = false; SyndEntry entry = new SyndEntryImpl(); entries.add(entry); diff --git a/dspace-api/src/main/java/org/dspace/browse/BrowserScope.java b/dspace-api/src/main/java/org/dspace/browse/BrowserScope.java index 10cb23f8e9..ec61d37abc 100644 --- a/dspace-api/src/main/java/org/dspace/browse/BrowserScope.java +++ b/dspace-api/src/main/java/org/dspace/browse/BrowserScope.java @@ -12,6 +12,8 @@ import org.dspace.content.Community; import org.dspace.content.DSpaceObject; import org.dspace.core.Context; import org.dspace.discovery.IndexableObject; +import org.dspace.discovery.indexobject.IndexableCollection; +import org.dspace.discovery.indexobject.IndexableCommunity; import org.dspace.sort.SortException; import org.dspace.sort.SortOption; @@ -136,10 +138,10 @@ public class BrowserScope { */ public void setBrowseContainer(IndexableObject dso) throws BrowseException { - if (dso instanceof Collection) { - this.collection = (Collection) dso; - } else if (dso instanceof Community) { - this.community = (Community) dso; + if (dso instanceof IndexableCollection) { + this.collection = ((IndexableCollection) dso).getIndexedObject(); + } else if (dso instanceof IndexableCommunity) { + this.community = ((IndexableCommunity) dso).getIndexedObject(); } else { throw new BrowseException("The container must be a community or a collection"); } diff --git a/dspace-api/src/main/java/org/dspace/browse/ItemCountDAOSolr.java b/dspace-api/src/main/java/org/dspace/browse/ItemCountDAOSolr.java index 4b741847a8..d233270d81 100644 --- a/dspace-api/src/main/java/org/dspace/browse/ItemCountDAOSolr.java +++ b/dspace-api/src/main/java/org/dspace/browse/ItemCountDAOSolr.java @@ -23,6 +23,7 @@ import org.dspace.discovery.DiscoverResult.FacetResult; import org.dspace.discovery.SearchService; import org.dspace.discovery.SearchServiceException; import org.dspace.discovery.configuration.DiscoveryConfigurationParameters; +import org.dspace.discovery.indexobject.IndexableItem; import org.dspace.services.factory.DSpaceServicesFactory; /** @@ -122,13 +123,13 @@ public class ItemCountDAOSolr implements ItemCountDAO { query.addFacetField(new DiscoverFacetField("location.coll", DiscoveryConfigurationParameters.TYPE_STANDARD, -1, DiscoveryConfigurationParameters.SORT.COUNT)); - query.addFilterQueries("search.resourcetype:2"); // count only items + query.addFilterQueries("search.resourcetype:" + IndexableItem.TYPE); // count only items query.addFilterQueries("NOT(discoverable:false)"); // only discoverable query.setMaxResults(0); DiscoverResult sResponse = null; try { - sResponse = searcher.search(context, query, false); + sResponse = searcher.search(context, query); List commCount = sResponse.getFacetResult("location.comm"); List collCount = sResponse.getFacetResult("location.coll"); for (FacetResult c : commCount) { diff --git a/dspace-api/src/main/java/org/dspace/browse/SolrBrowseDAO.java b/dspace-api/src/main/java/org/dspace/browse/SolrBrowseDAO.java index ae491ad935..6a960e8d75 100644 --- a/dspace-api/src/main/java/org/dspace/browse/SolrBrowseDAO.java +++ b/dspace-api/src/main/java/org/dspace/browse/SolrBrowseDAO.java @@ -20,7 +20,6 @@ import org.apache.logging.log4j.Logger; import org.dspace.authorize.factory.AuthorizeServiceFactory; import org.dspace.authorize.service.AuthorizeService; import org.dspace.content.Item; -import org.dspace.core.Constants; import org.dspace.core.Context; import org.dspace.discovery.DiscoverFacetField; import org.dspace.discovery.DiscoverQuery; @@ -32,6 +31,7 @@ import org.dspace.discovery.IndexableObject; import org.dspace.discovery.SearchService; import org.dspace.discovery.SearchServiceException; import org.dspace.discovery.configuration.DiscoveryConfigurationParameters; +import org.dspace.discovery.indexobject.IndexableItem; import org.dspace.services.factory.DSpaceServicesFactory; /** @@ -169,9 +169,6 @@ public class SolrBrowseDAO implements BrowseDAO { private DiscoverResult sResponse = null; - private boolean itemsWithdrawn = false; - private boolean itemsDiscoverable = true; - private boolean showFrequencies; private DiscoverResult getSolrResponse() throws BrowseException { @@ -210,15 +207,14 @@ public class SolrBrowseDAO implements BrowseDAO { } // filter on item to be sure to don't include any other object // indexed in the Discovery Search core - query.addFilterQueries("search.resourcetype:" + Constants.ITEM); + query.addFilterQueries("search.resourcetype:" + IndexableItem.TYPE); if (orderField != null) { query.setSortField("bi_" + orderField + "_sort", ascending ? SORT_ORDER.asc : SORT_ORDER.desc); } } try { - sResponse = searcher.search(context, query, itemsWithdrawn - || !itemsDiscoverable); + sResponse = searcher.search(context, query); } catch (SearchServiceException e) { throw new BrowseException(e); } @@ -227,21 +223,14 @@ public class SolrBrowseDAO implements BrowseDAO { } private void addStatusFilter(DiscoverQuery query) { - if (itemsWithdrawn) { - query.addFilterQueries("withdrawn:true"); - } else if (!itemsDiscoverable) { - query.addFilterQueries("discoverable:false"); - // TODO - - try { - if (!authorizeService.isAdmin(context) - && (authorizeService.isCommunityAdmin(context) - || authorizeService.isCollectionAdmin(context))) { - query.addFilterQueries(searcher.createLocationQueryForAdministrableItems(context)); - } - } catch (SQLException ex) { - log.error(ex); + try { + if (!authorizeService.isAdmin(context) + && (authorizeService.isCommunityAdmin(context) + || authorizeService.isCollectionAdmin(context))) { + query.addFilterQueries(searcher.createLocationQueryForAdministrableItems(context)); } + } catch (SQLException ex) { + log.error("Error looking up authorization rights of current user", ex); } } @@ -308,10 +297,10 @@ public class SolrBrowseDAO implements BrowseDAO { DiscoverResult resp = getSolrResponse(); List bitems = new ArrayList<>(); - for (IndexableObject solrDoc : resp.getIndexableObjects()) { + for (IndexableObject solrDoc : resp.getIndexableObjects()) { // FIXME introduce project, don't retrieve Item immediately when // processing the query... - Item item = (Item) solrDoc; + Item item = ((IndexableItem) solrDoc).getIndexedObject(); bitems.add(item); } return bitems; @@ -322,7 +311,7 @@ public class SolrBrowseDAO implements BrowseDAO { throws BrowseException { DiscoverQuery query = new DiscoverQuery(); query.setQuery("search.resourceid:" + itemID - + " AND search.resourcetype:" + Constants.ITEM); + + " AND search.resourcetype:" + IndexableItem.TYPE); query.setMaxResults(1); DiscoverResult resp = null; try { @@ -345,7 +334,7 @@ public class SolrBrowseDAO implements BrowseDAO { addLocationScopeFilter(query); addStatusFilter(query); query.setMaxResults(0); - query.addFilterQueries("search.resourcetype:" + Constants.ITEM); + query.addFilterQueries("search.resourcetype:" + IndexableItem.TYPE); // We need to take into account the fact that we may be in a subset of the items if (authority != null) { @@ -363,10 +352,9 @@ public class SolrBrowseDAO implements BrowseDAO { query.setQuery("bi_" + column + "_sort" + ": {\"" + value + "\" TO *]"); query.addFilterQueries("-(bi_" + column + "_sort" + ":" + value + "*)"); } - boolean includeUnDiscoverable = itemsWithdrawn || !itemsDiscoverable; DiscoverResult resp = null; try { - resp = searcher.search(context, query, includeUnDiscoverable); + resp = searcher.search(context, query); } catch (SearchServiceException e) { throw new BrowseException(e); } @@ -693,11 +681,6 @@ public class SolrBrowseDAO implements BrowseDAO { */ @Override public void setTable(String table) { - if (table.equals(BrowseIndex.getWithdrawnBrowseIndex().getTableName())) { - itemsWithdrawn = true; - } else if (table.equals(BrowseIndex.getPrivateBrowseIndex().getTableName())) { - itemsDiscoverable = false; - } facetField = table; } diff --git a/dspace-api/src/main/java/org/dspace/content/BitstreamServiceImpl.java b/dspace-api/src/main/java/org/dspace/content/BitstreamServiceImpl.java index 78d65800b1..83e91a2d7b 100644 --- a/dspace-api/src/main/java/org/dspace/content/BitstreamServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/content/BitstreamServiceImpl.java @@ -14,6 +14,8 @@ import java.util.Iterator; import java.util.List; import java.util.UUID; +import javax.annotation.Nullable; + import org.apache.commons.collections4.CollectionUtils; import org.apache.commons.lang3.StringUtils; import org.apache.logging.log4j.Logger; @@ -462,7 +464,9 @@ public class BitstreamServiceImpl extends DSpaceObjectServiceImpl imp return bitstreamDAO.getNotReferencedBitstreams(context); } - public Long getLastModified(Bitstream bitstream) { + @Nullable + @Override + public Long getLastModified(Bitstream bitstream) throws IOException { return bitstreamStorageService.getLastModified(bitstream); } } diff --git a/dspace-api/src/main/java/org/dspace/content/Collection.java b/dspace-api/src/main/java/org/dspace/content/Collection.java index 0d6a662b29..32d70aacaf 100644 --- a/dspace-api/src/main/java/org/dspace/content/Collection.java +++ b/dspace-api/src/main/java/org/dspace/content/Collection.java @@ -12,7 +12,6 @@ import java.util.Arrays; import java.util.HashSet; import java.util.List; import java.util.Set; -import java.util.UUID; import javax.persistence.Cacheable; import javax.persistence.CascadeType; @@ -32,7 +31,6 @@ import org.dspace.content.factory.ContentServiceFactory; import org.dspace.content.service.CollectionService; import org.dspace.core.Constants; import org.dspace.core.Context; -import org.dspace.discovery.IndexableObject; import org.dspace.eperson.Group; import org.hibernate.annotations.CacheConcurrencyStrategy; import org.hibernate.proxy.HibernateProxyHelper; @@ -55,7 +53,7 @@ import org.hibernate.proxy.HibernateProxyHelper; @Table(name = "collection") @Cacheable @org.hibernate.annotations.Cache(usage = CacheConcurrencyStrategy.NONSTRICT_READ_WRITE, include = "non-lazy") -public class Collection extends DSpaceObject implements DSpaceObjectLegacySupport, IndexableObject { +public class Collection extends DSpaceObject implements DSpaceObjectLegacySupport { @Column(name = "collection_id", insertable = false, updatable = false) private Integer legacyId; @@ -331,9 +329,4 @@ public class Collection extends DSpaceObject implements DSpaceObjectLegacySuppor return collectionService; } - @Override - public String getTypeText() { - return Constants.typeText[Constants.COLLECTION]; - } - } diff --git a/dspace-api/src/main/java/org/dspace/content/CollectionServiceImpl.java b/dspace-api/src/main/java/org/dspace/content/CollectionServiceImpl.java index 2899159ec9..cc6d32b8c3 100644 --- a/dspace-api/src/main/java/org/dspace/content/CollectionServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/content/CollectionServiceImpl.java @@ -278,15 +278,6 @@ public class CollectionServiceImpl extends DSpaceObjectServiceImpl i return collectionDAO.findByID(context, Collection.class, id); } - @Override - /** - * This method is an alias of the find method needed to avoid ambiguity between the IndexableObjectService interface - * and the DSpaceObjectService interface - */ - public Collection findIndexableObject(Context context, UUID id) throws SQLException { - return collectionDAO.findByID(context, Collection.class, id); - } - @Override public void setMetadata(Context context, Collection collection, String field, String value) throws MissingResourceException, SQLException { @@ -795,15 +786,6 @@ public class CollectionServiceImpl extends DSpaceObjectServiceImpl i return Constants.COLLECTION; } - @Override - /** - * This method is an alias of the getSupportsTypeConstant method needed to avoid ambiguity between the - * IndexableObjectService interface and the DSpaceObjectService interface - */ - public int getSupportsIndexableObjectTypeConstant() { - return getSupportsTypeConstant(); - } - @Override public List findAuthorized(Context context, Community community, int actionID) throws SQLException { List myResults = new ArrayList<>(); diff --git a/dspace-api/src/main/java/org/dspace/content/Community.java b/dspace-api/src/main/java/org/dspace/content/Community.java index aecd03fcd6..f8319b4cd1 100644 --- a/dspace-api/src/main/java/org/dspace/content/Community.java +++ b/dspace-api/src/main/java/org/dspace/content/Community.java @@ -11,7 +11,6 @@ import java.util.Arrays; import java.util.HashSet; import java.util.List; import java.util.Set; -import java.util.UUID; import javax.persistence.Cacheable; import javax.persistence.CascadeType; @@ -32,7 +31,6 @@ import org.dspace.content.factory.ContentServiceFactory; import org.dspace.content.service.CommunityService; import org.dspace.core.Constants; import org.dspace.core.Context; -import org.dspace.discovery.IndexableObject; import org.dspace.eperson.Group; import org.hibernate.annotations.CacheConcurrencyStrategy; import org.hibernate.proxy.HibernateProxyHelper; @@ -51,7 +49,7 @@ import org.hibernate.proxy.HibernateProxyHelper; @Table(name = "community") @Cacheable @org.hibernate.annotations.Cache(usage = CacheConcurrencyStrategy.NONSTRICT_READ_WRITE, include = "non-lazy") -public class Community extends DSpaceObject implements DSpaceObjectLegacySupport, IndexableObject { +public class Community extends DSpaceObject implements DSpaceObjectLegacySupport { /** * log4j category */ @@ -254,11 +252,6 @@ public class Community extends DSpaceObject implements DSpaceObjectLegacySupport return Constants.COMMUNITY; } - @Override - public String getTypeText() { - return Constants.typeText[Constants.COMMUNITY]; - } - @Override public String getName() { String value = getCommunityService() diff --git a/dspace-api/src/main/java/org/dspace/content/CommunityServiceImpl.java b/dspace-api/src/main/java/org/dspace/content/CommunityServiceImpl.java index 242a5ff389..c49442267a 100644 --- a/dspace-api/src/main/java/org/dspace/content/CommunityServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/content/CommunityServiceImpl.java @@ -137,15 +137,6 @@ public class CommunityServiceImpl extends DSpaceObjectServiceImpl imp return communityDAO.findByID(context, Community.class, id); } - @Override - /** - * This method is an alias of the find method needed to avoid ambiguity between the IndexableObjectService interface - * and the DSpaceObjectService interface - */ - public Community findIndexableObject(Context context, UUID id) throws SQLException { - return find(context, id); - } - @Override public List findAll(Context context) throws SQLException { MetadataField sortField = metadataFieldService.findByElement(context, MetadataSchemaEnum.DC.getName(), @@ -520,15 +511,6 @@ public class CommunityServiceImpl extends DSpaceObjectServiceImpl imp return Constants.COMMUNITY; } - @Override - /** - * This method is an alias of the getSupportsTypeConstant method needed to avoid ambiguity between the - * IndexableObjectService interface and the DSpaceObjectService interface - */ - public int getSupportsIndexableObjectTypeConstant() { - return getSupportsTypeConstant(); - } - /** * Internal method to remove the community and all its children from the * database, and perform any pre/post-cleanup diff --git a/dspace-api/src/main/java/org/dspace/content/EntityServiceImpl.java b/dspace-api/src/main/java/org/dspace/content/EntityServiceImpl.java index eb25605cff..00d522f926 100644 --- a/dspace-api/src/main/java/org/dspace/content/EntityServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/content/EntityServiceImpl.java @@ -51,7 +51,7 @@ public class EntityServiceImpl implements EntityService { @Override public EntityType getType(Context context, Entity entity) throws SQLException { Item item = entity.getItem(); - List list = itemService.getMetadata(item, "relationship", "type", null, Item.ANY); + List list = itemService.getMetadata(item, "relationship", "type", null, Item.ANY, false); if (!list.isEmpty()) { return entityTypeService.findByEntityType(context, list.get(0).getValue()); } else { diff --git a/dspace-api/src/main/java/org/dspace/content/InProgressSubmission.java b/dspace-api/src/main/java/org/dspace/content/InProgressSubmission.java index df1d9c1623..5e7a04c4c9 100644 --- a/dspace-api/src/main/java/org/dspace/content/InProgressSubmission.java +++ b/dspace-api/src/main/java/org/dspace/content/InProgressSubmission.java @@ -7,10 +7,9 @@ */ package org.dspace.content; -import java.io.Serializable; import java.sql.SQLException; -import org.dspace.discovery.IndexableObject; +import org.dspace.core.ReloadableEntity; import org.dspace.eperson.EPerson; /** @@ -20,13 +19,13 @@ import org.dspace.eperson.EPerson; * @author Robert Tansley * @version $Revision$ */ -public interface InProgressSubmission extends IndexableObject { +public interface InProgressSubmission extends ReloadableEntity { /** * Get the internal ID of this submission * * @return the internal identifier */ - ID getID(); + Integer getID(); /** * Get the incomplete item object @@ -48,7 +47,7 @@ public interface InProgressSubmission extends Indexable * @return the submitting e-person * @throws SQLException if database error */ - EPerson getSubmitter() throws SQLException; + EPerson getSubmitter(); /** * Find out if the submission has (or is intended to have) more than one diff --git a/dspace-api/src/main/java/org/dspace/content/Item.java b/dspace-api/src/main/java/org/dspace/content/Item.java index adb2eaaacd..20975c8ccf 100644 --- a/dspace-api/src/main/java/org/dspace/content/Item.java +++ b/dspace-api/src/main/java/org/dspace/content/Item.java @@ -13,7 +13,6 @@ import java.util.Date; import java.util.HashSet; import java.util.List; import java.util.Set; -import java.util.UUID; import javax.persistence.CascadeType; import javax.persistence.Column; @@ -35,7 +34,6 @@ import org.dspace.content.factory.ContentServiceFactory; import org.dspace.content.service.ItemService; import org.dspace.core.Constants; import org.dspace.core.Context; -import org.dspace.discovery.IndexableObject; import org.dspace.eperson.EPerson; import org.hibernate.proxy.HibernateProxyHelper; @@ -55,7 +53,7 @@ import org.hibernate.proxy.HibernateProxyHelper; */ @Entity @Table(name = "item") -public class Item extends DSpaceObject implements DSpaceObjectLegacySupport, IndexableObject { +public class Item extends DSpaceObject implements DSpaceObjectLegacySupport { /** * log4j logger @@ -376,10 +374,4 @@ public class Item extends DSpaceObject implements DSpaceObjectLegacySupport, Ind } return itemService; } - - @Override - public String getTypeText() { - return getItemService().getTypeText(this); - } - } diff --git a/dspace-api/src/main/java/org/dspace/content/ItemServiceImpl.java b/dspace-api/src/main/java/org/dspace/content/ItemServiceImpl.java index 2edd72b0f7..9502a2ca32 100644 --- a/dspace-api/src/main/java/org/dspace/content/ItemServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/content/ItemServiceImpl.java @@ -172,15 +172,6 @@ public class ItemServiceImpl extends DSpaceObjectServiceImpl implements It return item; } - @Override - /** - * This method is an alias of the find method needed to avoid ambiguity between the IndexableObjectService interface - * and the DSpaceObjectService interface - */ - public Item findIndexableObject(Context context, UUID id) throws SQLException { - return find(context, id); - } - @Override public Item create(Context context, WorkspaceItem workspaceItem) throws SQLException, AuthorizeException { if (workspaceItem.getItem() != null) { @@ -677,15 +668,6 @@ public class ItemServiceImpl extends DSpaceObjectServiceImpl implements It return Constants.ITEM; } - @Override - /** - * This method is an alias of the getSupportsTypeConstant method needed to avoid ambiguity between the - * IndexableObjectService interface and the DSpaceObjectService interface - */ - public int getSupportsIndexableObjectTypeConstant() { - return getSupportsTypeConstant(); - } - protected void rawDelete(Context context, Item item) throws AuthorizeException, SQLException, IOException { authorizeService.authorizeAction(context, item, Constants.REMOVE); diff --git a/dspace-api/src/main/java/org/dspace/content/RelationshipMetadataServiceImpl.java b/dspace-api/src/main/java/org/dspace/content/RelationshipMetadataServiceImpl.java index 9a7ec9704b..bc466c5b83 100644 --- a/dspace-api/src/main/java/org/dspace/content/RelationshipMetadataServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/content/RelationshipMetadataServiceImpl.java @@ -240,7 +240,6 @@ public class RelationshipMetadataServiceImpl implements RelationshipMetadataServ return null; } metadataValue.setMetadataField(metadataField); - metadataValue.setLanguage(Item.ANY); return metadataValue; } diff --git a/dspace-api/src/main/java/org/dspace/content/RelationshipServiceImpl.java b/dspace-api/src/main/java/org/dspace/content/RelationshipServiceImpl.java index 8012c29f6a..0f08b15635 100644 --- a/dspace-api/src/main/java/org/dspace/content/RelationshipServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/content/RelationshipServiceImpl.java @@ -317,8 +317,8 @@ public class RelationshipServiceImpl implements RelationshipService { @Override public void delete(Context context, Relationship relationship) throws SQLException, AuthorizeException { - //TODO: retrieve default settings from configuration - delete(context, relationship, false, false); + delete(context, relationship, relationship.getRelationshipType().isCopyToLeft(), + relationship.getRelationshipType().isCopyToRight()); } @Override @@ -364,9 +364,14 @@ public class RelationshipServiceImpl implements RelationshipService { relationshipMetadataService.findRelationshipMetadataValueForItemRelationship(context, relationship.getLeftItem(), entityTypeString, relationship, true); for (RelationshipMetadataValue relationshipMetadataValue : relationshipMetadataValues) { - itemService.addMetadata(context, relationship.getLeftItem(), - relationshipMetadataValue.getMetadataField(), null, - relationshipMetadataValue.getValue() ); + itemService.addAndShiftRightMetadata(context, relationship.getLeftItem(), + relationshipMetadataValue.getMetadataField(). + getMetadataSchema().getName(), + relationshipMetadataValue.getMetadataField().getElement(), + relationshipMetadataValue.getMetadataField().getQualifier(), + relationshipMetadataValue.getLanguage(), + relationshipMetadataValue.getValue(), null, -1, + relationshipMetadataValue.getPlace()); } itemService.update(context, relationship.getLeftItem()); } @@ -377,9 +382,14 @@ public class RelationshipServiceImpl implements RelationshipService { relationshipMetadataService.findRelationshipMetadataValueForItemRelationship(context, relationship.getRightItem(), entityTypeString, relationship, true); for (RelationshipMetadataValue relationshipMetadataValue : relationshipMetadataValues) { - itemService.addMetadata(context, relationship.getRightItem(), - relationshipMetadataValue.getMetadataField(), null, - relationshipMetadataValue.getValue() ); + itemService.addAndShiftRightMetadata(context, relationship.getRightItem(), + relationshipMetadataValue.getMetadataField(). + getMetadataSchema().getName(), + relationshipMetadataValue.getMetadataField().getElement(), + relationshipMetadataValue.getMetadataField().getQualifier(), + relationshipMetadataValue.getLanguage(), + relationshipMetadataValue.getValue(), null, -1, + relationshipMetadataValue.getPlace()); } itemService.update(context, relationship.getRightItem()); } diff --git a/dspace-api/src/main/java/org/dspace/content/RelationshipType.java b/dspace-api/src/main/java/org/dspace/content/RelationshipType.java index 0d33c98adf..5f16870bc6 100644 --- a/dspace-api/src/main/java/org/dspace/content/RelationshipType.java +++ b/dspace-api/src/main/java/org/dspace/content/RelationshipType.java @@ -102,6 +102,17 @@ public class RelationshipType implements ReloadableEntity { @Column(name = "right_max_cardinality") private Integer rightMaxCardinality; + /** + * The boolean indicating whether the metadata should be copied on left item or not + */ + @Column(name = "copy_to_left", nullable = false) + private boolean copyToLeft; + + /** + * The boolean indicating whether the metadata should be copied on right item or not + */ + @Column(name = "copy_to_right", nullable = false) + private boolean copyToRight; /** * Protected constructor, create object using: * {@link org.dspace.content.service.RelationshipTypeService#create(Context)} } @@ -244,6 +255,38 @@ public class RelationshipType implements ReloadableEntity { this.rightMaxCardinality = rightMaxCardinality; } + /** + * Generic getter for the copyToLeft + * @return the copyToLeft value of this RelationshipType + */ + public boolean isCopyToLeft() { + return copyToLeft; + } + + /** + * Generic setter for the copyToLeft + * @param copyToLeft The copyToLeft to be set on this RelationshipType + */ + public void setCopyToLeft(boolean copyToLeft) { + this.copyToLeft = copyToLeft; + } + + /** + * Generic getter for the copyToRight + * @return the copyToRight value of this RelationshipType + */ + public boolean isCopyToRight() { + return copyToRight; + } + + /** + * Generic setter for the copyToRight + * @param copyToRight The copyToRight to be set on this RelationshipType + */ + public void setCopyToRight(boolean copyToRight) { + this.copyToRight = copyToRight; + } + /** * Standard getter for the ID of this RelationshipType * @return The ID of this RelationshipType diff --git a/dspace-api/src/main/java/org/dspace/content/RelationshipTypeServiceImpl.java b/dspace-api/src/main/java/org/dspace/content/RelationshipTypeServiceImpl.java index 0864e8c185..2600fd90b2 100644 --- a/dspace-api/src/main/java/org/dspace/content/RelationshipTypeServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/content/RelationshipTypeServiceImpl.java @@ -117,6 +117,26 @@ public class RelationshipTypeServiceImpl implements RelationshipTypeService { return create(context, relationshipType); } + @Override + public RelationshipType create(Context context, EntityType leftEntityType, EntityType rightEntityType, + String leftwardType, String rightwardType, Integer leftCardinalityMinInteger, + Integer leftCardinalityMaxInteger, Integer rightCardinalityMinInteger, + Integer rightCardinalityMaxInteger, Boolean copyToLeft, Boolean copyToRight) + throws SQLException, AuthorizeException { + RelationshipType relationshipType = new RelationshipType(); + relationshipType.setLeftType(leftEntityType); + relationshipType.setRightType(rightEntityType); + relationshipType.setLeftwardType(leftwardType); + relationshipType.setRightwardType(rightwardType); + relationshipType.setCopyToLeft(copyToLeft); + relationshipType.setCopyToRight(copyToRight); + relationshipType.setLeftMinCardinality(leftCardinalityMinInteger); + relationshipType.setLeftMaxCardinality(leftCardinalityMaxInteger); + relationshipType.setRightMinCardinality(rightCardinalityMinInteger); + relationshipType.setRightMaxCardinality(rightCardinalityMaxInteger); + return create(context, relationshipType); + } + @Override public RelationshipType find(Context context,int id) throws SQLException { return relationshipTypeDAO.findByID(context, RelationshipType.class, id); diff --git a/dspace-api/src/main/java/org/dspace/content/WorkspaceItem.java b/dspace-api/src/main/java/org/dspace/content/WorkspaceItem.java index 0a61f4d93a..e2ded4815d 100644 --- a/dspace-api/src/main/java/org/dspace/content/WorkspaceItem.java +++ b/dspace-api/src/main/java/org/dspace/content/WorkspaceItem.java @@ -8,7 +8,6 @@ package org.dspace.content; import java.io.Serializable; -import java.sql.SQLException; import java.util.ArrayList; import java.util.List; @@ -27,10 +26,7 @@ import javax.persistence.SequenceGenerator; import javax.persistence.Table; import org.apache.commons.lang3.builder.HashCodeBuilder; -import org.dspace.core.Constants; import org.dspace.core.Context; -import org.dspace.core.ReloadableEntity; -import org.dspace.discovery.IndexableObject; import org.dspace.eperson.EPerson; import org.dspace.eperson.Group; import org.dspace.workflow.WorkflowItem; @@ -45,7 +41,7 @@ import org.hibernate.proxy.HibernateProxyHelper; @Entity @Table(name = "workspaceitem") public class WorkspaceItem - implements InProgressSubmission, Serializable, ReloadableEntity, IndexableObject { + implements InProgressSubmission, Serializable { @Id @Column(name = "workspace_item_id", unique = true, nullable = false) @@ -197,7 +193,7 @@ public class WorkspaceItem } @Override - public EPerson getSubmitter() throws SQLException { + public EPerson getSubmitter() { return item.getSubmitter(); } @@ -242,10 +238,4 @@ public class WorkspaceItem void addSupervisorGroup(Group group) { supervisorGroups.add(group); } - - @Override - public int getType() { - return Constants.WORKSPACEITEM; - } - } diff --git a/dspace-api/src/main/java/org/dspace/content/WorkspaceItemServiceImpl.java b/dspace-api/src/main/java/org/dspace/content/WorkspaceItemServiceImpl.java index 42ff757446..c45f6c737c 100644 --- a/dspace-api/src/main/java/org/dspace/content/WorkspaceItemServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/content/WorkspaceItemServiceImpl.java @@ -60,11 +60,6 @@ public class WorkspaceItemServiceImpl implements WorkspaceItemService { } - @Override - public int getSupportsIndexableObjectTypeConstant() { - return Constants.WORKSPACEITEM; - } - @Override public WorkspaceItem find(Context context, int id) throws SQLException { WorkspaceItem workspaceItem = workspaceItemDAO.findByID(context, WorkspaceItem.class, id); @@ -83,14 +78,6 @@ public class WorkspaceItemServiceImpl implements WorkspaceItemService { return workspaceItem; } - @Override - public WorkspaceItem findIndexableObject(Context context, Integer id) throws SQLException { - if (id != null) { - return find(context, id); - } - return null; - } - @Override public WorkspaceItem create(Context context, Collection collection, boolean template) throws AuthorizeException, SQLException { diff --git a/dspace-api/src/main/java/org/dspace/content/dao/impl/RelationshipDAOImpl.java b/dspace-api/src/main/java/org/dspace/content/dao/impl/RelationshipDAOImpl.java index ed5a4260e8..53a2a0fb0b 100644 --- a/dspace-api/src/main/java/org/dspace/content/dao/impl/RelationshipDAOImpl.java +++ b/dspace-api/src/main/java/org/dspace/content/dao/impl/RelationshipDAOImpl.java @@ -145,11 +145,13 @@ public class RelationshipDAOImpl extends AbstractHibernateDAO impl .where(criteriaBuilder.equal(relationshipRoot.get(Relationship_.relationshipType), relationshipType), criteriaBuilder.equal(relationshipRoot.get(Relationship_.leftItem), item)); + criteriaQuery.orderBy(criteriaBuilder.asc(relationshipRoot.get(Relationship_.leftPlace))); } else { criteriaQuery .where(criteriaBuilder.equal(relationshipRoot.get(Relationship_.relationshipType), relationshipType), criteriaBuilder.equal(relationshipRoot.get(Relationship_.rightItem), item)); + criteriaQuery.orderBy(criteriaBuilder.asc(relationshipRoot.get(Relationship_.rightPlace))); } return list(context, criteriaQuery, true, Relationship.class, limit, offset); } diff --git a/dspace-api/src/main/java/org/dspace/content/factory/ContentServiceFactory.java b/dspace-api/src/main/java/org/dspace/content/factory/ContentServiceFactory.java index f7c5274883..4010e14861 100644 --- a/dspace-api/src/main/java/org/dspace/content/factory/ContentServiceFactory.java +++ b/dspace-api/src/main/java/org/dspace/content/factory/ContentServiceFactory.java @@ -7,7 +7,6 @@ */ package org.dspace.content.factory; -import java.io.Serializable; import java.util.List; import org.dspace.content.DSpaceObject; @@ -24,7 +23,6 @@ import org.dspace.content.service.DSpaceObjectService; import org.dspace.content.service.EntityService; import org.dspace.content.service.EntityTypeService; import org.dspace.content.service.InProgressSubmissionService; -import org.dspace.content.service.IndexableObjectService; import org.dspace.content.service.InstallItemService; import org.dspace.content.service.ItemService; import org.dspace.content.service.MetadataFieldService; @@ -35,7 +33,6 @@ import org.dspace.content.service.RelationshipTypeService; import org.dspace.content.service.SiteService; import org.dspace.content.service.SupervisedItemService; import org.dspace.content.service.WorkspaceItemService; -import org.dspace.discovery.IndexableObject; import org.dspace.services.factory.DSpaceServicesFactory; import org.dspace.workflow.factory.WorkflowServiceFactory; @@ -47,13 +44,6 @@ import org.dspace.workflow.factory.WorkflowServiceFactory; */ public abstract class ContentServiceFactory { - /** - * Return the list of all the available implementations of the IndexableObjectService interface - * - * @return the list of IndexableObjectService - */ - public abstract List getIndexableObjectServices(); - public abstract List> getDSpaceObjectServices(); public abstract List> @@ -142,18 +132,6 @@ public abstract class ContentServiceFactory { throw new UnsupportedOperationException("Unknown DSpace type: " + type); } - @SuppressWarnings("unchecked") - public , PK extends Serializable> IndexableObjectService - getIndexableObjectService(int type) { - for (int i = 0; i < getIndexableObjectServices().size(); i++) { - IndexableObjectService objectService = getIndexableObjectServices().get(i); - if (objectService.getSupportsIndexableObjectTypeConstant() == type) { - return (IndexableObjectService) objectService; - } - } - throw new UnsupportedOperationException("Unknown Findable Object type: " + type); - } - public DSpaceObjectLegacySupportService getDSpaceLegacyObjectService(int type) { for (int i = 0; i < getDSpaceObjectLegacySupportServices().size(); i++) { DSpaceObjectLegacySupportService objectLegacySupportService = diff --git a/dspace-api/src/main/java/org/dspace/content/factory/ContentServiceFactoryImpl.java b/dspace-api/src/main/java/org/dspace/content/factory/ContentServiceFactoryImpl.java index db2a192bda..6f123ae1ba 100644 --- a/dspace-api/src/main/java/org/dspace/content/factory/ContentServiceFactoryImpl.java +++ b/dspace-api/src/main/java/org/dspace/content/factory/ContentServiceFactoryImpl.java @@ -20,7 +20,6 @@ import org.dspace.content.service.DSpaceObjectLegacySupportService; import org.dspace.content.service.DSpaceObjectService; import org.dspace.content.service.EntityService; import org.dspace.content.service.EntityTypeService; -import org.dspace.content.service.IndexableObjectService; import org.dspace.content.service.InstallItemService; import org.dspace.content.service.ItemService; import org.dspace.content.service.MetadataFieldService; @@ -31,7 +30,6 @@ import org.dspace.content.service.RelationshipTypeService; import org.dspace.content.service.SiteService; import org.dspace.content.service.SupervisedItemService; import org.dspace.content.service.WorkspaceItemService; -import org.dspace.utils.DSpace; import org.springframework.beans.factory.annotation.Autowired; /** @@ -85,11 +83,6 @@ public class ContentServiceFactoryImpl extends ContentServiceFactory { @Autowired(required = true) private EntityService entityService; - @Override - public List getIndexableObjectServices() { - return new DSpace().getServiceManager().getServicesByType(IndexableObjectService.class); - } - @Override public List> getDSpaceObjectServices() { return dSpaceObjectServices; diff --git a/dspace-api/src/main/java/org/dspace/content/service/BitstreamService.java b/dspace-api/src/main/java/org/dspace/content/service/BitstreamService.java index 87f380cbca..4250041b5d 100644 --- a/dspace-api/src/main/java/org/dspace/content/service/BitstreamService.java +++ b/dspace-api/src/main/java/org/dspace/content/service/BitstreamService.java @@ -14,6 +14,8 @@ import java.util.Iterator; import java.util.List; import java.util.UUID; +import javax.annotation.Nullable; + import org.dspace.authorize.AuthorizeException; import org.dspace.content.Bitstream; import org.dspace.content.BitstreamFormat; @@ -222,5 +224,13 @@ public interface BitstreamService extends DSpaceObjectService, DSpace List getNotReferencedBitstreams(Context context) throws SQLException; - public Long getLastModified(Bitstream bitstream); + /** + * Gets the last modified timestamp of the the given bitstream's content, if known. + * + * @param bitstream the bitstream. + * @return the timestamp in milliseconds, or {@code null} if unknown. + * @throws IOException if an unexpected io error occurs. + */ + @Nullable + Long getLastModified(Bitstream bitstream) throws IOException; } diff --git a/dspace-api/src/main/java/org/dspace/content/service/CollectionService.java b/dspace-api/src/main/java/org/dspace/content/service/CollectionService.java index 063f217d79..aa8bc94d25 100644 --- a/dspace-api/src/main/java/org/dspace/content/service/CollectionService.java +++ b/dspace-api/src/main/java/org/dspace/content/service/CollectionService.java @@ -13,7 +13,6 @@ import java.sql.SQLException; import java.util.List; import java.util.Map; import java.util.MissingResourceException; -import java.util.UUID; import org.dspace.authorize.AuthorizeException; import org.dspace.content.Bitstream; @@ -31,8 +30,7 @@ import org.dspace.eperson.Group; * @author kevinvandevelde at atmire.com */ public interface CollectionService - extends DSpaceObjectService, DSpaceObjectLegacySupportService, - IndexableObjectService { + extends DSpaceObjectService, DSpaceObjectLegacySupportService { /** * Create a new collection with a new ID. diff --git a/dspace-api/src/main/java/org/dspace/content/service/CommunityService.java b/dspace-api/src/main/java/org/dspace/content/service/CommunityService.java index 3e9b372930..6284b27e25 100644 --- a/dspace-api/src/main/java/org/dspace/content/service/CommunityService.java +++ b/dspace-api/src/main/java/org/dspace/content/service/CommunityService.java @@ -12,7 +12,6 @@ import java.io.InputStream; import java.sql.SQLException; import java.util.List; import java.util.MissingResourceException; -import java.util.UUID; import org.dspace.authorize.AuthorizeException; import org.dspace.content.Bitstream; @@ -28,8 +27,7 @@ import org.dspace.eperson.Group; * * @author kevinvandevelde at atmire.com */ -public interface CommunityService extends DSpaceObjectService, DSpaceObjectLegacySupportService, - IndexableObjectService { +public interface CommunityService extends DSpaceObjectService, DSpaceObjectLegacySupportService { /** diff --git a/dspace-api/src/main/java/org/dspace/content/service/InProgressSubmissionService.java b/dspace-api/src/main/java/org/dspace/content/service/InProgressSubmissionService.java index 627e27bad6..aa81b16fba 100644 --- a/dspace-api/src/main/java/org/dspace/content/service/InProgressSubmissionService.java +++ b/dspace-api/src/main/java/org/dspace/content/service/InProgressSubmissionService.java @@ -7,7 +7,6 @@ */ package org.dspace.content.service; -import java.io.Serializable; import java.sql.SQLException; import org.dspace.app.util.DCInputsReaderException; @@ -25,8 +24,7 @@ import org.dspace.core.Context; * @param class type * @author kevinvandevelde at atmire.com */ -public interface InProgressSubmissionService, ID extends Serializable> - extends IndexableObjectService { +public interface InProgressSubmissionService { /** * Deletes submission wrapper, doesn't delete item contents diff --git a/dspace-api/src/main/java/org/dspace/content/service/IndexableObjectService.java b/dspace-api/src/main/java/org/dspace/content/service/IndexableObjectService.java deleted file mode 100644 index 929f244206..0000000000 --- a/dspace-api/src/main/java/org/dspace/content/service/IndexableObjectService.java +++ /dev/null @@ -1,44 +0,0 @@ -/** - * The contents of this file are subject to the license and copyright - * detailed in the LICENSE and NOTICE files at the root of the source - * tree and available online at - * - * http://www.dspace.org/license/ - */ -package org.dspace.content.service; - -import java.io.Serializable; -import java.sql.SQLException; - -import org.dspace.core.Context; -import org.dspace.discovery.IndexableObject; - -/** - * Base Service interface class for any IndexableObject. The name of the methods contains IndexableObject to avoid - * ambiguity reference as some implementation supports both this interface than the DSpaceObectService interface - * - * @param - * class type of the indexable object - * @param - * class type of the primary key - * @author Andrea Bollini (andrea.bollini at 4science.it) - */ -public interface IndexableObjectService, PK extends Serializable> { - - /** - * Generic find for when the precise type of an IndexableObject is not known - * - * @param context - the context - * @param id - id within table of type'd indexable objects - * @return the indexable object found, or null if it does not exist. - * @throws SQLException only upon failure accessing the database. - */ - public T findIndexableObject(Context context, PK id) throws SQLException; - - /** - * Returns the Constants which this service supports - * - * @return a org.dspace.core.Constants that represents a IndexableObject type - */ - public int getSupportsIndexableObjectTypeConstant(); -} diff --git a/dspace-api/src/main/java/org/dspace/content/service/ItemService.java b/dspace-api/src/main/java/org/dspace/content/service/ItemService.java index 8f651b0e59..71b736f1bd 100644 --- a/dspace-api/src/main/java/org/dspace/content/service/ItemService.java +++ b/dspace-api/src/main/java/org/dspace/content/service/ItemService.java @@ -38,7 +38,7 @@ import org.dspace.eperson.Group; * @author kevinvandevelde at atmire.com */ public interface ItemService - extends DSpaceObjectService, DSpaceObjectLegacySupportService, IndexableObjectService { + extends DSpaceObjectService, DSpaceObjectLegacySupportService { public Thumbnail getThumbnail(Context context, Item item, boolean requireOriginal) throws SQLException; diff --git a/dspace-api/src/main/java/org/dspace/content/service/RelationshipTypeService.java b/dspace-api/src/main/java/org/dspace/content/service/RelationshipTypeService.java index 7030ce94f0..6eee264848 100644 --- a/dspace-api/src/main/java/org/dspace/content/service/RelationshipTypeService.java +++ b/dspace-api/src/main/java/org/dspace/content/service/RelationshipTypeService.java @@ -135,6 +135,7 @@ public interface RelationshipTypeService extends DSpaceCRUDService findByEntityType(Context context, EntityType entityType, boolean isLeft, Integer limit, Integer offset) throws SQLException; + /** * This method will support the creation of a RelationshipType object with the given parameters * @param context The relevant DSpace context @@ -155,4 +156,24 @@ public interface RelationshipTypeService extends DSpaceCRUDService { +public interface WorkspaceItemService extends InProgressSubmissionService { /** * Get a workspace item from the database. The item, collection and diff --git a/dspace-api/src/main/java/org/dspace/core/Constants.java b/dspace-api/src/main/java/org/dspace/core/Constants.java index 9e4a8db840..8feb2434f8 100644 --- a/dspace-api/src/main/java/org/dspace/core/Constants.java +++ b/dspace-api/src/main/java/org/dspace/core/Constants.java @@ -55,31 +55,11 @@ public class Constants { */ public static final int EPERSON = 7; - /** - * Type of workspace item objects - */ - public static final int WORKSPACEITEM = 8; - - /** - * Type of workflow item objects - */ - public static final int WORKFLOWITEM = 9; - - /** - * Type of pool task objects - */ - public static final int POOLTASK = 10; - - /** - * Type of claimed task objects - */ - public static final int CLAIMEDTASK = 11; - /** * lets you look up type names from the type IDs */ public static final String[] typeText = { "BITSTREAM", "BUNDLE", "ITEM", "COLLECTION", "COMMUNITY", "SITE", "GROUP", - "EPERSON", "WORKSPACEITEM", "WORKFLOWITEM", "POOLTASK", "CLAIMEDTASK" }; + "EPERSON"}; /** * Special Bundle and Bitstream Names: diff --git a/dspace-api/src/main/java/org/dspace/discovery/DiscoverQuery.java b/dspace-api/src/main/java/org/dspace/discovery/DiscoverQuery.java index a21c33cdd1..d3efb3c626 100644 --- a/dspace-api/src/main/java/org/dspace/discovery/DiscoverQuery.java +++ b/dspace-api/src/main/java/org/dspace/discovery/DiscoverQuery.java @@ -31,7 +31,7 @@ public class DiscoverQuery { **/ private String query; private List filterQueries; - private int DSpaceObjectFilter = -1; + private String DSpaceObjectFilter = null; private List fieldPresentQueries; private boolean spellCheck; @@ -120,7 +120,7 @@ public class DiscoverQuery { * * @param DSpaceObjectFilter the DSpace object filer */ - public void setDSpaceObjectFilter(int DSpaceObjectFilter) { + public void setDSpaceObjectFilter(String DSpaceObjectFilter) { this.DSpaceObjectFilter = DSpaceObjectFilter; } @@ -130,7 +130,7 @@ public class DiscoverQuery { * * @return the DSpace object filer */ - public int getDSpaceObjectFilter() { + public String getDSpaceObjectFilter() { return DSpaceObjectFilter; } diff --git a/dspace-api/src/main/java/org/dspace/discovery/DiscoverResult.java b/dspace-api/src/main/java/org/dspace/discovery/DiscoverResult.java index a6bfa0b2b5..b2bd0fc5ff 100644 --- a/dspace-api/src/main/java/org/dspace/discovery/DiscoverResult.java +++ b/dspace-api/src/main/java/org/dspace/discovery/DiscoverResult.java @@ -243,7 +243,7 @@ public class DiscoverResult { String dsoString = SearchDocument.getIndexableObjectStringRepresentation(idxObj); List result = searchDocuments.get(dsoString); if (result == null) { - return new ArrayList(); + return new ArrayList<>(); } else { return result; } diff --git a/dspace-api/src/main/java/org/dspace/discovery/IndexClient.java b/dspace-api/src/main/java/org/dspace/discovery/IndexClient.java index c4f88e8edd..2e7b00a617 100644 --- a/dspace-api/src/main/java/org/dspace/discovery/IndexClient.java +++ b/dspace-api/src/main/java/org/dspace/discovery/IndexClient.java @@ -10,6 +10,7 @@ package org.dspace.discovery; import java.io.IOException; import java.sql.SQLException; import java.util.Iterator; +import java.util.Optional; import java.util.UUID; import org.apache.commons.cli.CommandLine; @@ -17,11 +18,16 @@ import org.apache.commons.cli.Options; import org.apache.commons.cli.ParseException; import org.dspace.content.Collection; import org.dspace.content.Community; +import org.dspace.content.DSpaceObject; import org.dspace.content.Item; import org.dspace.content.factory.ContentServiceFactory; import org.dspace.content.service.ItemService; -import org.dspace.core.Constants; import org.dspace.core.Context; +import org.dspace.discovery.indexobject.IndexableCollection; +import org.dspace.discovery.indexobject.IndexableCommunity; +import org.dspace.discovery.indexobject.IndexableItem; +import org.dspace.discovery.indexobject.factory.IndexFactory; +import org.dspace.discovery.indexobject.factory.IndexObjectFactoryFactory; import org.dspace.handle.factory.HandleServiceFactory; import org.dspace.scripts.DSpaceRunnable; import org.springframework.beans.factory.annotation.Autowired; @@ -79,28 +85,42 @@ public class IndexClient extends DSpaceRunnable { } catch (Exception e) { // nothing to do, it should be an handle } - IndexableObject dso = null; + Optional indexableObject = Optional.empty(); if (uuid != null) { - dso = ContentServiceFactory.getInstance().getItemService().find(context, uuid); - if (dso == null) { + final Item item = ContentServiceFactory.getInstance().getItemService().find(context, uuid); + if (item != null) { + indexableObject = Optional.of(new IndexableItem(item)); + } else { // it could be a community - dso = ContentServiceFactory.getInstance().getCommunityService().find(context, uuid); - if (dso == null) { + final Community community = ContentServiceFactory.getInstance(). + getCommunityService().find(context, uuid); + if (community != null) { + indexableObject = Optional.of(new IndexableCommunity(community)); + } else { // it could be a collection - dso = ContentServiceFactory.getInstance().getCollectionService().find(context, uuid); + final Collection collection = ContentServiceFactory.getInstance(). + getCollectionService().find(context, uuid); + if (collection != null) { + indexableObject = Optional.of(new IndexableCollection(collection)); + } } } } else { - dso = (IndexableObject) HandleServiceFactory.getInstance() - .getHandleService().resolveToObject(context, param); + final DSpaceObject dso = HandleServiceFactory.getInstance() + .getHandleService().resolveToObject(context, param); + if (dso != null) { + final IndexFactory indexableObjectService = IndexObjectFactoryFactory.getInstance(). + getIndexFactoryByType(String.valueOf(dso.getType())); + indexableObject = indexableObjectService.findIndexableObject(context, dso.getID().toString()); + } } - if (dso == null) { + if (!indexableObject.isPresent()) { throw new IllegalArgumentException("Cannot resolve " + param + " to a DSpace object"); } handler.logInfo("Indexing " + param + " force " + commandLine.hasOption("f")); final long startTimeMillis = System.currentTimeMillis(); - final long count = indexAll(indexer, ContentServiceFactory.getInstance().getItemService(), context, - dso); + final long count = indexAll(indexer, ContentServiceFactory.getInstance(). + getItemService(), context, indexableObject.get()); final long seconds = (System.currentTimeMillis() - startTimeMillis) / 1000; handler.logInfo("Indexed " + count + " object" + (count > 1 ? "s" : "") + " in " + seconds + " seconds"); } else if (indexClientOptions == IndexClientOptions.UPDATE || @@ -163,11 +183,11 @@ public class IndexClient extends DSpaceRunnable { indexingService.indexContent(context, dso, true, true); count++; - if (dso.getType() == Constants.COMMUNITY) { + if (dso.getIndexedObject() instanceof Community) { final Community community = (Community) dso; final String communityHandle = community.getHandle(); for (final Community subcommunity : community.getSubcommunities()) { - count += indexAll(indexingService, itemService, context, subcommunity); + count += indexAll(indexingService, itemService, context, new IndexableCommunity(subcommunity)); //To prevent memory issues, discard an object from the cache after processing context.uncacheEntity(subcommunity); } @@ -176,13 +196,13 @@ public class IndexClient extends DSpaceRunnable { communityHandle); for (final Collection collection : reloadedCommunity.getCollections()) { count++; - indexingService.indexContent(context, collection, true, true); + indexingService.indexContent(context, new IndexableCollection(collection), true, true); count += indexItems(indexingService, itemService, context, collection); //To prevent memory issues, discard an object from the cache after processing context.uncacheEntity(collection); } - } else if (dso.getType() == Constants.COLLECTION) { - count += indexItems(indexingService, itemService, context, (Collection) dso); + } else if (dso instanceof IndexableCollection) { + count += indexItems(indexingService, itemService, context, (Collection) dso.getIndexedObject()); } return count; @@ -209,7 +229,7 @@ public class IndexClient extends DSpaceRunnable { final Iterator itemIterator = itemService.findByCollection(context, collection); while (itemIterator.hasNext()) { Item item = itemIterator.next(); - indexingService.indexContent(context, item, true, false); + indexingService.indexContent(context, new IndexableItem(item), true, false); count++; //To prevent memory issues, discard an object from the cache after processing context.uncacheEntity(item); diff --git a/dspace-api/src/main/java/org/dspace/discovery/IndexEventConsumer.java b/dspace-api/src/main/java/org/dspace/discovery/IndexEventConsumer.java index 29c857fa9b..cab51a2c5a 100644 --- a/dspace-api/src/main/java/org/dspace/discovery/IndexEventConsumer.java +++ b/dspace-api/src/main/java/org/dspace/discovery/IndexEventConsumer.java @@ -15,6 +15,7 @@ import org.dspace.content.Bundle; import org.dspace.content.DSpaceObject; import org.dspace.core.Constants; import org.dspace.core.Context; +import org.dspace.discovery.indexobject.factory.IndexObjectFactoryFactory; import org.dspace.event.Consumer; import org.dspace.event.Event; import org.dspace.services.factory.DSpaceServicesFactory; @@ -42,6 +43,8 @@ public class IndexEventConsumer implements Consumer { .getServiceByName(IndexingService.class.getName(), IndexingService.class); + IndexObjectFactoryFactory indexObjectServiceFactory = IndexObjectFactoryFactory.getInstance(); + @Override public void initialize() throws Exception { @@ -58,8 +61,8 @@ public class IndexEventConsumer implements Consumer { public void consume(Context ctx, Event event) throws Exception { if (objectsToUpdate == null) { - objectsToUpdate = new HashSet(); - uniqueIdsToDelete = new HashSet(); + objectsToUpdate = new HashSet<>(); + uniqueIdsToDelete = new HashSet<>(); } int st = event.getSubjectType(); @@ -103,11 +106,11 @@ public class IndexEventConsumer implements Consumer { if (subject == null) { log.warn(event.getEventTypeAsString() + " event, could not get object for " + event.getSubjectTypeAsString() + " id=" - + String.valueOf(event.getSubjectID()) + + event.getSubjectID() + ", perhaps it has been deleted."); } else { log.debug("consume() adding event to update queue: " + event.toString()); - objectsToUpdate.add((IndexableObject)subject); + objectsToUpdate.addAll(indexObjectServiceFactory.getIndexableObjects(ctx, subject)); } break; @@ -116,11 +119,11 @@ public class IndexEventConsumer implements Consumer { if (object == null) { log.warn(event.getEventTypeAsString() + " event, could not get object for " + event.getObjectTypeAsString() + " id=" - + String.valueOf(event.getObjectID()) + + event.getObjectID() + ", perhaps it has been deleted."); } else { log.debug("consume() adding event to update queue: " + event.toString()); - objectsToUpdate.add((IndexableObject)object); + objectsToUpdate.addAll(indexObjectServiceFactory.getIndexableObjects(ctx, subject)); } break; @@ -159,14 +162,14 @@ public class IndexEventConsumer implements Consumer { * allow the search indexer to make * decisions on indexing and/or removal */ - iu = ctx.reloadEntity(iu); + iu.setIndexedObject(ctx.reloadEntity(iu.getIndexedObject())); ; String uniqueIndexID = iu.getUniqueIndexID(); if (uniqueIndexID != null && !uniqueIdsToDelete.contains(uniqueIndexID)) { try { indexer.indexContent(ctx, iu, true, true); log.debug("Indexed " - + Constants.typeText[iu.getType()] - + ", id=" + String.valueOf(iu.getID()) + + iu.getTypeText() + + ", id=" + iu.getID() + ", unique_id=" + uniqueIndexID); } catch (Exception e) { log.error("Failed while indexing object: ", e); diff --git a/dspace-api/src/main/java/org/dspace/discovery/IndexableObject.java b/dspace-api/src/main/java/org/dspace/discovery/IndexableObject.java index fe67d9787b..d201ef8d91 100644 --- a/dspace-api/src/main/java/org/dspace/discovery/IndexableObject.java +++ b/dspace-api/src/main/java/org/dspace/discovery/IndexableObject.java @@ -8,6 +8,7 @@ package org.dspace.discovery; import java.io.Serializable; +import java.util.Date; import org.dspace.core.Constants; import org.dspace.core.ReloadableEntity; @@ -20,13 +21,31 @@ import org.dspace.core.ReloadableEntity; * @param * the Class of the primary key */ -public interface IndexableObject extends ReloadableEntity { +public interface IndexableObject { /** * - * @return the integer constant representing the Entity Type, @see {@link Constants} + * @return the string constant representing the Entity Type, @see {@link Constants} */ - public int getType(); + String getType(); + + /** + * Return the identifier of this indexableObject, this will be the identifier of the object in the database + * @return for a DSpaceObject a uuid will be returned, for a tasks or workflow items an integer will be returned + */ + PK getID(); + + /** + * Get the entity that is linked to this indexable object + * @return a database entity + */ + T getIndexedObject(); + + /** + * Set the entity that is linked to this indexable object + * @param object the database entity + */ + void setIndexedObject(T object); /** * @@ -37,11 +56,16 @@ public interface IndexableObject extends ReloadableEnti } /** - * + * * @return a textual alias of the Entity Type @see {@link #getType()} */ - default public String getTypeText() { - return Constants.typeText[getType()]; - }; + String getTypeText(); + /** + * Return the last modified date of an of an object, or if no modification dates are stored, return NUll + * @return the last modified date + */ + default Date getLastModified() { + return null; + } } diff --git a/dspace-api/src/main/java/org/dspace/discovery/IndexingService.java b/dspace-api/src/main/java/org/dspace/discovery/IndexingService.java index 253008105b..46795d759e 100644 --- a/dspace-api/src/main/java/org/dspace/discovery/IndexingService.java +++ b/dspace-api/src/main/java/org/dspace/discovery/IndexingService.java @@ -51,14 +51,11 @@ public interface IndexingService { void updateIndex(Context context, boolean force); - void updateIndex(Context context, boolean force, int type); + void updateIndex(Context context, boolean force, String type); void cleanIndex(boolean force) throws IOException, SQLException, SearchServiceException; - void cleanIndex(boolean force, int type) throws IOException, - SQLException, SearchServiceException; - void commit() throws SearchServiceException; void optimize() throws SearchServiceException; diff --git a/dspace-api/src/main/java/org/dspace/discovery/SearchService.java b/dspace-api/src/main/java/org/dspace/discovery/SearchService.java index 596e784bf7..31b114fb33 100644 --- a/dspace-api/src/main/java/org/dspace/discovery/SearchService.java +++ b/dspace-api/src/main/java/org/dspace/discovery/SearchService.java @@ -51,29 +51,6 @@ public interface SearchService { DiscoverResult search(Context context, IndexableObject dso, DiscoverQuery query) throws SearchServiceException; - /** - * @param context DSpace Context object. - * @param query the discovery query object. - * @param includeWithdrawn use true to include in the results also withdrawn - * items that match the query. - * @return discovery search result object - * @throws SearchServiceException if search error - */ - DiscoverResult search(Context context, DiscoverQuery query, - boolean includeWithdrawn) throws SearchServiceException; - - /** - * @param context DSpace Context object - * @param dso a DSpace Object to use as scope of the search (only results - * within this object) - * @param query the discovery query object - * @param includeWithdrawn use true to include in the results also withdrawn - * items that match the query - * @return discovery search result object - * @throws SearchServiceException if search error - */ - DiscoverResult search(Context context, IndexableObject dso, DiscoverQuery query, boolean includeWithdrawn) - throws SearchServiceException; List search(Context context, String query, String orderfield, boolean ascending, int offset, int max, String... filterquery); diff --git a/dspace-api/src/main/java/org/dspace/discovery/SearchUtils.java b/dspace-api/src/main/java/org/dspace/discovery/SearchUtils.java index ce3567e916..90afb09eca 100644 --- a/dspace-api/src/main/java/org/dspace/discovery/SearchUtils.java +++ b/dspace-api/src/main/java/org/dspace/discovery/SearchUtils.java @@ -32,6 +32,15 @@ import org.dspace.workflow.WorkflowItem; * @author Ben Bosman (ben at atmire dot com) */ public class SearchUtils { + + public static final String AUTHORITY_SEPARATOR = "###"; + public static final String LAST_INDEXED_FIELD = "SolrIndexer.lastIndexed"; + public static final String RESOURCE_UNIQUE_ID = "search.uniqueid"; + public static final String RESOURCE_TYPE_FIELD = "search.resourcetype"; + public static final String RESOURCE_ID_FIELD = "search.resourceid"; + public static final String NAMED_RESOURCE_TYPE = "namedresourcetype"; + public static final String FILTER_SEPARATOR = "\n|||\n"; + /** * Cached search service **/ @@ -161,5 +170,4 @@ public class SearchUtils { DiscoveryConfiguration configurationExtra = getDiscoveryConfigurationByName(confName); result.add(configurationExtra); } - } diff --git a/dspace-api/src/main/java/org/dspace/discovery/SolrSearchCore.java b/dspace-api/src/main/java/org/dspace/discovery/SolrSearchCore.java new file mode 100644 index 0000000000..f61287ac87 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/SolrSearchCore.java @@ -0,0 +1,87 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery; + +import java.io.IOException; + +import org.apache.commons.validator.routines.UrlValidator; +import org.apache.log4j.Logger; +import org.apache.solr.client.solrj.SolrClient; +import org.apache.solr.client.solrj.SolrQuery; +import org.apache.solr.client.solrj.SolrRequest; +import org.apache.solr.client.solrj.SolrServerException; +import org.apache.solr.client.solrj.impl.HttpSolrClient; +import org.dspace.discovery.indexobject.IndexableItem; +import org.dspace.services.ConfigurationService; +import org.dspace.services.factory.DSpaceServicesFactory; +import org.dspace.storage.rdbms.DatabaseUtils; +import org.springframework.beans.factory.annotation.Autowired; + +/** + * Bean containing the SolrClient for the search core + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public class SolrSearchCore { + + private final Logger log = Logger.getLogger(SolrSearchCore.class); + @Autowired + protected IndexingService indexingService; + @Autowired + protected ConfigurationService configurationService; + + /** + * SolrServer for processing indexing events. + */ + protected SolrClient solr = null; + + public SolrClient getSolr() { + if (solr == null) { + initSolr(); + } + return solr; + } + + /** + * Initialize the solr search core + */ + protected void initSolr() { + if (solr == null) { + String solrService = DSpaceServicesFactory.getInstance().getConfigurationService() + .getProperty("discovery.search.server"); + + UrlValidator urlValidator = new UrlValidator(UrlValidator.ALLOW_LOCAL_URLS); + if (urlValidator.isValid(solrService) || configurationService + .getBooleanProperty("discovery.solr.url.validation.enabled", true)) { + try { + log.debug("Solr URL: " + solrService); + HttpSolrClient solrServer = new HttpSolrClient.Builder(solrService).build(); + + solrServer.setBaseURL(solrService); + solrServer.setUseMultiPartPost(true); + // Dummy/test query to search for Item (type=2) of ID=1 + SolrQuery solrQuery = new SolrQuery() + .setQuery(SearchUtils.RESOURCE_TYPE_FIELD + ":" + IndexableItem.TYPE + + " AND " + SearchUtils.RESOURCE_ID_FIELD + ":1"); + // Only return obj identifier fields in result doc + solrQuery.setFields(SearchUtils.RESOURCE_TYPE_FIELD, SearchUtils.RESOURCE_ID_FIELD); + solrServer.query(solrQuery, SolrRequest.METHOD.POST); + + // As long as Solr initialized, check with DatabaseUtils to see + // if a reindex is in order. If so, reindex everything + DatabaseUtils.checkReindexDiscovery(indexingService); + + solr = solrServer; + } catch (SolrServerException | IOException e) { + log.error("Error while initializing solr server", e); + } + } else { + log.error("Error while initializing solr, invalid url: " + solrService); + } + } + } +} diff --git a/dspace-api/src/main/java/org/dspace/discovery/SolrServiceContentInOriginalBundleFilterPlugin.java b/dspace-api/src/main/java/org/dspace/discovery/SolrServiceContentInOriginalBundleFilterPlugin.java index d389b53538..3d94350f1c 100644 --- a/dspace-api/src/main/java/org/dspace/discovery/SolrServiceContentInOriginalBundleFilterPlugin.java +++ b/dspace-api/src/main/java/org/dspace/discovery/SolrServiceContentInOriginalBundleFilterPlugin.java @@ -14,6 +14,7 @@ import org.dspace.content.Bitstream; import org.dspace.content.Bundle; import org.dspace.content.Item; import org.dspace.core.Context; +import org.dspace.discovery.indexobject.IndexableItem; /** * This plugin adds three fields to the solr index to make a facet with/without @@ -29,9 +30,9 @@ import org.dspace.core.Context; public class SolrServiceContentInOriginalBundleFilterPlugin implements SolrServiceIndexPlugin { @Override - public void additionalIndex(Context context, IndexableObject dso, SolrInputDocument document) { - if (dso instanceof Item) { - Item item = (Item) dso; + public void additionalIndex(Context context, IndexableObject indexableObject, SolrInputDocument document) { + if (indexableObject instanceof IndexableItem) { + Item item = ((IndexableItem) indexableObject).getIndexedObject(); boolean hasOriginalBundleWithContent = hasOriginalBundleWithContent(item); // _keyword and _filter because diff --git a/dspace-api/src/main/java/org/dspace/discovery/SolrServiceFileInfoPlugin.java b/dspace-api/src/main/java/org/dspace/discovery/SolrServiceFileInfoPlugin.java index e14aa1dbc3..3f5e765b0e 100644 --- a/dspace-api/src/main/java/org/dspace/discovery/SolrServiceFileInfoPlugin.java +++ b/dspace-api/src/main/java/org/dspace/discovery/SolrServiceFileInfoPlugin.java @@ -14,6 +14,7 @@ import org.dspace.content.Bitstream; import org.dspace.content.Bundle; import org.dspace.content.Item; import org.dspace.core.Context; +import org.dspace.discovery.indexobject.IndexableItem; /** *

@@ -40,9 +41,9 @@ public class SolrServiceFileInfoPlugin implements SolrServiceIndexPlugin { private static final String SOLR_FIELD_NAME_FOR_DESCRIPTIONS = "original_bundle_descriptions"; @Override - public void additionalIndex(Context context, IndexableObject dso, SolrInputDocument document) { - if (dso instanceof Item) { - Item item = (Item) dso; + public void additionalIndex(Context context, IndexableObject indexableObject, SolrInputDocument document) { + if (indexableObject instanceof IndexableItem) { + Item item = ((IndexableItem) indexableObject).getIndexedObject(); List bundles = item.getBundles(); if (bundles != null) { for (Bundle bundle : bundles) { diff --git a/dspace-api/src/main/java/org/dspace/discovery/SolrServiceImpl.java b/dspace-api/src/main/java/org/dspace/discovery/SolrServiceImpl.java index 00865f919c..6af1564830 100644 --- a/dspace-api/src/main/java/org/dspace/discovery/SolrServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/discovery/SolrServiceImpl.java @@ -7,11 +7,8 @@ */ package org.dspace.discovery; -import static org.dspace.discovery.configuration.DiscoverySortConfiguration.SCORE; - import java.io.IOException; import java.io.PrintWriter; -import java.io.Serializable; import java.io.StringWriter; import java.sql.SQLException; import java.text.ParseException; @@ -19,36 +16,26 @@ import java.text.SimpleDateFormat; import java.util.ArrayList; import java.util.Calendar; import java.util.Collections; -import java.util.Comparator; import java.util.Date; import java.util.HashMap; -import java.util.HashSet; import java.util.Iterator; import java.util.LinkedHashMap; -import java.util.LinkedList; import java.util.List; import java.util.Locale; import java.util.Map; +import java.util.Optional; import java.util.Set; import java.util.TimeZone; import java.util.UUID; -import java.util.Vector; import org.apache.commons.collections4.CollectionUtils; import org.apache.commons.collections4.MapUtils; import org.apache.commons.collections4.Transformer; -import org.apache.commons.lang3.ArrayUtils; import org.apache.commons.lang3.StringUtils; -import org.apache.commons.lang3.time.DateFormatUtils; -import org.apache.commons.validator.routines.UrlValidator; import org.apache.logging.log4j.Logger; -import org.apache.solr.client.solrj.SolrClient; import org.apache.solr.client.solrj.SolrQuery; import org.apache.solr.client.solrj.SolrRequest; import org.apache.solr.client.solrj.SolrServerException; -import org.apache.solr.client.solrj.impl.HttpSolrClient; -import org.apache.solr.client.solrj.request.AbstractUpdateRequest; -import org.apache.solr.client.solrj.request.ContentStreamUpdateRequest; import org.apache.solr.client.solrj.response.FacetField; import org.apache.solr.client.solrj.response.QueryResponse; import org.apache.solr.client.solrj.util.ClientUtils; @@ -57,64 +44,36 @@ import org.apache.solr.common.SolrDocumentList; import org.apache.solr.common.SolrInputDocument; import org.apache.solr.common.params.FacetParams; import org.apache.solr.common.params.HighlightParams; -import org.apache.solr.common.params.ModifiableSolrParams; import org.apache.solr.common.params.MoreLikeThisParams; import org.apache.solr.common.params.SpellingParams; import org.apache.solr.common.util.NamedList; -import org.apache.solr.handler.extraction.ExtractingParams; import org.dspace.authorize.ResourcePolicy; import org.dspace.authorize.factory.AuthorizeServiceFactory; import org.dspace.content.Collection; import org.dspace.content.Community; import org.dspace.content.DSpaceObject; import org.dspace.content.Item; -import org.dspace.content.MetadataField; -import org.dspace.content.MetadataSchema; -import org.dspace.content.MetadataValue; -import org.dspace.content.WorkspaceItem; -import org.dspace.content.authority.Choices; -import org.dspace.content.authority.service.ChoiceAuthorityService; -import org.dspace.content.authority.service.MetadataAuthorityService; import org.dspace.content.factory.ContentServiceFactory; -import org.dspace.content.service.CollectionService; -import org.dspace.content.service.CommunityService; -import org.dspace.content.service.ItemService; -import org.dspace.content.service.WorkspaceItemService; import org.dspace.core.ConfigurationManager; import org.dspace.core.Constants; import org.dspace.core.Context; import org.dspace.core.Email; import org.dspace.core.I18nUtil; import org.dspace.core.LogManager; -import org.dspace.discovery.configuration.DiscoveryConfiguration; import org.dspace.discovery.configuration.DiscoveryConfigurationParameters; -import org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration; -import org.dspace.discovery.configuration.DiscoveryHitHighlightingConfiguration; import org.dspace.discovery.configuration.DiscoveryMoreLikeThisConfiguration; -import org.dspace.discovery.configuration.DiscoveryRecentSubmissionsConfiguration; -import org.dspace.discovery.configuration.DiscoverySearchFilter; import org.dspace.discovery.configuration.DiscoverySearchFilterFacet; import org.dspace.discovery.configuration.DiscoverySortConfiguration; -import org.dspace.discovery.configuration.DiscoverySortFieldConfiguration; -import org.dspace.discovery.configuration.HierarchicalSidebarFacetConfiguration; +import org.dspace.discovery.indexobject.IndexableCollection; +import org.dspace.discovery.indexobject.IndexableCommunity; +import org.dspace.discovery.indexobject.IndexableItem; +import org.dspace.discovery.indexobject.factory.IndexFactory; +import org.dspace.discovery.indexobject.factory.IndexObjectFactoryFactory; import org.dspace.eperson.EPerson; import org.dspace.eperson.Group; import org.dspace.eperson.factory.EPersonServiceFactory; import org.dspace.eperson.service.GroupService; -import org.dspace.handle.service.HandleService; import org.dspace.services.factory.DSpaceServicesFactory; -import org.dspace.storage.rdbms.DatabaseUtils; -import org.dspace.util.MultiFormatDateParser; -import org.dspace.util.SolrUtils; -import org.dspace.workflow.WorkflowItem; -import org.dspace.xmlworkflow.WorkflowConfigurationException; -import org.dspace.xmlworkflow.factory.XmlWorkflowFactory; -import org.dspace.xmlworkflow.storedcomponents.ClaimedTask; -import org.dspace.xmlworkflow.storedcomponents.PoolTask; -import org.dspace.xmlworkflow.storedcomponents.XmlWorkflowItem; -import org.dspace.xmlworkflow.storedcomponents.service.ClaimedTaskService; -import org.dspace.xmlworkflow.storedcomponents.service.PoolTaskService; -import org.dspace.xmlworkflow.storedcomponents.service.XmlWorkflowItemService; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; @@ -153,94 +112,20 @@ public class SolrServiceImpl implements SearchService, IndexingService { private static final Logger log = org.apache.logging.log4j.LogManager.getLogger(SolrServiceImpl.class); - protected static final String LAST_INDEXED_FIELD = "SolrIndexer.lastIndexed"; - protected static final String HANDLE_FIELD = "handle"; - protected static final String RESOURCE_UNIQUE_ID = "search.uniqueid"; - protected static final String RESOURCE_TYPE_FIELD = "search.resourcetype"; - protected static final String RESOURCE_ID_FIELD = "search.resourceid"; - protected static final String NAMED_RESOURCE_TYPE = "namedresourcetype"; - - public static final String FILTER_SEPARATOR = "\n|||\n"; - - public static final String AUTHORITY_SEPARATOR = "###"; - - public static final String STORE_SEPARATOR = "\n|||\n"; - - public static final String VARIANTS_STORE_SEPARATOR = "###"; - - @Autowired(required = true) + @Autowired protected ContentServiceFactory contentServiceFactory; - @Autowired(required = true) - protected ChoiceAuthorityService choiceAuthorityService; - @Autowired(required = true) - protected CommunityService communityService; - @Autowired(required = true) - protected CollectionService collectionService; - @Autowired(required = true) - protected ItemService itemService; - @Autowired(required = true) - protected HandleService handleService; - @Autowired(required = true) - protected MetadataAuthorityService metadataAuthorityService; - @Autowired(required = true) - protected WorkspaceItemService workspaceItemService; - @Autowired(required = true) - protected XmlWorkflowItemService workflowItemService; - @Autowired(required = true) - protected ClaimedTaskService claimedTaskService; - @Autowired(required = true) - protected PoolTaskService poolTaskService; - @Autowired(required = true) - protected XmlWorkflowFactory workflowFactory; - @Autowired(required = true) + @Autowired protected GroupService groupService; - - /** - * Non-Static SolrServer for processing indexing events. - */ - protected SolrClient solr = null; - + @Autowired + protected IndexObjectFactoryFactory indexObjectServiceFactory; + @Autowired + protected SolrSearchCore solrSearchCore; protected SolrServiceImpl() { } - protected SolrClient getSolr() { - if (solr == null) { - String solrService = DSpaceServicesFactory.getInstance().getConfigurationService() - .getProperty("discovery.search.server"); - UrlValidator urlValidator = new UrlValidator(UrlValidator.ALLOW_LOCAL_URLS); - if (urlValidator.isValid(solrService) || ConfigurationManager - .getBooleanProperty("discovery", "solr.url.validation.enabled", true)) { - try { - log.debug("Solr URL: " + solrService); - HttpSolrClient solrServer = new HttpSolrClient.Builder(solrService).build(); - - solrServer.setBaseURL(solrService); - solrServer.setUseMultiPartPost(true); - // Dummy/test query to search for Item (type=2) of ID=1 - SolrQuery solrQuery = new SolrQuery() - .setQuery(RESOURCE_TYPE_FIELD + ":2 AND " + RESOURCE_ID_FIELD + ":1"); - // Only return obj identifier fields in result doc - solrQuery.setFields(RESOURCE_TYPE_FIELD, RESOURCE_ID_FIELD); - solrServer.query(solrQuery, SolrRequest.METHOD.POST); - - // As long as Solr initialized, check with DatabaseUtils to see - // if a reindex is in order. If so, reindex everything - DatabaseUtils.checkReindexDiscovery(this); - - solr = solrServer; - } catch (SolrServerException | IOException e) { - log.error("Error while initializing solr server", e); - } - } else { - log.error("Error while initializing solr, invalid url: " + solrService); - } - } - - return solr; - } /** * If the handle for the "dso" already exists in the index, and the "dso" @@ -263,62 +148,32 @@ public class SolrServiceImpl implements SearchService, IndexingService { * then it is updated, otherwise a new document is added. * * @param context Users Context - * @param dso DSpace Object (Item, Collection or Community + * @param indexableObject The object we want to index * @param force Force update even if not stale. * @throws SQLException if error */ @Override - public void indexContent(Context context, IndexableObject dso, - boolean force) throws SQLException { + public void indexContent(Context context, IndexableObject indexableObject, + boolean force) { try { - String uuid = dso.getID().toString(); - switch (dso.getType()) { - case Constants.ITEM: - Item item = (Item) dso; - if (item.isArchived() || item.isWithdrawn()) { - /** - * If the item is in the repository now, add it to the index - */ - if (force || requiresIndexing(dso.getUniqueIndexID(), ((Item) dso).getLastModified())) { - unIndexContent(context, dso); - buildDocument(context, (Item) dso); - } - } else { - /** - * Make sure the item is not in the index if it is not in - * archive or withdrawn. - */ - unIndexContent(context, dso); - log.info("Removed Item: " + uuid + " from Index"); - - /** - * reindex any in progress submission tasks associated with the item - */ - indexInProgressSubmissionItem(context, (Item) dso); - } - break; - - case Constants.COLLECTION: - buildDocument(context, (Collection) dso); - log.info("Wrote Collection: " + uuid + " to Index"); - break; - - case Constants.COMMUNITY: - buildDocument(context, (Community) dso); - log.info("Wrote Community: " + uuid + " to Index"); - break; - - default: - log - .error("Only Items, Collections and Communities can be Indexed"); + final IndexFactory indexableObjectFactory = indexObjectServiceFactory. + getIndexableObjectFactory(indexableObject); + if (force || requiresIndexing(indexableObject.getUniqueIndexID(), indexableObject.getLastModified())) { + update(context, indexableObjectFactory, indexableObject); + log.info(LogManager.getHeader(context, "indexed_object", indexableObject.getUniqueIndexID())); } - } catch (Exception e) { log.error(e.getMessage(), e); } } + protected void update(Context context, IndexFactory indexableObjectService, + IndexableObject indexableObject) throws IOException, SQLException, SolrServerException { + final SolrInputDocument solrInputDocument = indexableObjectService.buildDocument(context, indexableObject); + indexableObjectService.writeDocument(context, indexableObject, solrInputDocument); + } + /** * unIndex removes an Item, Collection, or Community * @@ -337,26 +192,23 @@ public class SolrServiceImpl implements SearchService, IndexingService { * unIndex removes an Item, Collection, or Community * * @param context The relevant DSpace Context. - * @param dso extension of DSpace Object, can be Community, Item, Collection or InProgressSubmission + * @param indexableObject The object to be indexed * @param commit if true force an immediate commit on SOLR * @throws SQLException if database error * @throws IOException if IO error */ @Override - public void unIndexContent(Context context, IndexableObject dso, boolean commit) + public void unIndexContent(Context context, IndexableObject indexableObject, boolean commit) throws SQLException, IOException { try { - if (dso == null) { + if (indexableObject == null) { return; } - String uniqueID = dso.getUniqueIndexID(); - log.debug("Try to delete uniqueID:" + uniqueID); - getSolr().deleteById(uniqueID); - if (Constants.ITEM == dso.getType()) { - deleteInProgressSubmissionByItemID(uniqueID); - } + String uniqueID = indexableObject.getUniqueIndexID(); + log.info("Try to delete uniqueID:" + uniqueID); + indexObjectServiceFactory.getIndexableObjectFactory(indexableObject).delete(indexableObject); if (commit) { - getSolr().commit(); + solrSearchCore.getSolr().commit(); } } catch (Exception exception) { log.error(exception.getMessage(), exception); @@ -388,13 +240,10 @@ public class SolrServiceImpl implements SearchService, IndexingService { throws IOException { try { - if (getSolr() != null) { - getSolr().deleteById(searchUniqueID); - if (searchUniqueID.startsWith(Constants.ITEM + "-")) { - deleteInProgressSubmissionByItemID(searchUniqueID); - } + if (solrSearchCore.getSolr() != null) { + indexObjectServiceFactory.getIndexableObjectFactory(searchUniqueID).delete(searchUniqueID); if (commit) { - getSolr().commit(); + solrSearchCore.getSolr().commit(); } } } catch (SolrServerException e) { @@ -460,53 +309,26 @@ public class SolrServiceImpl implements SearchService, IndexingService { */ @Override public void updateIndex(Context context, boolean force) { - updateIndex(context, force, Constants.ITEM); - updateIndex(context, force, Constants.COLLECTION); - updateIndex(context, force, Constants.COMMUNITY); + updateIndex(context, force, null); } - @Override - public void updateIndex(Context context, boolean force, int type) { + public void updateIndex(Context context, boolean force, String type) { try { - switch (type) { - case Constants.ITEM: - Iterator items = itemService.findAllUnfiltered(context); - while (items.hasNext()) { - Item item = items.next(); - indexContent(context, item, force); - //To prevent memory issues, discard an object from the cache after processing - context.uncacheEntity(item); + final List indexableObjectServices = indexObjectServiceFactory. + getIndexFactories(); + for (IndexFactory indexableObjectService : indexableObjectServices) { + if (type == null || StringUtils.equals(indexableObjectService.getType(), type)) { + final Iterator indexableObjects = indexableObjectService.findAll(context); + while (indexableObjects.hasNext()) { + final IndexableObject indexableObject = indexableObjects.next(); + indexContent(context, indexableObject, force); + context.uncacheEntity(indexableObject.getIndexedObject()); } - for (WorkspaceItem wsi : workspaceItemService.findAll(context)) { - indexContent(context, wsi.getItem(), force); - //To prevent memory issues, discard an object from the cache after processing - context.uncacheEntity(wsi); - } - for (WorkflowItem wfi : workflowItemService.findAll(context)) { - indexContent(context, wfi.getItem(), force); - //To prevent memory issues, discard an object from the cache after processing - context.uncacheEntity(wfi); - } - break; - case Constants.COLLECTION: - List collections = collectionService.findAll(context); - for (Collection collection : collections) { - indexContent(context, collection, force); - } - break; - case Constants.COMMUNITY: - List communities = communityService.findAll(context); - for (Community community : communities) { - indexContent(context, community, force); - } - break; - default: - throw new IllegalArgumentException("No type known: " + type); + } } - - if (getSolr() != null) { - getSolr().commit(); + if (solrSearchCore.getSolr() != null) { + solrSearchCore.getSolr().commit(); } } catch (Exception e) { @@ -525,65 +347,58 @@ public class SolrServiceImpl implements SearchService, IndexingService { */ @Override public void cleanIndex(boolean force) throws IOException, SQLException, SearchServiceException { - if (force) { - try { - getSolr().deleteByQuery( - "search.resourcetype:[" + Constants.ITEM + " TO " + Constants.COMMUNITY + "]" + - " OR " + - "search.resourcetype:[" + Constants.WORKSPACEITEM + " TO " + Constants.CLAIMEDTASK + "]"); - } catch (Exception e) { - throw new SearchServiceException(e.getMessage(), e); - } - } else { - cleanIndex(false, Constants.ITEM); - cleanIndex(false, Constants.COLLECTION); - cleanIndex(false, Constants.COMMUNITY); - cleanIndex(false, Constants.WORKSPACEITEM); - cleanIndex(false, Constants.POOLTASK); - cleanIndex(false, Constants.CLAIMEDTASK); - cleanIndex(false, Constants.WORKFLOWITEM); - } - } - - @Override - public void cleanIndex(boolean force, int type) throws IOException, SQLException, SearchServiceException { Context context = new Context(); context.turnOffAuthorisationSystem(); try { - if (getSolr() == null) { + if (solrSearchCore.getSolr() == null) { return; } if (force) { - getSolr().deleteByQuery(RESOURCE_TYPE_FIELD + ":" + type); + final List indexableObjectServices = indexObjectServiceFactory. + getIndexFactories(); + for (IndexFactory indexableObjectService : indexableObjectServices) { + indexableObjectService.deleteAll(); + } } else { SolrQuery query = new SolrQuery(); // Query for all indexed Items, Collections and Communities, // returning just their handle - query.setFields(HANDLE_FIELD, RESOURCE_UNIQUE_ID, RESOURCE_ID_FIELD, RESOURCE_TYPE_FIELD); - query.setQuery(RESOURCE_TYPE_FIELD + ":" + type); - QueryResponse rsp = getSolr().query(query, SolrRequest.METHOD.POST); - SolrDocumentList docs = rsp.getResults(); + query.setFields(SearchUtils.RESOURCE_UNIQUE_ID); + query.addSort(SearchUtils.RESOURCE_UNIQUE_ID, SolrQuery.ORDER.asc); + query.setQuery("*:*"); - Iterator iter = docs.iterator(); - while (iter.hasNext()) { + // Get the total amount of results + QueryResponse totalResponse = solrSearchCore.getSolr().query(query, SolrRequest.METHOD.POST); + long total = totalResponse.getResults().getNumFound(); - SolrDocument doc = (SolrDocument) iter.next(); + int start = 0; + int batch = 100; - String uniqueID = (String) doc.getFieldValue(RESOURCE_UNIQUE_ID); + query.setRows(batch); + while (start < total) { + query.setStart(start); + QueryResponse rsp = solrSearchCore.getSolr().query(query, SolrRequest.METHOD.POST); + SolrDocumentList docs = rsp.getResults(); - IndexableObject o = findIndexableObject(context, doc); + for (SolrDocument doc : docs) { + String uniqueID = (String) doc.getFieldValue(SearchUtils.RESOURCE_UNIQUE_ID); - if (o == null) { - log.info("Deleting: " + uniqueID); - /* - * Use IndexWriter to delete, its easier to manage - * write.lock - */ - unIndexContent(context, uniqueID); - } else { - log.debug("Keeping: " + o.getUniqueIndexID()); + IndexableObject o = findIndexableObject(context, doc); + + if (o == null) { + log.info("Deleting: " + uniqueID); + /* + * Use IndexWriter to delete, its easier to manage + * write.lock + */ + unIndexContent(context, uniqueID); + } else { + log.debug("Keeping: " + o.getUniqueIndexID()); + } } + + start += batch; } } } catch (Exception e) { @@ -600,12 +415,12 @@ public class SolrServiceImpl implements SearchService, IndexingService { @Override public void optimize() { try { - if (getSolr() == null) { + if (solrSearchCore.getSolr() == null) { return; } long start = System.currentTimeMillis(); System.out.println("SOLR Search Optimize -- Process Started:" + start); - getSolr().optimize(); + solrSearchCore.getSolr().optimize(); long finish = System.currentTimeMillis(); System.out.println("SOLR Search Optimize -- Process Finished:" + finish); System.out.println("SOLR Search Optimize -- Total time taken:" + (finish - start) + " (ms)."); @@ -620,13 +435,13 @@ public class SolrServiceImpl implements SearchService, IndexingService { public void buildSpellCheck() throws SearchServiceException, IOException { try { - if (getSolr() == null) { + if (solrSearchCore.getSolr() == null) { return; } SolrQuery solrQuery = new SolrQuery(); solrQuery.set("spellcheck", true); solrQuery.set(SpellingParams.SPELLCHECK_BUILD, true); - getSolr().query(solrQuery, SolrRequest.METHOD.POST); + solrSearchCore.getSolr().query(solrQuery, SolrRequest.METHOD.POST); } catch (SolrServerException e) { //Make sure to also log the exception since this command is usually run from a crontab. log.error(e, e); @@ -680,30 +495,35 @@ public class SolrServiceImpl implements SearchService, IndexingService { * Is stale checks the lastModified time stamp in the database and the index * to determine if the index is stale. * - * @param handle the handle of the dso + * @param uniqueId the unique identifier of the object that we want to index * @param lastModified the last modified date of the DSpace object * @return a boolean indicating if the dso should be re indexed again * @throws SQLException sql exception * @throws IOException io exception * @throws SearchServiceException if something went wrong with querying the solr server */ - protected boolean requiresIndexing(String handle, Date lastModified) + protected boolean requiresIndexing(String uniqueId, Date lastModified) throws SQLException, IOException, SearchServiceException { + // Check if we even have a last modified date + if (lastModified == null) { + return true; + } + boolean reindexItem = false; boolean inIndex = false; SolrQuery query = new SolrQuery(); - query.setQuery(RESOURCE_UNIQUE_ID + ":" + handle); + query.setQuery(SearchUtils.RESOURCE_UNIQUE_ID + ":" + uniqueId); // Specify that we ONLY want the LAST_INDEXED_FIELD returned in the field list (fl) - query.setFields(LAST_INDEXED_FIELD); + query.setFields(SearchUtils.LAST_INDEXED_FIELD); QueryResponse rsp; try { - if (getSolr() == null) { + if (solrSearchCore.getSolr() == null) { return false; } - rsp = getSolr().query(query, SolrRequest.METHOD.POST); + rsp = solrSearchCore.getSolr().query(query, SolrRequest.METHOD.POST); } catch (SolrServerException e) { throw new SearchServiceException(e.getMessage(), e); } @@ -712,7 +532,7 @@ public class SolrServiceImpl implements SearchService, IndexingService { inIndex = true; - Object value = doc.getFieldValue(LAST_INDEXED_FIELD); + Object value = doc.getFieldValue(SearchUtils.LAST_INDEXED_FIELD); if (value instanceof Date) { Date lastIndexed = (Date) value; @@ -727,63 +547,6 @@ public class SolrServiceImpl implements SearchService, IndexingService { return reindexItem || !inIndex; } - - /** - * @param context DSpace context - * @param myitem the item for which our locations are to be retrieved - * @return a list containing the identifiers of the communities and collections - * @throws SQLException sql exception - */ - protected List getItemLocations(Context context, Item myitem) - throws SQLException { - List locations = new Vector(); - - // build list of community ids - List communities = itemService.getCommunities(context, myitem); - - // build list of collection ids - List collections = myitem.getCollections(); - - // now put those into strings - int i = 0; - - for (i = 0; i < communities.size(); i++) { - locations.add("m" + communities.get(i).getID()); - } - - for (i = 0; i < collections.size(); i++) { - locations.add("l" + collections.get(i).getID()); - } - - return locations; - } - - protected List getCollectionLocations(Context context, Collection target) throws SQLException { - List locations = new Vector(); - // build list of community ids - List communities = communityService.getAllParents(context, target); - - // now put those into strings - for (Community community : communities) { - locations.add("m" + community.getID()); - } - - return locations; - } - - protected List getCommunityLocations(Community target) throws SQLException { - List locations = new Vector(); - // build list of community ids - List communities = target.getParentCommunities(); - - // now put those into strings - for (Community community : communities) { - locations.add("m" + community.getID()); - } - - return locations; - } - @Override public String createLocationQueryForAdministrableItems(Context context) throws SQLException { @@ -850,928 +613,6 @@ public class SolrServiceImpl implements SearchService, IndexingService { return locationQuery.toString(); } - /** - * Write the document to the index under the appropriate handle. - * - * @param doc the solr document to be written to the server - * @param streams list of bitstream content streams - * @throws IOException A general class of exceptions produced by failed or interrupted I/O operations. - */ - protected void writeDocument(SolrInputDocument doc, FullTextContentStreams streams) throws IOException { - - try { - if (getSolr() != null) { - if (streams != null && !streams.isEmpty()) { - ContentStreamUpdateRequest req = new ContentStreamUpdateRequest("/update/extract"); - req.addContentStream(streams); - - ModifiableSolrParams params = new ModifiableSolrParams(); - - //req.setParam(ExtractingParams.EXTRACT_ONLY, "true"); - for (String name : doc.getFieldNames()) { - for (Object val : doc.getFieldValues(name)) { - params.add(ExtractingParams.LITERALS_PREFIX + name, val.toString()); - } - } - - req.setParams(params); - req.setParam(ExtractingParams.UNKNOWN_FIELD_PREFIX, "attr_"); - req.setParam(ExtractingParams.MAP_PREFIX + "content", "fulltext"); - req.setParam(ExtractingParams.EXTRACT_FORMAT, "text"); - req.setAction(AbstractUpdateRequest.ACTION.COMMIT, true, true); - req.process(getSolr()); - } else { - getSolr().add(doc); - } - } - } catch (SolrServerException e) { - log.error(e.getMessage(), e); - } - } - - /** - * Build a solr document for a DSpace Community. - * - * @param context The relevant DSpace Context. - * @param community Community to be indexed - * @throws SQLException if database error - * @throws IOException if IO error - */ - protected void buildDocument(Context context, Community community) - throws SQLException, IOException { - - List locations = getCommunityLocations(community); - - // Create Document - SolrInputDocument doc = buildDocument(Constants.COMMUNITY, community.getID(), - community.getHandle(), locations); - - DiscoveryConfiguration discoveryConfiguration = SearchUtils.getDiscoveryConfiguration(community); - DiscoveryHitHighlightingConfiguration highlightingConfiguration = discoveryConfiguration - .getHitHighlightingConfiguration(); - List highlightedMetadataFields = new ArrayList(); - if (highlightingConfiguration != null) { - for (DiscoveryHitHighlightFieldConfiguration configuration : highlightingConfiguration - .getMetadataFields()) { - highlightedMetadataFields.add(configuration.getField()); - } - } - - // and populate it - String description = communityService.getMetadata(community, "introductory_text"); - String description_abstract = communityService.getMetadata(community, "short_description"); - String description_table = communityService.getMetadata(community, "side_bar_text"); - String rights = communityService.getMetadata(community, "copyright_text"); - String title = communityService.getMetadata(community, "name"); - - List toIgnoreMetadataFields = SearchUtils.getIgnoredMetadataFields(community.getType()); - addContainerMetadataField(doc, highlightedMetadataFields, toIgnoreMetadataFields, "dc.description", - description); - addContainerMetadataField(doc, highlightedMetadataFields, toIgnoreMetadataFields, "dc.description.abstract", - description_abstract); - addContainerMetadataField(doc, highlightedMetadataFields, toIgnoreMetadataFields, - "dc.description.tableofcontents", description_table); - addContainerMetadataField(doc, highlightedMetadataFields, toIgnoreMetadataFields, "dc.rights", rights); - addContainerMetadataField(doc, highlightedMetadataFields, toIgnoreMetadataFields, "dc.title", title); - - //Do any additional indexing, depends on the plugins - List solrServiceIndexPlugins = DSpaceServicesFactory.getInstance().getServiceManager() - .getServicesByType( - SolrServiceIndexPlugin.class); - for (SolrServiceIndexPlugin solrServiceIndexPlugin : solrServiceIndexPlugins) { - solrServiceIndexPlugin.additionalIndex(context, community, doc); - } - - writeDocument(doc, null); - } - - /** - * Build a solr document for a DSpace Collection. - * - * @param context The relevant DSpace Context. - * @param collection Collection to be indexed - * @throws SQLException sql exception - * @throws IOException IO exception - */ - protected void buildDocument(Context context, Collection collection) - throws SQLException, IOException { - List locations = getCollectionLocations(context, collection); - - // Create Lucene Document - SolrInputDocument doc = buildDocument(Constants.COLLECTION, collection.getID(), - collection.getHandle(), locations); - - DiscoveryConfiguration discoveryConfiguration = SearchUtils.getDiscoveryConfiguration(collection); - DiscoveryHitHighlightingConfiguration highlightingConfiguration = discoveryConfiguration - .getHitHighlightingConfiguration(); - List highlightedMetadataFields = new ArrayList(); - if (highlightingConfiguration != null) { - for (DiscoveryHitHighlightFieldConfiguration configuration : highlightingConfiguration - .getMetadataFields()) { - highlightedMetadataFields.add(configuration.getField()); - } - } - - - // and populate it - String description = collectionService.getMetadata(collection, "introductory_text"); - String description_abstract = collectionService.getMetadata(collection, "short_description"); - String description_table = collectionService.getMetadata(collection, "side_bar_text"); - String provenance = collectionService.getMetadata(collection, "provenance_description"); - String rights = collectionService.getMetadata(collection, "copyright_text"); - String rights_license = collectionService.getMetadata(collection, "license"); - String title = collectionService.getMetadata(collection, "name"); - - List toIgnoreMetadataFields = SearchUtils.getIgnoredMetadataFields(collection.getType()); - addContainerMetadataField(doc, highlightedMetadataFields, toIgnoreMetadataFields, "dc.description", - description); - addContainerMetadataField(doc, highlightedMetadataFields, toIgnoreMetadataFields, "dc.description.abstract", - description_abstract); - addContainerMetadataField(doc, highlightedMetadataFields, toIgnoreMetadataFields, - "dc.description.tableofcontents", description_table); - addContainerMetadataField(doc, highlightedMetadataFields, toIgnoreMetadataFields, "dc.provenance", provenance); - addContainerMetadataField(doc, highlightedMetadataFields, toIgnoreMetadataFields, "dc.rights", rights); - addContainerMetadataField(doc, highlightedMetadataFields, toIgnoreMetadataFields, "dc.rights.license", - rights_license); - addContainerMetadataField(doc, highlightedMetadataFields, toIgnoreMetadataFields, "dc.title", title); - - - //Do any additional indexing, depends on the plugins - List solrServiceIndexPlugins = DSpaceServicesFactory.getInstance().getServiceManager() - .getServicesByType( - SolrServiceIndexPlugin.class); - for (SolrServiceIndexPlugin solrServiceIndexPlugin : solrServiceIndexPlugins) { - solrServiceIndexPlugin.additionalIndex(context, collection, doc); - } - - writeDocument(doc, null); - } - - /** - * Add the metadata value of the community/collection to the solr document - * IF needed highlighting is added ! - * - * @param doc the solr document - * @param highlightedMetadataFields the list of metadata fields that CAN be highlighted - * @param toIgnoreMetadataFields the list of metadata fields to skip adding to Solr - * @param metadataField the metadata field added - * @param value the value (can be NULL !) - */ - protected void addContainerMetadataField(SolrInputDocument doc, List highlightedMetadataFields, - List toIgnoreMetadataFields, String metadataField, String value) { - if (toIgnoreMetadataFields == null || !toIgnoreMetadataFields.contains(metadataField)) { - if (StringUtils.isNotBlank(value)) { - doc.addField(metadataField, value); - if (highlightedMetadataFields.contains(metadataField)) { - doc.addField(metadataField + "_hl", value); - } - } - } - } - - /** - * Build a Lucene document for a DSpace Item and write the index - * - * @param context Users Context - * @param item The DSpace Item to be indexed - * @throws SQLException if database error - * @throws IOException if IO error - */ - protected void buildDocument(Context context, Item item) - throws SQLException, IOException { - String handle = item.getHandle(); - - if (handle == null) { - handle = handleService.findHandle(context, item); - } - - // get the location string (for searching by collection & community) - List locations = getItemLocations(context, item); - - SolrInputDocument doc = buildDocument(Constants.ITEM, item.getID(), handle, - locations); - - log.debug("Building Item: " + handle); - - doc.addField("archived", item.isArchived()); - doc.addField("withdrawn", item.isWithdrawn()); - doc.addField("discoverable", item.isDiscoverable()); - doc.addField("lastModified", SolrUtils.getDateFormatter().format(item.getLastModified())); - - EPerson submitter = item.getSubmitter(); - if (submitter != null) { - addFacetIndex(doc, "submitter", submitter.getID().toString(), - submitter.getFullName()); - } - - List discoveryConfigurations = SearchUtils.getAllDiscoveryConfigurations(item); - addDiscoveryFields(doc, context, item, discoveryConfigurations); - - //mandatory facet to show status on mydspace - final String typeText = StringUtils.deleteWhitespace(item.getTypeText().toLowerCase()); - String acvalue = DSpaceServicesFactory.getInstance().getConfigurationService().getProperty( - "discovery.facet.namedtype." + typeText, - typeText + SolrServiceImpl.AUTHORITY_SEPARATOR + typeText); - if (StringUtils.isNotBlank(acvalue)) { - addNamedResourceTypeIndex(doc, acvalue); - } - - // write the index and close the inputstreamreaders - try { - writeDocument(doc, new FullTextContentStreams(context, item)); - log.info("Wrote Item: " + item.getUniqueIndexID() + " to Index"); - } catch (RuntimeException e) { - log.error("Error while writing item to discovery index: " + item.getUniqueIndexID() + " message:" - + e.getMessage(), e); - } - } - - protected void addDiscoveryFields(SolrInputDocument doc, Context context, Item item, - List discoveryConfigurations) - throws SQLException, IOException { - //Keep a list of our sort values which we added, sort values can only be added once - List sortFieldsAdded = new ArrayList(); - Map> searchFilters = null; - Set hitHighlightingFields = new HashSet(); - try { - //A map used to save each sidebarFacet config by the metadata fields - searchFilters = new HashMap>(); - Map sortFields = new HashMap(); - Map recentSubmissionsConfigurationMap = new - HashMap(); - Set moreLikeThisFields = new HashSet(); - // some configuration are returned multiple times, skip them to save CPU cycles - Set appliedConf = new HashSet(); - // it is common to have search filter shared between multiple configurations - Set appliedDiscoverySearchFilter = new HashSet(); - - for (DiscoveryConfiguration discoveryConfiguration : discoveryConfigurations) { - if (appliedConf.contains(discoveryConfiguration.getId())) { - continue; - } else { - appliedConf.add(discoveryConfiguration.getId()); - } - for (int i = 0; i < discoveryConfiguration.getSearchFilters().size(); i++) { - if (appliedDiscoverySearchFilter - .contains(discoveryConfiguration.getSearchFilters().get(i).getIndexFieldName())) { - continue; - } else { - appliedDiscoverySearchFilter - .add(discoveryConfiguration.getSearchFilters().get(i).getIndexFieldName()); - } - List metadataValueList = new LinkedList<>(); - boolean shouldExposeMinMax = false; - DiscoverySearchFilter discoverySearchFilter = discoveryConfiguration.getSearchFilters().get(i); - if (StringUtils.equalsIgnoreCase(discoverySearchFilter.getFilterType(), "facet")) { - if (((DiscoverySearchFilterFacet) discoverySearchFilter).exposeMinAndMaxValue()) { - shouldExposeMinMax = true; - } - } - for (int j = 0; j < discoverySearchFilter.getMetadataFields().size(); j++) { - String metadataField = discoverySearchFilter.getMetadataFields().get(j); - List resultingList; - if (searchFilters.get(metadataField) != null) { - resultingList = searchFilters.get(metadataField); - } else { - //New metadata field, create a new list for it - resultingList = new ArrayList(); - } - - - if (shouldExposeMinMax) { - String[] splittedMetadataField = metadataField.split("\\."); - String schema = splittedMetadataField[0]; - String element = splittedMetadataField.length > 1 ? splittedMetadataField[1] : null; - String qualifier = splittedMetadataField.length > 2 ? splittedMetadataField[2] : null; - - metadataValueList.addAll(itemService.getMetadata(item, schema, - element, qualifier, Item.ANY)); - - } - - resultingList.add(discoverySearchFilter); - - searchFilters.put(metadataField, resultingList); - } - - if (!metadataValueList.isEmpty() && shouldExposeMinMax) { - metadataValueList.sort(new Comparator() { - public int compare(MetadataValue mdv1,MetadataValue mdv2) { - return mdv1.getValue().compareTo(mdv2.getValue()) ; - } - }); - MetadataValue firstMetadataValue = metadataValueList.get(0); - MetadataValue lastMetadataValue = metadataValueList.get(metadataValueList.size() - 1); - - doc.addField(discoverySearchFilter.getIndexFieldName() + "_min", firstMetadataValue.getValue()); - doc.addField(discoverySearchFilter.getIndexFieldName() - + "_min_sort", firstMetadataValue.getValue()); - doc.addField(discoverySearchFilter.getIndexFieldName() + "_max", lastMetadataValue.getValue()); - doc.addField(discoverySearchFilter.getIndexFieldName() - + "_max_sort", lastMetadataValue.getValue()); - - } - } - - DiscoverySortConfiguration sortConfiguration = discoveryConfiguration.getSearchSortConfiguration(); - if (sortConfiguration != null) { - for (DiscoverySortFieldConfiguration discoverySortConfiguration : sortConfiguration - .getSortFields()) { - sortFields.put(discoverySortConfiguration.getMetadataField(), discoverySortConfiguration); - } - } - - DiscoveryRecentSubmissionsConfiguration recentSubmissionConfiguration = discoveryConfiguration - .getRecentSubmissionConfiguration(); - if (recentSubmissionConfiguration != null) { - recentSubmissionsConfigurationMap - .put(recentSubmissionConfiguration.getMetadataSortField(), recentSubmissionConfiguration); - } - - DiscoveryHitHighlightingConfiguration hitHighlightingConfiguration = discoveryConfiguration - .getHitHighlightingConfiguration(); - if (hitHighlightingConfiguration != null) { - List fieldConfigurations = hitHighlightingConfiguration - .getMetadataFields(); - for (DiscoveryHitHighlightFieldConfiguration fieldConfiguration : fieldConfigurations) { - hitHighlightingFields.add(fieldConfiguration.getField()); - } - } - DiscoveryMoreLikeThisConfiguration moreLikeThisConfiguration = discoveryConfiguration - .getMoreLikeThisConfiguration(); - if (moreLikeThisConfiguration != null) { - for (String metadataField : moreLikeThisConfiguration.getSimilarityMetadataFields()) { - moreLikeThisFields.add(metadataField); - } - } - } - - - List toProjectionFields = new ArrayList(); - String[] projectionFields = DSpaceServicesFactory.getInstance().getConfigurationService() - .getArrayProperty("discovery.index.projection"); - if (projectionFields != null) { - for (String field : projectionFields) { - toProjectionFields.add(field.trim()); - } - } - - List toIgnoreMetadataFields = SearchUtils.getIgnoredMetadataFields(item.getType()); - List mydc = itemService.getMetadata(item, Item.ANY, Item.ANY, Item.ANY, Item.ANY); - for (MetadataValue meta : mydc) { - MetadataField metadataField = meta.getMetadataField(); - MetadataSchema metadataSchema = metadataField.getMetadataSchema(); - String field = metadataSchema.getName() + "." + metadataField.getElement(); - String unqualifiedField = field; - - String value = meta.getValue(); - - if (value == null) { - continue; - } - - if (metadataField.getQualifier() != null && !metadataField.getQualifier().trim().equals("")) { - field += "." + metadataField.getQualifier(); - } - - //We are not indexing provenance, this is useless - if (toIgnoreMetadataFields != null && (toIgnoreMetadataFields.contains(field) || toIgnoreMetadataFields - .contains(unqualifiedField + "." + Item.ANY))) { - continue; - } - - String authority = null; - String preferedLabel = null; - List variants = null; - boolean isAuthorityControlled = metadataAuthorityService - .isAuthorityControlled(metadataField); - - int minConfidence = isAuthorityControlled ? metadataAuthorityService - .getMinConfidence(metadataField) : Choices.CF_ACCEPTED; - - if (isAuthorityControlled && meta.getAuthority() != null - && meta.getConfidence() >= minConfidence) { - boolean ignoreAuthority = - DSpaceServicesFactory - .getInstance() - .getConfigurationService() - .getPropertyAsType("discovery.index.authority.ignore." + field, - DSpaceServicesFactory - .getInstance() - .getConfigurationService() - .getPropertyAsType("discovery.index.authority.ignore", - new Boolean(false)), - true); - if (!ignoreAuthority) { - authority = meta.getAuthority(); - - boolean ignorePrefered = - DSpaceServicesFactory - .getInstance() - .getConfigurationService() - .getPropertyAsType("discovery.index.authority.ignore-prefered." + field, - DSpaceServicesFactory - .getInstance() - .getConfigurationService() - .getPropertyAsType("discovery.index.authority.ignore-prefered", - new Boolean(false)), - true); - if (!ignorePrefered) { - - preferedLabel = choiceAuthorityService - .getLabel(meta, meta.getLanguage()); - } - - boolean ignoreVariants = - DSpaceServicesFactory - .getInstance() - .getConfigurationService() - .getPropertyAsType("discovery.index.authority.ignore-variants." + field, - DSpaceServicesFactory - .getInstance() - .getConfigurationService() - .getPropertyAsType("discovery.index.authority.ignore-variants", - new Boolean(false)), - true); - if (!ignoreVariants) { - variants = choiceAuthorityService - .getVariants(meta); - } - - } - } - - if ((searchFilters.get(field) != null || searchFilters - .get(unqualifiedField + "." + Item.ANY) != null)) { - List searchFilterConfigs = searchFilters.get(field); - if (searchFilterConfigs == null) { - searchFilterConfigs = searchFilters.get(unqualifiedField + "." + Item.ANY); - } - - for (DiscoverySearchFilter searchFilter : searchFilterConfigs) { - Date date = null; - String separator = DSpaceServicesFactory.getInstance().getConfigurationService() - .getProperty("discovery.solr.facets.split.char"); - if (separator == null) { - separator = FILTER_SEPARATOR; - } - if (searchFilter.getType().equals(DiscoveryConfigurationParameters.TYPE_DATE)) { - //For our search filters that are dates we format them properly - date = MultiFormatDateParser.parse(value); - if (date != null) { - //TODO: make this date format configurable ! - value = DateFormatUtils.formatUTC(date, "yyyy-MM-dd"); - } - } - doc.addField(searchFilter.getIndexFieldName(), value); - doc.addField(searchFilter.getIndexFieldName() + "_keyword", value); - - if (authority != null && preferedLabel == null) { - doc.addField(searchFilter.getIndexFieldName() - + "_keyword", value + AUTHORITY_SEPARATOR - + authority); - doc.addField(searchFilter.getIndexFieldName() - + "_authority", authority); - doc.addField(searchFilter.getIndexFieldName() - + "_acid", value.toLowerCase() - + separator + value - + AUTHORITY_SEPARATOR + authority); - } - - if (preferedLabel != null) { - doc.addField(searchFilter.getIndexFieldName(), - preferedLabel); - doc.addField(searchFilter.getIndexFieldName() - + "_keyword", preferedLabel); - doc.addField(searchFilter.getIndexFieldName() - + "_keyword", preferedLabel - + AUTHORITY_SEPARATOR + authority); - doc.addField(searchFilter.getIndexFieldName() - + "_authority", authority); - doc.addField(searchFilter.getIndexFieldName() - + "_acid", preferedLabel.toLowerCase() - + separator + preferedLabel - + AUTHORITY_SEPARATOR + authority); - } - if (variants != null) { - for (String var : variants) { - doc.addField(searchFilter.getIndexFieldName() + "_keyword", var); - doc.addField(searchFilter.getIndexFieldName() - + "_acid", var.toLowerCase() - + separator + var - + AUTHORITY_SEPARATOR + authority); - } - } - - //Add a dynamic fields for auto complete in search - doc.addField(searchFilter.getIndexFieldName() + "_ac", - value.toLowerCase() + separator + value); - if (preferedLabel != null) { - doc.addField(searchFilter.getIndexFieldName() - + "_ac", preferedLabel.toLowerCase() - + separator + preferedLabel); - } - if (variants != null) { - for (String var : variants) { - doc.addField(searchFilter.getIndexFieldName() - + "_ac", var.toLowerCase() + separator - + var); - } - } - - if (searchFilter.getFilterType().equals(DiscoverySearchFilterFacet.FILTER_TYPE_FACET)) { - if (searchFilter.getType().equals(DiscoveryConfigurationParameters.TYPE_TEXT)) { - //Add a special filter - //We use a separator to split up the lowercase and regular case, this is needed to - // get our filters in regular case - //Solr has issues with facet prefix and cases - if (authority != null) { - String facetValue = preferedLabel != null ? preferedLabel : value; - doc.addField(searchFilter.getIndexFieldName() + "_filter", facetValue - .toLowerCase() + separator + facetValue + AUTHORITY_SEPARATOR + authority); - } else { - doc.addField(searchFilter.getIndexFieldName() + "_filter", - value.toLowerCase() + separator + value); - } - } else if (searchFilter.getType().equals(DiscoveryConfigurationParameters.TYPE_DATE)) { - if (date != null) { - String indexField = searchFilter.getIndexFieldName() + ".year"; - String yearUTC = DateFormatUtils.formatUTC(date, "yyyy"); - doc.addField(searchFilter.getIndexFieldName() + "_keyword", yearUTC); - // add the year to the autocomplete index - doc.addField(searchFilter.getIndexFieldName() + "_ac", yearUTC); - doc.addField(indexField, yearUTC); - - if (yearUTC.startsWith("0")) { - doc.addField( - searchFilter.getIndexFieldName() - + "_keyword", - yearUTC.replaceFirst("0*", "")); - // add date without starting zeros for autocomplete e filtering - doc.addField( - searchFilter.getIndexFieldName() - + "_ac", - yearUTC.replaceFirst("0*", "")); - doc.addField( - searchFilter.getIndexFieldName() - + "_ac", - value.replaceFirst("0*", "")); - doc.addField( - searchFilter.getIndexFieldName() - + "_keyword", - value.replaceFirst("0*", "")); - } - - //Also save a sort value of this year, this is required for determining the upper - // & lower bound year of our facet - if (doc.getField(indexField + "_sort") == null) { - //We can only add one year so take the first one - doc.addField(indexField + "_sort", yearUTC); - } - } - } else if (searchFilter.getType() - .equals(DiscoveryConfigurationParameters.TYPE_HIERARCHICAL)) { - HierarchicalSidebarFacetConfiguration hierarchicalSidebarFacetConfiguration = - (HierarchicalSidebarFacetConfiguration) searchFilter; - String[] subValues = value.split(hierarchicalSidebarFacetConfiguration.getSplitter()); - if (hierarchicalSidebarFacetConfiguration - .isSkipFirstNodeLevel() && 1 < subValues.length) { - //Remove the first element of our array - subValues = (String[]) ArrayUtils.subarray(subValues, 1, subValues.length); - } - for (int i = 0; i < subValues.length; i++) { - StringBuilder valueBuilder = new StringBuilder(); - for (int j = 0; j <= i; j++) { - valueBuilder.append(subValues[j]); - if (j < i) { - valueBuilder.append(hierarchicalSidebarFacetConfiguration.getSplitter()); - } - } - - String indexValue = valueBuilder.toString().trim(); - doc.addField(searchFilter.getIndexFieldName() + "_tax_" + i + "_filter", - indexValue.toLowerCase() + separator + indexValue); - //We add the field x times that it has occurred - for (int j = i; j < subValues.length; j++) { - doc.addField(searchFilter.getIndexFieldName() + "_filter", - indexValue.toLowerCase() + separator + indexValue); - doc.addField(searchFilter.getIndexFieldName() + "_keyword", indexValue); - } - } - } - } - } - } - - if ((sortFields.get(field) != null || recentSubmissionsConfigurationMap - .get(field) != null) && !sortFieldsAdded.contains(field)) { - //Only add sort value once - String type; - if (sortFields.get(field) != null) { - type = sortFields.get(field).getType(); - } else { - type = recentSubmissionsConfigurationMap.get(field).getType(); - } - - if (type.equals(DiscoveryConfigurationParameters.TYPE_DATE)) { - Date date = MultiFormatDateParser.parse(value); - if (date != null) { - String stringDate = SolrUtils.getDateFormatter().format(date); - doc.addField(field + "_dt", stringDate); - } else { - log.warn("Error while indexing sort date field, item: " + item - .getHandle() + " metadata field: " + field + " date value: " + date); - } - } else { - doc.addField(field + "_sort", value); - } - sortFieldsAdded.add(field); - } - - if (hitHighlightingFields.contains(field) || hitHighlightingFields - .contains("*") || hitHighlightingFields.contains(unqualifiedField + "." + Item.ANY)) { - if (authority != null) { - doc.addField(field + "_hl", value + AUTHORITY_SEPARATOR + authority); - } else { - doc.addField(field + "_hl", value); - } - } - - if (moreLikeThisFields.contains(field) || moreLikeThisFields - .contains(unqualifiedField + "." + Item.ANY)) { - doc.addField(field + "_mlt", value); - } - - doc.addField(field, value); - if (authority != null) { - doc.addField(field + "_authority", authority); - } - if (toProjectionFields.contains(field) || toProjectionFields - .contains(unqualifiedField + "." + Item.ANY)) { - StringBuffer variantsToStore = new StringBuffer(); - if (variants != null) { - for (String var : variants) { - variantsToStore.append(VARIANTS_STORE_SEPARATOR); - variantsToStore.append(var); - } - } - doc.addField( - field + "_stored", - value + STORE_SEPARATOR + preferedLabel - + STORE_SEPARATOR - + (variantsToStore.length() > VARIANTS_STORE_SEPARATOR - .length() ? variantsToStore - .substring(VARIANTS_STORE_SEPARATOR - .length()) : "null") - + STORE_SEPARATOR + authority - + STORE_SEPARATOR + meta.getLanguage()); - } - - if (meta.getLanguage() != null && !meta.getLanguage().trim().equals("")) { - String langField = field + "." + meta.getLanguage(); - doc.addField(langField, value); - } - } - - } catch (Exception e) { - log.error(e.getMessage(), e); - } - - - log.debug(" Added Metadata"); - - try { - - List values = itemService.getMetadataByMetadataString(item, "dc.relation.ispartof"); - - if (values != null && values.size() > 0 && values.get(0) != null && values.get(0).getValue() != null) { - // group on parent - String handlePrefix = handleService.getCanonicalPrefix(); - - doc.addField("publication_grp", values.get(0).getValue().replaceFirst(handlePrefix, "")); - - } else { - // group on self - doc.addField("publication_grp", item.getHandle()); - } - - } catch (Exception e) { - log.error(e.getMessage(), e); - } - - - log.debug(" Added Grouping"); - - //Do any additional indexing, depends on the plugins - List solrServiceIndexPlugins = DSpaceServicesFactory.getInstance().getServiceManager() - .getServicesByType( - SolrServiceIndexPlugin.class); - for (SolrServiceIndexPlugin solrServiceIndexPlugin : solrServiceIndexPlugins) { - solrServiceIndexPlugin.additionalIndex(context, item, doc); - } - } - - private void deleteInProgressSubmissionByItemID(String uniqueID) throws SolrServerException, IOException { - String query = "inprogress.item:\"" + uniqueID + "\""; - log.debug("Try to delete all in progress submission [DELETEBYQUERY]:" + query); - getSolr().deleteByQuery(query); - } - - private void addFacetIndex(SolrInputDocument document, String field, String authority, String fvalue) { - addFacetIndex(document, field, fvalue, authority, fvalue); - } - - private void addFacetIndex(SolrInputDocument document, String field, String sortValue, String authority, - String fvalue) { - // the separator for the filter can be eventually configured - String separator = DSpaceServicesFactory.getInstance().getConfigurationService() - .getProperty("discovery.solr.facets.split.char"); - if (separator == null) { - separator = FILTER_SEPARATOR; - } - String acvalue = sortValue + separator + fvalue + SolrServiceImpl.AUTHORITY_SEPARATOR + authority; - document.addField(field + "_filter", acvalue); - // build the solr field used for the keyword search - document.addField(field + "_keyword", fvalue); - // build the solr fields used for the autocomplete - document.addField(field + "_ac", fvalue.toLowerCase() + separator + fvalue); - if (StringUtils.isNotBlank(authority)) { - document.addField(field + "_acid", fvalue.toLowerCase() + separator + fvalue - + SolrServiceImpl.AUTHORITY_SEPARATOR + authority); - document.addField(field + "_authority", authority); - } - } - - private void indexInProgressSubmissionItem(Context context, Item item) - throws SQLException, IOException, SolrServerException, WorkflowConfigurationException { - XmlWorkflowItem workflowItem = workflowItemService.findByItem(context, item); - if (workflowItem == null) { - WorkspaceItem workspaceItem = workspaceItemService.findByItem(context, item); - if (workspaceItem == null) { - // mmm... it could be a template item, skip it - return; - } - // workspaceitem - List locations = getCollectionLocations(context, workspaceItem.getCollection()); - SolrInputDocument doc = new SolrInputDocument(); - - doc.addField("lastModified", item.getLastModified()); - EPerson submitter = workspaceItem.getSubmitter(); - if (submitter != null) { - addFacetIndex(doc, "submitter", submitter.getID().toString(), - submitter.getFullName()); - } - - List discoveryConfigurations = SearchUtils - .getAllDiscoveryConfigurations(workspaceItem); - addDiscoveryFields(doc, context, item, discoveryConfigurations); - addBasicInfoToDocument(doc, Constants.WORKSPACEITEM, workspaceItem.getID(), null, locations); - - String acvalue = DSpaceServicesFactory.getInstance().getConfigurationService() - .getProperty("discovery.facet.namedtype.workspace"); - if (StringUtils.isBlank(acvalue)) { - acvalue = workspaceItem.getTypeText(); - } - addNamedResourceTypeIndex(doc, acvalue); - doc.addField("inprogress.item", item.getUniqueIndexID()); - - getSolr().add(doc); - } else { - // so it is an item in the workflow - // get the location string (for searching by collection & community) - List locations = getCollectionLocations(context, workflowItem.getCollection()); - SolrInputDocument doc = new SolrInputDocument(); - - doc.addField("inprogress.item", item.getUniqueIndexID()); - doc.addField("lastModified", item.getLastModified()); - EPerson submitter = workflowItem.getSubmitter(); - if (submitter != null) { - addFacetIndex(doc, "submitter", submitter.getID().toString(), - submitter.getFullName()); - } - - List discoveryConfigurations = SearchUtils - .getAllDiscoveryConfigurations(workflowItem); - addDiscoveryFields(doc, context, item, discoveryConfigurations); - - List claimedTasks = claimedTaskService.find(context, workflowItem); - List pools = poolTaskService.find(context, workflowItem); - - List docs = new ArrayList(); - - if (claimedTasks != null) { - for (ClaimedTask claimedTask : claimedTasks) { - SolrInputDocument claimDoc = doc.deepCopy(); - addBasicInfoToDocument(claimDoc, Constants.CLAIMEDTASK, claimedTask.getID(), null, locations); - addFacetIndex(claimDoc, "action", claimedTask.getActionID(), claimedTask.getActionID()); - addFacetIndex(claimDoc, "step", claimedTask.getStepID(), claimedTask.getStepID()); - - claimDoc.addField("taskfor", "e" + claimedTask.getOwner().getID().toString()); - - String acvalue = DSpaceServicesFactory.getInstance().getConfigurationService() - .getProperty("discovery.facet.namedtype.workflow.claimed"); - if (StringUtils.isBlank(acvalue)) { - acvalue = claimedTask.getTypeText(); - } - addNamedResourceTypeIndex(claimDoc, acvalue); - - docs.add(claimDoc); - } - } - - if (pools != null) { - for (PoolTask poolTask : pools) { - SolrInputDocument claimDoc = doc.deepCopy(); - addBasicInfoToDocument(claimDoc, Constants.POOLTASK, poolTask.getID(), null, locations); - addFacetIndex(claimDoc, "action", poolTask.getActionID(), poolTask.getActionID()); - addFacetIndex(claimDoc, "step", poolTask.getStepID(), poolTask.getStepID()); - - if (poolTask.getEperson() != null) { - claimDoc.addField("taskfor", "e" + poolTask.getEperson().getID().toString()); - } - if (poolTask.getGroup() != null) { - claimDoc.addField("taskfor", "g" + poolTask.getGroup().getID().toString()); - } - - String acvalue = DSpaceServicesFactory.getInstance().getConfigurationService() - .getProperty("discovery.facet.namedtype.workflow.pooled"); - if (StringUtils.isBlank(acvalue)) { - acvalue = poolTask.getTypeText(); - } - addNamedResourceTypeIndex(claimDoc, acvalue); - docs.add(claimDoc); - } - } - - String acvalue = DSpaceServicesFactory.getInstance().getConfigurationService() - .getProperty("discovery.facet.namedtype.workflow.item"); - if (StringUtils.isBlank(acvalue)) { - acvalue = workflowItem.getTypeText(); - } - addNamedResourceTypeIndex(doc, acvalue); - - addBasicInfoToDocument(doc, Constants.WORKFLOWITEM, workflowItem.getID(), null, locations); - docs.add(doc); - - if (docs.size() > 0) { - getSolr().add(docs); - } else { - // no tasks found?!? - log.error("No tasks found for workflowitem " + workflowItem.getID()); - } - } - } - - /** - * Create Lucene document with all the shared fields initialized. - * - * @param type Type of DSpace Object - * @param id internal identifier - * @param handle handle string - * @param locations list of collection/community internal identifiers - * @return initialized Lucene document - */ - protected SolrInputDocument buildDocument(int type, UUID id, String handle, - List locations) { - SolrInputDocument doc = new SolrInputDocument(); - addBasicInfoToDocument(doc, type, id, handle, locations); - return doc; - } - - private void addBasicInfoToDocument(SolrInputDocument doc, int type, Serializable id, String handle, - List locations) { - // want to be able to check when last updated - // (not tokenized, but it is indexed) - doc.addField(LAST_INDEXED_FIELD, - SolrUtils.getDateFormatter().format(new Date())); - - // New fields to weaken the dependence on handles, and allow for faster - // list display - doc.addField(RESOURCE_UNIQUE_ID, type + "-" + id); - doc.addField(RESOURCE_TYPE_FIELD, Integer.toString(type)); - doc.addField(RESOURCE_ID_FIELD, id.toString()); - - // want to be able to search for handle, so use keyword - // (not tokenized, but it is indexed) - if (handle != null) { - // want to be able to search for handle, so use keyword - // (not tokenized, but it is indexed) - doc.addField(HANDLE_FIELD, handle); - } - - if (locations != null) { - for (String location : locations) { - doc.addField("location", location); - if (location.startsWith("m")) { - doc.addField("location.comm", location.substring(1)); - } else { - doc.addField("location.coll", location.substring(1)); - } - } - } - } - /** * Helper function to retrieve a date using a best guess of the potential * date encodings on a field @@ -1855,46 +696,36 @@ public class SolrServiceImpl implements SearchService, IndexingService { } //========== SearchService implementation - @Override - public DiscoverResult search(Context context, DiscoverQuery query) throws SearchServiceException { - return search(context, query, false); - } @Override - public DiscoverResult search(Context context, IndexableObject dso, - DiscoverQuery query) + public DiscoverResult search(Context context, IndexableObject dso, DiscoverQuery discoveryQuery) throws SearchServiceException { - return search(context, dso, query, false); - } - - @Override - public DiscoverResult search(Context context, IndexableObject dso, DiscoverQuery discoveryQuery, - boolean includeUnDiscoverable) throws SearchServiceException { if (dso != null) { - if (dso instanceof Community) { + if (dso instanceof IndexableCommunity) { discoveryQuery.addFilterQueries("location:m" + dso.getID()); - } else if (dso instanceof Collection) { + } else if (dso instanceof IndexableCollection) { discoveryQuery.addFilterQueries("location:l" + dso.getID()); - } else if (dso instanceof Item) { - discoveryQuery.addFilterQueries(HANDLE_FIELD + ":" + ((Item) dso).getHandle()); + } else if (dso instanceof IndexableItem) { + discoveryQuery.addFilterQueries(SearchUtils.RESOURCE_UNIQUE_ID + ":" + dso. + getUniqueIndexID()); } } - return search(context, discoveryQuery, includeUnDiscoverable); + return search(context, discoveryQuery); } @Override - public DiscoverResult search(Context context, DiscoverQuery discoveryQuery, boolean includeUnDiscoverable) + public DiscoverResult search(Context context, DiscoverQuery discoveryQuery ) throws SearchServiceException { try { - if (getSolr() == null) { + if (solrSearchCore.getSolr() == null) { return new DiscoverResult(); } - SolrQuery solrQuery = resolveToSolrQuery(context, discoveryQuery, includeUnDiscoverable); + SolrQuery solrQuery = resolveToSolrQuery(context, discoveryQuery); - QueryResponse queryResponse = getSolr().query(solrQuery, SolrRequest.METHOD.POST); + QueryResponse queryResponse = solrSearchCore.getSolr().query(solrQuery, SolrRequest.METHOD.POST); return retrieveResult(context, discoveryQuery, queryResponse); } catch (Exception e) { @@ -1902,8 +733,8 @@ public class SolrServiceImpl implements SearchService, IndexingService { } } - protected SolrQuery resolveToSolrQuery(Context context, DiscoverQuery discoveryQuery, - boolean includeUnDiscoverable) throws SearchServiceException { + protected SolrQuery resolveToSolrQuery(Context context, DiscoverQuery discoveryQuery) + throws SearchServiceException { SolrQuery solrQuery = new SolrQuery(); String query = "*:*"; @@ -1919,9 +750,8 @@ public class SolrServiceImpl implements SearchService, IndexingService { solrQuery.addField(fieldName); } // Also ensure a few key obj identifier fields are returned with every query - solrQuery.addField(HANDLE_FIELD); - solrQuery.addField(RESOURCE_TYPE_FIELD); - solrQuery.addField(RESOURCE_ID_FIELD); + solrQuery.addField(SearchUtils.RESOURCE_TYPE_FIELD); + solrQuery.addField(SearchUtils.RESOURCE_ID_FIELD); if (discoveryQuery.isSpellCheck()) { solrQuery.setParam(SpellingParams.SPELLCHECK_Q, query); @@ -1929,17 +759,12 @@ public class SolrServiceImpl implements SearchService, IndexingService { solrQuery.setParam("spellcheck", Boolean.TRUE); } - if (!includeUnDiscoverable) { - solrQuery.addFilterQuery("NOT(withdrawn:true)"); - solrQuery.addFilterQuery("NOT(discoverable:false)"); - } - for (int i = 0; i < discoveryQuery.getFilterQueries().size(); i++) { String filterQuery = discoveryQuery.getFilterQueries().get(i); solrQuery.addFilterQuery(filterQuery); } - if (discoveryQuery.getDSpaceObjectFilter() != -1) { - solrQuery.addFilterQuery(RESOURCE_TYPE_FIELD + ":" + discoveryQuery.getDSpaceObjectFilter()); + if (discoveryQuery.getDSpaceObjectFilter() != null) { + solrQuery.addFilterQuery(SearchUtils.RESOURCE_TYPE_FIELD + ":" + discoveryQuery.getDSpaceObjectFilter()); } for (int i = 0; i < discoveryQuery.getFieldPresentQueries().size(); i++) { @@ -2082,13 +907,14 @@ public class SolrServiceImpl implements SearchService, IndexingService { List searchFields = query.getSearchFields(); for (SolrDocument doc : solrQueryResponse.getResults()) { - IndexableObject dso = findIndexableObject(context, doc); + IndexableObject indexableObject = findIndexableObject(context, doc); - if (dso != null) { - result.addIndexableObject(dso); + if (indexableObject != null) { + result.addIndexableObject(indexableObject); } else { - log.error(LogManager.getHeader(context, "Error while retrieving DSpace object from discovery index", - "Handle: " + doc.getFirstValue(HANDLE_FIELD))); + log.error(LogManager.getHeader(context, + "Error while retrieving DSpace object from discovery index", + "Unique identifier: " + doc.getFirstValue(SearchUtils.RESOURCE_UNIQUE_ID))); continue; } @@ -2101,11 +927,11 @@ public class SolrServiceImpl implements SearchService, IndexingService { } resultDoc.addSearchField(field, valuesAsString.toArray(new String[valuesAsString.size()])); } - result.addSearchDocument(dso, resultDoc); + result.addSearchDocument(indexableObject, resultDoc); if (solrQueryResponse.getHighlighting() != null) { Map> highlightedFields = solrQueryResponse.getHighlighting().get( - dso.getType() + "-" + dso.getID()); + indexableObject.getUniqueIndexID()); if (MapUtils.isNotEmpty(highlightedFields)) { //We need to remove all the "_hl" appendix strings from our keys Map> resultMap = new HashMap>(); @@ -2120,8 +946,8 @@ public class SolrServiceImpl implements SearchService, IndexingService { resultMap.put(key.substring(0, key.lastIndexOf("_hl")), highlightedFields.get(key)); } - result.addHighlightedResult(dso, - new DiscoverResult.IndexableObjectHighlightResult(dso, resultMap)); + result.addHighlightedResult(indexableObject, + new DiscoverResult.IndexableObjectHighlightResult(indexableObject, resultMap)); } } } @@ -2220,35 +1046,16 @@ public class SolrServiceImpl implements SearchService, IndexingService { * An exception that provides information on a database access error or other errors. */ protected IndexableObject findIndexableObject(Context context, SolrDocument doc) throws SQLException { - Integer type = (Integer) doc.getFirstValue(RESOURCE_TYPE_FIELD); - Object id = doc.getFirstValue(RESOURCE_ID_FIELD); - String handle = (String) doc.getFirstValue(HANDLE_FIELD); - IndexableObject o = null; - Serializable uid = null; - if (type != null && id != null) { - switch (type) { - case Constants.WORKSPACEITEM: - case Constants.WORKFLOWITEM: - case Constants.POOLTASK: - case Constants.CLAIMEDTASK: - uid = Integer.parseInt((String) id); - break; - default: - uid = UUID.fromString((String) id); - break; - } - } + String type = (String) doc.getFirstValue(SearchUtils.RESOURCE_TYPE_FIELD); + String id = (String) doc.getFirstValue(SearchUtils.RESOURCE_ID_FIELD); + final IndexFactory indexableObjectService = indexObjectServiceFactory. + getIndexFactoryByType(type); + Optional indexableObject = indexableObjectService.findIndexableObject(context, id); - if (uid != null) { - o = (IndexableObject) contentServiceFactory.getIndexableObjectService(type).findIndexableObject(context, - uid); + if (!indexableObject.isPresent()) { + log.warn("Not able to retrieve object RESOURCE_ID:" + id + " - RESOURCE_TYPE_ID:" + type); } - - if (o == null) { - log.warn("Not able to retrieve object RESOURCE_ID:" + id + " - RESOURCE_TYPE_ID:" + type + " - HANDLE:" + - handle); - } - return o; + return indexableObject.orElse(null); } public List search(Context context, String query, int offset, int max, @@ -2261,14 +1068,14 @@ public class SolrServiceImpl implements SearchService, IndexingService { int offset, int max, String... filterquery) { try { - if (getSolr() == null) { + if (solrSearchCore.getSolr() == null) { return Collections.emptyList(); } SolrQuery solrQuery = new SolrQuery(); solrQuery.setQuery(query); //Only return obj identifier fields in result doc - solrQuery.setFields(RESOURCE_ID_FIELD, RESOURCE_TYPE_FIELD); + solrQuery.setFields(SearchUtils.RESOURCE_ID_FIELD, SearchUtils.RESOURCE_TYPE_FIELD); solrQuery.setStart(offset); solrQuery.setRows(max); if (orderfield != null) { @@ -2277,18 +1084,14 @@ public class SolrServiceImpl implements SearchService, IndexingService { if (filterquery != null) { solrQuery.addFilterQuery(filterquery); } - QueryResponse rsp = getSolr().query(solrQuery, SolrRequest.METHOD.POST); + QueryResponse rsp = solrSearchCore.getSolr().query(solrQuery, SolrRequest.METHOD.POST); SolrDocumentList docs = rsp.getResults(); Iterator iter = docs.iterator(); List result = new ArrayList(); while (iter.hasNext()) { SolrDocument doc = (SolrDocument) iter.next(); - - IndexableObject o = (IndexableObject)contentServiceFactory - .getIndexableObjectService((Integer) doc.getFirstValue(RESOURCE_TYPE_FIELD)) - .findIndexableObject(context, UUID.fromString((String) doc.getFirstValue(RESOURCE_ID_FIELD))); - + IndexableObject o = findIndexableObject(context, doc); if (o != null) { result.add(o); } @@ -2298,7 +1101,7 @@ public class SolrServiceImpl implements SearchService, IndexingService { // Any acception that we get ignore it. // We do NOT want any crashed to shown by the user log.error(LogManager.getHeader(context, "Error while quering solr", "Query: " + query), e); - return new ArrayList(0); + return new ArrayList<>(0); } } @@ -2357,13 +1160,13 @@ public class SolrServiceImpl implements SearchService, IndexingService { @Override public List getRelatedItems(Context context, Item item, DiscoveryMoreLikeThisConfiguration mltConfig) { - List results = new ArrayList(); + List results = new ArrayList<>(); try { SolrQuery solrQuery = new SolrQuery(); //Set the query to handle since this is unique - solrQuery.setQuery(HANDLE_FIELD + ": " + item.getHandle()); + solrQuery.setQuery(SearchUtils.RESOURCE_UNIQUE_ID + ": " + new IndexableItem(item).getUniqueIndexID()); //Only return obj identifier fields in result doc - solrQuery.setFields(HANDLE_FIELD, RESOURCE_TYPE_FIELD, RESOURCE_ID_FIELD); + solrQuery.setFields(SearchUtils.RESOURCE_TYPE_FIELD, SearchUtils.RESOURCE_ID_FIELD); //Add the more like this parameters ! solrQuery.setParam(MoreLikeThisParams.MLT, true); //Add a comma separated list of the similar fields @@ -2382,35 +1185,33 @@ public class SolrServiceImpl implements SearchService, IndexingService { solrQuery.setParam(MoreLikeThisParams.DOC_COUNT, String.valueOf(mltConfig.getMax())); solrQuery.setParam(MoreLikeThisParams.MIN_WORD_LEN, String.valueOf(mltConfig.getMinWordLength())); - if (getSolr() == null) { + if (solrSearchCore.getSolr() == null) { return Collections.emptyList(); } - QueryResponse rsp = getSolr().query(solrQuery, SolrRequest.METHOD.POST); + QueryResponse rsp = solrSearchCore.getSolr().query(solrQuery, SolrRequest.METHOD.POST); NamedList mltResults = (NamedList) rsp.getResponse().get("moreLikeThis"); if (mltResults != null && mltResults.get(item.getType() + "-" + item.getID()) != null) { SolrDocumentList relatedDocs = (SolrDocumentList) mltResults.get(item.getType() + "-" + item.getID()); for (Object relatedDoc : relatedDocs) { SolrDocument relatedDocument = (SolrDocument) relatedDoc; IndexableObject relatedItem = findIndexableObject(context, relatedDocument); - if (relatedItem.getType() == Constants.ITEM) { - results.add((Item) relatedItem); + if (relatedItem instanceof IndexableItem) { + results.add(((IndexableItem) relatedItem).getIndexedObject()); } } } - - } catch (Exception e) { log.error( - LogManager.getHeader(context, "Error while retrieving related items", "Handle: " + item.getHandle()), - e); + LogManager.getHeader(context, "Error while retrieving related items", "Handle: " + + item.getHandle()), e); } return results; } @Override public String toSortFieldIndex(String metadataField, String type) { - if (StringUtils.equalsIgnoreCase(SCORE, metadataField)) { - return SCORE; + if (StringUtils.equalsIgnoreCase(DiscoverySortConfiguration.SCORE, metadataField)) { + return DiscoverySortConfiguration.SCORE; } else if (StringUtils.equals(type, DiscoveryConfigurationParameters.TYPE_DATE)) { return metadataField + "_dt"; } else { @@ -2469,7 +1270,7 @@ public class SolrServiceImpl implements SearchService, IndexingService { String separator = DSpaceServicesFactory.getInstance().getConfigurationService() .getProperty("discovery.solr.facets.split.char"); if (separator == null) { - separator = FILTER_SEPARATOR; + separator = SearchUtils.FILTER_SEPARATOR; } //Escape any regex chars separator = java.util.regex.Pattern.quote(separator); @@ -2477,7 +1278,7 @@ public class SolrServiceImpl implements SearchService, IndexingService { StringBuffer valueBuffer = new StringBuffer(); int start = fqParts.length / 2; for (int i = start; i < fqParts.length; i++) { - String[] split = fqParts[i].split(AUTHORITY_SEPARATOR, 2); + String[] split = fqParts[i].split(SearchUtils.AUTHORITY_SEPARATOR, 2); valueBuffer.append(split[0]); } value = valueBuffer.toString(); @@ -2501,7 +1302,7 @@ public class SolrServiceImpl implements SearchService, IndexingService { String separator = DSpaceServicesFactory.getInstance().getConfigurationService() .getProperty("discovery.solr.facets.split.char"); if (separator == null) { - separator = FILTER_SEPARATOR; + separator = SearchUtils.FILTER_SEPARATOR; } //Escape any regex chars separator = java.util.regex.Pattern.quote(separator); @@ -2509,7 +1310,7 @@ public class SolrServiceImpl implements SearchService, IndexingService { StringBuffer authorityBuffer = new StringBuffer(); int start = fqParts.length / 2; for (int i = start; i < fqParts.length; i++) { - String[] split = fqParts[i].split(AUTHORITY_SEPARATOR, 2); + String[] split = fqParts[i].split(SearchUtils.AUTHORITY_SEPARATOR, 2); if (split.length == 2) { authorityBuffer.append(split[1]); } @@ -2533,7 +1334,7 @@ public class SolrServiceImpl implements SearchService, IndexingService { String separator = DSpaceServicesFactory.getInstance().getConfigurationService() .getProperty("discovery.solr.facets.split.char"); if (separator == null) { - separator = FILTER_SEPARATOR; + separator = SearchUtils.FILTER_SEPARATOR; } //Escape any regex chars separator = java.util.regex.Pattern.quote(separator); @@ -2563,8 +1364,8 @@ public class SolrServiceImpl implements SearchService, IndexingService { @Override public void commit() throws SearchServiceException { try { - if (getSolr() != null) { - getSolr().commit(); + if (solrSearchCore.getSolr() != null) { + solrSearchCore.getSolr().commit(); } } catch (Exception e) { throw new SearchServiceException(e.getMessage(), e); @@ -2613,37 +1414,4 @@ public class SolrServiceImpl implements SearchService, IndexingService { } return null; } - - /** - * Add the necessary fields to the SOLR document to support a Discover Facet on resourcetypename (archived item, - * workspace item, workflow item, etc) - * - * @param document - * the solr document - * @param filterValue - * the filter value (i.e. \n|||\n### - */ - private void addNamedResourceTypeIndex(SolrInputDocument document, String filterValue) { - - // the separator for the filter can be eventually configured - String separator = DSpaceServicesFactory.getInstance().getConfigurationService() - .getProperty("discovery.solr.facets.split.char"); - if (separator == null) { - separator = FILTER_SEPARATOR; - } - - // split the authority part from the sort/display - String[] avalues = filterValue.split(SolrServiceImpl.AUTHORITY_SEPARATOR); - - String sortValue = avalues[0]; - String authorityValue = avalues.length == 2 ? avalues[1] : filterValue; - - // get the display value - int idxSeparator = sortValue.indexOf(separator); - String displayValue = idxSeparator != -1 ? sortValue.substring(idxSeparator + separator.length()) - : sortValue; - - addFacetIndex(document, NAMED_RESOURCE_TYPE, sortValue, authorityValue, displayValue); - } - } diff --git a/dspace-api/src/main/java/org/dspace/discovery/SolrServiceMetadataBrowseIndexingPlugin.java b/dspace-api/src/main/java/org/dspace/discovery/SolrServiceMetadataBrowseIndexingPlugin.java index 6d1035c4a0..187c6b0600 100644 --- a/dspace-api/src/main/java/org/dspace/discovery/SolrServiceMetadataBrowseIndexingPlugin.java +++ b/dspace-api/src/main/java/org/dspace/discovery/SolrServiceMetadataBrowseIndexingPlugin.java @@ -23,6 +23,7 @@ import org.dspace.content.authority.service.ChoiceAuthorityService; import org.dspace.content.authority.service.MetadataAuthorityService; import org.dspace.content.service.ItemService; import org.dspace.core.Context; +import org.dspace.discovery.indexobject.IndexableItem; import org.dspace.services.factory.DSpaceServicesFactory; import org.dspace.sort.OrderFormat; import org.dspace.sort.SortException; @@ -56,12 +57,12 @@ public class SolrServiceMetadataBrowseIndexingPlugin implements SolrServiceIndex protected ChoiceAuthorityService choiceAuthorityService; @Override - public void additionalIndex(Context context, IndexableObject dso, SolrInputDocument document) { + public void additionalIndex(Context context, IndexableObject indexableObject, SolrInputDocument document) { // Only works for Items - if (!(dso instanceof Item)) { + if (!(indexableObject instanceof IndexableItem)) { return; } - Item item = (Item) dso; + Item item = ((IndexableItem) indexableObject).getIndexedObject(); // Get the currently configured browse indexes BrowseIndex[] bis; @@ -206,9 +207,9 @@ public class SolrServiceMetadataBrowseIndexingPlugin implements SolrServiceIndex bi.getDataType()); distFValues .add(nLabel - + SolrServiceImpl.FILTER_SEPARATOR + + SearchUtils.FILTER_SEPARATOR + preferedLabel - + SolrServiceImpl.AUTHORITY_SEPARATOR + + SearchUtils.AUTHORITY_SEPARATOR + values.get(x).getAuthority()); distValuesForAC.add(preferedLabel); } @@ -222,9 +223,9 @@ public class SolrServiceMetadataBrowseIndexingPlugin implements SolrServiceIndex bi.getDataType()); distFValues .add(nVal - + SolrServiceImpl.FILTER_SEPARATOR + + SearchUtils.FILTER_SEPARATOR + var - + SolrServiceImpl.AUTHORITY_SEPARATOR + + SearchUtils.AUTHORITY_SEPARATOR + values.get(x).getAuthority()); distValuesForAC.add(var); } @@ -241,7 +242,7 @@ public class SolrServiceMetadataBrowseIndexingPlugin implements SolrServiceIndex bi.getDataType()); distFValues .add(nVal - + SolrServiceImpl.FILTER_SEPARATOR + + SearchUtils.FILTER_SEPARATOR + values.get(x).getValue()); distFVal.add(values.get(x).getValue()); distValuesForAC.add(values.get(x).getValue()); diff --git a/dspace-api/src/main/java/org/dspace/discovery/SolrServicePrivateItemPlugin.java b/dspace-api/src/main/java/org/dspace/discovery/SolrServicePrivateItemPlugin.java new file mode 100644 index 0000000000..47dea08fc8 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/SolrServicePrivateItemPlugin.java @@ -0,0 +1,49 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery; + +import static org.apache.logging.log4j.LogManager.getLogger; + +import java.sql.SQLException; + +import org.apache.logging.log4j.Logger; +import org.apache.solr.client.solrj.SolrQuery; +import org.dspace.authorize.service.AuthorizeService; +import org.dspace.core.Context; +import org.dspace.core.LogManager; +import org.springframework.beans.factory.annotation.Autowired; + +/** + * This plugin prevents discovery of private items by non-administrators. + */ +public class SolrServicePrivateItemPlugin implements SolrServiceSearchPlugin { + + private static final Logger log = getLogger(SolrServicePrivateItemPlugin.class.getSimpleName()); + + @Autowired(required = true) + protected AuthorizeService authorizeService; + + + @Autowired(required = true) + protected SearchService searchService; + + @Override + public void additionalSearchParameters(Context context, DiscoverQuery discoveryQuery, SolrQuery solrQuery) { + try { + // Prevents access if user has no administrative rights on the community or collection. + // NOTE: the resource restriction plugin adds location filters for community and collection admins. + if ( !authorizeService.isAdmin(context) && !authorizeService.isCommunityAdmin(context) + && !authorizeService.isCollectionAdmin(context)) { + solrQuery.addFilterQuery("NOT(discoverable:false)"); + } + } catch (SQLException ex) { + log.error(LogManager.getHeader(context, "Error looking up authorization rights of current user", + ""), ex); + } + } +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/SolrServiceResourceRestrictionPlugin.java b/dspace-api/src/main/java/org/dspace/discovery/SolrServiceResourceRestrictionPlugin.java index 853076fdc2..38e85dbf93 100644 --- a/dspace-api/src/main/java/org/dspace/discovery/SolrServiceResourceRestrictionPlugin.java +++ b/dspace-api/src/main/java/org/dspace/discovery/SolrServiceResourceRestrictionPlugin.java @@ -24,6 +24,7 @@ import org.dspace.content.service.CommunityService; import org.dspace.core.Constants; import org.dspace.core.Context; import org.dspace.core.LogManager; +import org.dspace.discovery.indexobject.IndexableDSpaceObject; import org.dspace.eperson.EPerson; import org.dspace.eperson.Group; import org.dspace.eperson.service.GroupService; @@ -56,8 +57,8 @@ public class SolrServiceResourceRestrictionPlugin implements SolrServiceIndexPlu @Override public void additionalIndex(Context context, IndexableObject idxObj, SolrInputDocument document) { - if (idxObj instanceof DSpaceObject) { - DSpaceObject dso = (DSpaceObject) idxObj; + if (idxObj instanceof IndexableDSpaceObject) { + DSpaceObject dso = ((IndexableDSpaceObject) idxObj).getIndexedObject(); try { List policies = authorizeService.getPoliciesActionFilter(context, dso, Constants.READ); for (ResourcePolicy resourcePolicy : policies) { diff --git a/dspace-api/src/main/java/org/dspace/discovery/SolrServiceSpellIndexingPlugin.java b/dspace-api/src/main/java/org/dspace/discovery/SolrServiceSpellIndexingPlugin.java index 99c3fcf6ef..47a96d0352 100644 --- a/dspace-api/src/main/java/org/dspace/discovery/SolrServiceSpellIndexingPlugin.java +++ b/dspace-api/src/main/java/org/dspace/discovery/SolrServiceSpellIndexingPlugin.java @@ -14,6 +14,7 @@ import org.dspace.content.Item; import org.dspace.content.MetadataValue; import org.dspace.content.service.ItemService; import org.dspace.core.Context; +import org.dspace.discovery.indexobject.IndexableItem; import org.springframework.beans.factory.annotation.Autowired; /** @@ -29,9 +30,9 @@ public class SolrServiceSpellIndexingPlugin implements SolrServiceIndexPlugin { protected ItemService itemService; @Override - public void additionalIndex(Context context, IndexableObject dso, SolrInputDocument document) { - if (dso instanceof Item) { - Item item = (Item) dso; + public void additionalIndex(Context context, IndexableObject indexableObject, SolrInputDocument document) { + if (indexableObject instanceof IndexableItem) { + Item item = ((IndexableItem) indexableObject).getIndexedObject(); List dcValues = itemService.getMetadata(item, Item.ANY, Item.ANY, Item.ANY, Item.ANY); List toIgnoreMetadataFields = SearchUtils.getIgnoredMetadataFields(item.getType()); for (MetadataValue dcValue : dcValues) { diff --git a/dspace-api/src/main/java/org/dspace/discovery/configuration/DiscoveryConfigurationService.java b/dspace-api/src/main/java/org/dspace/discovery/configuration/DiscoveryConfigurationService.java index 53433f879f..2c12f923ae 100644 --- a/dspace-api/src/main/java/org/dspace/discovery/configuration/DiscoveryConfigurationService.java +++ b/dspace-api/src/main/java/org/dspace/discovery/configuration/DiscoveryConfigurationService.java @@ -13,8 +13,8 @@ import java.util.List; import java.util.Map; import org.apache.commons.lang3.StringUtils; -import org.dspace.content.DSpaceObject; import org.dspace.discovery.IndexableObject; +import org.dspace.discovery.indexobject.IndexableDSpaceObject; import org.dspace.services.factory.DSpaceServicesFactory; /** @@ -45,8 +45,8 @@ public class DiscoveryConfigurationService { String name; if (dso == null) { name = "site"; - } else if (dso instanceof DSpaceObject) { - name = ((DSpaceObject) dso).getHandle(); + } else if (dso instanceof IndexableDSpaceObject) { + name = ((IndexableDSpaceObject) dso).getIndexedObject().getHandle(); } else { name = dso.getUniqueIndexID(); } diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/ClaimedTaskIndexFactoryImpl.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/ClaimedTaskIndexFactoryImpl.java new file mode 100644 index 0000000000..411aa6a0fb --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/ClaimedTaskIndexFactoryImpl.java @@ -0,0 +1,99 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject; + +import java.io.IOException; +import java.sql.SQLException; +import java.util.Arrays; +import java.util.Iterator; +import java.util.List; +import java.util.Optional; + +import org.apache.commons.lang3.StringUtils; +import org.apache.solr.common.SolrInputDocument; +import org.dspace.core.Context; +import org.dspace.discovery.indexobject.factory.ClaimedTaskIndexFactory; +import org.dspace.discovery.indexobject.factory.WorkflowItemIndexFactory; +import org.dspace.services.factory.DSpaceServicesFactory; +import org.dspace.xmlworkflow.storedcomponents.ClaimedTask; +import org.dspace.xmlworkflow.storedcomponents.service.ClaimedTaskService; +import org.springframework.beans.factory.annotation.Autowired; + +/** + * Factory implementation for indexing/retrieving claimed tasks in the search core + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public class ClaimedTaskIndexFactoryImpl extends IndexFactoryImpl + implements ClaimedTaskIndexFactory { + + @Autowired + protected ClaimedTaskService claimedTaskService; + @Autowired + WorkflowItemIndexFactory indexableWorkflowItemService; + + @Override + public Iterator findAll(Context context) throws SQLException { + final Iterator claimedTasks = claimedTaskService.findAll(context).iterator(); + return new Iterator() { + @Override + public boolean hasNext() { + return claimedTasks.hasNext(); + } + + @Override + public IndexableClaimedTask next() { + return new IndexableClaimedTask(claimedTasks.next()); + } + }; + } + + @Override + public String getType() { + return IndexableClaimedTask.TYPE; + } + + @Override + public SolrInputDocument buildDocument(Context context, IndexableClaimedTask indexableObject) + throws SQLException, IOException { + // Add the ID's, types and call the SolrServiceIndexPlugins + final SolrInputDocument doc = super.buildDocument(context, indexableObject); + final ClaimedTask claimedTask = indexableObject.getIndexedObject(); + // Add submitter, locations and modification time + indexableWorkflowItemService.storeInprogressItemFields(context, doc, claimedTask.getWorkflowItem()); + + addFacetIndex(doc, "action", claimedTask.getActionID(), claimedTask.getActionID()); + addFacetIndex(doc, "step", claimedTask.getStepID(), claimedTask.getStepID()); + + doc.addField("taskfor", "e" + claimedTask.getOwner().getID().toString()); + + String acvalue = DSpaceServicesFactory.getInstance().getConfigurationService() + .getProperty("discovery.facet.namedtype.workflow.claimed"); + if (StringUtils.isBlank(acvalue)) { + acvalue = indexableObject.getTypeText(); + } + addNamedResourceTypeIndex(doc, acvalue); + + return doc; + } + + @Override + public boolean supports(Object object) { + return object instanceof ClaimedTask; + } + + @Override + public List getIndexableObjects(Context context, ClaimedTask object) { + return Arrays.asList(new IndexableClaimedTask(object)); + } + + @Override + public Optional findIndexableObject(Context context, String id) throws SQLException { + final ClaimedTask claimedTask = claimedTaskService.find(context, Integer.parseInt(id)); + return claimedTask == null ? Optional.empty() : Optional.of(new IndexableClaimedTask(claimedTask)); + } +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/CollectionIndexFactoryImpl.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/CollectionIndexFactoryImpl.java new file mode 100644 index 0000000000..4a78dc8e82 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/CollectionIndexFactoryImpl.java @@ -0,0 +1,158 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject; + +import java.io.IOException; +import java.sql.SQLException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Iterator; +import java.util.List; +import java.util.Optional; +import java.util.UUID; + +import org.apache.solr.common.SolrInputDocument; +import org.dspace.content.Collection; +import org.dspace.content.Community; +import org.dspace.content.factory.ContentServiceFactory; +import org.dspace.content.service.CollectionService; +import org.dspace.content.service.CommunityService; +import org.dspace.core.Context; +import org.dspace.discovery.SearchUtils; +import org.dspace.discovery.configuration.DiscoveryConfiguration; +import org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration; +import org.dspace.discovery.configuration.DiscoveryHitHighlightingConfiguration; +import org.dspace.discovery.indexobject.factory.CollectionIndexFactory; +import org.springframework.beans.factory.annotation.Autowired; + + +/** + * Factory implementation for indexing/retrieving collections in the search core + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public class CollectionIndexFactoryImpl extends DSpaceObjectIndexFactoryImpl + implements CollectionIndexFactory { + + @Autowired + protected CollectionService collectionService; + + @Autowired + protected CommunityService communityService; + + @Override + public Iterator findAll(Context context) throws SQLException { + Iterator collections = collectionService.findAll(context).iterator(); + + return new Iterator() { + @Override + public boolean hasNext() { + return collections.hasNext(); + } + + @Override + public IndexableCollection next() { + return new IndexableCollection(collections.next()); + } + }; + } + + @Override + public String getType() { + return IndexableCollection.TYPE; + } + + /** + * Build a solr document for a DSpace Collection. + * + * @param context The relevant DSpace Context. + * @param indexableCollection indexableCollection to be indexed + * @throws SQLException sql exception + * @throws IOException IO exception + */ + @Override + public SolrInputDocument buildDocument(Context context, IndexableCollection indexableCollection) + throws IOException, SQLException { + // Create Lucene Document and add the ID's, types and call the SolrServiceIndexPlugins + SolrInputDocument doc = super.buildDocument(context, indexableCollection); + + final Collection collection = indexableCollection.getIndexedObject(); + + // Retrieve configuration + DiscoveryConfiguration discoveryConfiguration = SearchUtils.getDiscoveryConfiguration(collection); + DiscoveryHitHighlightingConfiguration highlightingConfiguration = discoveryConfiguration + .getHitHighlightingConfiguration(); + List highlightedMetadataFields = new ArrayList<>(); + if (highlightingConfiguration != null) { + for (DiscoveryHitHighlightFieldConfiguration configuration : highlightingConfiguration + .getMetadataFields()) { + highlightedMetadataFields.add(configuration.getField()); + } + } + + + // Add collection metadata + String description = collectionService.getMetadata(collection, "introductory_text"); + String description_abstract = collectionService.getMetadata(collection, "short_description"); + String description_table = collectionService.getMetadata(collection, "side_bar_text"); + String provenance = collectionService.getMetadata(collection, "provenance_description"); + String rights = collectionService.getMetadata(collection, "copyright_text"); + String rights_license = collectionService.getMetadata(collection, "license"); + String title = collectionService.getMetadata(collection, "name"); + + List toIgnoreMetadataFields = SearchUtils.getIgnoredMetadataFields(collection.getType()); + addContainerMetadataField(doc, highlightedMetadataFields, toIgnoreMetadataFields, "dc.description", + description); + addContainerMetadataField(doc, highlightedMetadataFields, toIgnoreMetadataFields, "dc.description.abstract", + description_abstract); + addContainerMetadataField(doc, highlightedMetadataFields, toIgnoreMetadataFields, + "dc.description.tableofcontents", description_table); + addContainerMetadataField(doc, highlightedMetadataFields, toIgnoreMetadataFields, "dc.provenance", provenance); + addContainerMetadataField(doc, highlightedMetadataFields, toIgnoreMetadataFields, "dc.rights", rights); + addContainerMetadataField(doc, highlightedMetadataFields, toIgnoreMetadataFields, "dc.rights.license", + rights_license); + addContainerMetadataField(doc, highlightedMetadataFields, toIgnoreMetadataFields, "dc.title", title); + + return doc; + } + + @Override + public boolean supports(Object object) { + return object instanceof Collection; + } + + @Override + public List getIndexableObjects(Context context, Collection object) { + return Arrays.asList(new IndexableCollection(object)); + } + + @Override + public Optional findIndexableObject(Context context, String id) throws SQLException { + final Collection collection = (collectionService.find(context, UUID.fromString(id))); + return collection == null ? Optional.empty() : Optional.of(new IndexableCollection(collection)); + } + + @Override + public List getLocations(Context context, IndexableCollection indexableCollection) throws SQLException { + return getCollectionLocations(context, indexableCollection.getIndexedObject()); + } + + @Override + public List getCollectionLocations(Context context, Collection collection) throws SQLException { + List locations = new ArrayList<>(); + // build list of community ids + List communities = ContentServiceFactory.getInstance().getCommunityService(). + getAllParents(context, collection); + + // now put those into strings + for (Community community : communities) { + locations.add("m" + community.getID()); + } + + return locations; + } +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/CommunityIndexFactoryImpl.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/CommunityIndexFactoryImpl.java new file mode 100644 index 0000000000..ac33b4cf5a --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/CommunityIndexFactoryImpl.java @@ -0,0 +1,131 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject; + +import java.io.IOException; +import java.sql.SQLException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Iterator; +import java.util.List; +import java.util.Optional; +import java.util.UUID; + +import org.apache.solr.common.SolrInputDocument; +import org.dspace.content.Community; +import org.dspace.content.service.CommunityService; +import org.dspace.core.Context; +import org.dspace.discovery.SearchUtils; +import org.dspace.discovery.configuration.DiscoveryConfiguration; +import org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration; +import org.dspace.discovery.configuration.DiscoveryHitHighlightingConfiguration; +import org.dspace.discovery.indexobject.factory.CommunityIndexFactory; +import org.springframework.beans.factory.annotation.Autowired; + +/** + * Factory implementation for indexing/retrieving communities in the search core + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public class CommunityIndexFactoryImpl extends DSpaceObjectIndexFactoryImpl + implements CommunityIndexFactory { + + @Autowired(required = true) + protected CommunityService communityService; + + @Override + public Iterator findAll(Context context) throws SQLException { + Iterator communities = communityService.findAll(context).iterator(); + + return new Iterator() { + @Override + public boolean hasNext() { + return communities.hasNext(); + } + + @Override + public IndexableCommunity next() { + return new IndexableCommunity(communities.next()); + } + }; + } + + @Override + public String getType() { + return IndexableCommunity.TYPE; + } + + + @Override + public SolrInputDocument buildDocument(Context context, IndexableCommunity indexableObject) + throws SQLException, IOException { + // Add the ID's, types and call the SolrServiceIndexPlugins + SolrInputDocument doc = super.buildDocument(context, indexableObject); + final Community community = indexableObject.getIndexedObject(); + + // Retrieve configuration + DiscoveryConfiguration discoveryConfiguration = SearchUtils.getDiscoveryConfiguration(community); + DiscoveryHitHighlightingConfiguration highlightingConfiguration = discoveryConfiguration + .getHitHighlightingConfiguration(); + List highlightedMetadataFields = new ArrayList(); + if (highlightingConfiguration != null) { + for (DiscoveryHitHighlightFieldConfiguration configuration : highlightingConfiguration + .getMetadataFields()) { + highlightedMetadataFields.add(configuration.getField()); + } + } + + // Add community metadata + String description = communityService.getMetadata(community, "introductory_text"); + String description_abstract = communityService.getMetadata(community, "short_description"); + String description_table = communityService.getMetadata(community, "side_bar_text"); + String rights = communityService.getMetadata(community, "copyright_text"); + String title = communityService.getMetadata(community, "name"); + + List toIgnoreMetadataFields = SearchUtils.getIgnoredMetadataFields(community.getType()); + addContainerMetadataField(doc, highlightedMetadataFields, toIgnoreMetadataFields, "dc.description", + description); + addContainerMetadataField(doc, highlightedMetadataFields, toIgnoreMetadataFields, "dc.description.abstract", + description_abstract); + addContainerMetadataField(doc, highlightedMetadataFields, toIgnoreMetadataFields, + "dc.description.tableofcontents", description_table); + addContainerMetadataField(doc, highlightedMetadataFields, toIgnoreMetadataFields, "dc.rights", rights); + addContainerMetadataField(doc, highlightedMetadataFields, toIgnoreMetadataFields, "dc.title", title); + return doc; + } + + @Override + public boolean supports(Object object) { + return object instanceof Community; + } + + @Override + public List getIndexableObjects(Context context, Community object) { + return Arrays.asList(new IndexableCommunity(object)); + } + + @Override + public Optional findIndexableObject(Context context, String id) throws SQLException { + final Community community = communityService.find(context, UUID.fromString(id)); + return community == null ? Optional.empty() : Optional.of(new IndexableCommunity(community)); + } + + @Override + public List getLocations(Context context, IndexableCommunity indexableDSpaceObject) throws SQLException { + final Community target = indexableDSpaceObject.getIndexedObject(); + List locations = new ArrayList<>(); + // build list of community ids + List communities = target.getParentCommunities(); + + // now put those into strings + for (Community community : communities) { + locations.add("m" + community.getID()); + } + + return locations; + } +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/DSpaceObjectIndexFactoryImpl.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/DSpaceObjectIndexFactoryImpl.java new file mode 100644 index 0000000000..08f9f31ea3 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/DSpaceObjectIndexFactoryImpl.java @@ -0,0 +1,80 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject; + +import java.io.IOException; +import java.sql.SQLException; +import java.util.List; + +import org.apache.commons.lang3.StringUtils; +import org.apache.solr.common.SolrInputDocument; +import org.dspace.content.DSpaceObject; +import org.dspace.core.Context; +import org.dspace.discovery.indexobject.factory.DSpaceObjectIndexFactory; + +/** + * Factory implementation for indexing/retrieving DSpaceObjects in the search core + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public abstract class DSpaceObjectIndexFactoryImpl + extends IndexFactoryImpl implements DSpaceObjectIndexFactory { + + @Override + public SolrInputDocument buildDocument(Context context, T indexableObject) throws SQLException, IOException { + // Add the ID's, types and call the SolrServiceIndexPlugins + SolrInputDocument doc = super.buildDocument(context, indexableObject); + final DSpaceObject dso = indexableObject.getIndexedObject(); + + // want to be able to search for handle, so use keyword + // (not tokenized, but it is indexed) + if (dso.getHandle() != null) { + // want to be able to search for handle, so use keyword + // (not tokenized, but it is indexed) + doc.addField("handle", dso.getHandle()); + } + + final List locations = getLocations(context, indexableObject); + storeCommunityCollectionLocations(doc, locations); + return doc; + } + + /** + * Add the metadata value of the community/collection to the solr document + * IF needed highlighting is added ! + * + * @param doc the solr document + * @param highlightedMetadataFields the list of metadata fields that CAN be highlighted + * @param toIgnoreMetadataFields the list of metadata fields to skip adding to Solr + * @param metadataField the metadata field added + * @param value the value (can be NULL !) + */ + protected void addContainerMetadataField(SolrInputDocument doc, List highlightedMetadataFields, + List toIgnoreMetadataFields, String metadataField, String value) { + if ((toIgnoreMetadataFields == null || !toIgnoreMetadataFields.contains(metadataField)) + && StringUtils.isNotBlank(value)) { + doc.addField(metadataField, value); + if (highlightedMetadataFields.contains(metadataField)) { + doc.addField(metadataField + "_hl", value); + } + } + } + + @Override + public void storeCommunityCollectionLocations(SolrInputDocument doc, List locations) { + if (locations != null) { + for (String location : locations) { + doc.addField("location", location); + if (location.startsWith("m")) { + doc.addField("location.comm", location.substring(1)); + } else { + doc.addField("location.coll", location.substring(1)); + } + } + } + } +} diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexFactoryImpl.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexFactoryImpl.java new file mode 100644 index 0000000000..ca1423e593 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexFactoryImpl.java @@ -0,0 +1,193 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject; + +import java.io.IOException; +import java.sql.SQLException; +import java.util.Date; +import java.util.List; + +import org.apache.commons.lang3.StringUtils; +import org.apache.solr.client.solrj.SolrClient; +import org.apache.solr.client.solrj.SolrServerException; +import org.apache.solr.client.solrj.request.AbstractUpdateRequest; +import org.apache.solr.client.solrj.request.ContentStreamUpdateRequest; +import org.apache.solr.common.SolrInputDocument; +import org.apache.solr.common.params.ModifiableSolrParams; +import org.apache.solr.handler.extraction.ExtractingParams; +import org.dspace.core.Context; +import org.dspace.discovery.FullTextContentStreams; +import org.dspace.discovery.IndexableObject; +import org.dspace.discovery.SearchUtils; +import org.dspace.discovery.SolrSearchCore; +import org.dspace.discovery.SolrServiceIndexPlugin; +import org.dspace.discovery.indexobject.factory.IndexFactory; +import org.dspace.services.factory.DSpaceServicesFactory; +import org.dspace.util.SolrUtils; +import org.springframework.beans.factory.annotation.Autowired; + +/** + * Basis factory interface implementation for indexing/retrieving any IndexableObject in the search core + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public abstract class IndexFactoryImpl implements IndexFactory { + + @Autowired + protected List solrServiceIndexPlugins; + @Autowired + protected SolrSearchCore solrSearchCore; + + @Override + public SolrInputDocument buildDocument(Context context, T indexableObject) throws SQLException, IOException { + SolrInputDocument doc = new SolrInputDocument(); + // want to be able to check when last updated + // (not tokenized, but it is indexed) + doc.addField(SearchUtils.LAST_INDEXED_FIELD, SolrUtils.getDateFormatter().format(new Date())); + + // New fields to weaken the dependence on handles, and allow for faster + // list display + doc.addField(SearchUtils.RESOURCE_UNIQUE_ID, indexableObject.getType() + "-" + indexableObject.getID()); + doc.addField(SearchUtils.RESOURCE_TYPE_FIELD, indexableObject.getType()); + doc.addField(SearchUtils.RESOURCE_ID_FIELD, indexableObject.getID().toString()); + + //Do any additional indexing, depends on the plugins + for (SolrServiceIndexPlugin solrServiceIndexPlugin : solrServiceIndexPlugins) { + solrServiceIndexPlugin.additionalIndex(context, indexableObject, doc); + } + + return doc; + } + + @Override + public void writeDocument(Context context, T indexableObject, SolrInputDocument solrInputDocument) + throws SQLException, IOException, SolrServerException { + writeDocument(solrInputDocument, null); + } + + /** + * Write the document to the index under the appropriate unique identifier. + * + * @param doc the solr document to be written to the server + * @param streams list of bitstream content streams DiscoverQueryBuilderTest.java:285 + * @throws IOException A general class of exceptions produced by failed or interrupted I/O operations. + */ + protected void writeDocument(SolrInputDocument doc, FullTextContentStreams streams) + throws IOException, SolrServerException { + final SolrClient solr = solrSearchCore.getSolr(); + if (solr != null) { + if (streams != null && !streams.isEmpty()) { + ContentStreamUpdateRequest req = new ContentStreamUpdateRequest("/update/extract"); + req.addContentStream(streams); + + ModifiableSolrParams params = new ModifiableSolrParams(); + + //req.setParam(ExtractingParams.EXTRACT_ONLY, "true"); + for (String name : doc.getFieldNames()) { + for (Object val : doc.getFieldValues(name)) { + params.add(ExtractingParams.LITERALS_PREFIX + name, val.toString()); + } + } + + req.setParams(params); + req.setParam(ExtractingParams.UNKNOWN_FIELD_PREFIX, "attr_"); + req.setParam(ExtractingParams.MAP_PREFIX + "content", "fulltext"); + req.setParam(ExtractingParams.EXTRACT_FORMAT, "text"); + req.setAction(AbstractUpdateRequest.ACTION.COMMIT, true, true); + req.process(solr); + } else { + solr.add(doc); + } + } + } + + + /** + * Index the provided value as use for a sidebar facet + * @param document The solr document + * @param field The facet field name + * @param authority The authority linked to the field + * @param fvalue The display value for the facet + */ + protected void addFacetIndex(SolrInputDocument document, String field, String authority, String fvalue) { + addFacetIndex(document, field, fvalue, authority, fvalue); + } + + /** + * Index the provided value as use for a sidebar facet + * @param document The solr document + * @param field The facet field name + * @param sortValue The value on which we should sort our facet fields when retrieving + * @param authority The authority linked to the field + * @param fvalue The display value for the facet + */ + protected void addFacetIndex(SolrInputDocument document, String field, String sortValue, String authority, + String fvalue) { + // the separator for the filter can be eventually configured + String separator = DSpaceServicesFactory.getInstance().getConfigurationService() + .getProperty("discovery.solr.facets.split.char"); + if (separator == null) { + separator = SearchUtils.FILTER_SEPARATOR; + } + String acvalue = sortValue + separator + fvalue + SearchUtils.AUTHORITY_SEPARATOR + authority; + document.addField(field + "_filter", acvalue); + // build the solr field used for the keyword search + document.addField(field + "_keyword", fvalue); + // build the solr fields used for the autocomplete + document.addField(field + "_ac", fvalue.toLowerCase() + separator + fvalue); + if (StringUtils.isNotBlank(authority)) { + document.addField(field + "_acid", fvalue.toLowerCase() + separator + fvalue + + SearchUtils.AUTHORITY_SEPARATOR + authority); + document.addField(field + "_authority", authority); + } + } + + /** + * Add the necessary fields to the SOLR document to support a Discover Facet on resourcetypename (archived item, + * workspace item, workflow item, etc) + * + * @param document the solr document + * @param filterValue the filter value (i.e. \n|||\n### + */ + protected void addNamedResourceTypeIndex(SolrInputDocument document, String filterValue) { + + // the separator for the filter can be eventually configured + String separator = DSpaceServicesFactory.getInstance().getConfigurationService() + .getProperty("discovery.solr.facets.split.char"); + if (separator == null) { + separator = SearchUtils.FILTER_SEPARATOR; + } + + // split the authority part from the sort/display + String[] avalues = filterValue.split(SearchUtils.AUTHORITY_SEPARATOR); + + String sortValue = avalues[0]; + String authorityValue = avalues.length == 2 ? avalues[1] : filterValue; + + // get the display value + int idxSeparator = sortValue.indexOf(separator); + String displayValue = idxSeparator != -1 ? sortValue.substring(idxSeparator + separator.length()) + : sortValue; + + addFacetIndex(document, SearchUtils.NAMED_RESOURCE_TYPE, sortValue, authorityValue, displayValue); + } + + @Override + public void delete(T indexableObject) throws IOException, SolrServerException { + solrSearchCore.getSolr().deleteById(indexableObject.getUniqueIndexID()); + } + + @Override + public void delete(String indexableObjectIdentifier) throws IOException, SolrServerException { + solrSearchCore.getSolr().deleteById(indexableObjectIdentifier); + } + + @Override + public void deleteAll() throws IOException, SolrServerException { + solrSearchCore.getSolr().deleteByQuery(SearchUtils.RESOURCE_TYPE_FIELD + ":" + getType()); + } +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexableClaimedTask.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexableClaimedTask.java new file mode 100644 index 0000000000..3810b6803f --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexableClaimedTask.java @@ -0,0 +1,51 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject; + +import org.dspace.discovery.IndexableObject; +import org.dspace.xmlworkflow.storedcomponents.ClaimedTask; + +/** + * ClaimedTask implementation for the IndexableObject + * + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public class IndexableClaimedTask implements IndexableObject { + + private ClaimedTask claimedTask; + public static final String TYPE = ClaimedTask.class.getSimpleName(); + + public IndexableClaimedTask(ClaimedTask claimedTask) { + this.claimedTask = claimedTask; + } + + @Override + public ClaimedTask getIndexedObject() { + return claimedTask; + } + + @Override + public void setIndexedObject(ClaimedTask claimedTask) { + this.claimedTask = claimedTask; + } + + @Override + public String getType() { + return TYPE; + } + + @Override + public Integer getID() { + return claimedTask.getID(); + } + + @Override + public String getTypeText() { + return "CLAIMEDTASK"; + } +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexableCollection.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexableCollection.java new file mode 100644 index 0000000000..d7a618c3f5 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexableCollection.java @@ -0,0 +1,35 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject; + +import org.dspace.content.Collection; +import org.dspace.core.Constants; + +/** + * Collection implementation for the IndexableObject + * + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public class IndexableCollection extends IndexableDSpaceObject { + + public static final String TYPE = Collection.class.getSimpleName(); + + public IndexableCollection(Collection dso) { + super(dso); + } + + @Override + public String getType() { + return TYPE; + } + + @Override + public String getTypeText() { + return Constants.typeText[Constants.COLLECTION]; + } +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexableCommunity.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexableCommunity.java new file mode 100644 index 0000000000..46b927f00f --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexableCommunity.java @@ -0,0 +1,34 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject; + +import org.dspace.content.Community; +import org.dspace.core.Constants; + +/** + * Community implementation for the IndexableObject + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public class IndexableCommunity extends IndexableDSpaceObject { + + public static final String TYPE = Community.class.getSimpleName(); + + public IndexableCommunity(Community dso) { + super(dso); + } + + @Override + public String getType() { + return TYPE; + } + + @Override + public String getTypeText() { + return Constants.typeText[Constants.COMMUNITY]; + } +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexableDSpaceObject.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexableDSpaceObject.java new file mode 100644 index 0000000000..7ad82b1a95 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexableDSpaceObject.java @@ -0,0 +1,43 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject; + +import java.util.UUID; + +import org.dspace.content.DSpaceObject; +import org.dspace.discovery.IndexableObject; + +/** + * DSpaceObject implementation for the IndexableObject, contains methods used by all DSpaceObject methods + * All DSpaceObjects that will be indexed in discovery should inherit from this class & have their own implementation + * + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public abstract class IndexableDSpaceObject implements IndexableObject { + + private T dso; + + public IndexableDSpaceObject(T dso) { + this.dso = dso; + } + + @Override + public T getIndexedObject() { + return dso; + } + + @Override + public void setIndexedObject(T dso) { + this.dso = dso; + } + + @Override + public UUID getID() { + return dso.getID(); + } +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexableInProgressSubmission.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexableInProgressSubmission.java new file mode 100644 index 0000000000..cfa27ff814 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexableInProgressSubmission.java @@ -0,0 +1,35 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject; + +import org.dspace.content.InProgressSubmission; +import org.dspace.discovery.IndexableObject; + +/** + * InProgressSubmission implementation for the IndexableObject + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public abstract class IndexableInProgressSubmission + implements IndexableObject { + + protected T inProgressSubmission; + + public IndexableInProgressSubmission(T inProgressSubmission) { + this.inProgressSubmission = inProgressSubmission; + } + + @Override + public T getIndexedObject() { + return inProgressSubmission; + } + + @Override + public void setIndexedObject(T inProgressSubmission) { + this.inProgressSubmission = inProgressSubmission; + } +} diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexableItem.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexableItem.java new file mode 100644 index 0000000000..ec67406e8f --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexableItem.java @@ -0,0 +1,41 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject; + +import java.util.Date; + +import org.dspace.content.Item; +import org.dspace.core.Constants; + +/** + * Item implementation for the IndexableObject + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public class IndexableItem extends IndexableDSpaceObject { + + public static final String TYPE = Item.class.getSimpleName(); + + public IndexableItem(Item dso) { + super(dso); + } + + @Override + public Date getLastModified() { + return getIndexedObject().getLastModified(); + } + + @Override + public String getType() { + return TYPE; + } + + @Override + public String getTypeText() { + return Constants.typeText[Constants.ITEM]; + } +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexablePoolTask.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexablePoolTask.java new file mode 100644 index 0000000000..6eea1f0ebb --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexablePoolTask.java @@ -0,0 +1,51 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject; + +import org.dspace.discovery.IndexableObject; +import org.dspace.xmlworkflow.storedcomponents.PoolTask; + +/** + * PoolTask implementation for the IndexableObject + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public class IndexablePoolTask implements IndexableObject { + + public static final String TYPE = PoolTask.class.getSimpleName(); + + private PoolTask poolTask; + + public IndexablePoolTask(PoolTask poolTask) { + this.poolTask = poolTask; + } + + @Override + public PoolTask getIndexedObject() { + return poolTask; + } + + @Override + public void setIndexedObject(PoolTask poolTask) { + this.poolTask = poolTask; + } + + @Override + public String getType() { + return TYPE; + } + + @Override + public String getTypeText() { + return "POOLTASK"; + } + + @Override + public Integer getID() { + return poolTask.getID(); + } +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexableWorkflowItem.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexableWorkflowItem.java new file mode 100644 index 0000000000..016fec1bbb --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexableWorkflowItem.java @@ -0,0 +1,38 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject; + +import org.dspace.xmlworkflow.storedcomponents.XmlWorkflowItem; + +/** + * Workflow item implementation for the IndexableObject + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public class IndexableWorkflowItem extends IndexableInProgressSubmission { + + public static final String TYPE = XmlWorkflowItem.class.getSimpleName(); + + public IndexableWorkflowItem(XmlWorkflowItem inProgressSubmission) { + super(inProgressSubmission); + } + + @Override + public String getType() { + return TYPE; + } + + @Override + public String getTypeText() { + return "WORKFLOWITEM"; + } + + @Override + public Integer getID() { + return getIndexedObject().getID(); + } +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexableWorkspaceItem.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexableWorkspaceItem.java new file mode 100644 index 0000000000..65b05b0d49 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/IndexableWorkspaceItem.java @@ -0,0 +1,38 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject; + +import org.dspace.content.WorkspaceItem; + +/** + * Workspace item implementation for the IndexableObject + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public class IndexableWorkspaceItem extends IndexableInProgressSubmission { + + public static final String TYPE = WorkspaceItem.class.getSimpleName(); + + public IndexableWorkspaceItem(WorkspaceItem inProgressSubmission) { + super(inProgressSubmission); + } + + @Override + public String getType() { + return TYPE; + } + + @Override + public Integer getID() { + return getIndexedObject().getID(); + } + + @Override + public String getTypeText() { + return "WORKSPACEITEM"; + } +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/InprogressSubmissionIndexFactoryImpl.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/InprogressSubmissionIndexFactoryImpl.java new file mode 100644 index 0000000000..4109d11021 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/InprogressSubmissionIndexFactoryImpl.java @@ -0,0 +1,66 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject; + +import java.io.IOException; +import java.sql.SQLException; +import java.util.List; + +import org.apache.solr.common.SolrInputDocument; +import org.dspace.content.InProgressSubmission; +import org.dspace.content.Item; +import org.dspace.core.Context; +import org.dspace.discovery.indexobject.factory.CollectionIndexFactory; +import org.dspace.discovery.indexobject.factory.InprogressSubmissionIndexFactory; +import org.dspace.discovery.indexobject.factory.ItemIndexFactory; +import org.dspace.eperson.EPerson; +import org.dspace.util.SolrUtils; +import org.springframework.beans.factory.annotation.Autowired; + +/** + * Factory implementation for indexing/retrieving InProgressSubmissions in the search core + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public abstract class InprogressSubmissionIndexFactoryImpl + extends IndexFactoryImpl + implements InprogressSubmissionIndexFactory { + + @Autowired + protected CollectionIndexFactory indexableCollectionService; + @Autowired + protected ItemIndexFactory indexableItemService; + + + @Override + public SolrInputDocument buildDocument(Context context, T indexableObject) throws SQLException, IOException { + // Add the ID's, types and call the SolrServiceIndexPlugins + SolrInputDocument doc = super.buildDocument(context, indexableObject); + // Add submitter, locations and modification time + storeInprogressItemFields(context, doc, indexableObject.getIndexedObject()); + return doc; + } + + @Override + public void storeInprogressItemFields(Context context, SolrInputDocument doc, + InProgressSubmission inProgressSubmission) throws SQLException { + final Item item = inProgressSubmission.getItem(); + doc.addField("lastModified", SolrUtils.getDateFormatter().format(item.getLastModified())); + EPerson submitter = inProgressSubmission.getSubmitter(); + if (submitter != null) { + addFacetIndex(doc, "submitter", submitter.getID().toString(), + submitter.getFullName()); + } + + doc.addField("inprogress.item", new IndexableItem(inProgressSubmission.getItem()).getUniqueIndexID()); + + // get the location string (for searching by collection & community) + List locations = indexableCollectionService. + getCollectionLocations(context, inProgressSubmission.getCollection()); + indexableCollectionService.storeCommunityCollectionLocations(doc, locations); + } +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/ItemIndexFactoryImpl.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/ItemIndexFactoryImpl.java new file mode 100644 index 0000000000..7f98131566 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/ItemIndexFactoryImpl.java @@ -0,0 +1,733 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject; + +import java.io.IOException; +import java.sql.SQLException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Date; +import java.util.HashMap; +import java.util.HashSet; +import java.util.Iterator; +import java.util.LinkedList; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.Set; +import java.util.UUID; + +import org.apache.commons.lang3.ArrayUtils; +import org.apache.commons.lang3.StringUtils; +import org.apache.commons.lang3.time.DateFormatUtils; +import org.apache.logging.log4j.Logger; +import org.apache.solr.client.solrj.SolrServerException; +import org.apache.solr.common.SolrInputDocument; +import org.dspace.content.Collection; +import org.dspace.content.Community; +import org.dspace.content.Item; +import org.dspace.content.MetadataField; +import org.dspace.content.MetadataSchema; +import org.dspace.content.MetadataValue; +import org.dspace.content.WorkspaceItem; +import org.dspace.content.authority.Choices; +import org.dspace.content.authority.service.ChoiceAuthorityService; +import org.dspace.content.authority.service.MetadataAuthorityService; +import org.dspace.content.service.ItemService; +import org.dspace.content.service.WorkspaceItemService; +import org.dspace.core.Context; +import org.dspace.core.LogManager; +import org.dspace.discovery.FullTextContentStreams; +import org.dspace.discovery.IndexableObject; +import org.dspace.discovery.SearchUtils; +import org.dspace.discovery.configuration.DiscoveryConfiguration; +import org.dspace.discovery.configuration.DiscoveryConfigurationParameters; +import org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration; +import org.dspace.discovery.configuration.DiscoveryHitHighlightingConfiguration; +import org.dspace.discovery.configuration.DiscoveryMoreLikeThisConfiguration; +import org.dspace.discovery.configuration.DiscoveryRecentSubmissionsConfiguration; +import org.dspace.discovery.configuration.DiscoverySearchFilter; +import org.dspace.discovery.configuration.DiscoverySearchFilterFacet; +import org.dspace.discovery.configuration.DiscoverySortConfiguration; +import org.dspace.discovery.configuration.DiscoverySortFieldConfiguration; +import org.dspace.discovery.configuration.HierarchicalSidebarFacetConfiguration; +import org.dspace.discovery.indexobject.factory.ItemIndexFactory; +import org.dspace.discovery.indexobject.factory.WorkflowItemIndexFactory; +import org.dspace.discovery.indexobject.factory.WorkspaceItemIndexFactory; +import org.dspace.eperson.EPerson; +import org.dspace.handle.service.HandleService; +import org.dspace.services.factory.DSpaceServicesFactory; +import org.dspace.util.MultiFormatDateParser; +import org.dspace.util.SolrUtils; +import org.dspace.xmlworkflow.storedcomponents.XmlWorkflowItem; +import org.dspace.xmlworkflow.storedcomponents.service.XmlWorkflowItemService; +import org.springframework.beans.factory.annotation.Autowired; + +/** + * Factory implementation for indexing/retrieving items in the search core + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public class ItemIndexFactoryImpl extends DSpaceObjectIndexFactoryImpl + implements ItemIndexFactory { + + private static final Logger log = org.apache.logging.log4j.LogManager.getLogger(ItemIndexFactoryImpl.class); + public static final String VARIANTS_STORE_SEPARATOR = "###"; + public static final String STORE_SEPARATOR = "\n|||\n"; + + + @Autowired + protected HandleService handleService; + @Autowired + protected ItemService itemService; + @Autowired(required = true) + protected ChoiceAuthorityService choiceAuthorityService; + @Autowired + protected MetadataAuthorityService metadataAuthorityService; + @Autowired + protected WorkspaceItemService workspaceItemService; + @Autowired + protected XmlWorkflowItemService xmlWorkflowItemService; + @Autowired + protected WorkflowItemIndexFactory workflowItemIndexFactory; + @Autowired + protected WorkspaceItemIndexFactory workspaceItemIndexFactory; + + + @Override + public Iterator findAll(Context context) throws SQLException { + Iterator items = itemService.findAllUnfiltered(context); + return new Iterator() { + @Override + public boolean hasNext() { + return items.hasNext(); + } + + @Override + public IndexableItem next() { + return new IndexableItem(items.next()); + } + }; + } + + @Override + public String getType() { + return IndexableItem.TYPE; + } + + /** + * Build a Solr document for a DSpace Item and write the index + * + * @param context Users Context + * @param indexableItem The IndexableItem Item to be indexed + * @throws SQLException if database error + * @throws IOException if IO error + */ + @Override + public SolrInputDocument buildDocument(Context context, IndexableItem indexableItem) + throws SQLException, IOException { + // Add the ID's, types and call the SolrServiceIndexPlugins + SolrInputDocument doc = super.buildDocument(context, indexableItem); + + final Item item = indexableItem.getIndexedObject(); + + doc.addField("archived", item.isArchived()); + doc.addField("withdrawn", item.isWithdrawn()); + doc.addField("discoverable", item.isDiscoverable()); + doc.addField("lastModified", SolrUtils.getDateFormatter().format(item.getLastModified())); + + EPerson submitter = item.getSubmitter(); + if (submitter != null) { + addFacetIndex(doc, "submitter", submitter.getID().toString(), + submitter.getFullName()); + } + + // Add the item metadata + List discoveryConfigurations = SearchUtils.getAllDiscoveryConfigurations(item); + addDiscoveryFields(doc, context, indexableItem.getIndexedObject(), discoveryConfigurations); + + //mandatory facet to show status on mydspace + final String typeText = StringUtils.deleteWhitespace(indexableItem.getTypeText().toLowerCase()); + String acvalue = DSpaceServicesFactory.getInstance().getConfigurationService().getProperty( + "discovery.facet.namedtype." + typeText, + typeText + SearchUtils.AUTHORITY_SEPARATOR + typeText); + if (StringUtils.isNotBlank(acvalue)) { + addNamedResourceTypeIndex(doc, acvalue); + } + + // write the index and close the inputstreamreaders + try { + log.info("Wrote Item: " + item.getID() + " to Index"); + } catch (RuntimeException e) { + log.error("Error while writing item to discovery index: " + item.getID() + " message:" + + e.getMessage(), e); + } + return doc; + } + + @Override + public void addDiscoveryFields(SolrInputDocument doc, Context context, Item item, + List discoveryConfigurations) + throws SQLException, IOException { + //Keep a list of our sort values which we added, sort values can only be added once + List sortFieldsAdded = new ArrayList<>(); + Map> searchFilters = null; + Set hitHighlightingFields = new HashSet<>(); + try { + //A map used to save each sidebarFacet config by the metadata fields + searchFilters = new HashMap<>(); + Map sortFields = new HashMap<>(); + Map recentSubmissionsConfigurationMap = new + HashMap<>(); + Set moreLikeThisFields = new HashSet<>(); + // some configuration are returned multiple times, skip them to save CPU cycles + Set appliedConf = new HashSet<>(); + // it is common to have search filter shared between multiple configurations + Set appliedDiscoverySearchFilter = new HashSet<>(); + + for (DiscoveryConfiguration discoveryConfiguration : discoveryConfigurations) { + if (appliedConf.contains(discoveryConfiguration.getId())) { + continue; + } else { + appliedConf.add(discoveryConfiguration.getId()); + } + for (int i = 0; i < discoveryConfiguration.getSearchFilters().size(); i++) { + if (appliedDiscoverySearchFilter + .contains(discoveryConfiguration.getSearchFilters().get(i).getIndexFieldName())) { + continue; + } else { + appliedDiscoverySearchFilter + .add(discoveryConfiguration.getSearchFilters().get(i).getIndexFieldName()); + } + List metadataValueList = new LinkedList<>(); + boolean shouldExposeMinMax = false; + DiscoverySearchFilter discoverySearchFilter = discoveryConfiguration.getSearchFilters().get(i); + if (StringUtils.equalsIgnoreCase(discoverySearchFilter.getFilterType(), "facet")) { + if (((DiscoverySearchFilterFacet) discoverySearchFilter).exposeMinAndMaxValue()) { + shouldExposeMinMax = true; + } + } + for (int j = 0; j < discoverySearchFilter.getMetadataFields().size(); j++) { + String metadataField = discoverySearchFilter.getMetadataFields().get(j); + List resultingList; + if (searchFilters.get(metadataField) != null) { + resultingList = searchFilters.get(metadataField); + } else { + //New metadata field, create a new list for it + resultingList = new ArrayList<>(); + } + + + if (shouldExposeMinMax) { + String[] splittedMetadataField = metadataField.split("\\."); + String schema = splittedMetadataField[0]; + String element = splittedMetadataField.length > 1 ? splittedMetadataField[1] : null; + String qualifier = splittedMetadataField.length > 2 ? splittedMetadataField[2] : null; + + metadataValueList.addAll(itemService.getMetadata(item, schema, + element, qualifier, Item.ANY)); + + } + + resultingList.add(discoverySearchFilter); + + searchFilters.put(metadataField, resultingList); + } + + if (!metadataValueList.isEmpty() && shouldExposeMinMax) { + metadataValueList.sort((mdv1, mdv2) -> mdv1.getValue().compareTo(mdv2.getValue())); + MetadataValue firstMetadataValue = metadataValueList.get(0); + MetadataValue lastMetadataValue = metadataValueList.get(metadataValueList.size() - 1); + + doc.addField(discoverySearchFilter.getIndexFieldName() + "_min", firstMetadataValue.getValue()); + doc.addField(discoverySearchFilter.getIndexFieldName() + + "_min_sort", firstMetadataValue.getValue()); + doc.addField(discoverySearchFilter.getIndexFieldName() + "_max", lastMetadataValue.getValue()); + doc.addField(discoverySearchFilter.getIndexFieldName() + + "_max_sort", lastMetadataValue.getValue()); + + } + } + + DiscoverySortConfiguration sortConfiguration = discoveryConfiguration.getSearchSortConfiguration(); + if (sortConfiguration != null) { + for (DiscoverySortFieldConfiguration discoverySortConfiguration : sortConfiguration + .getSortFields()) { + sortFields.put(discoverySortConfiguration.getMetadataField(), discoverySortConfiguration); + } + } + + DiscoveryRecentSubmissionsConfiguration recentSubmissionConfiguration = discoveryConfiguration + .getRecentSubmissionConfiguration(); + if (recentSubmissionConfiguration != null) { + recentSubmissionsConfigurationMap + .put(recentSubmissionConfiguration.getMetadataSortField(), recentSubmissionConfiguration); + } + + DiscoveryHitHighlightingConfiguration hitHighlightingConfiguration = discoveryConfiguration + .getHitHighlightingConfiguration(); + if (hitHighlightingConfiguration != null) { + List fieldConfigurations = hitHighlightingConfiguration + .getMetadataFields(); + for (DiscoveryHitHighlightFieldConfiguration fieldConfiguration : fieldConfigurations) { + hitHighlightingFields.add(fieldConfiguration.getField()); + } + } + DiscoveryMoreLikeThisConfiguration moreLikeThisConfiguration = discoveryConfiguration + .getMoreLikeThisConfiguration(); + if (moreLikeThisConfiguration != null) { + for (String metadataField : moreLikeThisConfiguration.getSimilarityMetadataFields()) { + moreLikeThisFields.add(metadataField); + } + } + } + + + List toProjectionFields = new ArrayList<>(); + String[] projectionFields = DSpaceServicesFactory.getInstance().getConfigurationService() + .getArrayProperty("discovery.index.projection"); + if (projectionFields != null) { + for (String field : projectionFields) { + toProjectionFields.add(field.trim()); + } + } + + List toIgnoreMetadataFields = SearchUtils.getIgnoredMetadataFields(item.getType()); + List mydc = itemService.getMetadata(item, Item.ANY, Item.ANY, Item.ANY, Item.ANY); + for (MetadataValue meta : mydc) { + MetadataField metadataField = meta.getMetadataField(); + MetadataSchema metadataSchema = metadataField.getMetadataSchema(); + String field = metadataSchema.getName() + "." + metadataField.getElement(); + String unqualifiedField = field; + + String value = meta.getValue(); + + if (value == null) { + continue; + } + + if (metadataField.getQualifier() != null && !metadataField.getQualifier().trim().equals("")) { + field += "." + metadataField.getQualifier(); + } + + //We are not indexing provenance, this is useless + if (toIgnoreMetadataFields != null && (toIgnoreMetadataFields.contains(field) || toIgnoreMetadataFields + .contains(unqualifiedField + "." + Item.ANY))) { + continue; + } + + String authority = null; + String preferedLabel = null; + List variants = null; + boolean isAuthorityControlled = metadataAuthorityService + .isAuthorityControlled(metadataField); + + int minConfidence = isAuthorityControlled ? metadataAuthorityService + .getMinConfidence(metadataField) : Choices.CF_ACCEPTED; + + if (isAuthorityControlled && meta.getAuthority() != null + && meta.getConfidence() >= minConfidence) { + boolean ignoreAuthority = + DSpaceServicesFactory + .getInstance() + .getConfigurationService() + .getPropertyAsType("discovery.index.authority.ignore." + field, + DSpaceServicesFactory + .getInstance() + .getConfigurationService() + .getPropertyAsType("discovery.index.authority.ignore", + new Boolean(false)), + true); + if (!ignoreAuthority) { + authority = meta.getAuthority(); + + boolean ignorePrefered = + DSpaceServicesFactory + .getInstance() + .getConfigurationService() + .getPropertyAsType("discovery.index.authority.ignore-prefered." + field, + DSpaceServicesFactory + .getInstance() + .getConfigurationService() + .getPropertyAsType("discovery.index.authority.ignore-prefered", + new Boolean(false)), + true); + if (!ignorePrefered) { + + preferedLabel = choiceAuthorityService + .getLabel(meta, meta.getLanguage()); + } + + boolean ignoreVariants = + DSpaceServicesFactory + .getInstance() + .getConfigurationService() + .getPropertyAsType("discovery.index.authority.ignore-variants." + field, + DSpaceServicesFactory + .getInstance() + .getConfigurationService() + .getPropertyAsType("discovery.index.authority.ignore-variants", + new Boolean(false)), + true); + if (!ignoreVariants) { + variants = choiceAuthorityService + .getVariants(meta); + } + + } + } + + if ((searchFilters.get(field) != null || searchFilters + .get(unqualifiedField + "." + Item.ANY) != null)) { + List searchFilterConfigs = searchFilters.get(field); + if (searchFilterConfigs == null) { + searchFilterConfigs = searchFilters.get(unqualifiedField + "." + Item.ANY); + } + + for (DiscoverySearchFilter searchFilter : searchFilterConfigs) { + Date date = null; + String separator = DSpaceServicesFactory.getInstance().getConfigurationService() + .getProperty("discovery.solr.facets.split.char"); + if (separator == null) { + separator = SearchUtils.FILTER_SEPARATOR; + } + if (searchFilter.getType().equals(DiscoveryConfigurationParameters.TYPE_DATE)) { + //For our search filters that are dates we format them properly + date = MultiFormatDateParser.parse(value); + if (date != null) { + //TODO: make this date format configurable ! + value = DateFormatUtils.formatUTC(date, "yyyy-MM-dd"); + } + } + doc.addField(searchFilter.getIndexFieldName(), value); + doc.addField(searchFilter.getIndexFieldName() + "_keyword", value); + + if (authority != null && preferedLabel == null) { + doc.addField(searchFilter.getIndexFieldName() + + "_keyword", value + SearchUtils.AUTHORITY_SEPARATOR + + authority); + doc.addField(searchFilter.getIndexFieldName() + + "_authority", authority); + doc.addField(searchFilter.getIndexFieldName() + + "_acid", value.toLowerCase() + + separator + value + + SearchUtils.AUTHORITY_SEPARATOR + authority); + } + + if (preferedLabel != null) { + doc.addField(searchFilter.getIndexFieldName(), + preferedLabel); + doc.addField(searchFilter.getIndexFieldName() + + "_keyword", preferedLabel); + doc.addField(searchFilter.getIndexFieldName() + + "_keyword", preferedLabel + + SearchUtils.AUTHORITY_SEPARATOR + authority); + doc.addField(searchFilter.getIndexFieldName() + + "_authority", authority); + doc.addField(searchFilter.getIndexFieldName() + + "_acid", preferedLabel.toLowerCase() + + separator + preferedLabel + + SearchUtils.AUTHORITY_SEPARATOR + authority); + } + if (variants != null) { + for (String var : variants) { + doc.addField(searchFilter.getIndexFieldName() + "_keyword", var); + doc.addField(searchFilter.getIndexFieldName() + + "_acid", var.toLowerCase() + + separator + var + + SearchUtils.AUTHORITY_SEPARATOR + authority); + } + } + + //Add a dynamic fields for auto complete in search + doc.addField(searchFilter.getIndexFieldName() + "_ac", + value.toLowerCase() + separator + value); + if (preferedLabel != null) { + doc.addField(searchFilter.getIndexFieldName() + + "_ac", preferedLabel.toLowerCase() + + separator + preferedLabel); + } + if (variants != null) { + for (String var : variants) { + doc.addField(searchFilter.getIndexFieldName() + + "_ac", var.toLowerCase() + separator + + var); + } + } + + if (searchFilter.getFilterType().equals(DiscoverySearchFilterFacet.FILTER_TYPE_FACET)) { + if (searchFilter.getType().equals(DiscoveryConfigurationParameters.TYPE_TEXT)) { + //Add a special filter + //We use a separator to split up the lowercase and regular case, this is needed to + // get our filters in regular case + //Solr has issues with facet prefix and cases + if (authority != null) { + String facetValue = preferedLabel != null ? preferedLabel : value; + doc.addField(searchFilter.getIndexFieldName() + "_filter", facetValue + .toLowerCase() + separator + facetValue + SearchUtils.AUTHORITY_SEPARATOR + + authority); + } else { + doc.addField(searchFilter.getIndexFieldName() + "_filter", + value.toLowerCase() + separator + value); + } + } else if (searchFilter.getType().equals(DiscoveryConfigurationParameters.TYPE_DATE)) { + if (date != null) { + String indexField = searchFilter.getIndexFieldName() + ".year"; + String yearUTC = DateFormatUtils.formatUTC(date, "yyyy"); + doc.addField(searchFilter.getIndexFieldName() + "_keyword", yearUTC); + // add the year to the autocomplete index + doc.addField(searchFilter.getIndexFieldName() + "_ac", yearUTC); + doc.addField(indexField, yearUTC); + + if (yearUTC.startsWith("0")) { + doc.addField( + searchFilter.getIndexFieldName() + + "_keyword", + yearUTC.replaceFirst("0*", "")); + // add date without starting zeros for autocomplete e filtering + doc.addField( + searchFilter.getIndexFieldName() + + "_ac", + yearUTC.replaceFirst("0*", "")); + doc.addField( + searchFilter.getIndexFieldName() + + "_ac", + value.replaceFirst("0*", "")); + doc.addField( + searchFilter.getIndexFieldName() + + "_keyword", + value.replaceFirst("0*", "")); + } + + //Also save a sort value of this year, this is required for determining the upper + // & lower bound year of our facet + if (doc.getField(indexField + "_sort") == null) { + //We can only add one year so take the first one + doc.addField(indexField + "_sort", yearUTC); + } + } + } else if (searchFilter.getType() + .equals(DiscoveryConfigurationParameters.TYPE_HIERARCHICAL)) { + HierarchicalSidebarFacetConfiguration hierarchicalSidebarFacetConfiguration = + (HierarchicalSidebarFacetConfiguration) searchFilter; + String[] subValues = value.split(hierarchicalSidebarFacetConfiguration.getSplitter()); + if (hierarchicalSidebarFacetConfiguration + .isSkipFirstNodeLevel() && 1 < subValues.length) { + //Remove the first element of our array + subValues = (String[]) ArrayUtils.subarray(subValues, 1, subValues.length); + } + for (int i = 0; i < subValues.length; i++) { + StringBuilder valueBuilder = new StringBuilder(); + for (int j = 0; j <= i; j++) { + valueBuilder.append(subValues[j]); + if (j < i) { + valueBuilder.append(hierarchicalSidebarFacetConfiguration.getSplitter()); + } + } + + String indexValue = valueBuilder.toString().trim(); + doc.addField(searchFilter.getIndexFieldName() + "_tax_" + i + "_filter", + indexValue.toLowerCase() + separator + indexValue); + //We add the field x times that it has occurred + for (int j = i; j < subValues.length; j++) { + doc.addField(searchFilter.getIndexFieldName() + "_filter", + indexValue.toLowerCase() + separator + indexValue); + doc.addField(searchFilter.getIndexFieldName() + "_keyword", indexValue); + } + } + } + } + } + } + + if ((sortFields.get(field) != null || recentSubmissionsConfigurationMap + .get(field) != null) && !sortFieldsAdded.contains(field)) { + //Only add sort value once + String type; + if (sortFields.get(field) != null) { + type = sortFields.get(field).getType(); + } else { + type = recentSubmissionsConfigurationMap.get(field).getType(); + } + + if (type.equals(DiscoveryConfigurationParameters.TYPE_DATE)) { + Date date = MultiFormatDateParser.parse(value); + if (date != null) { + String stringDate = SolrUtils.getDateFormatter().format(date); + doc.addField(field + "_dt", stringDate); + } else { + log.warn("Error while indexing sort date field, item: " + item + .getHandle() + " metadata field: " + field + " date value: " + date); + } + } else { + doc.addField(field + "_sort", value); + } + sortFieldsAdded.add(field); + } + + if (hitHighlightingFields.contains(field) || hitHighlightingFields + .contains("*") || hitHighlightingFields.contains(unqualifiedField + "." + Item.ANY)) { + if (authority != null) { + doc.addField(field + "_hl", value + SearchUtils.AUTHORITY_SEPARATOR + authority); + } else { + doc.addField(field + "_hl", value); + } + } + + if (moreLikeThisFields.contains(field) || moreLikeThisFields + .contains(unqualifiedField + "." + Item.ANY)) { + doc.addField(field + "_mlt", value); + } + + doc.addField(field, value); + if (authority != null) { + doc.addField(field + "_authority", authority); + } + if (toProjectionFields.contains(field) || toProjectionFields + .contains(unqualifiedField + "." + Item.ANY)) { + StringBuffer variantsToStore = new StringBuffer(); + if (variants != null) { + for (String var : variants) { + variantsToStore.append(VARIANTS_STORE_SEPARATOR); + variantsToStore.append(var); + } + } + doc.addField( + field + "_stored", + value + STORE_SEPARATOR + preferedLabel + + STORE_SEPARATOR + + (variantsToStore.length() > VARIANTS_STORE_SEPARATOR + .length() ? variantsToStore + .substring(VARIANTS_STORE_SEPARATOR + .length()) : "null") + + STORE_SEPARATOR + authority + + STORE_SEPARATOR + meta.getLanguage()); + } + + if (meta.getLanguage() != null && !meta.getLanguage().trim().equals("")) { + String langField = field + "." + meta.getLanguage(); + doc.addField(langField, value); + } + } + + } catch (Exception e) { + log.error(LogManager.getHeader(context, "item_metadata_discovery_error", + "Item identifier: " + item.getID()), e); + } + + + log.debug(" Added Metadata"); + + try { + + List values = itemService.getMetadataByMetadataString(item, "dc.relation.ispartof"); + + if (values != null && values.size() > 0 && values.get(0) != null && values.get(0).getValue() != null) { + // group on parent + String handlePrefix = handleService.getCanonicalPrefix(); + + doc.addField("publication_grp", values.get(0).getValue().replaceFirst(handlePrefix, "")); + + } else { + // group on self + doc.addField("publication_grp", item.getHandle()); + } + + } catch (Exception e) { + log.error(LogManager.getHeader(context, "item_publication_group_discovery_error", + "Item identifier: " + item.getID()), e); + } + + + log.debug(" Added Grouping"); + } + + @Override + public void writeDocument(Context context, IndexableItem indexableObject, SolrInputDocument solrInputDocument) + throws SQLException, IOException, SolrServerException { + writeDocument(solrInputDocument, new FullTextContentStreams(context, indexableObject.getIndexedObject())); + } + + @Override + public List getLocations(Context context, IndexableItem indexableDSpaceObject) + throws SQLException { + final Item item = indexableDSpaceObject.getIndexedObject(); + List locations = new ArrayList<>(); + + // build list of community ids + List communities = itemService.getCommunities(context, item); + + // build list of collection ids + List collections = item.getCollections(); + + // now put those into strings + int i = 0; + + for (i = 0; i < communities.size(); i++) { + locations.add("m" + communities.get(i).getID()); + } + + for (i = 0; i < collections.size(); i++) { + locations.add("l" + collections.get(i).getID()); + } + + return locations; + } + + @Override + public void delete(IndexableItem indexableObject) throws IOException, SolrServerException { + super.delete(indexableObject); + deleteInProgressData(indexableObject.getUniqueIndexID()); + } + + private void deleteInProgressData(String indexableObjectIdentifier) throws SolrServerException, IOException { + // Also delete any possible workflowItem / workspaceItem / tasks related to this item + String query = "inprogress.item:\"" + indexableObjectIdentifier + "\""; + log.debug("Try to delete all in progress submission [DELETEBYQUERY]:" + query); + solrSearchCore.getSolr().deleteByQuery(query); + } + + @Override + public void delete(String indexableObjectIdentifier) throws IOException, SolrServerException { + super.delete(indexableObjectIdentifier); + deleteInProgressData(indexableObjectIdentifier); + } + + @Override + public boolean supports(Object object) { + return object instanceof Item; + } + + @Override + public List getIndexableObjects(Context context, Item object) throws SQLException { + List results = new ArrayList<>(); + if (object.isArchived() || object.isWithdrawn()) { + // We only want to index an item as an item if it is not in workflow + results.addAll(Arrays.asList(new IndexableItem(object))); + } else { + // Check if we have a workflow / workspace item + final WorkspaceItem workspaceItem = workspaceItemService.findByItem(context, object); + if (workspaceItem != null) { + results.addAll(workspaceItemIndexFactory.getIndexableObjects(context, workspaceItem)); + } else { + // Check if we a workflow item + final XmlWorkflowItem xmlWorkflowItem = xmlWorkflowItemService.findByItem(context, object); + if (xmlWorkflowItem != null) { + results.addAll(workflowItemIndexFactory.getIndexableObjects(context, xmlWorkflowItem)); + } + } + } + + return results; + } + + @Override + public Optional findIndexableObject(Context context, String id) throws SQLException { + final Item item = itemService.find(context, UUID.fromString(id)); + return item == null ? Optional.empty() : Optional.of(new IndexableItem(item)); + } +} diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/PoolTaskIndexFactoryImpl.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/PoolTaskIndexFactoryImpl.java new file mode 100644 index 0000000000..e7f2f0a14c --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/PoolTaskIndexFactoryImpl.java @@ -0,0 +1,104 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject; + +import java.io.IOException; +import java.sql.SQLException; +import java.util.Arrays; +import java.util.Iterator; +import java.util.List; +import java.util.Optional; + +import org.apache.commons.lang3.StringUtils; +import org.apache.solr.common.SolrInputDocument; +import org.dspace.core.Context; +import org.dspace.discovery.indexobject.factory.PoolTaskIndexFactory; +import org.dspace.discovery.indexobject.factory.WorkflowItemIndexFactory; +import org.dspace.services.factory.DSpaceServicesFactory; +import org.dspace.xmlworkflow.storedcomponents.PoolTask; +import org.dspace.xmlworkflow.storedcomponents.service.PoolTaskService; +import org.springframework.beans.factory.annotation.Autowired; + +/** + * Factory implementation for indexing/retrieving pooled tasks in the search core + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public class PoolTaskIndexFactoryImpl extends IndexFactoryImpl + implements PoolTaskIndexFactory { + + @Autowired + protected PoolTaskService poolTaskService; + + @Autowired + WorkflowItemIndexFactory indexableWorkflowItemService; + + @Override + public Iterator findAll(Context context) throws SQLException { + final Iterator pooledTasks = poolTaskService.findAll(context).iterator(); + return new Iterator() { + @Override + public boolean hasNext() { + return pooledTasks.hasNext(); + } + + @Override + public IndexablePoolTask next() { + return new IndexablePoolTask(pooledTasks.next()); + } + }; + } + + @Override + public String getType() { + return IndexablePoolTask.TYPE; + } + + @Override + public SolrInputDocument buildDocument(Context context, IndexablePoolTask indexableObject) + throws SQLException, IOException { + // Add the ID's, types and call the SolrServiceIndexPlugins + final SolrInputDocument doc = super.buildDocument(context, indexableObject); + final PoolTask poolTask = indexableObject.getIndexedObject(); + // Add submitter, locations and modification time + indexableWorkflowItemService.storeInprogressItemFields(context, doc, poolTask.getWorkflowItem()); + + addFacetIndex(doc, "action", poolTask.getActionID(), poolTask.getActionID()); + addFacetIndex(doc, "step", poolTask.getStepID(), poolTask.getStepID()); + if (poolTask.getEperson() != null) { + doc.addField("taskfor", "e" + poolTask.getEperson().getID().toString()); + } + if (poolTask.getGroup() != null) { + doc.addField("taskfor", "g" + poolTask.getGroup().getID().toString()); + } + + String acvalue = DSpaceServicesFactory.getInstance().getConfigurationService() + .getProperty("discovery.facet.namedtype.workflow.pooled"); + if (StringUtils.isBlank(acvalue)) { + acvalue = indexableObject.getTypeText(); + } + addNamedResourceTypeIndex(doc, acvalue); + + return doc; + } + + @Override + public boolean supports(Object object) { + return object instanceof PoolTask; + } + + @Override + public List getIndexableObjects(Context context, PoolTask object) { + return Arrays.asList(new IndexablePoolTask(object)); + } + + @Override + public Optional findIndexableObject(Context context, String id) throws SQLException { + final PoolTask poolTask = poolTaskService.find(context, Integer.parseInt(id)); + return poolTask == null ? Optional.empty() : Optional.of(new IndexablePoolTask(poolTask)); + } +} diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/WorkflowItemIndexFactoryImpl.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/WorkflowItemIndexFactoryImpl.java new file mode 100644 index 0000000000..46439f3919 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/WorkflowItemIndexFactoryImpl.java @@ -0,0 +1,121 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject; + +import java.io.IOException; +import java.sql.SQLException; +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; +import java.util.Optional; + +import org.apache.commons.lang3.StringUtils; +import org.apache.solr.common.SolrInputDocument; +import org.dspace.content.Item; +import org.dspace.core.Context; +import org.dspace.discovery.IndexableObject; +import org.dspace.discovery.SearchUtils; +import org.dspace.discovery.configuration.DiscoveryConfiguration; +import org.dspace.discovery.indexobject.factory.WorkflowItemIndexFactory; +import org.dspace.services.factory.DSpaceServicesFactory; +import org.dspace.xmlworkflow.storedcomponents.ClaimedTask; +import org.dspace.xmlworkflow.storedcomponents.PoolTask; +import org.dspace.xmlworkflow.storedcomponents.XmlWorkflowItem; +import org.dspace.xmlworkflow.storedcomponents.service.ClaimedTaskService; +import org.dspace.xmlworkflow.storedcomponents.service.PoolTaskService; +import org.dspace.xmlworkflow.storedcomponents.service.XmlWorkflowItemService; +import org.springframework.beans.factory.annotation.Autowired; + +/** + * Factory implementation for indexing/retrieving workflow items in the search core + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public class WorkflowItemIndexFactoryImpl + extends InprogressSubmissionIndexFactoryImpl + implements WorkflowItemIndexFactory { + + @Autowired + protected XmlWorkflowItemService workflowItemService; + @Autowired + protected ClaimedTaskService claimedTaskService; + @Autowired + protected PoolTaskService poolTaskService; + + @Override + public Iterator findAll(Context context) throws SQLException { + final Iterator workflowItems = workflowItemService.findAll(context).iterator(); + + return new Iterator() { + @Override + public boolean hasNext() { + return workflowItems.hasNext(); + } + + @Override + public IndexableWorkflowItem next() { + return new IndexableWorkflowItem(workflowItems.next()); + } + }; + } + + @Override + public String getType() { + return IndexableWorkflowItem.TYPE; + } + + @Override + public SolrInputDocument buildDocument(Context context, IndexableWorkflowItem indexableObject) + throws SQLException, IOException { + // Add the ID's, types and call the SolrServiceIndexPlugins + final SolrInputDocument doc = super.buildDocument(context, indexableObject); + final XmlWorkflowItem workflowItem = indexableObject.getIndexedObject(); + final Item item = workflowItem.getItem(); + // Add the item metadata as configured + List discoveryConfigurations = SearchUtils + .getAllDiscoveryConfigurations(workflowItem); + indexableItemService.addDiscoveryFields(doc, context, item, discoveryConfigurations); + + String acvalue = DSpaceServicesFactory.getInstance().getConfigurationService() + .getProperty("discovery.facet.namedtype.workflow.item"); + if (StringUtils.isBlank(acvalue)) { + acvalue = indexableObject.getTypeText(); + } + addNamedResourceTypeIndex(doc, acvalue); + + return doc; + } + + @Override + public boolean supports(Object object) { + return object instanceof XmlWorkflowItem; + } + + @Override + public List getIndexableObjects(Context context, XmlWorkflowItem object) throws SQLException { + List results = new ArrayList<>(); + results.add(new IndexableWorkflowItem(object)); + + List pools = poolTaskService.find(context, object); + for (PoolTask poolTask : pools) { + results.add(new IndexablePoolTask(poolTask)); + } + + List claimedTasks = claimedTaskService.find(context, object); + for (ClaimedTask claimedTask : claimedTasks) { + results.add(new IndexableClaimedTask(claimedTask)); + } + + return results; + } + + @Override + public Optional findIndexableObject(Context context, String id) throws SQLException { + final XmlWorkflowItem xmlWorkflowItem = workflowItemService.find(context, Integer.parseInt(id)); + return xmlWorkflowItem == null ? Optional.empty() : Optional.of(new IndexableWorkflowItem(xmlWorkflowItem)); + } +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/WorkspaceItemIndexFactoryImpl.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/WorkspaceItemIndexFactoryImpl.java new file mode 100644 index 0000000000..08cb484497 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/WorkspaceItemIndexFactoryImpl.java @@ -0,0 +1,99 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject; + +import java.io.IOException; +import java.sql.SQLException; +import java.util.Arrays; +import java.util.Iterator; +import java.util.List; +import java.util.Optional; + +import org.apache.commons.lang3.StringUtils; +import org.apache.solr.common.SolrInputDocument; +import org.dspace.content.WorkspaceItem; +import org.dspace.content.service.WorkspaceItemService; +import org.dspace.core.Context; +import org.dspace.discovery.SearchUtils; +import org.dspace.discovery.configuration.DiscoveryConfiguration; +import org.dspace.discovery.indexobject.factory.WorkspaceItemIndexFactory; +import org.dspace.services.factory.DSpaceServicesFactory; +import org.springframework.beans.factory.annotation.Autowired; + +/** + * Factory implementation for indexing/retrieving workspace items in the search core + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public class WorkspaceItemIndexFactoryImpl + extends InprogressSubmissionIndexFactoryImpl + implements WorkspaceItemIndexFactory { + + @Autowired + protected WorkspaceItemService workspaceItemService; + + @Override + public Iterator findAll(Context context) throws SQLException { + final Iterator workspaceItems = workspaceItemService.findAll(context).iterator(); + + return new Iterator() { + @Override + public boolean hasNext() { + return workspaceItems.hasNext(); + } + + @Override + public IndexableWorkspaceItem next() { + return new IndexableWorkspaceItem(workspaceItems.next()); + } + }; + } + + @Override + public String getType() { + return IndexableWorkspaceItem.TYPE; + } + + @Override + public SolrInputDocument buildDocument(Context context, IndexableWorkspaceItem indexableObject) + throws SQLException, IOException { + // Add the ID's, types and call the SolrServiceIndexPlugins + final SolrInputDocument doc = super.buildDocument(context, indexableObject); + + // Add the object type + String acvalue = DSpaceServicesFactory.getInstance().getConfigurationService() + .getProperty("discovery.facet.namedtype.workspace"); + if (StringUtils.isBlank(acvalue)) { + acvalue = indexableObject.getTypeText(); + } + addNamedResourceTypeIndex(doc, acvalue); + final WorkspaceItem inProgressSubmission = indexableObject.getIndexedObject(); + + // Add the item metadata as configured + List discoveryConfigurations = SearchUtils + .getAllDiscoveryConfigurations(inProgressSubmission); + indexableItemService.addDiscoveryFields(doc, context, inProgressSubmission.getItem(), discoveryConfigurations); + + return doc; + } + + @Override + public boolean supports(Object object) { + return object instanceof WorkspaceItem; + } + + @Override + public List getIndexableObjects(Context context, WorkspaceItem object) { + return Arrays.asList(new IndexableWorkspaceItem(object)); + } + + @Override + public Optional findIndexableObject(Context context, String id) throws SQLException { + final WorkspaceItem workspaceItem = workspaceItemService.find(context, Integer.parseInt(id)); + return workspaceItem == null ? Optional.empty() : Optional.of(new IndexableWorkspaceItem(workspaceItem)); + } +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/ClaimedTaskIndexFactory.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/ClaimedTaskIndexFactory.java new file mode 100644 index 0000000000..3aac462fc2 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/ClaimedTaskIndexFactory.java @@ -0,0 +1,19 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject.factory; + +import org.dspace.discovery.indexobject.IndexableClaimedTask; +import org.dspace.xmlworkflow.storedcomponents.ClaimedTask; + +/** + * Factory interface for indexing/retrieving claimed tasks in the search core + * + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public interface ClaimedTaskIndexFactory extends IndexFactory { +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/CollectionIndexFactory.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/CollectionIndexFactory.java new file mode 100644 index 0000000000..ef60736293 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/CollectionIndexFactory.java @@ -0,0 +1,32 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject.factory; + +import java.sql.SQLException; +import java.util.List; + +import org.dspace.content.Collection; +import org.dspace.core.Context; +import org.dspace.discovery.indexobject.IndexableCollection; + +/** + * Factory interface for indexing/retrieving collections in the search core + * + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public interface CollectionIndexFactory extends DSpaceObjectIndexFactory { + + /** + * Return a list of the identifiers of the owning communities from the provided collection prepended by "m" + * @param context DSpace context object + * @param collection DSpace collection + * @return A list of community identifiers with "m" prepended to every one + * @throws SQLException If database error + */ + public List getCollectionLocations(Context context, Collection collection) throws SQLException; +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/CommunityIndexFactory.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/CommunityIndexFactory.java new file mode 100644 index 0000000000..d0002b5267 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/CommunityIndexFactory.java @@ -0,0 +1,19 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject.factory; + +import org.dspace.content.Community; +import org.dspace.discovery.indexobject.IndexableCommunity; + +/** + * Factory interface for indexing/retrieving communities in the search core + * + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public interface CommunityIndexFactory extends DSpaceObjectIndexFactory { +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/DSpaceObjectIndexFactory.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/DSpaceObjectIndexFactory.java new file mode 100644 index 0000000000..92e8b80207 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/DSpaceObjectIndexFactory.java @@ -0,0 +1,42 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject.factory; + +import java.sql.SQLException; +import java.util.List; + +import org.apache.solr.common.SolrInputDocument; +import org.dspace.content.DSpaceObject; +import org.dspace.core.Context; +import org.dspace.discovery.indexobject.IndexableDSpaceObject; + +/** + * Factory interface for indexing/retrieving DSpaceObjects in the search core + * + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public interface DSpaceObjectIndexFactory + extends IndexFactory { + + + /** + * Return a list of the identifiers from the parents for the provided IndexableObject, + * communities will be prepended by "m", collections b "c" + * @param context DSpace context object + * @return A list of community identifiers with "m" prepended to every one + * @throws SQLException If database error + */ + List getLocations(Context context, T indexableDSpaceObject) throws SQLException; + + /** + * Store the provided locations in the solr document + * @param doc The solr input document + * @param locations The locations to be stored + */ + void storeCommunityCollectionLocations(SolrInputDocument doc, List locations); +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/IndexFactory.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/IndexFactory.java new file mode 100644 index 0000000000..6644da248d --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/IndexFactory.java @@ -0,0 +1,108 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject.factory; + +import java.io.IOException; +import java.sql.SQLException; +import java.util.Iterator; +import java.util.List; +import java.util.Optional; + +import org.apache.solr.client.solrj.SolrServerException; +import org.apache.solr.common.SolrInputDocument; +import org.dspace.core.Context; +import org.dspace.discovery.IndexableObject; + +/** + * Basis factory interface for indexing/retrieving any IndexableObject in the search core + * + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public interface IndexFactory { + + /** + * Retrieve all instances of a certain indexable object type + * @param context DSpace context object + * @return An iterator containing all the objects to be indexed for the indexable object + * @throws SQLException If database error + */ + Iterator findAll(Context context) throws SQLException; + + /** + * Return the type of the indexable object + * @return a string containing the type + */ + String getType(); + + /** + * Create solr document with all the shared fields initialized. + * @param indexableObject the indexableObject that we want to index + * @return initialized solr document + */ + SolrInputDocument buildDocument(Context context, T indexableObject) throws SQLException, IOException; + + /** + * Write the provided document to the solr core + * @param context DSpace context object + * @param indexableObject The indexable object that we want to store in the search core + * @param solrInputDocument Solr input document which will be written to our discovery search core + * @throws SQLException If database error + * @throws IOException If IO error + * @throws SolrServerException If the solr document could not be written to the search core + */ + void writeDocument(Context context, T indexableObject, SolrInputDocument solrInputDocument) + throws SQLException, IOException, SolrServerException; + + /** + * Remove the provided indexable object from the solr core + * @param indexableObject The indexable object that we want to remove from the search core + * @throws IOException If IO error + * @throws SolrServerException If the solr document could not be removed to the search core + */ + void delete(T indexableObject) throws IOException, SolrServerException; + + /** + * Remove the provided indexable object from the solr core + * @param indexableObjectIdentifier The identifier that we want to remove from the search core + * @throws IOException If IO error + * @throws SolrServerException If the solr document could not be removed to the search core + */ + void delete(String indexableObjectIdentifier) throws IOException, SolrServerException; + + /** + * Remove all indexable objects of the implementing type from the search core + * @throws IOException If IO error + * @throws SolrServerException If the solr document could not be removed to the search core + */ + void deleteAll() throws IOException, SolrServerException; + + /** + * Retrieve a single indexable object using the provided identifier + * @param context DSpace context object + * @param id The identifier for which we want to retrieve our indexable object + * @return An indexable object + * @throws SQLException If database error + */ + Optional findIndexableObject(Context context, String id) throws SQLException; + + /** + * Determine whether the class can handle the factory implementation + * @param object The object which we want to check + * @return True if the factory implementation can handle the given object. False if it doesn't. + */ + boolean supports(Object object); + + /** + * Retrieve all the indexable objects for the provided object + * @param context DSpace context object + * @param object The object we want to retrieve our indexable objects for + * @return A list of indexable objects + * @throws SQLException If database error + */ + List getIndexableObjects(Context context, S object) throws SQLException; +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/IndexObjectFactoryFactory.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/IndexObjectFactoryFactory.java new file mode 100644 index 0000000000..1152dffbd3 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/IndexObjectFactoryFactory.java @@ -0,0 +1,102 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject.factory; + +import java.sql.SQLException; +import java.util.List; + +import org.apache.commons.lang3.StringUtils; +import org.dspace.content.service.WorkspaceItemService; +import org.dspace.core.Context; +import org.dspace.discovery.IndexableObject; +import org.dspace.services.factory.DSpaceServicesFactory; +import org.dspace.xmlworkflow.storedcomponents.service.ClaimedTaskService; +import org.dspace.xmlworkflow.storedcomponents.service.PoolTaskService; +import org.dspace.xmlworkflow.storedcomponents.service.XmlWorkflowItemService; +import org.springframework.beans.factory.annotation.Autowired; + +/** + * Abstract factory to get the IndexFactory objects + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public abstract class IndexObjectFactoryFactory { + + @Autowired + protected WorkspaceItemService workspaceItemService; + @Autowired + protected XmlWorkflowItemService xmlWorkflowItemService; + @Autowired + protected ClaimedTaskService claimedTaskService; + @Autowired + protected PoolTaskService poolTaskService; + + /** + * Return the list of all the available implementations of the IndexableObjectService interface + * + * @return the list of IndexableObjectService + */ + public abstract List getIndexFactories(); + + /** + * Retrieve the IndexFactory implementation for the given indexable object + * @param indexableObject the indexable object for which we need our factory + * @return An IndexFactory implementation + */ + public IndexFactory getIndexableObjectFactory(IndexableObject indexableObject) { + return getIndexableObjectFactory(indexableObject.getType()); + } + + /** + * Retrieve the IndexFactory implementation for the given indexable object unique identifier + * @param indexableObjectUniqueString the unique identifier of an indexable object + * @return An IndexFactory implementation + */ + public IndexFactory getIndexableObjectFactory(String indexableObjectUniqueString) { + // The unique identifier of an IndexableObject will always be {type}-{identifier} + return getIndexFactoryByType(StringUtils.substringBefore(indexableObjectUniqueString, "-")); + } + + /** + * Retrieve the IndexFactory implementation for the given indexable object type + * @param indexableFactoryType the object type of the indexable object + * @return An IndexFactory implementation + */ + public IndexFactory getIndexFactoryByType(String indexableFactoryType) { + for (IndexFactory indexableObjectFactory : getIndexFactories()) { + if (indexableObjectFactory.getType().equals(indexableFactoryType)) { + return indexableObjectFactory; + } + } + return null; + } + + /** + * Retrieve all the indexable objects for the provided object + * @param context DSpace context object + * @param object The object we want to retrieve our indexable objects for + * @return A list of indexable objects + */ + public List getIndexableObjects(Context context, Object object) throws SQLException { + for (IndexFactory indexableObjectFactory : getIndexFactories()) { + if (indexableObjectFactory.supports(object)) { + return indexableObjectFactory.getIndexableObjects(context, object); + } + } + throw new IllegalArgumentException("The object: " + object.getClass().getName() + + " cannot be indexed"); + } + + /** + * Retrieve an implementation instance for this factory + * @return an IndexObjectServiceFactory bean + */ + public static IndexObjectFactoryFactory getInstance() { + return DSpaceServicesFactory.getInstance().getServiceManager() + .getServiceByName("indexObjectFactoryFactory", IndexObjectFactoryFactory.class); + } +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/IndexObjectFactoryFactoryImpl.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/IndexObjectFactoryFactoryImpl.java new file mode 100644 index 0000000000..a199424991 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/IndexObjectFactoryFactoryImpl.java @@ -0,0 +1,27 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject.factory; + +import java.util.List; + +import org.springframework.beans.factory.annotation.Autowired; + +/** + * Abstract factory implementation to get the IndexFactory objects + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public class IndexObjectFactoryFactoryImpl extends IndexObjectFactoryFactory { + + @Autowired + List indexableObjectServices; + + @Override + public List getIndexFactories() { + return indexableObjectServices; + } +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/InprogressSubmissionIndexFactory.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/InprogressSubmissionIndexFactory.java new file mode 100644 index 0000000000..b858b54280 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/InprogressSubmissionIndexFactory.java @@ -0,0 +1,35 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject.factory; + +import java.sql.SQLException; + +import org.apache.solr.common.SolrInputDocument; +import org.dspace.content.InProgressSubmission; +import org.dspace.core.Context; +import org.dspace.discovery.indexobject.IndexableInProgressSubmission; + +/** + * Factory interface for indexing/retrieving InProgresssSubmission objects in the search core + * + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public interface InprogressSubmissionIndexFactory + extends IndexFactory { + + /** + * Store common fields between workspace / workflow items in the solr document + * @param context DSpace context object + * @param doc Solr input document which will be written to our discovery solr core + * @param inProgressSubmission the workspace / workflow item + * @throws SQLException If database error + */ + void storeInprogressItemFields(Context context, SolrInputDocument doc, InProgressSubmission inProgressSubmission) + throws SQLException; +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/ItemIndexFactory.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/ItemIndexFactory.java new file mode 100644 index 0000000000..4bf24b3c6d --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/ItemIndexFactory.java @@ -0,0 +1,41 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject.factory; + +import java.io.IOException; +import java.sql.SQLException; +import java.util.List; + +import org.apache.solr.common.SolrInputDocument; +import org.dspace.content.Item; +import org.dspace.core.Context; +import org.dspace.discovery.configuration.DiscoveryConfiguration; +import org.dspace.discovery.indexobject.IndexableItem; + +/** + * Factory interface for indexing/retrieving items in the search core + * + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public interface ItemIndexFactory extends DSpaceObjectIndexFactory { + + /** + * Store item fields in the solr document + * @param doc Solr input document which will be written to our discovery solr core + * @param context DSpace context object + * @param item Item for which we want to index our fields in the provided solr document + * @param discoveryConfigurations The discovery configuration which holds information + * for which item fields we should index + * @throws SQLException If database error + * @throws IOException If IO error + */ + void addDiscoveryFields(SolrInputDocument doc, Context context, Item item, + List discoveryConfigurations) + throws SQLException, IOException; + +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/PoolTaskIndexFactory.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/PoolTaskIndexFactory.java new file mode 100644 index 0000000000..203f13e61a --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/PoolTaskIndexFactory.java @@ -0,0 +1,19 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject.factory; + +import org.dspace.discovery.indexobject.IndexablePoolTask; +import org.dspace.xmlworkflow.storedcomponents.PoolTask; + +/** + * Factory interface for indexing/retrieving Pooltask objects in the search core + * + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public interface PoolTaskIndexFactory extends IndexFactory { +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/WorkflowItemIndexFactory.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/WorkflowItemIndexFactory.java new file mode 100644 index 0000000000..2a2f695ed8 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/WorkflowItemIndexFactory.java @@ -0,0 +1,20 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject.factory; + +import org.dspace.discovery.indexobject.IndexableWorkflowItem; +import org.dspace.xmlworkflow.storedcomponents.XmlWorkflowItem; + +/** + * Factory interface for indexing/retrieving workflow items objects in the search core + * + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public interface WorkflowItemIndexFactory + extends InprogressSubmissionIndexFactory { +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/WorkspaceItemIndexFactory.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/WorkspaceItemIndexFactory.java new file mode 100644 index 0000000000..0cb3b985e2 --- /dev/null +++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/factory/WorkspaceItemIndexFactory.java @@ -0,0 +1,20 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.discovery.indexobject.factory; + +import org.dspace.content.WorkspaceItem; +import org.dspace.discovery.indexobject.IndexableWorkspaceItem; + +/** + * Factory interface for indexing/retrieving workspace item objects in the search core + * + * @author Kevin Van de Velde (kevin at atmire dot com) + */ +public interface WorkspaceItemIndexFactory + extends InprogressSubmissionIndexFactory { +} \ No newline at end of file diff --git a/dspace-api/src/main/java/org/dspace/external/provider/impl/OrcidV2AuthorDataProvider.java b/dspace-api/src/main/java/org/dspace/external/provider/impl/OrcidV2AuthorDataProvider.java index e6825a2264..471a7e2512 100644 --- a/dspace-api/src/main/java/org/dspace/external/provider/impl/OrcidV2AuthorDataProvider.java +++ b/dspace-api/src/main/java/org/dspace/external/provider/impl/OrcidV2AuthorDataProvider.java @@ -132,7 +132,7 @@ public class OrcidV2AuthorDataProvider implements ExternalDataProvider { } externalDataObject.setId(person.getName().getPath()); externalDataObject - .addMetadata(new MetadataValueDTO("dc", "identifier", "orcid", null, person.getName().getPath())); + .addMetadata(new MetadataValueDTO("person", "identifier", "orcid", null, person.getName().getPath())); externalDataObject .addMetadata(new MetadataValueDTO("dc", "identifier", "uri", null, orcidUrl + person.getName().getPath())); if (!StringUtils.isBlank(lastName) && !StringUtils.isBlank(firstName)) { diff --git a/dspace-api/src/main/java/org/dspace/external/service/ExternalDataService.java b/dspace-api/src/main/java/org/dspace/external/service/ExternalDataService.java index bfcfeb6407..e0c241ba4a 100644 --- a/dspace-api/src/main/java/org/dspace/external/service/ExternalDataService.java +++ b/dspace-api/src/main/java/org/dspace/external/service/ExternalDataService.java @@ -13,7 +13,7 @@ import java.util.Optional; import org.dspace.authorize.AuthorizeException; import org.dspace.content.Collection; -import org.dspace.content.Item; +import org.dspace.content.WorkspaceItem; import org.dspace.core.Context; import org.dspace.external.model.ExternalDataObject; import org.dspace.external.provider.ExternalDataProvider; @@ -66,8 +66,7 @@ public interface ExternalDataService { public int getNumberOfResults(String source, String query); /** - * This method will create an Item in the given Collection based on the given ExternalDataObject. - * Note that this Item will be Archived + * This method will create a WorkspaceItem in the given Collection based on the given ExternalDataObject. * @param context The relevant DSpace context * @param externalDataObject The relevant ExternalDataObject to be used * @param collection The Collection in which the item will be present @@ -75,6 +74,7 @@ public interface ExternalDataService { * @throws AuthorizeException If something goes wrong * @throws SQLException If something goes wrong */ - Item createItemFromExternalDataObject(Context context, ExternalDataObject externalDataObject, Collection collection) + WorkspaceItem createWorkspaceItemFromExternalDataObject(Context context, ExternalDataObject externalDataObject, + Collection collection) throws AuthorizeException, SQLException; } diff --git a/dspace-api/src/main/java/org/dspace/external/service/impl/ExternalDataServiceImpl.java b/dspace-api/src/main/java/org/dspace/external/service/impl/ExternalDataServiceImpl.java index 587fe5cd0e..6375334fd2 100644 --- a/dspace-api/src/main/java/org/dspace/external/service/impl/ExternalDataServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/external/service/impl/ExternalDataServiceImpl.java @@ -18,7 +18,6 @@ import org.dspace.content.Collection; import org.dspace.content.Item; import org.dspace.content.WorkspaceItem; import org.dspace.content.dto.MetadataValueDTO; -import org.dspace.content.service.InstallItemService; import org.dspace.content.service.ItemService; import org.dspace.content.service.WorkspaceItemService; import org.dspace.core.Context; @@ -44,9 +43,6 @@ public class ExternalDataServiceImpl implements ExternalDataService { @Autowired private WorkspaceItemService workspaceItemService; - @Autowired - private InstallItemService installItemService; - @Autowired private AuthorizeService authorizeService; @@ -95,8 +91,9 @@ public class ExternalDataServiceImpl implements ExternalDataService { @Override - public Item createItemFromExternalDataObject(Context context, ExternalDataObject externalDataObject, - Collection collection) + public WorkspaceItem createWorkspaceItemFromExternalDataObject(Context context, + ExternalDataObject externalDataObject, + Collection collection) throws AuthorizeException, SQLException { if (!authorizeService.isAdmin(context)) { throw new AuthorizeException("You have to be an admin to create an Item from an ExternalDataObject"); @@ -113,6 +110,6 @@ public class ExternalDataServiceImpl implements ExternalDataService { log.info(LogManager.getHeader(context, "create_item_from_externalDataObject", "Created item" + "with id: " + item.getID() + " from source: " + externalDataObject.getSource() + " with identifier: " + externalDataObject.getId())); - return installItemService.installItem(context, workspaceItem); + return workspaceItem; } } diff --git a/dspace-api/src/main/java/org/dspace/search/Harvest.java b/dspace-api/src/main/java/org/dspace/search/Harvest.java index 493a7d39a6..a0b3698592 100644 --- a/dspace-api/src/main/java/org/dspace/search/Harvest.java +++ b/dspace-api/src/main/java/org/dspace/search/Harvest.java @@ -31,6 +31,8 @@ import org.dspace.discovery.DiscoverResult; import org.dspace.discovery.IndexableObject; import org.dspace.discovery.SearchServiceException; import org.dspace.discovery.SearchUtils; +import org.dspace.discovery.indexobject.IndexableDSpaceObject; +import org.dspace.discovery.indexobject.IndexableItem; import org.dspace.eperson.Group; import org.dspace.handle.factory.HandleServiceFactory; import org.dspace.handle.service.HandleService; @@ -97,7 +99,7 @@ public class Harvest { boolean items, boolean collections, boolean withdrawn, boolean nonAnon) throws SQLException, ParseException { DiscoverQuery discoverQuery = new DiscoverQuery(); - discoverQuery.addFilterQueries("search.resourcetype:" + Constants.ITEM); + discoverQuery.addFilterQueries("search.resourcetype:" + IndexableItem.TYPE); if (scope != null) { if (scope instanceof Community) { @@ -143,13 +145,13 @@ public class Harvest { Iterator dsoIterator = discoverResult.getIndexableObjects().iterator(); while (dsoIterator.hasNext() && ((limit == 0) || (itemCounter < limit))) { // the query is limited to ITEM - DSpaceObject dso = (DSpaceObject) dsoIterator.next(); + IndexableDSpaceObject indexableDSpaceObject = (IndexableDSpaceObject) dsoIterator.next(); HarvestedItemInfo itemInfo = new HarvestedItemInfo(); itemInfo.context = context; - itemInfo.handle = dso.getHandle(); - itemInfo.itemID = dso.getID(); - itemInfo.datestamp = ((Item) dso).getLastModified(); - itemInfo.withdrawn = ((Item) dso).isWithdrawn(); + itemInfo.handle = indexableDSpaceObject.getIndexedObject().getHandle(); + itemInfo.itemID = indexableDSpaceObject.getID(); + itemInfo.datestamp = ((IndexableItem) indexableDSpaceObject).getIndexedObject().getLastModified(); + itemInfo.withdrawn = ((IndexableItem) indexableDSpaceObject).getIndexedObject().isWithdrawn(); if (collections) { // Add collections data diff --git a/dspace-api/src/main/java/org/dspace/storage/bitstore/BitstreamStorageServiceImpl.java b/dspace-api/src/main/java/org/dspace/storage/bitstore/BitstreamStorageServiceImpl.java index c63b4ebe7e..a0d9101fb8 100644 --- a/dspace-api/src/main/java/org/dspace/storage/bitstore/BitstreamStorageServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/storage/bitstore/BitstreamStorageServiceImpl.java @@ -16,6 +16,8 @@ import java.util.List; import java.util.Map; import java.util.UUID; +import javax.annotation.Nullable; + import org.apache.commons.collections4.MapUtils; import org.apache.logging.log4j.Logger; import org.dspace.authorize.AuthorizeException; @@ -326,15 +328,16 @@ public class BitstreamStorageServiceImpl implements BitstreamStorageService, Ini } } - public Long getLastModified(Bitstream bitstream) { - Map wantedMetadata = new HashMap(); - wantedMetadata.put("modified", null); - try { - wantedMetadata = stores.get(incoming).about(bitstream, wantedMetadata); - } catch (IOException e) { - log.error(e); + @Nullable + @Override + public Long getLastModified(Bitstream bitstream) throws IOException { + Map attrs = new HashMap(); + attrs.put("modified", null); + attrs = stores.get(bitstream.getStoreNumber()).about(bitstream, attrs); + if (attrs == null || !attrs.containsKey("modified")) { + return null; } - return Long.valueOf(wantedMetadata.get("modified").toString()); + return Long.valueOf(attrs.get("modified").toString()); } /** diff --git a/dspace-api/src/main/java/org/dspace/storage/bitstore/service/BitstreamStorageService.java b/dspace-api/src/main/java/org/dspace/storage/bitstore/service/BitstreamStorageService.java index 95963b14ca..209ef5d16b 100644 --- a/dspace-api/src/main/java/org/dspace/storage/bitstore/service/BitstreamStorageService.java +++ b/dspace-api/src/main/java/org/dspace/storage/bitstore/service/BitstreamStorageService.java @@ -12,6 +12,7 @@ import java.io.InputStream; import java.sql.SQLException; import java.util.Map; import java.util.UUID; +import javax.annotation.Nullable; import org.dspace.authorize.AuthorizeException; import org.dspace.content.Bitstream; @@ -181,11 +182,13 @@ public interface BitstreamStorageService { /** - * Get the last modified timestamp of the file linked to the given bitstream + * Gets the last modified timestamp of the the given bitstream's content, if known. * - * @param bitstream The bitstream for which to get the last modified timestamp - * @return The last modified timestamp in milliseconds + * @param bitstream the bitstream. + * @return the timestamp in milliseconds, or {@code null} if unknown. + * @throws IOException if an unexpected io error occurs. */ - public Long getLastModified(Bitstream bitstream); + @Nullable + Long getLastModified(Bitstream bitstream) throws IOException; } diff --git a/dspace-api/src/main/java/org/dspace/workflow/WorkflowItem.java b/dspace-api/src/main/java/org/dspace/workflow/WorkflowItem.java index 44315db7e8..e3d5ccde9a 100644 --- a/dspace-api/src/main/java/org/dspace/workflow/WorkflowItem.java +++ b/dspace-api/src/main/java/org/dspace/workflow/WorkflowItem.java @@ -8,13 +8,12 @@ package org.dspace.workflow; import org.dspace.content.InProgressSubmission; -import org.dspace.core.ReloadableEntity; /** * Interface representing a workflowitem, each workflowItem implementation must implement this interface. * * @author kevinvandevelde at atmire.com */ -public interface WorkflowItem extends InProgressSubmission, ReloadableEntity { +public interface WorkflowItem extends InProgressSubmission { public int getState(); } diff --git a/dspace-api/src/main/java/org/dspace/workflow/WorkflowItemService.java b/dspace-api/src/main/java/org/dspace/workflow/WorkflowItemService.java index 0a5a8297fe..48ee20b9ad 100644 --- a/dspace-api/src/main/java/org/dspace/workflow/WorkflowItemService.java +++ b/dspace-api/src/main/java/org/dspace/workflow/WorkflowItemService.java @@ -26,7 +26,7 @@ import org.dspace.eperson.EPerson; * * @author kevinvandevelde at atmire.com */ -public interface WorkflowItemService extends InProgressSubmissionService { +public interface WorkflowItemService extends InProgressSubmissionService { public T create(Context context, Item item, Collection collection) throws SQLException, AuthorizeException; diff --git a/dspace-api/src/main/java/org/dspace/workflowbasic/BasicWorkflowItem.java b/dspace-api/src/main/java/org/dspace/workflowbasic/BasicWorkflowItem.java index cdcf13ba6f..065cae25fc 100644 --- a/dspace-api/src/main/java/org/dspace/workflowbasic/BasicWorkflowItem.java +++ b/dspace-api/src/main/java/org/dspace/workflowbasic/BasicWorkflowItem.java @@ -7,8 +7,6 @@ */ package org.dspace.workflowbasic; -import java.sql.SQLException; - import javax.persistence.Column; import javax.persistence.Entity; import javax.persistence.FetchType; @@ -23,7 +21,6 @@ import javax.persistence.Table; import org.dspace.content.Collection; import org.dspace.content.Item; -import org.dspace.core.Constants; import org.dspace.core.Context; import org.dspace.eperson.EPerson; import org.dspace.workflow.WorkflowItem; @@ -152,7 +149,7 @@ public class BasicWorkflowItem implements WorkflowItem { } @Override - public EPerson getSubmitter() throws SQLException { + public EPerson getSubmitter() { return item.getSubmitter(); } @@ -185,10 +182,4 @@ public class BasicWorkflowItem implements WorkflowItem { public void setPublishedBefore(boolean b) { this.publishedBefore = b; } - - @Override - public int getType() { - return Constants.WORKFLOWITEM; - } - } diff --git a/dspace-api/src/main/java/org/dspace/workflowbasic/BasicWorkflowItemServiceImpl.java b/dspace-api/src/main/java/org/dspace/workflowbasic/BasicWorkflowItemServiceImpl.java index 8fcd64da83..2751fd33e1 100644 --- a/dspace-api/src/main/java/org/dspace/workflowbasic/BasicWorkflowItemServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/workflowbasic/BasicWorkflowItemServiceImpl.java @@ -17,7 +17,6 @@ import org.dspace.authorize.AuthorizeException; import org.dspace.content.Collection; import org.dspace.content.Item; import org.dspace.content.service.ItemService; -import org.dspace.core.Constants; import org.dspace.core.Context; import org.dspace.core.LogManager; import org.dspace.eperson.EPerson; @@ -53,11 +52,6 @@ public class BasicWorkflowItemServiceImpl implements BasicWorkflowItemService { } - @Override - public int getSupportsIndexableObjectTypeConstant() { - return Constants.WORKFLOWITEM; - } - @Override public BasicWorkflowItem create(Context context, Item item, Collection collection) throws SQLException, AuthorizeException { @@ -90,14 +84,6 @@ public class BasicWorkflowItemServiceImpl implements BasicWorkflowItemService { return workflowItem; } - @Override - public BasicWorkflowItem findIndexableObject(Context context, Integer id) throws SQLException { - if (id != null) { - return find(context, id); - } - return null; - } - @Override public List findAll(Context context) throws SQLException { return workflowItemDAO.findAll(context, BasicWorkflowItem.class); diff --git a/dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/ClaimedTask.java b/dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/ClaimedTask.java index b527fc5701..8882055f82 100644 --- a/dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/ClaimedTask.java +++ b/dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/ClaimedTask.java @@ -18,10 +18,8 @@ import javax.persistence.ManyToOne; import javax.persistence.SequenceGenerator; import javax.persistence.Table; -import org.dspace.core.Constants; import org.dspace.core.Context; import org.dspace.core.ReloadableEntity; -import org.dspace.discovery.IndexableObject; import org.dspace.eperson.EPerson; /** @@ -34,7 +32,7 @@ import org.dspace.eperson.EPerson; */ @Entity @Table(name = "cwf_claimtask") -public class ClaimedTask implements ReloadableEntity, IndexableObject { +public class ClaimedTask implements ReloadableEntity { @Id @Column(name = "claimtask_id") @@ -116,10 +114,4 @@ public class ClaimedTask implements ReloadableEntity, IndexableObject findAll(Context context) throws SQLException { + return claimedTaskDAO.findAll(context, ClaimedTask.class); } @Override diff --git a/dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/PoolTask.java b/dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/PoolTask.java index 5c9c2e79a1..2a87de51cb 100644 --- a/dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/PoolTask.java +++ b/dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/PoolTask.java @@ -19,10 +19,8 @@ import javax.persistence.OneToOne; import javax.persistence.SequenceGenerator; import javax.persistence.Table; -import org.dspace.core.Constants; import org.dspace.core.Context; import org.dspace.core.ReloadableEntity; -import org.dspace.discovery.IndexableObject; import org.dspace.eperson.EPerson; import org.dspace.eperson.Group; @@ -36,7 +34,7 @@ import org.dspace.eperson.Group; */ @Entity @Table(name = "cwf_pooltask") -public class PoolTask implements ReloadableEntity, IndexableObject { +public class PoolTask implements ReloadableEntity { @Id @Column(name = "pooltask_id") @@ -131,10 +129,4 @@ public class PoolTask implements ReloadableEntity, IndexableObject findAll(Context context) throws SQLException { + return poolTaskDAO.findAll(context, PoolTask.class); } @Override @@ -141,14 +140,6 @@ public class PoolTaskServiceImpl implements PoolTaskService { return poolTaskDAO.findByID(context, PoolTask.class, id); } - @Override - public PoolTask findIndexableObject(Context context, Integer id) throws SQLException { - if (id == null) { - return null; - } - return find(context, id.intValue()); - } - @Override public void update(Context context, PoolTask poolTask) throws SQLException, AuthorizeException { update(context, Collections.singletonList(poolTask)); diff --git a/dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/XmlWorkflowItem.java b/dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/XmlWorkflowItem.java index a0e6836656..4108500707 100644 --- a/dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/XmlWorkflowItem.java +++ b/dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/XmlWorkflowItem.java @@ -7,8 +7,6 @@ */ package org.dspace.xmlworkflow.storedcomponents; -import java.sql.SQLException; - import javax.persistence.Column; import javax.persistence.Entity; import javax.persistence.FetchType; @@ -23,10 +21,7 @@ import javax.persistence.Table; import org.dspace.content.Collection; import org.dspace.content.Item; -import org.dspace.core.Constants; import org.dspace.core.Context; -import org.dspace.core.ReloadableEntity; -import org.dspace.discovery.IndexableObject; import org.dspace.eperson.EPerson; import org.dspace.workflow.WorkflowItem; @@ -40,7 +35,7 @@ import org.dspace.workflow.WorkflowItem; */ @Entity @Table(name = "cwf_workflowitem") -public class XmlWorkflowItem implements WorkflowItem, ReloadableEntity, IndexableObject { +public class XmlWorkflowItem implements WorkflowItem { @Id @Column(name = "workflowitem_id") @@ -103,7 +98,7 @@ public class XmlWorkflowItem implements WorkflowItem, ReloadableEntity, } @Override - public EPerson getSubmitter() throws SQLException { + public EPerson getSubmitter() { return item.getSubmitter(); } @@ -143,10 +138,4 @@ public class XmlWorkflowItem implements WorkflowItem, ReloadableEntity, // simplified return 0; } - - @Override - public int getType() { - return Constants.WORKFLOWITEM; - } - } diff --git a/dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/XmlWorkflowItemServiceImpl.java b/dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/XmlWorkflowItemServiceImpl.java index 4545a5f0ce..010c310ba6 100644 --- a/dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/XmlWorkflowItemServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/XmlWorkflowItemServiceImpl.java @@ -17,7 +17,6 @@ import org.dspace.authorize.AuthorizeException; import org.dspace.content.Collection; import org.dspace.content.Item; import org.dspace.content.service.ItemService; -import org.dspace.core.Constants; import org.dspace.core.Context; import org.dspace.core.LogManager; import org.dspace.eperson.EPerson; @@ -63,11 +62,6 @@ public class XmlWorkflowItemServiceImpl implements XmlWorkflowItemService { } - @Override - public int getSupportsIndexableObjectTypeConstant() { - return Constants.WORKFLOWITEM; - } - @Override public XmlWorkflowItem create(Context context, Item item, Collection collection) throws SQLException, AuthorizeException { @@ -95,14 +89,6 @@ public class XmlWorkflowItemServiceImpl implements XmlWorkflowItemService { return workflowItem; } - @Override - public XmlWorkflowItem findIndexableObject(Context context, Integer id) throws SQLException { - if (id != null) { - return find(context, id); - } - return null; - } - @Override public List findAll(Context context) throws SQLException { return xmlWorkflowItemDAO.findAll(context, XmlWorkflowItem.class); diff --git a/dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/service/ClaimedTaskService.java b/dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/service/ClaimedTaskService.java index 4f85731472..667ca898b5 100644 --- a/dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/service/ClaimedTaskService.java +++ b/dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/service/ClaimedTaskService.java @@ -11,7 +11,6 @@ import java.sql.SQLException; import java.util.List; import org.dspace.authorize.AuthorizeException; -import org.dspace.content.service.IndexableObjectService; import org.dspace.core.Context; import org.dspace.eperson.EPerson; import org.dspace.service.DSpaceCRUDService; @@ -25,8 +24,7 @@ import org.dspace.xmlworkflow.storedcomponents.XmlWorkflowItem; * * @author kevinvandevelde at atmire.com */ -public interface ClaimedTaskService extends DSpaceCRUDService, - IndexableObjectService { +public interface ClaimedTaskService extends DSpaceCRUDService { public List findByWorkflowItem(Context context, XmlWorkflowItem workflowItem) throws SQLException; @@ -49,4 +47,6 @@ public interface ClaimedTaskService extends DSpaceCRUDService, public void deleteByWorkflowItem(Context context, XmlWorkflowItem workflowItem) throws SQLException, AuthorizeException; + + List findAll(Context context) throws SQLException; } diff --git a/dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/service/PoolTaskService.java b/dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/service/PoolTaskService.java index 2ff61d8b07..d0de6bef38 100644 --- a/dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/service/PoolTaskService.java +++ b/dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/service/PoolTaskService.java @@ -12,7 +12,6 @@ import java.sql.SQLException; import java.util.List; import org.dspace.authorize.AuthorizeException; -import org.dspace.content.service.IndexableObjectService; import org.dspace.core.Context; import org.dspace.eperson.EPerson; import org.dspace.service.DSpaceCRUDService; @@ -26,7 +25,10 @@ import org.dspace.xmlworkflow.storedcomponents.XmlWorkflowItem; * * @author kevinvandevelde at atmire.com */ -public interface PoolTaskService extends DSpaceCRUDService, IndexableObjectService { +public interface PoolTaskService extends DSpaceCRUDService { + + public List findAll(Context context) throws SQLException; + public List findByEperson(Context context, EPerson ePerson) throws SQLException, AuthorizeException, IOException; diff --git a/dspace-api/src/main/resources/org/dspace/storage/rdbms/sqlmigration/h2/V7.0_2019.11.13__relationship_type_copy_left_right.sql b/dspace-api/src/main/resources/org/dspace/storage/rdbms/sqlmigration/h2/V7.0_2019.11.13__relationship_type_copy_left_right.sql new file mode 100644 index 0000000000..a58bbc501d --- /dev/null +++ b/dspace-api/src/main/resources/org/dspace/storage/rdbms/sqlmigration/h2/V7.0_2019.11.13__relationship_type_copy_left_right.sql @@ -0,0 +1,14 @@ +-- +-- The contents of this file are subject to the license and copyright +-- detailed in the LICENSE and NOTICE files at the root of the source +-- tree and available online at +-- +-- http://www.dspace.org/license/ +-- + +----------------------------------------------------------------------------------- +-- Create columns copy_left and copy_right for RelationshipType +----------------------------------------------------------------------------------- + +ALTER TABLE relationship_type ADD copy_to_left BOOLEAN DEFAULT FALSE NOT NULL; +ALTER TABLE relationship_type ADD copy_to_right BOOLEAN DEFAULT FALSE NOT NULL; \ No newline at end of file diff --git a/dspace-api/src/main/resources/org/dspace/storage/rdbms/sqlmigration/oracle/V7.0_2019.11.13__relationship_type_copy_left_right.sql b/dspace-api/src/main/resources/org/dspace/storage/rdbms/sqlmigration/oracle/V7.0_2019.11.13__relationship_type_copy_left_right.sql new file mode 100644 index 0000000000..a58bbc501d --- /dev/null +++ b/dspace-api/src/main/resources/org/dspace/storage/rdbms/sqlmigration/oracle/V7.0_2019.11.13__relationship_type_copy_left_right.sql @@ -0,0 +1,14 @@ +-- +-- The contents of this file are subject to the license and copyright +-- detailed in the LICENSE and NOTICE files at the root of the source +-- tree and available online at +-- +-- http://www.dspace.org/license/ +-- + +----------------------------------------------------------------------------------- +-- Create columns copy_left and copy_right for RelationshipType +----------------------------------------------------------------------------------- + +ALTER TABLE relationship_type ADD copy_to_left BOOLEAN DEFAULT FALSE NOT NULL; +ALTER TABLE relationship_type ADD copy_to_right BOOLEAN DEFAULT FALSE NOT NULL; \ No newline at end of file diff --git a/dspace-api/src/main/resources/org/dspace/storage/rdbms/sqlmigration/postgres/V7.0_2019.11.13__relationship_type_copy_left_right.sql b/dspace-api/src/main/resources/org/dspace/storage/rdbms/sqlmigration/postgres/V7.0_2019.11.13__relationship_type_copy_left_right.sql new file mode 100644 index 0000000000..a58bbc501d --- /dev/null +++ b/dspace-api/src/main/resources/org/dspace/storage/rdbms/sqlmigration/postgres/V7.0_2019.11.13__relationship_type_copy_left_right.sql @@ -0,0 +1,14 @@ +-- +-- The contents of this file are subject to the license and copyright +-- detailed in the LICENSE and NOTICE files at the root of the source +-- tree and available online at +-- +-- http://www.dspace.org/license/ +-- + +----------------------------------------------------------------------------------- +-- Create columns copy_left and copy_right for RelationshipType +----------------------------------------------------------------------------------- + +ALTER TABLE relationship_type ADD copy_to_left BOOLEAN DEFAULT FALSE NOT NULL; +ALTER TABLE relationship_type ADD copy_to_right BOOLEAN DEFAULT FALSE NOT NULL; \ No newline at end of file diff --git a/dspace-api/src/test/data/dspaceFolder/config/entities/relationship-types.dtd b/dspace-api/src/test/data/dspaceFolder/config/entities/relationship-types.dtd index 1a050d7b55..bf434a4462 100644 --- a/dspace-api/src/test/data/dspaceFolder/config/entities/relationship-types.dtd +++ b/dspace-api/src/test/data/dspaceFolder/config/entities/relationship-types.dtd @@ -2,11 +2,13 @@ - + + + diff --git a/dspace-api/src/test/data/dspaceFolder/config/entities/relationship-types.xml b/dspace-api/src/test/data/dspaceFolder/config/entities/relationship-types.xml index fcf00ac928..122e6ccdd6 100644 --- a/dspace-api/src/test/data/dspaceFolder/config/entities/relationship-types.xml +++ b/dspace-api/src/test/data/dspaceFolder/config/entities/relationship-types.xml @@ -13,6 +13,7 @@ 0 + true Publication @@ -25,6 +26,7 @@ 0 + true Publication @@ -37,6 +39,7 @@ 0 + true Person @@ -110,6 +113,7 @@ 0 + true JournalIssue @@ -123,5 +127,6 @@ 0 1 + true \ No newline at end of file diff --git a/dspace-api/src/test/data/dspaceFolder/config/spring/api/solr-services.xml b/dspace-api/src/test/data/dspaceFolder/config/spring/api/solr-services.xml index 654f6284a6..5ad031b688 100644 --- a/dspace-api/src/test/data/dspaceFolder/config/spring/api/solr-services.xml +++ b/dspace-api/src/test/data/dspaceFolder/config/spring/api/solr-services.xml @@ -19,7 +19,7 @@ - + @@ -27,6 +27,8 @@ + + diff --git a/dspace-api/src/test/data/dspaceFolder/config/submission-forms.xml b/dspace-api/src/test/data/dspaceFolder/config/submission-forms.xml index e0ec2dc60a..6ddfef9b83 100644 --- a/dspace-api/src/test/data/dspaceFolder/config/submission-forms.xml +++ b/dspace-api/src/test/data/dspaceFolder/config/submission-forms.xml @@ -52,7 +52,7 @@ isAuthorOfPublication - personConfiguration + person true true @@ -238,7 +238,7 @@ it, please enter the types and the actual numbers or codes. isVolumeOfJournal - periodicalConfiguration + periodical creativework.publisher:somepublishername Select the journal related to this volume. diff --git a/dspace-api/src/test/java/org/dspace/app/util/GoogleBitstreamComparatorTest.java b/dspace-api/src/test/java/org/dspace/app/util/GoogleBitstreamComparatorTest.java index 68b50a4f10..039d634938 100644 --- a/dspace-api/src/test/java/org/dspace/app/util/GoogleBitstreamComparatorTest.java +++ b/dspace-api/src/test/java/org/dspace/app/util/GoogleBitstreamComparatorTest.java @@ -138,7 +138,6 @@ public class GoogleBitstreamComparatorTest extends AbstractUnitTest { when(bitstreamFormat3.getMIMEType()).thenReturn("application/postscript"); when(bitstream1.getSizeBytes()).thenReturn(Long.valueOf(100)); when(bitstream2.getSizeBytes()).thenReturn(Long.valueOf(200)); - when(bitstream3.getSizeBytes()).thenReturn(Long.valueOf(300)); List toSort = bundle.getBitstreams(); Collections.sort(toSort, new GoogleBitstreamComparator(context, settings)); @@ -181,7 +180,6 @@ public class GoogleBitstreamComparatorTest extends AbstractUnitTest { when(bitstreamFormat1.getMIMEType()).thenReturn("unknown"); when(bitstreamFormat2.getMIMEType()).thenReturn("text/richtext"); when(bitstreamFormat3.getMIMEType()).thenReturn("text/richtext"); - when(bitstream1.getSizeBytes()).thenReturn(Long.valueOf(400)); when(bitstream2.getSizeBytes()).thenReturn(Long.valueOf(200)); when(bitstream3.getSizeBytes()).thenReturn(Long.valueOf(300)); @@ -342,9 +340,6 @@ public class GoogleBitstreamComparatorTest extends AbstractUnitTest { when(bitstreamFormat1.getMIMEType()).thenReturn("text/richtext"); when(bitstreamFormat2.getMIMEType()).thenReturn("application/msword"); when(bitstreamFormat3.getMIMEType()).thenReturn("application/postscript"); - when(bitstream1.getSizeBytes()).thenReturn(Long.valueOf(100)); - when(bitstream2.getSizeBytes()).thenReturn(Long.valueOf(200)); - when(bitstream3.getSizeBytes()).thenReturn(Long.valueOf(300)); List toSort = bundle.getBitstreams(); Collections.sort(toSort, new GoogleBitstreamComparator(context, settings)); @@ -362,9 +357,6 @@ public class GoogleBitstreamComparatorTest extends AbstractUnitTest { when(bitstreamFormat1.getMIMEType()).thenReturn("text/richtext"); when(bitstreamFormat2.getMIMEType()).thenReturn("application/msword"); when(bitstreamFormat3.getMIMEType()).thenReturn("audio/x-wav"); - when(bitstream1.getSizeBytes()).thenReturn(Long.valueOf(300)); - when(bitstream2.getSizeBytes()).thenReturn(Long.valueOf(200)); - when(bitstream3.getSizeBytes()).thenReturn(Long.valueOf(100)); List toSort = bundle.getBitstreams(); Collections.sort(toSort, new GoogleBitstreamComparator(context, settings)); diff --git a/dspace-api/src/test/java/org/dspace/content/EntityServiceImplTest.java b/dspace-api/src/test/java/org/dspace/content/EntityServiceImplTest.java index 7907e4e1cd..5aa9d97b79 100644 --- a/dspace-api/src/test/java/org/dspace/content/EntityServiceImplTest.java +++ b/dspace-api/src/test/java/org/dspace/content/EntityServiceImplTest.java @@ -68,7 +68,6 @@ public class EntityServiceImplTest { // Mock the state of objects utilized in findByItemId() to meet the success criteria of an invocation when(itemService.find(any(), any())).thenReturn(item); when(item.getName()).thenReturn("ItemName"); - when(relationshipService.findByItem(any(), any())).thenReturn(relationshipList); // The returned Entity's item should match the mocked item's name assertEquals("TestFindByItem 0", "ItemName", @@ -86,10 +85,6 @@ public class EntityServiceImplTest { list.add(metadataValue); EntityType entityType = entityTypeService.findByEntityType(context, "testType"); - // Mock the state of objects utilized in getType() to meet the success criteria of an invocation - when(metadataValue.getValue()).thenReturn("testType"); - when(itemService.getMetadata(item, "relationship", "type", null, Item.ANY)).thenReturn(list); - // The returned EntityType should equal our defined entityType case assertEquals("TestGetType 0", entityType, entityService.getType(context, entity)); } @@ -146,10 +141,6 @@ public class EntityServiceImplTest { relationshipList.add(relationship); // Mock the state of objects utilized in getRelationsByType() to meet the success criteria of an invocation - when(relationshipService.findAll(context, -1, -1)).thenReturn(relationshipList); - when(relationship.getRelationshipType()).thenReturn(relationshipType); - when(relationshipType.getLeftwardType()).thenReturn("leftwardType"); - when(relationshipType.getRightwardType()).thenReturn("rightwardType"); when(relationshipService.findByTypeName(context, "leftwardType", -1, -1)).thenReturn(relationshipList); // The relation(s) reported from our defined type should match our relationshipList @@ -176,17 +167,7 @@ public class EntityServiceImplTest { // Mock the state of objects utilized in getAllRelationshipTypes() // to meet the success criteria of the invocation - when(metadataValue.getValue()).thenReturn("testType"); when(entity.getItem()).thenReturn(item); - when(itemService.getMetadata(item, "relationship", "type", null, Item.ANY)).thenReturn(list); - when(relationshipTypeDAO.findAll(context, RelationshipType.class, -1, -1)).thenReturn(relationshipTypeList); - when(relationshipTypeService.findAll(context, -1, -1)).thenReturn(relationshipTypeList); - when(relationshipType.getLeftType()).thenReturn(leftType); - when(relationshipType.getRightType()).thenReturn(rightType); - when(entityTypeService.findByEntityType(context, "value")).thenReturn(leftType); - when(leftType.getID()).thenReturn(0); - when(rightType.getID()).thenReturn(1); - when(entityService.getType(context, entity)).thenReturn(leftType); // Mock when(relationshipTypeService.findByEntityType(context, entityService.getType(context, entity), -1, -1)) .thenReturn(relationshipTypeList); @@ -212,13 +193,9 @@ public class EntityServiceImplTest { // Mock the state of objects utilized in getLeftRelationshipTypes() // to meet the success criteria of the invocation - when(itemService.getMetadata(any(), any(), any(), any(), any())).thenReturn(metsList); + when(itemService.getMetadata(item, "relationship", "type", null, Item.ANY, false)).thenReturn(metsList); when(entity.getItem()).thenReturn(item); - when(entityType.getID()).thenReturn(0); - when(relationshipTypeService.findAll(context, -1, -1)).thenReturn(relationshipTypeList); - when(relationshipType.getLeftType()).thenReturn(entityType); when(entityService.getType(context, entity)).thenReturn(entityType); - when(entityTypeService.findByEntityType(any(), any())).thenReturn(entityType); when(relationshipTypeService.findByEntityType(context, entityService.getType(context, entity), true, -1, -1)) .thenReturn(relationshipTypeList); @@ -244,13 +221,9 @@ public class EntityServiceImplTest { // Mock the state of objects utilized in getRightRelationshipTypes() // to meet the success criteria of the invocation - when(itemService.getMetadata(any(), any(), any(), any(), any())).thenReturn(metsList); + when(itemService.getMetadata(item, "relationship", "type", null, Item.ANY, false)).thenReturn(metsList); when(entity.getItem()).thenReturn(item); - when(entityType.getID()).thenReturn(0); - when(relationshipTypeService.findAll(context, -1, -1)).thenReturn(relationshipTypeList); - when(relationshipType.getRightType()).thenReturn(entityType); when(entityService.getType(context, entity)).thenReturn(entityType); - when(entityTypeService.findByEntityType(any(), any())).thenReturn(entityType); when(relationshipTypeService.findByEntityType(context, entityService.getType(context, entity), false, -1, -1)) .thenReturn(relationshipTypeList); @@ -269,9 +242,6 @@ public class EntityServiceImplTest { // Mock the state of objects utilized in getRelationshipTypesByTypeName() // to meet the success criteria of the invocation - when(relationshipTypeService.findAll(context, -1, -1)).thenReturn(list); - when(relationshipType.getLeftwardType()).thenReturn("leftwardType"); - when(relationshipType.getRightwardType()).thenReturn("rightwardType"); when(relationshipTypeService.findByLeftwardOrRightwardTypeName(context, "leftwardType", -1, -1)) .thenReturn(list); diff --git a/dspace-api/src/test/java/org/dspace/content/EntityTypeServiceImplTest.java b/dspace-api/src/test/java/org/dspace/content/EntityTypeServiceImplTest.java index 35cb147aa8..707323deb5 100644 --- a/dspace-api/src/test/java/org/dspace/content/EntityTypeServiceImplTest.java +++ b/dspace-api/src/test/java/org/dspace/content/EntityTypeServiceImplTest.java @@ -60,9 +60,6 @@ public class EntityTypeServiceImplTest { // Declare objects utilized in unit test List entityTypeList = new ArrayList<>(); - // Mock DAO to return our mocked entityTypeList - when(entityTypeDAO.findAll(context, EntityType.class)).thenReturn(entityTypeList); - // The EntityType(s) reported from our mocked state should match our entityTypeList assertEquals("TestFindAll 0", entityTypeList, entityTypeService.findAll(context)); } diff --git a/dspace-api/src/test/java/org/dspace/content/RelationshipMetadataServiceTest.java b/dspace-api/src/test/java/org/dspace/content/RelationshipMetadataServiceTest.java index a307457e66..6290d010e0 100644 --- a/dspace-api/src/test/java/org/dspace/content/RelationshipMetadataServiceTest.java +++ b/dspace-api/src/test/java/org/dspace/content/RelationshipMetadataServiceTest.java @@ -122,6 +122,28 @@ public class RelationshipMetadataServiceTest extends AbstractUnitTest { context.restoreAuthSystemState(); } + /** + * Common function to convert leftItem to a publication item, convert rightItem to an author item, + * and relating them to each other stored in the relationship field + */ + private void initPublicationAuthorWithCopyParams(boolean copyToLeft, boolean copyToRight) + throws SQLException, AuthorizeException { + context.turnOffAuthorisationSystem(); + itemService.addMetadata(context, leftItem, "relationship", "type", null, null, "Publication"); + itemService.addMetadata(context, rightItem, "relationship", "type", null, null, "Author"); + itemService.addMetadata(context, rightItem, "person", "familyName", null, null, "familyName"); + itemService.addMetadata(context, rightItem, "person", "givenName", null, null, "firstName"); + EntityType publicationEntityType = entityTypeService.create(context, "Publication"); + EntityType authorEntityType = entityTypeService.create(context, "Author"); + RelationshipType isAuthorOfPublication = relationshipTypeService + .create(context, publicationEntityType, authorEntityType, + "isAuthorOfPublication", "isPublicationOfAuthor", + null, null, null, null, copyToLeft, copyToRight); + + relationship = relationshipService.create(context, leftItem, rightItem, isAuthorOfPublication, 0, 0); + context.restoreAuthSystemState(); + } + /** * Common function to convert leftItem to a journal issue item, convert rightItem to a journal volume item, * and relating them to each other stored in the relationship field @@ -357,6 +379,76 @@ public class RelationshipMetadataServiceTest extends AbstractUnitTest { assertThat(issueList.get(0).getValue(), equalTo("2")); } + @Test + public void testDeleteAuthorRelationshipCopyToLeftItemFromDefaultInDb() throws Exception { + initPublicationAuthorWithCopyParams(true, false); + context.turnOffAuthorisationSystem(); + //delete the relationship, copying the virtual metadata to actual metadata on the leftItem + //leftItem is the publication + relationshipService.delete(context, relationship); + context.restoreAuthSystemState(); + + //verify the dc.contributor.author actual metadata + List authorList = itemService.getMetadata(leftItem, "dc", "contributor", "author", Item.ANY); + assertThat(authorList.size(), equalTo(1)); + assertThat(authorList.get(0).getValue(), equalTo("familyName, firstName")); + assertThat(authorList.get(0).getMetadataField().getMetadataSchema().getName(), equalTo("dc")); + assertThat(authorList.get(0).getMetadataField().getElement(), equalTo("contributor")); + assertThat(authorList.get(0).getMetadataField().getQualifier(), equalTo("author")); + assertNull(authorList.get(0).getAuthority()); + + //verify there's no relation.isAuthorOfPublication actual metadata + List relationshipMetadataList = itemService + .getMetadata(leftItem, MetadataSchemaEnum.RELATION.getName(), "isAuthorOfPublication", null, Item.ANY); + assertThat(relationshipMetadataList.size(), equalTo(0)); + + //request the virtual metadata of the publication only + List list = relationshipMetadataService.getRelationshipMetadata(leftItem, true); + assertThat(list.size(), equalTo(0)); + } + + @Test + public void testAuthorDeleteRelationshipCopyToRightItemFromDefaultInDb() throws Exception { + initPublicationAuthorWithCopyParams(false, true); + context.turnOffAuthorisationSystem(); + //delete the relationship, copying the virtual metadata to actual metadata on the rightItem + //rightItem is the author + relationshipService.delete(context, relationship); + context.restoreAuthSystemState(); + + //verify there's no dc.contributor.author actual metadata on the publication + List authorList = itemService.getMetadata(leftItem, "dc", "contributor", "author", Item.ANY); + assertThat(authorList.size(), equalTo(0)); + + //verify there's no relation.isAuthorOfPublication actual metadata on the publication + List relationshipMetadataList = itemService + .getMetadata(leftItem, MetadataSchemaEnum.RELATION.getName(), "isAuthorOfPublication", null, Item.ANY); + assertThat(relationshipMetadataList.size(), equalTo(0)); + } + + @Test + public void testDeleteAuthorRelationshipCopyToBothItemsFromDefaultsInDb() throws Exception { + initPublicationAuthorWithCopyParams(true, true); + context.turnOffAuthorisationSystem(); + //delete the relationship, copying the virtual metadata to actual metadata on the both items + relationshipService.delete(context, relationship); + context.restoreAuthSystemState(); + + //verify the dc.contributor.author actual metadata + List authorList = itemService.getMetadata(leftItem, "dc", "contributor", "author", Item.ANY); + assertThat(authorList.size(), equalTo(1)); + assertThat(authorList.get(0).getValue(), equalTo("familyName, firstName")); + assertThat(authorList.get(0).getMetadataField().getMetadataSchema().getName(), equalTo("dc")); + assertThat(authorList.get(0).getMetadataField().getElement(), equalTo("contributor")); + assertThat(authorList.get(0).getMetadataField().getQualifier(), equalTo("author")); + assertNull(authorList.get(0).getAuthority()); + + //verify there's no relation.isAuthorOfPublication actual metadata + List relationshipMetadataList = itemService + .getMetadata(leftItem, MetadataSchemaEnum.RELATION.getName(), "isAuthorOfPublication", null, Item.ANY); + assertThat(relationshipMetadataList.size(), equalTo(0)); + } + @Test public void testGetNextRightPlace() throws Exception { assertThat(relationshipService.findNextRightPlaceByRightItem(context, rightItem), equalTo(0)); diff --git a/dspace-api/src/test/java/org/dspace/content/RelationshipServiceImplTest.java b/dspace-api/src/test/java/org/dspace/content/RelationshipServiceImplTest.java index 3c6f5d4485..244f58bc6d 100644 --- a/dspace-api/src/test/java/org/dspace/content/RelationshipServiceImplTest.java +++ b/dspace-api/src/test/java/org/dspace/content/RelationshipServiceImplTest.java @@ -205,8 +205,6 @@ public class RelationshipServiceImplTest { .isUseForPlaceTrueForRelationshipType(relationship.getRelationshipType(), true)).thenReturn(true); when(authorizeService .authorizeActionBoolean(context, relationship.getLeftItem(), Constants.WRITE)).thenReturn(true); - when(authorizeService - .authorizeActionBoolean(context, relationship.getRightItem(), Constants.WRITE)).thenReturn(true); when(relationshipService.findByItem(context,leftItem)).thenReturn(leftTypelist); when(relationshipService.findByItem(context,rightItem)).thenReturn(rightTypelist); when(leftEntityType.getLabel()).thenReturn("Entitylabel"); @@ -231,8 +229,6 @@ public class RelationshipServiceImplTest { @Test public void testDelete() throws Exception { - // Mock admin state - when(authorizeService.isAdmin(context)).thenReturn(true); // Declare objects utilized in unit test MetadataValue metVal = mock(MetadataValue.class); @@ -260,21 +256,12 @@ public class RelationshipServiceImplTest { .thenReturn(true); when(authorizeService.authorizeActionBoolean(context, relationship.getLeftItem(), Constants.WRITE)) .thenReturn(true); - when(authorizeService.authorizeActionBoolean(context, relationship.getRightItem(), Constants.WRITE)) - .thenReturn(true); when(relationshipService.findByItem(context,leftItem)).thenReturn(leftTypelist); when(relationshipService.findByItem(context,rightItem)).thenReturn(rightTypelist); - when(leftEntityType.getLabel()).thenReturn("Entitylabel"); - when(rightEntityType.getLabel()).thenReturn("Entitylabel"); - when(metVal.getValue()).thenReturn("Entitylabel"); - when(metsList.get(0).getValue()).thenReturn("Entitylabel"); when(relationshipService.findByItemAndRelationshipType(context, leftItem, testRel, true)) .thenReturn(leftTypelist); when(relationshipService.findByItemAndRelationshipType(context, rightItem, testRel, false)) .thenReturn(rightTypelist); - when(itemService.getMetadata(leftItem, "relationship", "type", null, Item.ANY)).thenReturn(metsList); - when(itemService.getMetadata(rightItem, "relationship", "type", null, Item.ANY)).thenReturn(metsList); - when(relationshipDAO.create(any(), any())).thenReturn(relationship); when(relationshipService.find(context,0)).thenReturn(relationship); // Invoke delete() @@ -288,7 +275,6 @@ public class RelationshipServiceImplTest { public void testUpdate() throws Exception { // Mock admin state context.turnOffAuthorisationSystem(); - when(authorizeService.isAdmin(context)).thenReturn(true); // Declare objects utilized in unit test MetadataValue metVal = mock(MetadataValue.class); @@ -312,8 +298,6 @@ public class RelationshipServiceImplTest { when(itemService.getMetadata(rightItem, "relationship", "type", null, Item.ANY)).thenReturn(metsList); when(authorizeService.authorizeActionBoolean(context, relationship.getLeftItem(), Constants.WRITE)).thenReturn(true); - when(authorizeService.authorizeActionBoolean(context, relationship.getRightItem(), - Constants.WRITE)).thenReturn(true); // Invoke update() relationshipService.update(context, relationship); diff --git a/dspace-api/src/test/java/org/dspace/content/comparator/NameAscendingComparatorTest.java b/dspace-api/src/test/java/org/dspace/content/comparator/NameAscendingComparatorTest.java index d65360e8fb..e03ce73ada 100644 --- a/dspace-api/src/test/java/org/dspace/content/comparator/NameAscendingComparatorTest.java +++ b/dspace-api/src/test/java/org/dspace/content/comparator/NameAscendingComparatorTest.java @@ -54,14 +54,12 @@ public class NameAscendingComparatorTest { @Test public void testCompareFirstNull() throws Exception { - when(dso2.getName()).thenReturn("b"); assertTrue(comparator.compare(null, dso2) < 0); } @Test public void testCompareSecondNull() throws Exception { - when(dso1.getName()).thenReturn("a"); assertTrue(comparator.compare(dso1, null) > 0); } diff --git a/dspace-api/src/test/java/org/dspace/content/virtual/RelatedTest.java b/dspace-api/src/test/java/org/dspace/content/virtual/RelatedTest.java index 4beb4afed8..d24824fbd9 100644 --- a/dspace-api/src/test/java/org/dspace/content/virtual/RelatedTest.java +++ b/dspace-api/src/test/java/org/dspace/content/virtual/RelatedTest.java @@ -132,9 +132,7 @@ public class RelatedTest { // Mock the state of objects utilized in getRelationsByLabel() to meet the success criteria of an invocation when(item.getID()).thenReturn(UUID.randomUUID()); when(relationshipType.getLeftwardType()).thenReturn("LeftwardType"); - when(relationshipType.getRightwardType()).thenReturn("RightwardType"); when(relationshipType.getLeftType()).thenReturn(entityType); - when(relationshipType.getRightType()).thenReturn(entityType); when(entityService.getAllRelationshipTypes(context, entity)).thenReturn(relationshipTypeList); when(entityService.findByItemId(context, item.getID())).thenReturn(entity); when(entityService.getType(context, entity)).thenReturn(entityType); @@ -142,9 +140,7 @@ public class RelatedTest { .thenReturn(relationshipList); when(relationship.getRelationshipType()).thenReturn(relationshipType); when(relationship.getLeftPlace()).thenReturn(0); - when(relationship.getRightPlace()).thenReturn(1); when(relationship.getRightItem()).thenReturn(item); - when(relationship.getLeftItem()).thenReturn(item); // The reported values should match out mocked collection of values assertEquals("TestGetValues 0", virtualMetadataConfiguration.getValues(context, item), diff --git a/dspace-api/src/test/java/org/dspace/discovery/MockSolrServiceImpl.java b/dspace-api/src/test/java/org/dspace/discovery/MockSolrSearchCore.java similarity index 86% rename from dspace-api/src/test/java/org/dspace/discovery/MockSolrServiceImpl.java rename to dspace-api/src/test/java/org/dspace/discovery/MockSolrSearchCore.java index ecbc0ed44b..1934ba9f0f 100644 --- a/dspace-api/src/test/java/org/dspace/discovery/MockSolrServiceImpl.java +++ b/dspace-api/src/test/java/org/dspace/discovery/MockSolrSearchCore.java @@ -14,7 +14,7 @@ import org.springframework.stereotype.Service; * Mock SOLR service for the Search Core */ @Service -public class MockSolrServiceImpl extends SolrServiceImpl implements InitializingBean { +public class MockSolrSearchCore extends SolrSearchCore implements InitializingBean { @Override public void afterPropertiesSet() throws Exception { diff --git a/dspace-api/src/test/java/org/dspace/statistics/MockSolrLoggerServiceImpl.java b/dspace-api/src/test/java/org/dspace/statistics/MockSolrLoggerServiceImpl.java index 0c02c0a100..eef9878c18 100644 --- a/dspace-api/src/test/java/org/dspace/statistics/MockSolrLoggerServiceImpl.java +++ b/dspace-api/src/test/java/org/dspace/statistics/MockSolrLoggerServiceImpl.java @@ -10,20 +10,20 @@ package org.dspace.statistics; import java.io.File; import com.maxmind.geoip2.DatabaseReader; -import org.dspace.services.ConfigurationService; import org.springframework.beans.factory.InitializingBean; -import org.springframework.beans.factory.annotation.Autowired; /** * Mock service that uses an embedded SOLR server for the statistics core. + *

+ * NOTE: this class is overridden by one of the same name + * defined in dspace-server-webapp and declared as a bean there. + * See {@code config/spring/api/Z-mock-services.xml}. Some kind of classpath + * magic makes this work. */ public class MockSolrLoggerServiceImpl extends SolrLoggerServiceImpl implements InitializingBean { - @Autowired(required = true) - private ConfigurationService configurationService; - public MockSolrLoggerServiceImpl() { } @@ -34,9 +34,8 @@ public class MockSolrLoggerServiceImpl new FakeDatabaseReader(); // Activate fake new FakeDatabaseReader.Builder(); // Activate fake - String locationDbPath = configurationService.getProperty("usage-statistics.dbfile"); - File locationDb = new File(locationDbPath); - locationDb.createNewFile(); + File locationDb = File.createTempFile("GeoIP", ".db"); + locationDb.deleteOnExit(); locationService = new DatabaseReader.Builder(locationDb).build(); } diff --git a/dspace-api/src/test/resources/log4j.properties b/dspace-api/src/test/resources/log4j.properties index 4e7fbff3e3..2797b7c655 100644 --- a/dspace-api/src/test/resources/log4j.properties +++ b/dspace-api/src/test/resources/log4j.properties @@ -19,16 +19,12 @@ log4j.rootCategory=INFO, A1 # A1 is set to be a ConsoleAppender. -log4j.appender.A1=org.apache.logging.log4j.ConsoleAppender +log4j.appender.A1=org.apache.log4j.ConsoleAppender # A1 uses PatternLayout. log4j.appender.A1.layout=org.apache.logging.log4j.PatternLayout log4j.appender.A1.layout.ConversionPattern=%d %-5p %c @ %m%n -# block passwords from being exposed in Axis logs. -# (DEBUG exposes passwords in Basic Auth) -log4j.logger.org.apache.axis.handlers.http.HTTPAuthHandler=INFO - ########################################################################### # Other settings ########################################################################### @@ -44,9 +40,9 @@ log4j.logger.org.dspace.servicemanager=ERROR log4j.logger.org.dspace.providers=ERROR log4j.logger.org.dspace.utils=ERROR -log4j.appender.stdout=org.apache.logging.log4j.ConsoleAppender +log4j.appender.stdout=org.apache.log4j.ConsoleAppender log4j.appender.stdout.Target=System.out -log4j.appender.stdout.layout=org.apache.logging.log4j.PatternLayout +log4j.appender.stdout.layout=org.apache.log4j.PatternLayout log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n # # Root logger option diff --git a/dspace-oai/pom.xml b/dspace-oai/pom.xml index 0e7f2bd0eb..183bf62fd7 100644 --- a/dspace-oai/pom.xml +++ b/dspace-oai/pom.xml @@ -15,9 +15,8 @@ ${basedir}/.. - 3.2.10 - - 5.86.1.RELEASE + 3.2.11 + 5.87.0.RELEASE diff --git a/dspace-oai/src/main/java/org/dspace/xoai/app/XOAI.java b/dspace-oai/src/main/java/org/dspace/xoai/app/XOAI.java index 8704324a88..0bf2fef557 100644 --- a/dspace-oai/src/main/java/org/dspace/xoai/app/XOAI.java +++ b/dspace-oai/src/main/java/org/dspace/xoai/app/XOAI.java @@ -448,6 +448,12 @@ public class XOAI { doc.addField("metadata.dc.format.mimetype", f); } + // Message output before processing - for debugging purposes + if (verbose) { + println(String.format("Item %s with handle %s is about to be indexed", + item.getID().toString(), handle)); + } + ByteArrayOutputStream out = new ByteArrayOutputStream(); XmlOutputContext xmlContext = XmlOutputContext.emptyContext(out, Second); retrieveMetadata(context, item).write(xmlContext); diff --git a/dspace-oai/src/main/java/org/dspace/xoai/util/ItemUtils.java b/dspace-oai/src/main/java/org/dspace/xoai/util/ItemUtils.java index 10bbc61e70..5169b5523f 100644 --- a/dspace-oai/src/main/java/org/dspace/xoai/util/ItemUtils.java +++ b/dspace-oai/src/main/java/org/dspace/xoai/util/ItemUtils.java @@ -30,6 +30,7 @@ import org.dspace.content.authority.Choices; import org.dspace.content.factory.ContentServiceFactory; import org.dspace.content.service.BitstreamService; import org.dspace.content.service.ItemService; +import org.dspace.content.service.RelationshipService; import org.dspace.core.ConfigurationManager; import org.dspace.core.Constants; import org.dspace.core.Context; @@ -44,18 +45,22 @@ public class ItemUtils { private static final Logger log = LogManager.getLogger(ItemUtils.class); private static final MetadataExposureService metadataExposureService - = UtilServiceFactory.getInstance().getMetadataExposureService(); + = UtilServiceFactory.getInstance().getMetadataExposureService(); private static final ItemService itemService - = ContentServiceFactory.getInstance().getItemService(); + = ContentServiceFactory.getInstance().getItemService(); + + private static final RelationshipService relationshipService + = ContentServiceFactory.getInstance().getRelationshipService(); private static final BitstreamService bitstreamService - = ContentServiceFactory.getInstance().getBitstreamService(); + = ContentServiceFactory.getInstance().getBitstreamService(); /** * Default constructor */ - private ItemUtils() { } + private ItemUtils() { + } private static Element getElement(List list, String name) { for (Element e : list) { @@ -73,228 +78,223 @@ public class ItemUtils { return e; } - private static Element.Field createValue( - String name, String value) { + private static Element.Field createValue(String name, String value) { Element.Field e = new Element.Field(); e.setValue(value); e.setName(name); return e; } + private static Element createBundlesElement(Context context, Item item) throws SQLException { + Element bundles = create("bundles"); + + List bs; + + bs = item.getBundles(); + for (Bundle b : bs) { + Element bundle = create("bundle"); + bundles.getElement().add(bundle); + bundle.getField().add(createValue("name", b.getName())); + + Element bitstreams = create("bitstreams"); + bundle.getElement().add(bitstreams); + List bits = b.getBitstreams(); + for (Bitstream bit : bits) { + Element bitstream = create("bitstream"); + bitstreams.getElement().add(bitstream); + String url = ""; + String bsName = bit.getName(); + String sid = String.valueOf(bit.getSequenceID()); + String baseUrl = ConfigurationManager.getProperty("oai", "bitstream.baseUrl"); + String handle = null; + // get handle of parent Item of this bitstream, if there + // is one: + List bn = bit.getBundles(); + if (!bn.isEmpty()) { + List bi = bn.get(0).getItems(); + if (!bi.isEmpty()) { + handle = bi.get(0).getHandle(); + } + } + if (bsName == null) { + List ext = bit.getFormat(context).getExtensions(); + bsName = "bitstream_" + sid + (ext.isEmpty() ? "" : ext.get(0)); + } + if (handle != null && baseUrl != null) { + url = baseUrl + "/bitstream/" + handle + "/" + sid + "/" + URLUtils.encode(bsName); + } else { + url = URLUtils.encode(bsName); + } + + String cks = bit.getChecksum(); + String cka = bit.getChecksumAlgorithm(); + String oname = bit.getSource(); + String name = bit.getName(); + String description = bit.getDescription(); + + if (name != null) { + bitstream.getField().add(createValue("name", name)); + } + if (oname != null) { + bitstream.getField().add(createValue("originalName", name)); + } + if (description != null) { + bitstream.getField().add(createValue("description", description)); + } + bitstream.getField().add(createValue("format", bit.getFormat(context).getMIMEType())); + bitstream.getField().add(createValue("size", "" + bit.getSizeBytes())); + bitstream.getField().add(createValue("url", url)); + bitstream.getField().add(createValue("checksum", cks)); + bitstream.getField().add(createValue("checksumAlgorithm", cka)); + bitstream.getField().add(createValue("sid", bit.getSequenceID() + "")); + } + } + + return bundles; + } + + private static Element createLicenseElement(Context context, Item item) + throws SQLException, AuthorizeException, IOException { + Element license = create("license"); + List licBundles; + licBundles = itemService.getBundles(item, Constants.LICENSE_BUNDLE_NAME); + if (!licBundles.isEmpty()) { + Bundle licBundle = licBundles.get(0); + List licBits = licBundle.getBitstreams(); + if (!licBits.isEmpty()) { + Bitstream licBit = licBits.get(0); + InputStream in; + + in = bitstreamService.retrieve(context, licBit); + ByteArrayOutputStream out = new ByteArrayOutputStream(); + Utils.bufferedCopy(in, out); + license.getField().add(createValue("bin", Base64Utils.encode(out.toString()))); + + } + } + return license; + } + + /** + * This method will add all sub-elements to a top element, like: dc, or dcterms, ... * + * @param schema Element argument passed by reference that will be changed + * @param val Metadatavalue that will be processed + * @throws SQLException + */ + private static void fillSchemaElement(Element schema, MetadataValue val) throws SQLException { + MetadataField field = val.getMetadataField(); + Element valueElem = schema; + + // Has element.. with XOAI one could have only schema and value + if (field.getElement() != null && !field.getElement().equals("")) { + Element element = getElement(schema.getElement(), field.getElement()); + if (element == null) { + element = create(field.getElement()); + schema.getElement().add(element); + } + valueElem = element; + + // Qualified element? + if (field.getQualifier() != null && !field.getQualifier().equals("")) { + Element qualifier = getElement(element.getElement(), field.getQualifier()); + if (qualifier == null) { + qualifier = create(field.getQualifier()); + element.getElement().add(qualifier); + } + valueElem = qualifier; + } + } + + // Language? + if (val.getLanguage() != null && !val.getLanguage().equals("")) { + Element language = getElement(valueElem.getElement(), val.getLanguage()); + if (language == null) { + language = create(val.getLanguage()); + valueElem.getElement().add(language); + } + valueElem = language; + } else { + Element language = getElement(valueElem.getElement(), "none"); + if (language == null) { + language = create("none"); + valueElem.getElement().add(language); + } + valueElem = language; + } + + valueElem.getField().add(createValue("value", val.getValue())); + if (val.getAuthority() != null) { + valueElem.getField().add(createValue("authority", val.getAuthority())); + if (val.getConfidence() != Choices.CF_NOVALUE) { + valueElem.getField().add(createValue("confidence", val.getConfidence() + "")); + } + } + } + + /** + * Utility method to retrieve a structured XML in XOAI format + * @param context + * @param item + * @return Structured XML Metadata in XOAI format + */ public static Metadata retrieveMetadata(Context context, Item item) { Metadata metadata; // read all metadata into Metadata Object metadata = new Metadata(); + List vals = itemService.getMetadata(item, Item.ANY, Item.ANY, Item.ANY, Item.ANY); for (MetadataValue val : vals) { MetadataField field = val.getMetadataField(); - - // Don't expose fields that are hidden by configuration try { - if (metadataExposureService.isHidden(context, - field.getMetadataSchema().getName(), - field.getElement(), - field.getQualifier())) { + // Don't expose fields that are hidden by configuration + if (metadataExposureService.isHidden(context, field.getMetadataSchema().getName(), field.getElement(), + field.getQualifier())) { continue; } + + Element schema = getElement(metadata.getElement(), field.getMetadataSchema().getName()); + if (schema == null) { + schema = create(field.getMetadataSchema().getName()); + metadata.getElement().add(schema); + } + + fillSchemaElement(schema, val); } catch (SQLException se) { throw new RuntimeException(se); } - - Element valueElem = null; - Element schema = getElement(metadata.getElement(), field.getMetadataSchema().getName()); - if (schema == null) { - schema = create(field.getMetadataSchema().getName()); - metadata.getElement().add(schema); - } - valueElem = schema; - - // Has element.. with XOAI one could have only schema and value - if (field.getElement() != null && !field.getElement().equals("")) { - Element element = getElement(schema.getElement(), - field.getElement()); - if (element == null) { - element = create(field.getElement()); - schema.getElement().add(element); - } - valueElem = element; - - // Qualified element? - if (field.getQualifier() != null && !field.getQualifier().equals("")) { - Element qualifier = getElement(element.getElement(), - field.getQualifier()); - if (qualifier == null) { - qualifier = create(field.getQualifier()); - element.getElement().add(qualifier); - } - valueElem = qualifier; - } - } - - // Language? - if (val.getLanguage() != null && !val.getLanguage().equals("")) { - Element language = getElement(valueElem.getElement(), - val.getLanguage()); - if (language == null) { - language = create(val.getLanguage()); - valueElem.getElement().add(language); - } - valueElem = language; - } else { - Element language = getElement(valueElem.getElement(), - "none"); - if (language == null) { - language = create("none"); - valueElem.getElement().add(language); - } - valueElem = language; - } - - valueElem.getField().add(createValue("value", val.getValue())); - if (val.getAuthority() != null) { - valueElem.getField().add(createValue("authority", val.getAuthority())); - if (val.getConfidence() != Choices.CF_NOVALUE) { - valueElem.getField().add(createValue("confidence", val.getConfidence() + "")); - } - } } + // Done! Metadata has been read! // Now adding bitstream info - Element bundles = create("bundles"); - metadata.getElement().add(bundles); - - List bs; try { - bs = item.getBundles(); - for (Bundle b : bs) { - Element bundle = create("bundle"); - bundles.getElement().add(bundle); - bundle.getField() - .add(createValue("name", b.getName())); - - Element bitstreams = create("bitstreams"); - bundle.getElement().add(bitstreams); - List bits = b.getBitstreams(); - for (Bitstream bit : bits) { - Element bitstream = create("bitstream"); - bitstreams.getElement().add(bitstream); - String url = ""; - String bsName = bit.getName(); - String sid = String.valueOf(bit.getSequenceID()); - String baseUrl = ConfigurationManager.getProperty("oai", - "bitstream.baseUrl"); - String handle = null; - // get handle of parent Item of this bitstream, if there - // is one: - List bn = bit.getBundles(); - if (!bn.isEmpty()) { - List bi = bn.get(0).getItems(); - if (!bi.isEmpty()) { - handle = bi.get(0).getHandle(); - } - } - if (bsName == null) { - List ext = bit.getFormat(context).getExtensions(); - bsName = "bitstream_" + sid - + (ext.isEmpty() ? "" : ext.get(0)); - } - if (handle != null && baseUrl != null) { - url = baseUrl + "/bitstream/" - + handle + "/" - + sid + "/" - + URLUtils.encode(bsName); - } else { - url = URLUtils.encode(bsName); - } - - String cks = bit.getChecksum(); - String cka = bit.getChecksumAlgorithm(); - String oname = bit.getSource(); - String name = bit.getName(); - String description = bit.getDescription(); - - if (name != null) { - bitstream.getField().add( - createValue("name", name)); - } - if (oname != null) { - bitstream.getField().add( - createValue("originalName", name)); - } - if (description != null) { - bitstream.getField().add( - createValue("description", description)); - } - bitstream.getField().add( - createValue("format", bit.getFormat(context) - .getMIMEType())); - bitstream.getField().add( - createValue("size", "" + bit.getSizeBytes())); - bitstream.getField().add(createValue("url", url)); - bitstream.getField().add( - createValue("checksum", cks)); - bitstream.getField().add( - createValue("checksumAlgorithm", cka)); - bitstream.getField().add( - createValue("sid", bit.getSequenceID() - + "")); - } - } - } catch (SQLException e1) { - e1.printStackTrace(); + Element bundles = createBundlesElement(context, item); + metadata.getElement().add(bundles); + } catch (SQLException e) { + log.warn(e.getMessage(), e); } - // Other info Element other = create("others"); - other.getField().add( - createValue("handle", item.getHandle())); - other.getField().add( - createValue("identifier", DSpaceItem.buildIdentifier(item.getHandle()))); - other.getField().add( - createValue("lastModifyDate", item - .getLastModified().toString())); + other.getField().add(createValue("handle", item.getHandle())); + other.getField().add(createValue("identifier", DSpaceItem.buildIdentifier(item.getHandle()))); + other.getField().add(createValue("lastModifyDate", item.getLastModified().toString())); metadata.getElement().add(other); // Repository Info Element repository = create("repository"); - repository.getField().add( - createValue("name", - ConfigurationManager.getProperty("dspace.name"))); - repository.getField().add( - createValue("mail", - ConfigurationManager.getProperty("mail.admin"))); + repository.getField().add(createValue("url", ConfigurationManager.getProperty("dspace.baseUrl"))); + repository.getField().add(createValue("name", ConfigurationManager.getProperty("dspace.name"))); + repository.getField().add(createValue("mail", ConfigurationManager.getProperty("mail.admin"))); metadata.getElement().add(repository); // Licensing info - Element license = create("license"); - List licBundles; try { - licBundles = itemService.getBundles(item, Constants.LICENSE_BUNDLE_NAME); - if (!licBundles.isEmpty()) { - Bundle licBundle = licBundles.get(0); - List licBits = licBundle.getBitstreams(); - if (!licBits.isEmpty()) { - Bitstream licBit = licBits.get(0); - InputStream in; - try { - in = bitstreamService.retrieve(context, licBit); - ByteArrayOutputStream out = new ByteArrayOutputStream(); - Utils.bufferedCopy(in, out); - license.getField().add( - createValue("bin", - Base64Utils.encode(out.toString()))); - metadata.getElement().add(license); - } catch (AuthorizeException | IOException | SQLException e) { - log.warn(e.getMessage(), e); - } - - } - } - } catch (SQLException e1) { - log.warn(e1.getMessage(), e1); + Element license = createLicenseElement(context, item); + metadata.getElement().add(license); + } catch (AuthorizeException | IOException | SQLException e) { + log.warn(e.getMessage(), e); } return metadata; diff --git a/dspace-rest/pom.xml b/dspace-rest/pom.xml index 3c06a15027..df22263136 100644 --- a/dspace-rest/pom.xml +++ b/dspace-rest/pom.xml @@ -19,7 +19,7 @@ ${basedir}/.. - 3.2.9.RELEASE + 5.1.3.RELEASE diff --git a/dspace-rest/src/main/webapp/WEB-INF/applicationContext.xml b/dspace-rest/src/main/webapp/WEB-INF/applicationContext.xml index 48dcabcfdf..62b660b86b 100644 --- a/dspace-rest/src/main/webapp/WEB-INF/applicationContext.xml +++ b/dspace-rest/src/main/webapp/WEB-INF/applicationContext.xml @@ -11,7 +11,7 @@ + http://www.springframework.org/schema/beans/spring-beans.xsd"> @@ -27,8 +27,8 @@ - - + @@ -77,4 +77,4 @@ class="org.dspace.rest.authentication.NoRedirectAuthenticationLoginSuccessHandler"/> - \ No newline at end of file + diff --git a/dspace-server-webapp/pom.xml b/dspace-server-webapp/pom.xml index 7d55617eea..49d32e25d8 100644 --- a/dspace-server-webapp/pom.xml +++ b/dspace-server-webapp/pom.xml @@ -28,7 +28,7 @@ org.dspace.app.rest.Application - 6.2 + 7.9 @@ -190,6 +190,7 @@ + @@ -219,11 +220,13 @@ provided ${spring-boot.version} + org.springframework.boot spring-boot-starter-data-rest ${spring-boot.version} + org.springframework.boot spring-boot-starter-aop @@ -240,7 +243,7 @@ org.springframework.data spring-data-rest-hal-browser - 2.5.7.RELEASE + 3.1.10.RELEASE @@ -313,6 +317,11 @@ joda-time joda-time + + com.fasterxml.jackson.core + jackson-databind + + com.nimbusds nimbus-jose-jwt @@ -329,20 +338,6 @@ org.springframework.boot spring-boot-starter-test test - - - - org.json - json - - - - com.jayway.jsonpath - json-path - - com.jayway.jsonpath diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/Application.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/Application.java index 0315860178..900324fc72 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/Application.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/Application.java @@ -23,16 +23,16 @@ import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.builder.SpringApplicationBuilder; -import org.springframework.boot.web.support.SpringBootServletInitializer; +import org.springframework.boot.web.servlet.support.SpringBootServletInitializer; import org.springframework.context.annotation.Bean; import org.springframework.core.annotation.Order; import org.springframework.hateoas.RelProvider; +import org.springframework.lang.NonNull; import org.springframework.web.context.request.RequestContextListener; import org.springframework.web.cors.CorsConfiguration; import org.springframework.web.method.support.HandlerMethodArgumentResolver; import org.springframework.web.servlet.config.annotation.CorsRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; -import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter; /** * Define the Spring Boot Application settings itself. This class takes the place @@ -124,9 +124,10 @@ public class Application extends SpringBootServletInitializer { @Bean public WebMvcConfigurer webMvcConfigurer() { - return new WebMvcConfigurerAdapter() { + + return new WebMvcConfigurer() { @Override - public void addCorsMappings(CorsRegistry registry) { + public void addCorsMappings(@NonNull CorsRegistry registry) { String[] corsAllowedOrigins = configuration.getCorsAllowedOrigins(); if (corsAllowedOrigins != null) { registry.addMapping("/api/**").allowedMethods(CorsConfiguration.ALL) @@ -138,7 +139,7 @@ public class Application extends SpringBootServletInitializer { } @Override - public void addArgumentResolvers(List argumentResolvers) { + public void addArgumentResolvers(@NonNull List argumentResolvers) { argumentResolvers.add(new SearchFilterResolver()); } }; diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/BitstreamBundleController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/BitstreamBundleController.java index a28ec5a9a7..ac29bf7699 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/BitstreamBundleController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/BitstreamBundleController.java @@ -36,6 +36,7 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.rest.webmvc.ControllerUtils; import org.springframework.data.rest.webmvc.ResourceNotFoundException; import org.springframework.hateoas.ResourceSupport; +import org.springframework.http.HttpHeaders; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import org.springframework.security.access.prepost.PostAuthorize; @@ -109,7 +110,7 @@ public class BitstreamBundleController { BundleResource bundleResource = converter.toResource( converter.toRest(bundles.get(0), utils.obtainProjection())); - return ControllerUtils.toResponseEntity(HttpStatus.OK, null, bundleResource); + return ControllerUtils.toResponseEntity(HttpStatus.OK, new HttpHeaders(), bundleResource); } /** diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/BitstreamRestController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/BitstreamRestController.java index 1ecd7a33ff..ba2c66c734 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/BitstreamRestController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/BitstreamRestController.java @@ -127,10 +127,13 @@ public class BitstreamRestController { .withLength(bitstreamTuple.getRight()) .withChecksum(bit.getChecksum()) .withMimetype(mimetype) - .withLastModified(lastModified) .with(request) .with(response); + if (lastModified != null) { + sender.withLastModified(lastModified); + } + //Determine if we need to send the file as a download or if the browser can open it inline long dispositionThreshold = configurationService.getLongProperty("webui.content_disposition_threshold"); if (dispositionThreshold >= 0 && bitstreamTuple.getRight() > dispositionThreshold) { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/BundleUploadBitstreamController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/BundleUploadBitstreamController.java index d7c0109e0c..7035e329f2 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/BundleUploadBitstreamController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/BundleUploadBitstreamController.java @@ -32,6 +32,7 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.rest.webmvc.ControllerUtils; import org.springframework.data.rest.webmvc.ResourceNotFoundException; import org.springframework.hateoas.ResourceSupport; +import org.springframework.http.HttpHeaders; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import org.springframework.security.access.prepost.PreAuthorize; @@ -112,6 +113,6 @@ public class BundleUploadBitstreamController { context, bundle, uploadfile.getOriginalFilename(), fileInputStream, properties); BitstreamResource bitstreamResource = converter.toResource(bitstreamRest); - return ControllerUtils.toResponseEntity(HttpStatus.CREATED, null, bitstreamResource); + return ControllerUtils.toResponseEntity(HttpStatus.CREATED, new HttpHeaders(), bitstreamResource); } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/CollectionItemtemplateController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/CollectionItemtemplateController.java index 5bde7b3b91..eef1d3eec0 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/CollectionItemtemplateController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/CollectionItemtemplateController.java @@ -32,6 +32,7 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.rest.webmvc.ControllerUtils; import org.springframework.data.rest.webmvc.ResourceNotFoundException; import org.springframework.hateoas.ResourceSupport; +import org.springframework.http.HttpHeaders; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import org.springframework.security.access.prepost.PreAuthorize; @@ -118,7 +119,7 @@ public class CollectionItemtemplateController { ItemRest templateItem = collectionRestRepository.createTemplateItem(context, collection, inputItemRest); context.commit(); - return ControllerUtils.toResponseEntity(HttpStatus.CREATED, null, + return ControllerUtils.toResponseEntity(HttpStatus.CREATED, new HttpHeaders(), new ItemResource(templateItem, utils)); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/CollectionLogoController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/CollectionLogoController.java index 15ada98ba4..76dec0555e 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/CollectionLogoController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/CollectionLogoController.java @@ -27,6 +27,7 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.rest.webmvc.ControllerUtils; import org.springframework.data.rest.webmvc.ResourceNotFoundException; import org.springframework.hateoas.ResourceSupport; +import org.springframework.http.HttpHeaders; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import org.springframework.security.access.prepost.PreAuthorize; @@ -106,7 +107,7 @@ public class CollectionLogoController { BitstreamResource bitstreamResource = new BitstreamResource(bitstream, utils); context.complete(); - return ControllerUtils.toResponseEntity(HttpStatus.CREATED, null, bitstreamResource); + return ControllerUtils.toResponseEntity(HttpStatus.CREATED, new HttpHeaders(), bitstreamResource); } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/CommunityLogoController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/CommunityLogoController.java index b99c54e2a3..4b11320f97 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/CommunityLogoController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/CommunityLogoController.java @@ -28,6 +28,7 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.rest.webmvc.ControllerUtils; import org.springframework.data.rest.webmvc.ResourceNotFoundException; import org.springframework.hateoas.ResourceSupport; +import org.springframework.http.HttpHeaders; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import org.springframework.security.access.prepost.PreAuthorize; @@ -108,7 +109,7 @@ public class CommunityLogoController { BitstreamResource bitstreamResource = new BitstreamResource(bitstream, utils); context.complete(); - return ControllerUtils.toResponseEntity(HttpStatus.CREATED, null, bitstreamResource); + return ControllerUtils.toResponseEntity(HttpStatus.CREATED, new HttpHeaders(), bitstreamResource); } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/EntityTypeLabelRestController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/EntityTypeLabelRestController.java new file mode 100644 index 0000000000..14d01b8c76 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/EntityTypeLabelRestController.java @@ -0,0 +1,67 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.app.rest; + +import java.sql.SQLException; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; + +import org.dspace.app.rest.converter.ConverterService; +import org.dspace.app.rest.model.EntityTypeRest; +import org.dspace.app.rest.utils.ContextUtil; +import org.dspace.app.rest.utils.Utils; +import org.dspace.content.EntityType; +import org.dspace.content.factory.ContentServiceFactory; +import org.dspace.content.service.EntityTypeService; +import org.dspace.core.Context; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.data.rest.webmvc.ResourceNotFoundException; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; + +/** + * This controller will handle all the incoming calls on the /api/core/entitytypes/label/<:entity-type-label> endpoint + * where the entity-type-label parameter can be filled in to match a specific entityType by label + * There's always at most one entity type per label. + *

+ * It responds with: + *

+ * The single entity type if there's a match + * 404 if the entity type doesn't exist + * + * @author Maria Verdonck (Atmire) on 2019-12-13 + */ +@RestController +@RequestMapping("/api/" + EntityTypeRest.CATEGORY + "/" + EntityTypeRest.NAME_PLURAL) +public class EntityTypeLabelRestController { + + protected final EntityTypeService entityTypeService = ContentServiceFactory.getInstance().getEntityTypeService(); + + @Autowired + protected ConverterService converter; + + @Autowired + protected Utils utils; + + @GetMapping("/label/{entity-type-label}") + public EntityTypeRest get(HttpServletRequest request, HttpServletResponse response, + @PathVariable("entity-type-label") String label) { + Context context = ContextUtil.obtainContext(request); + try { + EntityType entityType = this.entityTypeService.findByEntityType(context, label); + if (entityType == null) { + throw new ResourceNotFoundException("There was no entityType found with label: " + label); + } + return converter.toRest(entityType, utils.obtainProjection()); + } catch (SQLException e) { + throw new RuntimeException(e.getMessage(), e); + } + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/ItemAddBundleController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/ItemAddBundleController.java index 8354e0048b..0532ff2d29 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/ItemAddBundleController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/ItemAddBundleController.java @@ -35,6 +35,7 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.rest.webmvc.ControllerUtils; import org.springframework.data.rest.webmvc.ResourceNotFoundException; import org.springframework.hateoas.ResourceSupport; +import org.springframework.http.HttpHeaders; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import org.springframework.security.access.prepost.PreAuthorize; @@ -108,7 +109,7 @@ public class ItemAddBundleController { Bundle bundle = itemRestRepository.addBundleToItem(context, item, bundleRest); BundleResource bundleResource = converter.toResource(converter.toRest(bundle, Projection.DEFAULT)); - return ControllerUtils.toResponseEntity(HttpStatus.CREATED, null, bundleResource); + return ControllerUtils.toResponseEntity(HttpStatus.CREATED, new HttpHeaders(), bundleResource); } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/ItemtemplateRestController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/ItemtemplateRestController.java index a47a5ce58a..c7979ff47f 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/ItemtemplateRestController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/ItemtemplateRestController.java @@ -30,6 +30,7 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.rest.webmvc.ControllerUtils; import org.springframework.data.rest.webmvc.ResourceNotFoundException; import org.springframework.hateoas.ResourceSupport; +import org.springframework.http.HttpHeaders; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import org.springframework.security.access.prepost.PreAuthorize; @@ -125,7 +126,7 @@ public class ItemtemplateRestController { ItemRest templateItem = itemRestRepository.patchTemplateItem(item, jsonNode); context.commit(); - return ControllerUtils.toResponseEntity(HttpStatus.OK, null, + return ControllerUtils.toResponseEntity(HttpStatus.OK, new HttpHeaders(), new ItemResource(templateItem, utils)); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/MappedItemRestController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/MappedItemRestController.java index be450dd9cd..8379d1170e 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/MappedItemRestController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/MappedItemRestController.java @@ -90,7 +90,7 @@ public class MappedItemRestController { Context context = ContextUtil.obtainContext(request); Collection collection = collectionService.find(context, uuid); Iterator itemIterator = itemService.findByCollectionMapping(context, collection, pageable.getPageSize(), - pageable.getOffset()); + Math.toIntExact(pageable.getOffset())); int totalElements = itemService.countByCollectionMapping(context, collection); List mappedItemRestList = new LinkedList<>(); while (itemIterator.hasNext()) { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/OpenSearchController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/OpenSearchController.java index 3ae879564e..fd123acf15 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/OpenSearchController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/OpenSearchController.java @@ -12,7 +12,6 @@ import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; -import java.util.UUID; import javax.servlet.ServletException; import javax.servlet.http.HttpServletRequest; @@ -112,7 +111,7 @@ public class OpenSearchController { } // then the rest - we are processing the query - IndexableObject container = null; + IndexableObject container = null; // support pagination parameters DiscoverQuery queryArgs = new DiscoverQuery(); diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/RelationshipTypeRestController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/RelationshipTypeRestController.java index 490eefb6c4..184096dea0 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/RelationshipTypeRestController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/RelationshipTypeRestController.java @@ -8,7 +8,6 @@ package org.dspace.app.rest; import java.sql.SQLException; -import java.util.LinkedList; import java.util.List; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; @@ -16,9 +15,7 @@ import javax.servlet.http.HttpServletResponse; import org.dspace.app.rest.converter.ConverterService; import org.dspace.app.rest.link.HalLinkService; import org.dspace.app.rest.model.RelationshipTypeRest; -import org.dspace.app.rest.model.RelationshipTypeRestWrapper; -import org.dspace.app.rest.model.hateoas.RelationshipTypeResourceWrapper; -import org.dspace.app.rest.projection.Projection; +import org.dspace.app.rest.model.hateoas.RelationshipTypeResource; import org.dspace.app.rest.utils.ContextUtil; import org.dspace.app.rest.utils.Utils; import org.dspace.content.EntityType; @@ -27,6 +24,10 @@ import org.dspace.content.service.EntityTypeService; import org.dspace.content.service.RelationshipTypeService; import org.dspace.core.Context; import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.data.domain.Page; +import org.springframework.data.domain.Pageable; +import org.springframework.data.web.PagedResourcesAssembler; +import org.springframework.hateoas.PagedResources; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; @@ -64,32 +65,30 @@ public class RelationshipTypeRestController { * @param id The ID of the EntityType objects that we'll use to retrieve the RelationshipTypes * @param response The response object * @param request The request object - * @return The wrapped resource containing the list of RelationshipType objects as defined above + * @param pageable The pagination object + * @param assembler The assembler object + * @return The wrapped resource containing the list of RelationshipType objects as defined above * @throws SQLException If something goes wrong */ @RequestMapping(method = RequestMethod.GET) - public RelationshipTypeResourceWrapper retrieve(@PathVariable Integer id, - HttpServletResponse response, - HttpServletRequest request) throws SQLException { + public PagedResources retrieve(@PathVariable Integer id, + HttpServletResponse response, + HttpServletRequest request, + Pageable pageable, + PagedResourcesAssembler assembler) throws SQLException { Context context = ContextUtil.obtainContext(request); EntityType entityType = entityTypeService.find(context, id); List list = relationshipTypeService.findByEntityType(context, entityType, -1, -1); - List relationshipTypeRests = new LinkedList<>(); + Page relationshipTypeRestPage = converter + .toRestPage(list, pageable, list.size(), utils.obtainProjection(true)); - Projection projection = utils.obtainProjection(); - for (RelationshipType relationshipType : list) { - relationshipTypeRests.add(converter.toRest(relationshipType, projection)); - } + Page relationshipTypeResources = relationshipTypeRestPage + .map(relationshipTypeRest -> new RelationshipTypeResource(relationshipTypeRest, utils)); + relationshipTypeResources.forEach(halLinkService::addLinks); + PagedResources result = assembler.toResource(relationshipTypeResources); + return result; - RelationshipTypeRestWrapper relationshipTypeRestWrapper = new RelationshipTypeRestWrapper(); - relationshipTypeRestWrapper.setProjection(projection); - relationshipTypeRestWrapper.setEntityTypeId(id); - relationshipTypeRestWrapper.setEntityTypeLabel(entityType.getLabel()); - relationshipTypeRestWrapper.setRelationshipTypeRestList(relationshipTypeRests); - RelationshipTypeResourceWrapper relationshipTypeResourceWrapper = - converter.toResource(relationshipTypeRestWrapper); - return relationshipTypeResourceWrapper; } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/RestResourceController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/RestResourceController.java index d4cb82dcc4..1ed65887aa 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/RestResourceController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/RestResourceController.java @@ -21,6 +21,7 @@ import java.lang.reflect.Method; import java.sql.SQLException; import java.util.ArrayList; import java.util.List; +import java.util.Optional; import java.util.UUID; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; @@ -218,16 +219,16 @@ public class RestResourceController implements InitializingBean { private DSpaceResource findOneInternal(String apiCategory, String model, ID id) { DSpaceRestRepository repository = utils.getResourceRepository(apiCategory, model); - RestAddressableModel modelObject = null; + Optional modelObject = Optional.empty(); try { - modelObject = repository.findOne(id); + modelObject = repository.findById(id); } catch (ClassCastException e) { // ignore, as handled below } - if (modelObject == null) { + if (!modelObject.isPresent()) { throw new ResourceNotFoundException(apiCategory + "." + model + " with id: " + id + " not found"); } - return converter.toResource(modelObject); + return converter.toResource(modelObject.get()); } /** @@ -427,7 +428,7 @@ public class RestResourceController implements InitializingBean { } DSpaceResource result = converter.toResource(modelObject); //TODO manage HTTPHeader - return ControllerUtils.toResponseEntity(HttpStatus.CREATED, null, result); + return ControllerUtils.toResponseEntity(HttpStatus.CREATED, new HttpHeaders(), result); } /** @@ -459,7 +460,7 @@ public class RestResourceController implements InitializingBean { } DSpaceResource result = converter.toResource(modelObject); //TODO manage HTTPHeader - return ControllerUtils.toResponseEntity(HttpStatus.CREATED, null, result); + return ControllerUtils.toResponseEntity(HttpStatus.CREATED, new HttpHeaders(), result); } @@ -496,7 +497,7 @@ public class RestResourceController implements InitializingBean { if (modelObject != null) { DSpaceResource result = converter.toResource(modelObject); - return ControllerUtils.toResponseEntity(HttpStatus.CREATED, null, result); + return ControllerUtils.toResponseEntity(HttpStatus.CREATED, new HttpHeaders(), result); } else { return ControllerUtils.toEmptyResponse(HttpStatus.NO_CONTENT); } @@ -587,7 +588,7 @@ public class RestResourceController implements InitializingBean { return ControllerUtils.toEmptyResponse(HttpStatus.INTERNAL_SERVER_ERROR); } DSpaceResource result = converter.toResource(modelObject); - return ControllerUtils.toResponseEntity(HttpStatus.CREATED, null, result); + return ControllerUtils.toResponseEntity(HttpStatus.CREATED, new HttpHeaders(), result); } /** @@ -626,7 +627,7 @@ public class RestResourceController implements InitializingBean { DSpaceResource result = converter.toResource(modelObject); resources.add(result); } - return ControllerUtils.toResponseEntity(HttpStatus.OK, null, Resources.wrap(resources)); + return ControllerUtils.toResponseEntity(HttpStatus.OK, new HttpHeaders(), Resources.wrap(resources)); } /** @@ -704,7 +705,7 @@ public class RestResourceController implements InitializingBean { } DSpaceResource result = converter.toResource(modelObject); //TODO manage HTTPHeader - return ControllerUtils.toResponseEntity(HttpStatus.OK, null, result); + return ControllerUtils.toResponseEntity(HttpStatus.OK, new HttpHeaders(), result); } @@ -818,7 +819,7 @@ public class RestResourceController implements InitializingBean { throw new RuntimeException(e.getMessage(), e); } } - RestAddressableModel modelObject = repository.findOne(uuid); + RestAddressableModel modelObject = repository.findById(uuid).orElse(null); if (modelObject == null) { throw new ResourceNotFoundException(apiCategory + "." + model + " with id: " + uuid + " not found"); @@ -859,7 +860,7 @@ public class RestResourceController implements InitializingBean { result = assembler.toResource(pageResult); return result; } - int start = page.getOffset(); + int start = Math.toIntExact(page.getOffset()); int end = (start + page.getPageSize()) > fullList.size() ? fullList.size() : (start + page.getPageSize()); DSpaceRestRepository resourceRepository = utils .getResourceRepository(fullList.get(0).getCategory(), fullList.get(0).getType()); @@ -891,6 +892,7 @@ public class RestResourceController implements InitializingBean { Pageable page, PagedResourcesAssembler assembler, HttpServletResponse response) { + DSpaceRestRepository repository = utils.getResourceRepository(apiCategory, model); Link link = linkTo(methodOn(this.getClass(), apiCategory, model).findAll(apiCategory, model, page, assembler, response)) @@ -900,9 +902,7 @@ public class RestResourceController implements InitializingBean { try { resources = repository.findAll(page).map(converter::toResource); } catch (PaginationException pe) { - resources = new PageImpl>(new ArrayList>(), page, pe.getTotal()); - } catch (RepositoryMethodNotImplementedException mne) { - throw mne; + resources = new PageImpl<>(new ArrayList<>(), page, pe.getTotal()); } PagedResources> result = assembler.toResource(resources, link); if (repositoryUtils.haveSearchMethods(repository)) { @@ -1030,7 +1030,7 @@ public class RestResourceController implements InitializingBean { ID id) { checkModelPluralForm(apiCategory, model); DSpaceRestRepository repository = utils.getResourceRepository(apiCategory, model); - repository.delete(id); + repository.deleteById(id); return ControllerUtils.toEmptyResponse(HttpStatus.NO_CONTENT); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/ScriptProcessesController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/ScriptProcessesController.java index 0b0e1922b8..43788dfd1f 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/ScriptProcessesController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/ScriptProcessesController.java @@ -17,6 +17,7 @@ import org.dspace.app.rest.repository.ScriptRestRepository; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.rest.webmvc.ControllerUtils; import org.springframework.hateoas.ResourceSupport; +import org.springframework.http.HttpHeaders; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import org.springframework.security.access.prepost.PreAuthorize; @@ -56,7 +57,7 @@ public class ScriptProcessesController { } ProcessRest processRest = scriptRestRepository.startProcess(scriptName); ProcessResource processResource = converter.toResource(processRest); - return ControllerUtils.toResponseEntity(HttpStatus.ACCEPTED, null, processResource); + return ControllerUtils.toResponseEntity(HttpStatus.ACCEPTED, new HttpHeaders(), processResource); } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/StatisticsRestController.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/StatisticsRestController.java index 26447a7c9b..9422ef32ae 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/StatisticsRestController.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/StatisticsRestController.java @@ -28,6 +28,7 @@ import org.springframework.data.rest.webmvc.ControllerUtils; import org.springframework.hateoas.Link; import org.springframework.hateoas.PagedResources; import org.springframework.hateoas.ResourceSupport; +import org.springframework.http.HttpHeaders; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.PathVariable; @@ -96,13 +97,13 @@ public class StatisticsRestController implements InitializingBean { @RequestMapping(method = RequestMethod.POST, value = "/viewevents") public ResponseEntity postViewEvent() throws Exception { ViewEventResource result = converter.toResource(viewEventRestRepository.createViewEvent()); - return ControllerUtils.toResponseEntity(HttpStatus.CREATED, null, result); + return ControllerUtils.toResponseEntity(HttpStatus.CREATED, new HttpHeaders(), result); } @RequestMapping(method = RequestMethod.POST, value = "/searchevents") public ResponseEntity postSearchEvent() throws Exception { SearchEventResource result = converter.toResource(searchEventRestRepository.createSearchEvent()); - return ControllerUtils.toResponseEntity(HttpStatus.CREATED, null, result); + return ControllerUtils.toResponseEntity(HttpStatus.CREATED, new HttpHeaders(), result); } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/AInprogressItemConverter.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/AInprogressItemConverter.java index 4ad8b5743a..e589bc1b22 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/AInprogressItemConverter.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/AInprogressItemConverter.java @@ -7,8 +7,6 @@ */ package org.dspace.app.rest.converter; -import java.io.Serializable; -import java.sql.SQLException; import java.util.List; import org.apache.commons.lang3.StringUtils; @@ -38,11 +36,9 @@ import org.springframework.beans.factory.annotation.Autowired; * the DSpace API inprogressSubmission object * @param * the DSpace REST inprogressSubmission representation - * @param - * the Serializable class used as primary key */ -public abstract class AInprogressItemConverter, - R extends AInprogressSubmissionRest, ID extends Serializable> +public abstract class AInprogressItemConverter implements IndexableObjectConverter { private static final Logger log = org.apache.logging.log4j.LogManager.getLogger(AInprogressItemConverter.class); @@ -66,11 +62,7 @@ public abstract class AInprogressItemConverter { +public class BrowseEntryConverter implements Function { private static final Logger log = org.apache.logging.log4j.LogManager.getLogger(BrowseEntryConverter.class); @Override - public BrowseEntryRest convert(String[] source) { + public BrowseEntryRest apply(String[] source) { BrowseEntryRest entry = new BrowseEntryRest(); entry.setValue(source[0]); entry.setAuthority(source[1]); diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ClaimedTaskConverter.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ClaimedTaskConverter.java index ab23be4c1c..42ae152461 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ClaimedTaskConverter.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ClaimedTaskConverter.java @@ -47,8 +47,7 @@ public class ClaimedTaskConverter } @Override - public boolean supportsModel(IndexableObject object) { - return object instanceof ClaimedTask; + public boolean supportsModel(IndexableObject idxo) { + return idxo.getIndexedObject() instanceof ClaimedTask; } - } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/CollectionConverter.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/CollectionConverter.java index 66d949630c..affac38ed5 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/CollectionConverter.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/CollectionConverter.java @@ -109,6 +109,6 @@ public class CollectionConverter @Override public boolean supportsModel(IndexableObject idxo) { - return idxo instanceof Collection; + return idxo.getIndexedObject() instanceof Collection; } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/CommunityConverter.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/CommunityConverter.java index 4f386e7fcb..0ff00ab49d 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/CommunityConverter.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/CommunityConverter.java @@ -75,6 +75,6 @@ public class CommunityConverter @Override public boolean supportsModel(IndexableObject idxo) { - return idxo instanceof Community; + return idxo.getIndexedObject() instanceof Community; } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/DiscoverResultConverter.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/DiscoverResultConverter.java index 8826552015..772961a50f 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/DiscoverResultConverter.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/DiscoverResultConverter.java @@ -91,10 +91,11 @@ public class DiscoverResultConverter { } } - private RestAddressableModel convertDSpaceObject(final IndexableObject dspaceObject, final Projection projection) { - for (IndexableObjectConverter converter : converters) { - if (converter.supportsModel(dspaceObject)) { - return converter.convert(dspaceObject, projection); + private RestAddressableModel convertDSpaceObject(final IndexableObject indexableObject, + final Projection projection) { + for (IndexableObjectConverter converter : converters) { + if (converter.supportsModel(indexableObject)) { + return converter.convert(indexableObject.getIndexedObject(), projection); } } return null; diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/IndexableObjectConverter.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/IndexableObjectConverter.java index b4e789ab1f..784bb8fa6e 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/IndexableObjectConverter.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/IndexableObjectConverter.java @@ -17,11 +17,11 @@ import org.dspace.discovery.IndexableObject; * @param the Class in the DSpace REST data model * @author Andrea Bollini (andrea.bollini at 4science.it) */ -public interface IndexableObjectConverter extends DSpaceConverter { /** - * + * * @param idxo * the IndexableObject to check * @return true if the actual converter implementation is able to manage the supplied IndexableObject diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ItemConverter.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ItemConverter.java index 1df7af79bf..15a18384eb 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ItemConverter.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/ItemConverter.java @@ -82,6 +82,6 @@ public class ItemConverter @Override public boolean supportsModel(IndexableObject idxo) { - return idxo instanceof Item; + return idxo.getIndexedObject() instanceof Item; } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/PoolTaskConverter.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/PoolTaskConverter.java index e6530d6d6b..7a58fda864 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/PoolTaskConverter.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/PoolTaskConverter.java @@ -53,8 +53,7 @@ public class PoolTaskConverter } @Override - public boolean supportsModel(IndexableObject object) { - return object instanceof PoolTask; + public boolean supportsModel(IndexableObject idxo) { + return idxo.getIndexedObject() instanceof PoolTask; } - } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/RelationshipTypeConverter.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/RelationshipTypeConverter.java index d2f86cf6bb..c20249c025 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/RelationshipTypeConverter.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/RelationshipTypeConverter.java @@ -31,6 +31,8 @@ public class RelationshipTypeConverter implements DSpaceConverter { + extends AInprogressItemConverter { public WorkflowItemConverter() throws SubmissionConfigReaderException { super(); @@ -44,6 +44,6 @@ public class WorkflowItemConverter @Override public boolean supportsModel(IndexableObject object) { - return object instanceof XmlWorkflowItem; + return object.getIndexedObject() instanceof XmlWorkflowItem; } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/WorkspaceItemConverter.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/WorkspaceItemConverter.java index 24252d1449..388ef7e032 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/WorkspaceItemConverter.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/WorkspaceItemConverter.java @@ -22,7 +22,7 @@ import org.springframework.stereotype.Component; */ @Component public class WorkspaceItemConverter - extends AInprogressItemConverter { + extends AInprogressItemConverter { public WorkspaceItemConverter() throws SubmissionConfigReaderException { super(); @@ -47,6 +47,6 @@ public class WorkspaceItemConverter @Override public boolean supportsModel(IndexableObject object) { - return object instanceof WorkspaceItem; + return object.getIndexedObject() instanceof WorkspaceItem; } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/relation/EntityTypeHalLinkFactory.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/relation/EntityTypeHalLinkFactory.java index 326caa7eef..d2741181c1 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/relation/EntityTypeHalLinkFactory.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/relation/EntityTypeHalLinkFactory.java @@ -28,7 +28,7 @@ public class EntityTypeHalLinkFactory extends HalLinkFactory list) throws Exception { list.add(buildLink("relationshiptypes", getMethodOn().retrieve( - halResource.getContent().getId(), null, null))); + halResource.getContent().getId(), null, null, null, null))); } @Override diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/relation/RelationshipTypeResourceWrapperHalLinkFactory.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/relation/RelationshipTypeResourceWrapperHalLinkFactory.java deleted file mode 100644 index f3dccbddbd..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/link/relation/RelationshipTypeResourceWrapperHalLinkFactory.java +++ /dev/null @@ -1,45 +0,0 @@ -/** - * The contents of this file are subject to the license and copyright - * detailed in the LICENSE and NOTICE files at the root of the source - * tree and available online at - * - * http://www.dspace.org/license/ - */ -package org.dspace.app.rest.link.relation; - -import java.util.LinkedList; - -import org.dspace.app.rest.RelationshipTypeRestController; -import org.dspace.app.rest.link.HalLinkFactory; -import org.dspace.app.rest.model.hateoas.RelationshipTypeResourceWrapper; -import org.springframework.data.domain.Pageable; -import org.springframework.hateoas.Link; -import org.springframework.stereotype.Component; - -/** - * This class' purpose is to add the links to the RelationshipTypeResourceWrapper. - * This function and class will be called and used - * when the HalLinkService addLinks methods is called as it'll iterate over all the different factories and check - * whether - * these are allowed to create links for said resource or not. - */ -@Component -public class RelationshipTypeResourceWrapperHalLinkFactory - extends HalLinkFactory { - @Override - protected void addLinks(RelationshipTypeResourceWrapper halResource, Pageable pageable, LinkedList list) - throws Exception { - list.add(buildLink(Link.REL_SELF, getMethodOn() - .retrieve(halResource.getContent().getEntityTypeId(), null, null))); - } - - @Override - protected Class getControllerClass() { - return RelationshipTypeRestController.class; - } - - @Override - protected Class getResourceClass() { - return RelationshipTypeResourceWrapper.class; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/AInprogressSubmissionRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/AInprogressSubmissionRest.java index e142567e71..903e2866c8 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/AInprogressSubmissionRest.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/AInprogressSubmissionRest.java @@ -19,10 +19,8 @@ import com.fasterxml.jackson.annotation.JsonIgnore; * * @author Andrea Bollini (andrea.bollini at 4science.it) * - * @param - * the serializable class used as primary key */ -public abstract class AInprogressSubmissionRest extends BaseObjectRest { +public abstract class AInprogressSubmissionRest extends BaseObjectRest { private Date lastModified = new Date(); private Map sections; diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/EntityTypeRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/EntityTypeRest.java index fecd065815..454e5a82b6 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/EntityTypeRest.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/EntityTypeRest.java @@ -17,6 +17,7 @@ import org.dspace.app.rest.RestResourceController; public class EntityTypeRest extends BaseObjectRest { public static final String NAME = "entitytype"; + public static final String NAME_PLURAL = "entitytypes"; public static final String CATEGORY = "core"; public String getCategory() { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/RelationshipTypeRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/RelationshipTypeRest.java index f38c4ac2e4..b398bb4a9f 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/RelationshipTypeRest.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/RelationshipTypeRest.java @@ -22,6 +22,8 @@ public class RelationshipTypeRest extends BaseObjectRest { private String leftwardType; private String rightwardType; + private boolean copyToLeft; + private boolean copyToRight; private Integer leftMinCardinality; private Integer leftMaxCardinality; private Integer rightMinCardinality; @@ -57,6 +59,38 @@ public class RelationshipTypeRest extends BaseObjectRest { this.rightwardType = rightwardType; } + /** + * Generic getter for the copyToLeft + * @return the copyToLeft value of this RelationshipTypeRest + */ + public boolean isCopyToLeft() { + return copyToLeft; + } + + /** + * Generic setter for the copyToLeft + * @param copyToLeft The copyToLeft to be set on this RelationshipTypeRest + */ + public void setCopyToLeft(boolean copyToLeft) { + this.copyToLeft = copyToLeft; + } + + /** + * Generic getter for the copyToRight + * @return the copyToRight value of this RelationshipTypeRest + */ + public boolean isCopyToRight() { + return copyToRight; + } + + /** + * Generic setter for the copyToRight + * @param copyToRight The copyToRight to be set on this RelationshipTypeRest + */ + public void setCopyToRight(boolean copyToRight) { + this.copyToRight = copyToRight; + } + public Integer getLeftMinCardinality() { return leftMinCardinality; } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/RelationshipTypeRestWrapper.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/RelationshipTypeRestWrapper.java deleted file mode 100644 index 2aa0891005..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/RelationshipTypeRestWrapper.java +++ /dev/null @@ -1,65 +0,0 @@ -/** - * The contents of this file are subject to the license and copyright - * detailed in the LICENSE and NOTICE files at the root of the source - * tree and available online at - * - * http://www.dspace.org/license/ - */ -package org.dspace.app.rest.model; - -import java.util.List; - -import com.fasterxml.jackson.annotation.JsonIgnore; -import org.dspace.app.rest.RelationshipTypeRestController; - -/** - * This is the RestWrapper object for the RelationshipTypeRestResource class. This will contain all the data that is - * used in that resource and more specifically, the entityTypeLabel, entityTypeId and list of - * RelationshipTypeRest objects - * The other methods are generic getters and setters - */ -public class RelationshipTypeRestWrapper extends RestAddressableModel { - - @JsonIgnore - private List relationshipTypeRestList; - - private String entityTypeLabel; - private Integer entityTypeId; - - public List getRelationshipTypeRestList() { - return relationshipTypeRestList; - } - - public void setRelationshipTypeRestList( - List relationshipTypeRestList) { - this.relationshipTypeRestList = relationshipTypeRestList; - } - - public String getCategory() { - return "core"; - } - - public Class getController() { - return RelationshipTypeRestController.class; - } - - public String getType() { - return "relationshiptype"; - } - - public String getEntityTypeLabel() { - return entityTypeLabel; - } - - public void setEntityTypeLabel(String label) { - this.entityTypeLabel = label; - } - - public Integer getEntityTypeId() { - return entityTypeId; - } - - public void setEntityTypeId(Integer entityTypeId) { - this.entityTypeId = entityTypeId; - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ViewEventRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ViewEventRest.java index 5c2a827f9f..351a32eab0 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ViewEventRest.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/ViewEventRest.java @@ -9,6 +9,7 @@ package org.dspace.app.rest.model; import java.util.UUID; +import com.fasterxml.jackson.annotation.JsonIgnore; import com.fasterxml.jackson.annotation.JsonProperty; import org.dspace.app.rest.RestResourceController; @@ -23,6 +24,12 @@ public class ViewEventRest extends BaseObjectRest { private UUID targetId; private String targetType; + @Override + @JsonIgnore + public UUID getId() { + return id; + } + public UUID getTargetId() { return targetId; } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/WorkflowItemRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/WorkflowItemRest.java index 831baefec1..bf00ba0e4f 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/WorkflowItemRest.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/WorkflowItemRest.java @@ -14,7 +14,7 @@ import org.dspace.app.rest.RestResourceController; * * @author Andrea Bollini (andrea.bollini at 4science.it) */ -public class WorkflowItemRest extends AInprogressSubmissionRest { +public class WorkflowItemRest extends AInprogressSubmissionRest { public static final String NAME = "workflowitem"; public static final String CATEGORY = RestAddressableModel.WORKFLOW; diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/WorkspaceItemRest.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/WorkspaceItemRest.java index 3fac0eeef1..69fefd1a9b 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/WorkspaceItemRest.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/WorkspaceItemRest.java @@ -14,7 +14,7 @@ import org.dspace.app.rest.RestResourceController; * * @author Andrea Bollini (andrea.bollini at 4science.it) */ -public class WorkspaceItemRest extends AInprogressSubmissionRest { +public class WorkspaceItemRest extends AInprogressSubmissionRest { public static final String NAME = "workspaceitem"; public static final String CATEGORY = RestAddressableModel.SUBMISSION; diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/RelationshipTypeResourceWrapper.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/RelationshipTypeResourceWrapper.java deleted file mode 100644 index 57f722d3ca..0000000000 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/model/hateoas/RelationshipTypeResourceWrapper.java +++ /dev/null @@ -1,41 +0,0 @@ -/** - * The contents of this file are subject to the license and copyright - * detailed in the LICENSE and NOTICE files at the root of the source - * tree and available online at - * - * http://www.dspace.org/license/ - */ -package org.dspace.app.rest.model.hateoas; - -import java.util.LinkedList; -import java.util.List; - -import org.dspace.app.rest.model.RelationshipTypeRest; -import org.dspace.app.rest.model.RelationshipTypeRestWrapper; -import org.dspace.app.rest.utils.Utils; - -/** - * This is the RelationshipTypeResourceWrapper class which will take the - * RelationshipTypeRestWrapper's data and transform this into a resource with the data, embeds and links. - */ -public class RelationshipTypeResourceWrapper extends HALResource { - - /** - * The constructor for the RelationshipTypeResourceWrapper - * This will call the HALResource constructor and additionally add embeds to the resource - * @param content The RelationshipTypeRestWrapper object that contains the data - */ - public RelationshipTypeResourceWrapper(RelationshipTypeRestWrapper content, Utils utils) { - super(content); - addEmbeds(content, utils); - } - - private void addEmbeds(RelationshipTypeRestWrapper content, Utils utils) { - List list = new LinkedList<>(); - for (RelationshipTypeRest relationshipTypeRest : content.getRelationshipTypeRestList()) { - list.add(new RelationshipTypeResource(relationshipTypeRest, utils)); - } - - embedResource("relationshiptypes", list); - } -} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/AuthorityEntryLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/AuthorityEntryLinkRepository.java index 17ae198903..24422e4109 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/AuthorityEntryLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/AuthorityEntryLinkRepository.java @@ -68,7 +68,8 @@ public class AuthorityEntryLinkRepository extends AbstractDSpaceRestRepository if (StringUtils.isNotBlank(metadata)) { String[] tokens = org.dspace.core.Utils.tokenize(metadata); String fieldKey = org.dspace.core.Utils.standardize(tokens[0], tokens[1], tokens[2], "_"); - Choices choices = cas.getMatches(fieldKey, query, collection, pageable.getOffset(), pageable.getPageSize(), + Choices choices = cas.getMatches(fieldKey, query, collection, Math.toIntExact(pageable.getOffset()), + pageable.getPageSize(), context.getCurrentLocale().toString()); for (Choice value : choices.values) { results.add(authorityUtils.convertEntry(value, name, projection)); diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamRestRepository.java index 1a23515f90..51155289da 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamRestRepository.java @@ -101,7 +101,7 @@ public class BitstreamRestRepository extends DSpaceObjectRestRepository tmpResult = new ArrayList(); - for (IndexableObject bb : binfo.getBrowseItemResults()) { - tmpResult.add((Item) bb); + for (Item bb : binfo.getBrowseItemResults()) { + tmpResult.add(bb); } return converter.toRestPage(tmpResult, pageResultInfo, binfo.getTotal(), projection); diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BundleRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BundleRestRepository.java index 144c2d5daf..7d8e7f56ca 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BundleRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BundleRestRepository.java @@ -40,6 +40,7 @@ import org.dspace.core.Context; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.domain.Page; import org.springframework.data.domain.Pageable; +import org.springframework.data.rest.webmvc.ResourceNotFoundException; import org.springframework.security.access.AccessDeniedException; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.stereotype.Component; @@ -202,4 +203,30 @@ public class BundleRestRepository extends DSpaceObjectRestRepository getDomainClass() { return BundleRest.class; } + + /** + * Deletes a bundle whose uuid is given and deletes all the bitstreams it contains in BundleService.delete + * @param context + * the dspace context + * @param id + * the id of the bundle to delete + */ + @Override + @PreAuthorize("hasPermission(#id, 'BUNDLE', 'DELETE')") + protected void delete(Context context, UUID id) throws AuthorizeException { + Bundle bundleToDelete = null; + try { + bundleToDelete = bundleService.find(context, id); + if (bundleToDelete == null) { + throw new ResourceNotFoundException("Bundle with id: " + id + " not found"); + } + } catch (SQLException e) { + throw new RuntimeException("Can't find a bundle with id: " + id, e); + } + try { + bundleService.delete(context, bundleToDelete); + } catch (IOException | SQLException e) { + throw new RuntimeException("Something went wrong trying to delete bundle with id: " + id, e); + } + } } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionRestRepository.java index 5be6944db3..8c8853e6e7 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionRestRepository.java @@ -95,7 +95,8 @@ public class CollectionRestRepository extends DSpaceObjectRestRepository findAll(Context context, Pageable pageable) { try { long total = cs.countTotal(context); - List collections = cs.findAll(context, pageable.getPageSize(), pageable.getOffset()); + List collections = cs.findAll(context, pageable.getPageSize(), + Math.toIntExact(pageable.getOffset())); return converter.toRestPage(collections, pageable, total, utils.obtainProjection(true)); } catch (SQLException e) { throw new RuntimeException(e.getMessage(), e); diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CommunityRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CommunityRestRepository.java index c2414a7564..94d5670713 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CommunityRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CommunityRestRepository.java @@ -149,7 +149,8 @@ public class CommunityRestRepository extends DSpaceObjectRestRepository findAll(Context context, Pageable pageable) { try { long total = cs.countTotal(context); - List communities = cs.findAll(context, pageable.getPageSize(), pageable.getOffset()); + List communities = cs.findAll(context, pageable.getPageSize(), + Math.toIntExact(pageable.getOffset())); return converter.toRestPage(communities, pageable, total, utils.obtainProjection(true)); } catch (SQLException e) { throw new RuntimeException(e.getMessage(), e); diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/DSpaceObjectRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/DSpaceObjectRestRepository.java index c7a0082f1d..d0b9cf410a 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/DSpaceObjectRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/DSpaceObjectRestRepository.java @@ -19,6 +19,7 @@ import org.dspace.app.rest.repository.patch.DSpaceObjectPatch; import org.dspace.authorize.AuthorizeException; import org.dspace.content.DSpaceObject; import org.dspace.content.service.DSpaceObjectService; +import org.dspace.core.Context; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.rest.webmvc.ResourceNotFoundException; @@ -57,11 +58,12 @@ public abstract class DSpaceObjectRestRepository Iterable save(Iterable entities) { + public Iterable saveAll(Iterable entities) { // TODO Auto-generated method stub return null; } @@ -105,9 +106,14 @@ public abstract class DSpaceRestRepository findById(ID id) { Context context = obtainContext(); - return thisRepository.findOne(context, id); + final T object = thisRepository.findOne(context, id); + if (object == null) { + return Optional.empty(); + } else { + return Optional.of(object); + } } /** @@ -126,8 +132,8 @@ public abstract class DSpaceRestRepository findAll(Iterable ids) { + public Iterable findAllById(Iterable ids) { throw new RuntimeException("findAll MUST be paginated"); } @@ -161,7 +167,7 @@ public abstract class DSpaceRestRepository entities) { + public void deleteAll(Iterable entities) { // TODO Auto-generated method stub } @@ -412,7 +418,7 @@ public abstract class DSpaceRestRepository findAll(Context context, Pageable pageable) { try { long total = es.countTotal(context); - List epersons = es.findAll(context, EPerson.EMAIL, pageable.getPageSize(), pageable.getOffset()); + List epersons = es.findAll(context, EPerson.EMAIL, pageable.getPageSize(), + Math.toIntExact(pageable.getOffset())); return converter.toRestPage(epersons, pageable, total, utils.obtainProjection(true)); } catch (SQLException e) { throw new RuntimeException(e.getMessage(), e); @@ -135,8 +136,8 @@ public class EPersonRestRepository extends DSpaceObjectRestRepository epersons = es.search(context, q, pageable.getOffset(), - pageable.getOffset() + pageable.getPageSize()); + List epersons = es.search(context, q, Math.toIntExact(pageable.getOffset()), + Math.toIntExact(pageable.getOffset() + pageable.getPageSize())); return converter.toRestPage(epersons, pageable, total, utils.obtainProjection(true)); } catch (SQLException e) { throw new RuntimeException(e.getMessage(), e); diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ExternalSourceRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ExternalSourceRestRepository.java index 5bf84a3d57..5032a73645 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ExternalSourceRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ExternalSourceRestRepository.java @@ -70,7 +70,8 @@ public class ExternalSourceRestRepository extends DSpaceRestRepository externalDataObjects = externalDataService - .searchExternalDataObjects(externalSourceName, query, pageable.getOffset(), pageable.getPageSize()); + .searchExternalDataObjects(externalSourceName, query, Math.toIntExact(pageable.getOffset()), + pageable.getPageSize()); int numberOfResults = externalDataService.getNumberOfResults(externalSourceName, query); return converter.toRestPage(externalDataObjects, pageable, numberOfResults, utils.obtainProjection(true)); diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/GroupRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/GroupRestRepository.java index e8f0ec9a54..274180d1bf 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/GroupRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/GroupRestRepository.java @@ -98,7 +98,8 @@ public class GroupRestRepository extends DSpaceObjectRestRepository findAll(Context context, Pageable pageable) { try { long total = gs.countTotal(context); - List groups = gs.findAll(context, null, pageable.getPageSize(), pageable.getOffset()); + List groups = gs.findAll(context, null, pageable.getPageSize(), + Math.toIntExact(pageable.getOffset())); return converter.toRestPage(groups, pageable, total, utils.obtainProjection(true)); } catch (SQLException e) { throw new RuntimeException(e.getMessage(), e); diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemRelationshipLinkRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemRelationshipLinkRepository.java index 4c76dc2274..f51a39258e 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemRelationshipLinkRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemRelationshipLinkRepository.java @@ -53,7 +53,7 @@ public class ItemRelationshipLinkRepository extends AbstractDSpaceRestRepository } Pageable pageable = optionalPageable != null ? optionalPageable : new PageRequest(0, 20); Integer limit = pageable == null ? null : pageable.getPageSize(); - Integer offset = pageable == null ? null : pageable.getOffset(); + Integer offset = pageable == null ? null : Math.toIntExact(pageable.getOffset()); int total = relationshipService.countByItem(context, item); List relationships = relationshipService.findByItem(context, item, limit, offset); return converter.toRestPage(relationships, pageable, total, projection); diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemRestRepository.java index ea44514fa3..1ee570c4a9 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemRestRepository.java @@ -122,7 +122,8 @@ public class ItemRestRepository extends DSpaceObjectRestRepository findAll(Context context, Pageable pageable) { try { long total = itemService.countTotal(context); - Iterator it = itemService.findAll(context, pageable.getPageSize(), pageable.getOffset()); + Iterator it = itemService.findAll(context, pageable.getPageSize(), + Math.toIntExact(pageable.getOffset())); List items = new ArrayList<>(); while (it.hasNext()) { items.add(it.next()); diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java index ebfdb4d2a6..e49e33f9fe 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ProcessRestRepository.java @@ -52,7 +52,8 @@ public class ProcessRestRepository extends DSpaceRestRepository findAll(Context context, Pageable pageable) { try { int total = processService.countTotal(context); - List processes = processService.findAll(context, pageable.getPageSize(), pageable.getOffset()); + List processes = processService.findAll(context, pageable.getPageSize(), + Math.toIntExact(pageable.getOffset())); return converter.toRestPage(processes, pageable, total, utils.obtainProjection(true)); } catch (SQLException e) { throw new RuntimeException(e.getMessage(), e); diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/RelationshipRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/RelationshipRestRepository.java index d0921a0b34..2c12f8c558 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/RelationshipRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/RelationshipRestRepository.java @@ -85,7 +85,7 @@ public class RelationshipRestRepository extends DSpaceRestRepository relationships = relationshipService.findAll(context, - pageable.getPageSize(), pageable.getOffset()); + pageable.getPageSize(), Math.toIntExact(pageable.getOffset())); return converter.toRestPage(relationships, pageable, total, utils.obtainProjection(true)); } catch (SQLException e) { throw new RuntimeException(e.getMessage(), e); @@ -351,15 +351,19 @@ public class RelationshipRestRepository extends DSpaceRestRepository findAll(Context context, Pageable pageable) { int total = submissionConfigReader.countSubmissionConfigs(); List subConfs = submissionConfigReader.getAllSubmissionConfigs( - pageable.getPageSize(), pageable.getOffset()); + pageable.getPageSize(), Math.toIntExact(pageable.getOffset())); return converter.toRestPage(subConfs, pageable, total, utils.obtainProjection(true)); } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionFormRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionFormRestRepository.java index 51b0075e17..c953190b05 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionFormRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionFormRestRepository.java @@ -54,7 +54,8 @@ public class SubmissionFormRestRepository extends DSpaceRestRepository findAll(Context context, Pageable pageable) { try { long total = inputReader.countInputs(); - List subConfs = inputReader.getAllInputs(pageable.getPageSize(), pageable.getOffset()); + List subConfs = inputReader.getAllInputs(pageable.getPageSize(), + Math.toIntExact(pageable.getOffset())); return converter.toRestPage(subConfs, pageable, total, utils.obtainProjection(true)); } catch (DCInputsReaderException e) { throw new IllegalStateException(e.getMessage(), e); diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionPanelRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionPanelRestRepository.java index b9acb2ea32..fb2cb2c59b 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionPanelRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionPanelRestRepository.java @@ -52,7 +52,7 @@ public class SubmissionPanelRestRepository extends DSpaceRestRepository findAll(Context context, Pageable pageable) { List subConfs = submissionConfigReader.getAllSubmissionConfigs( - pageable.getPageSize(), pageable.getOffset()); + pageable.getPageSize(), Math.toIntExact(pageable.getOffset())); long total = 0; List stepConfs = new ArrayList<>(); for (SubmissionConfig config : subConfs) { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionUploadRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionUploadRestRepository.java index db3672aa4a..897cb2afb6 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionUploadRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/SubmissionUploadRestRepository.java @@ -79,7 +79,8 @@ public class SubmissionUploadRestRepository extends DSpaceRestRepository findAll(Context context, Pageable pageable) { List subConfs = new ArrayList(); - subConfs = submissionConfigReader.getAllSubmissionConfigs(pageable.getPageSize(), pageable.getOffset()); + subConfs = submissionConfigReader.getAllSubmissionConfigs(pageable.getPageSize(), + Math.toIntExact(pageable.getOffset())); Projection projection = utils.obtainProjection(true); List results = new ArrayList<>(); for (SubmissionConfig config : subConfs) { @@ -134,7 +135,7 @@ public class SubmissionUploadRestRepository extends DSpaceRestRepository errors = new ArrayList(); SubmissionConfig submissionConfig = @@ -218,7 +218,7 @@ public class WorkflowItemRestRepository extends DSpaceRestRepository operations = patch.getOperations(); - WorkflowItemRest wsi = findOne(id); + WorkflowItemRest wsi = findOne(context, id); XmlWorkflowItem source = wis.find(context, id); for (Operation op : operations) { //the value in the position 0 is a null value diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/WorkspaceItemRestRepository.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/WorkspaceItemRestRepository.java index 9aa8df3492..2f9312cf93 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/WorkspaceItemRestRepository.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/WorkspaceItemRestRepository.java @@ -26,11 +26,13 @@ import org.dspace.app.rest.Parameter; import org.dspace.app.rest.SearchRestMethod; import org.dspace.app.rest.converter.WorkspaceItemConverter; import org.dspace.app.rest.exception.DSpaceBadRequestException; +import org.dspace.app.rest.exception.RepositoryMethodNotImplementedException; import org.dspace.app.rest.model.ErrorRest; import org.dspace.app.rest.model.WorkspaceItemRest; import org.dspace.app.rest.model.patch.Operation; import org.dspace.app.rest.model.patch.Patch; import org.dspace.app.rest.projection.Projection; +import org.dspace.app.rest.repository.handler.service.UriListHandlerService; import org.dspace.app.rest.submit.AbstractRestProcessingStep; import org.dspace.app.rest.submit.SubmissionService; import org.dspace.app.rest.submit.UploadableStep; @@ -109,6 +111,9 @@ public class WorkspaceItemRestRepository extends DSpaceRestRepository findAll(Context context, Pageable pageable) { try { long total = wis.countTotal(context); - List witems = wis.findAll(context, pageable.getPageSize(), pageable.getOffset()); + List witems = wis.findAll(context, pageable.getPageSize(), + Math.toIntExact(pageable.getOffset())); return converter.toRestPage(witems, pageable, total, utils.obtainProjection(true)); } catch (SQLException e) { throw new RuntimeException(e.getMessage(), e); @@ -150,7 +156,8 @@ public class WorkspaceItemRestRepository extends DSpaceRestRepository witems = wis.findByEPerson(context, ep, pageable.getPageSize(), pageable.getOffset()); + List witems = wis.findByEPerson(context, ep, pageable.getPageSize(), + Math.toIntExact(pageable.getOffset())); return converter.toRestPage(witems, pageable, total, utils.obtainProjection(true)); } catch (SQLException e) { throw new RuntimeException(e.getMessage(), e); @@ -213,7 +220,7 @@ public class WorkspaceItemRestRepository extends DSpaceRestRepository errors = new ArrayList(); SubmissionConfig submissionConfig = @@ -262,7 +269,7 @@ public class WorkspaceItemRestRepository extends DSpaceRestRepository operations = patch.getOperations(); - WorkspaceItemRest wsi = findOne(id); + WorkspaceItemRest wsi = findOne(context, id); WorkspaceItem source = wis.find(context, id); for (Operation op : operations) { //the value in the position 0 is a null value @@ -481,4 +488,14 @@ public class WorkspaceItemRestRepository extends DSpaceRestRepository stringList) + throws AuthorizeException, SQLException, RepositoryMethodNotImplementedException { + + HttpServletRequest req = getRequestService().getCurrentRequest().getHttpServletRequest(); + WorkspaceItem workspaceItem = uriListHandlerService.handle(context, req, stringList, WorkspaceItem.class); + return converter.toRest(workspaceItem, Projection.DEFAULT); + } + + } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/handler/ExternalSourceEntryArchivedItemUriListHandler.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/handler/ExternalSourceEntryArchivedItemUriListHandler.java new file mode 100644 index 0000000000..86189933d9 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/handler/ExternalSourceEntryArchivedItemUriListHandler.java @@ -0,0 +1,82 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.app.rest.repository.handler; + +import java.sql.SQLException; +import java.util.List; +import javax.servlet.http.HttpServletRequest; + +import org.apache.logging.log4j.Logger; +import org.dspace.authorize.AuthorizeException; +import org.dspace.authorize.service.AuthorizeService; +import org.dspace.content.Item; +import org.dspace.content.WorkspaceItem; +import org.dspace.content.service.InstallItemService; +import org.dspace.core.Context; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Component; + +/** + * This class will handle ExternalSourceEntryUriList and it'll create Item objects based on them. + * This will create Archived items and thus only Admin users can use it + */ +@Component +public class ExternalSourceEntryArchivedItemUriListHandler extends ExternalSourceEntryItemUriListHandler { + + @Autowired + private AuthorizeService authorizeService; + + @Autowired + private InstallItemService installItemService; + + private static final Logger log = org.apache.logging.log4j.LogManager + .getLogger(ExternalSourceEntryItemUriListHandler.class); + + @Override + public boolean supports(List uriList, String method, Class clazz) { + if (!super.supports(uriList, method, clazz)) { + return false; + } + if (clazz != Item.class) { + return false; + } + return true; + } + + @Override + public boolean validate(Context context, HttpServletRequest request, List uriList) + throws AuthorizeException { + if (!super.validate(context, request, uriList)) { + return false; + } + try { + if (!authorizeService.isAdmin(context)) { + throw new AuthorizeException("Only admins are allowed to create items using external data"); + } + } catch (SQLException e) { + log.error("context isAdmin check resulted in an error", e); + return false; + } + return true; + } + + @Override + public Item handle(Context context, HttpServletRequest request, List uriList) + throws SQLException, AuthorizeException { + String owningCollectionUuid = request.getParameter("owningCollection"); + try { + WorkspaceItem workspaceItem = super.createWorkspaceItem(context, request, uriList); + return installItemService.installItem(context, workspaceItem); + } catch (AuthorizeException | SQLException e) { + log.error("An error occured when trying to create item in collection with uuid: " + owningCollectionUuid, + e); + throw e; + } + } + +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/handler/ExternalSourceEntryUriListHandler.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/handler/ExternalSourceEntryItemUriListHandler.java similarity index 74% rename from dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/handler/ExternalSourceEntryUriListHandler.java rename to dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/handler/ExternalSourceEntryItemUriListHandler.java index cce12e63a6..3ad9b7a193 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/handler/ExternalSourceEntryUriListHandler.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/handler/ExternalSourceEntryItemUriListHandler.java @@ -21,29 +21,25 @@ import org.apache.commons.lang3.StringUtils; import org.apache.logging.log4j.Logger; import org.dspace.app.rest.model.ExternalSourceRest; import org.dspace.authorize.AuthorizeException; -import org.dspace.authorize.service.AuthorizeService; import org.dspace.content.Collection; -import org.dspace.content.Item; +import org.dspace.content.WorkspaceItem; import org.dspace.content.service.CollectionService; import org.dspace.core.Context; import org.dspace.external.model.ExternalDataObject; import org.dspace.external.service.ExternalDataService; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.rest.webmvc.ResourceNotFoundException; -import org.springframework.stereotype.Component; import org.springframework.web.bind.annotation.RequestMethod; /** - * This class will handle ExternalSourceEntryUriList and it'll create Item objects based on them + * This provides an abstract class for the Item and WorkspaceItemUriListHandlers to extend and provide shared logic + * to reduce code duplication + * @param The type of Object we're dealing with */ -@Component -public class ExternalSourceEntryUriListHandler implements UriListHandler { +public abstract class ExternalSourceEntryItemUriListHandler implements UriListHandler { private List allowedRequestMethods = new LinkedList<>(Arrays.asList(RequestMethod.POST)); - @Autowired - private AuthorizeService authorizeService; - @Autowired private ExternalDataService externalDataService; @@ -51,11 +47,10 @@ public class ExternalSourceEntryUriListHandler implements UriListHandler { private CollectionService collectionService; private static final Logger log = org.apache.logging.log4j.LogManager - .getLogger(ExternalSourceEntryUriListHandler.class); - + .getLogger(ExternalSourceEntryItemUriListHandler.class); @Override - public boolean supports(List uriList, String method) { + public boolean supports(List uriList, String method, Class clazz) { if (!allowedRequestMethods.contains(RequestMethod.valueOf(method))) { return false; } @@ -69,22 +64,16 @@ public class ExternalSourceEntryUriListHandler implements UriListHandler { } @Override - public boolean validate(Context context, HttpServletRequest request, List uriList, - Class clazz) throws AuthorizeException { + public boolean validate(Context context, HttpServletRequest request, List uriList) + throws AuthorizeException { if (uriList.size() > 1) { return false; } - if (clazz != Item.class) { - return false; - } String owningCollectionString = request.getParameter("owningCollection"); if (StringUtils.isBlank(owningCollectionString)) { return false; } try { - if (!authorizeService.isAdmin(context)) { - throw new AuthorizeException("Only admins are allowed to create items using external data"); - } Collection collection = collectionService.find(context, UUID.fromString(owningCollectionString)); if (collection == null) { return false; @@ -97,23 +86,30 @@ public class ExternalSourceEntryUriListHandler implements UriListHandler { return true; } - @Override - public Item handle(Context context, HttpServletRequest request, List uriList) + /** + * This method will create a WorkspaceItem made from the ExternalDataObject that will be created from the given + * uriList. The Collection for the WorkspaceItem will be retrieved through the request. + * + * @param context The relevant DSpace context + * @param request The relevant Request + * @param uriList The uriList that contains the data for the ExternalDataObject + * @return A WorkspaceItem created from the given information + * @throws SQLException If something goes wrong + * @throws AuthorizeException If something goes wrong + */ + public WorkspaceItem createWorkspaceItem(Context context, HttpServletRequest request, List uriList) throws SQLException, AuthorizeException { ExternalDataObject dataObject = getExternalDataObjectFromUriList(uriList); String owningCollectionUuid = request.getParameter("owningCollection"); - Collection collection = null; - Item item = null; try { - collection = collectionService.find(context, UUID.fromString(owningCollectionUuid)); - item = externalDataService.createItemFromExternalDataObject(context, dataObject, collection); + Collection collection = collectionService.find(context, UUID.fromString(owningCollectionUuid)); + return externalDataService.createWorkspaceItemFromExternalDataObject(context, dataObject, collection); } catch (AuthorizeException | SQLException e) { log.error("An error occured when trying to create item in collection with uuid: " + owningCollectionUuid, e); throw e; } - return item; } /** @@ -138,5 +134,4 @@ public class ExternalSourceEntryUriListHandler implements UriListHandler { "Couldn't find an ExternalSource for source: " + externalSourceIdentifer + " and ID: " + id)); } - } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/handler/ExternalSourceEntryWorkspaceItemUriListHandler.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/handler/ExternalSourceEntryWorkspaceItemUriListHandler.java new file mode 100644 index 0000000000..6491ec0fd6 --- /dev/null +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/handler/ExternalSourceEntryWorkspaceItemUriListHandler.java @@ -0,0 +1,54 @@ +/** + * The contents of this file are subject to the license and copyright + * detailed in the LICENSE and NOTICE files at the root of the source + * tree and available online at + * + * http://www.dspace.org/license/ + */ +package org.dspace.app.rest.repository.handler; + +import java.sql.SQLException; +import java.util.List; +import javax.servlet.http.HttpServletRequest; + +import org.dspace.authorize.AuthorizeException; +import org.dspace.content.WorkspaceItem; +import org.dspace.core.Context; +import org.springframework.stereotype.Component; + +/** + * This class extends the {@link ExternalSourceEntryItemUriListHandler} abstract class and implements it specifically + * for the WorkspaceItem objects. It'll add extra checks and validations based on a WorkspaceItem and call the super + * functions. + */ +@Component +public class ExternalSourceEntryWorkspaceItemUriListHandler + extends ExternalSourceEntryItemUriListHandler { + + @Override + public boolean supports(List uriList, String method, Class clazz) { + if (!super.supports(uriList, method, clazz)) { + return false; + } + if (clazz != WorkspaceItem.class) { + return false; + } + return true; + } + + @Override + public boolean validate(Context context, HttpServletRequest request, List uriList) + throws AuthorizeException { + + if (!super.validate(context, request, uriList)) { + return false; + } + return true; + } + + @Override + public WorkspaceItem handle(Context context, HttpServletRequest request, List uriList) + throws SQLException, AuthorizeException { + return super.createWorkspaceItem(context, request, uriList); + } +} diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/handler/UriListHandler.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/handler/UriListHandler.java index f3702f45ac..84d6522845 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/handler/UriListHandler.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/handler/UriListHandler.java @@ -25,9 +25,10 @@ public interface UriListHandler { * can handle this input or not * @param uriList The list of UriList Strings to be checked if they're supported * @param method The request method to be checked if it's supported + * @param clazz The class to be returned by the handle method * @return A boolean indicating whether the implementing UriListHandler can handle this input */ - boolean supports(List uriList, String method); + boolean supports(List uriList, String method, Class clazz); /** * This method will take all the required input and validate them to see if there are any issues before @@ -35,10 +36,9 @@ public interface UriListHandler { * @param context The relevant DSpace context * @param request The current request * @param uriList The list of UriList Strings - * @param clazz The class to be returned by the handle method * @return A boolean indicating whether all this input is valid for the implementing UriListHandler */ - boolean validate(Context context, HttpServletRequest request, List uriList, Class clazz) + boolean validate(Context context, HttpServletRequest request, List uriList) throws AuthorizeException; /** diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/handler/service/UriListHandlerService.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/handler/service/UriListHandlerService.java index 38139d31b7..30887fd4b1 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/handler/service/UriListHandlerService.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/handler/service/UriListHandlerService.java @@ -47,9 +47,9 @@ public class UriListHandlerService { // Loop all the uriListHandlers for (UriListHandler uriListHandler : uriListHandlers) { // Does the class support the given uri list and the request method - if (uriListHandler.supports(uriList, request.getMethod())) { + if (uriListHandler.supports(uriList, request.getMethod(), clazz)) { // Can the class handle the given uri list and can the given class, params and authorization be handled - if (uriListHandler.validate(context, request, uriList, clazz)) { + if (uriListHandler.validate(context, request, uriList)) { // If all these things succeed, call handle return (T) uriListHandler.handle(context, request, uriList); } else { diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ClaimedTaskRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ClaimedTaskRestPermissionEvaluatorPlugin.java index 8304277dff..b7e2514722 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ClaimedTaskRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/ClaimedTaskRestPermissionEvaluatorPlugin.java @@ -10,8 +10,9 @@ package org.dspace.app.rest.security; import java.io.Serializable; import java.sql.SQLException; +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.ClaimedTaskRest; import org.dspace.app.rest.utils.ContextUtil; -import org.dspace.core.Constants; import org.dspace.core.Context; import org.dspace.eperson.EPerson; import org.dspace.eperson.service.EPersonService; @@ -49,7 +50,7 @@ public class ClaimedTaskRestPermissionEvaluatorPlugin extends RestObjectPermissi public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, DSpaceRestPermission permission) { - if (Constants.getTypeID(targetType) != Constants.CLAIMEDTASK) { + if (!StringUtils.equalsIgnoreCase(ClaimedTaskRest.NAME, targetType)) { return false; } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/PoolTaskRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/PoolTaskRestPermissionEvaluatorPlugin.java index 34b1bbf2cb..73c43714ba 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/PoolTaskRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/PoolTaskRestPermissionEvaluatorPlugin.java @@ -11,9 +11,10 @@ import java.io.IOException; import java.io.Serializable; import java.sql.SQLException; +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.PoolTaskRest; import org.dspace.app.rest.utils.ContextUtil; import org.dspace.authorize.AuthorizeException; -import org.dspace.core.Constants; import org.dspace.core.Context; import org.dspace.eperson.EPerson; import org.dspace.eperson.service.EPersonService; @@ -51,7 +52,7 @@ public class PoolTaskRestPermissionEvaluatorPlugin extends RestObjectPermissionE public boolean hasDSpacePermission(Authentication authentication, Serializable targetId, String targetType, DSpaceRestPermission permission) { - if (Constants.getTypeID(targetType) != Constants.POOLTASK) { + if (!StringUtils.equalsIgnoreCase(PoolTaskRest.NAME, targetType)) { return false; } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowRestPermissionEvaluatorPlugin.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowRestPermissionEvaluatorPlugin.java index 54040fb5f0..a4c452d9c3 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowRestPermissionEvaluatorPlugin.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/security/WorkflowRestPermissionEvaluatorPlugin.java @@ -11,9 +11,10 @@ import java.io.IOException; import java.io.Serializable; import java.sql.SQLException; +import org.apache.commons.lang3.StringUtils; +import org.dspace.app.rest.model.WorkflowItemRest; import org.dspace.app.rest.utils.ContextUtil; import org.dspace.authorize.AuthorizeException; -import org.dspace.core.Constants; import org.dspace.core.Context; import org.dspace.eperson.EPerson; import org.dspace.eperson.service.EPersonService; @@ -62,7 +63,7 @@ public class WorkflowRestPermissionEvaluatorPlugin extends RestObjectPermissionE //This plugin currently only evaluates READ access DSpaceRestPermission restPermission = DSpaceRestPermission.convert(permission); if (!DSpaceRestPermission.READ.equals(restPermission) - || Constants.getTypeID(targetType) != Constants.WORKFLOWITEM) { + || !StringUtils.equalsIgnoreCase(WorkflowItemRest.NAME, targetType)) { return false; } diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/SubmissionService.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/SubmissionService.java index 04da631083..59ae72f432 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/SubmissionService.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/SubmissionService.java @@ -92,7 +92,7 @@ public class SubmissionService { public WorkspaceItem createWorkspaceItem(Context context, Request request) throws SQLException, AuthorizeException { WorkspaceItem wsi = null; Collection collection = null; - String collectionUUID = request.getHttpServletRequest().getParameter("collection"); + String collectionUUID = request.getHttpServletRequest().getParameter("owningCollection"); if (StringUtils.isBlank(collectionUUID)) { collectionUUID = configurationService.getProperty("submission.default.collection"); diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/ApplicationConfig.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/ApplicationConfig.java index fd9059faa6..e2a4caa008 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/ApplicationConfig.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/ApplicationConfig.java @@ -24,7 +24,7 @@ import org.springframework.data.web.config.EnableSpringDataWebSupport; @Configuration @EnableSpringDataWebSupport @ComponentScan( {"org.dspace.app.rest.converter", "org.dspace.app.rest.repository", "org.dspace.app.rest.utils", - "org.dspace.app.configuration"}) + "org.dspace.app.configuration"}) public class ApplicationConfig { // Allowed CORS origins. Defaults to * (everywhere) // Can be overridden in DSpace configuration diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/DiscoverQueryBuilder.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/DiscoverQueryBuilder.java index 5d4d773a82..a6d3fd00dd 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/DiscoverQueryBuilder.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/DiscoverQueryBuilder.java @@ -12,13 +12,11 @@ import java.util.ArrayList; import java.util.List; import org.apache.commons.collections4.CollectionUtils; -import org.apache.commons.lang3.ArrayUtils; import org.apache.commons.lang3.StringUtils; import org.apache.logging.log4j.Logger; import org.dspace.app.rest.converter.query.SearchQueryConverter; import org.dspace.app.rest.exception.DSpaceBadRequestException; import org.dspace.app.rest.parameter.SearchFilter; -import org.dspace.core.Constants; import org.dspace.core.Context; import org.dspace.core.LogManager; import org.dspace.discovery.DiscoverFacetField; @@ -35,6 +33,7 @@ import org.dspace.discovery.configuration.DiscoverySearchFilter; import org.dspace.discovery.configuration.DiscoverySearchFilterFacet; import org.dspace.discovery.configuration.DiscoverySortConfiguration; import org.dspace.discovery.configuration.DiscoverySortFieldConfiguration; +import org.dspace.discovery.indexobject.factory.IndexFactory; import org.dspace.services.ConfigurationService; import org.springframework.beans.factory.InitializingBean; import org.springframework.beans.factory.annotation.Autowired; @@ -56,6 +55,9 @@ public class DiscoverQueryBuilder implements InitializingBean { @Autowired private ConfigurationService configurationService; + @Autowired + private List indexableFactories; + private int pageSizeLimit; @Override @@ -119,7 +121,7 @@ public class DiscoverQueryBuilder implements InitializingBean { private void configurePaginationForFacets(Pageable page, DiscoverQuery queryArgs) { if (page != null) { - queryArgs.setFacetOffset(page.getOffset()); + queryArgs.setFacetOffset(Math.toIntExact(page.getOffset())); } } @@ -182,7 +184,7 @@ public class DiscoverQueryBuilder implements InitializingBean { //Limit results to DSO type if (StringUtils.isNotBlank(dsoType)) { - queryArgs.setDSpaceObjectFilter(getDsoTypeId(dsoType)); + queryArgs.setDSpaceObjectFilter(getDsoType(dsoType)); } return queryArgs; } @@ -262,19 +264,24 @@ public class DiscoverQueryBuilder implements InitializingBean { private void configurePagination(Pageable page, DiscoverQuery queryArgs) { if (page != null) { queryArgs.setMaxResults(Math.min(pageSizeLimit, page.getPageSize())); - queryArgs.setStart(page.getOffset()); + queryArgs.setStart(Math.toIntExact(page.getOffset())); } else { queryArgs.setMaxResults(pageSizeLimit); queryArgs.setStart(0); } } - private int getDsoTypeId(String dsoType) throws DSpaceBadRequestException { - int index = ArrayUtils.indexOf(Constants.typeText, dsoType.toUpperCase()); - if (index < 0) { - throw new DSpaceBadRequestException(dsoType + " is not a valid DSpace Object type"); + private String getDsoType(String dsoType) throws DSpaceBadRequestException { + for (IndexFactory indexFactory : indexableFactories) { + if (StringUtils.equalsIgnoreCase(indexFactory.getType(), dsoType)) { + return indexFactory.getType(); + } } - return index; + throw new DSpaceBadRequestException(dsoType + " is not a valid DSpace Object type"); + } + + public void setIndexableFactories(List indexableFactories) { + this.indexableFactories = indexableFactories; } private String[] convertFilters(Context context, DiscoveryConfiguration discoveryConfiguration, diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/ScopeResolver.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/ScopeResolver.java index ffc6b16d2d..658a3e996a 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/ScopeResolver.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/ScopeResolver.java @@ -16,6 +16,8 @@ import org.dspace.content.service.CollectionService; import org.dspace.content.service.CommunityService; import org.dspace.core.Context; import org.dspace.discovery.IndexableObject; +import org.dspace.discovery.indexobject.IndexableCollection; +import org.dspace.discovery.indexobject.IndexableCommunity; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; @@ -33,14 +35,14 @@ public class ScopeResolver { @Autowired CommunityService communityService; - public IndexableObject resolveScope(Context context, String scope) { - IndexableObject scopeObj = null; + public IndexableObject resolveScope(Context context, String scope) { + IndexableObject scopeObj = null; if (StringUtils.isNotBlank(scope)) { try { UUID uuid = UUID.fromString(scope); - scopeObj = communityService.find(context, uuid); - if (scopeObj == null) { - scopeObj = collectionService.find(context, uuid); + scopeObj = new IndexableCommunity(communityService.find(context, uuid)); + if (scopeObj.getIndexedObject() == null) { + scopeObj = new IndexableCollection(collectionService.find(context, uuid)); } } catch (IllegalArgumentException ex) { log.warn("The given scope string " + StringUtils.trimToEmpty(scope) + " is not a UUID", ex); diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/Utils.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/Utils.java index 81b5a2556e..e1a16b2728 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/Utils.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/Utils.java @@ -118,9 +118,10 @@ public class Utils { throw new PaginationException(total); } else { if (pageable.getOffset() + pageable.getPageSize() > total) { - pageContent = fullContents.subList(pageable.getOffset(), total); + pageContent = fullContents.subList(Math.toIntExact(pageable.getOffset()), total); } else { - pageContent = fullContents.subList(pageable.getOffset(), pageable.getOffset() + pageable.getPageSize()); + pageContent = fullContents.subList(Math.toIntExact(pageable.getOffset()), + Math.toIntExact(pageable.getOffset()) + pageable.getPageSize()); } return new PageImpl(pageContent, pageable, total); } diff --git a/dspace-server-webapp/src/main/resources/application.properties b/dspace-server-webapp/src/main/resources/application.properties index 37883da3ed..b40551739d 100644 --- a/dspace-server-webapp/src/main/resources/application.properties +++ b/dspace-server-webapp/src/main/resources/application.properties @@ -94,6 +94,8 @@ spring.autoconfigure.exclude=org.springframework.boot.autoconfigure.jdbc.DataSou org.springframework.boot.autoconfigure.solr.SolrAutoConfiguration, \ org.springframework.boot.autoconfigure.velocity.VelocityAutoConfiguration +spring.main.allow-bean-definition-overriding = true + ######################### # Spring Boot Logging levels # diff --git a/dspace-server-webapp/src/main/webapp/index.html b/dspace-server-webapp/src/main/webapp/index.html index acb6b51fc5..15661c654a 100644 --- a/dspace-server-webapp/src/main/webapp/index.html +++ b/dspace-server-webapp/src/main/webapp/index.html @@ -122,7 +122,7 @@