NodeTypeImportResource.java

/*
 * Copyright (C) 2003-2017 eXo Platform SAS.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.exoplatform.management.ecmadmin.operations.nodetype;

import org.exoplatform.container.xml.ComponentPlugin;
import org.exoplatform.container.xml.Configuration;
import org.exoplatform.container.xml.ExternalComponentPlugins;
import org.exoplatform.container.xml.PropertiesParam;
import org.exoplatform.container.xml.Property;
import org.exoplatform.management.ecmadmin.operations.ECMAdminImportResource;
import org.exoplatform.services.jcr.RepositoryService;
import org.exoplatform.services.jcr.core.nodetype.ExtendedNodeTypeManager;
import org.exoplatform.services.jcr.core.nodetype.NodeTypeValue;
import org.exoplatform.services.jcr.core.nodetype.NodeTypeValuesList;
import org.exoplatform.services.log.ExoLogger;
import org.exoplatform.services.log.Log;
import org.gatein.management.api.exceptions.OperationException;
import org.gatein.management.api.operation.OperationContext;
import org.gatein.management.api.operation.OperationNames;
import org.gatein.management.api.operation.ResultHandler;
import org.gatein.management.api.operation.model.NoResultModel;
import org.jibx.runtime.BindingDirectory;
import org.jibx.runtime.IBindingFactory;
import org.jibx.runtime.IUnmarshallingContext;
import org.jibx.runtime.JiBXException;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.zip.ZipEntry;
import java.util.zip.ZipInputStream;

import javax.jcr.AccessDeniedException;
import javax.jcr.NamespaceException;
import javax.jcr.NamespaceRegistry;
import javax.jcr.RepositoryException;
import javax.jcr.UnsupportedRepositoryOperationException;

/**
 * The Class NodeTypeImportResource.
 *
 * @author <a href="mailto:bkhanfir@exoplatform.com">Boubaker Khanfir</a>
 * @version $Revision$
 */
public class NodeTypeImportResource extends ECMAdminImportResource {
  
  /** The Constant log. */
  private static final Log log = ExoLogger.getLogger(NodeTypeImportResource.class);
  
  /** The repository service. */
  private RepositoryService repositoryService;
  
  /** The path prefix. */
  private String pathPrefix = null;

  /**
   * Instantiates a new node type import resource.
   *
   * @param pathPrefix the path prefix
   */
  public NodeTypeImportResource(String pathPrefix) {
    super(null);
    this.pathPrefix = "ecmadmin/" + pathPrefix + "/";
  }

  /**
   * Instantiates a new node type import resource.
   *
   * @param pathPrefix the path prefix
   * @param filePath the file path
   */
  public NodeTypeImportResource(String pathPrefix, String filePath) {
    super(filePath);
    this.pathPrefix = "ecmadmin/" + pathPrefix + "/";
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public void execute(OperationContext operationContext, ResultHandler resultHandler) throws OperationException {
    // get attributes and attachement inputstream
    super.execute(operationContext, resultHandler);

    if (repositoryService == null) {
      repositoryService = operationContext.getRuntimeContext().getRuntimeComponent(RepositoryService.class);
    }
    try {
      ExtendedNodeTypeManager extManager = repositoryService.getCurrentRepository().getNodeTypeManager();

      log.info("Import node types (existing nodetypes will be ignored) :");

      ZipInputStream zin = new ZipInputStream(attachmentInputStream);
      List<NodeTypeValue> nodeTypeValues = new ArrayList<NodeTypeValue>();
      try {
        ZipEntry ze = null;
        while ((ze = zin.getNextEntry()) != null) {
          try {
            if (!ze.getName().startsWith(pathPrefix)) {
              continue;
            }
            if (ze.getName().endsWith("-nodeType.xml")) {
              IBindingFactory factory = BindingDirectory.getFactory(NodeTypeValuesList.class);
              IUnmarshallingContext uctx = factory.createUnmarshallingContext();
              NodeTypeValuesList nodeTypeValuesList = (NodeTypeValuesList) uctx.unmarshalDocument(zin, null);
              ArrayList<?> ntvList = nodeTypeValuesList.getNodeTypeValuesList();
              for (Object object : ntvList) {
                NodeTypeValue nodeTypeValue = (NodeTypeValue) object;
                log.info("- " + nodeTypeValue.getName());
                nodeTypeValues.add(nodeTypeValue);
              }
            } else if (ze.getName().endsWith("namespaces-configuration.xml")) {
              // Import namespaces
              registerNamespaces(zin);
            }
          } finally {
            zin.closeEntry();
          }
        }
      } finally {
        zin.close();
      }

      if (replaceExisting) {
        log.info("Option replace-existing ignored for nodetypes (" + pathPrefix.substring(0, pathPrefix.length() - 1)
            + ") import, since the behavior isn't safe. So existing nodetypes will be ignored.");
      }

      extManager.registerNodeTypes(nodeTypeValues, ExtendedNodeTypeManager.IGNORE_IF_EXISTS);

      log.info("Node types imported");

      resultHandler.completed(NoResultModel.INSTANCE);
    } catch (Exception exception) {
      throw new OperationException(OperationNames.IMPORT_RESOURCE, "Error while importing nodetypes.", exception);
    }
  }

  /**
   * Register namespaces.
   *
   * @param zin the zin
   * @throws JiBXException the ji BX exception
   * @throws RepositoryException the repository exception
   * @throws NamespaceException the namespace exception
   * @throws UnsupportedRepositoryOperationException the unsupported repository operation exception
   * @throws AccessDeniedException the access denied exception
   */
  private void registerNamespaces(ZipInputStream zin) throws JiBXException, RepositoryException, NamespaceException, UnsupportedRepositoryOperationException, AccessDeniedException {
    IBindingFactory bfact = BindingDirectory.getFactory(Configuration.class);
    IUnmarshallingContext uctx = bfact.createUnmarshallingContext();

    Configuration configuration = (Configuration) uctx.unmarshalDocument(zin, "UTF-8");
    ExternalComponentPlugins externalComponentPlugins = configuration.getExternalComponentPlugins(RepositoryService.class.getName());
    List<ComponentPlugin> componentPlugins = externalComponentPlugins.getComponentPlugins();
    if (componentPlugins == null || componentPlugins.isEmpty()) {
      log.warn("Wrong Namespaces configuration, no namespace will be imported");
      return;
    }
    ComponentPlugin componentPlugin = componentPlugins.get(0);
    PropertiesParam propertiesParam = componentPlugin.getInitParams().getPropertiesParam("namespaces");
    if (propertiesParam == null || propertiesParam.getProperties().isEmpty()) {
      log.warn("Wrong Namespaces configuration, no namespace will be imported");
      return;
    }

    NamespaceRegistry namespaceRegistry = repositoryService.getCurrentRepository().getNamespaceRegistry();

    Iterator<Property> propertiesIterator = propertiesParam.getPropertyIterator();
    while (propertiesIterator.hasNext()) {
      Property property = (Property) propertiesIterator.next();
      String namespacePrefix = property.getName();
      String namespaceURI = null;
      try {
        namespaceURI = namespaceRegistry.getURI(namespacePrefix);
      } catch (Exception exception) {
        // Nothing to do
      }
      if (namespaceURI == null) {
        namespaceURI = property.getValue();
        namespaceRegistry.registerNamespace(namespacePrefix, namespaceURI);
      }
    }
  }
}