/*
    * Copyright (c) 2011-2024 Qulice.com
    *
    * 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 the Qulice.com 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 COPYRIGHT HOLDER 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.
   */
  package com.qulice.maven;
  
  import com.google.common.base.Function;
  import com.google.common.base.Predicate;
  import com.google.common.base.Predicates;
  import com.google.common.collect.Collections2;
  import com.google.common.collect.Iterables;
  import com.jcabi.log.Logger;
  import java.io.File;
  import java.net.MalformedURLException;
  import java.net.URI;
  import java.net.URL;
  import java.net.URLClassLoader;
  import java.nio.charset.Charset;
  import java.security.PrivilegedAction;
  import java.util.Collection;
  import java.util.LinkedList;
  import java.util.List;
  import java.util.Properties;
  import javax.annotation.Nullable;
  import org.apache.commons.io.FileUtils;
  import org.apache.commons.io.FilenameUtils;
  import org.apache.commons.io.filefilter.DirectoryFileFilter;
  import org.apache.commons.io.filefilter.IOFileFilter;
  import org.apache.commons.io.filefilter.WildcardFileFilter;
  import org.apache.maven.artifact.Artifact;
  import org.apache.maven.artifact.DependencyResolutionRequiredException;
  import org.apache.maven.project.MavenProject;
  import org.codehaus.plexus.context.Context;
  
  /**
   * Environment, passed from MOJO to validators.
   *
   * @since 0.3
   * @checkstyle ClassDataAbstractionCouplingCheck (300 lines)
   */
  @SuppressWarnings("PMD.TooManyMethods")
  public final class DefaultMavenEnvironment implements MavenEnvironment {
  
      /**
       * Maven project.
       */
      private MavenProject iproject;
  
      /**
       * Plexus context.
       */
      private Context icontext;
  
      /**
       * Plugin configuration.
       */
      private final Properties iproperties = new Properties();
  
      /**
       * MOJO executor.
       */
      private MojoExecutor exectr;
  
      /**
       * Excludes, regular expressions.
       */
      private final Collection<String> exc = new LinkedList<>();
  
      /**
       * Xpath queries for pom.xml validation.
       */
      private final Collection<String> asser = new LinkedList<>();
  
     /**
      * Source code encoding charset.
      */
     private String charset = "UTF-8";
 
     @Override
     public String param(final String name, final String value) {
         String ret = this.iproperties.getProperty(name);
         if (ret == null) {
             ret = value;
         }
         return ret;
     }
 
     @Override
     public File basedir() {
         return this.iproject.getBasedir();
     }
 
     @Override
     public File tempdir() {
         return new File(this.iproject.getBuild().getOutputDirectory());
     }
 
     @Override
     public File outdir() {
         return new File(this.iproject.getBuild().getOutputDirectory());
     }
 
     @Override
     @SuppressWarnings({"PMD.AvoidInstantiatingObjectsInLoops", "deprecation"})
     public Collection<String> classpath() {
         final Collection<String> paths = new LinkedList<>();
         final String blank = "%20";
         final String whitespace = " ";
         try {
             for (final String name
                 : this.iproject.getRuntimeClasspathElements()) {
                 paths.add(
                     name.replace(
                         File.separatorChar, '/'
                     ).replaceAll(whitespace, blank)
                 );
             }
             for (final Artifact artifact
                 : this.iproject.getDependencyArtifacts()) {
                 if (artifact.getFile() != null) {
                     paths.add(
                         artifact.getFile().getAbsolutePath()
                             .replace(File.separatorChar, '/')
                             .replaceAll(whitespace, blank)
                     );
                 }
             }
         } catch (final DependencyResolutionRequiredException ex) {
             throw new IllegalStateException("Failed to read classpath", ex);
         }
         return paths;
     }
 
     @Override
     public ClassLoader classloader() {
         final List<URL> urls = new LinkedList<>();
         for (final String path : this.classpath()) {
             try {
                 urls.add(
                     URI.create(String.format("file:///%s", path)).toURL()
                 );
             } catch (final MalformedURLException ex) {
                 throw new IllegalStateException("Failed to build URL", ex);
             }
         }
         final URLClassLoader loader =
             new DefaultMavenEnvironment.PrivilegedClassLoader(urls).run();
         for (final URL url : loader.getURLs()) {
             Logger.debug(this, "Classpath: %s", url);
         }
         return loader;
     }
 
     @Override
     public MavenProject project() {
         return this.iproject;
     }
 
     @Override
     public Properties properties() {
         return this.iproperties;
     }
 
     @Override
     public Context context() {
         return this.icontext;
     }
 
     @Override
     public Properties config() {
         return this.iproperties;
     }
 
     @Override
     public MojoExecutor executor() {
         return this.exectr;
     }
 
     @Override
     public Collection<String> asserts() {
         return this.asser;
     }
 
     @Override
     @SuppressWarnings("PMD.AvoidInstantiatingObjectsInLoops")
     public Collection<File> files(final String pattern) {
         final Collection<File> files = new LinkedList<>();
         final IOFileFilter filter = WildcardFileFilter.builder().setWildcards(pattern).get();
         final String[] dirs = {
             "src",
         };
         for (final String dir : dirs) {
             final File sources = new File(this.basedir(), dir);
             if (sources.exists()) {
                 files.addAll(
                     FileUtils.listFiles(
                         sources,
                         filter,
                         DirectoryFileFilter.INSTANCE
                     )
                 );
             }
         }
         return files;
     }
 
     @Override
     public boolean exclude(final String check, final String name) {
         return Iterables.any(
             this.excludes(check),
             new DefaultMavenEnvironment.PathPredicate(name)
         );
     }
 
     @Override
     public Collection<String> excludes(final String checker) {
         final Collection<String> excludes = Collections2.transform(
             this.exc,
             new DefaultMavenEnvironment.CheckerExcludes(checker)
         );
         return Collections2.filter(excludes, Predicates.notNull());
     }
 
     /**
      * Set Maven Project (used mostly for unit testing).
      * @param proj The project to set
      */
     public void setProject(final MavenProject proj) {
         this.iproject = proj;
     }
 
     /**
      * Set context.
      * @param ctx The context to set
      */
     public void setContext(final Context ctx) {
         this.icontext = ctx;
     }
 
     /**
      * Set executor.
      * @param exec The executor
      */
     public void setMojoExecutor(final MojoExecutor exec) {
         this.exectr = exec;
     }
 
     /**
      * Set property.
      * @param name Its name
      * @param value Its value
      */
     public void setProperty(final String name, final String value) {
         this.iproperties.setProperty(name, value);
     }
 
     /**
      * Set list of regular expressions to exclude.
      * @param exprs Expressions
      */
     public void setExcludes(final Collection<String> exprs) {
         this.exc.clear();
         this.exc.addAll(exprs);
     }
 
     /**
      * Set list of Xpath queries for pom.xml validation.
      * @param ass Xpath queries
      */
     public void setAsser(final Collection<String> ass) {
         this.asser.clear();
         this.asser.addAll(ass);
     }
 
     public void setEncoding(final String encoding) {
         this.charset = encoding;
     }
 
     /**
      * Get source files encoding.
      * @return Charset of the source files
      */
     public Charset encoding() {
         if (this.charset == null || this.charset.isEmpty()) {
             this.charset = "UTF-8";
         }
         return Charset.forName(this.charset);
     }
 
     /**
      * Creates URL ClassLoader in privileged block.
      *
      * @since 0.1
      */
     private static final class PrivilegedClassLoader implements
         PrivilegedAction<URLClassLoader> {
         /**
          * URLs for class loading.
          */
         private final List<URL> urls;
 
         /**
          * Constructor.
          * @param urls URLs for class loading.
          */
         private PrivilegedClassLoader(final List<URL> urls) {
             this.urls = urls;
         }
 
         @Override
         public URLClassLoader run() {
             return new URLClassLoader(
                 this.urls.toArray(new URL[this.urls.size()]),
                 Thread.currentThread().getContextClassLoader()
             );
         }
     }
 
     /**
      * Checks if two paths are equal.
      *
      * @since 0.1
      */
     private static class PathPredicate implements Predicate<String> {
         /**
          * Path to match.
          */
         private final String name;
 
         /**
          * Constructor.
          * @param name Path to match.
          */
         PathPredicate(final String name) {
             this.name = name;
         }
 
         @Override
         public boolean apply(@Nullable final String input) {
             return input != null
                 && FilenameUtils.normalize(this.name, true).matches(input);
         }
     }
 
     /**
      * Converts a checker exclude into exclude param.
      *
      * E.g. "checkstyle:.*" will become ".*".
      *
      * @since 0.1
      */
     private static class CheckerExcludes implements Function<String, String> {
 
         /**
          * Name of checker.
          */
         private final String checker;
 
         /**
          * Constructor.
          * @param checker Name of checker.
          */
         CheckerExcludes(final String checker) {
             this.checker = checker;
         }
 
         @Nullable
         @Override
         public String apply(@Nullable final String input) {
             String result = null;
             if (input != null) {
                 final String[] exclude = input.split(":", 2);
                 if (this.checker.equals(exclude[0]) && exclude.length > 1) {
                     result = exclude[1];
                 }
             }
             return result;
         }
     }
 }