/**
    * This file Copyright (c) 2008-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.module.resources.renderers;
  
  import info.magnolia.cms.beans.config.MIMEMapping;
  import info.magnolia.context.MgnlContext;
  import info.magnolia.freemarker.FreemarkerHelper;
  import info.magnolia.jcr.util.NodeUtil;
  import info.magnolia.jcr.util.PropertyUtil;
  import info.magnolia.jcr.wrapper.HTMLEscapingNodeWrapper;
  import info.magnolia.module.resources.ResourcesModule;
  import info.magnolia.module.resources.loaders.ResourceLoader;
  import info.magnolia.module.resources.templates.ResourceTemplate;
  import info.magnolia.objectfactory.Classes;
  import info.magnolia.objectfactory.guice.GuiceUtils;
  import info.magnolia.rendering.context.RenderingContext;
  import info.magnolia.rendering.engine.RenderException;
  import info.magnolia.rendering.engine.RenderingEngine;
  import info.magnolia.rendering.model.RenderingModel;
  import info.magnolia.rendering.renderer.FreemarkerRenderer;
  import info.magnolia.rendering.template.RenderableDefinition;
  import info.magnolia.rendering.util.AppendableWriter;
  
  import java.io.IOException;
  import java.io.InputStream;
  import java.io.Reader;
  import java.io.StringReader;
  import java.util.List;
  import java.util.Map;
  
  import javax.inject.Inject;
  import javax.inject.Provider;
  import javax.jcr.Node;
  import javax.jcr.RepositoryException;
  import javax.servlet.http.HttpServletResponse;
  
  import org.apache.commons.io.IOUtils;
  import org.apache.commons.lang3.StringUtils;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  import freemarker.template.TemplateException;
  
  /**
   * This renderer uses the content and its subnodes as a Freemarker template
   * source. Subnodes are appended to the content of the current node. Note that
   * this doesn't work recursively. This can be useful for css or javascript
   * resources, and the post-processing by Freemarker makes these dynamic,
   * allowing one to use all of Freemarker's niceness right in their css or
   * javascript (thus getting hold of Magnolia content and configuration, or
   * simply using variables, etc...)
   */
  public class ResourcesTextTemplateRenderer extends FreemarkerRenderer {
  
      private static final Logger log = LoggerFactory.getLogger(ResourcesTextTemplateRenderer.class);
      private final Provider<ResourcesModule> resourcesModule;
  
      /**
       * @deprecated since 2.4, use {@link #ResourcesTextTemplateRenderer(FreemarkerHelper, RenderingEngine, Provider)}.
       */
      @Deprecated
      public ResourcesTextTemplateRenderer(FreemarkerHelper fmRenderer, RenderingEngine renderingEngine) {
          this(fmRenderer, renderingEngine, GuiceUtils.providerForInstance(ResourcesModule.getInstance()));
      }
  
      @Inject
      public ResourcesTextTemplateRenderer(FreemarkerHelper fmRenderer, RenderingEngine renderingEngine, Provider<ResourcesModule> resourcesModule) {
          super(fmRenderer, renderingEngine);
         this.resourcesModule = resourcesModule;
     }
 
     @Override
     protected void onRender(Node content, RenderableDefinition definition, RenderingContext renderingCtx, Map<String, Object> ctx, String templateScript) throws RenderException {
         // Get template from Definition
         ResourceTemplate resourceTemplate = (ResourceTemplate) definition;
         // Get HTTP Response
         final HttpServletResponse response = MgnlContext.getWebContext().getResponse();
         final String contentType = resourceTemplate.getContentType();
         final boolean processed = resourceTemplate.isProcessed();
 
         response.setContentType(contentType);
 
         content = NodeUtil.deepUnwrap(content, HTMLEscapingNodeWrapper.class);
 
         StringBuffer text;
         if (shouldBypass(content)) {
             // fall back on the normal template loading mechanism
             // the same path as in the workspace is used
             if (processed) {
                 super.onRender(content, definition, renderingCtx, ctx, templateScript);
                 return;
             }
 
             InputStream in = null;
             List<ResourceLoader> loaders = resourcesModule.get().getResourceLoaders();
 
             for (ResourceLoader loader : loaders) {
                 try {
                     in = loader.getStream(templateScript);
                     if (in != null) {
                         break;
                     }
                 } catch (IOException e) {
                     log.debug("Can't load resource '{}' with ResourceLoader '{}'", templateScript, loader.getClass());
                 }
             }
 
             if (in == null) {
                 throw new RenderException(String.format("Template '%s' not found.", templateScript));
             }
 
             try {
                 text = new StringBuffer();
                 text.append(IOUtils.toString(in));
             } catch (IOException e) {
                 throw new RenderException(String.format("Can't render resource '%s'.", templateScript), e);
             } finally {
                 IOUtils.closeQuietly(in);
             }
 
         } else {
             text = new StringBuffer();
             text.append(PropertyUtil.getString(content, "text"));
         }
 
         try {
             // Get Output
             AppendableWriter out = renderingCtx.getAppendable();
 
             if (processed) {
                 Reader reader = new StringReader(text.toString());
                 try {
                     this.getFmHelper().render(reader, ctx, out);
                 } catch (TemplateException e) {
                     throw new RenderException(e);
                 }
             } else {
                 out.write(text.toString());
             }
         } catch (IOException e) {
             throw new RenderException("Can't render resource", e);
         }
     }
 
     /**
      * The template is stored in the content node. So we don't need a
      * templatePath.
      */
     @Override
     protected String resolveTemplateScript(Node content, RenderableDefinition definition, RenderingModel<?> model, final String actionResult) {
         if (shouldBypass(content)) {
             try {
                 String path;
                 if (StringUtils.isNotBlank(MIMEMapping.getMIMEType(StringUtils.substringAfterLast(content.getPath(), ".")))) {
                     return content.getPath();
                 }
                 String extension = PropertyUtil.getString(content, "extension");
                 path = content.getPath();
                 if (extension != null) {
                     path += "." + extension;
                 }
                 return path;
             } catch (RepositoryException re) {
                 log.error("Not able to determineTemplatePath ", re);
             }
         }
         // Return an empty object due to the check of AbstractRenderer.render(.
         // that throw an Exception if the templatePath is null. In our case
         // we don't have a templatePath because the script is coming from
         // the content node.
         return "";
     }
 
     /**
      * Creates the model for this rendering process. Will set the properties.
      */
     @Override
     public RenderingModel<?> newModel(Node content, RenderableDefinition definition, RenderingModel<?> parentModel) throws RenderException {
 
         String modelClass = PropertyUtil.getString(content, "modelClass");
 
         if (StringUtils.isEmpty(modelClass)) {
             return super.newModel(content, definition, parentModel);
         }
 
         Class<? extends RenderingModel<?>> clazz;
         try {
             clazz = Classes.getClassFactory().forName(modelClass);
         } catch (ClassNotFoundException e) {
             throw new RenderException("Could not create model.", e);
         }
 
         return super.newModel(clazz, content, definition, parentModel);
     }
 
     protected boolean shouldBypass(Node content) {
         return PropertyUtil.getBoolean(content, "bypass", false);
     }
 
 }