info.fetter.logstashforwarder.FileWatcher.java Source code

Java tutorial

Introduction

Here is the source code for info.fetter.logstashforwarder.FileWatcher.java

Source

package info.fetter.logstashforwarder;

/*
 * Copyright 2015 Didier Fetter
 *
 * 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.
 *
 */

import info.fetter.logstashforwarder.util.AdapterException;
import info.fetter.logstashforwarder.util.LastModifiedFileFilter;

import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.apache.commons.io.FileUtils;
import org.apache.commons.io.FilenameUtils;
import org.apache.commons.io.filefilter.FileFilterUtils;
import org.apache.commons.io.filefilter.IOFileFilter;
import org.apache.commons.io.filefilter.WildcardFileFilter;
import org.apache.commons.io.monitor.FileAlterationObserver;
import org.apache.log4j.Logger;

public class FileWatcher {
    private static final Logger logger = Logger.getLogger(FileWatcher.class);
    private List<FileAlterationObserver> observerList = new ArrayList<FileAlterationObserver>();
    public static final int ONE_DAY = 24 * 3600 * 1000;
    private Map<File, FileState> oldWatchMap = new HashMap<File, FileState>();
    private Map<File, FileState> newWatchMap = new HashMap<File, FileState>();
    private FileState[] savedStates;
    private int maxSignatureLength;
    private boolean tail = false;
    private Event stdinFields;
    private boolean stdinConfigured = false;
    private String sincedbFile = null;

    public FileWatcher() {
    }

    public void initialize() throws IOException {
        logger.debug("Initializing FileWatcher");
        if (savedStates != null) {
            for (FileState state : savedStates) {
                logger.info("Loading file state: " + state.getFile() + ":" + state.getPointer());
                oldWatchMap.put(state.getFile(), state);
            }
        }
        processModifications();
        if (tail) {
            for (FileState state : oldWatchMap.values()) {
                if (state.getPointer() == 0) {
                    state.setPointer(state.getSize());
                }
            }
        }
        printWatchMap();
    }

    public void addFilesToWatch(String fileToWatch, Event fields, int deadTime) {
        try {
            if (fileToWatch.equals("-")) {
                addStdIn(fields);
            } else if (fileToWatch.contains("*")) {
                addWildCardFiles(fileToWatch, fields, deadTime);
            } else {
                addSingleFile(fileToWatch, fields, deadTime);
            }
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    public void checkFiles() throws IOException {
        logger.trace("Checking files");
        logger.trace("==============");
        for (FileAlterationObserver observer : observerList) {
            observer.checkAndNotify();
        }
        processModifications();
        printWatchMap();
    }

    public int readFiles(FileReader reader) throws IOException, AdapterException {
        logger.trace("Reading files");
        logger.trace("==============");
        int numberOfLinesRead = reader.readFiles(oldWatchMap.values());
        Registrar.writeStateToJson(sincedbFile, oldWatchMap.values());
        return numberOfLinesRead;
    }

    public int readStdin(InputReader reader) throws AdapterException, IOException {
        if (stdinConfigured) {
            logger.debug("Reading stdin");
            reader.setFields(stdinFields);
            int numberOfLinesRead = reader.readInput();
            return numberOfLinesRead;
        } else {
            return 0;
        }
    }

    private void processModifications() throws IOException {

        for (File file : newWatchMap.keySet()) {
            FileState state = newWatchMap.get(file);
            if (logger.isTraceEnabled()) {
                logger.trace("Checking file : " + file.getCanonicalPath());
                logger.trace("-- Last modified : " + state.getLastModified());
                logger.trace("-- Size : " + state.getSize());
                logger.trace("-- Directory : " + state.getDirectory());
                logger.trace("-- Filename : " + state.getFileName());
            }

            logger.trace("Determine if file has just been written to");
            FileState oldState = oldWatchMap.get(file);
            if (oldState != null) {
                if (oldState.getSize() > state.getSize()) {
                    logger.trace("File shorter : file can't be the same");
                } else {
                    if (oldState.getSignatureLength() == state.getSignatureLength()
                            && oldState.getSignature() == state.getSignature()) {
                        state.setOldFileState(oldState);
                        logger.trace("Same signature size and value : file is the same");
                        continue;
                    } else if (oldState.getSignatureLength() < state.getSignatureLength()) {
                        long signature = FileSigner.computeSignature(state.getRandomAccessFile(),
                                oldState.getSignatureLength());
                        if (signature == oldState.getSignature()) {
                            state.setOldFileState(oldState);
                            logger.trace("Same signature : file is the same");
                            continue;
                        } else {
                            logger.trace("Signature different : file can't be the same");
                        }
                    } else if (oldState.getSignatureLength() > state.getSignatureLength()) {
                        logger.trace("Signature shorter : file can't be the same");
                    }
                }
            }

            if (state.getOldFileState() == null) {
                logger.trace("Determine if file has been renamed and/or written to");
                for (File otherFile : oldWatchMap.keySet()) {
                    FileState otherState = oldWatchMap.get(otherFile);
                    if (otherState != null && state.getSize() >= otherState.getSize()
                            && state.getDirectory().equals(otherState.getDirectory())) {
                        if (logger.isTraceEnabled()) {
                            logger.trace("Comparing to : " + otherFile.getCanonicalPath());
                        }
                        if (otherState.getSignatureLength() == state.getSignatureLength()
                                && otherState.getSignature() == state.getSignature()) {
                            state.setOldFileState(otherState);
                            logger.trace("Same signature size and value : file is the same");
                            break;
                        } else if (otherState.getSignatureLength() < state.getSignatureLength()) {
                            long signature = FileSigner.computeSignature(state.getRandomAccessFile(),
                                    otherState.getSignatureLength());
                            if (signature == otherState.getSignature()) {
                                state.setOldFileState(otherState);
                                logger.trace("Same signature : file is the same");
                                break;
                            } else {
                                logger.trace("Signature different : file can't be the same");
                            }
                        } else if (otherState.getSignatureLength() > state.getSignatureLength()) {
                            logger.trace("Signature shorter : file can't be the same");
                        }
                    }
                }
            }
        }

        for (FileState state : newWatchMap.values()) {
            if (logger.isTraceEnabled()) {
                logger.trace("Refreshing file state: " + state.getFile());
            }
            FileState oldState = state.getOldFileState();
            if (oldState == null) {
                if (logger.isDebugEnabled()) {
                    logger.debug(
                            "File " + state.getFile() + " has been truncated or created, not retrieving pointer");
                }
                oldState = oldWatchMap.get(state.getFile());
                if (oldState != null && !oldState.isMatchedToNewFile()) {
                    if (logger.isDebugEnabled()) {
                        logger.debug("File " + state.getFile()
                                + " has been replaced and not renamed, removing from watchMap");
                    }
                    try {
                        oldState.getRandomAccessFile().close();
                    } catch (Exception e) {
                    }
                    oldWatchMap.remove(state.getFile());
                }
            } else {
                if (logger.isInfoEnabled() && !state.getFileName().equals(oldState.getFileName())) {
                    logger.info("File rename was detected: " + oldState.getFile() + " -> " + state.getFile());
                }
                if (logger.isDebugEnabled()) {
                    logger.debug("File " + state.getFile()
                            + " has not been truncated or created, retrieving pointer: " + oldState.getPointer());
                }
                state.setPointer(oldState.getPointer());
                state.deleteOldFileState();
            }
        }

        logger.trace("Replacing old state");
        for (File file : newWatchMap.keySet()) {
            FileState state = newWatchMap.get(file);
            oldWatchMap.put(file, state);
        }

        // Truncating changedWatchMap
        newWatchMap.clear();

        removeMarkedFilesFromWatchMap();
    }

    private void addSingleFile(String fileToWatch, Event fields, int deadTime) throws Exception {
        logger.info("Watching file : " + new File(fileToWatch).getCanonicalPath());
        String directory = FilenameUtils.getFullPath(fileToWatch);
        String fileName = FilenameUtils.getName(fileToWatch);
        IOFileFilter fileFilter = FileFilterUtils.and(FileFilterUtils.fileFileFilter(),
                FileFilterUtils.nameFileFilter(fileName), new LastModifiedFileFilter(deadTime));
        initializeWatchMap(new File(directory), fileFilter, fields);
    }

    private void addWildCardFiles(String filesToWatch, Event fields, int deadTime) throws Exception {
        logger.info("Watching wildcard files : " + filesToWatch);
        String directory = FilenameUtils.getFullPath(filesToWatch);
        String wildcard = FilenameUtils.getName(filesToWatch);
        logger.trace("Directory : " + new File(directory).getCanonicalPath() + ", wildcard : " + wildcard);
        IOFileFilter fileFilter = FileFilterUtils.and(FileFilterUtils.fileFileFilter(),
                new WildcardFileFilter(wildcard), new LastModifiedFileFilter(deadTime));
        initializeWatchMap(new File(directory), fileFilter, fields);
    }

    private void addStdIn(Event fields) {
        logger.error("Watching stdin");
        stdinFields = fields;
        stdinConfigured = true;
    }

    private void initializeWatchMap(File directory, IOFileFilter fileFilter, Event fields) throws Exception {
        if (!directory.isDirectory()) {
            logger.warn("Directory " + directory + " does not exist");
            return;
        }
        FileAlterationObserver observer = new FileAlterationObserver(directory, fileFilter);
        FileModificationListener listener = new FileModificationListener(this, fields);
        observer.addListener(listener);
        observerList.add(observer);
        observer.initialize();
        for (File file : FileUtils.listFiles(directory, fileFilter, null)) {
            addFileToWatchMap(newWatchMap, file, fields);
        }
    }

    private void addFileToWatchMap(Map<File, FileState> map, File file, Event fields) {
        try {
            FileState state = new FileState(file);
            state.setFields(fields);
            int signatureLength = (int) (state.getSize() > maxSignatureLength ? maxSignatureLength
                    : state.getSize());
            state.setSignatureLength(signatureLength);
            long signature = FileSigner.computeSignature(state.getRandomAccessFile(), signatureLength);
            state.setSignature(signature);
            logger.trace(
                    "Setting signature of size : " + signatureLength + " on file : " + file + " : " + signature);
            map.put(file, state);
        } catch (IOException e) {
            logger.error("Caught IOException : " + e.getMessage());
        }
    }

    public void onFileChange(File file, Event fields) {
        try {
            logger.debug("Change detected on file : " + file.getCanonicalPath());
            addFileToWatchMap(newWatchMap, file, fields);
        } catch (IOException e) {
            logger.error("Caught IOException : " + e.getMessage());
        }
    }

    public void onFileCreate(File file, Event fields) {
        try {
            logger.debug("Create detected on file : " + file.getCanonicalPath());
            addFileToWatchMap(newWatchMap, file, fields);
        } catch (IOException e) {
            logger.error("Caught IOException : " + e.getMessage());
        }
    }

    public void onFileDelete(File file) {
        try {
            logger.debug("Delete detected on file : " + file.getCanonicalPath());
            FileState state = oldWatchMap.get(file);
            if (state != null)
                state.setDeleted();
        } catch (IOException e) {
            logger.error("Caught IOException : " + e.getMessage());
        }
    }

    private void printWatchMap() throws IOException {
        if (logger.isTraceEnabled()) {
            logger.trace("WatchMap contents : ");
            for (File file : oldWatchMap.keySet()) {
                FileState state = oldWatchMap.get(file);
                logger.trace("\tFile : " + file.getCanonicalPath() + " marked for deletion : " + state.isDeleted());
            }
        }
    }

    private void removeMarkedFilesFromWatchMap() throws IOException {
        logger.trace("Removing deleted files from watchMap");
        List<File> markedList = null;
        for (File file : oldWatchMap.keySet()) {
            FileState state = oldWatchMap.get(file);
            if (state.getRandomAccessFile() == null) {
                state.setDeleted();
            }
            if (state.isDeleted()) {
                if (!file.exists()) {
                    if (markedList == null) {
                        markedList = new ArrayList<File>();
                    }
                    markedList.add(file);
                }
                try {
                    state.getRandomAccessFile().close();
                } catch (Exception e) {
                }
            }
        }
        if (markedList != null) {
            for (File file : markedList) {
                oldWatchMap.remove(file);
                logger.debug("File " + file + " removed from watchMap");
            }
        }
    }

    public void close() throws IOException {
        logger.debug("Closing all files");
        for (File file : oldWatchMap.keySet()) {
            FileState state = oldWatchMap.get(file);
            state.getRandomAccessFile().close();
        }
    }

    public int getMaxSignatureLength() {
        return maxSignatureLength;
    }

    public void setMaxSignatureLength(int maxSignatureLength) {
        this.maxSignatureLength = maxSignatureLength;
    }

    public void setTail(boolean tail) {
        this.tail = tail;
    }

    public void setSincedb(String sincedbFile) {
        this.sincedbFile = sincedbFile;
        try {
            logger.debug("Loading saved states");
            savedStates = Registrar.readStateFromJson(sincedbFile);
        } catch (Exception e) {
            logger.warn("Could not load saved states : " + e.getMessage(), e);
        }
    }

}