content: //
  // Licensed to the Apache Software Foundation (ASF) under one
  // or more contributor license agreements.  See the NOTICE file
  // distributed with this work for additional information
  // regarding copyright ownership.  The ASF licenses this file
  // to you under the Apache License, Version 2.0 (the
  // "License"); you may not use this file except in compliance
  // with the License.  You may obtain a copy of the License at
  //
  //   http://www.apache.org/licenses/LICENSE-2.0
  //
  // Unless required by applicable law or agreed to in writing,
  // software distributed under the License is distributed on an
  // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  // KIND, either express or implied.  See the License for the
  // specific language governing permissions and limitations
  // under the License.
  //
  
  package com.cloud.storage.template;
  
  import java.io.File;
  import java.util.List;
  import java.util.Map;
  
  import javax.naming.ConfigurationException;
  
  import com.cloud.agent.api.to.OVFInformationTO;
  import com.cloud.agent.api.to.deployasis.OVFConfigurationTO;
  import com.cloud.agent.api.to.deployasis.OVFEulaSectionTO;
  import com.cloud.agent.api.to.deployasis.OVFPropertyTO;
  import com.cloud.agent.api.to.deployasis.OVFVirtualHardwareItemTO;
  import com.cloud.agent.api.to.deployasis.OVFVirtualHardwareSectionTO;
  import com.cloud.agent.api.to.deployasis.OVFNetworkTO;
  import org.apache.commons.collections.CollectionUtils;
  import org.apache.commons.lang3.StringUtils;
  import org.w3c.dom.Document;
  import org.w3c.dom.Element;
  import org.w3c.dom.NodeList;
  
  import com.cloud.agent.api.storage.OVFHelper;
  import com.cloud.agent.api.to.DatadiskTO;
  import com.cloud.exception.InternalErrorException;
  import com.cloud.storage.Storage.ImageFormat;
  import com.cloud.storage.StorageLayer;
  import com.cloud.utils.Pair;
  import com.cloud.utils.component.AdapterBase;
  import com.cloud.utils.script.Script;
  
  /**
   * processes the content of an OVA for registration of a template
   */
  public class OVAProcessor extends AdapterBase implements Processor {
      StorageLayer _storage;
  
      @Override
      public FormatInfo process(String templatePath, ImageFormat format, String templateName) throws InternalErrorException {
          return process(templatePath, format, templateName, 0);
      }
  
      @Override
      public FormatInfo process(String templatePath, ImageFormat format, String templateName, long processTimeout) throws InternalErrorException {
          if (! conversionChecks(format)){
              return null;
          }
  
          logger.info("Template processing. templatePath: " + templatePath + ", templateName: " + templateName);
          String templateFilePath = templatePath + File.separator + templateName + "." + ImageFormat.OVA.getFileExtension();
          if (!_storage.exists(templateFilePath)) {
              if (logger.isInfoEnabled()) {
                  logger.info("Unable to find the vmware template file: " + templateFilePath);
              }
              return null;
          }
  
          String templateFileFullPath = unpackOva(templatePath, templateName, processTimeout);
  
          setFileSystemAccessRights(templatePath);
  
          FormatInfo info = createFormatInfo(templatePath, templateName, templateFilePath, templateFileFullPath);
  
          return info;
      }
  
      private FormatInfo createFormatInfo(String templatePath, String templateName, String templateFilePath, String templateFileFullPath) throws InternalErrorException {
          FormatInfo info = new FormatInfo();
          info.format = ImageFormat.OVA;
          info.filename = templateName + "." + ImageFormat.OVA.getFileExtension();
          info.size = _storage.getSize(templateFilePath);
          info.virtualSize = getTemplateVirtualSize(templatePath, info.filename);
          validateOva(templateFileFullPath, info);
  
          return info;
      }
  
      /**
       * side effect; properties are added to the info
       *
       * @throws InternalErrorException on an invalid ova contents
       */
      private void validateOva(String templateFileFullPath, FormatInfo info) throws InternalErrorException {
          String ovfFilePath = getOVFFilePath(templateFileFullPath);
          OVFHelper ovfHelper = new OVFHelper();
          Document doc = ovfHelper.getOvfParser().parseOVFFile(ovfFilePath);
  
          OVFInformationTO ovfInformationTO = createOvfInformationTO(ovfHelper, doc, ovfFilePath);
          info.ovfInformationTO = ovfInformationTO;
      }
  
      private OVFInformationTO createOvfInformationTO(OVFHelper ovfHelper, Document doc, String ovfFilePath) throws InternalErrorException {
          OVFInformationTO ovfInformationTO = new OVFInformationTO();
  
          List<DatadiskTO> disks = ovfHelper.getOVFVolumeInfoFromFile(ovfFilePath, doc, null);
          if (CollectionUtils.isNotEmpty(disks)) {
              if (logger.isTraceEnabled()) {
                  logger.trace(String.format("Found %d disks in template %s", disks.size(), ovfFilePath));
              }
              ovfInformationTO.setDisks(disks);
          }
          List<OVFNetworkTO> nets = ovfHelper.getNetPrerequisitesFromDocument(doc);
          if (CollectionUtils.isNotEmpty(nets)) {
              logger.info("Found " + nets.size() + " prerequisite networks");
              ovfInformationTO.setNetworks(nets);
          } else if (logger.isTraceEnabled()) {
              logger.trace(String.format("no net prerequisites found in template %s", ovfFilePath));
          }
          List<OVFPropertyTO> ovfProperties = ovfHelper.getConfigurableOVFPropertiesFromDocument(doc);
          if (CollectionUtils.isNotEmpty(ovfProperties)) {
              logger.info("Found " + ovfProperties.size() + " configurable OVF properties");
              ovfInformationTO.setProperties(ovfProperties);
          } else if (logger.isTraceEnabled()) {
              logger.trace(String.format("no ovf properties found in template %s", ovfFilePath));
          }
          OVFVirtualHardwareSectionTO hardwareSection = ovfHelper.getVirtualHardwareSectionFromDocument(doc);
          List<OVFConfigurationTO> configurations = hardwareSection.getConfigurations();
          if (CollectionUtils.isNotEmpty(configurations)) {
              logger.info("Found " + configurations.size() + " deployment option configurations");
          }
          List<OVFVirtualHardwareItemTO> hardwareItems = hardwareSection.getCommonHardwareItems();
          if (CollectionUtils.isNotEmpty(hardwareItems)) {
              logger.info("Found " + hardwareItems.size() + " virtual hardware items");
          }
          if (StringUtils.isNotBlank(hardwareSection.getMinimiumHardwareVersion())) {
              logger.info("Found minimum hardware version " + hardwareSection.getMinimiumHardwareVersion());
          }
          ovfInformationTO.setHardwareSection(hardwareSection);
          List<OVFEulaSectionTO> eulaSections = ovfHelper.getEulaSectionsFromDocument(doc);
          if (CollectionUtils.isNotEmpty(eulaSections)) {
              logger.info("Found " + eulaSections.size() + " license agreements");
              ovfInformationTO.setEulaSections(eulaSections);
          }
          Pair<String, String> guestOsPair = ovfHelper.getOperatingSystemInfoFromDocument(doc);
          if (guestOsPair != null) {
              logger.info("Found guest OS information: " + guestOsPair.first() + " - " + guestOsPair.second());
              ovfInformationTO.setGuestOsInfo(guestOsPair);
          }
          return ovfInformationTO;
      }
  
      private void setFileSystemAccessRights(String templatePath) {
          Script command;
          String result;
  
          command = new Script("chmod", 0, logger);
          command.add("-R");
          command.add("666", templatePath);
          result = command.execute();
          if (result != null) {
              logger.warn("Unable to set permissions for files in " + templatePath + " due to " + result);
          }
          command = new Script("chmod", 0, logger);
          command.add("777", templatePath);
          result = command.execute();
          if (result != null) {
              logger.warn("Unable to set permissions for " + templatePath + " due to " + result);
          }
      }
  
      private String unpackOva(String templatePath, String templateName, long processTimeout) throws InternalErrorException {
          logger.info("Template processing - untar OVA package. templatePath: " + templatePath + ", templateName: " + templateName);
          String templateFileFullPath = templatePath + File.separator + templateName + "." + ImageFormat.OVA.getFileExtension();
          File templateFile = new File(templateFileFullPath);
          Script command = new Script("tar", processTimeout, logger);
          command.add("--no-same-owner");
          command.add("--no-same-permissions");
          command.add("-xf", templateFileFullPath);
          command.setWorkDir(templateFile.getParent());
          String result = command.execute();
          if (result != null) {
              logger.info("failed to untar OVA package due to " + result + ". templatePath: " + templatePath + ", templateName: " + templateName);
              throw new InternalErrorException("failed to untar OVA package");
          }
          return templateFileFullPath;
      }
  
      private boolean conversionChecks(ImageFormat format) {
          if (format != null) {
              if (logger.isInfoEnabled()) {
                  logger.info("We currently don't handle conversion from " + format + " to OVA.");
              }
              return false;
          }
          if (logger.isTraceEnabled()) {
              logger.trace("We are handling format " + format + ".");
          }
          return true;
      }
  
      @Override
      public long getVirtualSize(File file) {
          try {
              long size = getTemplateVirtualSize(file.getParent(), file.getName());
              return size;
          } catch (Exception e) {
              logger.info("[ignored]"
                      + "failed to get virtual template size for ova: " + e.getLocalizedMessage());
          }
          return file.length();
      }
  
      /**
       * gets the virtual size from the OVF file meta data.
       *
       * @return the accumulative virtual size of the disk definitions in the OVF
       * @throws InternalErrorException
       */
      public long getTemplateVirtualSize(String templatePath, String templateName) throws InternalErrorException {
          long virtualSize = 0;
          String templateFileFullPath = templatePath.endsWith(File.separator) ? templatePath : templatePath + File.separator;
          templateFileFullPath += templateName.endsWith(ImageFormat.OVA.getFileExtension()) ? templateName : templateName + "." + ImageFormat.OVA.getFileExtension();
          String ovfFileName = getOVFFilePath(templateFileFullPath);
          OVFHelper ovfHelper = new OVFHelper();
          if (ovfFileName == null) {
              String msg = "Unable to locate OVF file in template package directory: " + templatePath;
              logger.error(msg);
              throw new InternalErrorException(msg);
          }
          try {
              Document ovfDoc = ovfHelper.getOvfParser().parseOVFFile(ovfFileName);
              NodeList diskElements = ovfHelper.getOvfParser().getElementsFromOVFDocument(ovfDoc, "Disk");
              for (int i = 0; i < diskElements.getLength(); i++) {
                  Element disk = (Element)diskElements.item(i);
                  String diskSizeValue = disk.getAttribute("ovf:capacity");
                  long diskSize = 1;
                  try {
                      diskSize = Long.parseLong(diskSizeValue);
                  } catch (NumberFormatException e) {
                      // ASSUMEably the diskSize contains a property for replacement
                      logger.warn(String.format("the disksize for disk %s is not a valid number: %s", disk.getAttribute("diskId"), diskSizeValue));
                      // TODO parse the property to get any value can not be done at registration time
                      //  and will have to be done at deploytime, so for orchestration purposes
                      //  we now assume, a value of one
                  }
                  String allocationUnits = disk.getAttribute("ovf:capacityAllocationUnits");
                  diskSize = OVFHelper.getDiskVirtualSize(diskSize, allocationUnits, ovfFileName);
                  virtualSize += diskSize;
              }
              return virtualSize;
          } catch (InternalErrorException  | NumberFormatException e) {
              String msg = "getTemplateVirtualSize: Unable to parse OVF XML document " + templatePath + " to get the virtual disk " + templateName + " size due to " + e;
              logger.error(msg);
              throw new InternalErrorException(msg);
          }
      }
  
      private String getOVFFilePath(String srcOVAFileName) {
          File file = new File(srcOVAFileName);
          assert (_storage != null);
          String[] files = _storage.listFiles(file.getParent());
          if (files != null) {
              for (String fileName : files) {
                  if (fileName.toLowerCase().endsWith(".ovf")) {
                      File ovfFile = new File(fileName);
                      return file.getParent() + File.separator + ovfFile.getName();
                  }
              }
          }
          return null;
      }
  
      @Override
      public boolean configure(String name, Map<String, Object> params) throws ConfigurationException {
          _storage = (StorageLayer)params.get(StorageLayer.InstanceConfigKey);
          if (_storage == null) {
              throw new ConfigurationException("Unable to get storage implementation");
          }
  
          return true;
      }
  }
  