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.jdbc;

import java.sql.Connection;

import java.sql.PreparedStatement;

import java.sql.SQLException;

import java.sql.Statement;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.Iterator;

import java.util.List;

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

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

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

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

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.FeatureReferenceProviderServices;

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

import org.gvsig.fmap.dal.store.db.FeatureTypeHelper;

import org.gvsig.fmap.dal.store.jdbc.exception.JDBCExecutePreparedSQLException;

import org.gvsig.fmap.dal.store.jdbc.exception.JDBCExecuteSQLException;

import org.gvsig.fmap.dal.store.jdbc.exception.JDBCPreparingSQLException;

import org.gvsig.fmap.dal.store.jdbc.exception.JDBCSQLException;

import org.gvsig.fmap.dal.store.jdbc.exception.JDBCUpdateWithoutChangesException;

import org.gvsig.tools.dynobject.DynObject;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

 * @author jmvivo

 *

 */

public class JDBCStoreProviderWriter extends JDBCStoreProvider {

        final static private Logger logger = LoggerFactory

                        .getLogger(JDBCStoreProviderWriter.class);

        protected Appender appender;

        public JDBCStoreProviderWriter(JDBCStoreParameters params,

                        DataStoreProviderServices storeServices)

                        throws InitializeException {

                super(params, storeServices);

                this.appender = this.createAppender();

        }

        protected JDBCStoreProviderWriter(JDBCStoreParameters params,

                        DataStoreProviderServices storeServices, DynObject metadata)

                        throws InitializeException {

                super(params, storeServices, metadata);

                this.appender = this.createAppender();

        }

        protected Appender createAppender() {

            return new JDBCAppender(this);

        }

        public boolean supportsAppendMode() {

            return true;

        }

        public void endAppend() throws DataException {

            this.appender.end();

        }

        public void beginAppend() throws DataException {

            this.appender.begin();

        }

        public void append(final FeatureProvider featureProvider) throws DataException {

            this.appender.append(featureProvider);

        }

        protected void addToListFeatureValues(FeatureProvider featureProvider,

                        FeatureAttributeDescriptor attrOfList,

                        FeatureAttributeDescriptor attr, List<Object> values) throws DataException {

                if (attr == null) {

                        if (attrOfList.isPrimaryKey()) {

                                throw new RuntimeException("pk attribute '"

                                                + attrOfList.getName() + "' not found in feature");

                        }

                        values.add(helper

                                        .dalValueToJDBC(attr, attrOfList.getDefaultValue()));

                } else {

                        values.add(helper.dalValueToJDBC(attr, featureProvider.get(attr

                                        .getIndex())));

                }

        }

        protected void addToListFeatureValues(FeatureProvider featureProvider,

                        List<FeatureAttributeDescriptor> attributes, List<Object> values) throws DataException {

                FeatureAttributeDescriptor attr, attrOfList;

                FeatureType fType = featureProvider.getType();

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

                        attrOfList = (FeatureAttributeDescriptor) attributes.get(i);

                        attr = fType.getAttributeDescriptor(attrOfList.getName());

                        addToListFeatureValues(featureProvider, attrOfList, attr, values);

                }

        }

        protected void appendToSQLPreparedPkWhereClause(StringBuilder sql,

                        List<FeatureAttributeDescriptor> pkAttributes) {

                sql.append(" Where ");

                FeatureAttributeDescriptor attr;

                for (int i = 0; i < pkAttributes.size() - 1; i++) {

                        attr = (FeatureAttributeDescriptor) pkAttributes.get(i);

                        sql.append(helper.escapeFieldName(attr.getName()));

                        sql.append(" = ? AND ");

                }

                attr = (FeatureAttributeDescriptor) pkAttributes.get(pkAttributes

                                .size() - 1);

                sql.append(helper.escapeFieldName(attr.getName()));

                sql.append(" = ? ");

        }

        protected void executeRemovePreparedStatement(Connection conn, String sql,

                        List<FeatureAttributeDescriptor> attributes, Iterator<FeatureReferenceProviderServices> featureReferences) throws DataException {

                                PreparedStatement st;

                                try {

                                        st = conn.prepareStatement(sql);

                                } catch (SQLException e) {

                                        throw new JDBCPreparingSQLException(sql, e);

                                }

                                try {

                                        List<Object> values = new ArrayList<Object>();

                                        FeatureReferenceProviderServices featureRef;

//                                        FeatureType featureType;

                                        while (featureReferences.hasNext()) {

                                                st.clearParameters();

                                                featureRef = featureReferences.next();

                                                values.clear();

//                                                featureType = this.getFeatureStore()

//                                                        .getFeatureType(featureRef.getFeatureTypeId());

                                                Iterator<FeatureAttributeDescriptor> iter = attributes.iterator();

                                                FeatureAttributeDescriptor attr;

                                                while (iter.hasNext()) {

                                                        attr =  iter.next();

                                                        values.add( helper.dalValueToJDBC(attr, featureRef

                                                                        .getKeyValue(attr.getName())));

                                                }

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

                                                        st.setObject(i + 1, values.get(i));

                                                }

                                                try {

                                                        int nAffected =JDBCHelper.executeUpdate(st);

                                                        if (nAffected == 0) {

                                                                throw new JDBCUpdateWithoutChangesException(sql, values);

                                                        }

                                                        if (nAffected > 1){

                                                                logger.warn("Remove statement affectst to {} rows: {}",

                                                                                nAffected, sql);

                                                        }

                                                } catch (SQLException e) {

                                                        throw new JDBCExecutePreparedSQLException(sql, values, e);

                                                }

                                        }

                                } catch (SQLException e) {

                                        throw new JDBCSQLException(e);

                                } finally {

                                        try {st.close();} catch (SQLException e) {        };

                                }

                        }

        protected void executeUpdatePreparedStatement(Connection conn, String sql,

                        List<FeatureAttributeDescriptor> attributes, Iterator<FeatureProvider> featureProviders) throws DataException {

                                PreparedStatement st;

                                try {

                                        st = conn.prepareStatement(sql);

                                } catch (SQLException e) {

                                        throw new JDBCPreparingSQLException(sql, e);

                                }

                                try {

                                        List<Object> values = new ArrayList<Object>();

                                        FeatureProvider featureProvider;

                                        while (featureProviders.hasNext()) {

                                                st.clearParameters();

                                                featureProvider = (FeatureProvider) featureProviders.next();

                                                values.clear();

                                                addToListFeatureValues(featureProvider, attributes, values);

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

                                                        st.setObject(i + 1, values.get(i));

                                                }

                                                try {

                                                        if ( JDBCHelper.executeUpdate(st) == 0) {

                                                                throw new JDBCUpdateWithoutChangesException(sql, values);

                                                        }

                                                } catch (SQLException e) {

                                                        throw new JDBCExecutePreparedSQLException(sql, values, e);

                                                }

                                        }

                                } catch (SQLException e) {

                                        throw new JDBCSQLException(e);

                                } finally {

                                        try {st.close();} catch (SQLException e) {        };

                                }

                        }

        protected void performDeletes(Connection conn, Iterator<FeatureReferenceProviderServices> deleteds, List<FeatureAttributeDescriptor> pkAttributes)

                        throws DataException {

                                if (pkAttributes.size() < 0) {

                                        throw new RuntimeException("Operation requires missing pk");

                                }

                                // ************ Prepare SQL ****************

                                StringBuilder sqlb = new StringBuilder();

                                sqlb.append("Delete from ");

                                sqlb.append(getJDBCParameters().tableID());

                                appendToSQLPreparedPkWhereClause(sqlb, pkAttributes);

                                String sql = sqlb.toString();

                                // ************ Prepare SQL (end) ****************

                                executeRemovePreparedStatement(conn, sql, pkAttributes, deleteds);

                        }

        protected String getSqlStatementAddField(FeatureAttributeDescriptor attr,

                        List<String> additionalStatement) throws DataException {

                StringBuilder strb = new StringBuilder();

                strb.append("ADD ");

                strb.append(this.helper.getSqlFieldDescription(attr));

                return strb.toString();

        }

        protected String getSqlStatementDropField(FeatureAttributeDescriptor attr,List<String> additionalStatement) {

                // DROP [ COLUMN ] column

                return " DROP COLUMN "

                                + this.helper.escapeFieldName(attr.getName());

        }

        protected List<String> getSqlStatementAlterField(

                        FeatureAttributeDescriptor attrOrg,

                        FeatureAttributeDescriptor attrTrg, List<String> additionalStatement)

                        throws DataException {

                //

                List<String> actions = new ArrayList<String>();

                StringBuilder strb;

                if (attrOrg.getDataType() != attrTrg.getDataType()) {

                        // ALTER COLUMN {col} TYPE {type} character varying(35)

                        strb = new StringBuilder();

                        strb.append("ALTER COLUMN ");

                        strb.append(helper.escapeFieldName(attrTrg.getName()));

                        strb.append(" ");

                        strb.append(helper.getSqlColumnTypeDescription(attrTrg));

                        actions.add(strb.toString());

                }

                if (attrOrg.allowNull() != attrTrg.allowNull()) {

                        // ALTER [ COLUMN ] column { SET | DROP } NOT NULL

                        strb = new StringBuilder();

                        strb.append("ALTER COLUMN ");

                        strb.append(helper.escapeFieldName(attrTrg.getName()));

                        strb.append(' ');

                        if (attrTrg.allowNull()) {

                                strb.append("SET ");

                        } else {

                                strb.append("DROP ");

                        }

                        strb.append("NOT NULL");

                        actions.add(strb.toString());

                }

                if (attrOrg.getDefaultValue() != attrTrg.getDefaultValue()) {

                        if (attrTrg.getDefaultValue() == null) {

                                // ALTER [ COLUMN ] column DROP DEFAULT

                                strb = new StringBuilder();

                                strb.append("ALTER COLUMN ");

                                strb.append(helper.escapeFieldName(attrTrg.getName()));

                                strb.append(" DROP DEFAULT");

                                actions.add(strb.toString());

                        } else if (!attrTrg.getDefaultValue().equals(

                                        attrOrg.getDefaultValue())) {

                                // ALTER [ COLUMN ] column DROP DEFAULT

                                strb = new StringBuilder();

                                strb.append("ALTER COLUMN ");

                                strb.append(helper.escapeFieldName(attrTrg.getName()));

                                strb.append(" SET DEFAULT");

                                strb.append(helper.dalValueToJDBC(attrTrg, attrTrg

                                                .getDefaultValue()));

                                actions.add(strb.toString());

                        }

                }

                return actions;

        }

        protected void performUpdateTable(Connection conn, FeatureType original,

                        FeatureType target) throws DataException {

                /*

                 *

                 * ALTER TABLE [ ONLY ] name [ * ] action [, ... ]

                 */

                List<String> toDrop = new ArrayList<String>();

                List<String> toAdd = new ArrayList<String>();

                List<String> toAlter = new ArrayList<String>();

                List<String> additionalStatement = new ArrayList<String>();

                FeatureAttributeDescriptor attrOrg;

                FeatureAttributeDescriptor attrTrg;

                Iterator<FeatureAttributeDescriptor> attrs = FeatureTypeHelper.iterator(original);

                while (attrs.hasNext()) {

                        attrOrg = (FeatureAttributeDescriptor) attrs.next();

                        attrTrg = target.getAttributeDescriptor(attrOrg.getName());

                        if (attrTrg == null) {

                                toDrop.add(getSqlStatementDropField(attrOrg,

                                                additionalStatement));

                        } else {

                                toAlter.addAll(getSqlStatementAlterField(attrOrg, attrTrg,additionalStatement));

                        }

                }

                attrs = FeatureTypeHelper.iterator(target);

                while (attrs.hasNext()) {

                        attrTrg = (FeatureAttributeDescriptor) attrs.next();

                        if (original.getAttributeDescriptor(attrTrg.getName()) == null) {

                                toAdd.add(getSqlStatementAddField(attrTrg,

                                                                additionalStatement));

                        }

                }

                StringBuilder sqlb = new StringBuilder();

                sqlb.append("ALTER TABLE ");

                sqlb.append(getJDBCParameters().tableID());

                sqlb.append(' ');

                List<String> actions = new ArrayList<String>();

                actions.addAll(toDrop);

                actions.addAll(toAlter);

                actions.addAll(toAdd);

                Iterator<String> it = actions.iterator();

                while (it.hasNext()) {

                        if (it.next() == null) {

                                it.remove();

                        }

                }

                it = additionalStatement.iterator();

                while (it.hasNext()) {

                        if (it.next() == null) {

                                it.remove();

                        }

                }

                if (actions.size() < 1) {

                        return;

                }

                helper.stringJoin(actions, ", ", sqlb);

                String sql = sqlb.toString();

                Statement st = null;

                try {

                        st = conn.createStatement();

                } catch (SQLException e1) {

                        throw new JDBCSQLException(e1);

                }

                try {

                        JDBCHelper.execute(st, sql);

                        Iterator<String> iter = additionalStatement.iterator();

                        while (iter.hasNext()) {

                                sql = (String) iter.next();

                                JDBCHelper.execute(st, sql);

                        }

                } catch (SQLException e1) {

                        throw new JDBCExecuteSQLException(sql, e1);

                } finally {

                        try {

                                st.close();

                        } catch (Exception e) {

                                logger.error("Exception closing statement", e);

                        }

                        ;

                }

        }

        public void perfomInsert(Connection conn, PreparedStatement insertSt,

                        String sql, FeatureProvider feature, List<FeatureAttributeDescriptor> attributes)

                        throws DataException {

                try {

                        insertSt.clearParameters();

                        List<Object> values = new ArrayList<Object>();

                        addToListFeatureValues(feature, attributes, values);

//                        FeatureAttributeDescriptor attr;

                        int j = 1;

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

                                insertSt.setObject(j, values.get(i));

                                j++;

                        }

                        if (logger.isDebugEnabled()) {

                                logger.debug("Executing insert. sql={} value={}", new Object[] {

                                                sql, values });

                        }

                        try {

                                JDBCHelper.execute(insertSt, sql);

                        } catch (SQLException e) {

                                throw new JDBCExecutePreparedSQLException(sql, values, e);

                        }

                } catch (Exception e1) {

                        throw new JDBCExecuteSQLException(sql, e1);

                }

        }

        protected void prepareAttributeForUpdate(FeatureAttributeDescriptor attr,

                        List<String> values) {

                values.add(helper.escapeFieldName(attr.getName()) + " = ?");

        }

        protected void prepareAttributeForInsert(FeatureAttributeDescriptor attr,

                        List<String> fields, List<String> values) {

                fields.add(helper.escapeFieldName(attr.getName()));

                values.add("?");

        }

        protected void prepareSQLAndAttributeListForInsert(StringBuilder sqlb,

                        List<FeatureAttributeDescriptor> attributes) throws DataException {

                /*

                 * INSERT INTO table [ ( column [, ...] ) ] { DEFAULT VALUES | VALUES (

                 * { expression | DEFAULT } [, ...] ) [, ...] | query } [ RETURNING * |

                 * output_expression [ AS output_name ] [, ...] ]

                 */

                sqlb.append("INSERT INTO ");

                sqlb.append(getJDBCParameters().tableID());

                sqlb.append(" (");

                FeatureType type = this.getFeatureStore().getDefaultFeatureType();

                List<String> fields = new ArrayList<String>();

                List<String> values = new ArrayList<String>();

                Iterator<FeatureAttributeDescriptor> iter = FeatureTypeHelper.iterator(type);

                FeatureAttributeDescriptor attr;

                while (iter.hasNext()) {

                        attr = iter.next();

                        if (attr.isAutomatic() || attr.isReadOnly()) {

                                continue;

                        }

                        attributes.add(attr);

                        prepareAttributeForInsert(attr, fields, values);

                }

                if (attributes.size() < 1) {

                        throw new RuntimeException("no fields to set");

                }

                helper.stringJoin(fields, ", ", sqlb);

                sqlb.append(") VALUES (");

                helper.stringJoin(values, ", ", sqlb);

                sqlb.append(") ");

        }

        protected void performInserts(Connection conn, Iterator<FeatureProvider> inserteds)

                        throws DataException {

                StringBuilder sqlb = new StringBuilder();

                List<FeatureAttributeDescriptor> attrs = new ArrayList<FeatureAttributeDescriptor>();

                prepareSQLAndAttributeListForInsert(sqlb, attrs);

                String sql = sqlb.toString();

                PreparedStatement st;

                try {

                        st = conn.prepareStatement(sql);

                } catch (SQLException e) {

                        throw new JDBCPreparingSQLException(sql, e);

                }

                try {

                        while (inserteds.hasNext()) {

                                perfomInsert(conn, st, sql, inserteds.next(),

                                                attrs);

                        }

                } finally {

                        try {st.close();} catch (SQLException e) {logger.error("Error closing statement", e);};

                }

        }

        protected void performUpdates(Connection conn, Iterator<FeatureProvider> updateds,

                        List<FeatureAttributeDescriptor> pkAttributes) throws DataException {

                /*

                 * UPDATE [ ONLY ] table [ [ AS ] alias ] SET { column = { expression |

                 * DEFAULT } | ( column [, ...] ) = ( { expression | DEFAULT } [, ...] )

                 * } [, ...] [ FROM fromlist ] [ WHERE condition ] [ RETURNING * |

                 * output_expression [ AS output_name ] [, ...] ]

                 */

                if (pkAttributes.size() < 0) {

                        throw new RuntimeException("Operation requires missing pk");

                }

                // ************ Prepare SQL ****************

                StringBuilder sqlb = new StringBuilder();

                sqlb.append("UPDATE ");

                sqlb.append(getJDBCParameters().tableID());

                sqlb.append(" SET ");

                List<String> values = new ArrayList<String>();

                FeatureType type = this.getFeatureStore().getDefaultFeatureType();

                Iterator<FeatureAttributeDescriptor> iter = FeatureTypeHelper.iterator(type);

                FeatureAttributeDescriptor attr;

                List<FeatureAttributeDescriptor> updateAttrs = new ArrayList<FeatureAttributeDescriptor>();

                while (iter.hasNext()) {

                        attr = iter.next();

                        if (attr.isPrimaryKey() || attr.isAutomatic() || attr.isReadOnly()) {

                                continue;

                        }

                        updateAttrs.add(attr);

                        prepareAttributeForUpdate(attr, values);

                }

                if (updateAttrs.size() < 1) {

                        throw new RuntimeException("no fields to set");

                }

                helper.stringJoin(values, ", ", sqlb);

                sqlb.append(' ');

                appendToSQLPreparedPkWhereClause(sqlb, pkAttributes);

                String sql = sqlb.toString();

                // ************ Prepare SQL (end) ****************

                updateAttrs.addAll(pkAttributes);

                executeUpdatePreparedStatement(conn, sql, updateAttrs, updateds);

        }

        protected TransactionalAction getPerformChangesAction(

                        final Iterator<FeatureReferenceProviderServices> deleteds, 

                        final Iterator<FeatureProvider> inserteds,

                        final Iterator<FeatureProvider> updateds, 

                        final Iterator<FeatureTypeChanged> featureTypesChanged) {

                TransactionalAction action = new TransactionalAction() {

                        public Object action(Connection conn) throws DataException {

                                if (featureTypesChanged.hasNext()) {

                                        FeatureTypeChanged item = featureTypesChanged.next();

                                        performUpdateTable(conn, item.getSource(), item.getTarget());

                                }

                                List<FeatureAttributeDescriptor> pkAttributes = null;

                                if (deleteds.hasNext() || updateds.hasNext()) {

                                        pkAttributes = Arrays.asList(getFeatureStore()

                                                        .getDefaultFeatureType()

                                                        .getPrimaryKey());

                                }

                                if (deleteds.hasNext()) {

                                        performDeletes(conn, deleteds, pkAttributes);

                                }

                                if (updateds.hasNext()) {

                                        performUpdates(conn, updateds, pkAttributes);

                                }

                                if (inserteds.hasNext()) {

                                        performInserts(conn, inserteds);

                                }

                                return null;

                        }

                        public boolean continueTransactionAllowed() {

                                return false;

                        }

                };

                return action;

        }

        @SuppressWarnings("unchecked")

        public void performChanges(Iterator deleteds, Iterator inserteds,

                        Iterator updateds, Iterator featureTypesChanged)

                        throws PerformEditingException {

                boolean countChanged = deleteds.hasNext() || inserteds.hasNext();

                try {

                        this.helper.doConnectionAction(getPerformChangesAction(deleteds,

                                        inserteds, updateds, featureTypesChanged));

                        /*

                         * Get rules before initializing feature type

                         */

                        FeatureRules old_rules = getFeatureStore().getDefaultFeatureType().getRules();

                        /*

                         * This initialization loses the feature type rules

                         */

                        this.initFeatureType();

                        /*

                         * Get new feature type, clear rules and add

                         * the ones saved previously

                         */

                        FeatureType ft = getFeatureStore().getDefaultFeatureType();

                        FeatureRules new_rules = ft.getRules();

                        new_rules.clear();

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

                            new_rules.add(old_rules.getRule(i));

                        }

                        // ===================================================

                        if (countChanged) {

                                resetCount();

                        }

                } catch (Exception e) {

                        throw new PerformEditingException(this.getSourceId().toString(), e);

                }

        }

        public boolean allowWrite() {

                if (directSQLMode) {

                        return false;

                }

        FeatureType ft = null;

        try {

            ft = this.getFeatureStore().getDefaultFeatureType();

        } catch (DataException e) {

            logger.error("While getting default Feature Type", e);

        }

        String[] storePK = getPK(ft);

        JDBCHelper helper = this.getHelper();

        String[] dbPK = null;

        try {

            Connection conn = helper.getConnection();

            dbPK = helper.getPksFrom(conn, getJDBCParameters());

            conn.close();

        } catch (Exception exc) {

            logger.error("While getting PK from DB", exc);

            return false;

        }

        return sameStrings(storePK, dbPK);

        }

    private boolean sameStrings(String[] a, String[] b) {

        if (a==null || b==null || a.length!=b.length || a.length==0) {

            /*

             * Must not be empty

             */

            return false;

        }

        int len = a.length;

        boolean found = false;

        /*

         * Check same 

         */

        for (int ai=0; ai<len; ai++) {

            found = false;

            for (int bi=0; bi<len; bi++) {

                if (b[bi].compareTo(a[ai]) == 0) {

                    found = true;

                    break;

                }

            }

            if (! found) {

                return false;

            }

        }

        return true;

    }

    private String[] getPK(FeatureType ft) {

        List resp = new ArrayList();

        FeatureAttributeDescriptor attr;

        Iterator<FeatureAttributeDescriptor> iter = FeatureTypeHelper.iterator(ft);

        while (iter.hasNext()) {

            attr = (FeatureAttributeDescriptor) iter.next();

            if (attr.isPrimaryKey()) {

                resp.add(attr.getName());

            }

        }

        return (String[]) resp.toArray(new String[0]);

    }

}