/**
    * This file Copyright (c) 2017 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.rest.delivery.jcr.filter;
  
  import info.magnolia.jcr.decoration.ContentDecoratorNodeIterator;
  import info.magnolia.jcr.decoration.ContentDecoratorNodeWrapper;
  import info.magnolia.jcr.predicate.JCRMgnlPropertyHidingPredicate;
  import info.magnolia.jcr.wrapper.ChildFilteringContentDecorator;
  import info.magnolia.jcr.wrapper.PropertyFilteringContentDecorator;
  import info.magnolia.rest.delivery.jcr.decorator.ReferenceExpandDecorator;
  import info.magnolia.rest.delivery.jcr.decorator.ReferenceExpandWrapper;
  import info.magnolia.rest.reference.ReferenceDefinition;
  
  import java.util.ArrayList;
  import java.util.Collections;
  import java.util.List;
  
  import javax.jcr.Node;
  import javax.jcr.NodeIterator;
  import javax.jcr.RepositoryException;
  
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  /**
   * A builder to centralize the decorators in one place.
   */
  public class FilteringContentDecoratorBuilder implements Cloneable {
      private static final Logger log = LoggerFactory.getLogger(FilteringContentDecoratorBuilder.class);
  
      private List<String> childNodeTypes = new ArrayList<>();
      private boolean includeSystemProperties;
      private int depth;
      private List<ReferenceDefinition> references = new ArrayList<>();
  
      public FilteringContentDecoratorBuilder childNodeTypes(List<String> childrenNodeTypes) {
          this.childNodeTypes = childrenNodeTypes;
          return this;
      }
  
      public FilteringContentDecoratorBuilder includeSystemProperties(boolean includeSystemProperties) {
          this.includeSystemProperties = includeSystemProperties;
          return this;
      }
  
      public FilteringContentDecoratorBuilder depth(int depth) {
          this.depth = depth;
          return this;
      }
  
      public FilteringContentDecoratorBuilder references(List<ReferenceDefinition> references) {
          this.references = references;
          return this;
      }
  
      public Node wrapNode(Node node) {
          if (!childNodeTypes.isEmpty()) {
              node = new ContentDecoratorNodeWrapper<>(node, new ChildFilteringContentDecorator(new NodeTypesPredicate(childNodeTypes), true));
          }
  
          if (!includeSystemProperties) {
              node = new ContentDecoratorNodeWrapper<>(node, new PropertyFilteringContentDecorator(new JCRMgnlPropertyHidingPredicate()));
          }
  
          if (depth >= 0) {
              ChildFilteringContentDecorator depthDecorator = new ChildFilteringContentDecorator(new DepthFilteringPredicate(getDepth(node), getDepth(node) + depth), true);
              node = new ContentDecoratorNodeWrapper<>(node, depthDecorator);
          }
 
         if (references != null && !references.isEmpty()) {
             FilteringContentDecoratorBuilder expandDecorators = this.clone();
             expandDecorators
                     .childNodeTypes(Collections.emptyList())
                     .depth(-1);
 
             node = new ReferenceExpandWrapper(node, references, expandDecorators);
         }
 
         return node;
     }
 
     public NodeIterator wrapNodeIterator(NodeIterator nodeIterator) {
 
         if (!childNodeTypes.isEmpty()) {
             nodeIterator = new ChildNodeTypesFilteringNodeIterator(nodeIterator, childNodeTypes);
         }
 
         if (!includeSystemProperties) {
             nodeIterator = new ContentDecoratorNodeIterator(nodeIterator, new PropertyFilteringContentDecorator(new JCRMgnlPropertyHidingPredicate()));
         }
 
         if (depth >= 0) {
             nodeIterator = new DepthFilteringDecoratorNodeIterator(nodeIterator, depth);
         }
 
         if (references != null && !references.isEmpty()) {
             FilteringContentDecoratorBuilder expandDecorators = this.clone();
             expandDecorators
                     .childNodeTypes(Collections.emptyList())
                     .depth(-1);
 
             nodeIterator = new ContentDecoratorNodeIterator(nodeIterator, new ReferenceExpandDecorator(references, expandDecorators));
         }
 
         return nodeIterator;
     }
 
     private int getDepth(Node node) {
         try {
             return node.getDepth();
         } catch (RepositoryException e) {
             return 0;
         }
     }
 
     @Override
     public FilteringContentDecoratorBuilder clone() {
         try {
             return (FilteringContentDecoratorBuilder) super.clone();
         } catch (CloneNotSupportedException e) {
             log.warn("Cannot clone new builder!", e);
         }
 
         return new FilteringContentDecoratorBuilder();
     }
 }