quickfix-ffi 0.2.1

/* -*- C++ -*- */

/****************************************************************************
** Copyright (c) 2001-2014
**
** This file is part of the QuickFIX FIX Engine
**
** This file may be distributed under the terms of the quickfixengine.org
** license as defined by quickfixengine.org and appearing in the file
** LICENSE included in the packaging of this file.
**
** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
**
** See http://www.quickfixengine.org/LICENSE for licensing information.
**
** Contact ask@quickfixengine.org if any conditions of this licensing are
** not clear to you.
**
****************************************************************************/

#ifndef FIX_DATADICTIONARY_H
#define FIX_DATADICTIONARY_H

#ifdef _MSC_VER
#pragma warning(disable : 4503 4355 4786 4290)
#endif

#include "DOMDocument.h"
#include "Exceptions.h"
#include "FieldMap.h"
#include "Fields.h"
#include <map>
#include <set>
#include <string.h>

namespace FIX {
class FieldMap;
class Message;

/**
 * Represents a data dictionary for a version of %FIX.
 *
 * Generally loaded from an XML document.  The DataDictionary is also
 * responsible for validation beyond the basic structure of a message.
 */

class DataDictionary {
  typedef std::set<int> MsgFields;
  typedef std::map<std::string, MsgFields> MsgTypeToField;
  typedef std::set<std::string> MsgTypes;
  typedef std::set<int> Fields;
  typedef std::map<int, bool> NonBodyFields;
  typedef std::vector<int> OrderedFields;

  struct MessageFieldsOrderHolder {
    MessageFieldsOrderHolder() {}

    ~MessageFieldsOrderHolder() {}

    void push_back(int field) { m_orderedFlds.push_back(field); }

    const message_order &getMessageOrder() const {
      if (m_msgOrder) {
        return m_msgOrder;
      }

      int *tmp = new int[m_orderedFlds.size() + 1];
      int *i = tmp;

      for (OrderedFields::const_iterator iter = m_orderedFlds.begin(); iter != m_orderedFlds.end();
           *(i++) = *(iter++)) {}
      *i = 0;

      m_msgOrder = message_order(tmp);
      delete[] tmp;

      return m_msgOrder;
    }

  private:
    mutable message_order m_msgOrder;
    OrderedFields m_orderedFlds;
  };

  typedef std::map<std::string, MessageFieldsOrderHolder> MsgTypeToOrderedFields;

  typedef message_order OrderedFieldsArray;
  typedef std::map<int, TYPE::Type> FieldTypes;
  typedef std::set<std::string> Values;
  typedef std::map<int, Values> FieldToValue;
  typedef std::map<int, std::string> FieldToName;
  typedef std::map<std::string, int> NameToField;
  typedef std::map<std::pair<int, std::string>, std::string> ValueToName;
  // while FieldToGroup structure seems to be overcomplicated
  // in reality it yields a lot of performance because:
  // 1) avoids memory copying;
  // 2) first lookup is done by comparing integers and not string objects
  // TODO: use hash_map with good hashing algorithm
  typedef std::map<std::string, std::pair<int, DataDictionary *>> FieldPresenceMap;
  typedef std::map<int, FieldPresenceMap> FieldToGroup;

public:
  DataDictionary();
  DataDictionary(const DataDictionary &copy);
  DataDictionary(std::istream &stream, bool preserveMsgFldsOrder = false) EXCEPT(ConfigError);
  DataDictionary(const std::string &url, bool preserveMsgFldsOrder = false) EXCEPT(ConfigError);
  virtual ~DataDictionary();

  void readFromURL(const std::string &url) EXCEPT(ConfigError);
  void readFromDocument(const DOMDocumentPtr &pDoc) EXCEPT(ConfigError);
  void readFromStream(std::istream &stream) EXCEPT(ConfigError);

  message_order const &getOrderedFields() const;
  message_order const &getHeaderOrderedFields() const EXCEPT(ConfigError);
  message_order const &getTrailerOrderedFields() const EXCEPT(ConfigError);
  message_order const &getMessageOrderedFields(const std::string &msgType) const EXCEPT(ConfigError);

  // storage functions
  void setVersion(const std::string &beginString) {
    m_beginString = beginString;
    m_hasVersion = true;
  }
  std::string getVersion() const { return m_beginString.getString(); }

  void addField(int field) {
    m_fields.insert(field);
    m_orderedFields.push_back(field);
  }

  void addFieldName(int field, const std::string &name) {
    if (m_names.insert(std::make_pair(name, field)).second == false) {
      throw ConfigError("Field named " + name + " defined multiple times");
    }
    m_fieldNames[field] = name;
  }

  bool getFieldName(int field, std::string &name) const {
    FieldToName::const_iterator i = m_fieldNames.find(field);
    if (i == m_fieldNames.end()) {
      return false;
    }
    name = i->second;
    return true;
  }

  bool getFieldTag(const std::string &name, int &field) const {
    NameToField::const_iterator i = m_names.find(name);
    if (i == m_names.end()) {
      return false;
    }
    field = i->second;
    return true;
  }

  void addValueName(int field, const std::string &value, const std::string &name) {
    m_valueNames[std::make_pair(field, value)] = name;
    m_nameValues[std::make_pair(field, name)] = value;
  }

  bool getValueName(int field, const std::string &value, std::string &name) const {
    ValueToName::const_iterator i = m_valueNames.find(std::make_pair(field, value));
    if (i == m_valueNames.end()) {
      return false;
    }
    name = i->second;
    return true;
  }

  bool getNameValue(int field, const std::string &name, std::string &value) const {
    ValueToName::const_iterator i = m_nameValues.find(std::make_pair(field, name));
    if (m_nameValues.end() == i) {
      return false;
    }
    value = i->second;
    return true;
  }

  bool isField(int field) const { return m_fields.find(field) != m_fields.end(); }

  void addMsgType(const std::string &msgType) { m_messages.insert(msgType); }

  bool isMsgType(const std::string &msgType) const { return m_messages.find(msgType) != m_messages.end(); }

  void addMsgField(const std::string &msgType, int field) {
    if (m_storeMsgFieldsOrder) {
      m_messageOrderedFields[msgType].push_back(field);
    }

    m_messageFields[msgType].insert(field);
  }

  bool isMsgField(const std::string &msgType, int field) const {
    MsgTypeToField::const_iterator i = m_messageFields.find(msgType);
    if (i == m_messageFields.end()) {
      return false;
    }
    return i->second.find(field) != i->second.end();
  }

  void addHeaderField(int field, bool required) {
    if (m_storeMsgFieldsOrder) {
      m_headerOrderedFields.push_back(field);
    }

    m_headerFields[field] = required;
  }

  bool isHeaderField(int field) const { return m_headerFields.find(field) != m_headerFields.end(); }

  void addTrailerField(int field, bool required) {
    if (m_storeMsgFieldsOrder) {
      m_trailerOrderedFields.push_back(field);
    }

    m_trailerFields[field] = required;
  }

  bool isTrailerField(int field) const { return m_trailerFields.find(field) != m_trailerFields.end(); }

  void addFieldType(int field, FIX::TYPE::Type type) {
    m_fieldTypes[field] = type;

    if (type == FIX::TYPE::Data) {
      m_dataFields.insert(field);
    }
  }

  bool getFieldType(int field, FIX::TYPE::Type &type) const {
    FieldTypes::const_iterator i = m_fieldTypes.find(field);
    if (i == m_fieldTypes.end()) {
      return false;
    }
    type = i->second;
    return true;
  }

  void addRequiredField(const std::string &msgType, int field) { m_requiredFields[msgType].insert(field); }

  bool isRequiredField(const std::string &msgType, int field) const {
    MsgTypeToField::const_iterator i = m_requiredFields.find(msgType);
    if (i == m_requiredFields.end()) {
      return false;
    }
    return i->second.find(field) != i->second.end();
  }

  void addFieldValue(int field, const std::string &value) { m_fieldValues[field].insert(value); }

  bool hasFieldValue(int field) const {
    FieldToValue::const_iterator i = m_fieldValues.find(field);
    return i != m_fieldValues.end();
  }

  bool isFieldValue(int field, const std::string &value) const {
    FieldToValue::const_iterator i = m_fieldValues.find(field);
    if (i == m_fieldValues.end()) {
      return false;
    }
    if (!isMultipleValueField(field)) {
      return i->second.find(value) != i->second.end();
    }

    // MultipleValue
    std::string::size_type startPos = 0;
    std::string::size_type endPos = 0;
    do {
      endPos = value.find_first_of(' ', startPos);
      std::string singleValue = value.substr(startPos, endPos - startPos);
      if (i->second.find(singleValue) == i->second.end()) {
        return false;
      }
      startPos = endPos + 1;
    } while (endPos != std::string::npos);
    return true;
  }

  void addGroup(const std::string &msg, int field, int delim, const DataDictionary &dataDictionary) {
    DataDictionary *pDD = new DataDictionary(dataDictionary);
    pDD->setVersion(getVersion());

    FieldPresenceMap &presenceMap = m_groups[field];
    presenceMap[msg] = std::make_pair(delim, pDD);
  }

  bool isGroup(const std::string &msg, int field) const {
    FieldToGroup::const_iterator i = m_groups.find(field);
    if (i == m_groups.end()) {
      return false;
    }

    const FieldPresenceMap &presenceMap = i->second;

    FieldPresenceMap::const_iterator iter = presenceMap.find(msg);
    return (iter != presenceMap.end());
  }

  bool getGroup(const std::string &msg, int field, int &delim, const DataDictionary *&pDataDictionary) const {
    FieldToGroup::const_iterator i = m_groups.find(field);
    if (i == m_groups.end()) {
      return false;
    }

    const FieldPresenceMap &presenceMap = i->second;

    FieldPresenceMap::const_iterator iter = presenceMap.find(msg);
    if (iter == presenceMap.end()) {
      return false;
    }

    std::pair<int, DataDictionary *> pair = iter->second;
    delim = pair.first;
    pDataDictionary = pair.second;
    return true;
  }

  bool isDataField(int field) const {
    MsgFields::const_iterator iter = m_dataFields.find(field);
    return iter != m_dataFields.end();
  }

  bool isMultipleValueField(int field) const {
    FieldTypes::const_iterator i = m_fieldTypes.find(field);
    return i != m_fieldTypes.end()
           && (i->second == TYPE::MultipleValueString || i->second == TYPE::MultipleCharValue
               || i->second == TYPE::MultipleStringValue);
  }

  void checkFieldsOutOfOrder(bool value) { m_checkFieldsOutOfOrder = value; }
  void checkFieldsHaveValues(bool value) { m_checkFieldsHaveValues = value; }
  void checkUserDefinedFields(bool value) { m_checkUserDefinedFields = value; }
  void allowUnknownMsgFields(bool value) { m_allowUnknownMessageFields = value; }
  void preserveMessageFieldsOrder(bool value) { m_storeMsgFieldsOrder = value; }
  bool isMessageFieldsOrderPreserved() const { return m_storeMsgFieldsOrder; }

  /// Validate a message.
  static void validate(
      const Message &message,
      const DataDictionary *const pSessionDD,
      const DataDictionary *const pAppID) EXCEPT(FIX::Exception);

  void validate(const Message &message) const EXCEPT(FIX::Exception) { validate(message, false); }
  void validate(const Message &message, bool bodyOnly) const EXCEPT(FIX::Exception) {
    validate(message, bodyOnly ? (DataDictionary *)0 : this, this);
  }

  DataDictionary &operator=(const DataDictionary &rhs);

private:
  /// Iterate through fields while applying checks.
  void iterate(const FieldMap &map, const MsgType &msgType) const;

  /// Check if message type is defined in spec.
  void checkMsgType(const MsgType &msgType) const {
    if (!isMsgType(msgType.getValue())) {
      throw InvalidMessageType();
    }
  }

  /// If we need to check for the tag in the dictionary
  bool shouldCheckTag(const FieldBase &field) const {
    if (m_allowUnknownMessageFields && field.getTag() < FIELD::UserMin) {
      return false;
    } else if (!m_checkUserDefinedFields && field.getTag() >= FIELD::UserMin) {
      return false;
    } else {
      return true;
    }
  }

  /// Check if field tag number is defined in spec.
  void checkValidTagNumber(const FieldBase &field) const EXCEPT(InvalidTagNumber) {
    if (m_fields.find(field.getTag()) == m_fields.end()) {
      throw InvalidTagNumber(field.getTag());
    }
  }

  void checkValidFormat(const FieldBase &field) const EXCEPT(IncorrectDataFormat) {
    try {
      TYPE::Type type = TYPE::Unknown;
      getFieldType(field.getTag(), type);
      switch (type) {
      case TYPE::String:
        STRING_CONVERTOR::convert(field.getString());
        break;
      case TYPE::Char:
        CHAR_CONVERTOR::convert(field.getString());
        break;
      case TYPE::Price:
        PRICE_CONVERTOR::convert(field.getString());
        break;
      case TYPE::Int:
        INT_CONVERTOR::convert(field.getString());
        break;
      case TYPE::Amt:
        AMT_CONVERTOR::convert(field.getString());
        break;
      case TYPE::Qty:
        QTY_CONVERTOR::convert(field.getString());
        break;
      case TYPE::Currency:
        CURRENCY_CONVERTOR::convert(field.getString());
        break;
      case TYPE::MultipleValueString:
        MULTIPLEVALUESTRING_CONVERTOR::convert(field.getString());
        break;
      case TYPE::MultipleStringValue:
        MULTIPLESTRINGVALUE_CONVERTOR::convert(field.getString());
        break;
      case TYPE::MultipleCharValue:
        MULTIPLECHARVALUE_CONVERTOR::convert(field.getString());
        break;
      case TYPE::Exchange:
        EXCHANGE_CONVERTOR::convert(field.getString());
        break;
      case TYPE::UtcTimeStamp:
        UTCTIMESTAMP_CONVERTOR::convert(field.getString());
        break;
      case TYPE::Boolean:
        BOOLEAN_CONVERTOR::convert(field.getString());
        break;
      case TYPE::LocalMktTime:
        LOCALMKTTIME_CONVERTOR::convert(field.getString());
        break;
      case TYPE::LocalMktDate:
        LOCALMKTDATE_CONVERTOR::convert(field.getString());
        break;
      case TYPE::Data:
        DATA_CONVERTOR::convert(field.getString());
        break;
      case TYPE::Float:
        FLOAT_CONVERTOR::convert(field.getString());
        break;
      case TYPE::PriceOffset:
        PRICEOFFSET_CONVERTOR::convert(field.getString());
        break;
      case TYPE::MonthYear:
        MONTHYEAR_CONVERTOR::convert(field.getString());
        break;
      case TYPE::DayOfMonth:
        DAYOFMONTH_CONVERTOR::convert(field.getString());
        break;
      case TYPE::UtcDate:
        UTCDATE_CONVERTOR::convert(field.getString());
        break;
      case TYPE::UtcTimeOnly:
        UTCTIMEONLY_CONVERTOR::convert(field.getString());
        break;
      case TYPE::NumInGroup:
        NUMINGROUP_CONVERTOR::convert(field.getString());
        break;
      case TYPE::Percentage:
        PERCENTAGE_CONVERTOR::convert(field.getString());
        break;
      case TYPE::SeqNum:
        SEQNUM_CONVERTOR::convert(field.getString());
        break;
      case TYPE::TagNum:
        TAGNUM_CONVERTOR::convert(field.getString());
        break;
      case TYPE::Length:
        LENGTH_CONVERTOR::convert(field.getString());
        break;
      case TYPE::Country:
        COUNTRY_CONVERTOR::convert(field.getString());
        break;
      case TYPE::TzTimeOnly:
        TZTIMEONLY_CONVERTOR::convert(field.getString());
        break;
      case TYPE::TzTimeStamp:
        TZTIMESTAMP_CONVERTOR::convert(field.getString());
        break;
      case TYPE::XmlData:
        XMLDATA_CONVERTOR::convert(field.getString());
        break;
      case TYPE::Language:
        LANGUAGE_CONVERTOR::convert(field.getString());
        break;
      case TYPE::Xid:
        XID_CONVERTOR::convert(field.getString());
        break;
      case TYPE::XidRef:
        XIDREF_CONVERTOR::convert(field.getString());
        break;
      case TYPE::Unknown:
        break;
      }
    } catch (FieldConvertError &) {
      throw IncorrectDataFormat(field.getTag(), field.getString());
    }
  }

  void checkValue(const FieldBase &field) const EXCEPT(IncorrectTagValue) {
    if (!hasFieldValue(field.getTag())) {
      return;
    }

    const std::string &value = field.getString();
    if (!isFieldValue(field.getTag(), value)) {
      throw IncorrectTagValue(field.getTag());
    }
  }

  /// Check if a field has a value.
  void checkHasValue(const FieldBase &field) const EXCEPT(NoTagValue) {
    if (m_checkFieldsHaveValues && !field.getString().length()) {
      throw NoTagValue(field.getTag());
    }
  }

  /// Check if a field is in this message type.
  void checkIsInMessage(const FieldBase &field, const MsgType &msgType) const EXCEPT(TagNotDefinedForMessage) {
    if (!isMsgField(msgType, field.getTag())) {
      throw TagNotDefinedForMessage(field.getTag());
    }
  }

  /// Check if group count matches number of groups in
  void checkGroupCount(const FieldBase &field, const FieldMap &fieldMap, const MsgType &msgType) const
      EXCEPT(RepeatingGroupCountMismatch) {
    int fieldNum = field.getTag();
    if (isGroup(msgType, fieldNum)) {
      if ((int)fieldMap.groupCount(fieldNum) != IntConvertor::convert(field.getString())) {
        throw RepeatingGroupCountMismatch(fieldNum);
      }
    }
  }

  /// Check if a message has all required fields.
  void checkHasRequired(const FieldMap &header, const FieldMap &body, const FieldMap &trailer, const MsgType &msgType)
      const EXCEPT(RequiredTagMissing) {
    for (const NonBodyFields::value_type &NBF : m_headerFields) {
      if (NBF.second == true && !header.isSetField(NBF.first)) {
        throw RequiredTagMissing(NBF.first);
      }
    }

    for (const NonBodyFields::value_type &NBF : m_trailerFields) {
      if (NBF.second == true && !trailer.isSetField(NBF.first)) {
        throw RequiredTagMissing(NBF.first);
      }
    }

    MsgTypeToField::const_iterator iM = m_requiredFields.find(msgType.getString());
    if (iM == m_requiredFields.end()) {
      return;
    }

    const MsgFields &fields = iM->second;
    MsgFields::const_iterator iF;
    for (const MsgFields::value_type &F : fields) {
      if (!body.isSetField(F)) {
        throw RequiredTagMissing(F);
      }
    }

    for (FieldMap::g_const_iterator groups = body.g_begin(); groups != body.g_end(); ++groups) {
      int delim;
      const DataDictionary *DD = 0;
      int field = groups->first;
      if (getGroup(msgType.getValue(), field, delim, DD)) {
        for (const FieldMap *group : groups->second) {
          DD->checkHasRequired(*group, *group, *group, msgType);
        }
      }
    }
  }

  int lookupXMLFieldNumber(DOMDocument *, DOMNode *) const;
  int lookupXMLFieldNumber(DOMDocument *, const std::string &name) const;
  int addXMLComponentFields(DOMDocument *, DOMNode *, const std::string &msgtype, DataDictionary &, bool);
  void addXMLGroup(DOMDocument *, DOMNode *, const std::string &msgtype, DataDictionary &, bool);
  TYPE::Type XMLTypeToType(const std::string &xmlType) const;

  bool m_hasVersion;
  bool m_checkFieldsOutOfOrder;
  bool m_checkFieldsHaveValues;
  bool m_checkUserDefinedFields;
  bool m_allowUnknownMessageFields;
  bool m_storeMsgFieldsOrder;

  BeginString m_beginString;
  MsgTypeToField m_messageFields;
  MsgTypeToField m_requiredFields;
  MsgTypes m_messages;
  Fields m_fields;
  OrderedFields m_orderedFields;
  mutable OrderedFieldsArray m_orderedFieldsArray;
  NonBodyFields m_headerFields;
  NonBodyFields m_trailerFields;
  FieldTypes m_fieldTypes;
  FieldToValue m_fieldValues;
  FieldToName m_fieldNames;
  NameToField m_names;
  ValueToName m_valueNames;
  ValueToName m_nameValues;
  FieldToGroup m_groups;
  MsgFields m_dataFields;
  OrderedFields m_headerOrderedFields;
  mutable OrderedFieldsArray m_headerOrder;
  OrderedFields m_trailerOrderedFields;
  mutable OrderedFieldsArray m_trailerOrder;
  MsgTypeToOrderedFields m_messageOrderedFields;
};
} // namespace FIX

#endif // FIX_DATADICTIONARY_H