/*
    * 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.maven.plugins.checkstyle.exec;
  
  import java.io.File;
  import java.util.ArrayList;
  import java.util.List;
  
  import com.puppycrawl.tools.checkstyle.api.AuditEvent;
  import com.puppycrawl.tools.checkstyle.api.AuditListener;
  import com.puppycrawl.tools.checkstyle.api.AutomaticBean;
  import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
  import com.puppycrawl.tools.checkstyle.api.Configuration;
  import com.puppycrawl.tools.checkstyle.api.SeverityLevel;
  import org.apache.commons.lang3.StringUtils;
  
  /**
   * Listener in charge of receiving events from the Checker.
   *
   * @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
   * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
   *
   */
  public class CheckstyleCheckerListener extends AutomaticBean implements AuditListener {
      private final List<File> sourceDirectories;
  
      private CheckstyleResults results;
  
      private String currentFile;
  
      private List<AuditEvent> events;
  
      private SeverityLevel severityLevel;
  
      private Configuration checkstyleConfiguration;
  
      /**
       * @param sourceDirectory assume that is <code>sourceDirectory</code> is a not null directory and exists
       */
      public CheckstyleCheckerListener(File sourceDirectory) {
          this.sourceDirectories = new ArrayList<>();
          this.sourceDirectories.add(sourceDirectory);
      }
      /**
       * @param sourceDirectory assume that is <code>sourceDirectory</code> is a not null directory and exists
       * @param configuration Checkstyle configuration
       * @since 2.5
       */
      public CheckstyleCheckerListener(File sourceDirectory, Configuration configuration) {
          this.sourceDirectories = new ArrayList<>();
          this.sourceDirectories.add(sourceDirectory);
          this.checkstyleConfiguration = configuration;
      }
  
      /**
       * @param configuration Checkstyle configuration
       * @since 2.5
       */
      public CheckstyleCheckerListener(Configuration configuration) {
          this.sourceDirectories = new ArrayList<>();
          this.checkstyleConfiguration = configuration;
      }
  
      /**
       * @param sourceDirectory assume that is <code>sourceDirectory</code> is a not null directory and exists
       */
      public void addSourceDirectory(File sourceDirectory) {
          this.sourceDirectories.add(sourceDirectory);
      }
  
      /**
       * @param severityLevel The severity level of the events to listen to.
       */
      public void setSeverityLevelFilter(SeverityLevel severityLevel) {
          this.severityLevel = severityLevel;
      }
  
      /**
       * @return The severity level of the events to listen to.
       */
      public SeverityLevel getSeverityLevelFilter() {
          return severityLevel;
      }
 
     /** {@inheritDoc} */
     @Override
     public void auditStarted(AuditEvent event) {
         setResults(new CheckstyleResults());
     }
 
     /** {@inheritDoc} */
     @Override
     public void auditFinished(AuditEvent event) {
         // do nothing
     }
 
     /** {@inheritDoc} */
     @Override
     public void fileStarted(AuditEvent event) {
         final String fileName = StringUtils.replace(event.getFileName(), "\\", "/");
 
         for (File sourceDirectory : sourceDirectories) {
             String sourceDirectoryPath = StringUtils.replace(sourceDirectory.getPath(), "\\", "/");
 
             if (fileName.startsWith(sourceDirectoryPath + "/")) {
                 currentFile = StringUtils.substring(fileName, sourceDirectoryPath.length() + 1);
 
                 events = getResults().getFileViolations(currentFile);
 
                 break;
             }
         }
 
         if (events == null) {
             events = new ArrayList<>();
         }
     }
 
     /** {@inheritDoc} */
     @Override
     public void fileFinished(AuditEvent event) {
         getResults().setFileViolations(currentFile, events);
         currentFile = null;
     }
 
     /** {@inheritDoc} */
     @Override
     public void addError(AuditEvent event) {
         if (SeverityLevel.IGNORE.equals(event.getSeverityLevel())) {
             return;
         }
 
         if (severityLevel == null || severityLevel.equals(event.getSeverityLevel())) {
             events.add(event);
         }
     }
 
     /** {@inheritDoc} */
     @Override
     public void addException(AuditEvent event, Throwable throwable) {
         // Do Nothing
     }
 
     /** {@inheritDoc} */
     @Override
     protected void finishLocalSetup() throws CheckstyleException {
         // Do Nothing
     }
 
     /**
      * @return The results of Checkstyle invocation.
      */
     public CheckstyleResults getResults() {
         results.setConfiguration(checkstyleConfiguration);
         return results;
     }
 
     /**
      * @param results The results of Checkstyle invocation.
      */
     public void setResults(CheckstyleResults results) {
         this.results = results;
     }
 
     /**
      * @since 2.5
      * @return The configuration of Checkstyle to use.
      */
     public Configuration getCheckstyleConfiguration() {
         return checkstyleConfiguration;
     }
 
     /**
      * @param checkstyleConfiguration The configuration of Checkstyle to use.
      * @since 2.5
      */
     public void setCheckstyleConfiguration(Configuration checkstyleConfiguration) {
         this.checkstyleConfiguration = checkstyleConfiguration;
     }
 }