/**
    * 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.module.setup;
  
  import info.magnolia.jcr.util.NodeTypes;
  import info.magnolia.jcr.util.NodeUtil;
  import info.magnolia.module.InstallContext;
  import info.magnolia.module.delta.AbstractRepositoryTask;
  import info.magnolia.module.delta.TaskExecutionException;
  
  import javax.jcr.Node;
  import javax.jcr.NodeIterator;
  import javax.jcr.Property;
  import javax.jcr.RepositoryException;
  import javax.jcr.Session;
  
  
  /**
   * Task for installing context attributes to renderers.
   */
  public class InstallRendererContextAttributeTask extends AbstractRepositoryTask {
  
      public static final String MODULES_ROOT_DIR = "/modules/";
      public static final String RENDERERS_NODE = "renderers";
      public static final String CONTEXT_ATTRIBUTES = "contextAttributes";
      public static final String COMPONENT_CLASS = "componentClass";
  
      private final String modulePath;
      private final String name;
      private final String componentClass;
      private final String renderer;
  
      public InstallRendererContextAttributeTask(String moduleName, String renderer, String name, String componentClass) {
          super("Renderer context attribute install task", String.format("Installing '%s' context attribute in module '%s'.", name, moduleName));
          this.renderer = renderer;
          this.modulePath = MODULES_ROOT_DIR + moduleName;
          this.name = name;
          this.componentClass = componentClass;
      }
  
      @Override
      protected void doExecute(InstallContext installContext) throws RepositoryException, TaskExecutionException {
          Session session = installContext.getConfigJCRSession();
  
          if (session.nodeExists(modulePath)) {
              Node module = session.getNode(modulePath);
  
              if (module.hasNode(RENDERERS_NODE + "/" + renderer)) {
                  Node rendererNode = module.getNode(RENDERERS_NODE).getNode(renderer);
  
                  Node context = NodeUtil.createPath(rendererNode, CONTEXT_ATTRIBUTES, NodeTypes.ContentNode.NAME);
                  NodeIterator functions = context.getNodes();
                  boolean installed = false;
  
                  while (functions.hasNext()) {
                      Node function = functions.nextNode();
  
                      if (function.hasProperty(COMPONENT_CLASS)) {
                          Property property = function.getProperty(COMPONENT_CLASS);
                          if (componentClass.equals(property.getString())) {
                              installed = true;
                              break;
                          }
                      }
                  }
                  if (installed) {
                      installContext.info(String.format("Context attribute with class '%s' already installed, skipping.", componentClass));
                      return;
                 }
                 else if (context.hasNode(name)) {
                     installContext.info(String.format("Context attribute with name '%s' already installed, skipping.", name));
                     return;
                 }
                 else {
                     Node contextAttribute = context.addNode(name, NodeTypes.ContentNode.NAME);
                     contextAttribute.setProperty("name", name);
                     contextAttribute.setProperty(COMPONENT_CLASS, componentClass);
                 }
             }
             else {
                 installContext.info(String.format("Renderer '%s' is not installed. Context attribute is not installed.", renderer));
             }
         }
         else {
             installContext.info(String.format("Module '%s' is not installed. Context attribute is not installed.", modulePath));
         }
 
     }
 }