Merge pull request #41 from frankgrimes97/feature/ESCAPE_QUOTE_CHAR_WITH_ESCAPE_CHAR

Add CsvGenerator.Feature.ESCAPE_QUOTE_CHAR_WITH_ESCAPE_CHAR

Author: cowtowncoder

csv/src/main/java/com/fasterxml/jackson/dataformat/csv/CsvGenerator.java

@@ -71,6 +71,14 @@ public enum Feature
          * @since 2.9
          */
         ALWAYS_QUOTE_EMPTY_STRINGS(false),
+
+        /**
+         * Feature that determines whether values written Strings (from <code>java.lang.String</code>
+         * valued POJO properties) which contains quotes be escaped using the Schema's configured escape character instead of "".
+         *
+         * @since 2.9
+         */
+        ESCAPE_QUOTE_CHAR_WITH_ESCAPE_CHAR(false)
         ;
 
         protected final boolean _defaultState;

csv/src/main/java/com/fasterxml/jackson/dataformat/csv/impl/CsvEncoder.java

@@ -90,7 +90,11 @@ public class CsvEncoder
     protected boolean _cfgAlwaysQuoteStrings;
 
     protected boolean _cfgAlwaysQuoteEmptyStrings;
-    
+
+    protected boolean _cfgEscapeQuoteCharWithEscapeChar;
+
+    protected final char _cfgQuoteCharEscapeChar;
+
     /*
     /**********************************************************
     /* Output state
@@ -169,6 +173,7 @@ public CsvEncoder(IOContext ctxt, int csvFeatures, Writer out, CsvSchema schema)
         _cfgIncludeMissingTail = !CsvGenerator.Feature.OMIT_MISSING_TAIL_COLUMNS.enabledIn(_csvFeatures);
         _cfgAlwaysQuoteStrings = CsvGenerator.Feature.ALWAYS_QUOTE_STRINGS.enabledIn(csvFeatures);
         _cfgAlwaysQuoteEmptyStrings = CsvGenerator.Feature.ALWAYS_QUOTE_EMPTY_STRINGS.enabledIn(csvFeatures);
+        _cfgEscapeQuoteCharWithEscapeChar = CsvGenerator.Feature.ESCAPE_QUOTE_CHAR_WITH_ESCAPE_CHAR.enabledIn(csvFeatures);
 
         _outputBuffer = ctxt.allocConcatBuffer();
         _bufferRecyclable = true;
@@ -187,6 +192,12 @@ public CsvEncoder(IOContext ctxt, int csvFeatures, Writer out, CsvSchema schema)
         _cfgMinSafeChar = _calcSafeChar();
 
         _cfgMaxQuoteCheckChars = MAX_QUOTE_CHECK;
+
+        _cfgQuoteCharEscapeChar = _getQuoteCharEscapeChar(
+          _cfgEscapeQuoteCharWithEscapeChar,
+          _cfgQuoteCharacter,
+          _cfgEscapeCharacter
+        );
     }
 
     public CsvEncoder(CsvEncoder base, CsvSchema newSchema)
@@ -197,6 +208,7 @@ public CsvEncoder(CsvEncoder base, CsvSchema newSchema)
         _cfgIncludeMissingTail = base._cfgIncludeMissingTail;
         _cfgAlwaysQuoteStrings = base._cfgAlwaysQuoteStrings;
         _cfgAlwaysQuoteEmptyStrings = base._cfgAlwaysQuoteEmptyStrings;
+        _cfgEscapeQuoteCharWithEscapeChar = base._cfgEscapeQuoteCharWithEscapeChar;
 
         _outputBuffer = base._outputBuffer;
         _bufferRecyclable = base._bufferRecyclable;
@@ -212,8 +224,33 @@ public CsvEncoder(CsvEncoder base, CsvSchema newSchema)
         _cfgNullValue = newSchema.getNullValueOrEmpty();
         _cfgMinSafeChar = _calcSafeChar();
         _columnCount = newSchema.size();
-    }  
-    
+        _cfgQuoteCharEscapeChar = _getQuoteCharEscapeChar(
+          base._cfgEscapeQuoteCharWithEscapeChar,
+          newSchema.getQuoteChar(),
+          newSchema.getEscapeChar()
+        );
+    }
+
+    private final char _getQuoteCharEscapeChar(
+        final boolean escapeQuoteCharWithEscapeChar,
+        final int quoteCharacter,
+        final int escapeCharacter) {
+
+      final char quoteEscapeChar;
+
+      if (_cfgEscapeQuoteCharWithEscapeChar && _cfgEscapeCharacter > 0) {
+        quoteEscapeChar = (char) _cfgEscapeCharacter;
+      }
+      else if (_cfgQuoteCharacter > 0) {
+        quoteEscapeChar = (char) _cfgQuoteCharacter;
+      }
+      else {
+        quoteEscapeChar = '\\';
+      }
+
+      return quoteEscapeChar;
+    }
+
     private final int _calcSafeChar()
     {
         // note: quote char may be -1 to signify "no quoting":
@@ -237,6 +274,7 @@ public CsvEncoder overrideFormatFeatures(int feat) {
             _cfgIncludeMissingTail = !CsvGenerator.Feature.OMIT_MISSING_TAIL_COLUMNS.enabledIn(feat);
             _cfgAlwaysQuoteStrings = CsvGenerator.Feature.ALWAYS_QUOTE_STRINGS.enabledIn(feat);
             _cfgAlwaysQuoteEmptyStrings = CsvGenerator.Feature.ALWAYS_QUOTE_EMPTY_STRINGS.enabledIn(feat);
+            _cfgEscapeQuoteCharWithEscapeChar = CsvGenerator.Feature.ESCAPE_QUOTE_CHAR_WITH_ESCAPE_CHAR.enabledIn(feat);
         }
         return this;
     }
@@ -702,7 +740,7 @@ protected void _writeQuoted(String text, char q, int i) throws IOException
                 if (_outputTail >= _outputEnd) {
                     _flushBuffer();
                 }
-                buf[_outputTail++] = q;
+                buf[_outputTail++] = _cfgQuoteCharEscapeChar;
             }
             if (_outputTail >= _outputEnd) {
                 _flushBuffer();
@@ -724,7 +762,7 @@ private final void _writeLongQuoted(String text, char q) throws IOException
             }
             char c = text.charAt(i);
             if (c == q) { // double up
-                _outputBuffer[_outputTail++] = q;
+                _outputBuffer[_outputTail++] = _cfgQuoteCharEscapeChar;
                 if (_outputTail >= _outputEnd) {
                     _flushBuffer();
                 }
@@ -782,7 +820,7 @@ protected void _writeQuotedAndEscaped(String text, char q, char esc, int i) thro
                 if (_outputTail >= _outputEnd) {
                     _flushBuffer();
                 }
-                buf[_outputTail++] = c;
+                buf[_outputTail++] = (c == q) ? _cfgQuoteCharEscapeChar : c;
             }
             if (_outputTail >= _outputEnd) {
                 _flushBuffer();
@@ -800,13 +838,14 @@ private final void _writeLongQuotedAndEscaped(String text, char esc) throws IOEx
         final int len = text.length();
         // NOTE: caller should guarantee quote char is valid (not -1) at this point:
         final char q = (char) _cfgQuoteCharacter;
+        final char quoteEscape = _cfgEscapeQuoteCharWithEscapeChar ? esc : q;
         for (int i = 0; i < len; ++i) {
             if (_outputTail >= _outputEnd) {
                 _flushBuffer();
             }
             char c = text.charAt(i);
             if ((c == q) || (c == esc)) { // double up, either way
-                _outputBuffer[_outputTail++] = c;
+                _outputBuffer[_outputTail++] = (c == q) ? quoteEscape : c;
                 if (_outputTail >= _outputEnd) {
                     _flushBuffer();
                 }

csv/src/test/java/com/fasterxml/jackson/dataformat/csv/ser/TestGenerator.java

@@ -204,6 +204,21 @@ public void testForcedQuoting60() throws Exception
         assertEquals("xyz,2.5\n", result);
     }
 
+    public void testForcedQuotingWithQuoteEscapedWithBackslash() throws Exception
+    {
+        CsvMapper mapper = mapperForCsv();
+        CsvSchema schema = CsvSchema.builder()
+                                    .addColumn("id")
+                                    .addColumn("amount")
+                                    .setEscapeChar('\\')
+                                    .build();
+        String result = mapper.writer(schema)
+                .with(CsvGenerator.Feature.ALWAYS_QUOTE_STRINGS)
+                .with(CsvGenerator.Feature.ESCAPE_QUOTE_CHAR_WITH_ESCAPE_CHAR)
+                .writeValueAsString(new Entry("\"abc\"", 1.25));
+        assertEquals("\"\\\"abc\\\"\",1.25\n", result);
+    }
+
     public void testForcedQuotingEmptyStrings() throws Exception
     {
         CsvMapper mapper = mapperForCsv();