SAK-48981 msgcntr handle forum and topic permission levels when using Lesson's prerequisites (#14604)

Author: ern

config/configuration/bundles/src/bundle/org/sakaiproject/config/bundle/default.sakai.properties

@@ -3963,6 +3963,11 @@
 # DEFAULT: false
 # mc.disableLongDesc=true
 
+# Messages tool option for sending a copy of a message to recipient email addresses.
+# Options are 0 (Never), 1 (Optional), and 2 (Always)
+# DEFAULT: 1
+# msgcntr.defaultSendToEmailSetting=2
+
 # Include a copy of the message to the recipient by default. Works in conjunction with user preference.
 # DEFAULT: false
 # mc.messages.ccEmailDefault=true

lessonbuilder/tool/src/java/org/sakaiproject/lessonbuildertool/service/ForumEntity.java

@@ -30,137 +30,129 @@ public interface Area extends MutableEntity {
      * setting for {@link #sendToEmail}. A copy of message is never sent
      * to recipients' email addresses
      */
-    public static final int EMAIL_COPY_NEVER = 0;
+    int EMAIL_COPY_NEVER = 0;
     /**
      * setting for {@link #sendToEmail}. Sender is given the option of sending
      * a copy of message to email addresses 
      */
-    public static final int EMAIL_COPY_OPTIONAL = 1;
+    int EMAIL_COPY_OPTIONAL = 1;
     /**
      * setting for {@link #sendToEmail}. A copy of message is always sent
      * to recipients' email addresses
      */
-    public static final int EMAIL_COPY_ALWAYS = 2;
+    int EMAIL_COPY_ALWAYS = 2;
 
-    public void setVersion(Integer version);
+    void setVersion(Integer version);
 
-    public String getContextId();
+    String getContextId();
 
-    public void setContextId(String contextId);
+    void setContextId(String contextId);
 
-    public Boolean getHidden();
+    Boolean getHidden();
 
-    public void setHidden(Boolean hidden);
+    void setHidden(Boolean hidden);
 
-    public String getName();
+    String getName();
 
-    public void setName(String name);
+    void setName(String name);
 
-    public Boolean getEnabled();
+    Boolean getEnabled();
 
-    public void setEnabled(Boolean enabled);
+    void setEnabled(Boolean enabled);
 
-    /**
-     * {@link Deprecated} This option was replaced by sendToEmail via MSGCNTR-708. DO NOT USE.
-     * @return
-     */
-    public Boolean getSendEmailOut();
+    Boolean getSendEmailOut();
 
-    /**
-     * {@link Deprecated} This option was replaced by sendToEmail via MSGCNTR-708. DO NOT USE.
-     * @param sendEmailOut
-     */
-    public void setSendEmailOut(Boolean sendEmailOut);
+    void setSendEmailOut(Boolean sendEmailOut);
 
     /**
      * 
      * @return the site-level setting for sending a copy of the message to recipients'
      * email addresses. This may be {@link #EMAIL_COPY_NEVER}, #{@link #EMAIL_COPY_OPTIONAL},
      * {@link #EMAIL_COPY_ALWAYS}
      */
-    public int getSendToEmail();
+    int getSendToEmail();
 
     /**
      * set the site-level setting for sending a copy of the message to recipients'
      * email addresses. This may be {@link #EMAIL_COPY_NEVER}, #{@link #EMAIL_COPY_OPTIONAL},
      * {@link #EMAIL_COPY_ALWAYS}
      * @param sendToEmail
      */
-    public void setSendToEmail(int sendToEmail);
+    void setSendToEmail(int sendToEmail);
 
-    public List getOpenForums();
+    List<OpenForum> getOpenForums();
 
-    public Set getOpenForumsSet();
+    Set<OpenForum> getOpenForumsSet();
 
-    public void setOpenForums(List openForums);
+    void setOpenForums(List<OpenForum> openForums);
 
-    public List getPrivateForums();
+    List<PrivateForum> getPrivateForums();
 
-    public Set getPrivateForumsSet();
+    Set<PrivateForum> getPrivateForumsSet();
 
-    public void setPrivateForums(List discussionForums);
+    void setPrivateForums(List<PrivateForum> discussionForums);
 
-    public List getDiscussionForums();
+    List<DiscussionForum> getDiscussionForums();
 
-    public void setDiscussionForums(List discussionForums);
+    void setDiscussionForums(List<DiscussionForum> discussionForums);
 
-    public String getTypeUuid();
+    String getTypeUuid();
 
-    public void setTypeUuid(String typeUuid);
+    void setTypeUuid(String typeUuid);
 
-    public void addPrivateForum(BaseForum forum);
+    void addPrivateForum(PrivateForum forum);
 
-    public void removePrivateForum(BaseForum forum);
+    void removePrivateForum(PrivateForum forum);
 
-    public void addDiscussionForum(BaseForum forum);
+    void addDiscussionForum(DiscussionForum forum);
 
-    public void removeDiscussionForum(BaseForum forum);
+    void removeDiscussionForum(DiscussionForum forum);
 
-    public void addOpenForum(BaseForum forum);
+    void addOpenForum(OpenForum forum);
 
-    public void removeOpenForum(BaseForum forum);
+    void removeOpenForum(OpenForum forum);
 
-    public Boolean getLocked();
+    Boolean getLocked();
 
-    public void setLocked(Boolean locked);
+    void setLocked(Boolean locked);
 
-    public Boolean getModerated();
+    Boolean getModerated();
 
-    public void setModerated(Boolean moderated);
+    void setModerated(Boolean moderated);
 
-    public Boolean getAutoMarkThreadsRead();
+    Boolean getAutoMarkThreadsRead();
 
-    public void setAutoMarkThreadsRead(Boolean autoMarkThreadsRead);
+    void setAutoMarkThreadsRead(Boolean autoMarkThreadsRead);
 
-    public Set<DBMembershipItem> getMembershipItemSet();
+    Set<DBMembershipItem> getMembershipItemSet();
 
-	public void setMembershipItemSet(Set<DBMembershipItem> membershipItemSet);
+	void setMembershipItemSet(Set<DBMembershipItem> membershipItemSet);
 
-    public void addMembershipItem(DBMembershipItem item);      
+    void addMembershipItem(DBMembershipItem item);
 
-    public void removeMembershipItem(DBMembershipItem item);
+    void removeMembershipItem(DBMembershipItem item);
 
-    public Boolean getAvailabilityRestricted();
+    Boolean getAvailabilityRestricted();
 
-    public void setAvailabilityRestricted(Boolean restricted);
+    void setAvailabilityRestricted(Boolean restricted);
 
-    public Date getOpenDate();
+    Date getOpenDate();
 
-	public void setOpenDate(Date openDate);
+	void setOpenDate(Date openDate);
 
-    public Date getCloseDate();
+    Date getCloseDate();
 
-	public void setCloseDate(Date closeDate);
+	void setCloseDate(Date closeDate);
 
-	public Boolean getAvailability();
+	Boolean getAvailability();
 
-    public void setAvailability(Boolean restricted);
+    void setAvailability(Boolean restricted);
 
-    public Boolean getPostFirst();
+    Boolean getPostFirst();
 
-    public void setPostFirst(Boolean postFirst);
+    void setPostFirst(Boolean postFirst);
 
-    public Set getHiddenGroups();
+    Set<HiddenGroup> getHiddenGroups();
 
-    public void setHiddenGroups(Set hiddenGroups);
+    void setHiddenGroups(Set<HiddenGroup> hiddenGroups);
 }

msgcntr/messageforums-api/src/java/org/sakaiproject/api/app/messageforums/Area.java

@@ -284,13 +284,20 @@ public interface MessageForumsForumManager {
 	public List getForumByTypeAndContextWithTopicsAllAttachments(final String typeUuid, final String contextId);
 
 	/**
-	 * 
+	 *
 	 * @param topicId
 	 * @return the Topic with the given id with the DBMembershipItems initialized.
 	 * Does not initialize attachments or messages.
 	 */
 	public Topic getTopicByIdWithMemberships(final Long topicId);
 
+	/**
+	 * @param forumId
+	 * @return the BaseForum with the given id with the DBMembershipItems initialized.
+	 * Does not initialize attachments or topics.
+	 */
+	public BaseForum getForumByIdWithMemberships(final Long forumId);
+
 	/**
 	 * @param contextId the context in which we are seeking topics
 	 * @return all topics within this context

msgcntr/messageforums-api/src/java/org/sakaiproject/api/app/messageforums/MessageForumsForumManager.java

@@ -676,4 +676,28 @@ public void saveTopicMessagePermissions(DiscussionTopic topic,
   public Optional<LRS_Statement> getStatementForGrade(String studentUid, String forumTitle, double score);
 
   void setUiPermissionsManager(UIPermissionsManager uiPermissionsManager);
+
+  /**
+   * Restrict access to a topic to the named groups only.
+   * Contributor-level role and group items are set to None; items for the specified groups are set
+   * to Contributor. Owner items are never modified. Passing null or an empty set are treated
+   * identically and restore role items to Contributor and group items to None (open to site).
+   * If the site or any group ID cannot be resolved, the operation is aborted and no changes are saved.
+   *
+   * @param topicId  the id of the DiscussionTopic
+   * @param groupIds site group IDs; null or empty means "open to site"
+   */
+  void setTopicGroupRestrictions(Long topicId, Set<String> groupIds);
+
+  /**
+   * Restrict access to a forum to the named groups only.
+   * Contributor-level role and group items are set to None; items for the specified groups are set
+   * to Contributor. Owner items are never modified. Passing null or an empty set are treated
+   * identically and restore role items to Contributor and group items to None (open to site).
+   * If the site or any group ID cannot be resolved, the operation is aborted and no changes are saved.
+   *
+   * @param forumId  the id of the DiscussionForum
+   * @param groupIds site group IDs; null or empty means "open to site"
+   */
+  void setForumGroupRestrictions(Long forumId, Set<String> groupIds);
 }