com.github.k0zka.contentcompress.JettyGzipMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-contentgzip-plugin Show documentation
Compresses the static web resource files with gzip.
The newest version!
package com.github.k0zka.contentcompress;

/*
 * Copyright 2001-2005 The Apache Software Foundation.
 *
 * 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.
 */

import java.io.File;
import java.io.FileFilter;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.FilenameFilter;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.zip.GZIPOutputStream;

import org.apache.commons.io.FileUtils;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang.ObjectUtils;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;

/**
 * This goal creates a gzip-ed file from each file in the webapp that matches
 * the filename pattern.
 * 
 * @goal process
 * 
 * @phase prepare-package
 */
public class JettyGzipMojo extends AbstractMojo {
	private final class DotNotFilter implements FileFilter {
		public boolean accept(File pathname) {
			return !pathname.getName().startsWith(".");
		}
	}

	private final class FilesToGzipFilter implements FilenameFilter {
		public boolean accept(File dir, String name) {
			return matchesAny(name) && new File(dir, name).isFile();
		}

		private boolean matchesAny(final String fileName) {
			for (final String pattern : extensions) {
				if (fileName.endsWith(pattern)) {
					return true;
				}
			}
			return false;
		}
	}

	private final class SubdirsFilter implements FilenameFilter {

		public boolean accept(final File dir, final String name) {
			return new File(dir, name).isDirectory() && !"WEB-INF".equals(name);
		}

	}

	/**
	 * Location of the webapp.
	 *  
	 * @parameter expression="src/main/webapp"
	 * @required
	 */
	private File webappDirectory;

	/**
	 * Location of the file.
	 * 
	 * @parameter expression="${project.build.directory}/${project.build.finalName}"
	 * @required
	 */
	private File outputDirectory;
	/**
	 * @parameter
	 */
	private List extensions = getDefaultExtensions();

	public void execute() throws MojoExecutionException {
		getLog().info("Compressing static resources with gzip...");
		try {
			if(!ObjectUtils.equals(webappDirectory, outputDirectory)) {
				FileUtils.copyDirectory(webappDirectory, outputDirectory, new DotNotFilter());
			}
			seekAndGzip(outputDirectory);
		} catch (IOException e) {
			throw new MojoExecutionException("IO exception when gzipping files", e);
		}
	}

	List getDefaultExtensions() {
		final ArrayList ret = new ArrayList();
		ret.add(".css");
		ret.add(".txt");
		ret.add(".html");
		ret.add(".htm");
		ret.add(".js");
		ret.add(".xml");
		ret.add(".xls");
		ret.add(".ico");
		ret.add(".pdf");
		ret.add(".doc");
		return ret;
	}

	void seekAndGzip(File directory) throws IOException {
		final String[] fileNames = directory.list(new FilesToGzipFilter());
		if (fileNames == null) {
			getLog().error(
					"Directory does not exist: " + directory.getAbsolutePath());
			return;
		}
		for (final String fileName : fileNames) {
			final File gzippedFile = new File(directory, fileName.concat(".gz"));
			if (gzippedFile.exists()) {
				continue;
			}
			final File sourceFile = new File(directory, fileName);
			final FileInputStream inputStream = new FileInputStream(sourceFile);
			final FileOutputStream fileStream = new FileOutputStream(
					gzippedFile);
			final GZIPOutputStream gzipStream = new GZIPOutputStream(fileStream);
			IOUtils.copy(inputStream, gzipStream);
			IOUtils.closeQuietly(inputStream);
			IOUtils.closeQuietly(gzipStream);
			IOUtils.closeQuietly(fileStream);
			getLog().info(
					"Compressed file " + sourceFile.getName() + ". "
							+ sourceFile.length() + " -> "
							+ gzippedFile.length());
		}
		final String[] subDirs = directory.list(new SubdirsFilter());
		for (final String subDir : subDirs) {
			seekAndGzip(new File(directory, subDir));
		}
	}

}