/**
    * 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.cms.core.Content;
  import info.magnolia.cms.core.Content.ContentFilter;
  import info.magnolia.cms.util.ContentUtil;
  import info.magnolia.module.InstallContext;
  
  import java.util.Collection;
  
  import javax.jcr.Node;
  import javax.jcr.RepositoryException;
  import javax.jcr.Session;
  
  import org.apache.commons.lang3.StringUtils;
  
  /**
   * This task executes the abstract method on every child node.
   *
   * @deprecated since 5.6, used {@link AllChildrenTask} instead.
   */
  @Deprecated
  public abstract class AllChildrenNodesOperation extends AbstractRepositoryTask {
  
      private final String repositoryName;
      private final String parentNodePath;
      private final ContentFilter filter;
  
      public AllChildrenNodesOperation(String name, String description, String repositoryName, String parentNodePath) {
          this(name, description, repositoryName, parentNodePath, ContentUtil.EXCLUDE_META_DATA_CONTENT_FILTER);
      }
  
      public AllChildrenNodesOperation(String name, String description, String repositoryName, String parentNodePath, ContentFilter filter) {
          super(name, description);
          this.repositoryName = repositoryName;
          this.parentNodePath = parentNodePath;
          this.filter = filter;
      }
  
      @Override
      protected void doExecute(InstallContext ctx) throws RepositoryException, TaskExecutionException {
          final Content parentNode = getParentNode(ctx);
          final Collection<Content> childNodes = parentNode.getChildren(filter);
          for (Content node : childNodes) {
              operateOnChildNode(node, ctx);
          }
      }
  
      protected Content getParentNode(InstallContext ctx) throws RepositoryException, TaskExecutionException {
          final Session session = ctx.getJCRSession(repositoryName);
          // Previously hierarchy manager would expect relative path, worse than that, it would remove any prefixed slash
          // from given path before calling #getContent()
          final Node parentNode;
          if ("/".equals(this.parentNodePath)) {
              parentNode = session.getRootNode();
          } else {
              final String parentNodePath = StringUtils.removeStart(this.parentNodePath, "/");
              parentNode = session.getRootNode().getNode(parentNodePath);
          }
          return ContentUtil.asContent(parentNode);
      }
  
      protected abstract void operateOnChildNode(Content node, InstallContext ctx) throws RepositoryException, TaskExecutionException;
  }