package com.atlassian.plugin;
   
   import com.google.common.base.Predicate;
   import org.apache.commons.io.IOUtils;
   import org.slf4j.Logger;
   import org.slf4j.LoggerFactory;
   
   import java.io.BufferedInputStream;
   import java.io.File;
  import java.io.FileInputStream;
  import java.io.FileNotFoundException;
  import java.io.IOException;
  import java.io.InputStream;
  import java.util.jar.JarEntry;
  import java.util.jar.JarFile;
  import java.util.jar.Manifest;
  import java.util.zip.ZipEntry;
  
  import static com.google.common.base.Preconditions.checkNotNull;
  import static com.google.common.collect.Iterators.any;
  import static com.google.common.collect.Iterators.forEnumeration;
  
  /**
   * The implementation of PluginArtifact that is backed by a jar file.
   *
   * @see PluginArtifact
   * @since 2.0.0
   */
  public final class JarPluginArtifact implements PluginArtifact, PluginArtifact.AllowsReference
  {
      private final Logger logger = LoggerFactory.getLogger(this.getClass());
  
      private final File jarFile;
  
      /**
       * The {@link ReferenceMode} used to implement {@link #allowsReference}.
       */
      final ReferenceMode referenceMode;
  
      /**
       * Construct a PluginArtifact for a jar file which does not allow reference installation.
       * @param jarFile the jar file comprising the artifact.
       */
      public JarPluginArtifact(File jarFile)
      {
          this(jarFile, ReferenceMode.FORBID_REFERENCE);
      }
  
      /**
       * Construct a PluginArtifact for a jar file and specify whether reference installation is supported.
       * @param jarFile the jar file comprising the artifact.
       * @param referenceMode The {@link ReferenceMode} used to implement {@link #allowsReference}.
       */
      public JarPluginArtifact(File jarFile, ReferenceMode referenceMode)
      {
          this.jarFile = checkNotNull(jarFile);
          this.referenceMode = referenceMode;
      }
  
  
      public boolean doesResourceExist(String name)
      {
          InputStream in = null;
          try
          {
              in = getResourceAsStream(name);
              return (in != null);
          }
          finally
          {
              IOUtils.closeQuietly(in);
          }
      }
  
      /**
       * @return an input stream for the this file in the jar. Closing this stream also closes the jar file this stream comes from.
       */
      public InputStream getResourceAsStream(String fileName) throws PluginParseException
      {
          checkNotNull(fileName, "The file name must not be null");
  
          final JarFile jar = open();
          final ZipEntry entry = jar.getEntry(fileName);
          if (entry == null)
          {
              closeJarQuietly(jar);
              return null;
          }
  
          try
          {
              return new BufferedInputStream(jar.getInputStream(entry))
              {
                  // because we do not expose a handle to the jar file this stream is associated with, we need to make sure
                  // we explicitly close the jar file when we're done with the stream (else we'll have a file handle leak)
                  public void close() throws IOException
                  {
                      super.close();
                      jar.close();
                 }
             };
         }
         catch (IOException e)
         {
             throw new PluginParseException("Cannot retrieve " + fileName + " from plugin JAR [" + jarFile + "]", e);
         }
     }
 
     public String getName()
     {
         return jarFile.getName();
     }
 
     @Override
     public String toString()
     {
         return getName();
     }
 
     /**
      * @return a buffered file input stream of the file on disk. This input stream
      *         is not resettable.
      */
     public InputStream getInputStream()
     {
         try
         {
             return new BufferedInputStream(new FileInputStream(jarFile));
         }
         catch (FileNotFoundException e)
         {
             throw new PluginParseException("Could not open JAR file: " + jarFile, e);
         }
     }
 
     public File toFile()
     {
         return jarFile;
     }
 
     @Override
     public boolean containsJavaExecutableCode()
     {
         final JarFile jar = open();
         try
         {
             final Manifest manifest = getManifest(jar);
             return hasBundleActivator(manifest)
                     ||
                     hasSpringContext(manifest)
                     ||
                     any(forEnumeration(jar.entries()), new Predicate<JarEntry>()
                     {
                         @Override
                         public boolean apply(JarEntry entry)
                         {
                             return isJavaClass(entry) || isJavaLibrary(entry) || isSpringContext(entry);
                         }
                     });
         }
         finally
         {
             closeJarQuietly(jar);
         }
     }
 
     @Override
     public boolean allowsReference()
     {
         return referenceMode.allowsReference();
     }
 
     private boolean isJavaClass(ZipEntry entry)
     {
         return entry.getName().endsWith(".class");
     }
 
     private boolean isJavaLibrary(ZipEntry entry)
     {
         return entry.getName().endsWith(".jar");
     }
 
     private boolean isSpringContext(ZipEntry entry)
     {
         final String entryName = entry.getName();
         return entryName.startsWith("META-INF/spring/") && entryName.endsWith(".xml");
     }
 
     private boolean hasSpringContext(Manifest manifest)
     {
         return hasManifestEntry(manifest, "Spring-Context");
     }
 
     private boolean hasBundleActivator(Manifest manifest)
     {
         return hasManifestEntry(manifest, "Bundle-Activator");
     }
 
     private boolean hasManifestEntry(Manifest manifest, String manifestEntryName)
     {
         return manifest != null
                 && manifest.getMainAttributes() != null
                 && manifest.getMainAttributes().getValue(manifestEntryName) != null;
     }
 
     private JarFile open()
     {
         try
         {
             return new JarFile(jarFile);
         }
         catch (IOException e)
         {
             throw new PluginParseException("Cannot open JAR file: " + jarFile, e);
         }
     }
 
     private Manifest getManifest(JarFile jar)
     {
         try
         {
             return jar.getManifest();
         }
         catch (IOException e)
         {
             throw new PluginParseException("Cannot get manifest for JAR file: " + jarFile, e);
         }
     }
 
     private void closeJarQuietly(JarFile jar)
     {
         if (jar != null)
         {
             try
             {
                 jar.close();
             }
             catch (IOException ignored)
             {
                 logger.debug("Exception closing jar file " + jarFile + ".", ignored);
             }
         }
     }
 }