Enable providing a message when archiving content #11164

ashklianko · rymsha · commit 9f61ad9fe479 · 2025-11-04T17:03:23.000+01:00
(cherry picked from commit c8b7ac5)
diff --git a/modules/core/core-api/src/main/java/com/enonic/xp/archive/ArchiveContentParams.java b/modules/core/core-api/src/main/java/com/enonic/xp/archive/ArchiveContentParams.java
@@ -14,11 +14,14 @@ public final class ArchiveContentParams
 
     private final boolean stopInherit;
 
+    private final String message;
+
     public ArchiveContentParams( Builder builder )
     {
         this.contentId = builder.contentId;
         this.archiveContentListener = builder.archiveContentListener;
         this.stopInherit = builder.stopInherit;
+        this.message = builder.message;
     }
 
     public static ArchiveContentParams.Builder create()
@@ -41,6 +44,11 @@ public boolean stopInherit()
         return stopInherit;
     }
 
+    public String getMessage()
+    {
+        return message;
+    }
+
     public void validate()
     {
         Preconditions.checkNotNull( this.contentId, "Content id cannot be null" );
@@ -54,6 +62,8 @@ public static final class Builder
 
         private boolean stopInherit = true;
 
+        private String message;
+
         private Builder()
         {
         }
@@ -76,6 +86,12 @@ public Builder stopInherit( boolean stopInherit )
             return this;
         }
 
+        public Builder message( final String message )
+        {
+            this.message = message;
+            return this;
+        }
+
         private void validate()
         {
             Preconditions.checkNotNull( contentId, "contentId must be set" );
diff --git a/modules/core/core-api/src/main/java/com/enonic/xp/content/ContentConstants.java b/modules/core/core-api/src/main/java/com/enonic/xp/content/ContentConstants.java
@@ -76,6 +76,8 @@ public final class ContentConstants
 
     public static final String PUBLISH_COMMIT_PREFIX_DELIMITER = " ";
 
+    public static final String ARCHIVE_COMMIT_PREFIX_DELIMITER = " ";
+
     public static final String CONTENT_ROOT_PATH_ATTRIBUTE = "contentRootPath";
 
     private static final PrincipalKey CONTENT_SUPER_USER_KEY = PrincipalKey.ofUser( IdProviderKey.system(), "content-su" );
diff --git a/modules/core/core-content/src/main/java/com/enonic/xp/core/impl/content/ArchiveContentCommand.java b/modules/core/core-content/src/main/java/com/enonic/xp/core/impl/content/ArchiveContentCommand.java
@@ -52,15 +52,12 @@ final class ArchiveContentCommand
 
     private final ArchiveContentParams params;
 
-    private final ArchiveContentListener archiveContentListener;
-
     private final PathResolver pathResolver;
 
     private ArchiveContentCommand( final Builder builder )
     {
         super( builder );
         this.params = builder.params;
-        this.archiveContentListener = builder.archiveContentListener;
         this.pathResolver = new PathResolver();
     }
 
@@ -120,9 +117,9 @@ private ArchiveContentsResult doExecute()
     @Override
     public void nodesMoved( final int count )
     {
-        if ( archiveContentListener != null )
+        if ( params.getArchiveContentListener() != null )
         {
-            archiveContentListener.contentArchived( count );
+            params.getArchiveContentListener().contentArchived( count );
         }
     }
 
@@ -169,7 +166,10 @@ private void updatePropertiesAndCommit( final NodeId nodeId, final NodePath orig
         } ).build() );
         routableNodeVersionIds.add( RoutableNodeVersionId.from( updated.id(), updated.getNodeVersionId() ) );
 
-        nodeService.commit( NodeCommitEntry.create().message( ContentConstants.ARCHIVE_COMMIT_PREFIX ).build(),
+        final String commitEntryMessage = params.getMessage() == null
+            ? ContentConstants.ARCHIVE_COMMIT_PREFIX
+            : String.join( ContentConstants.ARCHIVE_COMMIT_PREFIX_DELIMITER, ContentConstants.ARCHIVE_COMMIT_PREFIX, params.getMessage() );
+        nodeService.commit( NodeCommitEntry.create().message( commitEntryMessage ).build(),
                             routableNodeVersionIds.build() );
 
     }
@@ -227,19 +227,11 @@ public static class Builder
     {
         private final ArchiveContentParams params;
 
-        private ArchiveContentListener archiveContentListener;
-
         private Builder( final ArchiveContentParams params )
         {
             this.params = params;
         }
 
-        public Builder archiveListener( final ArchiveContentListener archiveContentListener )
-        {
-            this.archiveContentListener = archiveContentListener;
-            return this;
-        }
-
         @Override
         void validate()
         {
diff --git a/modules/core/core-content/src/main/java/com/enonic/xp/core/impl/content/ContentServiceImpl.java b/modules/core/core-content/src/main/java/com/enonic/xp/core/impl/content/ContentServiceImpl.java
@@ -726,7 +726,6 @@ public ArchiveContentsResult archive( final ArchiveContentParams params )
             .translator( translator )
             .eventPublisher( eventPublisher )
             .contentTypeService( contentTypeService )
-            .archiveListener( params.getArchiveContentListener() )
             .build()
             .execute();
 
diff --git a/modules/core/core-content/src/main/java/com/enonic/xp/core/impl/content/ContentVersionFactory.java b/modules/core/core-content/src/main/java/com/enonic/xp/core/impl/content/ContentVersionFactory.java
@@ -120,6 +120,14 @@ private String getMessage( final NodeCommitEntry nodeCommitEntry )
             return nodeCommitEntry.getMessage()
                 .substring( ContentConstants.PUBLISH_COMMIT_PREFIX.length() + ContentConstants.PUBLISH_COMMIT_PREFIX_DELIMITER.length() );
         }
+
+        if ( nodeCommitEntry.getMessage()
+            .startsWith( ContentConstants.ARCHIVE_COMMIT_PREFIX + ContentConstants.PUBLISH_COMMIT_PREFIX_DELIMITER ) )
+        {
+            return nodeCommitEntry.getMessage()
+                .substring( ContentConstants.ARCHIVE_COMMIT_PREFIX.length() + ContentConstants.PUBLISH_COMMIT_PREFIX_DELIMITER.length() );
+        }
+
         return null;
     }
 
diff --git a/modules/itest/itest-core/src/test/java/com/enonic/xp/core/content/ContentServiceImplTest_archive.java b/modules/itest/itest-core/src/test/java/com/enonic/xp/core/content/ContentServiceImplTest_archive.java
@@ -2,6 +2,7 @@
 
 import java.time.Instant;
 import java.util.EnumSet;
+import java.util.Iterator;
 
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -15,7 +16,10 @@
 import com.enonic.xp.content.ContentIds;
 import com.enonic.xp.content.ContentInheritType;
 import com.enonic.xp.content.ContentPath;
+import com.enonic.xp.content.ContentVersion;
 import com.enonic.xp.content.DeleteContentParams;
+import com.enonic.xp.content.FindContentVersionsParams;
+import com.enonic.xp.content.FindContentVersionsResult;
 import com.enonic.xp.content.ImportContentParams;
 import com.enonic.xp.content.MoveContentParams;
 import com.enonic.xp.content.PushContentParams;
@@ -31,6 +35,7 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertNull;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertTrue;
@@ -56,7 +61,7 @@ public void archive_tree()
         final Content child1_2 = createContent( child1.getPath(), "child2_1" );
 
         final ArchiveContentParams params =
-            ArchiveContentParams.create().contentId( parent.getId() ).archiveContentListener( listener ).build();
+            ArchiveContentParams.create().contentId( parent.getId() ).message( "archive msg" ).archiveContentListener( listener ).build();
 
         final ArchiveContentsResult result = this.contentService.archive( params );
 
@@ -285,6 +290,29 @@ public void archive_check_properties()
         } );
     }
 
+    @Test
+    public void archive_with_message()
+        throws Exception
+    {
+        final Content parent = createContent( ContentPath.ROOT, "archive" );
+        final String archiveMessage = "Archive test message";
+
+        final ArchiveContentParams params =
+            ArchiveContentParams.create().contentId( parent.getId() ).message( archiveMessage ).archiveContentListener( listener ).build();
+
+        this.contentService.archive( params );
+
+        FindContentVersionsResult versions =
+            this.contentService.getVersions( FindContentVersionsParams.create().contentId( parent.getId() ).build() );
+
+        Iterator<ContentVersion> iterator = versions.getContentVersions().iterator();
+        assertTrue( iterator.hasNext() );
+
+        ContentVersion version = iterator.next();
+        assertNotNull( version.getPublishInfo().getTimestamp() );
+        assertEquals( archiveMessage, version.getPublishInfo().getMessage() );
+    }
+
     private static final class TestListener
         implements ArchiveContentListener
     {

Original file line number	Diff line number	Diff line change
`@@ -14,11 +14,14 @@ public final class ArchiveContentParams`
`14`	`14`
`15`	`15`	`private final boolean stopInherit;`
`16`	`16`
	`17`	`+ private final String message;`
	`18`	`+`
`17`	`19`	`public ArchiveContentParams( Builder builder )`
`18`	`20`	`{`
`19`	`21`	`this.contentId = builder.contentId;`
`20`	`22`	`this.archiveContentListener = builder.archiveContentListener;`
`21`	`23`	`this.stopInherit = builder.stopInherit;`
	`24`	`+ this.message = builder.message;`
`22`	`25`	`}`
`23`	`26`
`24`	`27`	`public static ArchiveContentParams.Builder create()`
`@@ -41,6 +44,11 @@ public boolean stopInherit()`
`41`	`44`	`return stopInherit;`
`42`	`45`	`}`
`43`	`46`
	`47`	`+ public String getMessage()`
	`48`	`+ {`
	`49`	`+ return message;`
	`50`	`+ }`
	`51`	`+`
`44`	`52`	`public void validate()`
`45`	`53`	`{`
`46`	`54`	`Preconditions.checkNotNull( this.contentId, "Content id cannot be null" );`
`@@ -54,6 +62,8 @@ public static final class Builder`
`54`	`62`
`55`	`63`	`private boolean stopInherit = true;`
`56`	`64`
	`65`	`+ private String message;`
	`66`	`+`
`57`	`67`	`private Builder()`
`58`	`68`	`{`
`59`	`69`	`}`
`@@ -76,6 +86,12 @@ public Builder stopInherit( boolean stopInherit )`
`76`	`86`	`return this;`
`77`	`87`	`}`
`78`	`88`
	`89`	`+ public Builder message( final String message )`
	`90`	`+ {`
	`91`	`+ this.message = message;`
	`92`	`+ return this;`
	`93`	`+ }`
	`94`	`+`
`79`	`95`	`private void validate()`
`80`	`96`	`{`
`81`	`97`	`Preconditions.checkNotNull( contentId, "contentId must be set" );`
Original file line number	Diff line number	Diff line change
`@@ -52,15 +52,12 @@ final class ArchiveContentCommand`
`52`	`52`
`53`	`53`	`private final ArchiveContentParams params;`
`54`	`54`
`55`		`- private final ArchiveContentListener archiveContentListener;`
`56`		`-`
`57`	`55`	`private final PathResolver pathResolver;`
`58`	`56`
`59`	`57`	`private ArchiveContentCommand( final Builder builder )`
`60`	`58`	`{`
`61`	`59`	`super( builder );`
`62`	`60`	`this.params = builder.params;`
`63`		`- this.archiveContentListener = builder.archiveContentListener;`
`64`	`61`	`this.pathResolver = new PathResolver();`
`65`	`62`	`}`
`66`	`63`
`@@ -120,9 +117,9 @@ private ArchiveContentsResult doExecute()`
`120`	`117`	`@Override`
`121`	`118`	`public void nodesMoved( final int count )`
`122`	`119`	`{`
`123`		`- if ( archiveContentListener != null )`
	`120`	`+ if ( params.getArchiveContentListener() != null )`
`124`	`121`	`{`
`125`		`- archiveContentListener.contentArchived( count );`
	`122`	`+ params.getArchiveContentListener().contentArchived( count );`
`126`	`123`	`}`
`127`	`124`	`}`
`128`	`125`
`@@ -169,7 +166,10 @@ private void updatePropertiesAndCommit( final NodeId nodeId, final NodePath orig`
`169`	`166`	`} ).build() );`
`170`	`167`	`routableNodeVersionIds.add( RoutableNodeVersionId.from( updated.id(), updated.getNodeVersionId() ) );`
`171`	`168`
`172`		`- nodeService.commit( NodeCommitEntry.create().message( ContentConstants.ARCHIVE_COMMIT_PREFIX ).build(),`
	`169`	`+ final String commitEntryMessage = params.getMessage() == null`
	`170`	`+ ? ContentConstants.ARCHIVE_COMMIT_PREFIX`
	`171`	`+ : String.join( ContentConstants.ARCHIVE_COMMIT_PREFIX_DELIMITER, ContentConstants.ARCHIVE_COMMIT_PREFIX, params.getMessage() );`
	`172`	`+ nodeService.commit( NodeCommitEntry.create().message( commitEntryMessage ).build(),`
`173`	`173`	`routableNodeVersionIds.build() );`
`174`	`174`
`175`	`175`	`}`
`@@ -227,19 +227,11 @@ public static class Builder`
`227`	`227`	`{`
`228`	`228`	`private final ArchiveContentParams params;`
`229`	`229`
`230`		`- private ArchiveContentListener archiveContentListener;`
`231`		`-`
`232`	`230`	`private Builder( final ArchiveContentParams params )`
`233`	`231`	`{`
`234`	`232`	`this.params = params;`
`235`	`233`	`}`
`236`	`234`
`237`		`- public Builder archiveListener( final ArchiveContentListener archiveContentListener )`
`238`		`- {`
`239`		`- this.archiveContentListener = archiveContentListener;`
`240`		`- return this;`
`241`		`- }`
`242`		`-`
`243`	`235`	`@Override`
`244`	`236`	`void validate()`
`245`	`237`	`{`
Original file line number	Diff line number	Diff line change
`@@ -120,6 +120,14 @@ private String getMessage( final NodeCommitEntry nodeCommitEntry )`
`120`	`120`	`return nodeCommitEntry.getMessage()`
`121`	`121`	`.substring( ContentConstants.PUBLISH_COMMIT_PREFIX.length() + ContentConstants.PUBLISH_COMMIT_PREFIX_DELIMITER.length() );`
`122`	`122`	`}`
	`123`	`+`
	`124`	`+ if ( nodeCommitEntry.getMessage()`
	`125`	`+ .startsWith( ContentConstants.ARCHIVE_COMMIT_PREFIX + ContentConstants.PUBLISH_COMMIT_PREFIX_DELIMITER ) )`
	`126`	`+ {`
	`127`	`+ return nodeCommitEntry.getMessage()`
	`128`	`+ .substring( ContentConstants.ARCHIVE_COMMIT_PREFIX.length() + ContentConstants.PUBLISH_COMMIT_PREFIX_DELIMITER.length() );`
	`129`	`+ }`
	`130`	`+`
`123`	`131`	`return null;`
`124`	`132`	`}`
`125`	`133`