/**
    * This file Copyright (c) 2014-2018 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.objectfactory.Components;
  import info.magnolia.rendering.engine.OutputProvider;
  import info.magnolia.rendering.template.RenderableDefinition;
  import info.magnolia.voting.voters.ResponseContentTypeVoter;
  import info.magnolia.voting.voters.VoterSet;
  
  import java.util.Arrays;
  import java.util.Map;
  
  import javax.jcr.Node;
  import javax.jcr.RepositoryException;
  import javax.servlet.http.HttpServletResponse;
  
  /**
   * Listener for {@link info.magnolia.rendering.engine.RenderingEngine}.
   */
  public abstract class AbstractRenderingListener {
  
      private VoterSet<HttpServletResponse> shouldProcess = new VoterSet<HttpServletResponse>();
  
      /**
       * Rendering listener return codes.
       */
      public static enum RenderingListenerReturnCode {
          SKIP,
          STOP,
          NOT_FOUND
      }
  
      private boolean enabled = true;
  
      public AbstractRenderingListener() {
          // process by default only "text/html"
          ResponseContentTypeVoter voter = new ResponseContentTypeVoter();
          voter.setAllowed(Arrays.asList("text/html"));
          getShouldProcess().addVoter(voter);
      }
  
      public RenderingListenerReturnCode init(OutputProvider outputProvider, HttpServletResponse response) throws RepositoryException {
          return this.shouldProcess(response) ? null : RenderingListenerReturnCode.SKIP;
      }
  
      protected boolean shouldProcess(HttpServletResponse response) {
          if (getShouldProcess().vote(response) <= 0) {
              return false;
          }
          return true;
      }
  
      public abstract RenderingListenerReturnCode before(Node content, RenderableDefinition definition, Map<String, Object> contextObjects, OutputProvider out) throws RepositoryException;
  
      public abstract RenderingListenerReturnCode after(Node content, RenderableDefinition definition, Map<String, Object> contextObjects, OutputProvider out) throws RepositoryException;
  
      public boolean isEnabled() {
          return enabled;
      }
  
      public void setEnabled(boolean enabled) {
          this.enabled = enabled;
      }
  
      /**
       * The instance of each {@link AbstractRenderingListener} needs to be copied per request.
       * Override this method to set your custom properties which should be shared between all instances.
      */
     public AbstractRenderingListener copy() { // no need to copy enabled field since such node is disabled by N2B
         AbstractRenderingListener copy = Components.newInstance(this.getClass());
         copy.setShouldProcess(shouldProcess);
         return copy;
     }
 
     public VoterSet<HttpServletResponse> getShouldProcess() {
         return shouldProcess;
     }
 
     public void setShouldProcess(VoterSet<HttpServletResponse> shouldProcess) {
         this.shouldProcess = shouldProcess;
     }
 
 }