/**
    * This file Copyright (c) 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.security.AccessDeniedException;
  import info.magnolia.cms.security.Permission;
  import info.magnolia.context.Context;
  import info.magnolia.context.MgnlContext;
  import info.magnolia.importexport.DataTransporter;
  import info.magnolia.repository.RepositoryConstants;
  
  import java.io.IOException;
  import java.io.InputStream;
  
  import javax.jcr.ImportUUIDBehavior;
  import javax.jcr.RepositoryException;
  
  import org.apache.commons.lang.StringEscapeUtils;
  import org.apache.commons.lang.StringUtils;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  /**
   * Generic Import Command.<br>
   * Based on an InputStream representing a XML node structure, create the Node
   * tree under the <br>
   * specified workspace and path.
   */
  public class ImportCommand extends ExportCommand {
  
      private static final Logger log = LoggerFactory.getLogger(ImportCommand.class);
  
      public static final String IMPORT_XML_STREAM = "xmlStream";
      private InputStream xmlStream;
      public static final String IMPORT_XML_FILE_NAME = "xmlFileName";
      private String xmlFileName;
      public static final String IMPORT_IDENTIFIER_BEHAVIOR = "identifierBehavior";
      private int identifierBehavior;
      private boolean forceUnpublishState;
  
      @Override
      public boolean execute(Context context) throws Exception {
          String repository = StringUtils.isBlank(getRepository()) ? RepositoryConstants.WEBSITE : getRepository();
          String path = StringUtils.isBlank(getPath()) ? "/" : getPath();
          identifierBehavior = (getIdentifierBehavior() != -1) ? getIdentifierBehavior() : ImportUUIDBehavior.IMPORT_UUID_CREATE_NEW;
  
          log.debug("Will import content in {} repository with and path {}", new Object[] { getRepository(), getPath() });
  
          // Check Path
          if (!MgnlContext.getJCRSession(repository).nodeExists(path)) {
              throw new RepositoryException("Path " + path + " Do not exist in the following workspace " + repository);
          }
  
          // Check Permission
          if (!checkPermissions(repository, path, Permission.WRITE)) {
              // escape to prevent XSS attack
              throw new AccessDeniedException("Write permission needed for import. User not allowed to Write path [" + StringEscapeUtils.escapeHtml(path) + "]");
          }
          try {
              DataTransporter.importXmlStream(xmlStream, repository, path, xmlFileName, false, forceUnpublishState, identifierBehavior, true, true);
          } catch (IOException ioe) {
              throw ioe;
          } finally {
              if (xmlStream != null) {
                  xmlStream.close();
              }
          }
          log.info("Import done");
         return true;
     }
 
     /**
      * @return the xmlStream
      */
     public InputStream getXmlStream() {
         return xmlStream;
     }
 
     /**
      * @param xmlStream
      *            the xmlStream to set
      */
     public void setXmlStream(InputStream xmlStream) {
         this.xmlStream = xmlStream;
     }
 
     /**
      * @return the forceUnpublishState
      */
     public boolean isForceUnpublishState() {
         return forceUnpublishState;
     }
 
     /**
      * @param forceUnpublishState
      */
     public void setForceUnpublishState(boolean forceUnpublishState) {
         this.forceUnpublishState = forceUnpublishState;
     }
 
     /**
      * @return the xmlFileName
      */
     public String getXmlFileName() {
         return xmlFileName;
     }
 
     /**
      * @param xmlFileName
      *            the xmlFileName to set
      */
     public void setXmlFileName(String xmlFileName) {
         this.xmlFileName = xmlFileName;
     }
 
     /**
      * @return the identifierBehavior
      */
     public int getIdentifierBehavior() {
         return identifierBehavior;
     }
 
     /**
      * See {@link javax.jcr.ImportUUIDBehavior} constants definition.
      * 
      * @param identifierBehavior the identifierBehavior to set
      */
     public void setIdentifierBehavior(int identifierBehavior) {
         this.identifierBehavior = identifierBehavior;
     }
 
 }