/**
    * This file Copyright (c) 2014-2015 Magnolia International
    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
    *
    *
    * This file is dual-licensed under both the Magnolia
    * Network Agreement and the GNU General Public License.
    * You may elect to use one or the other of these licenses.
    *
   * This file is distributed in the hope that it will be
   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
   * implied warranty of MERCHANTABILITY or FITNESS FOR A
   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
   * Redistribution, except as permitted by whichever of the GPL
   * or MNA you select, is prohibited.
   *
   * 1. For the GPL license (GPL), you can redistribute and/or
   * modify this file under the terms of the GNU General
   * Public License, Version 3, as published by the Free Software
   * Foundation.  You should have received a copy of the GNU
   * General Public License, Version 3 along with this program;
   * if not, write to the Free Software Foundation, Inc., 51
   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * 2. For the Magnolia Network Agreement (MNA), this file
   * and the accompanying materials are made available under the
   * terms of the MNA which accompanies this distribution, and
   * is available at http://www.magnolia-cms.com/mna.html
   *
   * Any modifications to this file must keep this entire header
   * intact.
   *
   */
  package info.magnolia.rendering.listeners;
  
  import info.magnolia.rendering.engine.OutputProvider;
  import info.magnolia.rendering.template.RenderableDefinition;
  
  import java.io.IOException;
  import java.util.ArrayList;
  import java.util.Collection;
  import java.util.Map;
  
  import javax.jcr.Node;
  import javax.jcr.RepositoryException;
  
  import org.apache.commons.lang3.StringUtils;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  /**
   * Listener for text injection.
   */
  public abstract class AbstractInjectionListener extends AbstractRenderingListener {
  
      private static final Logger log = LoggerFactory.getLogger(AbstractInjectionListener.class);
  
      private boolean skipRendering = false;
      private String before = null;
      private String after = null;
      private Collection<String> arguments = new ArrayList<String>();
  
      protected abstract boolean shouldInclude(Node content, RenderableDefinition definition) throws RepositoryException;
  
      @Override
      public AbstractRenderingListener copy() {
          AbstractInjectionListener copy = (AbstractInjectionListener) super.copy();
          copy.setSkipRendering(skipRendering);
          copy.setBefore(before);
          copy.setAfter(after);
          copy.setArguments(arguments);
          return copy;
      }
  
      @Override
      public RenderingListenerReturnCode before(Node content, RenderableDefinition definition, Map<String, Object> contextObjects, OutputProvider out) throws RepositoryException {
          if (before != null && this.shouldInclude(content, definition)) {
              this.include(content, definition, out, this.getBefore());
              if (skipRendering) {
                  return RenderingListenerReturnCode.SKIP;
              }
          }
          return null;
      }
  
      @Override
      public RenderingListenerReturnCode after(Node content, RenderableDefinition definition, Map<String, Object> contextObjects, OutputProvider out) throws RepositoryException {
          if (after != null && this.shouldInclude(content, definition)) {
              this.include(content, definition, out, this.getAfter());
          }
          return null;
      }
  
      private void include(Node content, RenderableDefinition definition, OutputProvider out, String text) throws RepositoryException {
          try {
              out.getAppendable().append(this.processBeforeInjection(text, content, definition));
          } catch (IOException e) {
              throw new RepositoryException(String.format("Cannot inject text '%s' into component.", text), e);
          }
     }
 
     protected String processBeforeInjection(String text, Node content, RenderableDefinition definition) throws RepositoryException {
         for (String argument : arguments) {
             if (content.hasProperty(argument)) {
                 text = StringUtils.replaceOnce(text, "${" + argument + "}", content.getProperty(argument).getString());
             } else {
                 log.warn("Cannot replace '{}' since '{}' doesn't have such property.", "${" + argument + "}", content);
             }
         }
         return text;
     }
 
     public String getBefore() {
         return before;
     }
 
     public void setBefore(String before) {
         this.before = before;
     }
 
     public String getAfter() {
         return after;
     }
 
     public void setAfter(String after) {
         this.after = after;
     }
 
     public boolean isSkipRendering() {
         return skipRendering;
     }
 
     public void setSkipRendering(boolean skipRendering) {
         this.skipRendering = skipRendering;
     }
 
     public Collection<String> getArguments() {
         return arguments;
     }
 
     public void setArguments(Collection<String> arguments) {
         this.arguments = arguments;
     }
 
 }