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.app.sqlQueryValidation;

import java.io.ByteArrayInputStream;

import org.gvsig.andami.PluginServices;

import Zql.ZqlParser;

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2004 IVER T.I. and Generalitat Valenciana.

 *

 * 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 2

 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

/**

 * Class for validate a complete query or the sentence of a query from WHERE 

 *

 * @author Pablo Piqueras Bartolom? (p_queras@hotmail.com)

 */

public class SQLQueryValidation {

        private String query;

        private boolean onlyWhereStatement;

        private int[] errorPosition; //[0] -> line, [1] -> column        ( (-1, -1) -> no error ) ( (-2, -2) -> error: query = null)

        private String errorMessage;

        private String errorPositionAsMessage;

        private String token;

        private final String preQuery = "SELECT a FROM b WHERE ";

        private final int preQueryLenght = preQuery.length();

        /**

         * Default constructor with a parameter

         * 

         * @param _query The query to validate

         * @param _onlyWhereStatement If the query is only the part of WHERE ... in a query

         */

        public SQLQueryValidation(String _query, boolean _onlyWhereStatement) {

                query = new String(_query);

                onlyWhereStatement = _onlyWhereStatement;

                // By default no error position

                errorPosition = new int[2];

                errorPosition[0] = -1;

                errorPosition[1] = -1;

                errorPositionAsMessage = null;

                // By default no error message

                errorMessage = null;

                // By default no error symbol

                token = null;

        }

        /**

         * Validates a query

         * 

         * Returns 'null' if there has been some error

         */

        public boolean validateQuery() {

                String completeQuery = new String();

                // If the query is null -> error 

                if (query == null)        {

                        errorPosition[0] = -2;

                        errorPosition[1] = -2;

                        defineErrorPositionAsMessageAttribute(errorPosition);

                        errorMessage = new String( PluginServices.getText(null, "queryIsNull"));

                        return false;

                }

                // If no query itsn't considered as a error

                if ((query.compareTo("")) == 0) {

                        errorPosition[0] = -1;

                        errorPosition[1] = -1;

                        defineErrorPositionAsMessageAttribute(errorPosition);

                        errorMessage = null;

                        return true;

                }

                // Converts all apostrophes between aphostrophes to double inverted commas ( " )

                int index = 0;

                boolean is_word = false; // by default isn't a word

                String formatted_query = new String();

                char c;

                while (index < query.length()) {

                        c = query.charAt(index);

                        if (c == '\'') {

                                if (is_word == false) {

                                        if ((index > 0) && ((query.charAt(index-1) == ' ') || (query.charAt(index-1) == '(')) ) {

                                                is_word = true;

                                        }

                                        formatted_query += c;

                                }

                                else {

                                        if (index == (query.length() -1)) {

//                                                is_word = false;

                                                formatted_query += c;

                                        }

                                        else {

                                                if (((query.charAt(index+1) == ' ') || (query.charAt(index+1) == ')')) ) {

                                                        is_word = false;

                                                        formatted_query += c;

                                                }

                                                else {

                                                        formatted_query += "\""; // Convert ' to "

                                                }

                                        }

                                }

                        }

                        else {

                                formatted_query += c;

                        }

                        index ++;

                }                

                // Converts all ocurrences of the symbol " ( double inverted commas ) to space because Zql doesn't support that symbol

                if (onlyWhereStatement)

                        completeQuery = preQuery + formatted_query.trim().replaceAll("\"", " ");

                else

                        completeQuery = formatted_query.trim().replaceAll("\"", " ");

                if ((completeQuery.length() > 0) && (completeQuery.charAt(completeQuery.length() - 1) != ';'))

                        completeQuery += ";";

                try {

                        // Starts the parser

                        ZqlParser p = new ZqlParser();

                        p.initParser(new ByteArrayInputStream(completeQuery.getBytes()));

                        // Analyzes the query

                        p.readStatement();

                        // If arrives here -> there has been no errors

                        errorPosition[0] = -1;

                        errorPosition[1] = -1;

                        defineErrorPositionAsMessageAttribute(errorPosition);

                        errorMessage = null;

                        return true;

                } catch (Exception e) {

                        // Defines the error message

                        errorMessage = e.getMessage();

                        // Get the token that produced the error

                        int ini_pos = e.getMessage().indexOf('\"') +1;

                        token = new String(errorMessage.substring(ini_pos, errorMessage.indexOf('\"', ini_pos)));

                        // Get the line an column where the syntax error starts

                        String line = new String(errorMessage.substring(e.getMessage().indexOf("line"), errorMessage.indexOf(',')));

                        line = line.substring(line.indexOf(' ')+1, line.length());

                        String column = new String(e.getMessage().substring(errorMessage.indexOf("column"), errorMessage.indexOf('.')));

                        column = column.substring(column.indexOf(' ')+1, column.length());                        

                        // Get the line an column of the error

                        errorPosition[0] = Integer.valueOf(line.trim()).intValue();                        

                        errorPosition[1] = Integer.valueOf(column.trim()).intValue();

                        if (onlyWhereStatement) {

                                this.errorPosition[1] -= this.preQueryLenght; // Substract the lenght of the pre-query added

                        }

                        defineErrorPositionAsMessageAttribute(this.errorPosition);

                        return false;

                }

        }

        /**

         * Returns an string with an error message if there has been an error, or 'null' if there hasn't been

         * 

         * @return An string or null

         */

        public String getErrorMessage() {

                return this.errorMessage;

        }

        /**

         * Returns an string with a text describing the (first) position of the error

         * 

         * @return An string or null

         */

        public String getErrorPositionAsMessage() {

                return this.errorPositionAsMessage;

        }

        /**

         * Returns the error position (line, column) or (-1, -1) if there hasn't been any error

         * 

         * @return An array of 2 integer values (first: line, second: column) 

         */

        public int[] getErrorPosition() {

                return errorPosition;

        }

        /**

         * Returns the token where the validator failed

         * 

         * @return An string

         */

        public String getTokenThatProducedTheSyntacticError() {

                return token;

        }

        /**

         * Creates a message with information about the message

         * 

         * @param position An array with 2 elements: (row, column)

         */

        private void defineErrorPositionAsMessageAttribute(int position[]) {

                // Defines the error message

                errorPositionAsMessage = new String( PluginServices.getText(null, "line") + ": " + errorPosition[0] + ", " + PluginServices.getText(null, "column") + ": " + errorPosition[1] );

        }

}