d2/parser_context.cc

Go to the documentation of this file.

// Copyright (C) 2017-2026 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
#include <config.h>
 
#include <d2/d2_parser.h>
#include <d2/parser_context.h>
#include <d2srv/d2_log.h>
#include <exceptions/exceptions.h>
#include <cc/data.h>
#include <util/str.h>
#include <boost/lexical_cast.hpp>
#include <fstream>
#include <sstream>
#include <limits>
 
namespace isc {
namespace d2 {
 
D2ParserContext::D2ParserContext()
  : sfile_(0), ctx_(NO_KEYWORD), trace_scanning_(false), trace_parsing_(false) {
}
 
D2ParserContext::~D2ParserContext() {
}
 
isc::data::ElementPtr
D2ParserContext::parseString(const std::string& str, ParserType parser_type) {
    scanStringBegin(str, parser_type);
    return (parseCommon());
}
 
isc::data::ElementPtr
D2ParserContext::parseFile(const std::string& filename, ParserType parser_type) {
    FILE* f = fopen(filename.c_str(), "r");
    if (!f) {
        isc_throw(D2ParseError, "Unable to open file " << filename);
    }
    scanFileBegin(f, filename, parser_type);
    return (parseCommon());
}
 
isc::data::ElementPtr
D2ParserContext::parseCommon() {
    isc::d2::D2Parser parser(*this);
    // Uncomment this to get detailed parser logs.
    // trace_parsing_ = true;
    parser.set_debug_level(trace_parsing_);
    try {
        int res = parser.parse();
        if (res != 0) {
            isc_throw(D2ParseError, "Parser abort");
        }
        scanEnd();
    } catch (...) {
        scanEnd();
        throw;
    }
    if (stack_.size() == 1) {
        return (stack_[0]);
    } else {
        isc_throw(D2ParseError, "Expected exactly one terminal Element, found "
                  << stack_.size());
    }
}
 
void
D2ParserContext::error(const isc::d2::location& loc,
                       const std::string& what,
                       size_t pos) {
    std::string escaped = util::str::escapeNulls(what);
    if (pos == 0) {
        isc_throw(D2ParseError, loc << ": " << escaped);
    } else {
        isc_throw(D2ParseError, loc << " (near " << pos << "): " << escaped);
    }
}
 
void
D2ParserContext::error(const std::string& what) {
    isc_throw(D2ParseError, util::str::escapeNulls(what));
}
 
void
D2ParserContext::fatal(const std::string& what) {
    isc_throw(D2ParseError, util::str::escapeNulls(what));
}
 
isc::data::Element::Position
D2ParserContext::loc2pos(isc::d2::location& loc) {
    const std::string& file = *loc.begin.filename;
    const uint32_t line = loc.begin.line;
    const uint32_t pos = loc.begin.column;
    return (isc::data::Element::Position(file, line, pos));
}
 
void
D2ParserContext::require(const std::string& name,
                         isc::data::Element::Position open_loc,
                         isc::data::Element::Position close_loc) {
    ConstElementPtr value = stack_.back()->get(name);
    if (!value) {
        isc_throw(D2ParseError,
                  "missing parameter '" << name << "' ("
                  << stack_.back()->getPosition() << ") ["
                  << contextName() << " map between "
                  << open_loc << " and " << close_loc << "]");
    }
}
 
void
D2ParserContext::unique(const std::string& name,
                        isc::data::Element::Position loc) {
    ConstElementPtr value = stack_.back()->get(name);
    if (value) {
        if (ctx_ != NO_KEYWORD) {
            isc_throw(D2ParseError, loc << ": duplicate " << name
                      << " entries in " << contextName()
                      << " map (previous at " << value->getPosition() << ")");
        } else {
            isc_throw(D2ParseError, loc << ": duplicate " << name
                      << " entries in JSON"
                  << " map (previous at " << value->getPosition() << ")");
        }
    }
}
 
void
D2ParserContext::enter(const ParserContext& ctx) {
    cstack_.push_back(ctx_);
    ctx_ = ctx;
}
 
void
D2ParserContext::leave() {
    if (cstack_.empty()) {
        fatal("unbalanced syntactic context");
    }
 
    ctx_ = cstack_.back();
    cstack_.pop_back();
}
 
const std::string
D2ParserContext::contextName() {
    switch (ctx_) {
    case NO_KEYWORD:
        return ("__no keyword__");
    case CONFIG:
        return ("toplevel");
    case DHCPDDNS:
        return ("DhcpDdns");
    case TSIG_KEY:
        return ("tsig-key");
    case TSIG_KEYS:
        return ("tsig-keys");
    case ALGORITHM:
        return ("algorithm");
    case DIGEST_BITS:
        return ("digest-bits");
    case SECRET:
        return ("secret");
    case FORWARD_DDNS:
        return ("forward-ddns");
    case REVERSE_DDNS:
        return ("reverse-ddns");
    case DDNS_DOMAIN:
        return ("ddns-domain");
    case DDNS_DOMAINS:
        return ("ddns-domains");
    case DNS_SERVER:
        return ("dns-server");
    case DNS_SERVERS:
        return ("dns-servers");
    case CONTROL_SOCKETS:
        return ("control-sockets");
    case CONTROL_SOCKET_TYPE:
        return ("control-socket-type");
    case AUTHENTICATION:
        return ("authentication");
    case AUTH_TYPE:
        return ("auth-type");
    case CLIENTS:
        return ("clients");
    case LOGGERS:
        return ("loggers");
    case OUTPUT_OPTIONS:
        return ("output-options");
    case NCR_PROTOCOL:
        return ("ncr-protocol");
    case NCR_FORMAT:
        return ("ncr-format");
    case HOOKS_LIBRARIES:
        return ("hooks-libraries");
    default:
        return ("__unknown__");
    }
}
 
void
D2ParserContext::warning(const isc::d2::location& loc,
                         const std::string& what) {
    std::ostringstream msg;
    msg << loc << ": " << what;
    LOG_WARN(d2_to_dns_logger, DHCP_DDNS_CONFIG_SYNTAX_WARNING)
        .arg(msg.str());
}
 
void
D2ParserContext::warnAboutExtraCommas(const isc::d2::location& loc) {
    warning(loc, "Extraneous comma. A piece of configuration may have been omitted.");
}
 
}  // namespace d2
}  // namespace isc