001/*
002 * JDrupes Builder
003 * Copyright (C) 2025 Michael N. Lipp
004 * 
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Affero General Public License as
007 * published by the Free Software Foundation, either version 3 of the
008 * License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
013 * GNU Affero General Public License for more details.
014 *
015 * You should have received a copy of the GNU Affero General Public License
016 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
017 */
018
019package org.jdrupes.builder.startup;
020
021import com.google.common.flogger.FluentLogger;
022import eu.maveniverse.maven.mima.context.Context;
023import eu.maveniverse.maven.mima.context.ContextOverrides;
024import eu.maveniverse.maven.mima.context.Runtime;
025import eu.maveniverse.maven.mima.context.Runtimes;
026import java.net.MalformedURLException;
027import java.net.URL;
028import java.net.URLClassLoader;
029import java.nio.file.Path;
030import java.util.ArrayList;
031import java.util.Arrays;
032import java.util.List;
033import java.util.Properties;
034import java.util.stream.Stream;
035import org.apache.commons.cli.CommandLine;
036import org.apache.commons.cli.DefaultParser;
037import org.apache.commons.cli.ParseException;
038import org.eclipse.aether.artifact.DefaultArtifact;
039import org.eclipse.aether.collection.CollectRequest;
040import org.eclipse.aether.graph.Dependency;
041import org.eclipse.aether.graph.DependencyNode;
042import org.eclipse.aether.resolution.DependencyRequest;
043import org.eclipse.aether.resolution.DependencyResolutionException;
044import org.eclipse.aether.util.graph.visitor.PreorderNodeListGenerator;
045import org.jdrupes.builder.api.BuildException;
046import org.jdrupes.builder.api.FaultAware;
047import org.jdrupes.builder.api.Launcher;
048import org.jdrupes.builder.api.Masked;
049import org.jdrupes.builder.api.Project;
050import org.jdrupes.builder.api.ResourceFactory;
051import org.jdrupes.builder.api.RootProject;
052import org.jdrupes.builder.core.LauncherSupport;
053import org.jdrupes.builder.java.JarFile;
054import static org.jdrupes.builder.java.JavaTypes.*;
055
056/// An implementation of a [Launcher] that expects that the JDrupes
057/// Builder project already been compiled and its classes are available
058/// on the classpath.
059///
060public class DirectLauncher extends AbstractLauncher {
061
062    private static final FluentLogger logger = FluentLogger.forEnclosingClass();
063    /// The JDrupes Builder properties read from the file
064    /// `.jdbld.properties` in the root project.
065    protected Properties jdbldProps;
066    /// The command line.
067    protected CommandLine commandLine;
068    private static final String RUNTIME_EXTENSIONS = "runtimeExtensions";
069    private RootProject rootProject;
070
071    /// Instantiates a new direct launcher. The classpath is scanned for
072    /// classes that implement [Project] but do not implement [Masked].
073    /// One of these must also implement the [RootProject] interface.
074    /// The latter is instantiated and registered as root project with all
075    /// other classes found as direct sub projects.
076    ///
077    /// @param classloader the classloader
078    /// @param buildRoot the build root
079    /// @param args the arguments. Flags are processed in the constructor,
080    /// command line arguments are processed in [runCommands].
081    ///
082    @SuppressWarnings({ "PMD.UseVarargs" })
083    public DirectLauncher(ClassLoader classloader, Path buildRoot,
084            String[] args) {
085        unwrapBuildException(() -> {
086            jdbldProps = propertiesFromFiles(buildRoot);
087            try {
088                commandLine = new DefaultParser().parse(baseOptions(), args);
089            } catch (ParseException e) {
090                throw new BuildException(e);
091            }
092            addCliProperties(jdbldProps, commandLine);
093            configureLogging(buildRoot, jdbldProps);
094
095            final var extClsLdr = addRuntimeExts(classloader);
096            var rootProjects = new ArrayList<Class<? extends RootProject>>();
097            var subprojects = new ArrayList<Class<? extends Project>>();
098            findProjects(extClsLdr, rootProjects, subprojects);
099            rootProject = LauncherSupport.createProjects(buildRoot,
100                rootProjects.get(0), subprojects, jdbldProps, commandLine);
101            return null;
102        });
103    }
104
105    private ClassLoader addRuntimeExts(ClassLoader classloader) {
106        String[] coordinates = Arrays
107            .asList(jdbldProps.getProperty(RUNTIME_EXTENSIONS, "").split(","))
108            .stream()
109            .map(String::trim).filter(c -> !c.isBlank()).toArray(String[]::new);
110        if (coordinates.length == 0) {
111            return classloader;
112        }
113
114        // Resolve using maven repo
115        var cpUrls = resolveRequested(coordinates).mapMulti((jf, consumer) -> {
116            try {
117                consumer.accept(jf.path().toFile().toURI().toURL());
118            } catch (MalformedURLException e) {
119                logger.atWarning().withCause(e).log("Cannot convert %s to URL",
120                    jf);
121            }
122        }).toArray(URL[]::new);
123
124        // Return augmented classloader
125        return new URLClassLoader(cpUrls, classloader);
126    }
127
128    @SuppressWarnings({ "PMD.UseVarargs",
129        "PMD.AvoidInstantiatingObjectsInLoops" })
130    private Stream<JarFile> resolveRequested(String[] coordinates) {
131        ContextOverrides overrides = ContextOverrides.create()
132            .withUserSettings(true).build();
133        Runtime runtime = Runtimes.INSTANCE.getRuntime();
134        try (Context context = runtime.create(overrides)) {
135            CollectRequest collectRequest = new CollectRequest()
136                .setRepositories(context.remoteRepositories());
137            for (var coord : coordinates) {
138                collectRequest.addDependency(
139                    new Dependency(new DefaultArtifact(coord), "runtime"));
140            }
141
142            DependencyRequest dependencyRequest
143                = new DependencyRequest(collectRequest, null);
144            DependencyNode rootNode;
145            try {
146                rootNode = context.repositorySystem()
147                    .resolveDependencies(context.repositorySystemSession(),
148                        dependencyRequest)
149                    .getRoot();
150                PreorderNodeListGenerator nlg = new PreorderNodeListGenerator();
151                rootNode.accept(nlg);
152                List<DependencyNode> dependencyNodes = nlg.getNodes();
153                return dependencyNodes.stream()
154                    .filter(d -> d.getArtifact() != null)
155                    .map(d -> d.getArtifact().getFile().toPath())
156                    .map(p -> ResourceFactory
157                        .create(JarFileType, p));
158            } catch (DependencyResolutionException e) {
159                throw new BuildException(
160                    "Cannot resolve: " + e.getMessage(), e);
161            }
162        }
163    }
164
165    @Override
166    public RootProject rootProject() {
167        return rootProject;
168    }
169
170    /// Execute the commands from the command line.
171    ///
172    /// @return true, if successful
173    ///
174    @SuppressWarnings({ "PMD.SystemPrintln", "PMD.AvoidLiteralsInIfCondition" })
175    public boolean runCommands() {
176        for (var arg : commandLine.getArgs()) {
177            var parts = arg.split(":");
178            String resource = parts[parts.length - 1];
179            var cmdData = LauncherSupport.lookupCommand(rootProject, resource);
180            if (cmdData.requests().length == 0) {
181                throw new BuildException("Unknown command: " + arg);
182            }
183            String pattern = cmdData.pattern();
184            if (parts.length > 1) {
185                pattern = parts[0];
186            }
187            for (var req : cmdData.requests()) {
188                if (!resources(rootProject().projects(pattern), req)
189                    .peek(r -> System.out.println(r.toString()))
190                    .map(r -> !(r instanceof FaultAware)
191                        || !((FaultAware) r).isFaulty())
192                    .reduce((r1, r2) -> r1 && r2).orElse(true)) {
193                    return false;
194                }
195            }
196        }
197        return true;
198    }
199
200    /// This main can be used to start the user's JDrupes Builder
201    /// project from an IDE for debugging purposes. It expects that
202    /// the JDrupes Builder project has already been compiled (typically
203    /// by the IDE) and is available on the classpath.
204    ///
205    /// @param args the arguments
206    ///
207    public static void main(String[] args) {
208        new DirectLauncher(Thread.currentThread().getContextClassLoader(),
209            Path.of("").toAbsolutePath(), args).runCommands();
210    }
211}