001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.dao.orm.common;
016    
017    import com.liferay.portal.kernel.dao.db.DB;
018    import com.liferay.portal.kernel.dao.db.DBFactoryUtil;
019    import com.liferay.portal.kernel.log.Log;
020    import com.liferay.portal.kernel.log.LogFactoryUtil;
021    import com.liferay.portal.kernel.util.CharPool;
022    import com.liferay.portal.kernel.util.StringBundler;
023    import com.liferay.portal.kernel.util.StringPool;
024    import com.liferay.portal.kernel.util.StringUtil;
025    
026    import java.util.Map;
027    import java.util.concurrent.ConcurrentHashMap;
028    import java.util.regex.Matcher;
029    import java.util.regex.Pattern;
030    
031    /**
032     * @author Brian Wing Shun Chan
033     * @author Shuyang Zhou
034     */
035    public class SQLTransformer {
036    
037            public static void reloadSQLTransformer() {
038                    _instance._reloadSQLTransformer();
039            }
040    
041            public static String transform(String sql) {
042                    return _instance._transform(sql);
043            }
044    
045            public static String transformFromHqlToJpql(String sql) {
046                    return _instance._transformFromHqlToJpql(sql);
047            }
048    
049            public static String transformFromJpqlToHql(String sql) {
050                    return _instance._transformFromJpqlToHql(sql);
051            }
052    
053            private SQLTransformer() {
054                    _reloadSQLTransformer();
055            }
056    
057            private void _reloadSQLTransformer() {
058                    if (_transformedSqls == null) {
059                            _transformedSqls = new ConcurrentHashMap<String, String>();
060                    }
061                    else {
062                            _transformedSqls.clear();
063                    }
064    
065                    _vendorDB2 = false;
066                    _vendorDerby = false;
067                    _vendorFirebird = false;
068                    //_vendorHypersonic = false;
069                    _vendorInformix = false;
070                    _vendorIngres = false;
071                    _vendorInterbase = false;
072                    _vendorMySQL = false;
073                    _vendorOracle = false;
074                    _vendorPostgreSQL = false;
075                    _vendorSQLServer = false;
076                    _vendorSybase = false;
077    
078                    DB db = DBFactoryUtil.getDB();
079    
080                    String dbType = db.getType();
081    
082                    _db = db;
083    
084                    if (dbType.equals(DB.TYPE_DB2)) {
085                            _vendorDB2 = true;
086                    }
087                    else if (dbType.equals(DB.TYPE_DERBY)) {
088                            _vendorDerby = true;
089                    }
090                    else if (dbType.equals(DB.TYPE_FIREBIRD)) {
091                            _vendorFirebird = true;
092                    }
093                    else if (dbType.equals(DB.TYPE_HYPERSONIC)) {
094                            //_vendorHypersonic = true;
095                    }
096                    else if (dbType.equals(DB.TYPE_INFORMIX)) {
097                            _vendorInformix = true;
098                    }
099                    else if (dbType.equals(DB.TYPE_INGRES)) {
100                            _vendorIngres = true;
101                    }
102                    else if (dbType.equals(DB.TYPE_INTERBASE)) {
103                            _vendorInterbase = true;
104                    }
105                    else if (dbType.equals(DB.TYPE_MYSQL)) {
106                            _vendorMySQL = true;
107                    }
108                    else if (db.getType().equals(DB.TYPE_ORACLE)) {
109                            _vendorOracle = true;
110                    }
111                    else if (dbType.equals(DB.TYPE_POSTGRESQL)) {
112                            _vendorPostgreSQL = true;
113                    }
114                    else if (dbType.equals(DB.TYPE_SQLSERVER)) {
115                            _vendorSQLServer = true;
116                    }
117                    else if (dbType.equals(DB.TYPE_SYBASE)) {
118                            _vendorSybase = true;
119                    }
120            }
121    
122            private String _removeLower(String sql) {
123                    int x = sql.indexOf(_LOWER_OPEN);
124    
125                    if (x == -1) {
126                            return sql;
127                    }
128    
129                    StringBuilder sb = new StringBuilder(sql.length());
130    
131                    int y = 0;
132    
133                    while (true) {
134                            sb.append(sql.substring(y, x));
135    
136                            y = sql.indexOf(_LOWER_CLOSE, x);
137    
138                            if (y == -1) {
139                                    sb.append(sql.substring(x));
140    
141                                    break;
142                            }
143    
144                            sb.append(sql.substring(x + _LOWER_OPEN.length(), y));
145    
146                            y++;
147    
148                            x = sql.indexOf(_LOWER_OPEN, y);
149    
150                            if (x == -1) {
151                                    sb.append(sql.substring(y));
152    
153                                    break;
154                            }
155                    }
156    
157                    sql = sb.toString();
158    
159                    return sql;
160            }
161    
162            private String _replaceBitwiseCheck(String sql) {
163                    Matcher matcher = _bitwiseCheckPattern.matcher(sql);
164    
165                    if (_vendorDerby) {
166                            return matcher.replaceAll("MOD($1 / $2, 2) != 0");
167                    }
168                    else if (_vendorInformix || _vendorIngres) {
169                            return matcher.replaceAll("BIT_AND($1, $2)");
170                    }
171                    else if (_vendorFirebird || _vendorInterbase) {
172                            return matcher.replaceAll("BIN_AND($1, $2)");
173                    }
174                    else if (_vendorMySQL || _vendorPostgreSQL || _vendorSQLServer ||
175                                     _vendorSybase) {
176    
177                            return matcher.replaceAll("($1 & $2)");
178                    }
179                    else {
180                            return sql;
181                    }
182            }
183    
184            private String _replaceBoolean(String newSQL) {
185                    return StringUtil.replace(
186                            newSQL,
187                            new String[] {"[$FALSE$]", "[$TRUE$]"},
188                            new String[] {_db.getTemplateFalse(), _db.getTemplateTrue()});
189            }
190    
191            private String _replaceCastLong(String sql) {
192                    Matcher matcher = _castLongPattern.matcher(sql);
193    
194                    if (_vendorSybase) {
195                            return matcher.replaceAll("CONVERT(BIGINT, $1)");
196                    }
197                    else {
198                            return matcher.replaceAll("$1");
199                    }
200            }
201    
202            private String _replaceCastText(String sql) {
203                    Matcher matcher = _castTextPattern.matcher(sql);
204    
205                    if (_vendorDB2 || _vendorDerby) {
206                            return matcher.replaceAll("CAST($1 AS CHAR(254))");
207                    }
208                    else if (_vendorOracle) {
209                            return matcher.replaceAll("CAST($1 AS VARCHAR(4000))");
210                    }
211                    else if (_vendorPostgreSQL) {
212                            return matcher.replaceAll("CAST($1 AS TEXT)");
213                    }
214                    else if (_vendorSQLServer) {
215                            return matcher.replaceAll("CAST($1 AS NVARCHAR(MAX))");
216                    }
217                    else if (_vendorSybase) {
218                            return matcher.replaceAll("CAST($1 AS NVARCHAR(16384))");
219                    }
220                    else {
221                            return matcher.replaceAll("$1");
222                    }
223            }
224    
225            private String _replaceIntegerDivision(String sql) {
226                    Matcher matcher = _integerDivisionPattern.matcher(sql);
227    
228                    if (_vendorMySQL) {
229                            return matcher.replaceAll("$1 DIV $2");
230                    }
231                    else if (_vendorOracle) {
232                            return matcher.replaceAll("TRUNC($1 / $2)");
233                    }
234                    else {
235                            return matcher.replaceAll("$1 / $2");
236                    }
237            }
238    
239            private String _replaceMod(String sql) {
240                    Matcher matcher = _modPattern.matcher(sql);
241    
242                    return matcher.replaceAll("$1 % $2");
243            }
244    
245            private String _replaceNegativeComparison(String sql) {
246                    Matcher matcher = _negativeComparisonPattern.matcher(sql);
247    
248                    return matcher.replaceAll("$1 ($2)");
249            }
250    
251            private String _replaceReplace(String newSQL) {
252                    return StringUtil.replace(newSQL, "replace(", "str_replace(");
253            }
254    
255            private String _replaceUnion(String sql) {
256                    Matcher matcher = _unionAllPattern.matcher(sql);
257    
258                    return matcher.replaceAll("$1 $2");
259            }
260    
261            private String _transform(String sql) {
262                    if (sql == null) {
263                            return sql;
264                    }
265    
266                    String newSQL = sql;
267    
268                    newSQL = _replaceBitwiseCheck(newSQL);
269                    newSQL = _replaceBoolean(newSQL);
270                    newSQL = _replaceCastLong(newSQL);
271                    newSQL = _replaceCastText(newSQL);
272                    newSQL = _replaceIntegerDivision(newSQL);
273    
274                    if (_vendorDerby) {
275                            newSQL = _replaceUnion(newSQL);
276                    }
277                    else if (_vendorMySQL) {
278                            DB db = DBFactoryUtil.getDB();
279    
280                            if (!db.isSupportsStringCaseSensitiveQuery()) {
281                                    newSQL = _removeLower(newSQL);
282                            }
283                    }
284                    else if (_vendorPostgreSQL) {
285                            newSQL = _replaceNegativeComparison(newSQL);
286                    }
287                    else if (_vendorSQLServer) {
288                            newSQL = _replaceMod(newSQL);
289                    }
290                    else if (_vendorSybase) {
291                            newSQL = _replaceMod(newSQL);
292                            newSQL = _replaceReplace(newSQL);
293                    }
294    
295                    if (_log.isDebugEnabled()) {
296                            _log.debug("Original SQL " + sql);
297                            _log.debug("Modified SQL " + newSQL);
298                    }
299    
300                    return newSQL;
301            }
302    
303            private String _transformFromHqlToJpql(String sql) {
304                    String newSQL = _transformedSqls.get(sql);
305    
306                    if (newSQL != null) {
307                            return newSQL;
308                    }
309    
310                    newSQL = _transform(sql);
311    
312                    newSQL = _transformPositionalParams(newSQL);
313    
314                    newSQL = StringUtil.replace(newSQL, _HQL_NOT_EQUALS, _JPQL_NOT_EQUALS);
315                    newSQL = StringUtil.replace(
316                            newSQL, _HQL_COMPOSITE_ID_MARKER, _JPQL_DOT_SEPARTOR);
317    
318                    _transformedSqls.put(sql, newSQL);
319    
320                    return newSQL;
321            }
322    
323            private String _transformFromJpqlToHql(String sql) {
324                    String newSQL = _transformedSqls.get(sql);
325    
326                    if (newSQL != null) {
327                            return newSQL;
328                    }
329    
330                    newSQL = _transform(sql);
331    
332                    Matcher matcher = _jpqlCountPattern.matcher(newSQL);
333    
334                    if (matcher.find()) {
335                            String countExpression = matcher.group(1);
336                            String entityAlias = matcher.group(3);
337    
338                            if (entityAlias.equals(countExpression)) {
339                                    newSQL = matcher.replaceFirst(_HQL_COUNT_SQL);
340                            }
341                    }
342    
343                    _transformedSqls.put(sql, newSQL);
344    
345                    return newSQL;
346            }
347    
348            private String _transformPositionalParams(String queryString) {
349                    if (queryString.indexOf(CharPool.QUESTION) == -1) {
350                            return queryString;
351                    }
352    
353                    StringBundler sb = new StringBundler();
354    
355                    int i = 1;
356                    int from = 0;
357                    int to = 0;
358    
359                    while ((to = queryString.indexOf(CharPool.QUESTION, from)) != -1) {
360                            sb.append(queryString.substring(from, to));
361                            sb.append(StringPool.QUESTION);
362                            sb.append(i++);
363    
364                            from = to + 1;
365                    }
366    
367                    sb.append(queryString.substring(from, queryString.length()));
368    
369                    return sb.toString();
370            }
371    
372            private static final String _HQL_COMPOSITE_ID_MARKER = "\\.id\\.";
373    
374            private static final String _HQL_COUNT_SQL = "SELECT COUNT(*) FROM $2 $3";
375    
376            private static final String _HQL_NOT_EQUALS = "!=";
377    
378            private static final String _JPQL_DOT_SEPARTOR = ".";
379    
380            private static final String _JPQL_NOT_EQUALS = "<>";
381    
382            private static final String _LOWER_CLOSE = StringPool.CLOSE_PARENTHESIS;
383    
384            private static final String _LOWER_OPEN = "lower(";
385    
386            private static Log _log = LogFactoryUtil.getLog(SQLTransformer.class);
387    
388            private static SQLTransformer _instance = new SQLTransformer();
389    
390            private static Pattern _bitwiseCheckPattern = Pattern.compile(
391                    "BITAND\\((.+?),(.+?)\\)");
392            private static Pattern _castLongPattern = Pattern.compile(
393                    "CAST_LONG\\((.+?)\\)", Pattern.CASE_INSENSITIVE);
394            private static Pattern _castTextPattern = Pattern.compile(
395                    "CAST_TEXT\\((.+?)\\)", Pattern.CASE_INSENSITIVE);
396            private static Pattern _integerDivisionPattern = Pattern.compile(
397                    "INTEGER_DIV\\((.+?),(.+?)\\)", Pattern.CASE_INSENSITIVE);
398            private static Pattern _jpqlCountPattern = Pattern.compile(
399                    "SELECT COUNT\\((\\S+)\\) FROM (\\S+) (\\S+)");
400            private static Pattern _modPattern = Pattern.compile(
401                    "MOD\\((.+?),(.+?)\\)", Pattern.CASE_INSENSITIVE);
402            private static Pattern _negativeComparisonPattern = Pattern.compile(
403                    "(!=)?( -([0-9]+)?)", Pattern.CASE_INSENSITIVE);
404            private static Pattern _unionAllPattern = Pattern.compile(
405                    "SELECT \\* FROM(.*)TEMP_TABLE(.*)", Pattern.CASE_INSENSITIVE);
406    
407            private DB _db;
408            private Map<String, String> _transformedSqls;
409            private boolean _vendorDB2;
410            private boolean _vendorDerby;
411            private boolean _vendorFirebird;
412            //private boolean _vendorHypersonic;
413            private boolean _vendorInformix;
414            private boolean _vendorIngres;
415            private boolean _vendorInterbase;
416            private boolean _vendorMySQL;
417            private boolean _vendorOracle;
418            private boolean _vendorPostgreSQL;
419            private boolean _vendorSQLServer;
420            private boolean _vendorSybase;
421    
422    }