SAK-42257 - Problems archiving message forums (sakaiproject#7232)

* SAK-42257 - Problems archiving message forums With this commit the export and import processes for forums are fixed. Now messages are exported and imported. * SAK-42257: Problems archiving message forums * SAK-42257 - Problems archiving message forums Commit to fix issues reported by Codacy and some more. * SAK-42257 - Problems archiving message forums Commit to apply suggested changes in PR * SAK-42257 - Problems archiving message forums Commit to fix an issue importing forums with custom permission configuration at discussion topic level. Also Conflicts with master have been solved.
bot2012 · Sep 16, 2019 · 2ed0668 · 2ed0668
1 parent 66cece7
commit 2ed0668
Show file tree

Hide file tree

Showing 13 changed files with 1,016 additions and 879 deletions.
diff --git a/...forums-api/src/java/org/sakaiproject/api/app/messageforums/MessageForumsForumManager.java b/...forums-api/src/java/org/sakaiproject/api/app/messageforums/MessageForumsForumManager.java
@@ -111,9 +111,9 @@ public interface MessageForumsForumManager {
     /**
      * Save a discussion forum topic
      */
-    public void saveDiscussionForumTopic(DiscussionTopic topic);
-    public void saveDiscussionForumTopic(DiscussionTopic topic, boolean parentForumDraftStatus);
-    public void saveDiscussionForumTopic(DiscussionTopic topic, boolean parentForumDraftStatus, String currentUser, boolean logEvent);
+    public DiscussionTopic saveDiscussionForumTopic(DiscussionTopic topic);
+    public DiscussionTopic saveDiscussionForumTopic(DiscussionTopic topic, boolean parentForumDraftStatus);
+    public DiscussionTopic saveDiscussionForumTopic(DiscussionTopic topic, boolean parentForumDraftStatus, String currentUser, boolean logEvent);
     /**
      * Create and save an empty private discussion forum topic
      */
@@ -130,8 +130,12 @@ public interface MessageForumsForumManager {
      * Delete a private forum topic
      */
     public void deletePrivateForumTopic(PrivateTopic topic);
-
-
+
+    /**
+     * Create an empty message
+     */
+    Message createMessage(final DiscussionTopic topic);
+
     /**
      * Create and save an empty open discussion forum topic
      */

diff --git a/...rums-api/src/java/org/sakaiproject/api/app/messageforums/MessageForumsMessageManager.java b/...rums-api/src/java/org/sakaiproject/api/app/messageforums/MessageForumsMessageManager.java
@@ -37,9 +37,9 @@ public interface MessageForumsMessageManager {
 
     public Message createOpenMessage();
 
-    public Message saveMessage(Message message);
+    public Message saveOrUpdateMessage(Message message);
 
-    public Message saveMessage(Message message, boolean logEvent);
+    public Message saveOrUpdateMessage(Message message, boolean logEvent);
     /**
      * 
      * @param message message
@@ -50,7 +50,32 @@ public interface MessageForumsMessageManager {
      * @return 
      *
      */
-	public Message saveMessage(Message message, boolean logEvent, String toolId, String userId, String contextId);
+    public Message saveOrUpdateMessage(Message message, boolean logEvent, String toolId, String userId, String contextId);
+    /**
+     * 
+     * @param message
+     * @param logEvent
+     * @param ignoreLockedTopicForum set true if you want to allow the message
+     * to be updated even if the topic or forum is locked (ie marking as read or
+     * commenting on a moderated message)
+     * @return Message saved or updated, with the assigned id. Different object
+     * that the one passed as parameter.
+     */
+    public Message saveOrUpdateMessage(Message message, boolean logEvent, boolean ignoreLockedTopicForum);
+
+    String saveMessage(Message message);
+
+    String saveMessage(Message message, boolean logEvent);
+    /**
+     * 
+     * @param message message
+     * @param logEvent logEvent
+     * @param toolId id of the forums tool 
+     * @param userId user id
+     * @param contextId context id
+     *
+     */
+    String saveMessage(Message message, boolean logEvent, String toolId, String userId, String contextId);
 
     /**
      * 
@@ -60,8 +85,10 @@ public interface MessageForumsMessageManager {
      * to be updated even if the topic or forum is locked (ie marking as read or
      * commenting on a moderated message)
      */
-    public Message saveMessage(Message message, boolean logEvent, boolean ignoreLockedTopicForum);
+	String saveMessage(Message message, boolean logEvent, boolean ignoreLockedTopicForum);
 
+    String saveMessage(Message message, boolean logEvent, String toolId, String userId, String contextId,
+            boolean ignoreLockedTopicForum);
     public void deleteMessage(Message message);
 
     public Message getMessageById(Long messageId);

diff --git a/...ageforums-api/src/java/org/sakaiproject/api/app/messageforums/PermissionLevelManager.java b/...ageforums-api/src/java/org/sakaiproject/api/app/messageforums/PermissionLevelManager.java
@@ -90,8 +90,8 @@ public interface PermissionLevelManager {
 	public List<PermissionLevel> getDefaultPermissionLevels();
 
     public DBMembershipItem createDBMembershipItem(String name, String permissionLevelName, Integer type);
-    public void saveDBMembershipItem(DBMembershipItem item);
-    public void savePermissionLevel(PermissionLevel level);
+    public DBMembershipItem saveDBMembershipItem(DBMembershipItem item);
+    public PermissionLevel savePermissionLevel(PermissionLevel level);
 
     /**
      * 

diff --git a/...r/messageforums-app/src/java/org/sakaiproject/tool/messageforums/DiscussionForumTool.java b/...r/messageforums-app/src/java/org/sakaiproject/tool/messageforums/DiscussionForumTool.java
@@ -4746,7 +4746,7 @@ public String processDfMsgRevisedPost()
 
 		LRS_Statement statement = forumManager.getStatementForUserPosted(dMsg.getTitle(), SAKAI_VERB.responded).orElse(null);
 		Message persistedMessage = forumManager.saveMessage(dMsg, new ForumsMessageEventParams(ForumsMessageEventParams.MessageEvent.REVISE, statement));
-		
+
 		messageManager.markMessageReadForUser(dfTopic.getId(), persistedMessage.getId(), true);
 
 		List messageList = selectedTopic.getMessages();
@@ -5376,7 +5376,7 @@ public String processAddCommentToDeniedMsg()
               .getTopicByIdWithMessages(selectedTopic.getTopic().getId()));
 	  LRS_Statement statement = forumManager.getStatementForUserPosted(currMessage.getTitle(), SAKAI_VERB.responded).orElse(null);
 	  Message persistedMessage = forumManager.saveMessage(currMessage, new ForumsMessageEventParams(ForumsMessageEventParams.MessageEvent.REVISE, statement), true);
-	  
+
 	  if (displayDeniedMsg) // only displayed if from Deny & Comment path
 	  {
 		  setSuccessMessage(getResourceBundleString("cdfm_denied_alert"));
@@ -6987,7 +6987,7 @@ else if (target instanceof Topic){
         setupMembershipItemPermission(membershipItem, permBean);
 
         // save DBMembershiptItem here to get an id so we can add to the set
-        permissionLevelManager.saveDBMembershipItem(membershipItem);          
+        membershipItem = permissionLevelManager.saveDBMembershipItem(membershipItem);
 
         membershipItemSet.add(membershipItem);
       }
@@ -8206,7 +8206,7 @@ private DiscussionTopicBean duplicateTopic(Long originalTopicId, DiscussionForum
 				log.debug("About to getMembershipItemCopy()");
 				DBMembershipItem newItem = getMembershipItemCopy(oldItem);
 				if (newItem != null) {
-					permissionLevelManager.saveDBMembershipItem(newItem);
+					newItem = permissionLevelManager.saveDBMembershipItem(newItem);
 					newTopic.addMembershipItem(newItem);
 				}
 		}
@@ -8859,7 +8859,7 @@ public String processMoveThread() {
 			if (log.isDebugEnabled()) log.debug("processMoveThread messageId = " + mes.getId());
 			if (log.isDebugEnabled()) log.debug("processMoveThread message title = " + mes.getTitle());
 			mes.setTopic(desttopic);
-			messageManager.saveMessage(mes);
+			mes = messageManager.saveOrUpdateMessage(mes);
 
 			// mfr_move_history_t stores only records that are used to display reminder links. Not all moves are recorded in this
 			// table.
@@ -8879,7 +8879,7 @@ public String processMoveThread() {
 				if (log.isDebugEnabled()) log.debug("processMoveThread messageId = " + childMsg.getId());
 				if (log.isDebugEnabled()) log.debug("processMoveThread message title = " + childMsg.getTitle());
 				childMsg.setTopic(desttopic);
-				messageManager.saveMessage(childMsg);
+				childMsg = messageManager.saveOrUpdateMessage(childMsg);
 				messageManager.saveMessageMoveHistory(childMsg.getId(), desttopicId, sourceTopicId, checkReminder);
 				eventmsg = "Moving message " + childMsg.getId() + " from topic " + sourceTopicId + " to topic " + desttopicId;
 				eventTrackingService.post(eventTrackingService.newEvent(DiscussionForumService.EVENT_FORUMS_MOVE_THREAD, eventmsg, true));

diff --git a/msgcntr/messageforums-component-impl/pom.xml b/msgcntr/messageforums-component-impl/pom.xml
@@ -103,6 +103,10 @@
       <groupId>org.sakaiproject.rubrics</groupId>
       <artifactId>rubrics-service-api</artifactId>
     </dependency>
+    <dependency>
+        <groupId>org.apache.commons</groupId>
+        <artifactId>commons-lang3</artifactId>
+    </dependency>
   </dependencies>
   <build>
     <resources>