JMadModelDefinitionExporterImpl.java

  1. // @formatter:off
  2. /*******************************************************************************
  3.  *
  4.  * This file is part of JMad.
  5.  * 
  6.  * Copyright (c) 2008-2011, CERN. All rights reserved.
  7.  *
  8.  * Licensed under the Apache License, Version 2.0 (the "License");
  9.  * you may not use this file except in compliance with the License.
  10.  * You may obtain a copy of the License at
  11.  *
  12.  *     http://www.apache.org/licenses/LICENSE-2.0
  13.  *
  14.  * Unless required by applicable law or agreed to in writing, software
  15.  * distributed under the License is distributed on an "AS IS" BASIS,
  16.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17.  * See the License for the specific language governing permissions and
  18.  * limitations under the License.
  19.  * 
  20.  ******************************************************************************/
  21. // @formatter:on

  23. /**
  24.  * 
  25.  */
  26. package cern.accsoft.steering.jmad.modeldefs.io.impl;

  28. import java.io.File;
  29. import java.io.FileOutputStream;
  30. import java.io.IOException;
  31. import java.io.InputStream;
  32. import java.util.ArrayList;
  33. import java.util.Collection;
  34. import java.util.HashMap;
  35. import java.util.List;
  36. import java.util.Map;
  37. import java.util.zip.ZipEntry;
  38. import java.util.zip.ZipOutputStream;

  40. import org.slf4j.Logger;
  41. import org.slf4j.LoggerFactory;

  43. import cern.accsoft.steering.jmad.domain.file.ModelFile;
  44. import cern.accsoft.steering.jmad.domain.machine.SequenceDefinition;
  45. import cern.accsoft.steering.jmad.domain.machine.SequenceDefinitionImpl;
  46. import cern.accsoft.steering.jmad.modeldefs.domain.JMadModelDefinition;
  47. import cern.accsoft.steering.jmad.modeldefs.domain.JMadModelDefinitionImpl;
  48. import cern.accsoft.steering.jmad.modeldefs.io.JMadModelDefinitionExportRequest;
  49. import cern.accsoft.steering.jmad.modeldefs.io.JMadModelDefinitionExporter;
  50. import cern.accsoft.steering.jmad.modeldefs.io.ModelDefinitionPersistenceService;
  51. import cern.accsoft.steering.jmad.modeldefs.io.ModelFileFinder;
  52. import cern.accsoft.steering.jmad.modeldefs.io.ModelFileFinderManager;
  53. import cern.accsoft.steering.jmad.util.FileUtil;
  54. import cern.accsoft.steering.jmad.util.StreamUtil;
  55. import cern.accsoft.steering.jmad.util.xml.PersistenceServiceException;

  57. /**
  58.  * This is the default implementation of the {@link JMadModelDefinitionExporter}
  59.  * 
  60.  * @author Kajetan Fuchsberger (kajetan.fuchsberger at cern.ch)
  61.  */
  62. public class JMadModelDefinitionExporterImpl implements JMadModelDefinitionExporter {
  63.     /**
  64.      * The persistence service to use to write model definition to xml. (injected by
  65.      * spring)
  66.      */
  67.     private List<ModelDefinitionPersistenceService> persistenceServices = new ArrayList<ModelDefinitionPersistenceService>();

  69.     /**
  70.      * The class which keeps track of file finders for the model definitions.
  71.      */
  72.     private ModelFileFinderManager fileFinderManager;

  74.     /** The logger for the class */
  75.     private static final Logger LOGGER = LoggerFactory.getLogger(JMadModelDefinitionExporterImpl.class);

  77.     @Override
  78.     public File export(JMadModelDefinitionExportRequest exportRequest, File exportPath) {
  79.         if (exportRequest == null) {
  80.             LOGGER.error("No model definition given to export.");
  81.             return null;
  82.         }
  83.         if (exportPath == null) {
  84.             LOGGER.error("No file given. Cannot export model definition.");
  85.             return null;
  86.         }

  88.         ModelDefinitionPersistenceService persistenceService = findPersistenceService(exportPath.getName());

  90.         if (persistenceService != null || exportPath.isDirectory()) {
  91.             return exportAsFiles(exportRequest, exportPath);
  92.         } else {
  93.             /* per default we export as zip */
  94.             return exportAsZip(exportRequest, exportPath);
  95.         }
  96.     }

  98.     @Override
  99.     public File exportAsFiles(JMadModelDefinitionExportRequest exportRequest, File exportPath) {
  100.         if (exportRequest == null) {
  101.             LOGGER.error("No model definition given to export.");
  102.             return null;
  103.         }
  104.         if (exportPath == null) {
  105.             LOGGER.error("No destination dir given. Cannot export model definition.");
  106.             return null;
  107.         }
  108.         JMadModelDefinition modelDefinition = tailorModelDefinition(exportRequest);

  110.         File xmlFile;
  111.         File destDir;
  112.         if (exportPath.isDirectory()) {
  113.             destDir = exportPath;
  114.             /* per default we save as xml */
  115.             xmlFile = new File(destDir.getAbsolutePath() + File.separator + getFileName(modelDefinition));
  116.         } else {
  117.             destDir = exportPath.getAbsoluteFile().getParentFile();
  118.             xmlFile = exportPath;
  119.         }
  120.         FileUtil.createDir(destDir, false);

  122.         /*
  123.          * first we save the model-def file. If it matches one of the extensions of the
  124.          * persisters, then we use that one, otherwise we use the default.
  125.          */
  126.         ModelDefinitionPersistenceService persistenceService = findPersistenceService(xmlFile.getAbsolutePath());
  127.         if (persistenceService == null) {
  128.             xmlFile = new File(xmlFile.getAbsolutePath() + ModelDefinitionUtil.getDefaultFileExtension());
  129.             persistenceService = findPersistenceService(xmlFile.getAbsolutePath());
  130.         }
  131.         if (persistenceService == null) {
  132.             LOGGER.error("Cannot find appropriate persistence service for file '" + xmlFile.getAbsolutePath() + "'.");
  133.         }

  135.         try {

  137.             persistenceService.save(modelDefinition, xmlFile);

  139.             /*
  140.              * then we loop through all model files and copy all the files.
  141.              */
  142.             ModelFileFinder fileFinder = getFileFinderManager().getModelFileFinder(modelDefinition);
  143.             for (ModelFile modelFile : getRequiredFiles(modelDefinition)) {
  144.                 /*
  145.                  * We use the archive path here. So the file structure is the same as inside the
  146.                  * zip archive.
  147.                  */
  148.                 String archivePath = fileFinder.getArchivePath(modelFile);
  149.                 File file = new File(destDir.getAbsolutePath() + File.separator + archivePath);

  151.                 /*
  152.                  * ensure that the parent dir exists
  153.                  */
  154.                 FileUtil.createDir(file.getAbsoluteFile().getParentFile(), false);

  156.                 InputStream inStream = fileFinder.getStream(modelFile);
  157.                 if (!StreamUtil.toFile(inStream, file)) {
  158.                     LOGGER.error("Could not write file '" + file.getAbsolutePath() + "'");
  159.                     return null;
  160.                 }
  161.             }
  162.             return xmlFile;
  163.         } catch (PersistenceServiceException e) {
  164.             LOGGER.error("Could not save model definition to file '" + xmlFile.getAbsolutePath() + "'.", e);
  165.         }
  166.         return null;
  167.     }

  169.     private ModelDefinitionPersistenceService findPersistenceService(String fileName) {
  170.         for (ModelDefinitionPersistenceService persistenceService : getPersistenceServices()) {
  171.             if (persistenceService.isCorrectFileName(fileName)) {
  172.                 return persistenceService;
  173.             }
  174.         }
  175.         return null;
  176.     }

  178.     @Override
  179.     public File exportAsZip(JMadModelDefinitionExportRequest exportRequest, File file) {
  180.         if (exportRequest == null) {
  181.             LOGGER.error("No model definition given to export.");
  182.             return null;
  183.         }
  184.         if (file == null) {
  185.             LOGGER.error("No file given. Cannot export model definition.");
  186.             return null;
  187.         }
  188.         JMadModelDefinition modelDefinition = tailorModelDefinition(exportRequest);

  190.         File zipFile = ModelDefinitionUtil.ensureZipFileExtension(file);

  192.         try {
  193.             /* Create the output stream */
  194.             ZipOutputStream outStream;
  195.             outStream = new ZipOutputStream(new FileOutputStream(zipFile));

  197.             String baseName = ModelDefinitionUtil.getProposedIdStringFromName(modelDefinition);

  199.             /* Add a zip entry to the output stream each persister we have */
  200.             for (ModelDefinitionPersistenceService persistenceService : getPersistenceServices()) {
  201.                 outStream.putNextEntry(new ZipEntry(baseName + persistenceService.getFileExtension()));
  202.                 persistenceService.save(modelDefinition, outStream);
  203.                 outStream.closeEntry();
  204.             }

  206.             /*
  207.              * next we need the corresponding ModelFileFinder to find all the required files
  208.              * and put them in the archive.
  209.              */
  210.             ModelFileFinder fileFinder = getFileFinderManager().getModelFileFinder(modelDefinition);

  212.             /*
  213.              * now we are ready to copy all the files into the archive.
  214.              */
  215.             for (ModelFile modelFile : getRequiredFiles(modelDefinition)) {
  216.                 outStream.putNextEntry(new ZipEntry(fileFinder.getArchivePath(modelFile)));
  217.                 InputStream inStream = fileFinder.getStream(modelFile);
  218.                 StreamUtil.copy(inStream, outStream);
  219.                 outStream.closeEntry();
  220.                 inStream.close();
  221.             }

  223.             outStream.close();
  224.             return zipFile;
  225.         } catch (IOException e) {
  226.             LOGGER.error("Could not save model definition to zip file '" + zipFile.getAbsolutePath() + "'", e);
  227.         } catch (PersistenceServiceException e) {
  228.             LOGGER.error("Could not save model definition to zip file '" + zipFile.getAbsolutePath() + "'", e);
  229.         }
  230.         return null;
  231.     }

  233.     private JMadModelDefinition tailorModelDefinition(JMadModelDefinitionExportRequest request) {
  234.         JMadModelDefinition modelDefinitionForExport = cloneModel(request.getModelDefinition());

  236.         /* remove optics/sequences/ranges not selected */
  237.         modelDefinitionForExport.getOpticsDefinitions().removeIf(o -> !(request.getOpticsToExport().contains(o)));
  238.         modelDefinitionForExport.getSequenceDefinitions().removeIf(s -> !(request.getSequencesToExport().contains(s)));
  239.         modelDefinitionForExport.getSequenceDefinitions().forEach(//
  240.                 seq -> seq.getRangeDefinitions().removeIf(r -> !(request.getRangesToExport().contains(r))));

  242.         /* remove empty sequences (no ranges) */
  243.         modelDefinitionForExport.getSequenceDefinitions().removeIf(s -> s.getRangeDefinitions().isEmpty());

  245.         /* if we end up with an empty model, throw */
  246.         if (modelDefinitionForExport.getOpticsDefinitions().isEmpty()) {
  247.             throw new IllegalArgumentException("no optics definitions have been selected for export!");
  248.         }
  249.         if (modelDefinitionForExport.getSequenceDefinitions().isEmpty()) {
  250.             throw new IllegalArgumentException("no sequence definitions have been selected for export!");
  251.         }
  252.         if (modelDefinitionForExport.getRangeDefinitions().isEmpty()) {
  253.             throw new IllegalArgumentException("no ranges have been selected for export!");
  254.         }

  256.         /* fix defaults */
  257.         if (!modelDefinitionForExport.getOpticsDefinitions()
  258.                 .contains(modelDefinitionForExport.getDefaultOpticsDefinition())) {
  259.             ((JMadModelDefinitionImpl) modelDefinitionForExport)
  260.                     .setDefaultOpticsDefinition(modelDefinitionForExport.getOpticsDefinitions().get(0));
  261.         }

  263.         if (!modelDefinitionForExport.getSequenceDefinitions()
  264.                 .contains(modelDefinitionForExport.getDefaultSequenceDefinition())) {
  265.             ((JMadModelDefinitionImpl) modelDefinitionForExport)
  266.                     .setDefaultSequenceDefinition(modelDefinitionForExport.getSequenceDefinitions().get(0));
  267.         }

  269.         for (SequenceDefinition sequence : modelDefinitionForExport.getSequenceDefinitions()) {
  270.             if (!sequence.getRangeDefinitions().contains(sequence.getDefaultRangeDefinition())) {
  271.                 ((SequenceDefinitionImpl) sequence).setDefaultRangeDefinition(sequence.getRangeDefinitions().get(0));
  272.             }
  273.         }

  275.         return modelDefinitionForExport;
  276.     }

  278.     private JMadModelDefinition cloneModel(JMadModelDefinition model) {
  279.         for (ModelDefinitionPersistenceService cloneService : persistenceServices) {
  280.             try {
  281.                 return cloneService.clone(model);
  282.             } catch (Exception e) {
  283.                 /* try next service */
  284.             }
  285.         }
  286.         throw new IllegalStateException("no persistence service was able to clone the model definition");
  287.     }

  289.     private String getFileName(JMadModelDefinition modelDefinition) {
  290.         if ((modelDefinition.getSourceInformation() != null)
  291.                 && (modelDefinition.getSourceInformation().getFileName() != null)) {
  292.             return modelDefinition.getSourceInformation().getFileName();
  293.         }
  294.         return ModelDefinitionUtil.getProposedDefaultFileName(modelDefinition);
  295.     }

  297.     /**
  298.      * collects all the required files for a model definition. it returns a
  299.      * collection which will contain all the model files with the same archive path
  300.      * only once.
  301.      * 
  302.      * @param modelDefinition
  303.      *            the model definition for which to collect the files
  304.      * @return all the files, with unique archive-path
  305.      */
  306.     private Collection<ModelFile> getRequiredFiles(JMadModelDefinition modelDefinition) {
  307.         ModelFileFinder fileFinder = getFileFinderManager().getModelFileFinder(modelDefinition);
  308.         Map<String, ModelFile> modelFiles = new HashMap<String, ModelFile>();
  309.         for (ModelFile modelFile : ModelDefinitionUtil.getRequiredModelFiles(modelDefinition)) {
  310.             String archivePath = fileFinder.getArchivePath(modelFile);
  311.             modelFiles.put(archivePath, modelFile);
  312.         }
  313.         return modelFiles.values();
  314.     }

  316.     public void setFileFinderManager(ModelFileFinderManager fileFinderManager) {
  317.         this.fileFinderManager = fileFinderManager;
  318.     }

  320.     private ModelFileFinderManager getFileFinderManager() {
  321.         return fileFinderManager;
  322.     }

  324.     public void setPersistenceServices(List<ModelDefinitionPersistenceService> persistenceServices) {
  325.         this.persistenceServices = persistenceServices;
  326.     }

  328.     private List<ModelDefinitionPersistenceService> getPersistenceServices() {
  329.         return persistenceServices;
  330.     }

  332. }
Created with JaCoCo 0.8.3.201901230119