001    /**
002     * Copyright (c) 2000-2012 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, new String[] {"[$FALSE$]", "[$TRUE$]"},
187                            new String[] {_db.getTemplateFalse(), _db.getTemplateTrue()});
188            }
189    
190            private String _replaceCastLong(String sql) {
191                    Matcher matcher = _castLongPattern.matcher(sql);
192    
193                    if (_vendorSybase) {
194                            return matcher.replaceAll("CONVERT(BIGINT, $1)");
195                    }
196                    else {
197                            return matcher.replaceAll("$1");
198                    }
199            }
200    
201            private String _replaceCastText(String sql) {
202                    Matcher matcher = _castTextPattern.matcher(sql);
203    
204                    if (_vendorDB2 || _vendorDerby) {
205                            return matcher.replaceAll("CAST($1 AS CHAR(254))");
206                    }
207                    else if (_vendorHypersonic) {
208                            return matcher.replaceAll("CONVERT($1, SQL_VARCHAR)");
209                    }
210                    else if (_vendorOracle) {
211                            return matcher.replaceAll("CAST($1 AS VARCHAR(4000))");
212                    }
213                    else if (_vendorPostgreSQL) {
214                            return matcher.replaceAll("CAST($1 AS TEXT)");
215                    }
216                    else if (_vendorSQLServer) {
217                            return matcher.replaceAll("CAST($1 AS NVARCHAR(MAX))");
218                    }
219                    else if (_vendorSybase) {
220                            return matcher.replaceAll("CAST($1 AS NVARCHAR(5461))");
221                    }
222                    else {
223                            return matcher.replaceAll("$1");
224                    }
225            }
226    
227            private String _replaceCrossJoin(String sql) {
228                    if (_vendorSybase) {
229                            return StringUtil.replace(sql, "CROSS JOIN", StringPool.COMMA);
230                    }
231    
232                    return sql;
233            }
234    
235            private String _replaceIntegerDivision(String sql) {
236                    Matcher matcher = _integerDivisionPattern.matcher(sql);
237    
238                    if (_vendorMySQL) {
239                            return matcher.replaceAll("$1 DIV $2");
240                    }
241                    else if (_vendorOracle) {
242                            return matcher.replaceAll("TRUNC($1 / $2)");
243                    }
244                    else {
245                            return matcher.replaceAll("$1 / $2");
246                    }
247            }
248    
249            private String _replaceLike(String sql) {
250                    Matcher matcher = _likePattern.matcher(sql);
251    
252                    return matcher.replaceAll(
253                            "LIKE COALESCE(CAST(? AS VARCHAR(32672)),'')");
254            }
255    
256            private String _replaceMod(String sql) {
257                    Matcher matcher = _modPattern.matcher(sql);
258    
259                    return matcher.replaceAll("$1 % $2");
260            }
261    
262            private String _replaceNegativeComparison(String sql) {
263                    Matcher matcher = _negativeComparisonPattern.matcher(sql);
264    
265                    return matcher.replaceAll("$1 ($2)");
266            }
267    
268            private String _replaceReplace(String newSQL) {
269                    return newSQL.replaceAll("(?i)replace\\(", "str_replace(");
270            }
271    
272            private String _replaceUnion(String sql) {
273                    Matcher matcher = _unionAllPattern.matcher(sql);
274    
275                    return matcher.replaceAll("$1 $2");
276            }
277    
278            private String _transform(String sql) {
279                    if (sql == null) {
280                            return sql;
281                    }
282    
283                    String newSQL = sql;
284    
285                    newSQL = _replaceBitwiseCheck(newSQL);
286                    newSQL = _replaceBoolean(newSQL);
287                    newSQL = _replaceCastLong(newSQL);
288                    newSQL = _replaceCastText(newSQL);
289                    newSQL = _replaceCrossJoin(newSQL);
290                    newSQL = _replaceIntegerDivision(newSQL);
291    
292                    if (_vendorDB2) {
293                            newSQL = _replaceLike(newSQL);
294                    }
295                    else if (_vendorDerby) {
296                            newSQL = _replaceUnion(newSQL);
297                    }
298                    else if (_vendorMySQL) {
299                            DB db = DBFactoryUtil.getDB();
300    
301                            if (!db.isSupportsStringCaseSensitiveQuery()) {
302                                    newSQL = _removeLower(newSQL);
303                            }
304                    }
305                    else if (_vendorPostgreSQL) {
306                            newSQL = _replaceNegativeComparison(newSQL);
307                    }
308                    else if (_vendorSQLServer) {
309                            newSQL = _replaceMod(newSQL);
310                    }
311                    else if (_vendorSybase) {
312                            newSQL = _replaceMod(newSQL);
313                            newSQL = _replaceReplace(newSQL);
314                    }
315    
316                    if (_log.isDebugEnabled()) {
317                            _log.debug("Original SQL " + sql);
318                            _log.debug("Modified SQL " + newSQL);
319                    }
320    
321                    return newSQL;
322            }
323    
324            private String _transformFromHqlToJpql(String sql) {
325                    String newSQL = _transformedSqls.get(sql);
326    
327                    if (newSQL != null) {
328                            return newSQL;
329                    }
330    
331                    newSQL = _transform(sql);
332    
333                    newSQL = _transformPositionalParams(newSQL);
334    
335                    newSQL = StringUtil.replace(newSQL, _HQL_NOT_EQUALS, _JPQL_NOT_EQUALS);
336                    newSQL = StringUtil.replace(
337                            newSQL, _HQL_COMPOSITE_ID_MARKER, _JPQL_DOT_SEPARTOR);
338    
339                    _transformedSqls.put(sql, newSQL);
340    
341                    return newSQL;
342            }
343    
344            private String _transformFromJpqlToHql(String sql) {
345                    String newSQL = _transformedSqls.get(sql);
346    
347                    if (newSQL != null) {
348                            return newSQL;
349                    }
350    
351                    newSQL = _transform(sql);
352    
353                    Matcher matcher = _jpqlCountPattern.matcher(newSQL);
354    
355                    if (matcher.find()) {
356                            String countExpression = matcher.group(1);
357                            String entityAlias = matcher.group(3);
358    
359                            if (entityAlias.equals(countExpression)) {
360                                    newSQL = matcher.replaceFirst(_HQL_COUNT_SQL);
361                            }
362                    }
363    
364                    _transformedSqls.put(sql, newSQL);
365    
366                    return newSQL;
367            }
368    
369            private String _transformPositionalParams(String queryString) {
370                    if (queryString.indexOf(CharPool.QUESTION) == -1) {
371                            return queryString;
372                    }
373    
374                    StringBundler sb = new StringBundler();
375    
376                    int i = 1;
377                    int from = 0;
378                    int to = 0;
379    
380                    while ((to = queryString.indexOf(CharPool.QUESTION, from)) != -1) {
381                            sb.append(queryString.substring(from, to));
382                            sb.append(StringPool.QUESTION);
383                            sb.append(i++);
384    
385                            from = to + 1;
386                    }
387    
388                    sb.append(queryString.substring(from));
389    
390                    return sb.toString();
391            }
392    
393            private static final String _HQL_COMPOSITE_ID_MARKER = "\\.id\\.";
394    
395            private static final String _HQL_COUNT_SQL = "SELECT COUNT(*) FROM $2 $3";
396    
397            private static final String _HQL_NOT_EQUALS = "!=";
398    
399            private static final String _JPQL_DOT_SEPARTOR = ".";
400    
401            private static final String _JPQL_NOT_EQUALS = "<>";
402    
403            private static final String _LOWER_CLOSE = StringPool.CLOSE_PARENTHESIS;
404    
405            private static final String _LOWER_OPEN = "lower(";
406    
407            private static Log _log = LogFactoryUtil.getLog(SQLTransformer.class);
408    
409            private static SQLTransformer _instance = new SQLTransformer();
410    
411            private static Pattern _bitwiseCheckPattern = Pattern.compile(
412                    "BITAND\\((.+?),(.+?)\\)");
413            private static Pattern _castLongPattern = Pattern.compile(
414                    "CAST_LONG\\((.+?)\\)", Pattern.CASE_INSENSITIVE);
415            private static Pattern _castTextPattern = Pattern.compile(
416                    "CAST_TEXT\\((.+?)\\)", Pattern.CASE_INSENSITIVE);
417            private static Pattern _integerDivisionPattern = Pattern.compile(
418                    "INTEGER_DIV\\((.+?),(.+?)\\)", Pattern.CASE_INSENSITIVE);
419            private static Pattern _jpqlCountPattern = Pattern.compile(
420                    "SELECT COUNT\\((\\S+)\\) FROM (\\S+) (\\S+)");
421            private static Pattern _likePattern = Pattern.compile(
422                    "LIKE \\?", Pattern.CASE_INSENSITIVE);
423            private static Pattern _modPattern = Pattern.compile(
424                    "MOD\\((.+?),(.+?)\\)", Pattern.CASE_INSENSITIVE);
425            private static Pattern _negativeComparisonPattern = Pattern.compile(
426                    "(!?=)( -([0-9]+)?)", Pattern.CASE_INSENSITIVE);
427            private static Pattern _unionAllPattern = Pattern.compile(
428                    "SELECT \\* FROM(.*)TEMP_TABLE(.*)", Pattern.CASE_INSENSITIVE);
429    
430            private DB _db;
431            private Map<String, String> _transformedSqls;
432            private boolean _vendorDB2;
433            private boolean _vendorDerby;
434            private boolean _vendorFirebird;
435            private boolean _vendorHypersonic;
436            private boolean _vendorInformix;
437            private boolean _vendorIngres;
438            private boolean _vendorInterbase;
439            private boolean _vendorMySQL;
440            private boolean _vendorOracle;
441            private boolean _vendorPostgreSQL;
442            private boolean _vendorSQLServer;
443            private boolean _vendorSybase;
444    
445    }