org.apache.myfaces.tobago.maven.plugin.IndexThemeMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tobago-theme-plugin Show documentation
There is a newer version: 3.0.0-alpha-7
/*
 * 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.
 */

package org.apache.myfaces.tobago.maven.plugin;

import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.codehaus.plexus.util.DirectoryScanner;
import org.codehaus.plexus.util.FileUtils;

import java.io.BufferedWriter;
import java.io.File;
import java.io.IOException;
import java.io.StringWriter;

@Mojo(name = "index", defaultPhase = LifecyclePhase.PREPARE_PACKAGE)
public class IndexThemeMojo extends AbstractThemeMojo {

  private static final char FILE_SEPARATOR = System.getProperty("file.separator").charAt(0);
  private static final boolean FILE_SEPARATOR_IS_SLASH = FILE_SEPARATOR == '/';

  private static final String[] EXCLUDES = new String[]{
    "META-INF/**/*",
    "**/*.class"
  };

  /**
   * Directory containing the resource files that should be listed into the tobago-resources.properties.
   */
  @Parameter(defaultValue = "${project.build.outputDirectory}", required = true)
  private File outputDirectory;

  /**
   * Index file.
   */
  @Parameter(defaultValue = "${project.build.outputDirectory}/META-INF/tobago-resource-index.txt", required = true)
  private File tobagoResourcesFile;

  public void execute() {
    if ("pom".equalsIgnoreCase(getProject().getPackaging())) {
      getLog().info("Not creating " + tobagoResourcesFile.getName() + " as the project is a pom package");
      return;
    }
    if (getLog().isDebugEnabled()) {
      getLog().debug("Scanning resource: " + outputDirectory.getName());
    }

    if (!outputDirectory.isAbsolute()) {
      outputDirectory = new File(getProject().getBasedir(), outputDirectory.getPath());
    }
    if (!outputDirectory.exists()) {
      getLog().info("Not creating " + tobagoResourcesFile.getName() + " as the project has no outputDirectory");
      return;
    }
    final StaleCheckDirectoryScanner scanner = new StaleCheckDirectoryScanner(tobagoResourcesFile.lastModified());
    scanner.setBasedir(outputDirectory);
    scanner.setIncludes(getIncludes());
    scanner.setExcludes(getExcludes());
    scanner.scan();

    final String[] fileNames = scanner.getIncludedFiles();
    if (fileNames == null || fileNames.length == 0) {
      getLog().info("Skipping create resource file " + tobagoResourcesFile.getName() + ". No resources found");
      return;
    }

    if (!scanner.isUp2date) {
      final File metaInf = tobagoResourcesFile.getParentFile();
      if (!metaInf.exists()) {
        if (!metaInf.mkdirs()) {
          getLog().error("Error creating directory " + metaInf.getName());
        }
      }
      final StringWriter stringWriter = new StringWriter();
      try (BufferedWriter bufferedWriter = new BufferedWriter(stringWriter)) {
        for (final String file : fileNames) {
          bufferedWriter.append('/');
          if (FILE_SEPARATOR_IS_SLASH) {
            bufferedWriter.append(file);
          } else {
            bufferedWriter.append(convertFileSeparatorToSlash(file));
          }
          bufferedWriter.newLine();
        }
        bufferedWriter.flush();
        FileUtils.fileWrite(tobagoResourcesFile, "utf-8", stringWriter.toString());
      } catch (final IOException e) {
        getLog().error("Error creating resource file " + tobagoResourcesFile.getName(), e);
      }
    } else {
      getLog().info("Skipping create resource file " + tobagoResourcesFile.getName());
    }
  }

  private String convertFileSeparatorToSlash(String file) {
    return file.replace(FILE_SEPARATOR, '/');
  }

  public String[] getExcludes() {
    return EXCLUDES;
  }

  private static class StaleCheckDirectoryScanner extends DirectoryScanner {
    private final long lastModified;
    private boolean isUp2date = true;

    private StaleCheckDirectoryScanner(final long lastModified) {
      this.lastModified = lastModified;
    }

    @Override
    protected boolean isSelected(final String name, final File file) {
      if (file.lastModified() > this.lastModified) {
        isUp2date = false;
      }
      return super.isSelected(name, file);
    }
  }
}