Examples with NotificationFilter org.xwiki.notifications.filters.NotificationFilter used on opensource projects

Example 1 with NotificationFilter

use of org.xwiki.notifications.filters.NotificationFilter in project xwiki-platform by xwiki.

the class QueryGenerator method handleEventPreferences.

/**
 * For each notification preference of the given user, add a constraint on the events to
 * - have one of the notification types that have been subscribed by the user;
 * - have a date superior to the start date corresponding to this type;
 * - match the custom defined user filters.
 *
 * @param user the current user
 * @param preferences a list of the user preferences
 * @return a list of maps that contains query parameters
 * @throws NotificationException if an error occurred
 */
private AbstractOperatorNode handleEventPreferences(DocumentReference user, List<NotificationPreference> preferences) throws NotificationException {
    AbstractOperatorNode preferencesNode = null;
    // Filter the notification preferences that are not bound to a specific EVENT_TYPE
    Iterator<NotificationPreference> it = preferences.stream().filter(pref -> pref.getProperties().containsKey(NotificationPreferenceProperty.EVENT_TYPE)).iterator();
    while (it.hasNext()) {
        NotificationPreference preference = it.next();
        AbstractOperatorNode preferenceTypeNode = new AndNode(new EqualsNode(value(EventProperty.TYPE), value((String) preference.getProperties().get(NotificationPreferenceProperty.EVENT_TYPE))), new GreaterThanNode(value(EventProperty.DATE), value(preference.getStartDate())));
        // Get the notification filters that can be applied to the current preference
        Collection<NotificationFilter> filters = notificationFilterManager.getFilters(user, preference);
        for (NotificationFilter filter : filters) {
            ExpressionNode node = filter.filterExpression(user, preference);
            if (node != null && node instanceof AbstractOperatorNode) {
                preferenceTypeNode = preferenceTypeNode.and((AbstractOperatorNode) node);
            }
        }
        if (preferencesNode == null) {
            preferencesNode = preferenceTypeNode;
        } else {
            preferencesNode = preferencesNode.or(preferenceTypeNode);
        }
    }
    return preferencesNode;
}

Example 2 with NotificationFilter

use of org.xwiki.notifications.filters.NotificationFilter in project xwiki-platform by xwiki.

the class QueryGeneratorTest method generateQueryWithNoRelevantFilters.

@Test
public void generateQueryWithNoRelevantFilters() throws Exception {
    // Mocks
    NotificationFilter notificationFilter1 = mock(NotificationFilter.class);
    when(notificationFilterManager.getFilters(any(DocumentReference.class), any(NotificationPreference.class))).thenReturn(Collections.singleton(notificationFilter1));
    when(notificationFilter1.filterExpression(any(DocumentReference.class), any(NotificationPreference.class))).thenReturn(new EmptyNode());
    when(notificationFilter1.matchesPreference(any(NotificationPreference.class))).thenReturn(true);
    // Test
    ExpressionNode node = mocker.getComponentUnderTest().generateQueryExpression(new DocumentReference("xwiki", "XWiki", "UserA"), NotificationFormat.ALERT, null, startDate, Arrays.asList("event1", "event2"));
    assertEquals("(((DATE >= \"Thu Jan 01 01:00:00 CET 1970\" " + "AND (TYPE = \"create\" AND DATE >= \"Fri Jan 02 04:46:40 CET 1970\")) " + "AND NOT (ID IN (\"event1\", \"event2\"))) " + "AND HIDDEN <> true) " + "ORDER BY DATE DESC", node.toString());
}

Example 3 with NotificationFilter

use of org.xwiki.notifications.filters.NotificationFilter in project xwiki-platform by xwiki.

the class QueryGeneratorTest method generateQueryWithFilters.

@Test
public void generateQueryWithFilters() throws Exception {
    // Mocks
    NotificationFilter notificationFilter1 = mock(NotificationFilter.class);
    NotificationFilter notificationFilter2 = mock(NotificationFilter.class);
    when(notificationFilterManager.getFilters(any(DocumentReference.class), any(NotificationPreference.class))).thenReturn(Sets.newSet(notificationFilter1, notificationFilter2));
    when(notificationFilter1.filterExpression(any(DocumentReference.class), any(NotificationPreference.class))).thenReturn(new AndNode(new EqualsNode(new PropertyValueNode(EventProperty.PAGE), new StringValueNode("someValue1")), new EqualsNode(new StringValueNode("1"), new StringValueNode("1"))));
    when(notificationFilter2.filterExpression(any(DocumentReference.class), any(NotificationPreference.class))).thenReturn(new AndNode(new EqualsNode(new PropertyValueNode(EventProperty.TYPE), new StringValueNode("someValue2")), new EqualsNode(new StringValueNode("2"), new StringValueNode("2"))));
    when(notificationFilter1.matchesPreference(any(NotificationPreference.class))).thenReturn(true);
    when(notificationFilter2.matchesPreference(any(NotificationPreference.class))).thenReturn(true);
    // Test
    ExpressionNode node = mocker.getComponentUnderTest().generateQueryExpression(new DocumentReference("xwiki", "XWiki", "UserA"), NotificationFormat.ALERT, null, startDate, Arrays.asList("event1", "event2"));
    assertEquals("(((DATE >= \"Thu Jan 01 01:00:00 CET 1970\" " + "AND (((TYPE = \"create\" AND DATE >= \"Fri Jan 02 04:46:40 CET 1970\") " + "AND (PAGE = \"someValue1\" AND \"1\" = \"1\")) " + "AND (TYPE = \"someValue2\" AND \"2\" = \"2\"))) " + "AND NOT (ID IN (\"event1\", \"event2\"))) " + "AND HIDDEN <> true) " + "ORDER BY DATE DESC", node.toString());
}

Example 4 with NotificationFilter

use of org.xwiki.notifications.filters.NotificationFilter in project xwiki-platform by xwiki.

the class DefaultNotificationManager method filterEvent.

private boolean filterEvent(Event event, Parameters parameters) throws NotificationException {
    // Don't record events that have a target that don't include the current user
    if (!event.getTarget().isEmpty() && !event.getTarget().contains(parameters.userId)) {
        return true;
    }
    List<NotificationFilter> filters = new ArrayList<>(notificationFilterManager.getAllFilters(parameters.userReference));
    Collections.sort(filters);
    for (NotificationFilter filter : filters) {
        NotificationFilter.FilterPolicy policy = filter.filterEvent(event, parameters.userReference, parameters.format);
        switch(policy) {
            case FILTER:
                return true;
            case KEEP:
                return false;
            default:
        }
    }
    return false;
}

Example 5 with NotificationFilter

use of org.xwiki.notifications.filters.NotificationFilter in project xwiki-platform by xwiki.

the class DefaultNotificationFilterManager method fetchAllFilters.

/**
 * Fetches every filter available to the user, without taking care of whether the filter is disabled by the user
 * or not.
 *
 * @param user the user to use
 * @return a set of filters
 * @throws NotificationException if an error occurs
 */
private Set<NotificationFilter> fetchAllFilters(DocumentReference user) throws NotificationException {
    // If the user is from the main wiki, get filters from all wikis
    if (user.getWikiReference().getName().equals(wikiDescriptorManager.getMainWikiId())) {
        String currentWikiId = wikiDescriptorManager.getCurrentWikiId();
        Map<String, NotificationFilter> filters = new HashMap<>();
        try {
            for (String wikiId : wikiDescriptorManager.getAllIds()) {
                modelContext.setCurrentEntityReference(new WikiReference(wikiId));
                filters.putAll(componentManager.getInstanceMap(NotificationFilter.class));
            }
        } catch (Exception e) {
            throw new NotificationException(ERROR_MESSAGE, e);
        } finally {
            modelContext.setCurrentEntityReference(new WikiReference(currentWikiId));
        }
        return new HashSet<>(filters.values());
    } else {
        // If the user is local, get filters from the current wiki only (we assume it's the wiki of the user).
        try {
            return new HashSet<>(componentManager.getInstanceList(NotificationFilter.class));
        } catch (Exception e) {
            throw new NotificationException(ERROR_MESSAGE, e);
        }
    }
}