com.google.code.mojo.license.document.Document Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of maven-license-plugin Show documentation
Maven 2 plugin to check and update license headers in source files
There is a newer version: 1.10.b1
/**
 * Copyright (C) 2008 http://code.google.com/p/maven-license-plugin/
 *
 * 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.google.code.mojo.license.document;

import com.google.code.mojo.license.header.Header;
import com.google.code.mojo.license.header.HeaderDefinition;
import com.google.code.mojo.license.header.HeaderParser;
import com.google.code.mojo.license.header.HeaderType;
import com.google.code.mojo.license.util.FileContent;
import com.google.code.mojo.license.util.FileUtils;

import java.io.File;
import java.io.IOException;

import static com.google.code.mojo.license.util.FileUtils.*;

/**
 * Date: 16-Feb-2008
 Author: Mathieu Carbou ([email protected])
 */
public final class Document {
    private final File file;
    private final HeaderDefinition headerDefinition;
    private final String encoding;
    private final String[] keywords;
    private HeaderParser parser;

    public Document(File file, HeaderDefinition headerDefinition, String encoding, String[] keywords) {
        this.keywords = keywords.clone();
        this.file = file;
        this.headerDefinition = headerDefinition;
        this.encoding = encoding;
    }

    public HeaderDefinition getHeaderDefinition() {
        return headerDefinition;
    }

    public File getFile() {
        return file;
    }

    public String 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", " ");
                return fileHeaderOneLine.contains(remove(header.asOneLineString(), headerDefinition.getFirstLine().trim(), headerDefinition.getEndLine().trim(), headerDefinition.getBeforeEachLine().trim()));
            }
            catch (IOException e) {
                throw new IllegalStateException("Cannot read file " + getFile() + ". Cause: " + e.getMessage(), e);
            }
        } else {
            try {
                String fileHeader = readFirstLines(file, header.getLineCount() + 10, encoding).replaceAll(" *\r?\n", "\n");
                String expected = header.buildForDefinition(headerDefinition, true);
                return fileHeader.contains(expected);
            }
            catch (IOException e) {
                throw new IllegalStateException("Cannot read file " + getFile() + ". Cause: " + e.getMessage(), e);
            }
        }
    }

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

    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 " + getFile() + ". 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().sameFile(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 " + getFile();
    }
}