org.apache.cayenne.log.FormattedCommonsJdbcEventLogger Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cayenne-client
An aggregation of 1.4, 1.5 modules into an ROP client jar.
There is a newer version: 4.2.1
/*****************************************************************
 *   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.cayenne.log;

import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;

import org.apache.cayenne.map.DbAttribute;

/**
 * A {@link CommonsJdbcEventLogger} extension that provides pretty formatting of the
 * logged SQL messages.
 * 
 * @since 3.1
 */
public class FormattedCommonsJdbcEventLogger extends CommonsJdbcEventLogger {

    private final static Map KEYWORDS = new HashMap();

    static {
        KEYWORDS.put(" select ", "SELECT");
        KEYWORDS.put(" from ", "FROM");
        KEYWORDS.put(" where ", "WHERE");
        KEYWORDS.put(" order by ", "ORDER BY");
        KEYWORDS.put(" group by ", "GROUP BY");
        KEYWORDS.put(" update ", "UPDATE");
        KEYWORDS.put(" exec ", "EXEC");
        KEYWORDS.put(" set ", "SET");
        KEYWORDS.put(" insert ", "INSERT");
        KEYWORDS.put(" values ", "VALUES");
        KEYWORDS.put(" delete ", "DELETE");
        KEYWORDS.put(" declare ", "DECLARE");
        KEYWORDS.put(" case ", "CASE");
    }

    private String formatQuery(String sql) {
        Map scanResult = scanQuery(sql);
        Iterator iter = scanResult.keySet().iterator();
        int nextKeyIdx = (iter.hasNext()) ? iter.next() : -1;

        StringBuffer buffer = new StringBuffer();
        int apixCount = 0;
        int bufferPos = 0;
        for (int pos = 0; pos < sql.length(); pos++) {
            if (sql.charAt(pos) == '\'') {
                apixCount++;
                if (pos > 0 && sql.charAt(pos - 1) == '\'')
                    apixCount = apixCount - 2;
            }
            if (apixCount % 2 != 0) {
                continue;
            }
            if (pos == nextKeyIdx) {
                buffer.append(sql.substring(bufferPos, pos + 1));
                buffer.append("\n");
                String shiftedKeyWrd = scanResult.get(nextKeyIdx);
                nextKeyIdx = (iter.hasNext()) ? iter.next() : -1;
                buffer.append(shiftedKeyWrd);
                pos = pos + shiftedKeyWrd.length();
                bufferPos = pos + 1;
            }
            else if (sql.charAt(pos) == ','
                    || sql.charAt(pos) == ')'
                    || sql.charAt(pos) == '(') {
                buffer.append(sql.substring(bufferPos, pos + 1));
                buffer.append("\n\t");
                bufferPos = pos + 1;
            }
        }
        buffer.append(sql.substring(bufferPos));
        buffer.append("\n");
        String result = buffer.toString();
        while (result.contains("  ")) {
            result = result.replaceAll("  ", " ");
        }
        return result;
    }

    private Map scanQuery(String sql) {
        Map result = new TreeMap();
        String sql2Lower = sql.toLowerCase();
        for (String keyWrd : KEYWORDS.keySet()) {
            int prevIdx = 0;
            while (true) {
                int idx = sql2Lower.indexOf(keyWrd, prevIdx);
                if (idx >= 0) {
                    result.put(idx, KEYWORDS.get(keyWrd));
                    prevIdx = idx + 1;
                }
                else {
                    break;
                }
            }
        }
        return result;
    }

    @Override
    public void logQuery(
            String queryStr,
            List attrs,
            List params,
            long time) {
        if (isLoggable()) {
            super.logQuery(formatQuery(queryStr), attrs, params, time);
        }
    }

}