com.googlecode.smartgwtmavenplugin.mojo.lifted.AbstractInstallMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smartgwt-maven-plugin Show documentation
Facilitates the download, preparation, installation, and deployment of Maven artifacts from the Isomorphic builds available at http://www.smartclient.com/builds/.
The newest version!
package com.googlecode.smartgwtmavenplugin.mojo.lifted;

/*
 * 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.
 */

import java.io.File;
import java.io.IOException;
import java.util.Collection;
import java.util.Iterator;

import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.factory.ArtifactFactory;
import org.apache.maven.artifact.installer.ArtifactInstaller;
import org.apache.maven.artifact.metadata.ArtifactMetadata;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.codehaus.plexus.digest.Digester;
import org.codehaus.plexus.digest.DigesterException;
import org.codehaus.plexus.util.FileUtils;

/**
 * Common fields for installation mojos.  Taken directly from the Maven Install Plugin at 
 * http://maven.apache.org/plugins/maven-install-plugin/ with no modifications except to the package name.  Original Author's name
 * preserved.
 * 
 * @author Brett Porter
 * 
 */
public abstract class AbstractInstallMojo extends AbstractMojo {

	/**
	 * @component
	 */
	protected ArtifactFactory artifactFactory;

	/**
	 * @component
	 */
	protected ArtifactInstaller installer;

	/**
	 * @parameter property="localRepository"
	 * @required
	 * @readonly
	 */
	protected ArtifactRepository localRepository;

	/**
	 * Flag whether to create checksums (MD5, SHA-1) or not.
	 * 
	 * @parameter property="createChecksum" default-value="false"
	 * @since 2.2
	 */
	protected boolean createChecksum;

	/**
	 * Whether to update the metadata to make the artifact a release version.
	 * 
	 * @parameter property="updateReleaseInfo" default-value="false"
	 */
	protected boolean updateReleaseInfo;

	/**
	 * Digester for MD5.
	 * 
	 * @component role-hint="md5"
	 */
	protected Digester md5Digester;

	/**
	 * Digester for SHA-1.
	 * 
	 * @component role-hint="sha1"
	 */
	protected Digester sha1Digester;

	/**
	 * Gets the path of the specified artifact within the local repository. Note
	 * that the returned path need not exist (yet).
	 * 
	 * @param artifact
	 *            The artifact whose local repo path should be determined, must
	 *            not be null.
	 * @return The absolute path to the artifact when installed, never
	 *         null.
	 */
	protected File getLocalRepoFile(Artifact artifact) {
		String path = localRepository.pathOf(artifact);
		return new File(localRepository.getBasedir(), path);
	}

	/**
	 * Gets the path of the specified artifact metadata within the local
	 * repository. Note that the returned path need not exist (yet).
	 * 
	 * @param metadata
	 *            The artifact metadata whose local repo path should be
	 *            determined, must not be null.
	 * @return The absolute path to the artifact metadata when installed, never
	 *         null.
	 */
	protected File getLocalRepoFile(ArtifactMetadata metadata) {
		String path = localRepository.pathOfLocalRepositoryMetadata(metadata,
				localRepository);
		return new File(localRepository.getBasedir(), path);
	}

	/**
	 * Installs the checksums for the specified artifact (and its metadata
	 * files) if this has been enabled in the plugin configuration. This method
	 * creates checksums for files that have already been installed to the local
	 * repo to account for on-the-fly generated/updated files. For example, in
	 * Maven 2.0.4- the ProjectArtifactMetadata did not install the
	 * original POM file (cf. MNG-2820). While the plugin currently requires
	 * Maven 2.0.6, we continue to hash the installed POM for robustness with
	 * regard to future changes like re-introducing some kind of POM filtering.
	 * 
	 * @param artifact
	 *            The artifact for which to create checksums, must not be
	 *            null.
	 * @throws MojoExecutionException
	 *             If the checksums could not be installed.
	 */
	protected void installChecksums(Artifact artifact)
			throws MojoExecutionException {
		if (!createChecksum) {
			return;
		}

		File artifactFile = getLocalRepoFile(artifact);
		installChecksums(artifactFile);

		Collection metadatas = artifact.getMetadataList();
		if (metadatas != null) {
			for (Iterator it = metadatas.iterator(); it.hasNext();) {
				ArtifactMetadata metadata = (ArtifactMetadata) it.next();
				File metadataFile = getLocalRepoFile(metadata);
				installChecksums(metadataFile);
			}
		}
	}

	/**
	 * Installs the checksums for the specified file (if it exists).
	 * 
	 * @param installedFile
	 *            The path to the already installed file in the local repo for
	 *            which to generate checksums, must not be null.
	 * @throws MojoExecutionException
	 *             If the checksums could not be installed.
	 */
	private void installChecksums(File installedFile)
			throws MojoExecutionException {
		boolean signatureFile = installedFile.getName().endsWith(".asc");
		if (installedFile.isFile() && !signatureFile) {
			installChecksum(installedFile, installedFile, md5Digester, ".md5");
			installChecksum(installedFile, installedFile, sha1Digester, ".sha1");
		}
	}

	/**
	 * Installs a checksum for the specified file.
	 * 
	 * @param originalFile
	 *            The path to the file from which the checksum is generated,
	 *            must not be null.
	 * @param installedFile
	 *            The base path from which the path to the checksum files is
	 *            derived by appending the given file extension, must not be
	 *            null.
	 * @param digester
	 *            The checksum algorithm to use, must not be null.
	 * @param ext
	 *            The file extension (including the leading dot) to use for the
	 *            checksum file, must not be null.
	 * @throws MojoExecutionException
	 *             If the checksum could not be installed.
	 */
	private void installChecksum(File originalFile, File installedFile,
			Digester digester, String ext) throws MojoExecutionException {
		String checksum;
		getLog().debug(
				"Calculating " + digester.getAlgorithm() + " checksum for "
						+ originalFile);
		try {
			checksum = digester.calc(originalFile);
		} catch (DigesterException e) {
			throw new MojoExecutionException(
					"Failed to calculate " + digester.getAlgorithm()
							+ " checksum for " + originalFile, e);
		}

		File checksumFile = new File(installedFile.getAbsolutePath() + ext);
		getLog().debug("Installing checksum to " + checksumFile);
		try {
			checksumFile.getParentFile().mkdirs();
			FileUtils.fileWrite(checksumFile.getAbsolutePath(), "UTF-8",
					checksum);
		} catch (IOException e) {
			throw new MojoExecutionException("Failed to install checksum to "
					+ checksumFile, e);
		}
	}

}