org.grails.cli.compiler.maven.MavenSettingsReader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grace-shell Show documentation
Grace Framework : Grace Shell
There is a newer version: 2023.1.0-RC1
/*
 * Copyright 2012-2024 the original author or authors.
 *
 * Licensed 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
 *
 *      https://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.grails.cli.compiler.maven;

import java.io.File;

import org.apache.maven.settings.Settings;
import org.apache.maven.settings.building.DefaultSettingsBuilderFactory;
import org.apache.maven.settings.building.DefaultSettingsBuildingRequest;
import org.apache.maven.settings.building.SettingsBuildingException;
import org.apache.maven.settings.building.SettingsBuildingRequest;
import org.apache.maven.settings.crypto.DefaultSettingsDecrypter;
import org.apache.maven.settings.crypto.DefaultSettingsDecryptionRequest;
import org.apache.maven.settings.crypto.SettingsDecrypter;
import org.apache.maven.settings.crypto.SettingsDecryptionResult;
import org.sonatype.plexus.components.cipher.DefaultPlexusCipher;
import org.sonatype.plexus.components.sec.dispatcher.DefaultSecDispatcher;

import org.grails.cli.util.Log;

/**
 * {@code MavenSettingsReader} reads settings from a user's Maven settings.xml file,
 * decrypting them if necessary using settings-security.xml.
 *
 * @author Andy Wilkinson
 * @author Michael Yan
 * @since 2022.1.0
 */
public class MavenSettingsReader {

    private final String homeDir;

    public MavenSettingsReader() {
        this(System.getProperty("user.home"));
    }

    public MavenSettingsReader(String homeDir) {
        this.homeDir = homeDir;
    }

    public MavenSettings readSettings() {
        Settings settings = loadSettings();
        SettingsDecryptionResult decrypted = decryptSettings(settings);
        if (!decrypted.getProblems().isEmpty()) {
            Log.error("Maven settings decryption failed. Some Maven repositories may be inaccessible");
            // Continue - the encrypted credentials may not be used
        }
        return new MavenSettings(settings, decrypted);
    }

    private Settings loadSettings() {
        File settingsFile = new File(this.homeDir, ".m2/settings.xml");
        SettingsBuildingRequest request = new DefaultSettingsBuildingRequest();
        request.setUserSettingsFile(settingsFile);
        request.setSystemProperties(System.getProperties());
        try {
            return new DefaultSettingsBuilderFactory().newInstance().build(request).getEffectiveSettings();
        }
        catch (SettingsBuildingException ex) {
            throw new IllegalStateException("Failed to build settings from " + settingsFile, ex);
        }
    }

    private SettingsDecryptionResult decryptSettings(Settings settings) {
        DefaultSettingsDecryptionRequest request = new DefaultSettingsDecryptionRequest(settings);

        return createSettingsDecrypter().decrypt(request);
    }

    private SettingsDecrypter createSettingsDecrypter() {
        return new DefaultSettingsDecrypter(new SpringBootSecDispatcher());
    }

    private class SpringBootSecDispatcher extends DefaultSecDispatcher {

        private static final String SECURITY_XML = ".m2/settings-security.xml";

        SpringBootSecDispatcher() {
            super(new DefaultPlexusCipher());
            File file = new File(MavenSettingsReader.this.homeDir, SECURITY_XML);
            setConfigurationFile(file.getAbsolutePath());
        }

    }

}