SqlScriptReader.java

/**
 * Licensed to JumpMind Inc under one or more contributor
 * license agreements.  See the NOTICE file distributed
 * with this work for additional information regarding
 * copyright ownership.  JumpMind Inc licenses this file
 * to you under the GNU General Public License, version 3.0 (GPLv3)
 * (the "License"); you may not use this file except in compliance
 * with the License.
 *
 * You should have received a copy of the GNU General Public License,
 * version 3.0 (GPLv3) along with this library; if not, see
 * <http://www.gnu.org/licenses/>.
 *
 * 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.jumpmind.db.sql;

import java.io.IOException;
import java.io.LineNumberReader;
import java.io.Reader;
import java.util.Map;

import org.apache.commons.lang.StringUtils;
import org.jumpmind.exception.IoException;
import org.jumpmind.util.FormatUtils;

/**
 * Provides an interface to read each SQL statement in a SQL script.
 */
public class SqlScriptReader extends LineNumberReader implements ISqlStatementSource {

    static final char COMMENT_CHARS[] = { '-', '#', '/' };

    public final static String QUERY_ENDS = ";";

    private String delimiter = QUERY_ENDS;

    private Map<String, String> replacementTokens;
    
    private boolean usePrefixSuffixForReplacementTokens = false;

    public SqlScriptReader(Reader in) {
        super(in);
    }
    
    public void setUsePrefixSuffixForReplacementTokens(boolean usePrefixSuffixForReplacementTokens) {
        this.usePrefixSuffixForReplacementTokens = usePrefixSuffixForReplacementTokens;
    }
    
   public boolean isUsePrefixSuffixForReplacementTokens() {
        return usePrefixSuffixForReplacementTokens;
   }

    public void setDelimiter(String delimiter) {
        this.delimiter = delimiter;
    }

    public String getDelimiter() {
        return delimiter;
    }

    public void setReplacementTokens(Map<String, String> replacementTokens) {
        this.replacementTokens = replacementTokens;
    }

    public Map<String, String> getReplacementTokens() {
        return replacementTokens;
    }

    public String readSqlStatement() {
        try {
            String line = readLine();
            StringBuilder sql = null;
            if (line != null) {
                do {
                    line = trimComments(line);
                        if (sql == null) {
                            sql = new StringBuilder();
                        }
                        sql.append("\n");
                        sql.append(line);

                        if (checkStatementEnds(sql.toString())) {
                            String toExecute = sql.substring(0, sql.lastIndexOf(delimiter));
                            toExecute = prepareForExecute(toExecute);
                            if (StringUtils.isNotBlank(toExecute)) {
                                return toExecute;
                            } else {
                                sql.setLength(0);
                            }
                        } 
                    line = readLine();
                } while (line != null);

                String toExecute = sql.toString();
                if (StringUtils.isNotBlank(toExecute)) {
                    return prepareForExecute(toExecute);
                } else {
                    return null;
                }
            } else {
                return null;
            }

        } catch (IOException ex) {
            throw new IoException(ex);
        }

    }
    
    protected String prepareForExecute(String toExecute) {
        toExecute = FormatUtils.replaceTokens(toExecute, replacementTokens,
                usePrefixSuffixForReplacementTokens);
        if (StringUtils.isNotBlank(toExecute)) {
            return toExecute.trim();
        } else {
            return null;
        }
    }
 
    protected String trimComments(String line) {
        char[] content = line.toCharArray();
        for (int i = 0; i < line.length(); i++) {
            if (!betweenOccurences('\'', i, content) 
                    && !betweenOccurences('"', i, content) 
                    && !betweenOccurences('`', i, content)) {
                for (char c : COMMENT_CHARS) {
                    if (c == content[i]) {
                        if (i + 1 < content.length && content[i + 1] == c) {
                            return line.substring(0, i);
                        }

                        if (i > 0 && content[i - 1] == c) {
                            return line.substring(0, i - 1);
                        }
                    }
                }
            }
        }
        return line;
    }
    
    protected boolean betweenOccurences(char q, int i, char[] content) {
        boolean startFound = false;
        for (int j = 0; j < content.length; j++) {
            if (content[j] == q)
                if (j < i) {
                    startFound = !startFound;
                } else if (j > i) {
                    return startFound;
                }
        }
        return false;
    }
    
    protected boolean inQuotedArea(String s) {
        return StringUtils.countMatches(s, "'") % 2 != 0
                || StringUtils.countMatches(s, "\"") % 2 != 0
                || StringUtils.countMatches(s, "`") % 2 != 0;
    }
    
    protected boolean checkStatementEnds(String s) {
        return s.trim().endsWith("" + delimiter) && !inQuotedArea(s);
    }

}