com.ariht.maven.plugins.config.DirectoryReader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of config-processor-maven-plugin Show documentation
Generates config and scripts for multiple target environments using template placeholder substitution from values in multiple filter files.
There is a newer version: 0.9.5
Show newest version
/*
 * Copyright 2014 Software Design Studio Ltd.
 *
 * 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.ariht.maven.plugins.config;

import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

import com.google.common.collect.Lists;
import com.google.common.collect.Sets;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.FilenameUtils;
import org.apache.commons.io.filefilter.DirectoryFileFilter;
import org.apache.commons.io.filefilter.TrueFileFilter;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.lang.builder.ToStringBuilder;
import org.apache.maven.plugin.logging.Log;

/**
 * Reads directory recursively to put collated file information such as
 * relative paths, name (without extension) and a reference to the {@link File} itself.
 * 
 *
 * @author David Green
 */
public class DirectoryReader {

    private final Log log;
    private final String pathSeparator;
    private final List filesToIgnore;

    public DirectoryReader(final Log log, final String pathSeparator, final List filenamesToIgnore) {
        this.log = log;
        this.pathSeparator = pathSeparator;
        this.filesToIgnore = processFilesToIgnore(filenamesToIgnore);
    }

    private boolean isFileToIgnore(File file) {
        for (File f : filesToIgnore) {
            if (StringUtils.startsWith(file.getAbsolutePath(), f.getAbsolutePath())) {
                log.debug("Matched prefix so will ignore: \n" + file.getAbsolutePath() + "\n" + f.getAbsolutePath());
                return true;
            } else {
                log.debug("Not same: \n" + file.getAbsolutePath() + "\n" + f.getAbsolutePath());
            }
        }
        return false;
    }

    /**
     * Read directory creating FileInfo for each file found, include sub-directories.
     */
    public List readFiles(final String path) throws IOException, InstantiationException, IllegalAccessException {
        log.debug("Scanning directory: " + path);
        final File directory = new File(path);
        final Collection allFiles = getAllFiles(directory);
        if (allFiles.isEmpty()) {
            log.warn("No files found in directory: " + path);
        }
        final List allFilesInfo = new ArrayList(allFiles.size());
        final String canonicalBaseDirectory = directory.getCanonicalPath();
        for (final File file : allFiles) {
            final FileInfo fileInfo = new FileInfo(file);
            // Remove base directory to derive sub-directory
            final String canonicalFilePath = FilenameUtils.getFullPathNoEndSeparator(file.getCanonicalPath());
            final String subDirectory = FilenameUtils.normalize(StringUtils.replaceOnce(canonicalFilePath, canonicalBaseDirectory, "") + pathSeparator);
            fileInfo.setRelativeSubDirectory(subDirectory);
            allFilesInfo.add(fileInfo);
        }
        return allFilesInfo;
    }

    @SuppressWarnings("rawtypes")
    private Collection getAllFiles(final File directory) {
        final Collection files = Lists.newLinkedList();
        if (!directory.exists()) {
            log.warn("Directory does not exist: " + directory.getPath());
            return files;
        }
        final Collection allFiles = FileUtils.listFiles(directory, TrueFileFilter.TRUE, DirectoryFileFilter.DIRECTORY);
        for (final Object o : allFiles) {
            if (o == null) {
                continue;
            }
            if (o instanceof File) {
                final File file = (File) o;
                if (isFileToIgnore(file)) {
                    log.info("Ignoring: " + file.toString());
                } else {
                    log.debug("Adding file: " + file.toString());
                    files.add(file);
                }
            } else {
                log.warn("Not a file: " + ToStringBuilder.reflectionToString(o));
            }
        }
        return files;
    }

    private List processFilesToIgnore(final List filesToIgnore) {
        final List templatesIgnored = Lists.newLinkedList();
        if (filesToIgnore == null || filesToIgnore.isEmpty()) {
            return templatesIgnored;
        }
        for (String templateToIgnore : Sets.newTreeSet(filesToIgnore)) {
            if (StringUtils.isNotBlank(templateToIgnore)) {
                templateToIgnore = FilenameUtils.separatorsToSystem(FilenameUtils.normalize(templateToIgnore));
                final File file = new File(templateToIgnore);
                if (file.exists()) {
                    log.debug("Adding ignore for file: " + file.getAbsolutePath());
                    templatesIgnored.add(file);
                }
            }
        }
        return templatesIgnored;
    }
}