/**
    * This file Copyright (c) 2011-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.ServerConfiguration;
  import info.magnolia.context.MgnlContext;
  import info.magnolia.jcr.util.PropertyUtil;
  import info.magnolia.module.resources.ResourcesModule;
  import info.magnolia.objectfactory.Components;
  import info.magnolia.rendering.context.RenderingContext;
  import info.magnolia.rendering.engine.RenderException;
  import info.magnolia.rendering.engine.RenderingEngine;
  import info.magnolia.rendering.renderer.Renderer;
  import info.magnolia.rendering.util.AppendableWriter;
  
  import java.io.IOException;
  import java.util.Map;
  
  import javax.inject.Inject;
  import javax.jcr.Node;
  import javax.jcr.RepositoryException;
  import javax.jcr.Session;
  
  import org.apache.commons.lang3.StringUtils;
  import org.apache.jackrabbit.commons.JcrUtils;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  /**
   * Resolves the referenced resource and triggers the rendering of the referenced resource node.
   */
  public class ReferenceResourceRenderer implements Renderer {
  
      private static final Logger log = LoggerFactory.getLogger(ReferenceResourceRenderer.class);
  
      private final RenderingEngine engine;
      private final ServerConfiguration servConf;
  
      /**
       * @deprecated since 2.4, use {@link #ReferenceResourceRenderer(RenderingEngine, ServerConfiguration)}.
       */
      @Deprecated
      public ReferenceResourceRenderer() {
          this(Components.getComponent(RenderingEngine.class), Components.getComponent(ServerConfiguration.class));
      }
  
      @Inject
      public ReferenceResourceRenderer(RenderingEngine renderingEngine, ServerConfiguration servConf) {
          this.engine = renderingEngine;
          this.servConf = servConf;
      }
  
      @Override
      public void render(RenderingContext ctx, Map<String, Object> contextObjects) throws RenderException {
          String logMessage = "";
          Node content = ctx.getCurrentContent();
  
          String referencedPath = PropertyUtil.getString(content, "reference");
          if (referencedPath != null) {
              Node referencedResource = null;
              try {
                  Session session = MgnlContext.getJCRSession(ResourcesModule.DEFAULT_WORKSPACE);
                  if (session.nodeExists(referencedPath)) {
                      referencedResource = session.getNode(referencedPath);
                      engine.render(referencedResource, ctx.getOutputProvider());
                  } else {
                      logMessage = "The referenced resource '" + referencedPath + "' does not exist.";
                      log.error(logMessage);
 
                 }
             } catch (RepositoryException e) {
                 logMessage = "Unable to render referenced resource node ." + JcrUtils.toString(referencedResource);
                 throw new RenderException(logMessage, e);
             }
         } else {
             logMessage = "Reference resource " + JcrUtils.toString(content) + " does not contain any 'reference' property value targeting another resource node.";
             log.error(logMessage);
         }
 
         // Rendering the log information as comment.
         try {
             if (StringUtils.isNotEmpty(logMessage)) {
                 // Only render the error message on author instance
                 if (servConf.isAdmin()) {
                     AppendableWriter out = ctx.getAppendable();
                     out.append(htmlCommentLogMessage(logMessage));
                 }
             }
         } catch (IOException e) {
             throw new RenderException(logMessage, e);
         }
     }
 
     private String htmlCommentLogMessage(String logMessage) {
         return "<!-- " + logMessage + " -->";
     }
 }