GPU-1711: CMS: Page Expire Date

cms-core/src/main/java/com/gentics/contentnode/factory/object/ExtensiblePublishableObject.java

@@ -1,9 +1,10 @@
 package com.gentics.contentnode.factory.object;
 
-import java.util.List;
-
 import com.gentics.api.lib.exception.NodeException;
 import com.gentics.contentnode.object.PublishableNodeObject;
+import com.gentics.contentnode.publish.protocol.PublishProtocolUtil;
+import com.gentics.contentnode.publish.protocol.PublishState;
+import java.util.List;
 
 /**
  * Interface for {@link PublishableNodeObject}s, which allow to add hooks for specific actions on them (like saving, deleting, publishing and taking offline)
@@ -23,6 +24,8 @@ public interface ExtensiblePublishableObject<T extends PublishableNodeObject> ex
 	 * @throws NodeException when publishing has to fail
 	 */
 	default void onPublish(T object, boolean wasOnline, int userId) throws NodeException {
+		PublishProtocolUtil.logPublishState(object, PublishState.ONLINE.getValue(), userId);
+
 		for (ExtensiblePublishableObjectService<T> service : getServices()) {
 			service.onPublish(object, wasOnline, userId);
 		}
@@ -37,6 +40,8 @@ default void onPublish(T object, boolean wasOnline, int userId) throws NodeExcep
 	 * @throws NodeException when taking offline has to fail
 	 */
 	default void onTakeOffline(T object, boolean wasOnline, int userId) throws NodeException {
+		PublishProtocolUtil.logPublishState(object, PublishState.OFFLINE.getValue(), userId);
+
 		for (ExtensiblePublishableObjectService<T> service : getServices()) {
 			service.onTakeOffline(object, wasOnline, userId);
 		}

cms-core/src/main/java/com/gentics/contentnode/factory/object/FormFactory.java

@@ -182,6 +182,16 @@ private static class FactoryForm extends AbstractContentObject implements Form,
 		@Unversioned
 		protected ContentNodeDate pDate = new ContentNodeDate(0);
 
+		@DataField("unpublishedDate")
+		@Updateable
+		@Unversioned
+		protected ContentNodeDate unpublishedDate = new ContentNodeDate(0);
+
+		@DataField("unpublisher")
+		@Updateable
+		@Unversioned
+		protected int unpublisher = 0;
+
 		@DataField("publisher")
 		@Updateable
 		@Unversioned
@@ -329,13 +339,47 @@ public ContentNodeDate getPDate() {
 			return pDate;
 		}
 
+		@Override
+		public ContentNodeDate getUnpublishedDate() {
+			try {
+				return DBUtils.select("SELECT unpublished_date FROM form WHERE id = ?", stmt -> {
+							stmt.setInt(1, getId());
+						}, resultSet -> {
+							if (resultSet.next()) {
+								int unpublishedDate = resultSet.getInt("unpublished_date");
+								this.unpublishedDate = new ContentNodeDate(unpublishedDate);
+							}
+							return this.unpublishedDate;
+						}
+				);
+			} catch (NodeException e) {
+				logger.error("Unable to get unpublished date from form with id: "+ getId(), e);
+			}
+
+			return this.unpublishedDate;
+		}
+
 		@Override
 		public SystemUser getPublisher() throws NodeException {
 			SystemUser publisher = TransactionManager.getCurrentTransaction().getObject(SystemUser.class, publisherId);
 			assertNodeObjectNotNull(publisher, publisherId, "Publisher", true);
 			return publisher;
 		}
 
+		@Override
+		public SystemUser getUnpublisher() throws NodeException {
+			return DBUtils.select("SELECT unpublisher FROM form WHERE id = ?", stmt -> {
+						stmt.setInt(1, getId());
+					}, resultSet -> {
+						if (resultSet.next()) {
+							int unpublisherId = resultSet.getInt("unpublisher");
+							return TransactionManager.getCurrentTransaction().getObject(SystemUser.class, unpublisherId);
+						}
+						return null;
+					}
+			);
+		}
+
 		@Override
 		public void publish(int at, boolean keepTimePubVersion) throws ReadOnlyException, NodeException {
 			Transaction t = TransactionManager.getCurrentTransaction();
@@ -463,6 +507,9 @@ public void takeOffline(int at) throws ReadOnlyException, NodeException {
 
 			// we need to sent the NOTIFY event for the form in order to allow indexing (for feature ELASTICSEARCH)
 			t.addTransactional(new TransactionalTriggerEvent(Form.class, getId(), INDEXED_STATUS_ATTRIBUTES, Events.NOTIFY));
+
+			int unpublishedAt = at == 0 ? TransactionManager.getCurrentTransaction().getUnixTimestamp() : at;
+			DBUtils.update("UPDATE form SET unpublished_date = ?, unpublisher = ? WHERE id = ?", unpublishedAt, t.getUserId(), getId());
 		}
 
 		@Override

cms-core/src/main/java/com/gentics/contentnode/factory/object/PageFactory.java

@@ -265,6 +265,7 @@ private static class FactoryPage extends AbstractPage implements DisinheritableI
 		protected ContentNodeDate eDate = new ContentNodeDate(0);
 		protected ContentNodeDate customEDate = new ContentNodeDate(0);
 		protected ContentNodeDate pDate = new ContentNodeDate(0);
+		protected ContentNodeDate unpublishedDate = new ContentNodeDate(0);
 		protected Integer creatorId = 0;
 		protected Integer editorId = 0;
 		protected Integer publisherId = 0;
@@ -744,6 +745,19 @@ public SystemUser getPublisher() throws NodeException {
 			return publisher;
 		}
 
+		public SystemUser getUnpublisher() throws NodeException {
+			return DBUtils.select("SELECT unpublisher FROM page WHERE id = ?", stmt -> {
+						stmt.setInt(1, getId());
+					}, resultSet -> {
+						if (resultSet.next()) {
+							int unpublisherId = resultSet.getInt("unpublisher");
+							return TransactionManager.getCurrentTransaction().getObject(SystemUser.class, unpublisherId);
+						}
+						return null;
+					}
+			);
+		}
+
 		public List<Page> getLanguageVariants(boolean considerNodeLanguages) throws NodeException {
 			return loadLanguageVariants(considerNodeLanguages);
 		}
@@ -1128,6 +1142,27 @@ protected void setPDate(int timestamp) {
 			}
 		}
 
+		public ContentNodeDate getUnpublishedDate() {
+			try {
+				return DBUtils.select("SELECT unpublished_date FROM page WHERE id = ?", stmt -> {
+							stmt.setInt(1, getId());
+						}, resultSet -> {
+							if (resultSet.next()) {
+								int unpublishedDate = resultSet.getInt("unpublished_date");
+								this.unpublishedDate = new ContentNodeDate(unpublishedDate);
+							}
+							return this.unpublishedDate;
+						}
+				);
+			} catch (NodeException e) {
+				logger.error("Unable to get unpublished date from page with id: "+ getId(), e);
+			}
+
+			return this.unpublishedDate;
+		}
+
+
+
 		/**
 		 * Get the pdate of the page. If a value is stored as transaction attribute, it will modify the current pdate.
 		 * @return pdate
@@ -2591,6 +2626,7 @@ public void takeOffline(int timestamp) throws ReadOnlyException, NodeException {
 				// set the planned offline time and clear queue for planned offline time
 				Transaction t = TransactionManager.getCurrentTransaction();
 				DBUtils.update("UPDATE page SET time_off = ?, off_queue = ?, time_off_queue = ? WHERE id = ?", timestamp, 0, 0, getId());
+
 				timeOff = new ContentNodeDate(timestamp);
 				offQueueUserId = 0;
 				timeOffQueue = new ContentNodeDate(0);
@@ -2599,6 +2635,9 @@ public void takeOffline(int timestamp) throws ReadOnlyException, NodeException {
 				// we need to sent the NOTIFY event for the page in order to allow indexing (for feature ELASTICSEARCH)
 				t.addTransactional(new TransactionalTriggerEvent(Page.class, getId(), INDEXED_STATUS_ATTRIBUTES, Events.NOTIFY));
 			}
+			Transaction t = TransactionManager.getCurrentTransaction();
+			int unpublishedAt = timestamp == 0 ? TransactionManager.getCurrentTransaction().getUnixTimestamp() : timestamp;
+			DBUtils.update("UPDATE page SET unpublished_date = ?, unpublisher = ? WHERE id = ?", unpublishedAt, t.getUserId(), getId());
 		}
 
 		@Override

cms-core/src/main/java/com/gentics/contentnode/object/PublishableNodeObject.java

@@ -38,13 +38,26 @@ public interface PublishableNodeObject extends NodeObject {
 	 */
 	ContentNodeDate getPDate();
 
+	/**
+	 * get the unpublish date as a unix timestamp
+	 * @return unpublish date unix timestamp
+	 */
+	ContentNodeDate getUnpublishedDate();
+
 	/**
 	 * Get the user, who published the object (last)
 	 * @return last publisher, may be null
 	 * @throws NodeException
 	 */
 	SystemUser getPublisher() throws NodeException;
 
+	/**
+	 * Get the user, who unpublished the object (last)
+	 * @return last unpublisher, may be null
+	 * @throws NodeException
+	 */
+	SystemUser getUnpublisher() throws NodeException;
+
 	/**
 	 * Publish the object
 	 * @throws ReadOnlyException

cms-core/src/main/java/com/gentics/contentnode/publish/PublishStatus.java

@@ -1,7 +1,7 @@
 /*
  * @author Stefan Hepp
  * @date 23.1.2006
- * @version $Id: PublishStatus.java,v 1.2 2006-02-05 18:16:44 stefan Exp $
+ * @version $Id: PublishState.java,v 1.2 2006-02-05 18:16:44 stefan Exp $
  */
 package com.gentics.contentnode.publish;