OLD | NEW |
---|---|
1 // Copyright (c) 2006-2008 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2006-2008 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #include "base/json/string_escape.h" | 5 #include "base/json/string_escape.h" |
6 | 6 |
7 #include <string> | 7 #include <string> |
8 | 8 |
9 #include "base/strings/string_util.h" | 9 #include "base/strings/string_util.h" |
10 #include "base/strings/stringprintf.h" | 10 #include "base/strings/stringprintf.h" |
11 #include "base/strings/utf_string_conversion_utils.h" | |
12 #include "base/strings/utf_string_conversions.h" | |
13 #include "base/third_party/icu/icu_utf.h" | |
11 | 14 |
12 namespace base { | 15 namespace base { |
13 | 16 |
14 namespace { | 17 namespace { |
15 | 18 |
16 // Try to escape |c| as a "SingleEscapeCharacter" (\n, etc). If successful, | 19 // Format string for printing a \uXXXX escape sequence. |
17 // returns true and appends the escape sequence to |dst|. This isn't required | 20 const char kU16EscapeFormat[] = "\\u%04X"; |
18 // by the spec, but it's more readable by humans than the \uXXXX alternatives. | 21 |
19 template<typename CHAR> | 22 // The code point to output for an invalid input code unit. |
20 static bool JsonSingleEscapeChar(const CHAR c, std::string* dst) { | 23 const uint32 kReplacementCodePoint = 0xFFFD; |
24 | |
25 // Try to escape the |code_point| if it is a known special character. If | |
26 // successful, returns true and appends the escape sequence to |dest|. This | |
27 // isn't required by the spec, but it's more readable by humans. | |
28 bool EscapeSpecialCodePoint(uint32 code_point, std::string* dest) { | |
21 // WARNING: if you add a new case here, you need to update the reader as well. | 29 // WARNING: if you add a new case here, you need to update the reader as well. |
22 // Note: \v is in the reader, but not here since the JSON spec doesn't | 30 // Note: \v is in the reader, but not here since the JSON spec doesn't |
23 // allow it. | 31 // allow it. |
24 switch (c) { | 32 switch (code_point) { |
25 case '\b': | 33 case '\b': |
26 dst->append("\\b"); | 34 dest->append("\\b"); |
27 break; | 35 break; |
28 case '\f': | 36 case '\f': |
29 dst->append("\\f"); | 37 dest->append("\\f"); |
30 break; | 38 break; |
31 case '\n': | 39 case '\n': |
32 dst->append("\\n"); | 40 dest->append("\\n"); |
33 break; | 41 break; |
34 case '\r': | 42 case '\r': |
35 dst->append("\\r"); | 43 dest->append("\\r"); |
36 break; | 44 break; |
37 case '\t': | 45 case '\t': |
38 dst->append("\\t"); | 46 dest->append("\\t"); |
39 break; | 47 break; |
40 case '\\': | 48 case '\\': |
41 dst->append("\\\\"); | 49 dest->append("\\\\"); |
42 break; | 50 break; |
43 case '"': | 51 case '"': |
44 dst->append("\\\""); | 52 dest->append("\\\""); |
53 break; | |
54 // Escape < to prevent script execution. | |
55 case '<': | |
56 dest->append("\\u003C"); | |
Mark Mentovai
2013/12/09 20:21:59
0x3c is magic, so COMPILE_ASSERT that '<' == 0x3c.
Robert Sesek
2013/12/09 21:14:38
Done.
| |
45 break; | 57 break; |
46 default: | 58 default: |
47 return false; | 59 return false; |
48 } | 60 } |
49 return true; | 61 return true; |
50 } | 62 } |
51 | 63 |
52 template <class STR> | 64 template <typename S> |
53 void JsonDoubleQuoteT(const STR& str, | 65 bool EscapeJSONStringImpl(const S& str, bool put_in_quotes, std::string* dest) { |
54 bool put_in_quotes, | 66 bool did_replacement = false; |
55 std::string* dst) { | 67 |
56 if (put_in_quotes) | 68 if (put_in_quotes) |
57 dst->push_back('"'); | 69 dest->push_back('"'); |
58 | 70 |
59 for (typename STR::const_iterator it = str.begin(); it != str.end(); ++it) { | 71 // Casting is necessary because ICU uses int32. Try and do so safely. |
60 typename ToUnsigned<typename STR::value_type>::Unsigned c = *it; | 72 CHECK_LE(str.length(), static_cast<size_t>(kint32max)); |
61 if (!JsonSingleEscapeChar(c, dst)) { | 73 const int32 length = static_cast<int32>(str.length()); |
62 if (c < 32 || c > 126 || c == '<' || c == '>') { | 74 |
63 // 1. Escaping <, > to prevent script execution. | 75 for (int32 i = 0; i < length; ++i) { |
64 // 2. Technically, we could also pass through c > 126 as UTF8, but this | 76 uint32 code_point; |
65 // is also optional. It would also be a pain to implement here. | 77 if (!ReadUnicodeCharacter(str.data(), length, &i, &code_point)) { |
66 unsigned int as_uint = static_cast<unsigned int>(c); | 78 code_point = kReplacementCodePoint; |
67 base::StringAppendF(dst, "\\u%04X", as_uint); | 79 did_replacement = true; |
68 } else { | |
69 unsigned char ascii = static_cast<unsigned char>(*it); | |
70 dst->push_back(ascii); | |
71 } | |
72 } | 80 } |
81 | |
82 if (EscapeSpecialCodePoint(code_point, dest)) | |
83 continue; | |
84 | |
85 // Escape non-printing characters. | |
86 if (code_point < 32) | |
87 base::StringAppendF(dest, kU16EscapeFormat, code_point); | |
88 else | |
89 WriteUnicodeCharacter(code_point, dest); | |
73 } | 90 } |
74 | 91 |
75 if (put_in_quotes) | 92 if (put_in_quotes) |
76 dst->push_back('"'); | 93 dest->push_back('"'); |
94 | |
95 return !did_replacement; | |
77 } | 96 } |
78 | 97 |
79 } // namespace | 98 } // namespace |
80 | 99 |
81 void JsonDoubleQuote(const StringPiece& str, | 100 bool EscapeJSONString(const StringPiece& str, |
82 bool put_in_quotes, | 101 bool put_in_quotes, |
83 std::string* dst) { | 102 std::string* dest) { |
84 JsonDoubleQuoteT(str, put_in_quotes, dst); | 103 return EscapeJSONStringImpl(str, put_in_quotes, dest); |
85 } | 104 } |
86 | 105 |
87 std::string GetDoubleQuotedJson(const StringPiece& str) { | 106 bool EscapeJSONString(const StringPiece16& str, |
88 std::string dst; | 107 bool put_in_quotes, |
89 JsonDoubleQuote(str, true, &dst); | 108 std::string* dest) { |
90 return dst; | 109 return EscapeJSONStringImpl(str, put_in_quotes, dest); |
91 } | 110 } |
92 | 111 |
93 void JsonDoubleQuote(const StringPiece16& str, | 112 std::string GetQuotedJSONString(const StringPiece& str) { |
94 bool put_in_quotes, | 113 std::string dest; |
95 std::string* dst) { | 114 bool ok = EscapeJSONStringImpl(str, true, &dest); |
96 JsonDoubleQuoteT(str, put_in_quotes, dst); | 115 DCHECK(ok); |
116 return dest; | |
97 } | 117 } |
98 | 118 |
99 std::string GetDoubleQuotedJson(const StringPiece16& str) { | 119 std::string GetQuotedJSONString(const StringPiece16& str) { |
100 std::string dst; | 120 std::string dest; |
101 JsonDoubleQuote(str, true, &dst); | 121 bool ok = EscapeJSONStringImpl(str, true, &dest); |
102 return dst; | 122 DCHECK(ok); |
123 return dest; | |
124 } | |
125 | |
126 std::string EscapeBytesAsInvalidJSONString(const StringPiece& str, | |
127 bool put_in_quotes) { | |
128 std::string dest; | |
129 | |
130 if (put_in_quotes) | |
131 dest.push_back('"'); | |
132 | |
133 for (StringPiece::const_iterator it = str.begin(); it != str.end(); ++it) { | |
134 ToUnsigned<StringPiece::value_type>::Unsigned c = *it; | |
135 if (EscapeSpecialCodePoint(c, &dest)) | |
136 continue; | |
137 | |
138 if (c < 32 || c > 126) | |
139 base::StringAppendF(&dest, kU16EscapeFormat, c); | |
140 else | |
141 dest.push_back(*it); | |
142 } | |
143 | |
144 if (put_in_quotes) | |
145 dest.push_back('"'); | |
146 | |
147 return dest; | |
103 } | 148 } |
104 | 149 |
105 } // namespace base | 150 } // namespace base |
OLD | NEW |