/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* See LICENSE.txt included in this distribution for the specific
* language governing permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at LICENSE.txt.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright (c) 2007, 2017, Oracle and/or its affiliates. All rights reserved.
*/
package org.opensolaris.opengrok.history;
import java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.text.DateFormat;
import java.text.ParseException;
import java.util.ArrayList;
import java.util.List;
import java.util.logging.Logger;
import java.util.regex.Pattern;
import org.opensolaris.opengrok.configuration.RuntimeEnvironment;
import org.opensolaris.opengrok.logger.LoggerFactory;
import org.opensolaris.opengrok.util.Executor;
import org.opensolaris.opengrok.util.StringUtils;
/**
* Parse a stream of Git log comments.
*/
class GitHistoryParser implements Executor.StreamHandler {
private static final Logger LOGGER = LoggerFactory.getLogger(GitHistoryParser.class);
private enum ParseState {
HEADER, MESSAGE, FILES
}
private String myDir;
private GitRepository repository = new GitRepository();
private List<HistoryEntry> entries = new ArrayList<>();
/**
* Process the output from the log command and insert the HistoryEntries
* into the history field.
*
* @param input The output from the process
* @throws java.io.IOException If an error occurs while reading the stream
*/
@Override
public void processStream(InputStream input) throws IOException {
try (BufferedReader in = new BufferedReader(repository.newLogReader(input))) {
process(in);
}
}
private void process(BufferedReader in) throws IOException {
DateFormat df = repository.getDateFormat();
RuntimeEnvironment env = RuntimeEnvironment.getInstance();
entries = new ArrayList<>();
HistoryEntry entry = null;
ParseState state = ParseState.HEADER;
String s = in.readLine();
while (s != null) {
if (state == ParseState.HEADER) {
if (s.startsWith("commit")) {
if (entry != null) {
entries.add(entry);
}
entry = new HistoryEntry();
entry.setActive(true);
String commit = s.substring("commit".length()).trim();
entry.setRevision(commit);
} else if (s.startsWith("Author:") && entry != null) {
entry.setAuthor(s.substring("Author:".length()).trim());
} else if (s.startsWith("AuthorDate:") && entry != null) {
String dateString =
s.substring("AuthorDate:".length()).trim();
try {
entry.setDate(df.parse(dateString));
} catch (ParseException pe) {
//
// Overriding processStream() thus need to comply with the
// set of exceptions it can throw.
//
throw new IOException("Failed to parse author date: " + s, pe);
}
} else if (StringUtils.isOnlyWhitespace(s)) {
// We are done reading the heading, start to read the message
state = ParseState.MESSAGE;
// The current line is empty - the message starts on the next line (to be parsed below).
s = in.readLine();
}
}
if (state == ParseState.MESSAGE) {
if ((s.length() == 0) || Character.isWhitespace(s.charAt(0))) {
if (entry != null) {
entry.appendMessage(s);
}
} else {
// This is the list of files after the message - add them
state = ParseState.FILES;
}
}
if (state == ParseState.FILES) {
if (StringUtils.isOnlyWhitespace(s) || s.startsWith("commit")) {
state = ParseState.HEADER;
continue; // Parse this line again - do not read a new line
}
if (entry != null) {
try {
File f = new File(myDir, s);
entry.addFile(env.getPathRelativeToSourceRoot(f, 0));
} catch (FileNotFoundException e) { //NOPMD
// If the file is not located under the source root,
// ignore it (bug #11664).
}
}
}
s = in.readLine();
}
if (entry != null) {
entries.add(entry);
}
}
/**
* Parse the history for the specified file.
*
* @param file the file to parse history for
* @param repos Pointer to the GitRepository
* @param sinceRevision the oldest changeset to return from the executor, or
* {@code null} if all changesets should be returned
* @return object representing the file's history
*/
History parse(File file, Repository repos, String sinceRevision) throws HistoryException {
myDir = repos.getDirectoryName() + File.separator;
repository = (GitRepository) repos;
RenamedFilesParser parser = new RenamedFilesParser();
try {
Executor executor = repository.getHistoryLogExecutor(file, sinceRevision);
int status = executor.exec(true, this);
if (status != 0) {
throw new HistoryException(
String.format("Failed to get history for: \"%s\" Exit code: %d",
file.getAbsolutePath(),
status));
}
if (RuntimeEnvironment.getInstance().isHandleHistoryOfRenamedFiles()) {
executor = repository.getRenamedFilesExecutor(file, sinceRevision);
status = executor.exec(true, parser);
if (status != 0) {
throw new HistoryException(
String.format("Failed to get renamed files for: \"%s\" Exit code: %d",
file.getAbsolutePath(),
status));
}
}
} catch (IOException e) {
throw new HistoryException(
String.format("Failed to get history for: \"%s\"", file.getAbsolutePath()),
e);
}
return new History(entries, parser.getRenamedFiles());
}
/**
* Parse the given string.
*
* @param buffer The string to be parsed
* @return The parsed history
* @throws IOException if we fail to parse the buffer
*/
History parse(String buffer) throws IOException {
myDir = RuntimeEnvironment.getInstance().getSourceRootPath();
processStream(new ByteArrayInputStream(buffer.getBytes("UTF-8")));
return new History(entries);
}
/**
* Class for handling renamed files stream.
*/
private class RenamedFilesParser implements Executor.StreamHandler {
private final List<String> renamedFiles = new ArrayList<>();
@Override
public void processStream(InputStream input) throws IOException {
/*
* Commands to create the git repository:
*
* $ git init
* $ touch main.c
* $ touch foo.f
* $ touch foo2.f
* $ nano main.c # - add some lines
* $ git add . && git commit -m "first"
* $ mkdir moved
* $ mv main.c moved/
* $ git add . && git commit -m "second"
* $ nano moved/main.c # - change/add some lines
* $ git add . && git commit -m "third"
* $ mv moved/main.c moved/movedmain.c
* $ git add . && git commit -m "moved main"
* $ nano moved/movedmain.c # - change/add some lines
* $ git add . && git commit -m "changing some lines"
*
*
* Expected output format for this repository:
*
* 520b0dd changing some lines
* M moved/movedmain.c
*
* 07a8318 moved main
* R100 moved/main.c moved/movedmain.c
*
* e934333 third
* M moved/main.c
*
* 1ee21eb second
* R100 main.c moved/main.c
*
* 50bb0d3 first
* A foo.f
* A foo2.f
* A main.c
*/
RuntimeEnvironment env = RuntimeEnvironment.getInstance();
try (BufferedReader in = new BufferedReader(new InputStreamReader(input))) {
String line;
Pattern pattern = Pattern.compile("^R\\d+\\s.*");
while ((line = in.readLine()) != null) {
if (pattern.matcher(line).matches()) {
String[] parts = line.split("\t");
if (parts.length < 3
|| parts[1].length() <= 0
|| renamedFiles.contains(parts[1])) {
continue;
}
renamedFiles.add(parts[2]);
}
}
}
}
/**
* @return renamed files for this repository
*/
public List<String> getRenamedFiles() {
return renamedFiles;
}
}
}