Data store implementation

commons/src/main/java/com/powsybl/commons/datasource/ObservableInputStream.java

@@ -14,13 +14,13 @@
 /**
  * @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
  */
-class ObservableInputStream extends ForwardingInputStream<InputStream> {
+public class ObservableInputStream extends ForwardingInputStream<InputStream> {
 
     private final String streamName;
 
     private final DataSourceObserver observer;
 
-    ObservableInputStream(InputStream is, String streamName, DataSourceObserver observer) {
+    public ObservableInputStream(InputStream is, String streamName, DataSourceObserver observer) {
         super(is);
         this.streamName = streamName;
         this.observer = observer;

commons/src/main/java/com/powsybl/commons/datasource/StoreDataSource.java

@@ -0,0 +1,71 @@
+/**
+ * Copyright (c) 2020, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package com.powsybl.commons.datasource;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.util.HashSet;
+import java.util.Objects;
+import java.util.Set;
+
+import com.powsybl.commons.datastore.DataStore;
+
+/**
+ * @author Giovanni Ferrari <giovanni.ferrari at techrain.eu>
+ */
+public class StoreDataSource implements DataSource {
+
+    private final DataStore store;
+    private final String baseName;
+
+    public StoreDataSource(DataStore store, String baseName) {
+        this.store = Objects.requireNonNull(store);
+        this.baseName = Objects.requireNonNull(baseName);
+    }
+
+    @Override
+    public String getBaseName() {
+        return baseName;
+    }
+
+    @Override
+    public boolean exists(String suffix, String ext) throws IOException {
+        return store.exists(DataSourceUtil.getFileName(baseName, suffix, ext));
+    }
+
+    @Override
+    public boolean exists(String fileName) throws IOException {
+        return store.exists(fileName);
+    }
+
+    @Override
+    public InputStream newInputStream(String suffix, String ext) throws IOException {
+        return store.newInputStream(DataSourceUtil.getFileName(baseName, suffix, ext));
+    }
+
+    @Override
+    public InputStream newInputStream(String fileName) throws IOException {
+        return store.newInputStream(fileName);
+    }
+
+    @Override
+    public Set<String> listNames(String regex) throws IOException {
+        return new HashSet<>(store.getEntryNames());
+    }
+
+    @Override
+    public OutputStream newOutputStream(String fileName, boolean append) throws IOException {
+        return store.newOutputStream(fileName, append);
+    }
+
+    @Override
+    public OutputStream newOutputStream(String suffix, String ext, boolean append) throws IOException {
+        return store.newOutputStream(DataSourceUtil.getFileName(baseName, suffix, ext), append);
+    }
+
+}

commons/src/main/java/com/powsybl/commons/datasource/ZipFileDataSource.java

@@ -11,20 +11,17 @@
 import java.io.OutputStream;
 import java.nio.file.Files;
 import java.nio.file.Path;
-import java.nio.file.StandardCopyOption;
 import java.util.Enumeration;
 import java.util.HashSet;
 import java.util.Objects;
 import java.util.Set;
 import java.util.regex.Pattern;
 
-import com.google.common.io.ByteStreams;
-import com.powsybl.commons.io.ForwardingInputStream;
-import com.powsybl.commons.io.ForwardingOutputStream;
+import com.powsybl.commons.util.ZipEntryInputStream;
+import com.powsybl.commons.util.ZipEntryOutputStream;
 
 import net.java.truevfs.comp.zip.ZipEntry;
 import net.java.truevfs.comp.zip.ZipFile;
-import net.java.truevfs.comp.zip.ZipOutputStream;
 
 /**
  * @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
@@ -99,23 +96,6 @@ public InputStream newInputStream(String suffix, String ext) throws IOException
         return newInputStream(DataSourceUtil.getFileName(baseName, suffix, ext));
     }
 
-    private static final class ZipEntryInputStream extends ForwardingInputStream<InputStream> {
-
-        private final ZipFile zipFile;
-
-        public ZipEntryInputStream(ZipFile zipFile, String fileName) throws IOException {
-            super(zipFile.getInputStream(fileName));
-            this.zipFile = zipFile;
-        }
-
-        @Override
-        public void close() throws IOException {
-            super.close();
-
-            zipFile.close();
-        }
-    }
-
     @Override
     public InputStream newInputStream(String fileName) throws IOException {
         Objects.requireNonNull(fileName);
@@ -127,71 +107,14 @@ public InputStream newInputStream(String fileName) throws IOException {
         return null;
     }
 
-    private static final class ZipEntryOutputStream extends ForwardingOutputStream<ZipOutputStream> {
-
-        private final Path zipFilePath;
-
-        private final String fileName;
-
-        private boolean closed;
-
-        private ZipEntryOutputStream(Path zipFilePath, String fileName) throws IOException {
-            super(new ZipOutputStream(Files.newOutputStream(getTmpZipFilePath(zipFilePath))));
-            this.zipFilePath = zipFilePath;
-            this.fileName = fileName;
-            this.closed = false;
-
-            // create new entry
-            os.putNextEntry(new ZipEntry(fileName));
-        }
-
-        private static Path getTmpZipFilePath(Path zipFilePath) {
-            return zipFilePath.getParent().resolve(zipFilePath.getFileName() + ".tmp");
-        }
-
-        @Override
-        public void close() throws IOException {
-            if (!closed) {
-                // close new entry
-                os.closeEntry();
-
-                // copy existing entries
-                if (Files.exists(zipFilePath)) {
-                    try (ZipFile zipFile = new ZipFile(zipFilePath)) {
-                        Enumeration<? extends ZipEntry> e = zipFile.entries();
-                        while (e.hasMoreElements()) {
-                            ZipEntry zipEntry = e.nextElement();
-                            if (!zipEntry.getName().equals(fileName)) {
-                                os.putNextEntry(zipEntry);
-                                try (InputStream zis = zipFile.getInputStream(zipEntry.getName())) {
-                                    ByteStreams.copy(zis, os);
-                                }
-                                os.closeEntry();
-                            }
-                        }
-                    }
-                }
-
-                // close zip
-                super.close();
-
-                // swap with tmp zip
-                Path tmpZipFilePath = getTmpZipFilePath(zipFilePath);
-                Files.move(tmpZipFilePath, zipFilePath, StandardCopyOption.REPLACE_EXISTING);
-
-                closed = true;
-            }
-        }
-    }
-
     @Override
     public OutputStream newOutputStream(String fileName, boolean append) throws IOException {
         Objects.requireNonNull(fileName);
         if (append) {
             throw new UnsupportedOperationException("append not supported in zip file data source");
         }
         Path zipFilePath = getZipFilePath();
-        OutputStream os = new ZipEntryOutputStream(zipFilePath, fileName);
+        OutputStream os = new ZipEntryOutputStream(zipFilePath, fileName, entryExists(zipFilePath, fileName));
         return observer != null ? new ObservableOutputStream(os, zipFilePath + ":" + fileName, observer) : os;
     }
 
@@ -217,4 +140,5 @@ public Set<String> listNames(String regex) throws IOException {
         }
         return names;
     }
+
 }

commons/src/main/java/com/powsybl/commons/datastore/AbstractDataResolver.java

@@ -0,0 +1,64 @@
+/**
+ * Copyright (c) 2020, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package com.powsybl.commons.datastore;
+
+import java.io.IOException;
+import java.util.List;
+import java.util.Objects;
+import java.util.Optional;
+import java.util.Properties;
+import java.util.stream.Collectors;
+
+import com.google.common.io.Files;
+
+/**
+ * @author Giovanni Ferrari <giovanni.ferrari at techrain.eu>
+ */
+public abstract class AbstractDataResolver implements DataResolver {
+
+    @Override
+    public Optional<DataPack> resolve(ReadOnlyDataStore store, String mainFileName, Properties parameters)
+            throws IOException, NonUniqueResultException {
+        Objects.requireNonNull(store);
+
+        DataPack dp = null;
+        if (mainFileName != null) {
+            if (store.exists(mainFileName) && checkFileExtension(mainFileName)) {
+                dp = buildDataPack(store, mainFileName);
+            }
+        } else {
+            List<String> candidates = store.getEntryNames().stream().filter(this::checkFileExtension).collect(Collectors.toList());
+            if (candidates.size() > 1) {
+                throw new NonUniqueResultException("Non unique data pack found");
+            } else if (candidates.size() == 1) {
+                String entryName = candidates.get(0);
+                dp = buildDataPack(store, entryName);
+            }
+        }
+        return Optional.ofNullable(dp);
+    }
+
+    @Override
+    public boolean validate(DataPack pack, Properties properties) {
+        Optional<DataEntry> main = pack.getMainEntry();
+        return pack.getDataFormatId().equals(getDataFormat().getId()) && main.isPresent() && checkFileExtension(main.get().getName());
+    }
+
+    public boolean checkFileExtension(String filename) {
+        return getDataFormat().getExtensions().contains(Files.getFileExtension(filename));
+    }
+
+    private DataPack buildDataPack(ReadOnlyDataStore store, String mainFileName) {
+        DataPack dp = new DataPack(store, getDataFormat().getId());
+        DataEntry entry = new DataEntry(mainFileName, DataPack.MAIN_ENTRY_TAG);
+        dp.addEntry(entry);
+        return dp;
+    }
+
+    public abstract DataFormat getDataFormat();
+
+}

commons/src/main/java/com/powsybl/commons/datastore/Bzip2FileDataStore.java

@@ -0,0 +1,65 @@
+/**
+ * Copyright (c) 2020, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package com.powsybl.commons.datastore;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Collections;
+import java.util.List;
+import java.util.Objects;
+
+import org.apache.commons.compress.compressors.bzip2.BZip2CompressorInputStream;
+import org.apache.commons.compress.compressors.bzip2.BZip2CompressorOutputStream;
+
+import com.powsybl.commons.datasource.Bzip2FileDataSource;
+import com.powsybl.commons.datasource.DataSource;
+import com.powsybl.commons.datasource.DataSourceUtil;
+
+/**
+ * @author Giovanni Ferrari <giovanni.ferrari at techrain.eu>
+ */
+public class Bzip2FileDataStore implements DataStore {
+
+    private final Path path;
+
+    public Bzip2FileDataStore(Path path) {
+        this.path = Objects.requireNonNull(path);
+    }
+
+    @Override
+    public List<String> getEntryNames() throws IOException {
+        return Collections.singletonList(getEntryName());
+    }
+
+    @Override
+    public boolean exists(String entryName) {
+        return getEntryName().equals(entryName);
+    }
+
+    @Override
+    public InputStream newInputStream(String entryName) throws IOException {
+        return new BZip2CompressorInputStream(Files.newInputStream(path));
+    }
+
+    @Override
+    public OutputStream newOutputStream(String entryName, boolean append) throws IOException {
+        return new BZip2CompressorOutputStream(Files.newOutputStream(path, DataSourceUtil.getOpenOptions(append)));
+    }
+
+    private String getEntryName() {
+        String fileName = path.getFileName().toString();
+        return fileName.substring(0, fileName.lastIndexOf(".bz2"));
+    }
+
+    @Override
+    public DataSource toDataSource(String filename) {
+        return new Bzip2FileDataSource(path.getParent(), filename);
+    }
+}

commons/src/main/java/com/powsybl/commons/datastore/DataEntry.java

@@ -0,0 +1,39 @@
+/**
+ * Copyright (c) 2020, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package com.powsybl.commons.datastore;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+import java.util.Objects;
+
+/**
+ * @author Giovanni Ferrari <giovanni.ferrari at techrain.eu>
+ */
+public class DataEntry {
+
+    private final String name;
+
+    private final List<String> tags = new ArrayList<>();
+
+    public DataEntry(String name, String... tags) {
+        this.name = Objects.requireNonNull(name);
+        if (tags != null)  {
+            this.tags.addAll(Arrays.asList(tags));
+        }
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public List<String> getTags() {
+        return Collections.unmodifiableList(tags);
+    }
+
+}