/*
    * 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.logging.log4j.core.filter;
  
  import java.util.ArrayList;
  import java.util.Arrays;
  import java.util.Collections;
  import java.util.Iterator;
  import java.util.List;
  
  import org.apache.logging.log4j.Level;
  import org.apache.logging.log4j.Marker;
  import org.apache.logging.log4j.core.AbstractLifeCycle;
  import org.apache.logging.log4j.core.Filter;
  import org.apache.logging.log4j.core.LogEvent;
  import org.apache.logging.log4j.core.Logger;
  import org.apache.logging.log4j.core.config.Node;
  import org.apache.logging.log4j.core.config.plugins.Plugin;
  import org.apache.logging.log4j.core.config.plugins.PluginElement;
  import org.apache.logging.log4j.core.config.plugins.PluginFactory;
  import org.apache.logging.log4j.message.Message;
  
  /**
   * Composes and invokes one or more filters.
   */
  @Plugin(name = "filters", category = Node.CATEGORY, printObject = true)
  public final class CompositeFilter extends AbstractLifeCycle implements Iterable<Filter>, Filter {
  
      private static final long serialVersionUID = 1L;
  
      private final List<Filter> filters;
  
      private CompositeFilter() {
          this.filters = new ArrayList<Filter>();
      }
  
      private CompositeFilter(final List<Filter> filters) {
          if (filters == null) {
              this.filters = Collections.unmodifiableList(new ArrayList<Filter>());
              return;
          }
          this.filters = Collections.unmodifiableList(filters);
      }
  
      public CompositeFilter addFilter(final Filter filter) {
          if (filter == null) {
              // null does nothing
              return this;
          }
          final List<Filter> filterList = new ArrayList<Filter>(this.filters);
          filterList.add(filter);
          return new CompositeFilter(Collections.unmodifiableList(filterList));
      }
  
      public CompositeFilter removeFilter(final Filter filter) {
          if (filter == null) {
              // null does nothing
              return this;
          }
          final List<Filter> filterList = new ArrayList<Filter>(this.filters);
          filterList.remove(filter);
          return new CompositeFilter(Collections.unmodifiableList(filterList));
      }
  
      @Override
      public Iterator<Filter> iterator() {
          return filters.iterator();
      }
  
      public List<Filter> getFilters() {
          return filters;
      }
  
      /**
       * Returns whether this composite contains any filters.
       *
       * @return whether this composite contains any filters.
       */
      public boolean isEmpty() {
          return this.filters.isEmpty();
      }
  
      public int size() {
          return filters.size();
      }
 
     @Override
     public void start() {
         this.setStarting();
         for (final Filter filter : filters) {
             filter.start();
         }
         this.setStarted();
     }
 
     @Override
     public void stop() {
         this.setStopping();
         for (final Filter filter : filters) {
             filter.stop();
         }
         this.setStopped();
     }
 
     /**
      * Returns the result that should be returned when the filter does not match the event.
      *
      * @return the Result that should be returned when the filter does not match the event.
      */
     @Override
     public Result getOnMismatch() {
         return Result.NEUTRAL;
     }
 
     /**
      * Returns the result that should be returned when the filter matches the event.
      *
      * @return the Result that should be returned when the filter matches the event.
      */
     @Override
     public Result getOnMatch() {
         return Result.NEUTRAL;
     }
 
     /**
      * Filter an event.
      *
      * @param logger
      *            The Logger.
      * @param level
      *            The event logging Level.
      * @param marker
      *            The Marker for the event or null.
      * @param msg
      *            String text to filter on.
      * @param params
      *            An array of parameters or null.
      * @return the Result.
      */
     @Override
     public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
                          final Object... params) {
         Result result = Result.NEUTRAL;
         for (final Filter filter : filters) {
             result = filter.filter(logger, level, marker, msg, params);
             if (result == Result.ACCEPT || result == Result.DENY) {
                 return result;
             }
         }
         return result;
     }
 
     /**
      * Filter an event.
      *
      * @param logger
      *            The Logger.
      * @param level
      *            The event logging Level.
      * @param marker
      *            The Marker for the event or null.
      * @param msg
      *            Any Object.
      * @param t
      *            A Throwable or null.
      * @return the Result.
      */
     @Override
     public Result filter(final Logger logger, final Level level, final Marker marker, final Object msg,
                          final Throwable t) {
         Result result = Result.NEUTRAL;
         for (final Filter filter : filters) {
             result = filter.filter(logger, level, marker, msg, t);
             if (result == Result.ACCEPT || result == Result.DENY) {
                 return result;
             }
         }
         return result;
     }
 
     /**
      * Filter an event.
      *
      * @param logger
      *            The Logger.
      * @param level
      *            The event logging Level.
      * @param marker
      *            The Marker for the event or null.
      * @param msg
      *            The Message
      * @param t
      *            A Throwable or null.
      * @return the Result.
      */
     @Override
     public Result filter(final Logger logger, final Level level, final Marker marker, final Message msg,
                          final Throwable t) {
         Result result = Result.NEUTRAL;
         for (final Filter filter : filters) {
             result = filter.filter(logger, level, marker, msg, t);
             if (result == Result.ACCEPT || result == Result.DENY) {
                 return result;
             }
         }
         return result;
     }
 
     /**
      * Filter an event.
      *
      * @param event
      *            The Event to filter on.
      * @return the Result.
      */
     @Override
     public Result filter(final LogEvent event) {
         Result result = Result.NEUTRAL;
         for (final Filter filter : filters) {
             result = filter.filter(event);
             if (result == Result.ACCEPT || result == Result.DENY) {
                 return result;
             }
         }
         return result;
     }
 
     @Override
     public String toString() {
         final StringBuilder sb = new StringBuilder();
         for (final Filter filter : filters) {
             if (sb.length() == 0) {
                 sb.append('{');
             } else {
                 sb.append(", ");
             }
             sb.append(filter.toString());
         }
         if (sb.length() > 0) {
             sb.append('}');
         }
         return sb.toString();
     }
 
     /**
      * Create a CompositeFilter.
      *
      * @param filters
      *            An array of Filters to call.
      * @return The CompositeFilter.
      */
     @PluginFactory
     public static CompositeFilter createFilters(@PluginElement("Filters") final Filter[] filters) {
         final List<Filter> filterList = filters == null || filters.length == 0 ?
             new ArrayList<Filter>() : Arrays.asList(filters);
         return new CompositeFilter(filterList);
     }
 
 }