org.apache.maven.wrapper.WrapperExecutor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-wrapper
There is a newer version: 0.5.6
/*
 * Copyright 2007-2008 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
 *
 *      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.wrapper;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.Properties;

/**
 * @author Hans Dockter
 */
public class WrapperExecutor {
  public static final String DISTRIBUTION_URL_PROPERTY = "distributionUrl";

  public static final String DISTRIBUTION_BASE_PROPERTY = "distributionBase";

  public static final String ZIP_STORE_BASE_PROPERTY = "zipStoreBase";

  public static final String DISTRIBUTION_PATH_PROPERTY = "distributionPath";

  public static final String ZIP_STORE_PATH_PROPERTY = "zipStorePath";

  private final Properties properties;

  private final File propertiesFile;

  private final Appendable warningOutput;

  private final WrapperConfiguration config = new WrapperConfiguration();

  public static WrapperExecutor forProjectDirectory(File projectDir, Appendable warningOutput) {
    return new WrapperExecutor(new File(projectDir, "maven/wrapper/maven-wrapper.properties"), new Properties(), warningOutput);
  }

  public static WrapperExecutor forWrapperPropertiesFile(File propertiesFile, Appendable warningOutput) {
    if (!propertiesFile.exists()) {
      throw new RuntimeException(String.format("Wrapper properties file '%s' does not exist.", propertiesFile));
    }
    return new WrapperExecutor(propertiesFile, new Properties(), warningOutput);
  }

  WrapperExecutor(File propertiesFile, Properties properties, Appendable warningOutput) {
    this.properties = properties;
    this.propertiesFile = propertiesFile;
    this.warningOutput = warningOutput;
    if (propertiesFile.exists()) {
      try {
        loadProperties(propertiesFile, properties);
        config.setDistribution(prepareDistributionUri());
        config.setDistributionBase(getProperty(DISTRIBUTION_BASE_PROPERTY, config.getDistributionBase()));
        config.setDistributionPath(getProperty(DISTRIBUTION_PATH_PROPERTY, config.getDistributionPath()));
        config.setZipBase(getProperty(ZIP_STORE_BASE_PROPERTY, config.getZipBase()));
        config.setZipPath(getProperty(ZIP_STORE_PATH_PROPERTY, config.getZipPath()));
      } catch (Exception e) {
        throw new RuntimeException(String.format("Could not load wrapper properties from '%s'.", propertiesFile), e);
      }
    }
  }

  private URI prepareDistributionUri() throws URISyntaxException {
    URI source = readDistroUrl();
    if (source.getScheme() == null) {
      // no scheme means someone passed a relative url. In our context only file relative urls make sense.
      return new File(propertiesFile.getParentFile(), source.getSchemeSpecificPart()).toURI();
    } else {
      return source;
    }
  }

  private URI readDistroUrl() throws URISyntaxException {
    if (properties.getProperty(DISTRIBUTION_URL_PROPERTY) != null) {
      return new URI(getProperty(DISTRIBUTION_URL_PROPERTY));
    }

    reportMissingProperty(DISTRIBUTION_URL_PROPERTY);
    return null; // previous line will fail
  }

  private static void loadProperties(File propertiesFile, Properties properties) throws IOException {
    InputStream inStream = new FileInputStream(propertiesFile);
    try {
      properties.load(inStream);
    } finally {
      inStream.close();
    }
  }

  /**
   * Returns the distribution which this wrapper will use. Returns null if no wrapper meta-data was found in the
   * specified project directory.
   */
  public URI getDistribution() {
    return config.getDistribution();
  }

  /**
   * Returns the configuration for this wrapper.
   */
  public WrapperConfiguration getConfiguration() {
    return config;
  }

  public void execute(String[] args, Installer install, BootstrapMainStarter bootstrapMainStarter) throws Exception {
    File mavenHome = install.createDist(config);
    bootstrapMainStarter.start(args, mavenHome);
  }

  private String getProperty(String propertyName) {
    return getProperty(propertyName, null);
  }

  private String getProperty(String propertyName, String defaultValue) {
    String value = properties.getProperty(propertyName);
    if (value != null) {
      return value;
    }
    if (defaultValue != null) {
      return defaultValue;
    }
    return reportMissingProperty(propertyName);
  }

  private String reportMissingProperty(String propertyName) {
    throw new RuntimeException(String.format("No value with key '%s' specified in wrapper properties file '%s'.", propertyName, propertiesFile));
  }
}