ExpatCoreParser.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#include "XMLCoreParser/XMLCoreParser.h" 
 
#include "ExpatCoreParser.h"
 
#include <cstdio>
#include <cstdlib>
#include <cstring>
#include <expat.h>
 
#include <string>
#include <vector>
#include <iostream> 
#include <map> 
 
 
 
std::mutex ExpatCoreParser::s_mutex;
ExpatCoreParser::ExternalEntityMap ExpatCoreParser::s_entities;
ExpatCoreParser::ExternalEntityMap ExpatCoreParser::s_text_entities;
 
class ExpatCoreParserDebugger{ 
public: 
  static bool get_debug_state() {
    return ::getenv ("XMLDEBUG") != 0;
  }
  static bool debug () {
    static const bool debug_state = get_debug_state();
    return debug_state;
  }
}; 
 
 
 
#define BUFFSIZE 1000
 
void 
ExpatCoreParser::start (void* user_data, const char* el, const char** attr){
  ExpatCoreParser& me = *reinterpret_cast<ExpatCoreParser*> (user_data);
  me.do_start (el, attr);
}
 
void 
ExpatCoreParser::end (void* user_data, const char* el){
  ExpatCoreParser& me = *reinterpret_cast<ExpatCoreParser*> (user_data);
  me.do_end (el);
}
 
void 
ExpatCoreParser::char_data (void* user_data, const XML_Char* s, int len){
  ExpatCoreParser& me = *reinterpret_cast<ExpatCoreParser*> (user_data);
  me.do_char_data (s, len);
}
 
void 
ExpatCoreParser::default_handler (void* user_data, const XML_Char* s, int len){
  ExpatCoreParser& me = *reinterpret_cast<ExpatCoreParser*> (user_data);
  me.do_default_handler (s, len);
}
 
void 
ExpatCoreParser::comment (void* user_data, const XML_Char* s){
  ExpatCoreParser& me = *reinterpret_cast<ExpatCoreParser*> (user_data);
  me.do_comment (s);
}
 
int 
ExpatCoreParser::external_entity (XML_Parser parser,
                      const XML_Char* context,
                      const XML_Char* /*base*/,
                      const XML_Char* systemId,
                      const XML_Char* /*publicId*/){
  void* user_data = XML_GetUserData (parser);
  ExpatCoreParser& me = *reinterpret_cast<ExpatCoreParser*> (user_data);
  return (me.do_external_entity (parser, context, systemId));
}
  
void 
ExpatCoreParser::register_external_entity (const std::string& name, const std::string& file_name) {
  if (ExpatCoreParserDebugger::debug ()){
    std::cout << "ExpatCoreParser::register_external_entity> name=" << name
          << " file_name=" << file_name << std::endl; 
  }
  lock_t lock (s_mutex);
  s_entities[name] = file_name; 
} 
  
void 
ExpatCoreParser::register_text_entity (const std::string& name, const std::string& text) {
  if (ExpatCoreParserDebugger::debug ()) {
    std::cout << "ExpatCoreParser::register_text_entity> name=" << name
          << std::endl; 
  }
  lock_t lock (s_mutex);
  s_text_entities[name] = text; 
} 
 
void 
ExpatCoreParser::entity (void* /*userData*/,
                  const XML_Char* entityName,
                  int is_parameter_entity,
                  const XML_Char* value,
                  int value_length,
                  const XML_Char* base,
                  const XML_Char* systemId,
                  const XML_Char* publicId,
                  const XML_Char* /*notationName*/){
  if (!base) base = "none";
  if (!systemId) systemId = "none";
  if (!publicId) publicId = "none";
  std::string temp = "none";
  if (value) {
      temp.assign (value, strnlen(value, value_length));
  }
  
  if (ExpatCoreParserDebugger::debug ()){
    std::cout << "ExpatCoreParser::entity[" << 0 << "]> " << entityName;
    std::cout << " is_parameter=" << is_parameter_entity;
    std::cout << " value=[" << temp << "]";
    std::cout << " base=[" << base << "]";
    std::cout << " systemId=[" << systemId << "]";
    std::cout << " publicId=[" << publicId << "]";
    std::cout << std::endl;
  }
}
 
std::unique_ptr<CoreParser::DOMNode> 
ExpatCoreParser::get_document (){
  return std::move(m_top);
}
 
ExpatCoreParser::ExpatCoreParser (const std::string& prefix)
  : m_top (nullptr),
    m_last (nullptr),
    m_prefix (prefix){
}
 
void 
ExpatCoreParser::do_start (const char* el, const char** attr){
  int i;
  std::map <std::string, std::string> a;
  if (!m_top){
    m_top = std::make_unique<CoreParser::DOMNode> ();
    m_last = m_top.get();
  }
  CoreParser::DOMNode* node = new CoreParser::DOMNode (CoreParser::DOMNode::ELEMENT_NODE, el, m_last);
  if (ExpatCoreParserDebugger::debug ()) {
    std::cout << "ExpatCoreParser::do_start> el=" << el << " top=" << m_top.get() << " last=" << m_last << " node=" << node << std::endl; 
  }
  m_last = node;
  for (i = 0; attr[i]; i += 2) {
    const char* name = attr[i];
    const char* value = attr[i+1];
    node->m_attributes[name] = value;
  }
}
 
void 
ExpatCoreParser::do_end (const char* el){
  if (ExpatCoreParserDebugger::debug ()){
    std::cout << "ExpatCoreParser::do_end> el=" << el << std::endl; 
  }
  m_last = m_last->m_parent;
}
 
void 
ExpatCoreParser::do_char_data (const XML_Char* s, int len){
  if (len == 0) return;
  while ((len > 0) && (s[len-1] == '\n')) len--;
  if (len == 0) return;
  std::string temp (s, len);
  if (ExpatCoreParserDebugger::debug ()) {
    std::cout << "ExpatCoreParser::do_char_data> [" << temp << "]" << std::endl;
  }
}
 
void 
ExpatCoreParser::do_default_handler (const XML_Char* s, int len){
  if (len == 0) return;
  while ((len > 0) && (s[len-1] == '\n')) len--;
  if (len == 0) return;
  std::string temp (s, len);
  if (ExpatCoreParserDebugger::debug ()) {
      std::cout << "ExpatCoreParser::do_default_handler> [" << temp << "]" << std::endl;
  }
}
  
void 
ExpatCoreParser::do_comment (const XML_Char* s){
  if (!m_top)  {
    m_top = std::make_unique<CoreParser::DOMNode> ();
    m_last = m_top.get();
  }
  CoreParser::DOMNode* node = new CoreParser::DOMNode (CoreParser::DOMNode::COMMENT_NODE, s, m_last);
  if (ExpatCoreParserDebugger::debug ()) {
    std::cout << "ExpatCoreParser::do_comment> s=" << s << " top=" << m_top.get() << " last=" << m_last << " node=" << node << std::endl; 
  }
  // Node is owned by m_last.
  // cppcheck-suppress memleak
  node = nullptr;
}
 
int 
ExpatCoreParser::generic_parse (XML_Parser p, const std::string& file_name){
  FILE* docfd;
  if (ExpatCoreParserDebugger::debug ()){
    std::cout << "ExpatCoreParser::generic_parse> file_name=" << file_name << " prefix=" << m_prefix << std::endl; 
  }
  
  std::string temp_name = file_name;
  docfd = fopen (temp_name.c_str (), "r");
  if (!docfd){
    temp_name = m_prefix + "/" + file_name;
    docfd = fopen (temp_name.c_str (), "r");
  }
  
  if (docfd == 0){
    const char* xmlpathenv = ::getenv ("XMLPATH");
    if (xmlpathenv == 0) return (0);
    std::string xmlpath = xmlpathenv;
    std::string::size_type pos = 0;
    while (pos != std::string::npos){
      std::string::size_type sep = xmlpath.find (":", pos);
      if (sep == std::string::npos){
        temp_name = xmlpath.substr (pos);
        pos = std::string::npos;
      } else {
        temp_name = xmlpath.substr (pos, sep - pos);
        pos = sep + 1;
      }
      if (temp_name.empty()) continue;
      std::string last_temp_name = temp_name;
      temp_name += "/";
      temp_name += file_name;
      if (ExpatCoreParserDebugger::debug ()) {
          std::cout << "ExpatCoreParser::generic_parse> file_name=" << file_name
            << " xmlpath=" << xmlpath
            << " temp_name=" << temp_name
            << std::endl; 
        }
  
      docfd = fopen (temp_name.c_str (), "r");
      if (docfd != 0) break;
      // Test whether prefix is a relative path and if so use it
      if (m_prefix != "" && '/' != m_prefix[0]) {
        temp_name =  std::move(last_temp_name);
        temp_name += "/";
        temp_name += m_prefix;
        temp_name += "/";
        temp_name += file_name;
        if (ExpatCoreParserDebugger::debug ()){
          std::cout << "ExpatCoreParser::generic_parse> file_name=" << file_name
              << " xmlpath=" << xmlpath
              << " temp_name=" << temp_name
              << std::endl; 
        }
        docfd = fopen (temp_name.c_str (), "r");
        if (docfd != 0) break;
      }
    }
  }
 
  if (docfd == 0){
    return (0);
  }
  int result = 1;
  XML_SetParamEntityParsing (p, XML_PARAM_ENTITY_PARSING_ALWAYS);
  XML_SetElementHandler (p, start, end);
  XML_SetCharacterDataHandler (p, char_data);
  XML_SetExternalEntityRefHandler (p, external_entity);
  XML_SetCommentHandler (p, comment);
  XML_SetUserData (p, this);
  if (ExpatCoreParserDebugger::debug ()) {
    std::cout << "ExpatCoreParser::generic_parse> starting" << std::endl;
  }
  for (;;) {
    int items;
    char* buff = (char*) XML_GetBuffer (p, BUFFSIZE + 1);
    items = fread (buff, 1, BUFFSIZE, docfd);
    if (ferror (docfd)){
      std::cout << "Read error" << std::endl;
      result = 0;
      break;
    }
    int done = feof (docfd);
    buff[items] = 0;
    if (XML_ParseBuffer (p, BUFFSIZE, done) == XML_STATUS_ERROR) {
      if (!done) {
        std::cout << "ExpatCoreParser::Parse error at line " << XML_GetCurrentLineNumber(p)
          << " of file " << file_name
          << ":" << std::endl
          << XML_ErrorString (XML_GetErrorCode(p)) << std::endl;
        result = 0;
        }
      /* handle parse error */
    }
    if (done) break;
  }  
  fclose (docfd);
  return (result);
}
 
int 
ExpatCoreParser::generic_text_parse (XML_Parser p, const std::string& text){
  if (ExpatCoreParserDebugger::debug ()){
      std::cout << "ExpatCoreParser::generic_text_parse> " << std::endl; 
  }
  int result = 1;
  XML_SetParamEntityParsing (p, XML_PARAM_ENTITY_PARSING_ALWAYS);
  XML_SetElementHandler (p, start, end);
  XML_SetCharacterDataHandler (p, char_data);
  XML_SetExternalEntityRefHandler (p, external_entity);
  XML_SetCommentHandler (p, comment);
  XML_SetUserData (p, this);
  if (ExpatCoreParserDebugger::debug ()) {
    std::cout << "ExpatCoreParser::generic_text_parse> starting" << std::endl;
  }
  {
    char* buff = (char*) XML_GetBuffer (p, text.size() + 1);
    strcpy (buff, text.c_str ());
    int done = 1;
    if (XML_ParseBuffer (p, text.size(), done) == XML_STATUS_ERROR) {
      std::cout << "ExpatCoreParser::Parse error at line " << XML_GetCurrentLineNumber(p)
        << ":" << std::endl
        << XML_ErrorString (XML_GetErrorCode(p)) << std::endl;
      result = 0;
        /* handle parse error */
      }
  }  
  return (result);
}
 
int 
ExpatCoreParser::do_external_entity (XML_Parser parser,
                     const XML_Char* context, const XML_Char* systemId){
  std::string context_str;
  if (context == 0) context_str = "none";
  else context_str = context;
  bool done = false;
  int status = 0;
  if (context != 0) {
    std::string replacement = find_text_entity (context_str);
    if (replacement != "") {
      if (ExpatCoreParserDebugger::debug ()) {
        std::cout << "ExpatCoreParser::do_external_entity> "
          << " context=[" << context_str << "]"
          << " replacement=[" << replacement << "]"
          << std::endl;
      }
      XML_Parser p = XML_ExternalEntityParserCreate (parser, context, NULL);
      status = generic_text_parse (p, replacement);
      XML_ParserFree (p);
      done = true;
    }
  }
  if (!done) {
    std::string replacement = find_external_entity (context_str);
    if (replacement == "NULL") {
        return (1);
      }
    if (replacement != "") {
        systemId = replacement.c_str ();
      }
 
    if (ExpatCoreParserDebugger::debug ()){
      std::cout << "ExpatCoreParser::do_external_entity> "
        << " context=[" << context_str << "]"
        << " systemId=[" << systemId << "]"
        << " replacement=[" << replacement << "]"
        << std::endl;
    }
    XML_Parser p = XML_ExternalEntityParserCreate (parser, context, NULL);
    status = generic_parse (p, systemId);
    XML_ParserFree (p);
  }
  return (status);
}
 
const std::string& 
ExpatCoreParser::find_external_entity (const std::string& name){ 
  lock_t lock (s_mutex);
  ExternalEntityMap::const_iterator it = s_entities.find (name); 
  if (it == s_entities.end ())  {
    static const std::string empty;
    return (empty); 
  } else { 
    return ((*it).second); 
  } 
} 
 
const std::string& 
ExpatCoreParser::find_text_entity (const std::string& name){ 
  lock_t lock (s_mutex);
  ExternalEntityMap::const_iterator it = s_text_entities.find (name); 
  if (it == s_text_entities.end ()) {
    static const std::string empty;
    return (empty); 
  } else { 
    return ((*it).second); 
  } 
} 
 
std::unique_ptr<CoreParser::DOMNode>
ExpatCoreParser::parse (const std::string& file_name){
  std::string name = file_name;
  std::string::size_type pos = file_name.rfind ('/');
  std::string prefix;
  if (pos != std::string::npos){
    prefix = file_name.substr (0, pos);
    name = file_name.substr (pos + 1);
  }
  ExpatCoreParser me (prefix);
  XML_Parser p = XML_ParserCreate (NULL);
  if (!p)  {
    std::cout << "ExpatCoreParser::Couldn't allocate memory for parser" << std::endl;
    std::abort();
  }
  int result = me.generic_parse (p, name);
  XML_ParserFree (p);
  if (result == 0) return nullptr;
  return me.get_document ();
}