/*
 Copyright (C) 2002-2004 MySQL AB

 This program is free software; you can redistribute it and/or modify
 it under the terms of version 2 of the GNU General Public License as
 published by the Free Software Foundation.
 

 There are special exceptions to the terms and conditions of the GPL 
 as it is applied to this software. View the full text of the 
 exception exception in file EXCEPTIONS-CONNECTOR-J in the directory of this 
 software distribution.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */
package testsuite.regression;

import com.mysql.jdbc.StringUtils;

import testsuite.BaseTestCase;

import java.math.BigDecimal;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.Statement;

import java.util.Properties;


/**
 * Tests for regressions of bugs in String handling in the driver.
 *
 * @author Mark Matthews
 * @version StringRegressionTest.java,v 1.1 2002/11/04 14:58:25 mark_matthews Exp
 */
public class StringRegressionTest extends BaseTestCase {
    /**
     * Creates a new StringTest object.
     *
     * @param name DOCUMENT ME!
     */
    public StringRegressionTest(String name) {
        super(name);
    }

    /**
     * Runs all test cases in this test suite
     *
     * @param args
     */
    public static void main(String[] args) {
        junit.textui.TestRunner.run(StringRegressionTest.class);
    }

    /**
     * Tests character conversion bug.
     *
     * @throws Exception if there is an internal error (which is a bug).
     */
    public void testAsciiCharConversion() throws Exception {
        byte[] buf = new byte[10];
        buf[0] = (byte) '?';
        buf[1] = (byte) 'S';
        buf[2] = (byte) 't';
        buf[3] = (byte) 'a';
        buf[4] = (byte) 't';
        buf[5] = (byte) 'e';
        buf[6] = (byte) '-';
        buf[7] = (byte) 'b';
        buf[8] = (byte) 'o';
        buf[9] = (byte) 't';

        String testString = "?State-bot";
        String convertedString = StringUtils.toAsciiString(buf);

        for (int i = 0; i < convertedString.length(); i++) {
            System.out.println((byte) convertedString.charAt(i));
        }

        assertTrue("Converted string != test string",
            testString.equals(convertedString));
    }

    /**
     * Tests fix for BUG#4010 -- GBK encoding getting escaped doubly
     * when database default character set is GBK.
     * 
     * Requires version older than  4.1.0 and server set to default 
     * character set of 'gbk' to run.
     *
     * @throws Exception if the test fails.
     */
    public void testBug4010() throws Exception {
        if (!versionMeetsMinimum(4, 1)) {
            if ("GBK".equalsIgnoreCase(getMysqlVariable("character_set"))) {
                String origString = "\u603d";
                Properties props = new Properties();
                props.put("useUnicode", "true");
                props.put("characterEncoding", "GBK");

                Connection unicodeConn = getConnectionWithProps(props);
                Statement unicodeStmt = unicodeConn.createStatement();
                PreparedStatement unicodePstmt = unicodeConn.prepareStatement(
                        "INSERT INTO testBug4010 VALUES (?)");

                try {
                    unicodeStmt.executeUpdate(
                        "DROP TABLE IF EXISTS testBug4010");
                    unicodeStmt.executeUpdate(
                        "CREATE TABLE testBug4010 (field1 varchar(10))");

                    unicodePstmt.setString(1, origString);
                    unicodePstmt.executeUpdate();

                    this.rs = unicodeStmt.executeQuery(
                            "SELECT * FROM testBug4010");
                    assertTrue(this.rs.next());

                    String stringFromDb = this.rs.getString(1);
                    assertTrue("Retrieved string != sent string",
                        origString.equals(stringFromDb));
                } finally {
                    unicodeStmt.executeUpdate(
                        "DROP TABLE IF EXISTS testBug4010");
                    unicodeStmt.close();
                    unicodePstmt.close();
                    unicodeConn.close();
                }
            } else {
                System.err.println(
                    "WARN: Test not valid for servers not running GBK encoding");
            }
        } else {
            System.err.println(
                "WARN: Test not valid for MySQL version > 4.1.0, skipping");
        }
    }

    /**
     * Tests for regression of encoding forced by user, reported by Jive
     * Software
     *
     * @throws Exception when encoding is not supported (which is a bug)
     */
    public void testEncodingRegression() throws Exception {
        Properties props = new Properties();
        props.put("characterEncoding", "UTF-8");
        props.put("useUnicode", "true");
        DriverManager.getConnection(dbUrl, props).close();
    }

    /**
     * Tests fix for BUG#879
     *
     * @throws Exception if the bug resurfaces.
     */
    public void testEscapeSJISDoubleEscapeBug() throws Exception {
        String testString = "'It\\'s a boy!'";

        byte[] testStringAsBytes = testString.getBytes("SJIS");

        byte[] escapedStringBytes = StringUtils.escapeEasternUnicodeByteStream(testStringAsBytes,
                testString, 0, testString.length());

        String escapedString = new String(escapedStringBytes, "SJIS");

        assertTrue(testString.equals(escapedString));

        byte[] origByteStream = new byte[] {
                (byte) 0x95, (byte) 0x5c, (byte) 0x8e, (byte) 0x96, (byte) 0x5c,
                (byte) 0x62, (byte) 0x5c
            };

        String origString = "\u955c\u8e96\u5c62\\";

        byte[] newByteStream = StringUtils.escapeEasternUnicodeByteStream(origByteStream,
                origString, 0, origString.length());

        assertTrue((newByteStream.length == (origByteStream.length + 2))
            && (newByteStream[1] == 0x5c) && (newByteStream[2] == 0x5c)
            && (newByteStream[5] == 0x5c) && (newByteStream[6] == 0x5c));

        origByteStream = new byte[] {
                (byte) 0x8d, (byte) 0xb2, (byte) 0x93, (byte) 0x91, (byte) 0x81,
                (byte) 0x40, (byte) 0x8c, (byte) 0x5c
            };

        testString = new String(origByteStream, "SJIS");

        Properties connProps = new Properties();
        connProps.put("useUnicode", "true");
        connProps.put("characterEncoding", "sjis");
       
        Connection sjisConn = getConnectionWithProps(connProps);
        Statement sjisStmt = sjisConn.createStatement();

        try {
            sjisStmt.executeUpdate("DROP TABLE IF EXISTS doubleEscapeSJISTest");
            sjisStmt.executeUpdate(
                "CREATE TABLE doubleEscapeSJISTest (field1 BLOB)");

            PreparedStatement sjisPStmt = sjisConn.prepareStatement(
                    "INSERT INTO doubleEscapeSJISTest VALUES (?)");
            sjisPStmt.setString(1, testString);
            sjisPStmt.executeUpdate();

            this.rs = sjisStmt.executeQuery(
                    "SELECT * FROM doubleEscapeSJISTest");

            this.rs.next();

            String retrString = rs.getString(1);

            System.out.println(retrString.equals(testString));
        } finally {
            //sjisStmt.executeUpdate("DROP TABLE IF EXISTS doubleEscapeSJISTest");
        }
    }

    /**
     * Tests that 'latin1' character conversion works correctly.
     *
     * @throws Exception if any errors occur
     */
    public void testLatin1Encoding() throws Exception {
    	if (versionMeetsMinimum(4, 1)) {
	        char[] latin1Charset = {
	            0x0000, 0x0001, 0x0002, 0x0003, 0x0004, 0x0005, 0x0006, 0x0007,
	            0x0008, 0x0009, 0x000A, 0x000B, 0x000C, 0x000D, 0x000E, 0x000F,
	            0x0010, 0x0011, 0x0012, 0x0013, 0x0014, 0x0015, 0x0016, 0x0017,
	            0x0018, 0x0019, 0x001A, 0x001B, 0x001C, 0x001D, 0x001E, 0x001F,
	            0x0020, 0x0021, 0x0022, 0x0023, 0x0024, 0x0025, 0x0026, 0x0027,
	            0x0028, 0x0029, 0x002A, 0x002B, 0x002C, 0x002D, 0x002E, 0x002F,
	            0x0030, 0x0031, 0x0032, 0x0033, 0x0034, 0x0035, 0x0036, 0x0037,
	            0x0038, 0x0039, 0x003A, 0x003B, 0x003C, 0x003D, 0x003E, 0x003F,
	            0x0040, 0x0041, 0x0042, 0x0043, 0x0044, 0x0045, 0x0046, 0x0047,
	            0x0048, 0x0049, 0x004A, 0x004B, 0x004C, 0x004D, 0x004E, 0x004F,
	            0x0050, 0x0051, 0x0052, 0x0053, 0x0054, 0x0055, 0x0056, 0x0057,
	            0x0058, 0x0059, 0x005A, 0x005B, 0x005C, 0x005D, 0x005E, 0x005F,
	            0x0060, 0x0061, 0x0062, 0x0063, 0x0064, 0x0065, 0x0066, 0x0067,
	            0x0068, 0x0069, 0x006A, 0x006B, 0x006C, 0x006D, 0x006E, 0x006F,
	            0x0070, 0x0071, 0x0072, 0x0073, 0x0074, 0x0075, 0x0076, 0x0077,
	            0x0078, 0x0079, 0x007A, 0x007B, 0x007C, 0x007D, 0x007E, 0x007F,
	            0x0080, 0x0081, 0x0082, 0x0083, 0x0084, 0x0085, 0x0086, 0x0087,
	            0x0088, 0x0089, 0x008A, 0x008B, 0x008C, 0x008D, 0x008E, 0x008F,
	            0x0090, 0x0091, 0x0092, 0x0093, 0x0094, 0x0095, 0x0096, 0x0097,
	            0x0098, 0x0099, 0x009A, 0x009B, 0x009C, 0x009D, 0x009E, 0x009F,
	            0x00A0, 0x00A1, 0x00A2, 0x00A3, 0x00A4, 0x00A5, 0x00A6, 0x00A7,
	            0x00A8, 0x00A9, 0x00AA, 0x00AB, 0x00AC, 0x00AD, 0x00AE, 0x00AF,
	            0x00B0, 0x00B1, 0x00B2, 0x00B3, 0x00B4, 0x00B5, 0x00B6, 0x00B7,
	            0x00B8, 0x00B9, 0x00BA, 0x00BB, 0x00BC, 0x00BD, 0x00BE, 0x00BF,
	            0x00C0, 0x00C1, 0x00C2, 0x00C3, 0x00C4, 0x00C5, 0x00C6, 0x00C7,
	            0x00C8, 0x00C9, 0x00CA, 0x00CB, 0x00CC, 0x00CD, 0x00CE, 0x00CF,
	            0x00D0, 0x00D1, 0x00D2, 0x00D3, 0x00D4, 0x00D5, 0x00D6, 0x00D7,
	            0x00D8, 0x00D9, 0x00DA, 0x00DB, 0x00DC, 0x00DD, 0x00DE, 0x00DF,
	            0x00E0, 0x00E1, 0x00E2, 0x00E3, 0x00E4, 0x00E5, 0x00E6, 0x00E7,
	            0x00E8, 0x00E9, 0x00EA, 0x00EB, 0x00EC, 0x00ED, 0x00EE, 0x00EF,
	            0x00F0, 0x00F1, 0x00F2, 0x00F3, 0x00F4, 0x00F5, 0x00F6, 0x00F7,
	            0x00F8, 0x00F9, 0x00FA, 0x00FB, 0x00FC, 0x00FD, 0x00FE, 0x00FF
	        };
	
	        String latin1String = new String(latin1Charset);
	        PreparedStatement pStmt = null;
	
	        try {
	            stmt.executeUpdate("DROP TABLE IF EXISTS latin1RegressTest");
	            stmt.executeUpdate(
	                "CREATE TABLE latin1RegressTest (stringField TEXT)");
	
	            pStmt = conn.prepareStatement(
	                    "INSERT INTO latin1RegressTest VALUES (?)");
	            pStmt.setString(1, latin1String);
	            pStmt.executeUpdate();
	
	            rs = stmt.executeQuery("SELECT * FROM latin1RegressTest");
	
	            rs.next();
	
	            String retrievedString = rs.getString(1);
	
	            System.out.println(latin1String);
	            System.out.println(retrievedString);
	
	            if (!retrievedString.equals(latin1String)) {
	                int stringLength = Math.min(retrievedString.length(),
	                        latin1String.length());
	
	                for (int i = 0; i < stringLength; i++) {
	                    char rChar = retrievedString.charAt(i);
	                    char origChar = latin1String.charAt(i);
	
	                    if ((rChar != '?') && (rChar != origChar)) {
	                        fail("characters differ at position " + i + "'" + rChar
	                            + "' retrieved from database, original char was '"
	                            + origChar + "'");
	                    }
	                }
	            }
	        } finally {
	            if (rs != null) {
	                try {
	                    rs.close();
	                } catch (Exception ex) {
	                    // ignore
	                }
	            }
	
	            if (pStmt != null) {
	                try {
	                    pStmt.close();
	                } catch (Exception ex) {
	                    // ignore
	                }
	            }
	
	            stmt.executeUpdate("DROP TABLE IF EXISTS latin1RegressTest");
	        }
    	}
    }

    /**
     * Tests newline being treated correctly.
     *
     * @throws Exception if an error occurs
     */
    public void testNewlines() throws Exception {
        String newlineStr = "Foo\nBar\n\rBaz";

        stmt.executeUpdate("DROP TABLE IF EXISTS newlineRegressTest");
        stmt.executeUpdate(
            "CREATE TABLE newlineRegressTest (field1 MEDIUMTEXT)");

        try {
            stmt.executeUpdate("INSERT INTO newlineRegressTest VALUES ('"
                + newlineStr + "')");
            pstmt = conn.prepareStatement(
                    "INSERT INTO newlineRegressTest VALUES (?)");
            pstmt.setString(1, newlineStr);
            pstmt.executeUpdate();

            rs = stmt.executeQuery("SELECT * FROM newlineRegressTest");

            while (rs.next()) {
                assertTrue(rs.getString(1).equals(newlineStr));
            }
        } finally {
            stmt.executeUpdate("DROP TABLE IF EXISTS newlineRegressTest");
        }
    }

    
    /**
     * Tests that single-byte character conversion works correctly.
     *
     * @throws Exception if any errors occur
     */
    // TODO: Use Unicode Literal escapes for this, for now, this test is
    // broken :(
    /*
    public void testSingleByteConversion() throws Exception {
        testConversionForString("latin1", "��� ����");
        testConversionForString("latin1", "Kaarle ��nis Ilmari");
        testConversionForString("latin1", "������������������");
    }
*/
    /**
     * Tests that the 0x5c escaping works (we didn't use to have this).
     *
     * @throws Exception if an error occurs.
     */
    public void testSjis5c() throws Exception {
        byte[] origByteStream = new byte[] {
                (byte) 0x95, (byte) 0x5c, (byte) 0x8e, (byte) 0x96
            };

        //
        // Print the hex values of the string
        //
        StringBuffer bytesOut = new StringBuffer();

        for (int i = 0; i < origByteStream.length; i++) {
            bytesOut.append(Integer.toHexString(origByteStream[i] & 255));
            bytesOut.append(" ");
        }

        System.out.println(bytesOut.toString());

        String origString = new String(origByteStream, "SJIS");
        byte[] newByteStream = StringUtils.getBytes(origString, "SJIS", "SJIS",
                false);

        //
        // Print the hex values of the string (should have an extra 0x5c)
        //
        bytesOut = new StringBuffer();

        for (int i = 0; i < newByteStream.length; i++) {
            bytesOut.append(Integer.toHexString(newByteStream[i] & 255));
            bytesOut.append(" ");
        }

        System.out.println(bytesOut.toString());

        //
        // Now, insert and retrieve the value from the database
        //
        Connection sjisConn = null;
        Statement sjisStmt = null;

        try {
            Properties props = new Properties();
            props.put("useUnicode", "true");
            props.put("characterEncoding", "SJIS");
            sjisConn = getConnectionWithProps(props);

            sjisStmt = sjisConn.createStatement();

            this.rs = sjisStmt.executeQuery(
                    "SHOW VARIABLES LIKE 'character_set%'");

            while (rs.next()) {
                System.out.println(rs.getString(1) + " = " + rs.getString(2));
            }

            sjisStmt.executeUpdate("DROP TABLE IF EXISTS sjisTest");

            if (versionMeetsMinimum(4, 1)) {
                sjisStmt.executeUpdate(
                    "CREATE TABLE sjisTest (field1 char(50)) DEFAULT CHARACTER SET SJIS");
            } else {
                sjisStmt.executeUpdate(
                    "CREATE TABLE sjisTest (field1 char(50))");
            }

            pstmt = sjisConn.prepareStatement("INSERT INTO sjisTest VALUES (?)");
            pstmt.setString(1, origString);
            pstmt.executeUpdate();

            rs = sjisStmt.executeQuery("SELECT * FROM sjisTest");

            while (rs.next()) {
                byte[] testValueAsBytes = rs.getBytes(1);

                bytesOut = new StringBuffer();

                for (int i = 0; i < testValueAsBytes.length; i++) {
                    bytesOut.append(Integer.toHexString(testValueAsBytes[i]
                            & 255));
                    bytesOut.append(" ");
                }

                System.out.println("Value retrieved from database: "
                    + bytesOut.toString());

                String testValue = rs.getString(1);

                assertTrue(testValue.equals(origString));
            }
        } finally {
            stmt.executeUpdate("DROP TABLE IF EXISTS sjisTest");
        }
    }

    /**
     * Tests that UTF-8 character conversion works correctly.
     *
     * @throws Exception if any errors occur
     */
    public void testUtf8Encoding() throws Exception {
    	if (versionMeetsMinimum(4, 1)) {
    		Properties props = new Properties();
    		props.put("characterEncoding", "UTF8");
    		props.put("useUnicode", "true");

    		Connection utfConn = DriverManager.getConnection(dbUrl, props);
    		testConversionForString("UTF8", utfConn, "\u043c\u0438\u0445\u0438");
    	}
    }

    /**
     *
     *
     * @throws Exception ...
     */
    public void testUtf8Encoding2() throws Exception {
    	if (versionMeetsMinimum(4, 1)) {
	        String field1 = "K��sel";
	        String field2 = "B�b";
	        byte[] field1AsBytes = field1.getBytes("utf-8");
	        byte[] field2AsBytes = field2.getBytes("utf-8");
	
	        Properties props = new Properties();
	        props.put("characterEncoding", "UTF8");
	        props.put("useUnicode", "true");
	
	        Connection utfConn = DriverManager.getConnection(dbUrl, props);
	        Statement utfStmt = utfConn.createStatement();
	
	        try {
	            utfStmt.executeUpdate("DROP TABLE IF EXISTS testUtf8");
	            utfStmt.executeUpdate(
	                "CREATE TABLE testUtf8 (field1 varchar(32), field2 varchar(32)) CHARACTER SET UTF8");
	            utfStmt.executeUpdate("INSERT INTO testUtf8 VALUES ('" + field1
	                + "','" + field2 + "')");
	
	            PreparedStatement pStmt = utfConn.prepareStatement(
	                    "INSERT INTO testUtf8 VALUES (?, ?)");
	            pStmt.setString(1, field1);
	            pStmt.setString(2, field2);
	            pStmt.executeUpdate();
	
	            ResultSet rs = utfStmt.executeQuery("SELECT * FROM testUtf8");
	            assertTrue(rs.next());
	
	            // Compare results stored using direct statement
	            // Compare to original string
	            assertTrue(field1.equals(rs.getString(1)));
	            assertTrue(field2.equals(rs.getString(2)));
	
	            // Compare byte-for-byte, ignoring encoding
	            assertTrue(bytesAreSame(field1AsBytes, rs.getBytes(1)));
	            assertTrue(bytesAreSame(field2AsBytes, rs.getBytes(2)));
	
	            assertTrue(rs.next());
	
	            // Compare to original string
	            assertTrue(field1.equals(rs.getString(1)));
	            assertTrue(field2.equals(rs.getString(2)));
	
	            // Compare byte-for-byte, ignoring encoding
	            assertTrue(bytesAreSame(field1AsBytes, rs.getBytes(1)));
	            assertTrue(bytesAreSame(field2AsBytes, rs.getBytes(2)));
	        } finally {
	            utfStmt.executeUpdate("DROP TABLE IF EXISTS testUtf8");
	        }
    	}
    }

    private boolean bytesAreSame(byte[] byte1, byte[] byte2) {
        if (byte1.length != byte2.length) {
            return false;
        }

        for (int i = 0; i < byte1.length; i++) {
            if (byte1[i] != byte2[i]) {
                return false;
            }
        }

        return true;
    }

    private void testConversionForString(String charsetName,
        Connection convConn, String charsToTest) throws Exception {
        PreparedStatement pStmt = null;

        try {
            System.out.println("String to be tested: " + charsToTest);

            stmt = convConn.createStatement();
            stmt.executeUpdate("DROP TABLE IF EXISTS charConvTest_"
                + charsetName);

            if (!versionMeetsMinimum(4, 1)) {
                stmt.executeUpdate("CREATE TABLE charConvTest_" + charsetName
                    + "(field1 CHAR(50)");
            } else {
                stmt.executeUpdate("CREATE TABLE charConvTest_" + charsetName
                    + "(field1 CHAR(50) CHARACTER SET " + charsetName + ")");
            }

            stmt.executeUpdate("INSERT INTO charConvTest_" + charsetName
                + " VALUES ('" + charsToTest + "')");
            pStmt = convConn.prepareStatement("INSERT INTO charConvTest_"
                    + charsetName + " VALUES (?)");
            pStmt.setString(1, charsToTest);
            pStmt.executeUpdate();
            rs = stmt.executeQuery("SELECT * FROM charConvTest_" + charsetName);

            boolean hadRows = false;

            while (rs.next()) {
                hadRows = true;

                String testValue = rs.getString(1);
                System.out.println(testValue);
                assertTrue("Returned string \"" + testValue
                    + "\" != original string of \"" + charsToTest + "\"",
                    testValue.equals(charsToTest));
            }

            assertTrue(hadRows);
        } finally {
            stmt.executeUpdate("DROP TABLE IF EXISTS charConvTest_"
                + charsetName);
        }
    }

    private void testConversionForString(String charsetName, String charsToTest)
        throws Exception {
        testConversionForString(charsetName, this.conn, charsToTest);
    }
    
    /**
     * Tests fix for BUG#7601, '+' duplicated in fixDecimalExponent().
     * 
     * @throws Exception if the test fails
     */
    public void testBug7601() throws Exception {
    	assertTrue("1.5E+7".equals(StringUtils.fixDecimalExponent("1.5E+7")));
    	assertTrue("1.5E-7".equals(StringUtils.fixDecimalExponent("1.5E-7")));
    	assertTrue("1.5E+7".equals(StringUtils.fixDecimalExponent("1.5E7")));
    }
}
