forked from DSpace/DSpace
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'DSpace:main' into main
- Loading branch information
Showing
372 changed files
with
22,868 additions
and
1,338 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
30 changes: 30 additions & 0 deletions
30
dspace-api/src/main/java/org/dspace/app/ldn/ItemFilter.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| /** | ||
| * 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.ldn; | ||
|
|
||
| /** | ||
| * model class for the item filters configured into item-filters.xml | ||
| * | ||
| * @author Mohamed Eskander (mohamed.eskander at 4science.com) | ||
| */ | ||
| public class ItemFilter { | ||
|
|
||
| private String id; | ||
|
|
||
| public ItemFilter(String id) { | ||
| this.id = id; | ||
| } | ||
|
|
||
| public String getId() { | ||
| return id; | ||
| } | ||
|
|
||
| public void setId(String id) { | ||
| this.id = id; | ||
| } | ||
| } |
231 changes: 231 additions & 0 deletions
231
dspace-api/src/main/java/org/dspace/app/ldn/LDNMessageConsumer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,231 @@ | ||
| /** | ||
| * 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.ldn; | ||
|
|
||
| import static java.lang.String.format; | ||
|
|
||
| import java.io.IOException; | ||
| import java.sql.SQLException; | ||
| import java.util.ArrayList; | ||
| import java.util.Collections; | ||
| import java.util.Date; | ||
| import java.util.List; | ||
| import java.util.Locale; | ||
| import java.util.Objects; | ||
| import java.util.Optional; | ||
| import java.util.UUID; | ||
|
|
||
| import com.fasterxml.jackson.core.JsonProcessingException; | ||
| import com.fasterxml.jackson.databind.JsonMappingException; | ||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
| import org.apache.commons.collections4.CollectionUtils; | ||
| import org.apache.commons.lang3.StringUtils; | ||
| import org.dspace.app.ldn.factory.NotifyServiceFactory; | ||
| import org.dspace.app.ldn.model.Notification; | ||
| import org.dspace.app.ldn.service.LDNMessageService; | ||
| import org.dspace.app.ldn.service.NotifyPatternToTriggerService; | ||
| import org.dspace.app.ldn.service.NotifyServiceInboundPatternService; | ||
| import org.dspace.content.Bitstream; | ||
| import org.dspace.content.BitstreamFormat; | ||
| import org.dspace.content.Bundle; | ||
| import org.dspace.content.Item; | ||
| import org.dspace.content.MetadataValue; | ||
| import org.dspace.content.factory.ContentServiceFactory; | ||
| import org.dspace.content.logic.LogicalStatement; | ||
| import org.dspace.content.service.BitstreamService; | ||
| import org.dspace.content.service.ItemService; | ||
| import org.dspace.core.Constants; | ||
| import org.dspace.core.Context; | ||
| import org.dspace.core.I18nUtil; | ||
| import org.dspace.core.LDN; | ||
| import org.dspace.event.Consumer; | ||
| import org.dspace.event.Event; | ||
| import org.dspace.services.ConfigurationService; | ||
| import org.dspace.services.factory.DSpaceServicesFactory; | ||
| import org.dspace.utils.DSpace; | ||
| import org.dspace.web.ContextUtil; | ||
|
|
||
| /** | ||
| * class for creating a new LDN Messages of installed item | ||
| * | ||
| * @author Mohamed Eskander (mohamed.eskander at 4science.com) | ||
| */ | ||
| public class LDNMessageConsumer implements Consumer { | ||
|
|
||
| private NotifyPatternToTriggerService notifyPatternToTriggerService; | ||
| private NotifyServiceInboundPatternService inboundPatternService; | ||
| private LDNMessageService ldnMessageService; | ||
| private ConfigurationService configurationService; | ||
| private ItemService itemService; | ||
| private BitstreamService bitstreamService; | ||
|
|
||
| @Override | ||
| public void initialize() throws Exception { | ||
| notifyPatternToTriggerService = NotifyServiceFactory.getInstance().getNotifyPatternToTriggerService(); | ||
| ldnMessageService = NotifyServiceFactory.getInstance().getLDNMessageService(); | ||
| configurationService = DSpaceServicesFactory.getInstance().getConfigurationService(); | ||
| itemService = ContentServiceFactory.getInstance().getItemService(); | ||
| bitstreamService = ContentServiceFactory.getInstance().getBitstreamService(); | ||
| inboundPatternService = NotifyServiceFactory.getInstance().getNotifyServiceInboundPatternService(); | ||
| } | ||
|
|
||
| @Override | ||
| public void consume(Context context, Event event) throws Exception { | ||
|
|
||
| if (event.getSubjectType() != Constants.ITEM || | ||
| event.getEventType() != Event.INSTALL) { | ||
| return; | ||
| } | ||
|
|
||
| Item item = (Item) event.getSubject(context); | ||
| createManualLDNMessages(context, item); | ||
| createAutomaticLDNMessages(context, item); | ||
| } | ||
|
|
||
| private void createManualLDNMessages(Context context, Item item) throws SQLException, JsonProcessingException { | ||
| List<NotifyPatternToTrigger> patternsToTrigger = | ||
| notifyPatternToTriggerService.findByItem(context, item); | ||
|
|
||
| for (NotifyPatternToTrigger patternToTrigger : patternsToTrigger) { | ||
| createLDNMessage(context,patternToTrigger.getItem(), | ||
| patternToTrigger.getNotifyService(), patternToTrigger.getPattern()); | ||
| } | ||
| } | ||
|
|
||
| private void createAutomaticLDNMessages(Context context, Item item) throws SQLException, JsonProcessingException { | ||
|
|
||
| List<NotifyServiceInboundPattern> inboundPatterns = inboundPatternService.findAutomaticPatterns(context); | ||
|
|
||
| for (NotifyServiceInboundPattern inboundPattern : inboundPatterns) { | ||
| if (StringUtils.isEmpty(inboundPattern.getConstraint()) || | ||
| evaluateFilter(context, item, inboundPattern.getConstraint())) { | ||
| createLDNMessage(context, item, inboundPattern.getNotifyService(), inboundPattern.getPattern()); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private boolean evaluateFilter(Context context, Item item, String constraint) { | ||
| LogicalStatement filter = | ||
| new DSpace().getServiceManager().getServiceByName(constraint, LogicalStatement.class); | ||
|
|
||
| return filter != null && filter.getResult(context, item); | ||
| } | ||
|
|
||
| private void createLDNMessage(Context context, Item item, NotifyServiceEntity service, String pattern) | ||
| throws SQLException, JsonMappingException, JsonProcessingException { | ||
|
|
||
| LDN ldn = getLDNMessage(pattern); | ||
| LDNMessageEntity ldnMessage = | ||
| ldnMessageService.create(context, format("urn:uuid:%s", UUID.randomUUID())); | ||
|
|
||
| ldnMessage.setObject(item); | ||
| ldnMessage.setTarget(service); | ||
| ldnMessage.setQueueStatus(LDNMessageEntity.QUEUE_STATUS_QUEUED); | ||
| ldnMessage.setQueueTimeout(new Date()); | ||
|
|
||
| appendGeneratedMessage(ldn, ldnMessage, pattern); | ||
|
|
||
| ObjectMapper mapper = new ObjectMapper(); | ||
| Notification notification = mapper.readValue(ldnMessage.getMessage(), Notification.class); | ||
| ldnMessage.setType(StringUtils.joinWith(",", notification.getType())); | ||
|
|
||
| ArrayList<String> notificationTypeArrayList = new ArrayList<String>(notification.getType()); | ||
| // sorting the list | ||
| Collections.sort(notificationTypeArrayList); | ||
| ldnMessage.setActivityStreamType(notificationTypeArrayList.get(0)); | ||
| ldnMessage.setCoarNotifyType(notificationTypeArrayList.get(1)); | ||
|
|
||
| ldnMessageService.update(context, ldnMessage); | ||
| } | ||
|
|
||
| private LDN getLDNMessage(String pattern) { | ||
| try { | ||
| return LDN.getLDNMessage(I18nUtil.getLDNFilename(Locale.getDefault(), pattern)); | ||
| } catch (IOException e) { | ||
| throw new RuntimeException(e); | ||
| } | ||
| } | ||
|
|
||
| private void appendGeneratedMessage(LDN ldn, LDNMessageEntity ldnMessage, String pattern) { | ||
| Item item = (Item) ldnMessage.getObject(); | ||
| ldn.addArgument(getUiUrl()); | ||
| ldn.addArgument(configurationService.getProperty("ldn.notify.inbox")); | ||
| ldn.addArgument(configurationService.getProperty("dspace.name")); | ||
| ldn.addArgument(Objects.requireNonNullElse(ldnMessage.getTarget().getUrl(), "")); | ||
| ldn.addArgument(Objects.requireNonNullElse(ldnMessage.getTarget().getLdnUrl(), "")); | ||
| ldn.addArgument(getUiUrl() + "/handle/" + ldnMessage.getObject().getHandle()); | ||
| ldn.addArgument(getIdentifierUri(item)); | ||
| ldn.addArgument(generateBitstreamDownloadUrl(item)); | ||
| ldn.addArgument(getBitstreamMimeType(findPrimaryBitstream(item))); | ||
| ldn.addArgument(ldnMessage.getID()); | ||
|
|
||
| ldnMessage.setMessage(ldn.generateLDNMessage()); | ||
| } | ||
|
|
||
| private String getUiUrl() { | ||
| return configurationService.getProperty("dspace.ui.url"); | ||
| } | ||
|
|
||
| private String getIdentifierUri(Item item) { | ||
| return itemService.getMetadataByMetadataString(item, "dc.identifier.uri") | ||
| .stream() | ||
| .findFirst() | ||
| .map(MetadataValue::getValue) | ||
| .orElse(""); | ||
| } | ||
|
|
||
| private String generateBitstreamDownloadUrl(Item item) { | ||
| String uiUrl = getUiUrl(); | ||
| return findPrimaryBitstream(item) | ||
| .map(bs -> uiUrl + "/bitstreams/" + bs.getID() + "/download") | ||
| .orElse(""); | ||
| } | ||
|
|
||
| private Optional<Bitstream> findPrimaryBitstream(Item item) { | ||
| List<Bundle> bundles = item.getBundles(Constants.CONTENT_BUNDLE_NAME); | ||
| return bundles.stream() | ||
| .findFirst() | ||
| .map(Bundle::getPrimaryBitstream) | ||
| .or(() -> bundles.stream() | ||
| .findFirst() | ||
| .flatMap(bundle -> CollectionUtils.isNotEmpty(bundle.getBitstreams()) | ||
| ? Optional.of(bundle.getBitstreams().get(0)) | ||
| : Optional.empty())); | ||
| } | ||
|
|
||
| private String getBitstreamMimeType(Optional<Bitstream> bitstream) { | ||
| return bitstream.map(bs -> { | ||
| try { | ||
| Context context = ContextUtil.obtainCurrentRequestContext(); | ||
| BitstreamFormat bitstreamFormat = bs.getFormat(context); | ||
| if (bitstreamFormat.getShortDescription().equals("Unknown")) { | ||
| return getUserFormatMimeType(bs); | ||
| } | ||
| return bitstreamFormat.getMIMEType(); | ||
| } catch (SQLException e) { | ||
| throw new RuntimeException(e); | ||
| } | ||
| }).orElse(""); | ||
| } | ||
|
|
||
| private String getUserFormatMimeType(Bitstream bitstream) { | ||
| return bitstreamService.getMetadataFirstValue(bitstream, | ||
| "dc", "format", "mimetype", Item.ANY); | ||
| } | ||
|
|
||
| @Override | ||
| public void end(Context ctx) throws Exception { | ||
|
|
||
| } | ||
|
|
||
| @Override | ||
| public void finish(Context ctx) throws Exception { | ||
|
|
||
| } | ||
|
|
||
| } |
Oops, something went wrong.