Application: gvSIG desktop

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 gvSIG Association.

 *

 * This program is free software; you can redistribute it and/or modify it under

 * the terms of the GNU General Public License as published by the Free Software

 * Foundation; either version 3 of the License, or (at your option) any later

 * version.

 *

 * This program 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 General Public License for more

 * details.

 *

 * You should have received a copy of the GNU General Public License along with

 * this program; if not, write to the Free Software Foundation, Inc., 51

 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us at info AT

 * gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.fmap.dal.store.csv;

import java.io.File;

import java.io.InputStreamReader;

import java.net.URI;

import java.net.URL;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.Iterator;

import java.util.List;

import java.util.Locale;

import org.apache.commons.io.FilenameUtils;

import org.apache.commons.lang3.StringUtils;

import org.cresques.cts.IProjection;

import org.gvsig.fmap.dal.DALLocator;

import org.gvsig.fmap.dal.DataManager;

import org.gvsig.fmap.dal.DataServerExplorer;

import org.gvsig.fmap.dal.DataStore;

import org.gvsig.fmap.dal.DataStoreNotification;

import org.gvsig.fmap.dal.DataTypes;

import org.gvsig.fmap.dal.FileHelper;

import org.gvsig.fmap.dal.exception.DataException;

import org.gvsig.fmap.dal.exception.InitializeException;

import org.gvsig.fmap.dal.exception.OpenException;

import org.gvsig.fmap.dal.exception.ReadException;

import org.gvsig.fmap.dal.feature.EditableFeatureAttributeDescriptor;

import org.gvsig.fmap.dal.feature.EditableFeatureType;

import org.gvsig.fmap.dal.feature.Feature;

import org.gvsig.fmap.dal.feature.FeatureAttributeDescriptor;

import org.gvsig.fmap.dal.feature.FeatureSet;

import org.gvsig.fmap.dal.feature.FeatureStore;

import org.gvsig.fmap.dal.feature.FeatureType;

import org.gvsig.fmap.dal.feature.exception.PerformEditingException;

import org.gvsig.fmap.dal.feature.spi.FeatureProvider;

import org.gvsig.fmap.dal.feature.spi.memory.AbstractMemoryStoreProvider;

import org.gvsig.fmap.dal.resource.ResourceAction;

import org.gvsig.fmap.dal.resource.file.FileResource;

import org.gvsig.fmap.dal.resource.spi.ResourceConsumer;

import org.gvsig.fmap.dal.resource.spi.ResourceProvider;

import org.gvsig.fmap.dal.serverexplorer.filesystem.FilesystemServerExplorer;

import org.gvsig.fmap.dal.serverexplorer.filesystem.FilesystemServerExplorerParameters;

import org.gvsig.fmap.dal.spi.DataStoreProviderServices;

import org.gvsig.fmap.dal.store.csv.simplereaders.CSVReaderSuperCSV;

import org.gvsig.fmap.dal.store.csv.simplereaders.SimpleReader;

import org.gvsig.fmap.geom.Geometry;

import org.gvsig.fmap.geom.GeometryLocator;

import org.gvsig.fmap.geom.GeometryManager;

import org.gvsig.fmap.geom.primitive.Envelope;

import org.gvsig.fmap.geom.primitive.Point;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dataTypes.Coercion;

import org.gvsig.tools.dispose.DisposableIterator;

import org.gvsig.tools.dynobject.exception.DynFieldNotFoundException;

import org.gvsig.tools.evaluator.AbstractEvaluator;

import org.gvsig.tools.evaluator.EvaluatorData;

import org.gvsig.tools.evaluator.EvaluatorException;

import org.gvsig.tools.exception.BaseException;

import org.gvsig.tools.exception.NotYetImplemented;

import org.gvsig.tools.persistence.PersistentState;

import org.gvsig.tools.persistence.exception.PersistenceException;

import org.gvsig.tools.task.SimpleTaskStatus;

import org.gvsig.tools.task.TaskStatusManager;

import org.gvsig.tools.visitor.VisitCanceledException;

import org.gvsig.tools.visitor.Visitor;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.supercsv.prefs.CsvPreference;

import org.gvsig.tools.dataTypes.CoercionContext;

@SuppressWarnings("UseSpecificCatch")

public class CSVStoreProvider extends AbstractMemoryStoreProvider implements

        ResourceConsumer {

    private static final Logger LOGGER = LoggerFactory.getLogger(CSVStoreProvider.class);

    public static final String NAME = DataStore.CSV_PROVIDER_NAME;

    public static final String DESCRIPTION = "CSV file";

    public static final String METADATA_DEFINITION_NAME = NAME;

    private final ResourceProvider resource;

    private long counterNewsOIDs = 0;

    private Envelope envelope;

    private boolean need_calculate_envelope = false;

    private final SimpleTaskStatus taskStatus;

    private final CSVFeatureWriter writer;

    private FeatureType featureType;

    @SuppressWarnings({"OverridableMethodCallInConstructor", "LeakingThisInConstructor"})

    public CSVStoreProvider(CSVStoreParameters parameters,

            DataStoreProviderServices storeServices) throws InitializeException {

        super(

                parameters,

                storeServices,

                FileHelper.newMetadataContainer(METADATA_DEFINITION_NAME)

        );

        this.writer = new CSVFeatureWriter();

        TaskStatusManager manager = ToolsLocator.getTaskStatusManager();

        this.taskStatus = manager.createDefaultSimpleTaskStatus("CSV");

        counterNewsOIDs = 0;

        File file = getCSVParameters().getFile();

        resource = this.createResource(

                FileResource.NAME,

                new Object[]{file.getAbsolutePath()}

        );

        resource.addConsumer(this);

        initializeFeatureTypes();

    }

    private CSVStoreParameters getCSVParameters() {

        return (CSVStoreParameters) this.getParameters();

    }

    @Override

    public String getProviderName() {

        return NAME;

    }

    @Override

    public boolean allowWrite() {

        return true;

    }

    private String getFullFileName() {

        // Usar solo para mostrar mensajes en el logger.

        String s;

        try {

            s = getCSVParameters().getFile().getAbsolutePath();

        } catch (Exception e2) {

            s = "(unknow)";

        }

        return s;

    }

    @Override

    public void open() throws OpenException {

        if (this.data != null) {

            return;

        }

        this.data = new ArrayList<>();

        resource.setData(new HashMap());

        counterNewsOIDs = 0;

        try {

            loadFeatures();

        } catch (RuntimeException e) {

            LOGGER.debug("Can't load features from CSV '" + getFullFileName() + "'.", e);

            throw e;

        } catch (Exception e) {

            LOGGER.debug("Can't load features from CSV '" + getFullFileName() + "'.", e);

            throw new RuntimeException(e);

        }

    }

    @Override

    public DataServerExplorer getExplorer() throws ReadException {

        DataManager manager = DALLocator.getDataManager();

        FilesystemServerExplorerParameters params;

        try {

            params = (FilesystemServerExplorerParameters) manager

                    .createServerExplorerParameters(FilesystemServerExplorer.NAME);

            params.setRoot(this.getCSVParameters().getFile().getParent());

            return manager.openServerExplorer(FilesystemServerExplorer.NAME, params);

        } catch (Exception e) {

            throw new ReadException(this.getProviderName(), e);

        }

    }

    @Override

    @SuppressWarnings("Convert2Lambda")

    public void performChanges(Iterator deleteds, Iterator inserteds, Iterator updateds, Iterator originalFeatureTypesUpdated) throws PerformEditingException {

        try {

            this.taskStatus.add();

            taskStatus.message("_preparing");

            this.getResource().closeRequest();

            getResource().execute(new ResourceAction() {

                @Override

                public Object run() throws Exception {

                    FeatureSet features = null;

                    DisposableIterator it = null;

                    try {

                        File file = (File) resource.get();

                        features

                                = getStoreServices().getFeatureStore()

                                        .getFeatureSet();

                        List<FeatureProvider> newdata = new ArrayList<>();

                        FeatureType ftype = getStoreServices().getDefaultFeatureType();

                        writer.initialize(getCSVParameters(), file, ftype, getCSVPreferences());

                        writer.begin();

                        it = features.fastIterator();

                        taskStatus.setRangeOfValues(0, 0);

                        long counter = 0;

                        while (it.hasNext()) {

                            taskStatus.setCurValue(counter++);

                            FeatureProvider feature = getStoreServices().getFeatureProviderFromFeature(

                                    (org.gvsig.fmap.dal.feature.Feature) it.next());

                            writer.add(feature);

                            if (feature.getOID() == null) {

                                LOGGER.warn("feature without OID");

                                feature.setOID(createNewOID());

                            }

                            newdata.add(feature);

                        }

                        data = newdata;

                        if (writer.getEnvelope() != null) {

                            envelope = writer.getEnvelope().getGeometry().getEnvelope();

                        }

                        resource.notifyChanges();

                        writer.end();

                    } finally {

                        if (it != null) {

                            it.dispose();

                        }

                        if (features != null) {

                            features.dispose();

                        }

                    }

                    return null;

                }

            });

            this.taskStatus.terminate();

        } catch (Exception e) {

            this.taskStatus.abort();

            throw new PerformEditingException(getResource().toString(), e);

        } finally {

            this.taskStatus.remove();

        }

    }

    private CsvPreference getCSVPreferences() {

        CSVReaderSuperCSV reader = new CSVReaderSuperCSV(getCSVParameters());

        return reader.getCSVPreferences();

    }

    @Override

    public boolean closeResourceRequested(ResourceProvider resource) {

        return true;

    }

    @Override

    public int getOIDType() {

        return DataTypes.LONG;

    }

    @Override

    public boolean supportsAppendMode() {

        return true;

    }

    @Override

    @SuppressWarnings("Convert2Lambda")

    public void append(final FeatureProvider featureProvider) {

        //todo

        getResource().execute(new ResourceAction() {

            @Override

            public Object run() throws Exception {

                //writer.append(getStoreServices().createFeature(featureProvider));

                writer.add(featureProvider);

                return null;

            }

        });

    }

    @Override

    @SuppressWarnings("Convert2Lambda")

    public void beginAppend() throws DataException {

        this.close();

        getResource().execute(new ResourceAction() {

            @Override

            public Object run() throws Exception {

                writer.initialize(

                        getCSVParameters(),

                        getCSVParameters().getFile(),

                        getFeatureStore().getDefaultFeatureType(),

                        getCSVPreferences()

                );

                writer.beginAppend();

                return null;

            }

        });

    }

    @Override

    @SuppressWarnings("Convert2Lambda")

    public void endAppend() {

        try {

            getResource().execute(new ResourceAction() {

                @Override

                public Object run() throws Exception {

                    writer.end();

                    resource.notifyChanges(); //resourcesNotifyChanges();

                    counterNewsOIDs = -1;

                    return null;

                }

            });

            writer.end();

        } catch (PerformEditingException ex) {

            LOGGER.warn("Not been able to end append '" + this.getFullName() + "'.", ex);

        }

    }

    public void saveToState(PersistentState state) throws PersistenceException {

        throw new NotYetImplemented();

    }

    public void loadFromState(PersistentState state) throws PersistenceException {

        throw new NotYetImplemented();

    }

    @Override

    public Object createNewOID() {

        return counterNewsOIDs++;

    }

    protected void initializeFeatureTypes() throws InitializeException {

        try {

            this.open();

        } catch (OpenException e) {

            throw new InitializeException(this.getProviderName(), e);

        }

    }

    @Override

    @SuppressWarnings("Convert2Lambda")

    public Envelope getEnvelope() throws DataException {

        this.open();

        if (this.envelope != null) {

            return this.envelope;

        }

        if (!this.need_calculate_envelope) {

            return null;

        }

        FeatureStore fs = this.getFeatureStore();

        FeatureType ft = fs.getDefaultFeatureType();

        FeatureAttributeDescriptor fad = ft.getAttributeDescriptor(ft.getDefaultGeometryAttributeIndex());

        try {

            this.envelope = GeometryLocator.getGeometryManager().createEnvelope(fad.getGeomType().getSubType());

            fs.accept(new Visitor() {

                @Override

                public void visit(Object obj) throws VisitCanceledException, BaseException {

                    Feature f = (Feature) obj;

                    Geometry geom = f.getDefaultGeometry();

                    if (geom != null) {

                        envelope.add(geom.getEnvelope());

                    }

                }

            });

        } catch (BaseException e) {

            LOGGER.warn("Can't calculate the envelope of CSV file '" + this.getFullName() + "'.", e);

            this.envelope = null;

        }

        this.need_calculate_envelope = false;

        return this.envelope;

    }

    @Override

    public Object getDynValue(String name) throws DynFieldNotFoundException {

        if (DataStore.METADATA_ENVELOPE.equalsIgnoreCase(name)) {

            try {

                return this.getEnvelope();

            } catch (DataException e) {

                return null;

            }

        } else {

            if (DataStore.METADATA_CRS.equalsIgnoreCase(name)) {

                IProjection pro = CSVStoreParameters.getCRS(this.getCSVParameters());

                if (pro != null) {

                    return pro;

                }

            }

        }

        return super.getDynValue(name);

    }

    @Override

    public void resourceChanged(ResourceProvider resource) {

        this.getStoreServices().notifyChange(

                DataStoreNotification.RESOURCE_CHANGED,

                resource);

    }

    @Override

    public Object getSourceId() {

        return this.getCSVParameters().getFile();

    }

    @Override

    public String getName() {

        String name = this.getCSVParameters().getFile().getName();

        return FilenameUtils.getBaseName(name);

    }

    @Override

    public String getFullName() {

        return this.getCSVParameters().getFile().getAbsolutePath();

    }

    @Override

    public ResourceProvider getResource() {

        return resource;

    }

    private boolean isEmpty(String s) {

        if (s == null) {

            return true;

        }

        return s.trim().length() == 0;

    }

    private void init(CSVStoreParameters parameters, DataStoreProviderServices storeServices) {

        throw new UnsupportedOperationException("Not supported yet."); //To change body of generated methods, choose Tools | Templates.

    }

    static class ToPointEvaluaror extends AbstractEvaluator {

        private static final Logger logger = LoggerFactory.getLogger(ToPointEvaluaror.class);

        private GeometryManager geommgr = null;

        private String xname = null;

        private String yname = null;

        private String zname = null;

        private final Coercion toDouble;

        private int errorcount = 0;

        ToPointEvaluaror(String[] pointDimensionNames) {

            this.xname = pointDimensionNames[0];

            this.yname = pointDimensionNames[1];

            if (pointDimensionNames.length > 2) {

                this.zname = pointDimensionNames[2];

            }

            this.geommgr = GeometryLocator.getGeometryManager();

            this.toDouble = ToolsLocator.getDataTypesManager().getCoercion(DataTypes.DOUBLE);

        }

        @Override

        public Object evaluate(EvaluatorData data) throws EvaluatorException {

            try {

                double x = ((Double) toDouble.coerce(data.getDataValue(xname)));

                double y = ((Double) toDouble.coerce(data.getDataValue(yname)));

                Point point = geommgr.createPoint(x, y, Geometry.SUBTYPES.GEOM3D);

                if (zname != null) {

                    double z = ((Double) toDouble.coerce(data.getDataValue(zname)));

                    point.setCoordinateAt(2, z);

                }

                return point;

            } catch (Exception ex) {

                if (++errorcount < 5) {

                    logger.warn("[" + errorcount + "] Can't create point in CSV provider. XNAME='"

                            + xname + "', YNAME='" + yname + "', ZNAME='" + zname + "', data=" + data.toString());

                }

                return null;

            }

        }

        @Override

        public String getName() {

            return "ToPointEvaluaror";

        }

    }

    private void loadFeatures() {

        InputStreamReader in = null;

        SimpleReader reader = null;

        try {

            boolean ignore_errors = CSVStoreParameters.getIgnoreErrors(getCSVParameters());

            // Initialize the feature types

            EditableFeatureType edftype = getStoreServices().createFeatureType(this.getName());

            CSVUtils.loadFeatureType(getCSVParameters(), edftype, true);

            FeatureType ftype = edftype.getNotEditableCopy();

            this.setFeatureType(ftype);

            in = CSVUtils.openFile(

                    this.getCSVParameters().getFile(),

                    CSVStoreParameters.getCharset(this.getCSVParameters())

            );

            reader = CSVUtils.getSimpleReader(getCSVParameters(), in);

            if (CSVStoreParameters.isFirstLineHeader(getCSVParameters())) {

                reader.getHeader(); // Skip and ignore the header of file

            }

            Coercion coercion[] = new Coercion[ftype.size()];

            CoercionContext coercionContext[] = new CoercionContext[ftype.size()];

            int sizes[] = new int[ftype.size()];

            for (int i = 0; i < ftype.size(); i++) {

                sizes[i] = -1;

                FeatureAttributeDescriptor ad = ftype.getAttributeDescriptor(i);

                coercion[i] = ad.getCoercion();

                coercionContext[i] = ad.getCoercionContext();

                switch (ad.getDataType().getType()) {

                    case DataTypes.INT:

                        sizes[i] = 0;

                        break;

                    case DataTypes.LONG:

                        sizes[i] = 0;

                        break;

                    case DataTypes.STRING:

                        if (ad.getSize() == 0) {

                            // Es un string y no tiene un size asignado.

                            // Lo ponemos a cero para calcularlo.

                            sizes[i] = 0;

                        }

                        break;

                    case DataTypes.URL:

                    case DataTypes.URI:

                    case DataTypes.FILE:

                        sizes[i] = 0;

                }

            }

            if (ftype.getDefaultGeometryAttributeName() != null) {

                this.need_calculate_envelope = true;

            }

            Locale locale = CSVStoreParameters.getLocale(getCSVParameters());

            taskStatus.message("_loading");

            int count = 0;

            int count_errors = 0;

            List<String> row = reader.read();

            int skipLines = CSVStoreParameters.getSkipLines(getCSVParameters());

            if (skipLines > 0) {

                row = reader.skip(skipLines);

            }

            int limit = CSVStoreParameters.getLimit(getCSVParameters());

            while (row != null) {

                taskStatus.setCurValue(++count);

                FeatureProvider feature = this.createFeatureProvider(ftype);

                for (int i = 0; i < row.size(); i++) {

                    Object rawvalue = row.get(i);

                    try {

                        Object value = null;

                        if( coercion[i]!=null ) {

                          value = coercion[i].coerce(rawvalue, coercionContext[i]);

                        }

                        feature.set(i, value);

                        if (sizes[i] >= 0

                                && (value instanceof String || value instanceof URL

                                || value instanceof URI || value instanceof File)) {

                            int x = value.toString().length();

                            if (sizes[i] < x) {

                                sizes[i] = x;

                            }

                        }

                    } catch (Exception ex) {

                        if (!ignore_errors) {

                            throw ex;

                        }

                        if (count_errors++ < 10) {

                            LOGGER.warn("Can't load value of attribute " + i + " in row " + count + ".", ex);

                        }

                        if (count_errors == 10) {

                            LOGGER.info("Too many errors, suppress messages.");

                        }

                    }

                }

                this.addFeatureProvider(feature);

                if (limit > 0) {

                    if (limit < this.data.size()) {

                        break;

                    }

                }

                row = reader.read();

            }

            for (int i = 0; i < ftype.size(); i++) {

                if (sizes[i] > 0) {

                    EditableFeatureAttributeDescriptor efad = ((EditableFeatureAttributeDescriptor) edftype.getAttributeDescriptor(i));

                    efad.setSize(sizes[i]);

                }

            }

            // Volvemos a asignar al store el featuretype, ya que puede

            // haber cambiado.

            ftype = edftype.getNotEditableCopy();

            this.setFeatureType(ftype);

            taskStatus.terminate();

        } catch (Throwable ex) {

            int lineno = 0;

            if (reader != null) {

                lineno = reader.getLine();

            }

            throw new RuntimeException("Problems reading file '" + getFullFileName() + "' near line " + lineno + ".", ex);

        } finally {

            if (reader != null) {

                try {

                    reader.close();

                } catch (Exception ex) {

                    // Do nothing

                }

//                reader = null;

            }

            if (in != null) {

                try {

                    in.close();

                } catch (Exception ex) {

                    // Do nothing

                }

//                in = null;

            }

        }

    }

    @Override

    public void fixFeatureTypeFromParameters() {

        String param_types_def = CSVStoreParameters.getRawFieldTypes(this.getParameters());

        String[] pointDimensionNames = CSVStoreParameters.getPointDimensionNames(this.getParameters());

        String geometry_column = CSVStoreParameters.getGeometryColumn(this.getParameters());

        if (StringUtils.isNotBlank(param_types_def) || 

                pointDimensionNames != null || 

                !StringUtils.isBlank(geometry_column)) {

            this.setFeatureType(featureType);

        }

    }

    private void setFeatureType(FeatureType ftype) {

        List<FeatureType> ftypes = new ArrayList<>();

        ftypes.add(ftype);

        this.featureType = ftype;

        this.getStoreServices().setFeatureTypes(ftypes, ftype);

    }

}