/**
    * This file Copyright (c) 2003-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.module.delta;
  
  import info.magnolia.jcr.util.NodeNameHelper;
  import info.magnolia.jcr.util.NodeTypes;
  import info.magnolia.jcr.util.NodeUtil;
  import info.magnolia.module.InstallContext;
  import info.magnolia.module.model.ServletDefinition;
  import info.magnolia.module.model.ServletParameterDefinition;
  import info.magnolia.objectfactory.Components;
  
  import javax.jcr.Node;
  import javax.jcr.RepositoryException;
  import javax.jcr.Session;
  
  import org.apache.commons.lang3.StringUtils;
  
  /**
   * Registers a servlet definition from a module descriptor into the /server/filters/servlets node.
   *
   * @see info.magnolia.module.model.ServletDefinition
   */
  public class RegisterServletTask extends AbstractTask {
  
      private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(RegisterServletTask.class);
  
      private static final String DEFAULT_SERVLET_FILTER_PATH = "/server/filters/servlets";
      private final ServletDefinition servletDefinition;
      private final NodeNameHelper nodeNameHelper;
  
      public RegisterServletTask(ServletDefinition servletDefinition, NodeNameHelper nodeNameHelper) {
          super("Servlet " + servletDefinition.getName(), "Registers servlet" + servletDefinition.getName() + " (" + servletDefinition.getComment() + ")");
          this.servletDefinition = servletDefinition;
          this.nodeNameHelper = nodeNameHelper;
      }
  
      /**
       * @deprecated since 5.5.3, use {@link #RegisterServletTask(ServletDefinition, NodeNameHelper)} instead.
       */
      @Deprecated
      public RegisterServletTask(ServletDefinition servletDefinition) {
          this(servletDefinition, Components.getComponent(NodeNameHelper.class));
      }
  
      @Override
      public void execute(InstallContext installContext) throws TaskExecutionException {
          log.debug("Registering servlet {} in servlet filter.", servletDefinition.getName());
  
          try {
              final Session session = installContext.getConfigJCRSession();
              final Node servletNode = NodeUtil.createPath(session.getRootNode(), DEFAULT_SERVLET_FILTER_PATH + "/" + servletDefinition.getName(), NodeTypes.ContentNode.NAME);
              servletNode.setProperty("class", "info.magnolia.cms.filters.ServletDispatchingFilter");
              servletNode.setProperty("enabled", true);
              servletNode.setProperty("servletClass", servletDefinition.getClassName());
              servletNode.setProperty("servletName", servletDefinition.getName());
              servletNode.setProperty("comment", servletDefinition.getComment());
  
              final Node mappingsNode = servletNode.addNode("mappings", NodeTypes.ContentNode.NAME);
              for (String pattern : servletDefinition.getMappings()) {
                  if (StringUtils.isBlank(pattern)) {
                      installContext.warn("Empty mappings configuration is not supported and servlet was not installed.");
                      continue;
                  }
                  String mappingNodeName = nodeNameHelper.getUniqueName(mappingsNode, nodeNameHelper.getValidatedName(pattern));
                  final Node mappingNode = mappingsNode.addNode(mappingNodeName, NodeTypes.ContentNode.NAME);
                  mappingNode.setProperty("pattern", pattern);
              }
 
             final Node parametersNode = servletNode.addNode("parameters", NodeTypes.ContentNode.NAME);
             for (ServletParameterDefinition parameter : servletDefinition.getParams()) {
                 parametersNode.setProperty(parameter.getName(), parameter.getValue());
             }
         } catch (RepositoryException e) {
             log.error("Cannot create servlet node in servlet filter.", e);
         }
     }
 
     public ServletDefinition getServletDefinition() {
         return this.servletDefinition;
     }
 }