mxmlodb.cxx

Go to the documentation of this file.

//
// ALPHA ROOT analyzer
//
// Access to ODB stored in XML odb save file or ODB XML dump in MIDAS data file.
//
// Name: mxmlodb.cxx
// Author: K.Olchanski, 11-July-2006
// Author: K.Olchanski, 16-May-2019
//
 
#undef NDEBUG // midas required assert() to be always enabled
 
#include <stdio.h>
#include <assert.h>
#include <stdlib.h>
#include <string.h> // memset()
 
#include "mvodb.h"
#include "mxml.h"
 
static std::string toString(int i)
{
   char buf[256];
   snprintf(buf, sizeof(buf), "%d", i);
   return buf;
}
 
static PMXML_NODE FindNode(PMXML_NODE dir, const char* name)
{
   for (int i=0; i<dir->n_children; i++) {
      PMXML_NODE node = dir->child + i;
      //printf("node name: \"%s\"\n",node->GetNodeName());
      if (strcmp(node->name, name) == 0)
         return node;
      
      if (node->n_children > 0) {
         PMXML_NODE found = FindNode(node, name);
         if (found)
            return found;
      }
   }
   
   return NULL;
}
 
/// Return the name of the indexed attribute
static const char* GetAttrName(PMXML_NODE node, int i)
{
   assert(i>=0);
   assert(i<node->n_attributes);
   return node->attribute_name + i*MXML_NAME_LENGTH;
}
 
/// Return the value of the indexed attribute
static const char* GetAttrValue(PMXML_NODE node, int i)
{
   assert(i>=0);
   assert(i<node->n_attributes);
   return node->attribute_value[i];
}
 
/// Return the value of the named attribute
static const char* GetAttr(PMXML_NODE node, const char* attrName)
{
   for (int i=0; i<node->n_attributes; i++) {
      //printf("attribute name: \"%s\", value: \"%s\"\n",attr->GetName(),attr->GetValue());
      
      if (strcmp(GetAttrName(node, i), attrName) == 0)
         return GetAttrValue(node, i);
   }
   return NULL;
}
 
#if 0
/// Print out the contents of the ODB tree
static void DumpTree(PMXML_NODE node, int level = 0)
{
   assert(node);
 
   for (int k=0; k<level; k++)
      printf(" ");
   printf("node name: \"%s\"\n", node->name);
   for (int i=0; i<node->n_attributes; i++) {
      for (int k=0; k<level; k++)
         printf(" ");
      printf("attribute name: \"%s\", value: \"%s\"\n", GetAttrName(node, i), GetAttrValue(node, i));
   }
   if (node->value) {
      for (int k=0; k<level; k++)
         printf(" ");
      printf("node text: \"%s\"\n", node->value);
   }
   for (int i=0; i<node->n_children; i++)
      DumpTree(node->child + i, level + 1);
}
 
/// Print out the directory structure of the ODB tree
static void DumpDirTree(PMXML_NODE node, int level = 0)
{
   assert(node);
 
   const char* name = node->name;
   
   if (strcmp(name,"dir") != 0)
      return;
   
   for (int k=0; k<level; k++)
      printf(" ");
   printf("node name: \"%s\"\n", node->name);
   
   for (int i=0; i<node->n_attributes; i++) {
      for (int k=0; k<level; k++)
         printf(" ");
      printf("attribute name: \"%s\", value: \"%s\"\n", GetAttrName(node, i), GetAttrValue(node, i));
   }
   
   for (int i=0; i<node->n_children; i++) {
      DumpDirTree(node->child + i, level + 1);
   }
}
#endif
 
template <typename T>
static T GetXmlValue(const char* text);
 
template<>
int GetXmlValue<int>(const char* text)
{
   return atoi(text);
}
 
template<>
double GetXmlValue<double>(const char* text)
{
   return atof(text);
}
 
template<>
float GetXmlValue<float>(const char* text)
{
   return atof(text);
}
 
template<>
bool GetXmlValue<bool>(const char* text)
{
   if (*text == 'n')
      return false;
   else
      return true;
}
 
template<>
uint16_t GetXmlValue<uint16_t>(const char* text)
{
   return 0xFFFF & strtoul(text, NULL, 0);
}
 
template<>
uint32_t GetXmlValue<uint32_t>(const char* text)
{
   return strtoul(text, NULL, 0);
}
 
template<>
uint64_t GetXmlValue<uint64_t>(const char* text)
{
   if (sizeof(uint64_t) == sizeof(long))
      return strtoul(text, NULL, 0);
   else if (sizeof(uint64_t) == sizeof(long long))
      return strtoull(text, NULL, 0);
   else
      abort();
}
 
template<>
std::string GetXmlValue<std::string>(const char* text)
{
   return text;
}
 
/// Access to ODB saved in XML format inside midas .mid files
 
class XmlOdb : public MVOdb
{
public:
   PMXML_NODE fRoot; // root of XML document
   PMXML_NODE fDir;  // current ODB directory
   std::string fPath; // path to correct ODB directory
   bool fPrintError;
 
public:
   XmlOdb(PMXML_NODE root, PMXML_NODE dir, MVOdbError* error) // ctor
   {
      fPrintError = false;
      fRoot = root;
      fDir  = dir;
      fPath = "";
 
      //DumpTree(fRoot);
      //DumpTree(fDir);
      
      SetOk(error);
   }
 
   ~XmlOdb() // dtor
   {
      if (fRoot) {
         mxml_free_tree(fRoot);
         fRoot = NULL;
      }
      fDir = NULL;
   }
 
public:
   void SetPrintError(bool v)
   {
      fPrintError = true;
   }
 
   bool GetPrintError() const
   {
      return fPrintError;
   }
 
   void SetNotFound(MVOdbError* error, const char* varname)
   {
      std::string path;
      path += fPath;
      path += "/";
      path += varname;
      std::string msg;
      msg += "Cannot find ";
      msg += "\"";
      msg += path;
      msg += "\"";
      SetError(error, fPrintError, path, msg);
   }
 
   void SetNullValue(MVOdbError* error, const char* varname)
   {
      std::string path;
      path += fPath;
      path += "/";
      path += varname;
      std::string msg;
      msg += "XML node for ";
      msg += "\"";
      msg += path;
      msg += "\"";
      msg += " is NULL";
      SetError(error, fPrintError, path, msg);
   }
 
   bool IsReadOnly() const
   {
      return true;
   }
   
   /// Follow the ODB path through the XML DOM tree
   static PMXML_NODE FindPath(PMXML_NODE dir, const char* path)
   {
      assert(dir);
      
      while (1) {
         // skip leading slashes
         while (*path == '/')
            path++;
         
         if (*path == 0)
            return dir;
         
         std::string elem;
         
         // copy the next path element into "elem"-
         // copy "path" until we hit "/" or end of string
         while (1) {
            if (*path==0 || *path=='/')
               break;
            elem += *path++;
         }
      
         //printf("looking for \"%s\" more \"%s\"\n", elem.c_str(), path);
 
         PMXML_NODE found = NULL;
      
         for (int i=0; i<dir->n_children; i++) {
            PMXML_NODE node = dir->child + i;
            
            const char* nodename = node->name;
            const char* namevalue = GetAttr(node, "name");
            
            //printf("node name: \"%s\", \"name\" value: \"%s\"\n", node->name, namevalue);
            
            bool isDir = strcmp(nodename, "dir") == 0;
            bool isKey = strcmp(nodename, "key") == 0;
            bool isKeyArray = strcmp(nodename, "keyarray") == 0;
            
            if (!isKey && !isDir && !isKeyArray)
               continue;
      
            //
            // compare directory names
            //
      
            if (strcasecmp(elem.c_str(), namevalue) == 0) {
               if (isDir) {
                  // found the right subdirectory, descend into it
                  found = node;
                  break;
               } else if (isKey || isKeyArray) {
                  return node;
               }
            }
         }
 
         if (!found)
            return NULL;
         dir = found;
      }
   }
   
   MVOdb* Chdir(const char* subdir, bool create, MVOdbError* error)
   {
      PMXML_NODE node = FindPath(fDir, subdir);
      if (!node) {
         SetNotFound(error, subdir);
         if (create) {
            return MakeNullOdb();
         } else {
            return NULL;
         }
      }
 
      if (strcmp(node->name, "dir") != 0) {
         std::string msg;
         msg += "\"";
         msg += subdir;
         msg += "\"";
         msg += " XML node is ";
         msg += "\"";
         msg += node->name;
         msg += "\"";
         msg += " instead of \"dir\"";
         SetError(error, fPrintError, fPath, msg);
         if (create)
            return MakeNullOdb();
         else
            return NULL;
      }
 
      //printf("Found subdir [%s]\n", subdir);
      //DumpTree(node);
 
      XmlOdb* x = new XmlOdb(NULL, node, error);
      x->fPath = fPath + "/" + subdir;
      
      SetOk(error);
      return x;
   }
 
   void ReadKey(const char* varname, int *tid, int *num_values, int *total_size, int *item_size, MVOdbError* error)
   {
      if (tid) *tid = 0;
      if (num_values) *num_values = 0;
      if (total_size) *total_size = 0;
      if (item_size)  *item_size = 0;
      // FIXME: not implemented
      SetOk(error);
   }
 
   void ReadKeyLastWritten(const char* varname, int *last_written, MVOdbError* error)
   {
      if (last_written) *last_written = 0;
      // FIXME: not implemented
      SetOk(error);
   }
 
   void ReadDir(std::vector<std::string>* varname, std::vector<int> *tid, std::vector<int> *num_values, std::vector<int> *total_size, std::vector<int> *item_size, MVOdbError* error)
   {
      // FIXME: not implemented
      SetOk(error);
   }
 
   void RB(const char* varname, bool   *value, bool create, MVOdbError* error)
   {
      RBAI(varname, 0, value, error);
   };
 
   void RI(const char* varname, int    *value, bool create, MVOdbError* error)
   {
      RIAI(varname, 0, value, error);
   };
 
   void RD(const char* varname, double *value, bool create, MVOdbError* error)
   {
      RDAI(varname, 0, value, error);
   };
      
   void RF(const char* varname, float  *value, bool create, MVOdbError* error)
   {
      RFAI(varname, 0, value, error);
   };
      
   void RS(const char* varname, std::string *value, bool create, int create_string_length, MVOdbError* error)
   {
      RSAI(varname, 0, value, error);
   };
 
   void RU16(const char* varname, uint16_t *value, bool create, MVOdbError* error)
   {
      RU16AI(varname, 0, value, error);
   };
 
   void RU32(const char* varname, uint32_t *value, bool create, MVOdbError* error)
   {
      RU32AI(varname, 0, value, error);
   };
 
   void RU64(const char* varname, uint64_t *value, bool create, MVOdbError* error)
   {
      RU64AI(varname, 0, value, error);
   };
 
   PMXML_NODE FindXmlNode(PMXML_NODE dir, const char* varname, const char* type1, const char* type2, MVOdbError* error)
   {
      PMXML_NODE node = FindPath(dir, varname);
      if (!node) {
         SetNotFound(error, varname);
         return NULL;
      }
 
      const char* attr_type = GetAttr(node, "type");
 
      if (!attr_type) {
         fprintf(stderr, "XmlOdb::FindXmlNode: Error: no type attribute in varname \"%s\"!\n", varname);
         SetNullValue(error, varname);
         return NULL;
      }
      
      if (strcmp(attr_type, type1) != 0) {
         if (strcmp(attr_type, type2) != 0) {
            fprintf(stderr, "XmlOdb::FindXmlNode: Error: type mismatch, wanted \"%s\" or \"%s\", got \"%s\"!\n", type1, type2, attr_type);
            SetNullValue(error, varname);
            return NULL;
         }
      }
 
      return node;
   }
 
   template <typename T>
   void RXA(const char* varname, const char* type1, const char* type2, std::vector<T> *value, MVOdbError* error)
   {
      if (!value) {
         SetOk(error);
         return;
      }
 
      PMXML_NODE node = FindXmlNode(fDir, varname, type1, type2, error);
      if (!node)
         return;
 
      //DumpTree(node);
 
      if (strcmp(node->name, "keyarray") == 0) {
         const char* num_values_text = GetAttr(node, "num_values");
         if (!num_values_text) {
            fprintf(stderr, "no num_values!\n");
            SetNullValue(error, varname);
            return;
         }
         
         int num_values = atoi(num_values_text);
         
         if (num_values != node->n_children) {
            fprintf(stderr, "num_values mismatch %d vs %d children!\n", num_values, node->n_children);
            SetNullValue(error, varname);
            return;
         }
         
         value->clear();
      
         for (int i=0; i<node->n_children; i++) {
            PMXML_NODE elem = node->child+i;
            const char* text = elem->value;
            if (!text) {
               SetNullValue(error, varname);
               return;
            }
            T v = GetXmlValue<T>(text);
            value->push_back(v);
         }
 
         SetOk(error);
         return;
      } else if (strcmp(node->name, "key") == 0) {
         const char* text = node->value;
         if (!text) {
            SetNullValue(error, varname);
            return;
         }
         value->clear();
         T v = GetXmlValue<T>(text);
         value->push_back(v);
         SetOk(error);
         return;
      } else {
         fprintf(stderr, "unexpected node %s\n", node->name);
         SetNullValue(error, varname);
         return;
      }
   };
 
   void RBA(const char* varname, std::vector<bool> *value, bool create, int create_size, MVOdbError* error)
   {
      RXA(varname, "BOOL", "BOOL", value, error);
   }
 
   void RIA(const char* varname, std::vector<int> *value,  bool create, int create_size, MVOdbError* error)
   {
      RXA(varname, "INT", "INT32", value, error);
   }
 
   void RDA(const char* varname, std::vector<double> *value,  bool create, int create_size, MVOdbError* error)
   {
      RXA(varname, "DOUBLE", "DOUBLE", value, error);
   }
   
   void RFA(const char* varname, std::vector<float>  *value,  bool create, int create_size, MVOdbError* error)
   {
      RXA(varname, "FLOAT", "FLOAT", value, error);
   }
   
   void RSA(const char* varname, std::vector<std::string> *value, bool create, int create_size, int create_string_length, MVOdbError* error)
   {
      RXA(varname, "STRING", "STIRNG", value, error);
   }
 
   void RU16A(const char* varname, std::vector<uint16_t> *value,  bool create, int create_size, MVOdbError* error)
   {
      RXA(varname, "WORD", "UINT16", value, error);
   }
 
   void RU32A(const char* varname, std::vector<uint32_t> *value,  bool create, int create_size, MVOdbError* error)
   {
      RXA(varname, "DWORD", "UINT32", value, error);
   }
 
   void RU64A(const char* varname, std::vector<uint64_t> *value,  bool create, int create_size, MVOdbError* error)
   {
      RXA(varname, "QWORD", "UINT64", value, error);
   }
 
   template <typename T>
   void RXAI(const char* varname, int index, const char* type1, const char* type2, T* value, MVOdbError* error)
   {
      if (!value) {
         SetOk(error);
         return;
      }
 
      PMXML_NODE node = FindXmlNode(fDir, varname, type1, type2, error);
      if (!node)
         return;
 
      //DumpTree(node);
 
      if (strcmp(node->name, "keyarray") == 0) {
         const char* num_values_text = GetAttr(node, "num_values");
         if (!num_values_text) {
            fprintf(stderr, "no num_values!\n");
            SetNullValue(error, varname);
            return;
         }
         
         int num_values = atoi(num_values_text);
         
         if (num_values != node->n_children) {
            fprintf(stderr, "num_values mismatch %d vs %d children!\n", num_values, node->n_children);
            SetNullValue(error, varname);
            return;
         }
 
         if (index < 0) {
            fprintf(stderr, "bad index %d, num_values %d!\n", index, num_values);
            SetNullValue(error, varname);
            return;
         }
         
         if (index >= num_values) {
            fprintf(stderr, "bad index %d, num_values %d!\n", index, num_values);
            SetNullValue(error, varname);
            return;
         }
         
         PMXML_NODE elem = node->child+index;
         const char* text = elem->value;
         if (!text) {
            SetNullValue(error, varname);
            return;
         }
 
         *value = GetXmlValue<T>(text);
 
         SetOk(error);
         return;
      } else if (strcmp(node->name, "key") == 0) {
 
         if (index != 0) {
            fprintf(stderr, "non-zero index %d for non-array!\n", index);
            SetNullValue(error, varname);
            return;
         }
 
         const char* text = node->value;
         if (!text) {
            SetNullValue(error, varname);
            return;
         }
 
         *value = GetXmlValue<T>(text);
 
         SetOk(error);
         return;
      } else {
         fprintf(stderr, "unexpected node %s\n", node->name);
         SetNullValue(error, varname);
         return;
      }
   }
 
   void RBAI(const char* varname, int index, bool   *value, MVOdbError* error)
   {
      RXAI(varname, index, "BOOL", "BOOL", value, error);
   }
 
   void RIAI(const char* varname, int index, int    *value, MVOdbError* error)
   {
      RXAI(varname, index, "INT", "INT32", value, error);
   }
   
   void RDAI(const char* varname, int index, double *value, MVOdbError* error)
   {
      RXAI(varname, index, "DOUBLE", "DOUBLE", value, error);
   }
   
   void RFAI(const char* varname, int index, float  *value, MVOdbError* error)
   {
      RXAI(varname, index, "FLOAT", "FLOAT", value, error);
   }
   
   void RSAI(const char* varname, int index, std::string *value, MVOdbError* error)
   {
      RXAI(varname, index, "STRING", "STRING", value, error);
   }
   
   void RU16AI(const char* varname, int index, uint16_t *value, MVOdbError* error)
   {
      RXAI(varname, index, "WORD", "UINT16", value, error);
   }
 
   void RU32AI(const char* varname, int index, uint32_t *value, MVOdbError* error)
   {
      RXAI(varname, index, "DWORD", "UINT32", value, error);
   }
 
   void RU64AI(const char* varname, int index, uint64_t *value, MVOdbError* error)
   {
      RXAI(varname, index, "QWORD", "UINT64", value, error);
   }
 
   // write functions do nothing
 
   void WB(const char* varname, bool v,   MVOdbError* error) { SetOk(error); };
   void WI(const char* varname, int v,    MVOdbError* error)  { SetOk(error); };
   void WD(const char* varname, double v, MVOdbError* error) { SetOk(error); };
   void WF(const char* varname, float  v, MVOdbError* error) { SetOk(error); };
   void WS(const char* varname, const char* v, int string_length, MVOdbError* error) { SetOk(error); };
   void WU16(const char* varname, uint16_t v, MVOdbError* error) { SetOk(error); };
   void WU32(const char* varname, uint32_t v, MVOdbError* error) { SetOk(error); };
   void WU64(const char* varname, uint64_t v, MVOdbError* error) { SetOk(error); };
 
   void WBA(const char* varname, const std::vector<bool>& v, MVOdbError* error) { SetOk(error); };
   void WIA(const char* varname, const std::vector<int>& v, MVOdbError* error) { SetOk(error); };
   void WDA(const char* varname, const std::vector<double>& v, MVOdbError* error) { SetOk(error); };
   void WFA(const char* varname, const std::vector<float>& v, MVOdbError* error) { SetOk(error); };
   void WSA(const char* varname, const std::vector<std::string>& data, int odb_string_length, MVOdbError* error) { SetOk(error); };
   void WU16A(const char* varname, const std::vector<uint16_t>& v, MVOdbError* error) { SetOk(error); };
   void WU32A(const char* varname, const std::vector<uint32_t>& v, MVOdbError* error) { SetOk(error); };
   void WU64A(const char* varname, const std::vector<uint64_t>& v, MVOdbError* error) { SetOk(error); };
 
   void WBAI(const char* varname, int index, bool v,   MVOdbError* error) { SetOk(error); };
   void WIAI(const char* varname, int index, int v,    MVOdbError* error)  { SetOk(error); };
   void WDAI(const char* varname, int index, double v, MVOdbError* error) { SetOk(error); };
   void WFAI(const char* varname, int index, float  v, MVOdbError* error) { SetOk(error); };
   void WSAI(const char* varname, int index, const char* v, MVOdbError* error) { SetOk(error); };
   void WU16AI(const char* varname, int index, uint16_t v, MVOdbError* error) { SetOk(error); };
   void WU32AI(const char* varname, int index, uint32_t v, MVOdbError* error) { SetOk(error); };
   void WU64AI(const char* varname, int index, uint64_t v, MVOdbError* error) { SetOk(error); };
 
   // delete function does nothing
 
   void Delete(const char* odbname, MVOdbError* error) { SetOk(error); };
};
 
#if 0
int XmlOdb::odbReadArraySize(const char*name)
{
  PMXML_NODE node = FindPath(NULL, name);
  if (!node)
    return 0;
  const char* num_values = GetAttr(node, "num_values");
  if (!num_values)
    return 1;
  return atoi(num_values);
}
#endif
 
MVOdb* MakeXmlFileOdb(const char* filename, MVOdbError* error)
{
   char err[256];
   int err_line = 0;
   PMXML_NODE node = mxml_parse_file(filename, err, sizeof(err), &err_line);
   if (!node) {
      std::string msg;
      msg += "mxml_parse_file() error ";
      msg += "\"";
      msg += err;
      msg += "\"";
      msg += " file ";
      msg += filename;
      msg += " line ";
      msg += toString(err_line);
      SetError(error, true, filename, msg);
      return MakeNullOdb();
   }
 
   PMXML_NODE odb_node = FindNode(node, "odb");
 
   if (!odb_node) {
      std::string msg;
      msg += "invalid XML tree: no ODB tag";
      SetError(error, true, filename, msg);
      return MakeNullOdb();
   }
 
   return new XmlOdb(node, odb_node, error);
}
 
MVOdb* MakeXmlBufferOdb(const char* buf, int bufsize, MVOdbError* error)
{
#if 0
   // note: this code was in the old XmlOdb.cxx file
   // probably needed to clean up strange characters
   // that upset the ROOT/libxml XML parser. Stefan's mxml
   // XML parser probably does not need it, but if we see
   // reports of XML parser failure where the old XmlOdb
   // used to work, then we should put this code back. K.O.
   
   char*buf = (char*)malloc(bufLength);
   memcpy(buf, xbuf, bufLength);
   for (int i=0; i<bufLength; i++)
      if (!isascii(buf[i])) {
         buf[i] = 'X';
      } else if (buf[i]=='\n') {
      } else if (buf[i]=='\r') {
      } else if (!isprint(buf[i])) {
         buf[i] = 'X';
      } else if (buf[i] == 0x1D) {
         buf[i] = 'X';
      }
   
   char* xend = strstr(buf,"odb>");
   if (xend)
      xend[4] = 0;
#endif
 
   char err[256];
   int err_line = 0;
   PMXML_NODE node = mxml_parse_buffer(buf, err, sizeof(err), &err_line);
   if (!node) {
      std::string msg;
      msg += "mxml_parse_buffer() error ";
      msg += "\"";
      msg += err;
      msg += "\"";
      msg += " line ";
      msg += toString(err_line);
      SetError(error, true, "buffer", msg);
      return MakeNullOdb();
   }
 
   PMXML_NODE odb_node = FindNode(node, "odb");
 
   if (!odb_node) {
      std::string msg;
      msg += "invalid XML tree: no ODB tag";
      SetError(error, true, "buffer", msg);
      return MakeNullOdb();
   }
 
   return new XmlOdb(node, odb_node, error);
}
 
/* emacs
 * Local Variables:
 * tab-width: 8
 * c-basic-offset: 3
 * indent-tabs-mode: nil
 * End:
 */