Add configuration for who should get licensing notifications #208 (#216)

* added LicensingNotificationConfigurationSource for managing notification settings
* added notifiedGroups property to LicensingNotificationClass for user group notifications
* updated LicensingConfig.xml and Translations files for new notification settings
* added a notification groups section to the end of the licensing admin section
* added script service for getting the notification groups list
* added tests
* removed admin and programming rights restriction for notifications
* modified notification message for non admin/programming users

Author: ChiuchiuSorin

application-licensing-licensor/application-licensing-licensor-api/src/main/java/com/xwiki/licensing/LicensingConfiguration.java

@@ -20,9 +20,13 @@
 package com.xwiki.licensing;
 
 import java.io.File;
+import java.util.ArrayList;
+import java.util.HashSet;
 import java.util.List;
+import java.util.Set;
 
 import org.xwiki.component.annotation.Role;
+import org.xwiki.stability.Unstable;
 
 /**
  * Configuration of the licensing module.
@@ -80,4 +84,35 @@ public interface LicensingConfiguration
      * @return the email of the licensing owner or null if the value of the property is not filled up
      */
     String getLicensingOwnerEmail();
+
+    /**
+     * @return {@link List} with the groups whose members need to be notified about the extension
+     * @since 1.31
+     */
+    @Unstable
+    default List<String> getNotifiedGroups()
+    {
+        return new ArrayList<>();
+    }
+
+    /**
+     * @return {@link Set} with the groups whose members need to be notified about the extension
+     * @since 1.31
+     */
+    @Unstable
+    default Set<String> getNotifiedGroupsSet()
+    {
+        return new HashSet<>();
+    }
+
+    /**
+     * @return {@code true} if the context user is member of the groups from {@link  #getNotifiedGroups}, or
+     *     {@code false} otherwise
+     * @since 1.31
+     */
+    @Unstable
+    default boolean isMemberOfNotifiedGroups()
+    {
+        return false;
+    }
 }

application-licensing-licensor/application-licensing-licensor-api/src/main/java/com/xwiki/licensing/internal/DefaultLicensingConfiguration.java

@@ -20,9 +20,11 @@
 package com.xwiki.licensing.internal;
 
 import java.io.File;
+import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 import java.util.Objects;
+import java.util.Set;
 import java.util.stream.Collectors;
 
 import javax.inject.Inject;
@@ -33,8 +35,13 @@
 import org.xwiki.component.annotation.Component;
 import org.xwiki.configuration.ConfigurationSource;
 import org.xwiki.environment.Environment;
+import org.xwiki.model.reference.DocumentReference;
+import org.xwiki.model.reference.DocumentReferenceResolver;
 
+import com.xpn.xwiki.XWiki;
+import com.xpn.xwiki.XWikiContext;
 import com.xwiki.licensing.LicensingConfiguration;
+import com.xwiki.licensing.internal.helpers.LicensingNotificationConfigurationSource;
 
 /**
  * Default implementation of {@link LicensingConfiguration}.
@@ -74,6 +81,17 @@ public class DefaultLicensingConfiguration implements LicensingConfiguration
     @Named("LicensingOwnerConfigurationSource")
     private ConfigurationSource ownerConfig;
 
+    @Inject
+    @Named(LicensingNotificationConfigurationSource.HINT)
+    private ConfigurationSource notificationConfig;
+
+    @Inject
+    @Named("current")
+    private DocumentReferenceResolver<String> referenceResolver;
+
+    @Inject
+    private Provider<XWikiContext> wikiContextProvider;
+
     private File localStorePath;
 
     @Override
@@ -137,6 +155,28 @@ public String getStoreRenewURL()
         return this.storeConfig.getProperty("storeRenewURL");
     }
 
+    @Override
+    public List<String> getNotifiedGroups()
+    {
+        return convertObjectToStringList(notificationConfig.getProperty("notifiedGroups", new ArrayList<>()));
+    }
+
+    @Override
+    public Set<String> getNotifiedGroupsSet()
+    {
+        return getNotifiedGroups().stream().map(referenceResolver::resolve).map(DocumentReference::toString)
+            .collect(Collectors.toSet());
+    }
+
+    @Override
+    public boolean isMemberOfNotifiedGroups()
+    {
+        List<String> notifiedGroups = getNotifiedGroups();
+        XWikiContext wikiContext = wikiContextProvider.get();
+        XWiki wiki = wikiContext.getWiki();
+        return notifiedGroups.stream().anyMatch(group -> wiki.getUser(wikiContext).isUserInGroup(group));
+    }
+
     @SuppressWarnings("unchecked")
     private List<String> convertObjectToStringList(Object list)
     {

application-licensing-licensor/application-licensing-licensor-api/src/main/java/com/xwiki/licensing/internal/helpers/LicensingNotificationConfigurationSource.java

@@ -0,0 +1,74 @@
+/*
+ * See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+package com.xwiki.licensing.internal.helpers;
+
+import java.util.Arrays;
+import java.util.List;
+
+import javax.inject.Named;
+import javax.inject.Singleton;
+
+import org.xwiki.component.annotation.Component;
+import org.xwiki.configuration.internal.AbstractDocumentConfigurationSource;
+import org.xwiki.model.reference.DocumentReference;
+import org.xwiki.model.reference.LocalDocumentReference;
+
+/**
+ * Configuration source for notification information.
+ *
+ * @version $Id$
+ * @since 1.31
+ */
+@Component
+@Named(LicensingNotificationConfigurationSource.HINT)
+@Singleton
+public class LicensingNotificationConfigurationSource extends AbstractDocumentConfigurationSource
+{
+    /**
+     * Component hint.
+     */
+    public static final String HINT = "LicensingNotificationConfigurationSource";
+
+    protected static final List<String> CODE_SPACE = Arrays.asList("Licenses", "Code");
+
+    protected static final LocalDocumentReference LICENSING_CONFIG_DOC =
+        new LocalDocumentReference(CODE_SPACE, "LicensingConfig");
+
+    protected static final LocalDocumentReference OWNER_CLASS =
+        new LocalDocumentReference(CODE_SPACE, "LicensingNotificationClass");
+
+    @Override
+    protected DocumentReference getDocumentReference()
+    {
+        return new DocumentReference(LICENSING_CONFIG_DOC, this.getCurrentWikiReference());
+    }
+
+    @Override
+    protected LocalDocumentReference getClassReference()
+    {
+        return OWNER_CLASS;
+    }
+
+    @Override
+    protected String getCacheId()
+    {
+        return "licensing.configuration.notification";
+    }
+}

application-licensing-licensor/application-licensing-licensor-api/src/main/java/com/xwiki/licensing/internal/upgrades/AbstractLicensorTargetableEvent.java

@@ -0,0 +1,52 @@
+/*
+ * See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+package com.xwiki.licensing.internal.upgrades;
+
+import java.util.HashSet;
+import java.util.Set;
+
+import org.xwiki.eventstream.TargetableEvent;
+
+/**
+ * Abstract class used for common elements.
+ *
+ * @version $Id$
+ * @since 1.31
+ */
+public abstract class AbstractLicensorTargetableEvent implements TargetableEvent
+{
+    private Set<String> notifiedGroups = new HashSet<>();
+
+    @Override
+    public Set<String> getTarget()
+    {
+        return notifiedGroups;
+    }
+
+    /**
+     * Set the groups that should be notified.
+     *
+     * @param notifiedGroups the notified groups.
+     */
+    public void setNotifiedGroups(Set<String> notifiedGroups)
+    {
+        this.notifiedGroups = notifiedGroups;
+    }
+}

application-licensing-licensor/application-licensing-licensor-api/src/main/java/com/xwiki/licensing/internal/upgrades/NewExtensionVersionAvailableManager.java

@@ -23,8 +23,10 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 
 import javax.inject.Inject;
+import javax.inject.Provider;
 import javax.inject.Singleton;
 
 import org.apache.commons.lang3.exception.ExceptionUtils;
@@ -34,10 +36,13 @@
 import org.xwiki.extension.InstalledExtension;
 import org.xwiki.extension.repository.InstalledExtensionRepository;
 import org.xwiki.extension.version.Version;
+import org.xwiki.model.reference.DocumentReference;
+import org.xwiki.model.reference.EntityReferenceSerializer;
 import org.xwiki.observation.ObservationManager;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.xpn.xwiki.XWikiContext;
 import com.xwiki.licensing.LicensedExtensionManager;
 import com.xwiki.licensing.LicensingConfiguration;
 import com.xwiki.licensing.internal.upgrades.notifications.newVersion.NewExtensionVersionAvailableEvent;
@@ -74,6 +79,12 @@ public class NewExtensionVersionAvailableManager
     @Inject
     private NewVersionNotificationManager newVersionNotificationManager;
 
+    @Inject
+    private EntityReferenceSerializer<String> serializer;
+
+    @Inject
+    private Provider<XWikiContext> contextProvider;
+
     /**
      * Notify the administrators when one of the installed licensed applications has a new version available. Do nothing
      * for extensions that have auto upgrades enabled.
@@ -118,9 +129,10 @@ private void notifyExtensionVersionAvailable(ExtensionId extensionId, String nam
                 extensionInfo.put("extensionName", installedExtension.getName());
                 extensionInfo.put("namespace", namespaceName);
                 extensionInfo.put("version", installableVersions.get(0).getValue());
+                Set<String> notifiedGroups = getTargetGroups();
 
                 this.observationManager.notify(new NewExtensionVersionAvailableEvent(
-                        new ExtensionId(extensionId.getId(), installableVersions.get(0)), namespace),
+                        new ExtensionId(extensionId.getId(), installableVersions.get(0)), namespace, notifiedGroups),
                     extensionId.getId(), (new ObjectMapper()).writeValueAsString(extensionInfo));
                 this.newVersionNotificationManager.markNotificationAsSent(extensionId.getId(), namespaceName,
                     installableVersions.get(0).getValue());
@@ -130,4 +142,13 @@ private void notifyExtensionVersionAvailable(ExtensionId extensionId, String nam
                 extensionId.getId(), ExceptionUtils.getRootCauseMessage(e));
         }
     }
+
+    private Set<String> getTargetGroups()
+    {
+        Set<String> notifiedGroups = licensingConfig.getNotifiedGroupsSet();
+        DocumentReference adminGroupDocument =
+            new DocumentReference(contextProvider.get().getWikiId(), "XWiki", "XWikiAdminGroup");
+        notifiedGroups.add(serializer.serialize(adminGroupDocument));
+        return notifiedGroups;
+    }
 }

application-licensing-licensor/application-licensing-licensor-api/src/main/java/com/xwiki/licensing/internal/upgrades/UpgradeExtensionHandler.java

@@ -22,6 +22,7 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
+import java.util.Set;
 
 import javax.inject.Inject;
 import javax.inject.Named;
@@ -46,17 +47,19 @@
 import org.xwiki.job.JobException;
 import org.xwiki.job.JobExecutor;
 import org.xwiki.localization.ContextualLocalizationManager;
+import org.xwiki.model.reference.DocumentReference;
 import org.xwiki.model.reference.DocumentReferenceResolver;
 import org.xwiki.model.reference.EntityReferenceSerializer;
 import org.xwiki.observation.ObservationManager;
 
+import com.xwiki.licensing.LicensingConfiguration;
 import com.xwiki.licensing.internal.upgrades.notifications.ExtensionAutoUpgradedEvent;
 import com.xwiki.licensing.internal.upgrades.notifications.ExtensionAutoUpgradedFailedEvent;
 
 /**
  * Upgrades an extension from a namespace to the last compatible version and sends a notification. The notification will
  * be displayed only for users that subscribed to it and disabled the System filter since it is send by superadmin user.
- * 
+ *
  * @version $Id$
  * @since 1.17
  */
@@ -95,9 +98,13 @@ public class UpgradeExtensionHandler
     @Inject
     private EntityReferenceSerializer<String> serializer;
 
+    @Inject
+    private LicensingConfiguration licensingConfig;
+
+
     /**
      * Try upgrading an extension inside a namespace to the last compatible version.
-     * 
+     *
      * @param installedExtension the already installed extension
      * @param namespace the namespace in which the extension is installed
      */
@@ -115,8 +122,9 @@ public void tryUpgradeExtensionToLastVersion(InstalledExtension installedExtensi
                 String doneUpgradeMessage = this.localization.getTranslationPlain(
                     "licensor.notification.autoUpgrade.done", installedExtension.getName(),
                     installedExtensionId.getVersion().getValue(), toInstallExtensionId.getVersion().getValue());
-
-                this.observationManager.notify(new ExtensionAutoUpgradedEvent(), LICENSOR_API_ID, doneUpgradeMessage);
+                Set<String> notifiedGroups = getTargetGroups();
+                this.observationManager.notify(new ExtensionAutoUpgradedEvent(notifiedGroups), LICENSOR_API_ID,
+                    doneUpgradeMessage);
 
                 // If the execution gets here, it means that the upgrade was done.
                 break;
@@ -131,9 +139,18 @@ public void tryUpgradeExtensionToLastVersion(InstalledExtension installedExtensi
         }
     }
 
+    private Set<String> getTargetGroups()
+    {
+        Set<String> notifiedGroups = licensingConfig.getNotifiedGroupsSet();
+        DocumentReference adminGroupDoc = currentDocumentReferenceResolver.resolve("XWiki.XWikiAdminGroup");
+        String adminGroup = serializer.serialize(adminGroupDoc);
+        notifiedGroups.add(adminGroup);
+        return notifiedGroups;
+    }
+
     /**
      * Install the given extension inside a namespace.
-     * 
+     *
      * @param extensionId extension to install
      * @param namespace namespace where the install is done
      * @throws JobException error at job execution
@@ -183,7 +200,7 @@ protected InstallRequest getInstallRequest(ExtensionId extensionId, String names
 
     /**
      * Get the reversed list of versions that can be installed, considering the already installed version.
-     * 
+     *
      * @param extensionId ExtensionId of the application that is needed
      * @return reversed list of versions until the already installed one
      */