folly/json.cpp

   1 /*
   2  * Copyright 2013 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include "folly/json.h"
  18 #include <cassert>
  19 #include <boost/next_prior.hpp>
  20 #include <boost/algorithm/string.hpp>
  21
  22 #include "folly/Range.h"
  23 #include "folly/Unicode.h"
  24 #include "folly/Conv.h"
  25
  26 namespace folly {
  27
  28 //////////////////////////////////////////////////////////////////////
  29
  30 namespace json {
  31 namespace {
  32
  33 char32_t decodeUtf8(const unsigned char*& p, const unsigned char* const e) {
  34   /* The following encodings are valid, except for the 5 and 6 byte
  35    * combinations:
  36    * 0xxxxxxx
  37    * 110xxxxx 10xxxxxx
  38    * 1110xxxx 10xxxxxx 10xxxxxx
  39    * 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
  40    * 111110xx 10xxxxxx 10xxxxxx 10xxxxxx 10xxxxxx
  41    * 1111110x 10xxxxxx 10xxxxxx 10xxxxxx 10xxxxxx 10xxxxxx
  42    */
  43
  44   if (p >= e) {
  45     throw std::runtime_error("folly::decodeUtf8 empty/invalid string");
  46   }
  47
  48   unsigned char fst = *p;
  49   if (!(fst & 0x80)) {
  50     // trivial case
  51     return *p++;
  52   }
  53
  54   static const uint32_t bitMask[] = {
  55     (1 << 7) - 1,
  56     (1 << 11) - 1,
  57     (1 << 16) - 1,
  58     (1 << 21) - 1
  59   };
  60
  61   // upper control bits are masked out later
  62   uint32_t d = fst;
  63
  64   if ((fst & 0xC0) != 0xC0) {
  65     throw std::runtime_error(
  66       to<std::string>("folly::decodeUtf8 i=0 d=", d));
  67   }
  68
  69   fst <<= 1;
  70
  71   for (unsigned int i = 1; i != 3 && p + i < e; ++i) {
  72     unsigned char tmp = p[i];
  73
  74     if ((tmp & 0xC0) != 0x80) {
  75       throw std::runtime_error(
  76         to<std::string>("folly::decodeUtf8 i=", i, " tmp=", (uint32_t)tmp));
  77     }
  78
  79     d = (d << 6) | (tmp & 0x3F);
  80     fst <<= 1;
  81
  82     if (!(fst & 0x80)) {
  83       d &= bitMask[i];
  84
  85       // overlong, could have been encoded with i bytes
  86       if ((d & ~bitMask[i - 1]) == 0) {
  87         throw std::runtime_error(
  88           to<std::string>("folly::decodeUtf8 i=", i, " d=", d));
  89       }
  90
  91       // check for surrogates only needed for 3 bytes
  92       if (i == 2) {
  93         if ((d >= 0xD800 && d <= 0xDFFF) || d > 0x10FFFF) {
  94           throw std::runtime_error(
  95             to<std::string>("folly::decodeUtf8 i=", i, " d=", d));
  96         }
  97       }
  98
  99       p += i + 1;
 100       return d;
 101     }
 102   }
 103
 104   throw std::runtime_error("folly::decodeUtf8 encoding length maxed out");
 105 }
 106
 107 struct Printer {
 108   explicit Printer(fbstring& out,
 109                    unsigned* indentLevel,
 110                    serialization_opts const* opts)
 111     : out_(out)
 112     , indentLevel_(indentLevel)
 113     , opts_(*opts)
 114   {}
 115
 116   void operator()(dynamic const& v) const {
 117     switch (v.type()) {
 118     case dynamic::DOUBLE:
 119       toAppend(v.asDouble(), &out_);
 120       break;
 121     case dynamic::INT64: {
 122       auto intval = v.asInt();
 123       if (opts_.javascript_safe) {
 124         // Use folly::to to check that this integer can be represented
 125         // as a double without loss of precision.
 126         intval = int64_t(to<double>(intval));
 127       }
 128       toAppend(intval, &out_);
 129       break;
 130     }
 131     case dynamic::BOOL:
 132       out_ += v.asBool() ? "true" : "false";
 133       break;
 134     case dynamic::NULLT:
 135       out_ += "null";
 136       break;
 137     case dynamic::STRING:
 138       escapeString(v.asString(), out_, opts_);
 139       break;
 140     case dynamic::OBJECT:
 141       printObject(v);
 142       break;
 143     case dynamic::ARRAY:
 144       printArray(v);
 145       break;
 146     default:
 147       CHECK(0) << "Bad type " << v.type();
 148     }
 149   }
 150
 151 private:
 152   void printKV(const std::pair<dynamic, dynamic>& p) const {
 153     if (!opts_.allow_non_string_keys && !p.first.isString()) {
 154       throw std::runtime_error("folly::toJson: JSON object key was not a "
 155         "string");
 156     }
 157     (*this)(p.first);
 158     mapColon();
 159     (*this)(p.second);
 160   }
 161
 162   void printObject(dynamic const& o) const {
 163     if (o.empty()) {
 164       out_ += "{}";
 165       return;
 166     }
 167
 168     out_ += '{';
 169     indent();
 170     newline();
 171     auto it = o.items().begin();
 172     printKV(*it);
 173     for (++it; it != o.items().end(); ++it) {
 174       out_ += ',';
 175       newline();
 176       printKV(*it);
 177     }
 178     outdent();
 179     newline();
 180     out_ += '}';
 181   }
 182
 183   void printArray(dynamic const& a) const {
 184     if (a.empty()) {
 185       out_ += "[]";
 186       return;
 187     }
 188
 189     out_ += '[';
 190     indent();
 191     newline();
 192     (*this)(a[0]);
 193     for (auto& val : makeRange(boost::next(a.begin()), a.end())) {
 194       out_ += ',';
 195       newline();
 196       (*this)(val);
 197     }
 198     outdent();
 199     newline();
 200     out_ += ']';
 201   }
 202
 203 private:
 204   void outdent() const {
 205     if (indentLevel_) {
 206       --*indentLevel_;
 207     }
 208   }
 209
 210   void indent() const {
 211     if (indentLevel_) {
 212       ++*indentLevel_;
 213     }
 214   }
 215
 216   void newline() const {
 217     if (indentLevel_) {
 218       out_ += to<fbstring>('\n', fbstring(*indentLevel_ * 2, ' '));
 219     }
 220   }
 221
 222   void mapColon() const {
 223     out_ += indentLevel_ ? " : " : ":";
 224   }
 225
 226 private:
 227   fbstring& out_;
 228   unsigned* const indentLevel_;
 229   serialization_opts const& opts_;
 230 };
 231
 232 //////////////////////////////////////////////////////////////////////
 233
 234 struct ParseError : std::runtime_error {
 235   explicit ParseError(int line)
 236     : std::runtime_error(to<std::string>("json parse error on line ", line))
 237   {}
 238
 239   explicit ParseError(int line, std::string const& context,
 240       std::string const& expected)
 241     : std::runtime_error(to<std::string>("json parse error on line ", line,
 242         !context.empty() ? to<std::string>(" near `", context, '\'')
 243                         : "",
 244         ": ", expected))
 245   {}
 246
 247   explicit ParseError(std::string const& what)
 248     : std::runtime_error("json parse error: " + what)
 249   {}
 250 };
 251
 252 // Wraps our input buffer with some helper functions.
 253 struct Input {
 254   explicit Input(StringPiece range, json::serialization_opts const* opts)
 255       : range_(range)
 256       , opts_(*opts)
 257       , lineNum_(0)
 258   {
 259     storeCurrent();
 260   }
 261
 262   Input(Input const&) = delete;
 263   Input& operator=(Input const&) = delete;
 264
 265   char const* begin() const { return range_.begin(); }
 266
 267   // Parse ahead for as long as the supplied predicate is satisfied,
 268   // returning a range of what was skipped.
 269   template<class Predicate>
 270   StringPiece skipWhile(const Predicate& p) {
 271     std::size_t skipped = 0;
 272     for (; skipped < range_.size(); ++skipped) {
 273       if (!p(range_[skipped])) {
 274         break;
 275       }
 276       if (range_[skipped] == '\n') {
 277         ++lineNum_;
 278       }
 279     }
 280     auto ret = range_.subpiece(0, skipped);
 281     range_.advance(skipped);
 282     storeCurrent();
 283     return ret;
 284   }
 285
 286   StringPiece skipDigits() {
 287     return skipWhile([] (char c) { return c >= '0' && c <= '9'; });
 288   }
 289
 290   void skipWhitespace() {
 291     // Spaces other than ' ' characters are less common but should be
 292     // checked.  This configuration where we loop on the ' '
 293     // separately from oddspaces was empirically fastest.
 294     auto oddspace = [] (char c) {
 295       return c == '\n' || c == '\t' || c == '\r';
 296     };
 297
 298   loop:
 299     for (; !range_.empty() && range_.front() == ' '; range_.pop_front()) {
 300     }
 301     if (!range_.empty() && oddspace(range_.front())) {
 302       range_.pop_front();
 303       goto loop;
 304     }
 305     storeCurrent();
 306   }
 307
 308   void expect(char c) {
 309     if (**this != c) {
 310       throw ParseError(lineNum_, context(),
 311         to<std::string>("expected '", c, '\''));
 312     }
 313     ++*this;
 314   }
 315
 316   std::size_t size() const {
 317     return range_.size();
 318   }
 319
 320   int operator*() const {
 321     return current_;
 322   }
 323
 324   void operator++() {
 325     range_.pop_front();
 326     storeCurrent();
 327   }
 328
 329   template<class T>
 330   T extract() {
 331     try {
 332       return to<T>(&range_);
 333     } catch (std::exception const& e) {
 334       error(e.what());
 335     }
 336   }
 337
 338   bool consume(StringPiece str) {
 339     if (boost::starts_with(range_, str)) {
 340       range_.advance(str.size());
 341       storeCurrent();
 342       return true;
 343     }
 344     return false;
 345   }
 346
 347   std::string context() const {
 348     return range_.subpiece(0, 16 /* arbitrary */).toString();
 349   }
 350
 351   dynamic error(char const* what) const {
 352     throw ParseError(lineNum_, context(), what);
 353   }
 354
 355   json::serialization_opts const& getOpts() {
 356     return opts_;
 357   }
 358
 359 private:
 360   void storeCurrent() {
 361     current_ = range_.empty() ? EOF : range_.front();
 362   }
 363
 364 private:
 365   StringPiece range_;
 366   json::serialization_opts const& opts_;
 367   unsigned lineNum_;
 368   int current_;
 369 };
 370
 371 dynamic parseValue(Input& in);
 372 fbstring parseString(Input& in);
 373 dynamic parseNumber(Input& in);
 374
 375 dynamic parseObject(Input& in) {
 376   assert(*in == '{');
 377   ++in;
 378
 379   dynamic ret = dynamic::object;
 380
 381   in.skipWhitespace();
 382   if (*in == '}') {
 383     ++in;
 384     return ret;
 385   }
 386
 387   for (;;) {
 388     if (in.getOpts().allow_trailing_comma && *in == '}') {
 389       break;
 390     }
 391     if (*in == '\"') { // string
 392       auto key = parseString(in);
 393       in.skipWhitespace();
 394       in.expect(':');
 395       in.skipWhitespace();
 396       ret.insert(std::move(key), parseValue(in));
 397     } else if (!in.getOpts().allow_non_string_keys) {
 398       in.error("expected string for object key name");
 399     } else {
 400       auto key = parseValue(in);
 401       in.skipWhitespace();
 402       in.expect(':');
 403       in.skipWhitespace();
 404       ret.insert(std::move(key), parseValue(in));
 405     }
 406
 407     in.skipWhitespace();
 408     if (*in != ',') {
 409       break;
 410     }
 411     ++in;
 412     in.skipWhitespace();
 413   }
 414   in.expect('}');
 415
 416   return ret;
 417 }
 418
 419 dynamic parseArray(Input& in) {
 420   assert(*in == '[');
 421   ++in;
 422
 423   dynamic ret = {};
 424
 425   in.skipWhitespace();
 426   if (*in == ']') {
 427     ++in;
 428     return ret;
 429   }
 430
 431   for (;;) {
 432     if (in.getOpts().allow_trailing_comma && *in == ']') {
 433       break;
 434     }
 435     ret.push_back(parseValue(in));
 436     in.skipWhitespace();
 437     if (*in != ',') {
 438       break;
 439     }
 440     ++in;
 441     in.skipWhitespace();
 442   }
 443   in.expect(']');
 444
 445   return ret;
 446 }
 447
 448 dynamic parseNumber(Input& in) {
 449   bool const negative = (*in == '-');
 450   if (negative) {
 451     ++in;
 452     if (in.consume("Infinity")) {
 453       return -std::numeric_limits<double>::infinity();
 454     }
 455   }
 456
 457   auto integral = in.skipDigits();
 458   if (integral.empty()) {
 459     in.error("expected digits after `-'");
 460   }
 461   auto const wasE = *in == 'e' || *in == 'E';
 462   if (*in != '.' && !wasE) {
 463     auto val = to<int64_t>(integral);
 464     if (negative) {
 465       val = -val;
 466     }
 467     in.skipWhitespace();
 468     return val;
 469   }
 470
 471   auto end = !wasE ? (++in, in.skipDigits().end()) : in.begin();
 472   if (*in == 'e' || *in == 'E') {
 473     ++in;
 474     if (*in == '+' || *in == '-') {
 475       ++in;
 476     }
 477     auto expPart = in.skipDigits();
 478     end = expPart.end();
 479   }
 480   auto fullNum = makeRange(integral.begin(), end);
 481
 482   auto val = to<double>(fullNum);
 483   if (negative) {
 484     val *= -1;
 485   }
 486   return val;
 487 }
 488
 489 fbstring decodeUnicodeEscape(Input& in) {
 490   auto hexVal = [&] (char c) -> unsigned {
 491     return c >= '0' && c <= '9' ? c - '0' :
 492            c >= 'a' && c <= 'f' ? c - 'a' + 10 :
 493            c >= 'A' && c <= 'F' ? c - 'A' + 10 :
 494            (in.error("invalid hex digit"), 0);
 495   };
 496
 497   auto readHex = [&]() -> uint16_t {
 498     if (in.size() < 4) {
 499       in.error("expected 4 hex digits");
 500     }
 501
 502     uint16_t ret = hexVal(*in) * 4096;
 503     ++in;
 504     ret += hexVal(*in) * 256;
 505     ++in;
 506     ret += hexVal(*in) * 16;
 507     ++in;
 508     ret += hexVal(*in);
 509     ++in;
 510     return ret;
 511   };
 512
 513   /*
 514    * If the value encoded is in the surrogate pair range, we need to
 515    * make sure there is another escape that we can use also.
 516    */
 517   uint32_t codePoint = readHex();
 518   if (codePoint >= 0xd800 && codePoint <= 0xdbff) {
 519     if (!in.consume("\\u")) {
 520       in.error("expected another unicode escape for second half of "
 521         "surrogate pair");
 522     }
 523     uint16_t second = readHex();
 524     if (second >= 0xdc00 && second <= 0xdfff) {
 525       codePoint = 0x10000 + ((codePoint & 0x3ff) << 10) +
 526                   (second & 0x3ff);
 527     } else {
 528       in.error("second character in surrogate pair is invalid");
 529     }
 530   } else if (codePoint >= 0xdc00 && codePoint <= 0xdfff) {
 531     in.error("invalid unicode code point (in range [0xdc00,0xdfff])");
 532   }
 533
 534   return codePointToUtf8(codePoint);
 535 }
 536
 537 fbstring parseString(Input& in) {
 538   assert(*in == '\"');
 539   ++in;
 540
 541   fbstring ret;
 542   for (;;) {
 543     auto range = in.skipWhile(
 544       [] (char c) { return c != '\"' && c != '\\'; }
 545     );
 546     ret.append(range.begin(), range.end());
 547
 548     if (*in == '\"') {
 549       ++in;
 550       break;
 551     }
 552     if (*in == '\\') {
 553       ++in;
 554       switch (*in) {
 555       case '\"':    ret.push_back('\"'); ++in; break;
 556       case '\\':    ret.push_back('\\'); ++in; break;
 557       case '/':     ret.push_back('/');  ++in; break;
 558       case 'b':     ret.push_back('\b'); ++in; break;
 559       case 'f':     ret.push_back('\f'); ++in; break;
 560       case 'n':     ret.push_back('\n'); ++in; break;
 561       case 'r':     ret.push_back('\r'); ++in; break;
 562       case 't':     ret.push_back('\t'); ++in; break;
 563       case 'u':     ++in; ret += decodeUnicodeEscape(in); break;
 564       default:      in.error(to<fbstring>("unknown escape ", *in,
 565                                           " in string").c_str());
 566       }
 567       continue;
 568     }
 569     if (*in == EOF) {
 570       in.error("unterminated string");
 571     }
 572     if (!*in) {
 573       /*
 574        * Apparently we're actually supposed to ban all control
 575        * characters from strings.  This seems unnecessarily
 576        * restrictive, so we're only banning zero bytes.  (Since the
 577        * string is presumed to be UTF-8 encoded it's fine to just
 578        * check this way.)
 579        */
 580       in.error("null byte in string");
 581     }
 582
 583     ret.push_back(*in);
 584     ++in;
 585   }
 586
 587   return ret;
 588 }
 589
 590 dynamic parseValue(Input& in) {
 591   in.skipWhitespace();
 592   return *in == '[' ? parseArray(in) :
 593          *in == '{' ? parseObject(in) :
 594          *in == '\"' ? parseString(in) :
 595          (*in == '-' || (*in >= '0' && *in <= '9')) ? parseNumber(in) :
 596          in.consume("true") ? true :
 597          in.consume("false") ? false :
 598          in.consume("null") ? nullptr :
 599          in.consume("Infinity") ? std::numeric_limits<double>::infinity() :
 600          in.consume("NaN") ? std::numeric_limits<double>::quiet_NaN() :
 601          in.error("expected json value");
 602 }
 603
 604 }
 605
 606 //////////////////////////////////////////////////////////////////////
 607
 608 fbstring serialize(dynamic const& dyn, serialization_opts const& opts) {
 609   fbstring ret;
 610   unsigned indentLevel = 0;
 611   Printer p(ret, opts.pretty_formatting ? &indentLevel : nullptr, &opts);
 612   p(dyn);
 613   return ret;
 614 }
 615
 616 // Escape a string so that it is legal to print it in JSON text.
 617 void escapeString(StringPiece input,
 618                   fbstring& out,
 619                   const serialization_opts& opts) {
 620   auto hexDigit = [] (int c) -> char {
 621     return c < 10 ? c + '0' : c - 10 + 'a';
 622   };
 623
 624   out.reserve(out.size() + input.size() + 2);
 625   out.push_back('\"');
 626
 627   auto* p = reinterpret_cast<const unsigned char*>(input.begin());
 628   auto* q = reinterpret_cast<const unsigned char*>(input.begin());
 629   auto* e = reinterpret_cast<const unsigned char*>(input.end());
 630
 631   while (p < e) {
 632     // Since non-ascii encoding inherently does utf8 validation
 633     // we explicitly validate utf8 only if non-ascii encoding is disabled.
 634     if (opts.validate_utf8 && !opts.encode_non_ascii) {
 635       // to achieve better spatial and temporal coherence
 636       // we do utf8 validation progressively along with the
 637       // string-escaping instead of two separate passes
 638
 639       // as the encoding progresses, q will stay at or ahead of p
 640       CHECK(q >= p);
 641
 642       // as p catches up with q, move q forward
 643       if (q == p) {
 644         // calling utf8_decode has the side effect of
 645         // checking that utf8 encodings are valid
 646         decodeUtf8(q, e);
 647       }
 648     }
 649     if (opts.encode_non_ascii && (*p & 0x80)) {
 650       // note that this if condition captures utf8 chars
 651       // with value > 127, so size > 1 byte
 652       char32_t v = decodeUtf8(p, e);
 653       out.append("\\u");
 654       out.push_back(hexDigit(v >> 12));
 655       out.push_back(hexDigit((v >> 8) & 0x0f));
 656       out.push_back(hexDigit((v >> 4) & 0x0f));
 657       out.push_back(hexDigit(v & 0x0f));
 658     } else if (*p == '\\' || *p == '\"') {
 659       out.push_back('\\');
 660       out.push_back(*p++);
 661     } else if (*p <= 0x1f) {
 662       switch (*p) {
 663         case '\b': out.append("\\b"); p++; break;
 664         case '\f': out.append("\\f"); p++; break;
 665         case '\n': out.append("\\n"); p++; break;
 666         case '\r': out.append("\\r"); p++; break;
 667         case '\t': out.append("\\t"); p++; break;
 668         default:
 669           // note that this if condition captures non readable chars
 670           // with value < 32, so size = 1 byte (e.g control chars).
 671           out.append("\\u00");
 672           out.push_back(hexDigit((*p & 0xf0) >> 4));
 673           out.push_back(hexDigit(*p & 0xf));
 674           p++;
 675       }
 676     } else {
 677       out.push_back(*p++);
 678     }
 679   }
 680
 681   out.push_back('\"');
 682 }
 683
 684 }
 685
 686 //////////////////////////////////////////////////////////////////////
 687
 688 dynamic parseJson(StringPiece range) {
 689   return parseJson(range, json::serialization_opts());
 690 }
 691
 692 dynamic parseJson(
 693     StringPiece range,
 694     json::serialization_opts const& opts) {
 695
 696   json::Input in(range, &opts);
 697
 698   auto ret = parseValue(in);
 699   in.skipWhitespace();
 700   if (in.size() && *in != '\0') {
 701     in.error("parsing didn't consume all input");
 702   }
 703   return ret;
 704 }
 705
 706 fbstring toJson(dynamic const& dyn) {
 707   return json::serialize(dyn, json::serialization_opts());
 708 }
 709
 710 fbstring toPrettyJson(dynamic const& dyn) {
 711   json::serialization_opts opts;
 712   opts.pretty_formatting = true;
 713   return json::serialize(dyn, opts);
 714 }
 715
 716 //////////////////////////////////////////////////////////////////////
 717 // dynamic::print_as_pseudo_json() is implemented here for header
 718 // ordering reasons (most of the dynamic implementation is in
 719 // dynamic-inl.h, which we don't want to include json.h).
 720
 721 void dynamic::print_as_pseudo_json(std::ostream& out) const {
 722   json::serialization_opts opts;
 723   opts.allow_non_string_keys = true;
 724   out << json::serialize(*this, opts);
 725 }
 726
 727 //////////////////////////////////////////////////////////////////////
 728
 729 }