XWIKI-14597: Add UI for "Location" and "Global Notification Preferences"

in the Notification Center
* Add javadoc

xwiki-platform-core/xwiki-platform-notifications/xwiki-platform-notifications-filters/xwiki-platform-notifications-filters-api/src/main/java/org/xwiki/notifications/filters/NotificationFilter.java

@@ -29,6 +29,12 @@
 
 /**
  * Enable or disable notifications from the event stream (for customization purpose).
+ * A {@link NotificationFilter} has two goals :
+ * <ul>
+ *     <li>Pre-Filtering : Generate a query (made with {@link AbstractNode}) that will be used to retrieve a specific
+ *     subset of notifications from a provider.</li>
+ *     <li>Post-Filtering : given an {@link Event}, determine if this event should be filtered or not.</li>
+ * </ul>
  *
  * @version $Id$
  * @since 9.5RC1
@@ -39,7 +45,7 @@ public interface NotificationFilter
 {
     /**
      * Enable or disable an event in the notification list (post-filter).
-     *
+     *For a given {@link NotificationPreference}, generate a filter associated with this preference
      * @param event an event
      * @param user the user interested in the notification
      * @param format format of the notification
@@ -82,6 +88,10 @@ public interface NotificationFilter
     AbstractNode filterExpression(DocumentReference user);
 
     /**
+     * Get the name of the filter. This is useful as {@link NotificationFilterPreference} will be able to be linked to
+     * this filter using its name. If the {@link NotificationFilter} is used as a component, consider defining
+     * the hint of this component as the name of the filter.
+     *
      * @return the name of the filter
      *
      * @since 9.7RC1

xwiki-platform-core/xwiki-platform-notifications/xwiki-platform-notifications-filters/xwiki-platform-notifications-filters-api/src/main/java/org/xwiki/notifications/filters/internal/ScopeNotificationFilter.java

@@ -194,6 +194,10 @@ public String getName()
      * Given a {@link NotificationFilterPreference} and the current filtering context (defined by a
      * {@link NotificationPreference}), determine if a the current filter should apply with the given scope.
      *
+     * Note that we allow the {@link NotificationPreference} to be null and the
+     * {@link NotificationFilterPreference} to have an empty {@link NotificationPreferenceProperty#EVENT_TYPE} property.
+     * This is done to allow the filter to be applied globally and match all events.
+     *
      * @param filterPreference the reference scope
      * @param preference the related notification preference, can be null
      * @return true if the filter should be applied to the given scope.
@@ -201,15 +205,14 @@ public String getName()
     private boolean scopeMatchesFilteringContext(NotificationFilterPreference filterPreference,
             NotificationPreference preference)
     {
-        return ((preference == null
-                    || preference.getProperties().containsKey(NotificationPreferenceProperty.EVENT_TYPE))
-                && (filterPreference.getProperties(NotificationFilterProperty.EVENT_TYPE).isEmpty()
-                    || filterPreference.getProperties(NotificationFilterProperty.EVENT_TYPE).contains(
+        return ((preference == null && filterPreference.getProperties(NotificationFilterProperty.EVENT_TYPE).isEmpty())
+                || (preference.getProperties().containsKey(NotificationPreferenceProperty.EVENT_TYPE)
+                    && filterPreference.getProperties(NotificationFilterProperty.EVENT_TYPE).contains(
                             preference.getProperties().get(NotificationPreferenceProperty.EVENT_TYPE))));
     }
 
     /**
-     * Given {@link ScopeNotificationFilterPreference}, generate the associated node restriction.
+     * Given {@link ScopeNotificationFilterPreference}, generate the associated scope restriction.
      *
      * @param filterPreferenceScope the preference to use
      * @return the generated node

xwiki-platform-core/xwiki-platform-notifications/xwiki-platform-notifications-filters/xwiki-platform-notifications-filters-api/src/main/java/org/xwiki/notifications/filters/internal/SystemUserNotificationFilter.java

@@ -41,6 +41,8 @@
  * Define notification filters that are activated by default on every user and that filter the notifications
  * coming from the system user.
  *
+ * This filter is not bound to any {@link NotificationPreference} and should be applied globally.
+ *
  * @version $Id$
  * @since 9.7RC1
  */
@@ -80,7 +82,7 @@ protected boolean filterEventByFilterType(Event event, DocumentReference user, N
     protected AbstractNode generateFilterExpression(DocumentReference user, NotificationPreference preference,
             NotificationFilterType filterType)
     {
-        if (filterType.equals(NotificationFilterType.EXCLUSIVE)) {
+        if (preference == null && filterType.equals(NotificationFilterType.EXCLUSIVE)) {
             return new NotEqualsNode(
                     new PropertyValueNode(NotificationFilterProperty.USER),
                     new StringValueNode(serializer.serialize(systemUser)));
@@ -92,7 +94,8 @@ protected AbstractNode generateFilterExpression(DocumentReference user, Notifica
     @Override
     public boolean matchesPreference(NotificationPreference preference)
     {
-        return true;
+        // As the filter is applied globally, it’s not bound to any preference
+        return false;
     }
 
     @Override

xwiki-platform-core/xwiki-platform-notifications/xwiki-platform-notifications-filters/xwiki-platform-notifications-filters-api/src/test/java/org/xwiki/notifications/filters/internal/SystemUserNotificationFilterTest.java

@@ -99,13 +99,13 @@ public void generateFilterExpression() throws Exception
                 new PropertyValueNode(NotificationFilterProperty.USER),
                 new StringValueNode("serializedSystemUser")),
                 mocker.getComponentUnderTest().generateFilterExpression(
-                        randomUser, fakePreference, NotificationFilterType.EXCLUSIVE));
+                        randomUser, null, NotificationFilterType.EXCLUSIVE));
     }
 
     @Test
     public void matchesPreference() throws Exception
     {
-        assertTrue(mocker.getComponentUnderTest().matchesPreference(mock(NotificationPreference.class)));
+        assertFalse(mocker.getComponentUnderTest().matchesPreference(mock(NotificationPreference.class)));
     }
 
     @Test

xwiki-platform-core/xwiki-platform-notifications/xwiki-platform-notifications-sources/src/main/java/org/xwiki/notifications/sources/internal/QueryGenerator.java

@@ -167,6 +167,16 @@ public Query generateQuery(DocumentReference user, NotificationFormat format, bo
         return query;
     }
 
+    /**
+     * Generate a part of the query using each of the {@link NotificationFilter} retrieved from the
+     * {@link NotificationFilterManager}. Each {@link NotificationFilter} is called without any associated
+     * {@link NotificationPreference}.
+     *
+     * @param user the user used to retrieve the {@link NotificationFilter}
+     * @param hql the {@link StringBuilder} used for the query
+     * @return a list of maps of parameters that should be used for the query
+     * @throws NotificationException
+     */
     private List<Map<String, String>> handleGlobalFilters(DocumentReference user, StringBuilder hql)
             throws NotificationException
     {