Merge branch 'xwikisas:master' into issue#206

Author: KebabRonin

README.md

@@ -6,7 +6,7 @@ Manage and enforce application licenses for paid extensions
 * [Documentation & Download](http://store.xwiki.com/xwiki/bin/view/Extension/Licensing+Application)
 * [JIRA Issue Tracker](https://github.com/xwikisas/application-licensing/issues)
 * [Development Practices](http://dev.xwiki.org/xwiki/bin/view/Community/DevelopmentPractices)
-* Minimal XWiki version supported: XWiki 14.10
+* Minimal XWiki version supported: XWiki 15.10
 * License: LGPL 2.1
 * Translations: N/A 
 * Sonar Dashboard: N/A 

application-licensing-common/application-licensing-common-api/pom.xml

@@ -25,7 +25,7 @@
   <parent>
     <artifactId>application-licensing-common</artifactId>
     <groupId>com.xwiki.licensing</groupId>
-    <version>1.30.2-SNAPSHOT</version>
+    <version>1.32.1-SNAPSHOT</version>
   </parent>
   <artifactId>application-licensing-common-api</artifactId>
   <name>Licensing Application - Common - API</name>

application-licensing-common/application-licensing-common-api/src/main/java/com/xwiki/licensing/License.java

@@ -51,6 +51,11 @@ public class License implements Comparable<License>
      */
     public static final String LICENSEE_EMAIL = "email";
 
+    /**
+     * The key used to store the licensee issue date.
+     */
+    public static final String LICENSE_ISSUE_DATE = "issueDate";
+
     /**
      * An empty constant object used when you need to explicitly assign no license.
      */
@@ -267,7 +272,7 @@ public Map<String, String> getLicensee()
     }
 
     /**
-     * Set licensee informations.
+     * Set licensee information.
      *
      * @param licensee a map of licensee information to be assigned.
      */
@@ -326,6 +331,24 @@ public static License getOptimumLicense(License license1, License license2)
             return license1;
         }
 
+        boolean license1HasIssueDate = license1.getLicensee().containsKey(LICENSE_ISSUE_DATE);
+        boolean license2HasIssueDate = license2.getLicensee().containsKey(LICENSE_ISSUE_DATE);
+
+        if (license1HasIssueDate && !license2HasIssueDate) {
+            return license1;
+        }
+
+        if (!license1HasIssueDate && license2HasIssueDate) {
+            return license2;
+        }
+
+        if (license1HasIssueDate && license2HasIssueDate) {
+            long license1IssueDate = Long.parseLong(license1.getLicensee().get(LICENSE_ISSUE_DATE));
+            long license2IssueDate = Long.parseLong(license2.getLicensee().get(LICENSE_ISSUE_DATE));
+
+            return license1IssueDate > license2IssueDate ? license1 : license2;
+        }
+
         if (license1.getExpirationDate() != license2.getExpirationDate()) {
             return (license1.getExpirationDate() >= license2.getExpirationDate()) ? license1 : license2;
         }
@@ -402,7 +425,7 @@ public int compareTo(License o)
         return getId().compareTo(getId());
     }
 
-    private static class CollectionEqualsBuilder extends EqualsBuilder
+    private static final class CollectionEqualsBuilder extends EqualsBuilder
     {
         @Override
         public EqualsBuilder append(Object lhs, Object rhs)

application-licensing-common/application-licensing-common-api/src/test/java/com/xwiki/licensing/LicenseTest.java

@@ -21,6 +21,8 @@
 
 import java.util.Collections;
 import java.util.Date;
+import java.util.HashMap;
+import java.util.Map;
 
 import org.junit.Before;
 import org.junit.Test;
@@ -150,6 +152,40 @@ public void getOptimumLicense()
         assertSame(bob, License.getOptimumLicense(bob, alice));
     }
 
+    /**
+     * The returned license is the one with the latest issue date, even if it has an earlier expiration date. If the
+     * issue date is not available, then the returned license is the one with the latest expiration date.
+     */
+    @Test
+    public void getOptimumLicenseBasedOnIssuedDate()
+    {
+        License alice = new License();
+        alice.setExpirationDate(4L);
+
+        License bob = new License();
+        bob.setExpirationDate(6L);
+
+        assertSame(bob, License.getOptimumLicense(alice, bob));
+        assertSame(bob, License.getOptimumLicense(bob, alice));
+
+        Map<String, String> aliceLicensee = new HashMap<>();
+        aliceLicensee.put("issueDate", "1000");
+        alice.setLicensee(aliceLicensee);
+
+        assertSame(alice, License.getOptimumLicense(alice, bob));
+        assertSame(alice, License.getOptimumLicense(bob, alice));
+
+        alice.setExpirationDate(6L);
+        bob.setExpirationDate(4L);
+
+        Map<String, String> bobLicensee = new HashMap<>();
+        bobLicensee.put("issueDate", "2000");
+        bob.setLicensee(bobLicensee);
+
+        assertSame(bob, License.getOptimumLicense(alice, bob));
+        assertSame(bob, License.getOptimumLicense(bob, alice));
+    }
+
     private License getSignedLicense(License license, String content)
     {
         when(this.signedDataVerified.getContent()).thenReturn(content.getBytes());

application-licensing-common/application-licensing-common-model/pom.xml

@@ -25,7 +25,7 @@
   <parent>
     <artifactId>application-licensing-common</artifactId>
     <groupId>com.xwiki.licensing</groupId>
-    <version>1.30.2-SNAPSHOT</version>
+    <version>1.32.1-SNAPSHOT</version>
   </parent>
   <artifactId>application-licensing-common-model</artifactId>
   <name>Licensing Application - Common - Model</name>
@@ -48,14 +48,13 @@
   <build>
     <plugins>
       <plugin>
-        <groupId>org.jvnet.jaxb2.maven2</groupId>
-        <artifactId>maven-jaxb2-plugin</artifactId>
+        <groupId>org.jvnet.jaxb</groupId>
+        <artifactId>jaxb-maven-plugin</artifactId>
         <configuration>
           <generatePackage>com.xwiki.licensing.model.jaxb</generatePackage>
         </configuration>
         <executions>
           <execution>
-            <id>generate</id>
             <goals>
               <goal>generate</goal>
             </goals>

application-licensing-common/pom.xml

@@ -25,7 +25,7 @@
   <parent>
     <artifactId>application-licensing</artifactId>
     <groupId>com.xwiki.licensing</groupId>
-    <version>1.30.2-SNAPSHOT</version>
+    <version>1.32.1-SNAPSHOT</version>
   </parent>
   <artifactId>application-licensing-common</artifactId>
   <packaging>pom</packaging>

application-licensing-licensor/application-licensing-licensor-api/pom.xml

@@ -24,7 +24,7 @@
   <parent>
     <artifactId>application-licensing-licensor</artifactId>
     <groupId>com.xwiki.licensing</groupId>
-    <version>1.30.2-SNAPSHOT</version>
+    <version>1.32.1-SNAPSHOT</version>
   </parent>
   <modelVersion>4.0.0</modelVersion>
   <artifactId>application-licensing-licensor-api</artifactId>

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

@@ -52,10 +52,10 @@ public interface LicenseManager
     /**
      * Add a new license to the current set of active license. The added license is checked to be applicable to the
      * current wiki instance, else it will not be added. The license is also checked to be more interesting than the
-     * currently installed licenses. If the license does not provides any improvement of the licensing state of this
-     * wiki, it will not be added. This check does not reject unsigned license, but give immediate priority to signed
+     * currently installed licenses. If the license does not provide any improvement of the licensing state of this
+     * wiki, it will not be added. This check does not reject unsigned license, but gives immediate priority to signed
      * ones over unsigned ones, even if the signed license has narrower constraints. These evaluations are done for
-     * each licensed extension independently, whether these extension are currently installed or not.
+     * each licensed extension independently, whether these extensions are currently installed or not.
      *
      * @param license a license to be added (could be signed or not, unsigned will be stored but not really applied)
      * @return true if the license has been actually added (see above).

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

@@ -30,7 +30,7 @@
 public interface LicenseValidator
 {
     /**
-     * A LicenseValidator that always reply false. Used when the license validator received is not pristine.
+     * A LicenseValidator that always returns false. Used when the license validator received is not pristine.
      */
     LicenseValidator INVALIDATOR = new LicenseValidator() {
         @Override
@@ -69,7 +69,7 @@ public boolean isValid(License license)
     boolean isSigned(License license);
 
     /**
-     * Check if a license is valid, its constrains are respected.
+     * Check if a license is valid, its constraints are respected.
      * The instance constraint is NOT checked, see {@link #isApplicable(License)}
      *
      * @param license the license to be checked.

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;
+    }
 }