com.mycila.maven.plugin.license.document.Document Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of license-maven-plugin Show documentation
Maven 2 plugin to check and update license headers in source files
The newest version!
/*
 * Copyright (C) 2008-2024 Mycila ([email protected])
 *
 * 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
 *
 *         https://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.mycila.maven.plugin.license.document;

import com.mycila.maven.plugin.license.header.Header;
import com.mycila.maven.plugin.license.header.HeaderDefinition;
import com.mycila.maven.plugin.license.header.HeaderParser;
import com.mycila.maven.plugin.license.header.HeaderType;
import com.mycila.maven.plugin.license.util.FileContent;
import com.mycila.maven.plugin.license.util.FileUtils;

import java.io.File;
import java.io.IOException;
import java.nio.charset.Charset;

import static com.mycila.maven.plugin.license.util.FileUtils.readFirstLines;
import static com.mycila.maven.plugin.license.util.FileUtils.remove;

public final class Document {
  private final File file;
  private final String filePath;
  private final HeaderDefinition headerDefinition;
  private final Charset encoding;
  private final String[] keywords;
  private final DocumentPropertiesLoader documentPropertiesLoader;
  private final PropertyPlaceholderResolver placeholderResolver = new PropertyPlaceholderResolver();
  private HeaderParser parser;


  public Document(File file, HeaderDefinition headerDefinition, Charset encoding, String[] keywords, DocumentPropertiesLoader documentPropertiesLoader) {
    this.keywords = keywords.clone();
    this.file = file;
    this.filePath = file.getPath().replace('\\', '/');
    this.headerDefinition = headerDefinition;
    this.encoding = encoding;
    this.documentPropertiesLoader = documentPropertiesLoader;
  }

  public HeaderDefinition getHeaderDefinition() {
    return headerDefinition;
  }

  public File getFile() {
    return file;
  }

  public String getFilePath() {
    return filePath;
  }

  public Charset getEncoding() {
    return encoding;
  }

  public boolean isNotSupported() {
    return headerDefinition == null || HeaderType.UNKNOWN.getDefinition().getType().equals(headerDefinition.getType());
  }

  public boolean hasHeader(Header header, boolean strictCheck) {
    if (!strictCheck) {
      try {
        String fileHeader = readFirstLines(file, header.getLineCount() + 10, encoding);
        String fileHeaderOneLine = remove(fileHeader, headerDefinition.getFirstLine().trim(), headerDefinition.getEndLine().trim(), headerDefinition.getBeforeEachLine().trim(), "\n", "\r", "\t", " ");
        String headerOnOnelIne = mergeProperties(header.asOneLineString());
        return fileHeaderOneLine.contains(remove(headerOnOnelIne, headerDefinition.getFirstLine().trim(), headerDefinition.getEndLine().trim(), headerDefinition.getBeforeEachLine().trim()));
      } catch (IOException e) {
        throw new IllegalStateException("Cannot read file " + filePath + ". Cause: " + e.getMessage(), e);
      }
    }
    try {
      return header.isMatchForText(this, headerDefinition, true, encoding);
    } catch (IOException e) {
      throw new IllegalStateException("Cannot read file " + filePath + ". Cause: " + e.getMessage(), e);
    }
  }

  public void updateHeader(Header header) {
    String headerStr = header.applyDefinitionAndSections(parser.getHeaderDefinition(), parser.getFileContent().isUnix());
    parser.getFileContent().insert(parser.getBeginPosition(), mergeProperties(headerStr));
  }

  public String mergeProperties(String str) {
    return placeholderResolver.replacePlaceholders(str, documentPropertiesLoader.load(this));
  }

  public void save() {
    saveTo(file);
  }

  public void saveTo(File dest) {
    if (parser != null) {
      try {
        FileUtils.write(dest, parser.getFileContent().getContent(), encoding);
      } catch (IOException e) {
        throw new IllegalStateException("Cannot write new header in file " + filePath + ". Cause: " + e.getMessage(), e);
      }
    }
  }

  public String getContent() {
    return parser == null ? "" : parser.getFileContent().getContent();
  }

  public void removeHeader() {
    if (headerDetected()) {
      parser.getFileContent().delete(parser.getBeginPosition(), parser.getEndPosition());
    }
  }

  public boolean is(Header header) {
    try {
      return header.getLocation().isFromUrl(this.file.toURI().toURL());
    } catch (Exception e) {
      throw new IllegalStateException("Error comparing document " + this.file + " with file " + file + ". Cause: " + e.getMessage(), e);
    }
  }

  public void parseHeader() {
    if (parser == null) {
      parser = new HeaderParser(new FileContent(file, encoding), headerDefinition, keywords);
    }
  }

  public boolean headerDetected() {
    return parser.gotAnyHeader();
  }

  @Override
  public String toString() {
    return "Document " + filePath;
  }
}