fix: Stop sending work notification if there is no changes in API V2, move logic from controller to manager

Author: DanielPalafox

orcid-api-web/src/main/java/org/orcid/api/memberV3/server/delegator/impl/MemberV3ApiServiceDelegatorImpl.java

@@ -129,8 +129,6 @@
 import org.orcid.jaxb.model.v3.release.record.summary.Works;
 import org.orcid.jaxb.model.v3.release.search.Search;
 import org.orcid.jaxb.model.v3.release.search.expanded.ExpandedSearch;
-import org.orcid.pojo.ajaxForm.WorkForm;
-import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.MessageSource;
 import org.springframework.stereotype.Component;
 
@@ -271,9 +269,6 @@ public class MemberV3ApiServiceDelegatorImpl implements
 
     @Resource
     private OrcidUrlManager orcidUrlManager;
-
-    @Value("${org.orcid.core.work.contributors.ui.max:50}")
-    private int maxContributorsForUI;
 
     public Boolean getFilterVersionOfIdentifiers() {
         return filterVersionOfIdentifiers;
@@ -393,20 +388,8 @@ public Response updateWork(String orcid, Long putCode, Work work) {
             throw new MismatchedPutCodeException(addParmsMismatchedPutCode(putCode, work.getPutCode()));                                     
         }
         clearSource(work);
-        Work w = work;
-
-        WorkForm newWorkForm = WorkForm.valueOf(work, maxContributorsForUI);
-        Work workSaved = workManager.getWork(orcid, putCode);
-        WorkForm workFormSaved = WorkForm.valueOf(workSaved, maxContributorsForUI);
-
-        if (Features.STOP_SENDING_NOTIFICATION_WORK_NOT_UPDATED.isActive()) {
-            if (!workFormSaved.compare(newWorkForm)) {
-                w = updateWork(orcid, work);
-            }
-        } else {
-            w = updateWork(orcid, work);
-        }
-
+        Work w = workManager.updateWork(orcid, work, true);
+        sourceUtils.setSourceName(w);
         return Response.ok(w).build();
     }
 
@@ -1584,10 +1567,4 @@ private Map<String, String> addParmsMismatchedPutCode(Long urlPutCode, Long body
         return params;
     }
 
-    private Work updateWork(String orcid, Work work) {
-        Work w = workManager.updateWork(orcid, work, true);
-        sourceUtils.setSourceName(w);
-        return w;
-    }
-
 }

orcid-core/src/main/java/org/orcid/core/manager/impl/WorkManagerImpl.java

@@ -45,6 +45,7 @@
 import org.orcid.persistence.jpa.entities.SourceEntity;
 import org.orcid.persistence.jpa.entities.WorkEntity;
 import org.orcid.pojo.ContributorsRolesAndSequencesV2;
+import org.orcid.pojo.ajaxForm.WorkForm;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Value;
@@ -350,6 +351,16 @@ private void addExternalIdsToExistingSet(Map<ExternalID, Long> extIDPutCodeMap,
     @Transactional
     public Work updateWork(String orcid, Work work, boolean isApiRequest) {
         WorkEntity workEntity = workDao.getWork(orcid, work.getPutCode());
+
+        Work workSaved = jpaJaxbWorkAdapter.toWork(workEntity);
+        WorkForm workFormSaved = WorkForm.valueOf(workSaved, maxContributorsForUI);
+
+        if (Features.STOP_SENDING_NOTIFICATION_WORK_NOT_UPDATED.isActive()) {
+            if (workFormSaved.compare(WorkForm.valueOf(work, maxContributorsForUI))) {
+                return workSaved;
+            }
+        }
+
         String originalVisibility = workEntity.getVisibility();
         SourceEntity sourceEntity = sourceManager.retrieveSourceEntity();
 
@@ -387,8 +398,7 @@ public Work updateWork(String orcid, Work work, boolean isApiRequest) {
         workDao.merge(workEntity);
         workDao.flush();
         notificationManager.sendAmendEmail(orcid, AmendedSection.WORK, createItemList(workEntity, work.getExternalIdentifiers(), ActionType.UPDATE));
-        Work updatedWork = jpaJaxbWorkAdapter.toWork(workEntity);
-        return updatedWork;
+        return jpaJaxbWorkAdapter.toWork(workEntity);
     }
 
     @Override

orcid-core/src/main/java/org/orcid/core/manager/v3/impl/WorkManagerImpl.java

@@ -41,6 +41,7 @@
 import org.orcid.persistence.jpa.entities.ProfileEntity;
 import org.orcid.persistence.jpa.entities.WorkEntity;
 import org.orcid.pojo.ContributorsRolesAndSequences;
+import org.orcid.pojo.WorkExtended;
 import org.orcid.pojo.ajaxForm.WorkForm;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -358,6 +359,16 @@ private void addExternalIdsToExistingSet(Map<ExternalID, Long> extIDPutCodeMap,
     @Transactional
     public Work updateWork(String orcid, Work work, boolean isApiRequest) {
         WorkEntity workEntity = workDao.getWork(orcid, work.getPutCode());
+
+        Work workSaved = jpaJaxbWorkAdapter.toWork(workEntity);
+        WorkForm workFormSaved = WorkForm.valueOf(workSaved, maxContributorsForUI);
+
+        if (Features.STOP_SENDING_NOTIFICATION_WORK_NOT_UPDATED.isActive()) {
+            if (workFormSaved.compare(WorkForm.valueOf(work, maxContributorsForUI))) {
+                return workSaved;
+            }
+        }
+
         Visibility originalVisibility = Visibility.valueOf(workEntity.getVisibility());
         Source activeSource = sourceManager.retrieveActiveSource();
 
@@ -539,6 +550,16 @@ public Work updateWork(String orcid, WorkForm workForm) {
         Work work = workForm.toWork();
 
         WorkEntity workEntity = workDao.getWork(orcid, work.getPutCode());
+
+        WorkExtended workSaved = jpaJaxbWorkAdapter.toWorkExtended(workEntity);
+        WorkForm workFormSaved = WorkForm.valueOf(workSaved, maxContributorsForUI);
+
+        if (Features.STOP_SENDING_NOTIFICATION_WORK_NOT_UPDATED.isActive()) {
+            if (workFormSaved.compare(workForm)) {
+                return workSaved;
+            }
+        }
+
         Visibility originalVisibility = Visibility.valueOf(workEntity.getVisibility());
 
         //Save the original source

orcid-core/src/main/java/org/orcid/pojo/ajaxForm/ActivityExternalIdentifier.java

@@ -65,7 +65,23 @@ public static ActivityExternalIdentifier valueOf(ExternalID externalIdentifier)
         return wi;
 
     }
-    
+
+    public static ActivityExternalIdentifier valueOf(org.orcid.jaxb.model.record_v2.ExternalID externalIdentifier) {
+        ActivityExternalIdentifier wi = new ActivityExternalIdentifier();
+        if (externalIdentifier != null) {
+            if (externalIdentifier.getValue() != null)
+                wi.setExternalIdentifierId(Text.valueOf(externalIdentifier.getValue()));
+            if (externalIdentifier.getType() != null)
+                wi.setExternalIdentifierType(Text.valueOf(externalIdentifier.getType()));
+            if(externalIdentifier.getRelationship() != null)
+                wi.setRelationship(Text.valueOf(externalIdentifier.getRelationship().value()));
+            if(externalIdentifier.getUrl() != null)
+                wi.setUrl(Text.valueOf(externalIdentifier.getUrl().getValue()));
+        }
+        return wi;
+
+    }
+
     public ExternalID toExternalIdentifier() {
         ExternalID we = new ExternalID();
         if (!PojoUtil.isEmpty(this.getExternalIdentifierId())) 

orcid-core/src/main/java/org/orcid/pojo/ajaxForm/Date.java

@@ -83,6 +83,20 @@ public static Date valueOf(LastModifiedDate date) {
         return newDate;
     }
 
+    public static Date valueOf(org.orcid.jaxb.model.common_v2.CreatedDate date) {
+        Date newDate = new Date();
+        if (date != null && date.getValue() != null)
+            return Date.valueOf(date.getValue().toGregorianCalendar().getTime());
+        return newDate;
+    }
+
+    public static Date valueOf(org.orcid.jaxb.model.common_v2.LastModifiedDate date) {
+        Date newDate = new Date();
+        if (date != null && date.getValue() != null)
+            return Date.valueOf(date.getValue().toGregorianCalendar().getTime());
+        return newDate;
+    }
+
     public java.util.Date toJavaDate() {
         Calendar gc = toCalendar();
         return gc.getTime();

orcid-core/src/main/java/org/orcid/pojo/ajaxForm/WorkForm.java

@@ -335,12 +335,139 @@ public static WorkForm valueOf(WorkSummary work) {
         return w;
     }
 
+    public static WorkForm valueOf(org.orcid.jaxb.model.record_v2.Work work, int maxContributorsForUI) {
+        if (work == null)
+            return null;
+
+        WorkForm w = new WorkForm();
+
+        // Set work id
+        if (work.getPutCode() != null) {
+            w.setPutCode(Text.valueOf(work.getPutCode()));
+        }
+
+        // Set language
+        if (!PojoUtil.isEmpty(work.getLanguageCode())) {
+            w.setLanguageCode(Text.valueOf(work.getLanguageCode()));
+        }
+
+        // Set type
+        if (work.getWorkType() != null) {
+            w.setWorkType(Text.valueOf(work.getWorkType().value()));
+            // Set category
+            org.orcid.jaxb.model.record_v2.WorkCategory category = org.orcid.jaxb.model.record_v2.WorkCategory.fromWorkType(work.getWorkType());
+            w.setWorkCategory(Text.valueOf(category.value()));
+        }
+
+        if (work.getWorkTitle() != null) {
+            // Set title
+            if (work.getWorkTitle().getTitle() != null) {
+                w.setTitle(Text.valueOf(work.getWorkTitle().getTitle().getContent()));
+            }
+            // Set translated title
+            if (work.getWorkTitle().getTranslatedTitle() != null) {
+                TranslatedTitleForm tt = new TranslatedTitleForm();
+                tt.setContent(work.getWorkTitle().getTranslatedTitle().getContent());
+                tt.setLanguageCode(work.getWorkTitle().getTranslatedTitle().getLanguageCode());
+                w.setTranslatedTitle(tt);
+            }
+            // Set subtitle
+            if (work.getWorkTitle().getSubtitle() != null) {
+                w.setSubtitle(Text.valueOf(work.getWorkTitle().getSubtitle().getContent()));
+            }
+        }
+
+        // Set journal title
+        if (work.getJournalTitle() != null ) {
+            w.setJournalTitle(Text.valueOf(work.getJournalTitle().getContent()));
+        }
+
+        // Set description
+        if (work.getShortDescription() != null) {
+            w.setShortDescription(Text.valueOf(work.getShortDescription()));
+        }
+
+        // Set url
+        if (work.getUrl() != null ) {
+            w.setUrl(Text.valueOf(work.getUrl().getValue()));
+        }
+
+        // Set visibility
+        if (work.getVisibility() != null) {
+            w.setVisibility(Visibility.valueOf(work.getVisibility()));
+        }
+
+        // Set country
+        if (work.getCountry() != null && work.getCountry().getValue() != null) {
+            w.setCountryCode(Text.valueOf(work.getCountry().getValue().name()));
+        }
+
+        // Set publication date
+        FuzzyDate fuzzyPublicationDate = null;
+        if (work.getPublicationDate() != null) {
+            org.orcid.jaxb.model.common_v2.PublicationDate publicationDate = work.getPublicationDate();
+            Integer year = PojoUtil.isEmpty(publicationDate.getYear()) ? null : Integer.valueOf(publicationDate.getYear().getValue());
+            Integer month = PojoUtil.isEmpty(publicationDate.getMonth()) ? null : Integer.valueOf(publicationDate.getMonth().getValue());
+            Integer day = PojoUtil.isEmpty(publicationDate.getDay()) ? null : Integer.valueOf(publicationDate.getDay().getValue());
+            if(year != null && year == 0) {
+                year = null;
+            }
+            if(month != null && month == 0) {
+                month = null;
+            }
+            if (day != null && day == 0) {
+                day = null;
+            }
+            fuzzyPublicationDate = FuzzyDate.valueOf(year, month, day);
+            w.setPublicationDate(Date.valueOf(fuzzyPublicationDate));
+        }
+        w.setDateSortString(PojoUtil.createDateSortString(null, fuzzyPublicationDate));
+
+        // Set citation
+        if (work.getWorkCitation() != null) {
+            Citation citation = new Citation();
+            if(!PojoUtil.isEmpty(work.getWorkCitation().getCitation())) {
+                citation.setCitation(Text.valueOf(work.getWorkCitation().getCitation()));
+            }
+            if(work.getWorkCitation().getWorkCitationType() != null) {
+                citation.setCitationType(Text.valueOf(work.getWorkCitation().getWorkCitationType().value()));
+            }
+
+            w.setCitation(citation);
+        }
+            // Set contributors
+        populateContributors(work, w, maxContributorsForUI);
+        // Set external identifiers
+        populateExternalIdentifiers(work, w);
+
+        // Set created date
+        w.setCreatedDate(Date.valueOf(work.getCreatedDate()));
+
+        // Set last modified
+        w.setLastModified(Date.valueOf(work.getLastModifiedDate()));
+
+        if(work.getSource() != null) {
+            // Set source
+            w.setSource(work.getSource().retrieveSourcePath());
+            if(work.getSource().getSourceName() != null) {
+                w.setSourceName(work.getSource().getSourceName().getContent());
+            }
+        }
+        return w;
+    }
+
     private static void populateExternalIdentifiers(Work work, WorkForm workForm) {
         if(work.getExternalIdentifiers() != null) {        
             populateExternalIdentifiers(work.getExternalIdentifiers(), workForm, work.getWorkType());
         }
     }
-    
+
+    private static void populateExternalIdentifiers(org.orcid.jaxb.model.record_v2.Work work, WorkForm workForm) {
+        if(work.getExternalIdentifiers() != null) {
+            populateExternalIdentifiers(work.getExternalIdentifiers(), workForm, work.getWorkType());
+        }
+    }
+
     public static void populateExternalIdentifiers(ExternalIDs extIds, WorkForm workForm, WorkType workType) {
         if (extIds != null) {
             List<ActivityExternalIdentifier> workExternalIdentifiersList = new ArrayList<ActivityExternalIdentifier>();
@@ -367,7 +494,34 @@ public static void populateExternalIdentifiers(ExternalIDs extIds, WorkForm work
             workForm.setWorkExternalIdentifiers(workExternalIdentifiersList);
         }
     }
-    
+
+    public static void populateExternalIdentifiers(org.orcid.jaxb.model.record_v2.ExternalIDs extIds, WorkForm workForm, org.orcid.jaxb.model.record_v2.WorkType workType) {
+        if (extIds != null) {
+            List<ActivityExternalIdentifier> workExternalIdentifiersList = new ArrayList<ActivityExternalIdentifier>();
+            for (org.orcid.jaxb.model.record_v2.ExternalID extId : extIds.getExternalIdentifier()) {
+                if(extId.getRelationship() == null) {
+                    if(org.orcid.jaxb.model.message.WorkExternalIdentifierType.ISSN.equals(extId.getType())) {
+                        if(WorkType.BOOK.equals(workType)) {
+                            extId.setRelationship(org.orcid.jaxb.model.record_v2.Relationship.PART_OF);
+                        } else {
+                            extId.setRelationship(org.orcid.jaxb.model.record_v2.Relationship.SELF);
+                        }
+                    } else if(org.orcid.jaxb.model.message.WorkExternalIdentifierType.ISBN.equals(extId.getType())) {
+                        if(WorkType.BOOK_CHAPTER.equals(workType) || WorkType.CONFERENCE_PAPER.equals(workType)) {
+                            extId.setRelationship(org.orcid.jaxb.model.record_v2.Relationship.PART_OF);
+                        } else {
+                            extId.setRelationship(org.orcid.jaxb.model.record_v2.Relationship.SELF);
+                        }
+                    } else {
+                        extId.setRelationship(org.orcid.jaxb.model.record_v2.Relationship.SELF);
+                    }
+                }
+                workExternalIdentifiersList.add(ActivityExternalIdentifier.valueOf(extId));
+            }
+            workForm.setWorkExternalIdentifiers(workExternalIdentifiersList);
+        }
+    }
+
     private static void populateExternalIdentifiers(WorkForm workForm, Work work) {
         ExternalIDs workExternalIds = new ExternalIDs();
         if(workForm.getWorkExternalIdentifiers() != null && !workForm.getWorkExternalIdentifiers().isEmpty()) {
@@ -394,6 +548,30 @@ private static void populateExternalIdentifiers(WorkForm workForm, Work work) {
         work.setWorkExternalIdentifiers(workExternalIds);
     }
 
+    private static void populateContributors(org.orcid.jaxb.model.record_v2.Work work, WorkForm workForm, int maxContributorsForUI) {
+        List<Contributor> contributorsList = new ArrayList<Contributor>();
+        if(work.getWorkContributors() != null) {
+            List<org.orcid.jaxb.model.common_v2.Contributor> contributors = null;
+            if (Features.ORCID_ANGULAR_WORKS_CONTRIBUTORS.isActive()) {
+                if (work.getWorkContributors().getContributor().size() > maxContributorsForUI) {
+                    contributors = work.getWorkContributors().getContributor().subList(0, maxContributorsForUI);
+                } else {
+                    contributors = work.getWorkContributors().getContributor();
+                }
+            } else {
+                contributors = work.getWorkContributors().getContributor();
+            }
+
+            if (contributors != null) {
+                for (org.orcid.jaxb.model.common_v2.Contributor contributor : contributors) {
+                    contributorsList.add(Contributor.valueOf(contributor));
+                }
+            }
+
+        }
+        workForm.setContributors(contributorsList);
+    }
+
     private static void populateContributors(Work work, WorkForm workForm, int maxContributorsForUI) {
         List<Contributor> contributorsList = new ArrayList<Contributor>();
         if(work.getWorkContributors() != null) {