/**
    * This file Copyright (c) 2003-2013 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.commands.impl;
  
  import info.magnolia.cms.core.version.VersionManager;
  import info.magnolia.cms.util.ExclusiveWrite;
  import info.magnolia.context.Context;
  import info.magnolia.jcr.util.NodeTypes;
  import info.magnolia.jcr.util.PropertyUtil;
  
  import java.util.ArrayList;
  import java.util.HashMap;
  import java.util.List;
  import java.util.Map;
  
  import javax.jcr.Node;
  import javax.jcr.NodeIterator;
  import javax.jcr.RepositoryException;
  import javax.jcr.version.Version;
  
  import org.apache.commons.lang.StringUtils;
  
  /**
   * Creates a version for the passed path in the website repository.
   */
  public class VersionCommand extends RuleBasedCommand {
  
      private boolean recursive;
  
      private String comment;
  
      /**
       * @see info.magnolia.commands.MgnlCommand#execute(info.magnolia.context.Context)
       */
      @Override
      public boolean execute(Context ctx) throws Exception {
          final Node node = getJCRNode(ctx);
          if (isRecursive()) {
              // set versionMap and version name for this node
              List versionMap = new ArrayList();
              versionRecursively(node, ctx, versionMap);
              ctx.setAttribute(Context.ATTRIBUTE_VERSION_MAP, versionMap, Context.LOCAL_SCOPE);
          } else {
              addComment(node);
              Version version = VersionManager.getInstance().addVersion(node, getRule());
              ctx.setAttribute(Context.ATTRIBUTE_VERSION, version.getName(), Context.LOCAL_SCOPE);
              cleanComment(node);
          }
  
          return true;
      }
  
      protected void addComment(final Node node) throws RepositoryException {
          synchronized (ExclusiveWrite.getInstance()) {
              PropertyUtil.setProperty(node, NodeTypes.Versionable.COMMENT, getComment() != null ? getComment() : "");
              node.getSession().save();
          }
      }
  
      protected void cleanComment(final Node node) throws RepositoryException {
          synchronized (ExclusiveWrite.getInstance()) {
              if (node.hasProperty(NodeTypes.Versionable.COMMENT)
                      && !StringUtils.EMPTY.equals(node.getProperty(NodeTypes.Versionable.COMMENT).getString())) {
                  node.getProperty(NodeTypes.Versionable.COMMENT).remove();
                  node.getSession().save();
              }
          }
      }
 
     /**
      * Recursive version the descendant nodes in the tree. Uses the reversed {@link #rule} to filter the nodes meant to be versioned.
      * {@link info.magnolia.cms.util.Rule#isAllowed} is used to composite the child nodes into one version - node types defined in the
      * {@link info.magnolia.cms.util.Rule#allowedTypes} will not be versioned.
      *
      * @param versionMap keeps tack of the versioned nodes and gets passed to the context.
      */
     private void versionRecursively(Node node, Context ctx, List versionMap) throws RepositoryException {
         addComment(node);
         Version version = VersionManager.getInstance().addVersion(node, getRule());
         Map entry = new HashMap();
         entry.put("version", version.getName());
         entry.put("uuid", node.getIdentifier());
         versionMap.add(entry);
         if (StringUtils.isEmpty((String) ctx.getAttribute(Context.ATTRIBUTE_VERSION))) {
             ctx.setAttribute(Context.ATTRIBUTE_VERSION, version.getName(), Context.LOCAL_SCOPE);
         }
 
         cleanComment(node);
 
         NodeIterator children = node.getNodes();
         while (children.hasNext()) {
             Node child = children.nextNode();
             if (!getRule().isAllowed(child)) {
                 versionRecursively(child, ctx, versionMap);
             }
         }
     }
 
     /**
      * @return is recursive versioning
      */
     public boolean isRecursive() {
         return recursive;
     }
 
     /**
      * @param recursive
      */
     public void setRecursive(boolean recursive) {
         this.recursive = recursive;
     }
 
     public String getComment() {
         return comment;
     }
 
     public void setComment(String comment) {
         this.comment = comment;
     }
 
     @Override
     public void release() {
         super.release();
         this.recursive = false;
     }
 }