• Home
• com.viaoa
• oa-web
• 3.7.9
• source code
• OAJspUtil.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.viaoa.web.util.OAJspUtil Maven / Gradle / Ivy

/*  Copyright 1999 Vince Via [email protected]
    Licensed 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 com.viaoa.web.util;

import com.viaoa.util.OAString;

/**
 * Utility used to convert dynamic data for internal text, so that it is html and javascript safe.
 * 
 * Data that is sent as code to the browser needs to be converted, so that the code that is created for it
 * does not break, either within the javascript or html.
 * 
 * The outer js code will wrap the text in single or double quotes, and can then have html inside of it.
 * The html can also have js code in it, so there is various encoding/escaping that needs to be done
 * to have well formed js and html that will not break the back from processing it.
 * 
 * 
 * @author vvia
 */
public class OAJspUtil {
    
    /**
     * Helper method use to make sure that text is correctly escaped to be inside of javascript code.
     * This will call createJsString(text, '"', false, false) 
     */
/*    
    public static String createText(final String text) {
        String s = createJsString(text, '"', false, true);
        return s;
    }
    public static String createText(final String text, char quoteChar) {
        String s = createJsString(text, quoteChar, false, true);
        return s;
    }
    
    
    public static String createHtml(final String text) {
        String s = createJsString(text, '"', false, true);
        return s;
    }
    public static String createHtml(final String text,  char quoteChar) {
        String s = createJsString(text, quoteChar, false, true);
        return s;
    }
*/
    
    /*
     * This is only needed when putting html code/data inside of something that is quoted.
     * 
     * where data = "John's" and would need to be convertedto "John's"
     * example:  

     * @return
     */
    public static String createEmbeddedHtmlString(final String text, final char htmlQuoteChar) {
        String s;
        if (htmlQuoteChar == '\'') s = OAString.convert(text, "\'", "'");  // '  not yet supported
        else if (htmlQuoteChar == '\"') s = OAString.convert(text, "\"", """);  // "
        else s = text;
        return s;
    }

    /*
     * Javascript code that is inside of JS > Html 
     * example:   $('#id').html(" ..  ");
     */
    public static String createEmbeddedJsString(final String text, final char jsQuoteChar) {
        return _createJsString(text, jsQuoteChar, true);
    }
    
    
    public static String createJsString(final String text, final char jsQuoteChar) {
        return _createJsString(text, jsQuoteChar, false);
    }
    
    /*
     * First checks to see if it might be html.  If so, returns text, else converts [NL] to 
 and < > to html codes.
     */
    public static String convertToHtml(final String text) {
        if (text == null) return "";
        final int x = text.length();
        // check to see if there is html within the text.  If so, then dont convert.
        int cnt1 = 0;
        int cnt2 = 0;
        int cnt3 = 0;
        for (int i=0; i') cnt2++;
            else if (c == '\n') cnt3++;
        }
        if (cnt1 > 0 && cnt1 == cnt2) return text;  // guessing that this is already html
        
        if (cnt1 == 0 && cnt2 == 0 && cnt3 == 0) return text;

        StringBuilder sb = new StringBuilder(x+ (3*(cnt1 + cnt2 + cnt3)));
        
        for (int i=0; i");
                    break;
                case '<':
                    sb.append("<"); 
                    break;
                case '>':
                    sb.append(">"); 
                    break;
                case '\'':
                    sb.append("'"); 
                    break;
                case '\"':
                    sb.append("""); 
                    break;
                default:
                    sb.append(ch);
            }
        }
        return sb.toString();
        
    }
    
    /*
     * Converts a string to be used inside of a codegen Javascript screen
     * @param text
     * @param jsQuoteChar the char used for quoting the string
     * @param bIsJsCodeEmbeddedInHtml true if this is for js string that will be embedded inside of html
     * @param bMakeHtmlSafe if text should be check to see if < or > should be encoded.
     * @return string that can be put into a codegen js string and quoted with quoteChars
     */
    protected static String _createJsString(final String text, final char jsQuoteChar, final boolean bIsJsCodeEmbeddedInHtml) {
        if (text == null) return "";
        final int x = text.length();
        StringBuilder sb = null;

        for (int i=0; i 0) sb.append(text.substring(0, i));
                }
                
                if (ch == '\'') {
                    if (bIsJsCodeEmbeddedInHtml) sb.append("\\x27");  // x27 = "\'"
                    //was if (bIsJsCodeEmbeddedInHtml) sb.append("\\x5Cx27");  //  x5C = "\"   x27 = "\'"
                    else sb.append("\\"+jsQuoteChar);
                }
                else if (ch == '\"') {
                    if (bIsJsCodeEmbeddedInHtml) sb.append("\\x22");  // x22 = "\""
                    //was if (bIsJsCodeEmbeddedInHtml) sb.append("\\x5Cx22");  //  x5C = "\"   x22 = "\""
                    else sb.append("\\"+jsQuoteChar);
                }
                else if (ch == '<') {
                    sb.append("<");
                }
                else if (ch == '>') {
                    sb.append(">");
                }
                else if (ch == '\n') {
                    if (!bIsJsCodeEmbeddedInHtml) sb.append("\\n");
                    else sb.append("\\n"); //  \n
                    //was else sb.append("\\x5Cn"); //  \n
                }
                else if (ch == '\r') {
                    // no-op
                }
                else if (ch == '\\') {
                    if (!bIsJsCodeEmbeddedInHtml) sb.append("\\\\");
                    else sb.append("\\");
                    //was: else sb.append("\\x5C\\x5C"); // x5C = "\"
                }
            }
            else {
                if (sb != null) sb.append(ch);
            }
        }
        
        if (sb == null) {
            return text;
        }
        return sb.toString();
    }
}  
/*
if (ch == '&') {
    sb.append("&");
}
else if (ch == '"') {
    sb.append("""); // "
}
else if (ch == '\'') {
    sb.append("'"); // '  not yet supported
}
*/