org.apache.maven.cling.invoker.LookupContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-cli Show documentation
Maven CLI component, with CLI and logging support.
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.maven.cling.invoker;

import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.Consumer;
import java.util.function.Function;

import org.apache.maven.api.ProtoSession;
import org.apache.maven.api.cli.InvokerException;
import org.apache.maven.api.cli.InvokerRequest;
import org.apache.maven.api.cli.Logger;
import org.apache.maven.api.services.Lookup;
import org.apache.maven.api.settings.Settings;
import org.apache.maven.cling.logging.Slf4jConfiguration;
import org.apache.maven.logging.BuildEventListener;
import org.jline.terminal.Terminal;
import org.slf4j.ILoggerFactory;

import static java.util.Objects.requireNonNull;

@SuppressWarnings("VisibilityModifier")
public class LookupContext implements AutoCloseable {
    public final InvokerRequest invokerRequest;
    public final Function cwdResolver;
    public final Function installationResolver;
    public final Function userResolver;

    protected LookupContext(InvokerRequest invokerRequest) {
        this.invokerRequest = requireNonNull(invokerRequest);
        this.cwdResolver = s -> invokerRequest.cwd().resolve(s).normalize().toAbsolutePath();
        this.installationResolver = s ->
                invokerRequest.installationDirectory().resolve(s).normalize().toAbsolutePath();
        this.userResolver =
                s -> invokerRequest.userHomeDirectory().resolve(s).normalize().toAbsolutePath();
        this.logger = invokerRequest.parserRequest().logger();

        Map user = new HashMap<>(invokerRequest.userProperties());
        user.put("session.topDirectory", invokerRequest.topDirectory().toString());
        if (invokerRequest.rootDirectory().isPresent()) {
            user.put(
                    "session.rootDirectory",
                    invokerRequest.rootDirectory().get().toString());
        }
        this.protoSession = ProtoSession.newBuilder()
                .withSystemProperties(invokerRequest.systemProperties())
                .withUserProperties(user)
                .withTopDirectory(invokerRequest.topDirectory())
                .withRootDirectory(invokerRequest.rootDirectory().orElse(null))
                .build();
    }

    // this one "evolves" as process progresses (instance is immutable but instances are replaced)
    public ProtoSession protoSession;
    // here we track which user properties we pushed to Java System Properties (internal only)
    public Set pushedUserProperties;

    public Logger logger;
    public ILoggerFactory loggerFactory;
    public Slf4jConfiguration slf4jConfiguration;
    public Slf4jConfiguration.Level loggerLevel;
    public Boolean coloredOutput;
    public Terminal terminal;
    public Consumer writer;
    public ContainerCapsule containerCapsule;
    public Lookup lookup;

    public BuildEventListener buildEventListener;

    // paths user can override from CLI, and we need to set on MavenExReq
    public Path installationSettingsPath;
    public Path projectSettingsPath;
    public Path userSettingsPath;

    public boolean interactive;
    public Path localRepositoryPath;
    public Settings effectiveSettings;

    public final List closeables = new ArrayList<>();

    @Override
    public void close() throws InvokerException {
        List causes = null;
        List cs = new ArrayList<>(closeables);
        Collections.reverse(cs);
        for (AutoCloseable c : cs) {
            if (c != null) {
                try {
                    c.close();
                } catch (Exception e) {
                    if (causes == null) {
                        causes = new ArrayList<>();
                    }
                    causes.add(e);
                }
            }
        }
        if (causes != null) {
            InvokerException exception = new InvokerException("Unable to close context");
            causes.forEach(exception::addSuppressed);
            throw exception;
        }
    }

    protected void closeContainer() {
        if (containerCapsule != null) {
            try {
                containerCapsule.close();
            } finally {
                lookup = null;
                containerCapsule = null;
            }
        }
    }
}