vxquery-core/src/main/java/org/apache/vxquery/runtime/functions/index/updateIndex/MetaFileUtil.java

/*
* 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 org.apache.vxquery.runtime.functions.index.updateIndex;

import org.apache.log4j.Level;
import org.apache.log4j.Logger;

import javax.xml.bind.*;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

/**
 * Utility class for writing, reading metadata file and generating checksum.
 */
public class MetaFileUtil {

    private File metaFile;
    private Logger LOGGER = Logger.getLogger("MetadataFileUtil");
    private Map<String, ConcurrentHashMap<String, XmlMetadata>> indexes = new ConcurrentHashMap<>();
    private Map<String, String> indexToCollection = new ConcurrentHashMap<>();

    private MetaFileUtil(String indexFolder) {
        this.metaFile = new File(indexFolder + "/" + Constants.META_FILE_NAME);
    }

    public static MetaFileUtil create(String indexFolder) {
        return new MetaFileUtil(indexFolder);
    }

    /**
     * Checks for existing metadata file.
     *
     * @return true if the metadata file is present
     */
    public boolean isMetaFilePresent() {
        return metaFile.exists();
    }

    /**
     * Update the content of the metadata map.
     * If the current collection data is present, replace it.
     * Otherwise insert new.
     * @param metadataMap : Set of XmlMetaData objects.
     * @param index : The path to index location.
     * @throws IOException
     */
    public void updateMetadataMap(ConcurrentHashMap<String, XmlMetadata> metadataMap, String index) throws
            IOException, JAXBException {

        if (this.indexes.get(index) == null) {
            this.indexes.put(index, metadataMap);
        } else {
            this.indexes.replace(index, metadataMap);
        }

    }

    /**
     * Method to get the set of xml metadata for a given collection
     *
     * @param index : The collection from which the metadata should be read.
     * @return : Map containing the set of XmlMetadata objects.
     * @throws IOException
     * @throws ClassNotFoundException
     */
    public ConcurrentHashMap<String, XmlMetadata> getMetadata(String index)
            throws IOException, ClassNotFoundException, JAXBException {

        return this.indexes.get(index);
    }

    /**
     * Read the metadata file and create an in-memory map containing collection paths and xml files.
     * @throws JAXBException
     */
    public void readMetadataFile() throws JAXBException {
        JAXBContext jaxbContext = JAXBContext.newInstance(VXQueryIndex.class);
        Unmarshaller jaxbUnmarshaller = jaxbContext.createUnmarshaller();
        VXQueryIndex indexes = (VXQueryIndex) jaxbUnmarshaller.unmarshal(metaFile);

        List<XmlMetadataCollection> list = indexes.getIndex();


        for (XmlMetadataCollection collection : list) {
            String indexPath = collection.getIndexLocation();
            ConcurrentHashMap<String, XmlMetadata> metadataMap = new ConcurrentHashMap<>();
            List<XmlMetadata> metadata = collection.getMetadataList();

            this.indexToCollection.put(indexPath, collection.getCollection());

            for (XmlMetadata mData : metadata) {
                metadataMap.put(mData.getPath(), mData);
            }
            this.indexes.put(indexPath, metadataMap);
        }
    }

    /**
     * Write the content of the ConcurrentHashMap to the xml metadata file.
     * @throws FileNotFoundException
     * @throws JAXBException
     */
    public void writeMetadataToFile() throws FileNotFoundException, JAXBException {
        VXQueryIndex index = new VXQueryIndex();
        List<XmlMetadataCollection> xmlMetadataCollections = new ArrayList<>();

        for (Map.Entry<String, ConcurrentHashMap<String, XmlMetadata>> entry : indexes.entrySet()) {
            XmlMetadataCollection metadataCollection = new XmlMetadataCollection();
            List<XmlMetadata> metadataList = new ArrayList<>();
            metadataCollection.setIndexLocation(entry.getKey());
            metadataCollection.setCollection(indexToCollection.get(entry.getKey()));
            metadataList.addAll(entry.getValue().values());
            metadataCollection.setMetadataList(metadataList);
            xmlMetadataCollections.add(metadataCollection);
        }
        index.setIndex(xmlMetadataCollections);


        FileOutputStream fileOutputStream = new FileOutputStream(this.metaFile);
        JAXBContext jaxbContext = JAXBContext.newInstance(VXQueryIndex.class);
        Marshaller jaxbMarshaller = jaxbContext.createMarshaller();
        jaxbMarshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
        jaxbMarshaller.marshal(index, fileOutputStream);

        if (LOGGER.isDebugEnabled())
            LOGGER.log(Level.DEBUG, "Writing metadata file completed successfully!");

    }


    /**
     * Generate MD5 checksum string for a given file.
     *
     * @param file : File which the checksum should be generated.
     * @return : Checksum String
     * @throws NoSuchAlgorithmException
     * @throws IOException
     */
    public String generateMD5(File file) throws NoSuchAlgorithmException, IOException {
        MessageDigest md = MessageDigest.getInstance("MD5");
        md.update(Files.readAllBytes(file.toPath()));
        byte[] md5 = md.digest();
        return DatatypeConverter.printHexBinary(md5);
    }

    /**
     * Delete the existing Metadata file.
     *
     * @return True if deleted, false otherwise.
     */
    public boolean deleteMetaDataFile() {
        try {
            Files.delete(Paths.get(metaFile.getCanonicalPath()));
            if (LOGGER.isDebugEnabled()){
                LOGGER.log(Level.DEBUG, "Metadata file deleted!");
            }
            return true;
        } catch (IOException e) {
            if (LOGGER.isTraceEnabled()){
                LOGGER.log(Level.ERROR, "Metadata file could not be deleted!");
            }
            return false;
        }
    }

    /**
     * Get the collection for a given index location.
     * @param index : path to index
     * @return
     */
    public String getCollection(String index) {
        return this.indexToCollection.get(index);
    }

    /**
     * Set the entry for given index and collection.
     * @param index : path to index
     * @param collection : path to corresponding collection
     */
    public void setCollectionForIndex(String index, String collection) {
        if (this.indexToCollection.get(index)==null) {
            this.indexToCollection.put(index, collection);
        }
    }
}