DocumentHandler.cpp

Go to the documentation of this file.

//==========================================================================
//  AIDA Detector description implementation 
//--------------------------------------------------------------------------
// Copyright (C) Organisation europeenne pour la Recherche nucleaire (CERN)
// All rights reserved.
//
// For the licensing terms see $DD4hepINSTALL/LICENSE.
// For the list of contributors see $DD4hepINSTALL/doc/CREDITS.
//
// Author     : M.Frank
//
//==========================================================================
 
// Framework include files
#include <XML/Printout.h>
#include <XML/UriReader.h>
#include <XML/DocumentHandler.h>
 
// C/C++ include files
#include <memory>
#include <iostream>
#include <sys/types.h>
#include <sys/stat.h>
#ifndef _WIN32
#include <libgen.h>
#endif
#include <TSystem.h>
 
using namespace dd4hep::xml;
 
namespace {
  std::string undressed_file_name(const std::string& fn)   {
    if ( !fn.empty() )   {
      TString tfn(fn);
      gSystem->ExpandPathName(tfn);
      return std::string(tfn.Data());
    }
    return fn;
  }
  int s_minPrintLevel = dd4hep::INFO;
 
  std::string _clean_fname(const std::string& filepath) {
    // This function seems to resolve environment variables inside the filepath string and return resolved string
    std::string const& temp = getEnviron(filepath);
    std::string temp2 = undressed_file_name( temp.empty() ? filepath : temp );
    if ( strncmp(temp2.c_str(),"file:",5)==0 ) return temp2.substr(5);
    return temp2;
  }
 
}
 
#ifndef __TIXML__
#include <xercesc/framework/LocalFileFormatTarget.hpp>
#include <xercesc/framework/StdOutFormatTarget.hpp>
#include <xercesc/framework/MemBufFormatTarget.hpp>
#include <xercesc/framework/MemBufInputSource.hpp>
#include <xercesc/sax/SAXParseException.hpp>
#include <xercesc/sax/EntityResolver.hpp>
#include <xercesc/sax/InputSource.hpp>
#include <xercesc/parsers/XercesDOMParser.hpp>
#include <xercesc/util/XMLEntityResolver.hpp>
#include <xercesc/util/PlatformUtils.hpp>
#include <xercesc/util/XercesDefs.hpp>
#include <xercesc/util/XMLUni.hpp>
#include <xercesc/util/XMLURL.hpp>
#include <xercesc/util/XMLString.hpp>
#include <xercesc/dom/DOM.hpp>
#include <xercesc/sax/ErrorHandler.hpp>
 
using namespace xercesc;
 
namespace dd4hep {
 
  namespace xml {
 
    class DocumentErrorHandler: public ErrorHandler, public DOMErrorHandler {
    public:
      DocumentErrorHandler() {
      }
      virtual ~DocumentErrorHandler()  {
        printout(DEBUG,"DocumentErrorHandler","+++ Destructing the XercesC DOM-XML document error handler....");
      }
      void resetErrors() {
      }
      void warning(const SAXParseException& /* e */) {
      }
      void error(const SAXParseException& e);
      void fatalError(const SAXParseException& e);
      virtual bool handleError(const DOMError& domError);
    };
 
    bool DocumentErrorHandler::handleError(const DOMError& domError) {
      std::string err = "DOM UNKNOWN: ";
      switch (domError.getSeverity()) {
      case DOMError::DOM_SEVERITY_WARNING:
        err = "DOM WARNING: ";
        break;
      case DOMError::DOM_SEVERITY_ERROR:
        err = "DOM ERROR:   ";
        break;
      case DOMError::DOM_SEVERITY_FATAL_ERROR:
        err = "DOM FATAL:   ";
        break;
      default:
        return false;
      }
      printout(FATAL,"DocumentErrorHandler", "+++ %s %s: %s", err.c_str(),
               _toString(domError.getType()).c_str(),_toString(domError.getMessage()).c_str());
      DOMLocator* loc = domError.getLocation();
      if (loc) {
        printout(FATAL,"DocumentErrorHandler","+++ Location: Line:%d Column: %d",
                 int(loc->getLineNumber()),int(loc->getColumnNumber()));
      }
      return false;
    }
    void DocumentErrorHandler::error(const SAXParseException& e) {
      std::string m(_toString(e.getMessage()));
      if (m.find("The values for attribute 'name' must be names or name tokens") != std::string::npos
          || m.find("The values for attribute 'ID' must be names or name tokens") != std::string::npos
          || m.find("for attribute 'name' must be Name or Nmtoken") != std::string::npos
          || m.find("for attribute 'ID' must be Name or Nmtoken") != std::string::npos
          || m.find("for attribute 'name' is invalid Name or NMTOKEN value") != std::string::npos
          || m.find("for attribute 'ID' is invalid Name or NMTOKEN value") != std::string::npos)
        return;
      std::string sys(_toString(e.getSystemId()));
      printout(ERROR,"XercesC","+++ Error at file \"%s\", Line %d Column: %d Message:%s",
               sys.c_str(), int(e.getLineNumber()), int(e.getColumnNumber()), m.c_str());
    }
    void DocumentErrorHandler::fatalError(const SAXParseException& e) {
      std::string m(_toString(e.getMessage()));
      std::string sys(_toString(e.getSystemId()));
      printout(FATAL,"XercesC","+++ FATAL Error at file \"%s\", Line %d Column: %d Message:%s",
               sys.c_str(), int(e.getLineNumber()), int(e.getColumnNumber()), m.c_str());
    }
 
    namespace {
 
      class dd4hepDOMParser : public XercesDOMParser      {
        UriReader*           m_reader;
        DocumentErrorHandler m_errHandle_tr;
        class Resolver : public XMLEntityResolver {
          dd4hepDOMParser* parser;
        public:
          Resolver(dd4hepDOMParser* p) : parser(p) {}
          virtual ~Resolver() {}
          virtual InputSource *resolveEntity(XMLResourceIdentifier *id)
          {   return parser->read_uri(id);                            }
        };
        Resolver m_resolver;
      public:
        dd4hepDOMParser(UriReader* rdr) : XercesDOMParser(), m_reader(rdr), m_resolver(this)  {
          //printout(FATAL,"XercesC","+++ Creating new parser");
          setErrorHandler(&m_errHandle_tr);
          setXMLEntityResolver(&m_resolver);
        }
        virtual ~dd4hepDOMParser() {
          //printout(FATAL,"XercesC","+++ Deleting new parser");
        }
        InputSource *read_uri(XMLResourceIdentifier *id)   {
          if ( m_reader )   {
            std::string buf, systemID(_toString(id->getSystemId()));
            if ( m_reader->load(systemID, buf) )  {
              const XMLByte* input = (const XMLByte*)XMLString::replicate(buf.c_str());
#if 0
              std::string baseURI(_toString(id->getBaseURI()));
              std::string schema(_toString(id->getSchemaLocation()));
              std::string ns(_toString(id->getNameSpace()));
              if ( s_minPrintLevel <= INFO ) {
                printout(INFO,"XercesC","+++ Resolved URI: sysID:%s uri:%s ns:%s schema:%s",
                         systemID.c_str(), baseURI.c_str(), ns.c_str(), schema.c_str());
              }
#endif
              return new MemBufInputSource(input,buf.length(),systemID.c_str(),true);
            }
          }
          return 0;
        }
      };
 
      XercesDOMParser* make_parser(UriReader* reader=0) {
        XercesDOMParser* parser = new dd4hepDOMParser(reader);
        parser->setValidationScheme(XercesDOMParser::Val_Auto);
        parser->setValidationSchemaFullChecking(true);
        parser->setCreateEntityReferenceNodes(false);
        parser->setDoNamespaces(false);
        parser->setDoSchema(true);
 
        //domParser->setDoSchema( true );
        //domParser->setValidationSchemaFullChecking( true );
        return parser;
      }
    }
 
    void dumpTree(DOMNode* doc, std::ostream& os) {
      if ( doc )  {
        DOMImplementation  *imp = DOMImplementationRegistry::getDOMImplementation(Strng_t("LS"));
        MemBufFormatTarget *tar = new MemBufFormatTarget();
        DOMLSOutput        *out = imp->createLSOutput();
        DOMLSSerializer    *wrt = imp->createLSSerializer();
        out->setByteStream(tar);
        wrt->getDomConfig()->setParameter(Strng_t("format-pretty-print"), true);
        wrt->write(doc, out);
        os << tar->getRawBuffer() << std::endl << std::flush;
        out->release();
        wrt->release();
        return;
      }
      printout(ERROR,"dumpTree","+++ Cannot dump invalid document.");
    }
 
    void dump_doc(DOMDocument* doc, std::ostream& os) {
      dumpTree(doc,os);
    }
    void dump_tree(Handle_t elt, std::ostream& os) {
      dumpTree((DOMNode*)elt.ptr(),os);
    }
    void dump_tree(Document doc, std::ostream& os) {
      dump_doc((DOMDocument*)doc.ptr(),os);
    }
  }
}
 
#ifdef DD4HEP_NONE
std::string DocumentHandler::system_path(Handle_t base, const std::string& fn)   {
  std::string path = system_path(base);
  std::string dir  = ::dirname((char*)path.c_str());
  return dir+fn;
}
#else
 
#include <TUri.h>
#include <TUrl.h>
#endif
 
std::string DocumentHandler::system_path(Handle_t base, const std::string& fn)   {
  std::string path, dir = system_path(base);
  TUri uri_base(dir.c_str()), uri_rel(fn.c_str());
  TUrl url_base(dir.c_str());
  path = TUri::MergePaths(uri_rel,uri_base);
  TUri final(path.c_str());
  final.Normalise();
  path = url_base.GetProtocol()+std::string("://")+final.GetUri().Data();
  if ( path[path.length()-1]=='/' ) path = path.substr(0,path.length()-1);
  return path;
}
 
std::string DocumentHandler::system_path(Handle_t base)   {
  DOMElement* elt = (DOMElement*)base.ptr();
  std::string path = _toString(elt->getBaseURI());
  if ( path[0] == '/' )  {
    std::string tmp = "file:"+path;
    return tmp;
  }
  return path;
}
 
Document DocumentHandler::load(Handle_t base, const XMLCh* fname, UriReader* reader) const {
  std::string path;
  DOMElement* elt = (DOMElement*)base.ptr();
  try  {
    Document doc;
    Strng_t p = _toString(fname);    
    path      = _toString(fname);
    try  {
      XMLURL  ref_url(elt->getBaseURI(), p);
      path = _toString(ref_url.getURLText());
    }
    catch(...)   {
    }
    return load(path, reader);
  }
  catch(const std::exception& exc)   {
    std::string b = _toString(elt->getBaseURI());
    std::string e = _toString(fname);
    printout(DEBUG,"DocumentHandler","+++ URI exception: %s -> %s [%s]",b.c_str(),e.c_str(),exc.what());
  }
  catch(...)   {
    std::string b = _toString(elt->getBaseURI());
    std::string e = _toString(fname);
    printout(DEBUG,"DocumentHandler","+++ URI exception: %s -> %s",b.c_str(),e.c_str());
  }
  if ( reader )   {
    std::string buf, sys = system_path(base,fname);
#if 0
    std::string buf, sys, dir = _toString(elt->getBaseURI());
    std::string fn = _toString(fname);
    dir = ::dirname((char*)dir.c_str());
    while( fn.substr(0,3) == "../" )  {
      dir = ::dirname((char*)dir.c_str());
      fn = fn.substr(3);
    }
    sys = dir + "/" + fn;
#endif
    if ( reader->load(sys, buf) )  {
#if 0
      Document doc = parse(buf.c_str(), buf.length(), sys.c_str(), reader);
      dumpTree(doc);
      return doc;
#endif
      return parse(buf.c_str(), buf.length(), sys.c_str(), reader);
    }
  }
  return Document(0);
}
 
Document DocumentHandler::load(const std::string& fname, UriReader* reader) const   {
  auto fname_clean = _clean_fname(fname);
  std::string path;
  printout(DEBUG,"DocumentHandler","+++ Loading document URI: %s",fname_clean.c_str());
  try  {
    size_t idx = fname_clean.find(':');
    size_t idq = fname_clean.find('/');
    if ( idq == std::string::npos ) idq = 0;
    XMLURL xerurl = (const XMLCh*) Strng_t(idx==std::string::npos || idx>idq ? "file:"+fname_clean : fname_clean);
    std::string proto  = _toString(xerurl.getProtocolName());
    path = _toString(xerurl.getPath());
    printout(DEBUG,"DocumentHandler","+++             protocol:%s path:%s",proto.c_str(), path.c_str());
  }
  catch(...)   {
  }
  std::unique_ptr < XercesDOMParser > parser(make_parser(reader));
  try {
    if ( !path.empty() )  {
      parser->parse(path.c_str());
      if ( reader ) reader->parserLoaded(path);
    }
    else   {
      if ( reader && reader->load(fname_clean, path) )  {
        MemBufInputSource src((const XMLByte*)path.c_str(), path.length(), fname.c_str(), false);
        parser->parse(src);
        return (XmlDocument*)parser->adoptDocument();
      }
      return (XmlDocument*)0;
    }
  }
  catch (const std::exception& e) {
    printout(ERROR,"DocumentHandler","+++ Exception(XercesC): parse(path):%s",e.what());
    try {
      parser->parse(fname.c_str());
      if ( reader ) reader->parserLoaded(path);
    }
    catch (const std::exception& ex) {
      printout(FATAL,"DocumentHandler","+++ Exception(XercesC): parse(URI):%s",ex.what());
      throw;
    }
  }
  printout(DEBUG,"DocumentHandler","+++ Document %s succesfully parsed with XercesC .....",path.c_str());
  return (XmlDocument*)parser->adoptDocument();
}
 
Document DocumentHandler::parse(const char* bytes, size_t length, const char* sys_id, UriReader* rdr) const {
  std::unique_ptr < XercesDOMParser > parser(make_parser(rdr));
  MemBufInputSource src((const XMLByte*)bytes, length, sys_id, false);
  parser->parse(src);
  DOMDocument* doc = parser->adoptDocument();
  doc->setXmlStandalone(true);
  doc->setStrictErrorChecking(true);
  return (XmlDocument*) doc;
}
 
int DocumentHandler::output(Document doc, const std::string& fname) const {
  XMLFormatTarget *tar = 0;
  DOMImplementation *imp = DOMImplementationRegistry::getDOMImplementation(Strng_t("LS"));
  DOMLSOutput *out = imp->createLSOutput();
  DOMLSSerializer *wrt = imp->createLSSerializer();
 
  if (fname.empty())
    tar = new StdOutFormatTarget();
  else   {
    std::string fn = undressed_file_name(fname);
    tar = new LocalFileFormatTarget(Strng_t(fn));
  }
  out->setByteStream(tar);
  wrt->getDomConfig()->setParameter(Strng_t("format-pretty-print"), true);
  wrt->write((xercesc::DOMDocument*) doc.ptr(), out);
  out->release();
  wrt->release();
  delete tar;
  return 1;
}
 
#else
 
#include <XML/tinyxml.h>
 
namespace dd4hep {
  namespace xml {
 
    class DocumentErrorHandler {};
 
    union Xml {
      Xml(void* ptr) : p(ptr) {}
      Xml(const void* ptr) : cp(ptr) {}
      void* p;
      const void* cp;
      TiXmlElement* e;
      XmlElement* xe;
      TiXmlAttribute* a;
      Attribute attr;
      TiXmlNode* n;
      TiXmlDocument* d;
      XmlDocument* xd;
    };
  }}
 
std::string DocumentHandler::system_path(Handle_t base, const std::string& fname)   {
  std::string fn, clean = _clean_fname(fname);
  struct stat st;
  Element elt(base);
  // Poor man's URI handling. Xerces is much much better here
  if ( elt ) {
    std::string bn = Xml(elt.document()).d->Value();
#ifdef _WIN32
    char drive[_MAX_DRIVE], dir[_MAX_DIR], file[_MAX_FNAME], ext[_MAX_EXT];
    ::_splitpath(bn.c_str(),drive,dir,file,ext);
    fn = drive;
    fn += ":";
    fn += dir;
    fn += "/";
    fn += clean;
#else
    fn = ::dirname((char*)bn.c_str());
#endif
    fn += "/";
    fn += _clean_fname(fname);
  }
  if ( ::stat(fn.c_str(),&st)==0 )
    return fn;
  else if ( ::stat(clean.c_str(),&st)==0 )
    return clean;
  return fname;
}
 
std::string DocumentHandler::system_path(Handle_t base)   {
  std::string fn;
  Element elt(base);
  // Poor man's URI handling. Xerces is much much better here
  if ( elt ) {
    fn = Xml(elt.document()).d->Value();
  }
  return undressed_file_name(fn);
}
 
Document DocumentHandler::load(const std::string& fname, UriReader* reader) const  {
  std::string clean = _clean_fname(fname);
  if ( reader )   {
    printout(WARNING,"DocumentHandler","+++ Loading document URI: %s %s",
             fname.c_str(),"[URI Resolution is not supported by TiXML]");
  }
  else if ( s_minPrintLevel <= INFO ) {
    printout(INFO,"DocumentHandler","+++ Loading document URI: %s [Resolved:'%s']",
             fname.c_str(),clean.c_str());
  }
  TiXmlDocument* doc = new TiXmlDocument(clean.c_str());
  bool result = false;
  try {
    result = doc->LoadFile();
    if ( !result ) {
      if ( doc->Error() ) {
        printout(FATAL,"DocumentHandler","+++ Error (TinyXML) parsing XML document:%s [%s]",
                 fname.c_str(), clean.c_str());
        printout(FATAL,"DocumentHandler","+++ Error (TinyXML) XML parsing error:%s",
                 doc->ErrorDesc());
        printout(FATAL,"DocumentHandler","+++ Document:%s Location Line:%d Column:%d",
                 doc->Value(), doc->ErrorRow(), doc->ErrorCol());
        except("dd4hep:XML","++ file:%s error:%s",clean.c_str(),doc->ErrorDesc());
      }
      except("dd4hep:XML","++ Unknown error (TinyXML) while parsing:%s",fname.c_str());
    }
  }
  catch(std::exception& e) {
    printout(ERROR,"DocumentHandler","+++ Exception (TinyXML): parse(path):%s",e.what());
  }
  if ( result ) {
    if ( s_minPrintLevel <= INFO ) {
      printout(INFO,"DocumentHandler","+++ Document %s succesfully parsed with TinyXML .....",
               fname.c_str());
    }
    return (XmlDocument*)doc;
  }
  delete doc;
  return 0;
}
 
Document DocumentHandler::load(Handle_t base, const XmlChar* fname, UriReader* reader) const  {
  std::string path = system_path(base, fname);
  return load(path,reader);
}
 
Document DocumentHandler::parse(const char* bytes, size_t length, const char* /* sys_id */, UriReader* reader) const {
  if ( reader )   {
    printout(WARNING,"DocumentHandler","+++ Parsing memory document %s",
             "[URI Resolution is not supported by TiXML]");
  }
  TiXmlDocument* doc = new TiXmlDocument();
  try  {
    if ( bytes )   {
      size_t str_len = ::strlen(bytes);
      size_t len = length;
      // TiXml does not support white spaces at the end. Check and remove.
      if ( str_len+1 != len || bytes[str_len] != 0 || ::isspace(bytes[str_len-1]) )   {
        std::unique_ptr<char[]> data(new char[len+1]);
        char* buff = data.get();
        try  {
          ::memcpy(buff, bytes, len+1);
          buff[len] = 0;
          for(size_t i=len-1; i>0 && (buff[i]==0 || ::isspace(buff[i])); --i)
            buff[i] = 0;
          if ( 0 == doc->Parse(buff) ) {
            return (XmlDocument*)doc;
          }
        }
        catch(...)   {
        }
      }
      if ( 0 == doc->Parse(bytes) ) {
        return (XmlDocument*)doc;
      }
      if ( doc->Error() ) {
        printout(FATAL,"DocumentHandler",
                 "+++ Error (TinyXML) while parsing XML string [%s]",
                 doc->ErrorDesc());
        printout(FATAL,"DocumentHandler",
                 "+++ XML Document error: %s Location Line:%d Column:%d",
                 doc->Value(), doc->ErrorRow(), doc->ErrorCol());
        throw std::runtime_error(std::string("dd4hep: ")+doc->ErrorDesc());
      }
      throw std::runtime_error("dd4hep: Unknown error while parsing XML document string with TiXml.");
    }
    throw std::runtime_error("dd4hep: FAILED to parse invalid document string [NULL] with TiXml.");
  }
  catch(std::exception& e) {
    printout(ERROR,"DocumentHandler","+++ Exception (TinyXML): parse(string):%s",e.what());
  }
  delete doc;
  return 0;
}
 
int DocumentHandler::output(Document doc, const std::string& fname) const {
  std::string fn = undressed_file_name(fname);
  FILE* file = fn.empty() ? stdout : ::fopen(fn.c_str(),"w");
  if ( !file ) {
    printout(ERROR,"DocumentHandler","+++ Failed to open output file: %s",fname.c_str());
    return 0;
  }
  TiXmlDocument* d = (TiXmlDocument*)doc.ptr();
  d->Print(file);
  if ( !fn.empty() ) ::fclose(file);
  return 1;
}
 
void dd4hep::xml::dump_tree(Handle_t elt, std::ostream& os) {
  TiXmlNode* node = (TiXmlNode*)elt.ptr();
  TiXmlPrinter printer;
  printer.SetStreamPrinting();
  node->Accept( &printer );
  os << printer.Str();
}
 
void dd4hep::xml::dump_tree(Document doc, std::ostream& os) {
  TiXmlDocument* node = (TiXmlDocument*)doc.ptr();
  TiXmlPrinter printer;
  printer.SetStreamPrinting();
  node->Accept( &printer );
  os << printer.Str();
}
#endif
 
 
DocumentHandler::DocumentHandler() {}
 
DocumentHandler::~DocumentHandler() {}
 
int DocumentHandler::setMinimumPrintLevel(int level)    {
  int tmp = s_minPrintLevel;
  s_minPrintLevel = level;
  return tmp;
}
 
std::string DocumentHandler::defaultComment()  {
  const char comment[] = "\n"
    "      +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n"
    "      ++++   dd4hep generated alignment file using the         ++++\n"
    "      ++++   dd4hep Detector description XML generator.        ++++\n"
    "      ++++                                                     ++++\n"
    "      ++++   Parser:"
    XML_IMPLEMENTATION_TYPE
    "                ++++\n"
    "      ++++                                                     ++++\n"
    "      ++++                              M.Frank CERN/LHCb      ++++\n"
    "      +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n  ";
  return comment;
}
 
Document DocumentHandler::load(const std::string& fname) const {
  return load(fname, 0);
}
 
Document DocumentHandler::load(Handle_t base, const XmlChar* fname) const {
  return load(base, fname, 0);
}
 
Document DocumentHandler::parse(const char* bytes, size_t length) const {
  return parse(bytes, length, "xml-memory-buffer", 0);
}
 
std::string DocumentHandler::system_path(Handle_t base, const XmlChar* fname)   {
  std::string fn = _toString(fname);
  return system_path(base, fn);
}
 
std::string DocumentHandler::system_directory(Handle_t base, const XmlChar* fname)   {
  std::string path = system_path(base,fname);
  std::string dir = ::dirname((char*)path.c_str());
  return dir;
}
 
std::string DocumentHandler::system_directory(Handle_t base)   {
  std::string path = system_path(base);
  std::string dir = ::dirname((char*)path.c_str());
  return dir;
}
 
Document DocumentHandler::create(const char* tag, const char* comment) const {
  std::string top(tag);
  std::string empty = "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n";
  empty += "<" + top + "/>\0\0";
  Document doc = parse(empty.c_str(), empty.length() + 1);
  if (comment) {
    Element top_elt = doc.root();
    top_elt.addComment(comment);
  }
  return doc;
}
 
// Create new XML document by parsing empty xml buffer
Document DocumentHandler::create(const std::string& tag, const std::string& comment) const   {
  return create(tag.c_str(), comment.c_str());
}
 
void dd4hep::xml::dump_tree(Handle_t elt) {
  dump_tree(elt,std::cout);
}
 
void dd4hep::xml::dump_tree(Document doc) {
  dump_tree(doc,std::cout);
}