Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.samaxes.maven.plugin.minify.ProcessFilesTask Maven / Gradle / Ivy
Combine and minimize JavaScript and CSS files for faster page loading.
/*
* $Id$
*
* Minify Maven Plugin
* https://github.com/samaxes/minify-maven-plugin
*
* Copyright (c) 2009 samaxes.com
*
* 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 com.samaxes.maven.plugin.minify;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.SequenceInputStream;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.Callable;
import org.apache.maven.plugin.logging.Log;
import org.codehaus.plexus.util.DirectoryScanner;
import org.codehaus.plexus.util.FileUtils;
import org.codehaus.plexus.util.IOUtil;
import com.samaxes.maven.plugin.common.FilenameComparator;
import com.samaxes.maven.plugin.common.ListOfFiles;
/**
* Abstract class for merging and compressing a files list.
*/
public abstract class ProcessFilesTask implements Callable {
protected Log log;
protected int linebreak;
protected File mergedFile;
protected File minifiedFile;
protected Integer bufferSize;
protected String charset;
private List files = new ArrayList();
/**
* Task constructor.
*
* @param log Maven plugin log
* @param bufferSize size of the buffer used to read source files.
* @param webappSourceDir web resources source directory
* @param webappTargetDir web resources target directory
* @param inputDir directory containing source files
* @param sourceFiles list of source files to include
* @param sourceIncludes list of source files to include
* @param sourceExcludes list of source files to exclude
* @param outputDir directory to write the final file
* @param finalFilename final filename
* @param suffix final filename suffix
* @param charset if a character set is specified, a byte-to-char variant allows the encoding to be selected.
* Otherwise, only byte-to-byte operations are used
* @param linebreak split long lines after a specific column
*/
public ProcessFilesTask(Log log, Integer bufferSize, String webappSourceDir, String webappTargetDir,
String inputDir, List sourceFiles, List sourceIncludes, List sourceExcludes,
String outputDir, String finalFilename, String suffix, String charset, int linebreak) {
this.log = log;
this.linebreak = linebreak;
this.bufferSize = bufferSize;
this.charset = charset;
File sourceDir = new File(webappSourceDir + File.separator + inputDir);
for (String sourceFilename : sourceFiles) {
addNewSourceFile(finalFilename, sourceDir, sourceFilename);
}
for (File sourceInclude : getFilesToInclude(sourceDir, sourceIncludes, sourceExcludes)) {
if (!files.contains(sourceInclude)) {
addNewSourceFile(finalFilename, sourceDir, sourceInclude);
}
}
File targetDir = new File(webappTargetDir + File.separator + outputDir);
String extension = "." + FileUtils.getExtension(finalFilename);
if (!files.isEmpty() && (targetDir.exists() || targetDir.mkdirs())) {
this.mergedFile = new File(targetDir, finalFilename);
this.minifiedFile = new File(targetDir, this.mergedFile.getName().replace(extension,
suffix + extension));
} else if (!sourceFiles.isEmpty() || !sourceIncludes.isEmpty()) {
// The 'files' list will be empty if the source file paths or names added to the project's POM are wrong.
String fileType = ("CSS".equalsIgnoreCase(extension.substring(1))) ? "CSS" : "JavaScript";
log.error("No " + fileType + " source files found to process.");
}
}
/**
* Method executed by the thread.
*/
public Object call() {
mergeFiles();
minify();
return null;
}
/**
* Logs an addition of a new source file.
*
* @param finalFilename the final file name
* @param sourceDir the sources directory
* @param sourceFilename the source file name
*/
private void addNewSourceFile(String finalFilename, File sourceDir, String sourceFilename) {
File sourceFile = new File(sourceDir, sourceFilename);
addNewSourceFile(finalFilename, sourceDir, sourceFile);
}
/**
* Logs an addition of a new source file.
*
* @param finalFilename the final file name
* @param sourceDir the sources directory
* @param sourceFile the source file
*/
private void addNewSourceFile(String finalFilename, File sourceDir, File sourceFile) {
if (sourceFile.exists()) {
if (finalFilename.equalsIgnoreCase(sourceFile.getName())) {
log.warn("Source file [" + sourceFile.getName() + "] has the same name as the final file.");
}
log.debug("Source file [" + sourceFile.getName() + "] added.");
files.add(sourceFile);
} else {
log.warn("Source file [" + sourceFile.getName() + "] was not included beacause it does not exist.");
}
}
/**
* Returns the files to copy. Default exclusions are used when the excludes list is empty.
*
* @param baseDir the base directory to start from
* @param includes list of source files to include
* @param excludes list of source files to exclude
* @return the files to copy
*/
private List getFilesToInclude(File baseDir, List includes, List excludes) {
List includedFiles = new ArrayList();
if (includes != null && !includes.isEmpty()) {
DirectoryScanner scanner = new DirectoryScanner();
scanner.setIncludes(includes.toArray(new String[0]));
scanner.setExcludes(excludes.toArray(new String[0]));
scanner.addDefaultExcludes();
scanner.setBasedir(baseDir);
scanner.scan();
for (String includedFilename : scanner.getIncludedFiles()) {
includedFiles.add(new File(baseDir, includedFilename));
}
Collections.sort(includedFiles, new FilenameComparator());
}
return includedFiles;
}
/**
* Merges files list.
*/
private void mergeFiles() {
if (mergedFile != null) {
ListOfFiles listOfFiles = new ListOfFiles(log, files);
try {
log.info("Creating merged file [" + mergedFile.getName() + "].");
InputStream sequence = new SequenceInputStream(listOfFiles);
OutputStream out = new FileOutputStream(mergedFile);
if (charset == null) {
IOUtil.copy(sequence, out, bufferSize);
} else {
InputStreamReader sequenceReader = new InputStreamReader(sequence, charset);
OutputStreamWriter outWriter = new OutputStreamWriter(out, charset);
IOUtil.copy(sequenceReader, outWriter, bufferSize);
IOUtil.close(sequenceReader);
IOUtil.close(outWriter);
}
IOUtil.close(sequence);
IOUtil.close(out);
} catch (IOException e) {
log.error("An error has occurred while concatenating files.", e);
}
}
}
/**
* Minifies source file.
*/
abstract void minify();
}
