SAK-51956 motifications Add broadcast type notification

https://sakaiproject.atlassian.net/browse/SAK-51956

The idea behind this change is to replace the MOTD type notifications
with a single db entry rather than one for each system user.

This change also creates a SchedulingService which provides a facade
onto a ScheduledExecutorService and updates all the uses of scheduled
executors across Sakai to use it.

Author: adrianfish

announcement/announcement-api/api/src/java/org/sakaiproject/announcement/api/AnnouncementsUserNotificationHandler.java

@@ -127,7 +127,7 @@ private List<UserNotificationData> handleAdd(String from, String siteId, String
                 if (groupIds.isEmpty() || groupsUsers.contains(to)) {
                     if (!from.equals(to) && !securityService.isSuperUser(to)) {
                         String url = assignmentService.getDeepLink(siteId, assignmentId, to);
-                        bhEvents.add(new UserNotificationData(from, to, siteId, title, url, AssignmentConstants.TOOL_ID));
+                        bhEvents.add(new UserNotificationData(from, to, siteId, title, url, AssignmentConstants.TOOL_ID, false, null));
                     }
                 }
             }
@@ -164,7 +164,7 @@ private List<UserNotificationData> handleUpdateAccess(String from, String ref, S
                 String to = u.getId();
                 if (!from.equals(to) && !securityService.isSuperUser(to)) {
                     String url = assignmentService.getDeepLink(siteId, assignmentId, to);
-                    bhEvents.add(new UserNotificationData(from, to, siteId, title, url, AssignmentConstants.TOOL_ID));
+                    bhEvents.add(new UserNotificationData(from, to, siteId, title, url, AssignmentConstants.TOOL_ID, false, null));
                 }
             }
         } else {
@@ -178,7 +178,7 @@ private List<UserNotificationData> handleUpdateAccess(String from, String ref, S
                 String to = u.getId();
                 if (!from.equals(to) && !securityService.isSuperUser(to)) {
                     String url = assignmentService.getDeepLink(siteId, assignmentId, to);
-                    bhEvents.add(new UserNotificationData(from, to, siteId, title, url, AssignmentConstants.TOOL_ID));
+                    bhEvents.add(new UserNotificationData(from, to, siteId, title, url, AssignmentConstants.TOOL_ID, false, null));
                 }
             }
         }

assignment/api/src/java/org/sakaiproject/assignment/api/AddAssignmentUserNotificationHandler.java

@@ -94,7 +94,7 @@ public Optional<List<UserNotificationData>> handleEvent(Event e) {
                         try {
                             String url = assignmentService.getDeepLink(siteId, assignment.getId(), to.getSubmitter());
                             if (StringUtils.isNotBlank(url)) { 
-                                bhEvents.add(new UserNotificationData(from, to.getSubmitter(), siteId, title, url, AssignmentConstants.TOOL_ID));
+                                bhEvents.add(new UserNotificationData(from, to.getSubmitter(), siteId, title, url, AssignmentConstants.TOOL_ID, false, null));
                             }
                         } catch(Exception exc) {
                             log.error("Error retrieving deep link for assignment {} and user {} on site {}", assignment.getId(), to.getSubmitter(), siteId, exc);

assignment/api/src/java/org/sakaiproject/assignment/api/GradeAssignmentUserNotificationHandler.java

@@ -91,7 +91,7 @@ public Optional<List<UserNotificationData>> handleEvent(Event e) {
 
             // First, send an alert to the post author
             if (!commentCreator.equals(postCreator)) {
-                bhEvents.add(new UserNotificationData(commentCreator, postCreator, siteId, siteTitle, url, CommonsConstants.TOOL_ID));
+                bhEvents.add(new UserNotificationData(commentCreator, postCreator, siteId, siteTitle, url, CommonsConstants.TOOL_ID, false, null));
             }
 
             List<String> sentAlready = new ArrayList<>();
@@ -107,7 +107,7 @@ public Optional<List<UserNotificationData>> handleEvent(Event e) {
                 }
 
                 if (!sentAlready.contains(to)) {
-                    bhEvents.add(new UserNotificationData(commentCreator, to, siteId, siteTitle, url, CommonsConstants.TOOL_ID));
+                    bhEvents.add(new UserNotificationData(commentCreator, to, siteId, siteTitle, url, CommonsConstants.TOOL_ID, false, null));
                     sentAlready.add(to);
                 }
             }

commons/api/src/java/org/sakaiproject/commons/api/CommonsCommentUserNotificationHandler.java

@@ -2255,6 +2255,10 @@
 # DEFAULT: false
 # announcement.notification.email.to.matches.from=true
 
+# Controls how long a MOTD user notification lives, in hours, before being cleaned up
+# DEFAULT: 24
+# announcement.motd.notification.ttlhours=1
+
 ## BASICLTI PROVIDER
 
 # Enable the Provider
@@ -5765,3 +5769,17 @@
 # on a production system.  If there is no PNP base URL, this value has no effect.
 # lti.pnp.use_email=false
 # DEFAULT: false
+
+
+# Set the delay period between expired notifications
+# DEFAULT: 30
+# messaging.delete.expired.periodminutes=10
+
+# Set the number of threads pooled for use by the user messaging service. An executor will use these
+# threads to send emails or digests to users
+# DEFAULT: 10
+# messaging.threadpool.size=4
+
+# Configure the thread pool size for the scheduling service.
+# DEFAULT: 8
+# schedulingservice.poolsize=4

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

@@ -62,7 +62,7 @@ public interface UserMessagingService {
     /**
      * @return the list of notifications for the current user
      */
-    public List<UserNotification> getNotifications();
+    public List<UserNotificationTransferBean> getNotifications();
 
     /**
      * Register a handler for broadcast messages. The first registered handler that

kernel/api/src/main/java/org/sakaiproject/messaging/api/UserMessagingService.java

@@ -15,10 +15,15 @@
  */
 package org.sakaiproject.messaging.api;
 
+import java.time.Duration;
+
 import lombok.AllArgsConstructor;
-import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Data;
 
-@AllArgsConstructor @Getter
+@AllArgsConstructor
+@NoArgsConstructor
+@Data
 public class UserNotificationData {
 
     private String from;
@@ -27,4 +32,6 @@ public class UserNotificationData {
     private String title;
     private String url;
     private String commonToolId;
+    private boolean broadcast;
+    private Duration ttl;
 }

kernel/api/src/main/java/org/sakaiproject/messaging/api/UserNotificationData.java

@@ -0,0 +1,56 @@
+/**
+ * Copyright (c) 2003-2019 The Apereo Foundation
+ *
+ * Licensed under the Educational Community License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *             http://opensource.org/licenses/ecl2
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.sakaiproject.messaging.api;
+
+import org.sakaiproject.messaging.api.model.UserNotification;
+
+import java.time.Instant;
+
+public class UserNotificationTransferBean {
+
+    public String from;
+    public String to;
+    public String event;
+    public String ref;
+    public String title;
+    public String siteId;
+    public String url;
+    public Instant eventDate;
+    public boolean viewed;
+    public String tool;
+    public boolean broadcast;
+
+    public String fromDisplayName;
+    public String siteTitle;
+    public String formattedEventDate;
+
+    public static UserNotificationTransferBean of(UserNotification un) {
+
+        UserNotificationTransferBean bean = new UserNotificationTransferBean();
+        bean.from = un.getFromUser();
+        bean.to = un.getToUser();
+        bean.event = un.getEvent();
+        bean.ref = un.getRef();
+        bean.title = un.getTitle();
+        bean.siteId = un.getSiteId();
+        bean.url = un.getUrl();
+        bean.eventDate = un.getEventDate();
+        bean.viewed = un.getViewed();
+        bean.tool = un.getTool();
+        bean.broadcast = un.getBroadcast();
+        return bean;
+    }
+}

kernel/api/src/main/java/org/sakaiproject/messaging/api/UserNotificationTransferBean.java

@@ -25,7 +25,6 @@
 import javax.persistence.Index;
 import javax.persistence.SequenceGenerator;
 import javax.persistence.Table;
-import javax.persistence.Transient;
 
 import org.sakaiproject.springframework.data.PersistableEntity;
 
@@ -68,13 +67,17 @@ public class UserNotification implements PersistableEntity<Long> {
     @Column(name="SITE_ID", length = 99)
     private String siteId;
 
-    @Column(name="URL", length = 2048, nullable = false)
+    @Column(name="URL", length = 2048)
     private String url;
 
     @Column(name="EVENT_DATE", nullable = false)
     @Type(type = "org.hibernate.type.InstantType")
     private Instant eventDate;
 
+    @Column(name="END_DATE")
+    @Type(type = "org.hibernate.type.InstantType")
+    private Instant endDate;
+
     @Column(name="DEFERRED", nullable = false)
     private Boolean deferred = Boolean.FALSE;
 
@@ -84,12 +87,6 @@ public class UserNotification implements PersistableEntity<Long> {
     @Column(name = "TOOL", length = 99)
     private String tool;
 
-    @Transient
-    private String fromDisplayName;
-
-    @Transient
-    private String formattedEventDate;
-
-    @Transient
-    private String siteTitle;
+    @Column(name = "BROADCAST")
+    private Boolean broadcast = Boolean.FALSE;
 }

kernel/api/src/main/java/org/sakaiproject/messaging/api/model/UserNotification.java

@@ -24,7 +24,9 @@
 public interface UserNotificationRepository extends SpringCrudRepository<UserNotification, Long> {
 
     List<UserNotification> findByToUser(String toUser);
+    List<UserNotification> findByBroadcast(boolean broadcast);
     int deleteByToUserAndDeferred(String userId, boolean deferred);
+    int deleteExpiredNotifications();
     int setAllNotificationsViewed(String userId, String siteId, String toolId);
     int setDeferredBySiteId(String siteId, boolean deferred);
 }