Search in sources :

Example 1 with TemplatingException

use of org.jooq.exception.TemplatingException in project jOOQ by jOOQ.

the class Tools method renderAndBind.

/**
 * Render and bind a list of {@link QueryPart} to plain SQL
 * <p>
 * This will perform two actions:
 * <ul>
 * <li>When {@link RenderContext} is provided, it will render plain SQL to
 * the context, substituting {numbered placeholders} and bind values if
 * {@link RenderContext#inline()} is set</li>
 * <li>When {@link BindContext} is provided, it will bind the list of
 * {@link QueryPart} according to the {numbered placeholders} and bind
 * values in the sql string</li>
 * </ul>
 */
@SuppressWarnings("null")
static final void renderAndBind(Context<?> ctx, String sql, List<QueryPart> substitutes) {
    RenderContext render = ctx instanceof RenderContext ? (RenderContext) ctx : null;
    BindContext bind = ctx instanceof BindContext ? (BindContext) ctx : null;
    int substituteIndex = 0;
    char[] sqlChars = sql.toCharArray();
    // [#1593] Create a dummy renderer if we're in bind mode
    if (render == null)
        render = new DefaultRenderContext(bind.configuration());
    SQLDialect family = render.family();
    boolean mysql = SUPPORTS_HASH_COMMENT_SYNTAX.contains(render.dialect());
    char[][][] quotes = QUOTES.get(family);
    // [#3630] Depending on this setting, we need to consider backslashes as escape characters within string literals.
    boolean needsBackslashEscaping = needsBackslashEscaping(ctx.configuration());
    characterLoop: for (int i = 0; i < sqlChars.length; i++) {
        // where id = ?
        if (peek(sqlChars, i, TOKEN_SINGLE_LINE_COMMENT) || peek(sqlChars, i, TOKEN_SINGLE_LINE_COMMENT_C) || // http://bugs.mysql.com/bug.php?id=76623
        (mysql && peek(sqlChars, i, TOKEN_HASH))) {
            // Consume the complete comment
            for (; i < sqlChars.length && sqlChars[i] != '\r' && sqlChars[i] != '\n'; render.sql(sqlChars[i++])) ;
            // Consume the newline character
            if (i < sqlChars.length)
                render.sql(sqlChars[i]);
        } else // from t_book where id = ?
        if (peek(sqlChars, i, TOKEN_MULTI_LINE_COMMENT_OPEN)) {
            int nestedMultilineCommentLevel = 1;
            // Consume the complete comment
            do {
                render.sql(sqlChars[i++]);
                if (peek(sqlChars, i, TOKEN_MULTI_LINE_COMMENT_OPEN))
                    nestedMultilineCommentLevel++;
                else if (peek(sqlChars, i, TOKEN_MULTI_LINE_COMMENT_CLOSE))
                    nestedMultilineCommentLevel--;
            } while (nestedMultilineCommentLevel != 0);
            // Consume the comment delimiter
            render.sql(sqlChars[i]);
        } else // insert into x values ('Hello? Anybody out there?');
        if (sqlChars[i] == '\'') {
            // Consume the initial string literal delimiter
            render.sql(sqlChars[i++]);
            // Consume the whole string literal
            for (; ; ) {
                // of some vendor specific comment syntax
                if (i >= sqlChars.length)
                    break characterLoop;
                else // [#3000] [#3630] Consume backslash-escaped characters if needed
                if (sqlChars[i] == '\\' && needsBackslashEscaping)
                    render.sql(sqlChars[i++]);
                else // Consume an escaped apostrophe
                if (peek(sqlChars, i, TOKEN_ESCAPED_APOS))
                    render.sql(sqlChars[i++]);
                else // Break on the terminal string literal delimiter
                if (peek(sqlChars, i, TOKEN_APOS))
                    break;
                // Consume string literal content
                render.sql(sqlChars[i++]);
            }
            // Consume the terminal string literal delimiter
            render.sql(sqlChars[i]);
        } else // [#6704] PostgreSQL supports additional quoted string literals, which we must skip: E'...'
        if ((sqlChars[i] == 'e' || sqlChars[i] == 'E') && SUPPORT_POSTGRES_LITERALS.contains(ctx.dialect()) && i + 1 < sqlChars.length && sqlChars[i + 1] == '\'') {
            // Consume the initial string literal delimiters
            render.sql(sqlChars[i++]);
            render.sql(sqlChars[i++]);
            // Consume the whole string literal
            for (; ; ) {
                // [#3000] [#3630] Consume backslash-escaped characters if needed
                if (sqlChars[i] == '\\')
                    render.sql(sqlChars[i++]);
                else // Consume an escaped apostrophe
                if (peek(sqlChars, i, TOKEN_ESCAPED_APOS))
                    render.sql(sqlChars[i++]);
                else // Break on the terminal string literal delimiter
                if (peek(sqlChars, i, TOKEN_APOS))
                    break;
                // Consume string literal content
                render.sql(sqlChars[i++]);
            }
            // Consume the terminal string literal delimiter
            render.sql(sqlChars[i]);
        } else // update x set v = "Column Name with a ? (question mark)"
        if (peekAny(sqlChars, i, quotes[QUOTE_START_DELIMITER])) {
            // Main identifier delimiter or alternative one?
            int delimiter = 0;
            for (int d = 0; d < quotes[QUOTE_START_DELIMITER].length; d++) {
                if (peek(sqlChars, i, quotes[QUOTE_START_DELIMITER][d])) {
                    delimiter = d;
                    break;
                }
            }
            // Consume the initial identifier delimiter
            for (int d = 0; d < quotes[QUOTE_START_DELIMITER][delimiter].length; d++) render.sql(sqlChars[i++]);
            // Consume the whole identifier
            identifierLoop: for (; ; ) {
                // of some vendor specific comment syntax
                if (i >= sqlChars.length)
                    break characterLoop;
                else // Consume an escaped quote
                if (peek(sqlChars, i, quotes[QUOTE_END_DELIMITER_ESCAPED][delimiter])) {
                    for (int d = 0; d < quotes[QUOTE_END_DELIMITER_ESCAPED][delimiter].length; d++) render.sql(sqlChars[i++]);
                    continue identifierLoop;
                } else // Break on the terminal identifier delimiter
                if (peek(sqlChars, i, quotes[QUOTE_END_DELIMITER][delimiter]))
                    break identifierLoop;
                // Consume identifier content
                render.sql(sqlChars[i++]);
            }
            // Consume the terminal identifier delimiter
            for (int d = 0; d < quotes[QUOTE_END_DELIMITER][delimiter].length; d++) {
                if (d > 0)
                    i++;
                render.sql(sqlChars[i]);
            }
        } else // Inline bind variables only outside of string literals
        if (substituteIndex < substitutes.size() && ((sqlChars[i] == '?') || // Watch out for the PostgreSQL cast operator ::
        (sqlChars[i] == ':' && i + 1 < sqlChars.length && isJavaIdentifierPart(sqlChars[i + 1]) && (i - 1 < 0 || sqlChars[i - 1] != ':')))) {
            // [#5307] Consume PostgreSQL style operators. These aren't bind variables!
            if (sqlChars[i] == '?' && i + 1 < sqlChars.length && SUPPORT_NON_BIND_VARIABLE_SUFFIXES.contains(ctx.dialect())) {
                nonBindSuffixLoop: for (char[] candidate : NON_BIND_VARIABLE_SUFFIXES) {
                    if (peek(sqlChars, i + 1, candidate)) {
                        for (char[] exclude : BIND_VARIABLE_SUFFIXES) if (peek(sqlChars, i + 1, exclude))
                            continue nonBindSuffixLoop;
                        for (int j = i; i - j <= candidate.length; i++) render.sql(sqlChars[i]);
                        render.sql(sqlChars[i]);
                        continue characterLoop;
                    }
                }
            }
            // [#4131] Consume the named bind variable
            if (sqlChars[i] == ':')
                while (i + 1 < sqlChars.length && isJavaIdentifierPart(sqlChars[i + 1])) i++;
            QueryPart substitute = substitutes.get(substituteIndex++);
            if (render.paramType() == INLINED || render.paramType() == NAMED || render.paramType() == NAMED_OR_INLINED) {
                render.visit(substitute);
            } else {
                CastMode previous = render.castMode();
                render.castMode(CastMode.NEVER).visit(substitute).castMode(previous);
            }
            if (bind != null)
                bind.visit(substitute);
        } else // [#1432] Inline substitues for {numbered placeholders} outside of string literals
        if (sqlChars[i] == '{') {
            // [#1461] Be careful not to match any JDBC escape syntax
            if (peekAny(sqlChars, i, JDBC_ESCAPE_PREFIXES, true)) {
                render.sql(sqlChars[i]);
            } else // Consume the whole token
            {
                int start = ++i;
                for (; i < sqlChars.length && sqlChars[i] != '}'; i++) ;
                int end = i;
                // Try getting the {numbered placeholder}
                Integer index = Ints.tryParse(sql, start, end);
                if (index != null) {
                    if (index < 0 || index >= substitutes.size())
                        throw new TemplatingException("No substitute QueryPart provided for placeholder {" + index + "} in plain SQL template: " + sql);
                    QueryPart substitute = substitutes.get(index);
                    render.visit(substitute);
                    if (bind != null)
                        bind.visit(substitute);
                } else {
                    // Then we're dealing with a {keyword}
                    render.visit(DSL.keyword(sql.substring(start, end)));
                }
            }
        } else // Any other character
        {
            render.sql(sqlChars[i]);
        }
    }
}
Also used : BindContext(org.jooq.BindContext) BigInteger(java.math.BigInteger) UInteger(org.jooq.types.UInteger) RenderContext(org.jooq.RenderContext) SQLDialect(org.jooq.SQLDialect) QueryPart(org.jooq.QueryPart) TemplatingException(org.jooq.exception.TemplatingException) CastMode(org.jooq.RenderContext.CastMode)

Aggregations

BigInteger (java.math.BigInteger)1 BindContext (org.jooq.BindContext)1 QueryPart (org.jooq.QueryPart)1 RenderContext (org.jooq.RenderContext)1 CastMode (org.jooq.RenderContext.CastMode)1 SQLDialect (org.jooq.SQLDialect)1 TemplatingException (org.jooq.exception.TemplatingException)1 UInteger (org.jooq.types.UInteger)1