SAK-51090 Announcements cc+ don't import adding draft announcements for assignments (#13413)

Author: csev

announcement/announcement-impl/impl/src/java/org/sakaiproject/announcement/impl/BaseAnnouncementService.java

@@ -114,6 +114,7 @@
 import org.sakaiproject.util.Validator;
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
+import org.w3c.dom.NodeList;
 
 /**
  * <p>
@@ -1767,6 +1768,32 @@ public boolean approveMessageSender(String userId) {
 		return true; // Always approve the sender
 	}
 
+	/**
+	 * This method is used to check if a message can be merged - it is called with an element from the XML that represents the message
+	 *
+	 * 	<message body="T3BljAwIEFNIEVTVC4=" body-html="PHA+T3BjAwIEFNIEVTVC48L3A+">
+	 *		<header access="channel" date="20250217200655521" draft="true" from="" id="ad7bcb9a-f335-46a7-ad01-907778fb9df5" message_order="2"
+	 *		 subject="Assignment: Open Date for ''HW2''"/>
+	 *		<properties>
+	 *			<property enc="BASE64" list="list" name="noti_history" value="MjAyNSaXzA=" B64Decoded="2025-02-17T20:06:55.538289588Z_0"/>
+	 *			<property enc="BASE64" name="assignmentReference" value="L2Fzc2e8/5fab8f09-e029-4672-b478-43cfa3e17d64"/>
+	 *		</properties>
+	 *	</message>
+	 */
+	@Override
+	public boolean checkAllowMergeElement(Element element) {
+		NodeList propertyList = element.getElementsByTagName("property");
+		for (int i = 0; i < propertyList.getLength(); i++) {
+			Element propertyElement = (Element) propertyList.item(i);
+			String name = propertyElement.getAttribute("name");
+			if (name.equals("assignmentReference")) {
+				log.debug("Assignment announcement found, not merging");
+				return false;
+			}
+		}
+		return true;
+	}
+
 	@Override
 	public String getToolTitle(String url) {
 		return getToolTitle();

message/message-api/api/src/java/org/sakaiproject/message/api/MessageService.java

@@ -29,6 +29,7 @@
 
 import java.util.List;
 import java.util.Map;
+import org.w3c.dom.Element;
 
 /**
  * <p>
@@ -335,5 +336,14 @@ public List<Message> getMessages(String channelRef, Time afterDate, int limitedT
 	 */
 	public String getToolTitle(String url);
 
+	/**
+	 * Allows a service extending MessageService to check if a message can be merged
+	 *
+	 * @param element
+	 *        The element to check
+	 * @return true if the message can be merged, false otherwise
+	 */
+	public boolean checkAllowMergeElement(Element element);
+
 } // MessageService
 

message/message-util/util/src/java/org/sakaiproject/message/util/BaseMessage.java

@@ -371,6 +371,17 @@ public boolean approveMessageSender(String userId) {
 		return false;
 	}
 
+	/**
+	 * Allows a service extending BaseMessageService to check if a message can be merged
+	 *
+	 * @param element
+	 *        The element to check
+	 * @return true if the message can be merged, false otherwise
+	 */
+	public boolean checkAllowMergeElement(Element element) {
+		return true;
+	}
+
 	/**
 	 * Access the internal reference which can be used to access the message from within the system.
 	 * 
@@ -1967,6 +1978,11 @@ else if (element2.getTagName().equals(SYNOPTIC_TOOL))
 											}
 										}
 									}
+
+									// Once last moment to consult the extending service to allow or disallow merging
+									if ( goAhead ) {
+										goAhead = checkAllowMergeElement(element3);
+									}
 									// merge if ok
 									if (goAhead)
 									{