/*
    * 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.appender;
  
  import java.io.IOException;
  import java.io.OutputStream;
  import java.io.PrintStream;
  import java.io.Serializable;
  import java.io.UnsupportedEncodingException;
  import java.lang.reflect.Constructor;
  import java.nio.charset.Charset;
  
  import org.apache.logging.log4j.core.Filter;
  import org.apache.logging.log4j.core.Layout;
  import org.apache.logging.log4j.core.config.plugins.Plugin;
  import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
  import org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute;
  import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;
  import org.apache.logging.log4j.core.config.plugins.PluginElement;
  import org.apache.logging.log4j.core.config.plugins.PluginFactory;
  import org.apache.logging.log4j.core.config.plugins.validation.constraints.Required;
  import org.apache.logging.log4j.core.layout.PatternLayout;
  import org.apache.logging.log4j.core.util.Booleans;
  import org.apache.logging.log4j.core.util.Loader;
  import org.apache.logging.log4j.util.PropertiesUtil;
  
  /**
   * ConsoleAppender appends log events to <code>System.out</code> or
   * <code>System.err</code> using a layout specified by the user. The
   * default target is <code>System.out</code>.
   * TODO accessing System.out or .err as a byte stream instead of a writer
   *    bypasses the JVM's knowledge of the proper encoding. (RG) Encoding
   * is handled within the Layout. Typically, a Layout will generate a String
   * and then call getBytes which may use a configured encoding or the system
   * default. OTOH, a Writer cannot print byte streams.
   */
  @Plugin(name = "Console", category = "Core", elementType = "appender", printObject = true)
  public final class ConsoleAppender extends AbstractOutputStreamAppender<OutputStreamManager> {
  
      private static final long serialVersionUID = 1L;
      private static final String JANSI_CLASS = "org.fusesource.jansi.WindowsAnsiOutputStream";
      private static ConsoleManagerFactory factory = new ConsoleManagerFactory();
      private static final Target DEFAULT_TARGET = Target.SYSTEM_OUT;
  
      /**
       * Enumeration of console destinations.
       */
      public enum Target {
          /** Standard output. */
          SYSTEM_OUT,
          /** Standard error output. */
          SYSTEM_ERR
      }
  
      private ConsoleAppender(final String name, final Layout<? extends Serializable> layout, final Filter filter,
                              final OutputStreamManager manager,
                              final boolean ignoreExceptions) {
          super(name, layout, filter, ignoreExceptions, true, manager);
      }
  
      /**
       * Create a Console Appender.
       * @param layout The layout to use (required).
       * @param filter The Filter or null.
       * @param targetStr The target ("SYSTEM_OUT" or "SYSTEM_ERR"). The default is "SYSTEM_OUT".
       * @param follow If true will follow changes to the underlying output stream.
       * @param name The name of the Appender (required).
       * @param ignore If {@code "true"} (default) exceptions encountered when appending events are logged; otherwise
       *               they are propagated to the caller.
       * @return The ConsoleAppender.
       */
      @PluginFactory
      public static ConsoleAppender createAppender(
              @PluginElement("Layout") Layout<? extends Serializable> layout,
              @PluginElement("Filter") final Filter filter,
              @PluginAttribute(value = "target", defaultString = "SYSTEM_OUT") final String targetStr,
              @PluginAttribute("name") final String name,
              @PluginAttribute(value = "follow", defaultBoolean = false) final String follow,
              @PluginAttribute(value = "ignoreExceptions", defaultBoolean = true) final String ignore) {
          if (name == null) {
              LOGGER.error("No name provided for ConsoleAppender");
              return null;
          }
          if (layout == null) {
              layout = PatternLayout.createDefaultLayout();
         }
         final boolean isFollow = Boolean.parseBoolean(follow);
         final boolean ignoreExceptions = Booleans.parseBoolean(ignore, true);
         final Target target = targetStr == null ? DEFAULT_TARGET : Target.valueOf(targetStr);
         return new ConsoleAppender(name, layout, filter, getManager(isFollow, target, layout), ignoreExceptions);
     }
 
     public static ConsoleAppender createDefaultAppenderForLayout(final Layout<? extends Serializable> layout) {
         // this method cannot use the builder class without introducing an infinite loop due to DefaultConfiguration
         return new ConsoleAppender("Console", layout, null, getManager(false, DEFAULT_TARGET, layout), true);
     }
 
     @PluginBuilderFactory
     public static Builder newBuilder() {
         return new Builder();
     }
 
     public static class Builder implements org.apache.logging.log4j.core.util.Builder<ConsoleAppender> {
 
         @PluginElement("Layout")
         @Required
         private Layout<? extends Serializable> layout = PatternLayout.createDefaultLayout();
 
         @PluginElement("Filter")
         private Filter filter;
 
         @PluginBuilderAttribute
         @Required
         private Target target = DEFAULT_TARGET;
 
         @PluginBuilderAttribute
         @Required
         private String name;
 
         @PluginBuilderAttribute
         private boolean follow = false;
 
         @PluginBuilderAttribute
         private boolean ignoreExceptions = true;
 
         public Builder setLayout(final Layout<? extends Serializable> layout) {
             this.layout = layout;
             return this;
         }
 
         public Builder setFilter(final Filter filter) {
             this.filter = filter;
             return this;
         }
 
         public Builder setTarget(final Target target) {
             this.target = target;
             return this;
         }
 
         public Builder setName(final String name) {
             this.name = name;
             return this;
         }
 
         public Builder setFollow(final boolean follow) {
             this.follow = follow;
             return this;
         }
 
         public Builder setIgnoreExceptions(final boolean ignoreExceptions) {
             this.ignoreExceptions = ignoreExceptions;
             return this;
         }
 
         @Override
         public ConsoleAppender build() {
             return new ConsoleAppender(name, layout, filter, getManager(follow, target, layout), ignoreExceptions);
         }
     }
 
     private static OutputStreamManager getManager(final boolean follow, final Target target, final Layout<? extends Serializable> layout) {
         final String type = target.name();
         final OutputStream os = getOutputStream(follow, target);
         return OutputStreamManager.getManager(target.name() + '.' + follow, new FactoryData(os, type, layout), factory);
     }
 
     private static OutputStream getOutputStream(final boolean follow, final Target target) {
         final String enc = Charset.defaultCharset().name();
         OutputStream outputStream = null;
         try {
             // @formatter:off
             outputStream = target == Target.SYSTEM_OUT ?
                 follow ? new PrintStream(new SystemOutStream(), true, enc) : System.out :
                 follow ? new PrintStream(new SystemErrStream(), true, enc) : System.err;
             // @formatter:on
             outputStream = new CloseShieldOutputStream(outputStream);
         } catch (final UnsupportedEncodingException ex) { // should never happen
             throw new IllegalStateException("Unsupported default encoding " + enc, ex);
         }
         final PropertiesUtil propsUtil = PropertiesUtil.getProperties();
         if (!propsUtil.getStringProperty("os.name").startsWith("Windows")
                 || propsUtil.getBooleanProperty("log4j.skipJansi")) {
             return outputStream;
         }
         try {
             // We type the parameter as a wildcard to avoid a hard reference to Jansi.
             final Class<?> clazz = Loader.loadClass(JANSI_CLASS);
             final Constructor<?> constructor = clazz.getConstructor(OutputStream.class);
             return new CloseShieldOutputStream((OutputStream) constructor.newInstance(outputStream));
         } catch (final ClassNotFoundException cnfe) {
             LOGGER.debug("Jansi is not installed, cannot find {}", JANSI_CLASS);
         } catch (final NoSuchMethodException nsme) {
             LOGGER.warn("{} is missing the proper constructor", JANSI_CLASS);
         } catch (final Exception ex) {
             LOGGER.warn("Unable to instantiate {}", JANSI_CLASS);
         }
         return outputStream;
     }
 
     /**
      * An implementation of OutputStream that redirects to the current System.err.
      */
     private static class SystemErrStream extends OutputStream {
         public SystemErrStream() {
         }
 
         @Override
         public void close() {
             // do not close sys err!
         }
 
         @Override
         public void flush() {
             System.err.flush();
         }
 
         @Override
         public void write(final byte[] b) throws IOException {
             System.err.write(b);
         }
 
         @Override
         public void write(final byte[] b, final int off, final int len)
             throws IOException {
             System.err.write(b, off, len);
         }
 
         @Override
         public void write(final int b) {
             System.err.write(b);
         }
     }
 
     /**
      * An implementation of OutputStream that redirects to the current System.out.
      */
     private static class SystemOutStream extends OutputStream {
         public SystemOutStream() {
         }
 
         @Override
         public void close() {
             // do not close sys out!
         }
 
         @Override
         public void flush() {
             System.out.flush();
         }
 
         @Override
         public void write(final byte[] b) throws IOException {
             System.out.write(b);
         }
 
         @Override
         public void write(final byte[] b, final int off, final int len)
             throws IOException {
             System.out.write(b, off, len);
         }
 
         @Override
         public void write(final int b) throws IOException {
             System.out.write(b);
         }
     }
     
     /**
      * A delegating OutputStream that does not close its delegate.
      */
     private static class CloseShieldOutputStream extends OutputStream {
 
         private final OutputStream delegate;
 
         public CloseShieldOutputStream(final OutputStream delegate) {
             this.delegate = delegate;
         }
 
         @Override
         public void close() {
             // do not close delegate
         }
 
         @Override
         public void flush() throws IOException {
             delegate.flush();
         }
 
         @Override
         public void write(final byte[] b) throws IOException {
             delegate.write(b);
         }
 
         @Override
         public void write(final byte[] b, final int off, final int len)
                 throws IOException {
             delegate.write(b, off, len);
         }
 
         @Override
         public void write(final int b) throws IOException {
             delegate.write(b);
         }
     }
 
     /**
      * Data to pass to factory method.
      */
     private static class FactoryData {
         private final OutputStream os;
         private final String type;
         private final Layout<? extends Serializable> layout;
 
         /**
          * Constructor.
          * @param os The OutputStream.
          * @param type The name of the target.
          * @param layout A Serializable layout
          */
         public FactoryData(final OutputStream os, final String type, final Layout<? extends Serializable> layout) {
             this.os = os;
             this.type = type;
             this.layout = layout;
         }
     }
 
     /**
      * Factory to create the Appender.
      */
     private static class ConsoleManagerFactory implements ManagerFactory<OutputStreamManager, FactoryData> {
 
         /**
          * Create an OutputStreamManager.
          * @param name The name of the entity to manage.
          * @param data The data required to create the entity.
          * @return The OutputStreamManager
          */
         @Override
         public OutputStreamManager createManager(final String name, final FactoryData data) {
             return new OutputStreamManager(data.os, data.type, data.layout);
         }
     }
 
 }