install plugins in the right order

scm-webapp/src/main/java/sonia/scm/plugin/ExplodedSmp.java

@@ -0,0 +1,257 @@
+/**
+ * Copyright (c) 2010, Sebastian Sdorra All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer. 2. Redistributions in
+ * binary form must reproduce the above copyright notice, this list of
+ * conditions and the following disclaimer in the documentation and/or other
+ * materials provided with the distribution. 3. Neither the name of SCM-Manager;
+ * nor the names of its contributors may be used to endorse or promote products
+ * derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * http://bitbucket.org/sdorra/scm-manager
+ *
+ */
+
+
+
+package sonia.scm.plugin;
+
+//~--- non-JDK imports --------------------------------------------------------
+
+import com.google.common.base.Function;
+import com.google.common.collect.Multimap;
+
+import sonia.scm.util.Util;
+import sonia.scm.util.XmlUtil;
+
+//~--- JDK imports ------------------------------------------------------------
+
+import java.io.IOException;
+import java.io.InputStream;
+
+import java.nio.file.Files;
+import java.nio.file.Path;
+
+import java.util.Collection;
+
+/**
+ *
+ * @author Sebastian Sdorra
+ */
+public final class ExplodedSmp implements Comparable<ExplodedSmp>
+{
+
+  //~--- constructors ---------------------------------------------------------
+
+  /**
+   * Constructs ...
+   *
+   *
+   * @param path
+   * @param pluginId
+   * @param dependencies
+   */
+  ExplodedSmp(Path path, PluginId pluginId, Collection<String> dependencies)
+  {
+    this.path = path;
+    this.pluginId = pluginId;
+    this.dependencies = dependencies;
+  }
+
+  //~--- methods --------------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   * @param directory
+   *
+   * @return
+   *
+   * @throws IOException
+   */
+  public static ExplodedSmp create(Path directory) throws IOException
+  {
+    ExplodedSmp smp;
+
+    Path descriptor = directory.resolve(PluginConstants.FILE_DESCRIPTOR);
+
+    try (InputStream in = Files.newInputStream(descriptor))
+    {
+      //J-
+      Multimap<String,String> values = XmlUtil.values(in,
+        PluginConstants.EL_GROUPID,
+        PluginConstants.EL_ARTIFACTID, 
+        PluginConstants.EL_VERSION, 
+        PluginConstants.EL_DEPENDENCY
+      );
+      
+      PluginId pluginId = new PluginId(
+        Util.getFirst(values, PluginConstants.EL_GROUPID),
+        Util.getFirst(values, PluginConstants.EL_ARTIFACTID),
+        Util.getFirst(values, PluginConstants.EL_VERSION)
+      );
+      
+      smp = new ExplodedSmp(
+        directory, 
+        pluginId, 
+        values.get(PluginConstants.EL_DEPENDENCY)
+      );
+      //J+
+    }
+
+    return smp;
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @param o
+   *
+   * @return
+   */
+  @Override
+  public int compareTo(ExplodedSmp o)
+  {
+    int result;
+
+    if (dependencies.isEmpty() && o.dependencies.isEmpty())
+    {
+      result = 0;
+    }
+    else if (dependencies.isEmpty() &&!o.dependencies.isEmpty())
+    {
+      result = -1;
+    }
+    else if (!dependencies.isEmpty() && o.dependencies.isEmpty())
+    {
+      result = 1;
+    }
+    else
+    {
+      String id = pluginId.getIdWithoutVersion();
+      String oid = o.pluginId.getIdWithoutVersion();
+
+      if (dependencies.contains(oid) && o.dependencies.contains(id))
+      {
+        StringBuilder b = new StringBuilder("circular dependency detected: ");
+
+        b.append(id).append(" depends on ").append(oid).append(" and ");
+        b.append(oid).append(" depends on ").append(id);
+
+        throw new PluginCircularDependencyException(b.toString());
+      }
+      else if (dependencies.contains(oid))
+      {
+        result = 999;
+      }
+      else if (o.dependencies.contains(id))
+      {
+        result = -999;
+      }
+      else
+      {
+        result = 0;
+      }
+    }
+
+    return result;
+  }
+
+  //~--- get methods ----------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  public Collection<String> getDependencies()
+  {
+    return dependencies;
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  public Path getPath()
+  {
+    return path;
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  public PluginId getPluginId()
+  {
+    return pluginId;
+  }
+
+  //~--- inner classes --------------------------------------------------------
+
+  /**
+   * Class description
+   *
+   *
+   * @version        Enter version here..., 14/07/12
+   * @author         Enter your name here...
+   */
+  public static class PathTransformer implements Function<Path, ExplodedSmp>
+  {
+
+    /**
+     * Method description
+     *
+     *
+     * @param directory
+     *
+     * @return
+     */
+    @Override
+    public ExplodedSmp apply(Path directory)
+    {
+      try
+      {
+        return ExplodedSmp.create(directory);
+      }
+      catch (IOException ex)
+      {
+        throw new PluginException("could not create ExplodedSmp", ex);
+      }
+    }
+  }
+
+
+  //~--- fields ---------------------------------------------------------------
+
+  /** Field description */
+  private final Collection<String> dependencies;
+
+  /** Field description */
+  private final Path path;
+
+  /** Field description */
+  private final PluginId pluginId;
+}

scm-webapp/src/main/java/sonia/scm/plugin/PluginProcessor.java

@@ -33,14 +33,19 @@ package sonia.scm.plugin;
 
 //~--- non-JDK imports --------------------------------------------------------
 
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableList.Builder;
 import com.google.common.collect.ImmutableSet;
-import com.google.common.collect.ImmutableSet.Builder;
+import com.google.common.collect.Lists;
+import com.google.common.collect.Ordering;
 import com.google.common.collect.Sets;
 import com.google.common.hash.Hashing;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import sonia.scm.plugin.ExplodedSmp.PathTransformer;
+
 //~--- JDK imports ------------------------------------------------------------
 
 import java.io.File;
@@ -67,6 +72,8 @@ import javax.xml.bind.JAXBException;
 /**
  *
  * @author Sebastian Sdorra
+ *
+ * TODO don't mix nio and io
  */
 public final class PluginProcessor
 {
@@ -93,8 +100,7 @@ public final class PluginProcessor
   private static final String EXTENSION_PLUGIN = ".smp";
 
   /** Field description */
-  private static final String FILE_DESCRIPTOR =
-    SmpArchive.PATH_DESCRIPTOR.substring(1);
+  private static final String FORMAT_DATE = "yyyy-MM-dd";
 
   /** Field description */
   private static final String GLOB_JAR = "*.jar";
@@ -242,15 +248,18 @@ public final class PluginProcessor
 
     extract(archives);
 
-    Set<Path> directories = collectPluginDirectories(pluginDirectory);
+    List<Path> dirs = collectPluginDirectories(pluginDirectory);
 
     if (logger.isDebugEnabled())
     {
-      logger.debug("process {} directories", directories.size());
+      logger.debug("process {} directories", dirs.size());
     }
 
+    List<ExplodedSmp> smps = Lists.transform(dirs, new PathTransformer());
+    Iterable<ExplodedSmp> smpOrdered = Ordering.natural().sortedCopy(smps);
+
     Set<PluginWrapper> pluginWrappers = createPluginWrappers(classLoader,
-                                          directories);
+                                          smpOrdered);
 
     if (logger.isDebugEnabled())
     {
@@ -294,9 +303,9 @@ public final class PluginProcessor
    *
    * @throws IOException
    */
-  private Set<Path> collectPluginDirectories(Path directory) throws IOException
+  private List<Path> collectPluginDirectories(Path directory) throws IOException
   {
-    Builder<Path> paths = ImmutableSet.builder();
+    Builder<Path> paths = ImmutableList.builder();
 
     Filter<Path> filter = new DirectoryFilter();
 
@@ -322,7 +331,7 @@ public final class PluginProcessor
    */
   private String createDate()
   {
-    return new SimpleDateFormat("yyyy-MM-dd").format(new Date());
+    return new SimpleDateFormat(FORMAT_DATE).format(new Date());
   }
 
   /**
@@ -373,7 +382,7 @@ public final class PluginProcessor
     throws IOException
   {
     PluginWrapper wrapper = null;
-    Path descriptor = directory.resolve(FILE_DESCRIPTOR);
+    Path descriptor = directory.resolve(PluginConstants.FILE_DESCRIPTOR);
 
     if (Files.exists(descriptor))
     {
@@ -397,21 +406,21 @@ public final class PluginProcessor
    *
    *
    * @param classLoader
-   * @param directories
+   * @param smps
    *
    * @return
    *
    * @throws IOException
    */
   private Set<PluginWrapper> createPluginWrappers(ClassLoader classLoader,
-    Iterable<Path> directories)
+    Iterable<ExplodedSmp> smps)
     throws IOException
   {
     Set<PluginWrapper> plugins = Sets.newHashSet();
 
-    for (Path directory : directories)
+    for (ExplodedSmp smp : smps)
     {
-      PluginWrapper plugin = createPluginWrapper(classLoader, directory);
+      PluginWrapper plugin = createPluginWrapper(classLoader, smp.getPath());
 
       if (plugin != null)
       {
@@ -444,7 +453,7 @@ public final class PluginProcessor
 
       logger.debug("extract plugin {}", smp.getPluginId());
 
-      File directory = Plugins.createPluginDirectory(archiveFile,
+      File directory = Plugins.createPluginDirectory(pluginDirectory.toFile(),
                          smp.getPluginId());
 
       String checksum = com.google.common.io.Files.hash(archiveFile,
@@ -532,7 +541,8 @@ public final class PluginProcessor
     @Override
     public boolean accept(Path entry) throws IOException
     {
-      return Files.isDirectory(entry) &&!entry.getFileName().startsWith(".");
+      return Files.isDirectory(entry)
+        &&!entry.getFileName().toString().startsWith(".");
     }
   }
 

scm-webapp/src/main/java/sonia/scm/plugin/Plugins.java

@@ -28,6 +28,7 @@
  */
 
 
+
 package sonia.scm.plugin;
 
 //~--- non-JDK imports --------------------------------------------------------
@@ -107,11 +108,6 @@ public final class Plugins
     return new File(new File(parent, id.getGroupId()), id.getArtifactId());
   }
 
-    /** Field description */
-  private static final String FILE_CHECKSUM = "checksum";
-
-  
-  
   /**
    * Method description
    *
@@ -143,16 +139,12 @@ public final class Plugins
 
     if (core)
     {
-      if (!new File(directory, "core").createNewFile())
+      if (!new File(directory, PluginConstants.FILE_CORE).createNewFile())
       {
         throw new IOException("could not create core plugin marker");
       }
     }
   }
-  
-  public static File getChecksumFile(File pluginDirectory){
-    return new File(pluginDirectory, FILE_CHECKSUM);
-  }
 
   /**
    * Method description
@@ -167,6 +159,21 @@ public final class Plugins
     return Iterables.transform(wrapped, new Unwrap());
   }
 
+  //~--- get methods ----------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   * @param pluginDirectory
+   *
+   * @return
+   */
+  public static File getChecksumFile(File pluginDirectory)
+  {
+    return new File(pluginDirectory, PluginConstants.FILE_CHECKSUM);
+  }
+
   //~--- inner classes --------------------------------------------------------
 
   /**