configuration.hpp

Go to the documentation of this file.

//-------------------------------------------------------------------------------------------------
/*

Fix8 is released under the GNU LESSER GENERAL PUBLIC LICENSE Version 3.

Fix8 Open Source FIX Engine.
Copyright (C) 2010-16 David L. Dight <fix@fix8.org>

Fix8 is free software: you can  redistribute it and / or modify  it under the  terms of the
GNU Lesser General  Public License as  published  by the Free  Software Foundation,  either
version 3 of the License, or (at your option) any later version.

Fix8 is distributed in the hope  that it will be useful, but WITHOUT ANY WARRANTY;  without
even the  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

You should  have received a copy of the GNU Lesser General Public  License along with Fix8.
If not, see <http://www.gnu.org/licenses/>.

BECAUSE THE PROGRAM IS  LICENSED FREE OF  CHARGE, THERE IS NO  WARRANTY FOR THE PROGRAM, TO
THE EXTENT  PERMITTED  BY  APPLICABLE  LAW.  EXCEPT WHEN  OTHERWISE  STATED IN  WRITING THE
COPYRIGHT HOLDERS AND/OR OTHER PARTIES  PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY
KIND,  EITHER EXPRESSED   OR   IMPLIED,  INCLUDING,  BUT   NOT  LIMITED   TO,  THE  IMPLIED
WARRANTIES  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS TO
THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE,
YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

IN NO EVENT UNLESS REQUIRED  BY APPLICABLE LAW  OR AGREED TO IN  WRITING WILL ANY COPYRIGHT
HOLDER, OR  ANY OTHER PARTY  WHO MAY MODIFY  AND/OR REDISTRIBUTE  THE PROGRAM AS  PERMITTED
ABOVE,  BE  LIABLE  TO  YOU  FOR  DAMAGES,  INCLUDING  ANY  GENERAL, SPECIAL, INCIDENTAL OR
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR
THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH
HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

*/
//-------------------------------------------------------------------------------------------------
#ifndef FIX8_CONFIGURATION_HPP_
#define FIX8_CONFIGURATION_HPP_

#ifdef FIX8_HAVE_OPENSSL
#include <openssl/ssl.h>
#else
#define SSL_VERIFY_PEER 0
#endif

//-------------------------------------------------------------------------------------------------
namespace FIX8 {

//-------------------------------------------------------------------------------------------------
struct Server
{
   std::string _hostname;
   unsigned _max_retries, _retries;
   Poco::Net::SocketAddress _addr;
   bool _reset_sequence_numbers;

   Server(const std::string& hostname, unsigned max_retries, const Poco::Net::SocketAddress& addr, bool reset_sequence_numbers)
      : _hostname(hostname), _max_retries(max_retries), _retries(), _addr(addr), _reset_sequence_numbers(reset_sequence_numbers) {}
};

//-------------------------------------------------------------------------------------------------
struct SslContext
{
   std::string _private_key_file; 
   std::string _certificate_file; 
   std::string _ca_location;      
   int _verification_mode;        
   int _verification_depth;       
   bool _load_default_cas;        
   std::string _cipher_list;      
   bool _valid;

   SslContext(const std::string& private_key_file="", const std::string& certificate_file="", const std::string& ca_location="",
              int verification_mode=SSL_VERIFY_PEER, int verification_depth=9, bool load_default_cas=false,
              const std::string& cipher_list="ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH")
      : _private_key_file(private_key_file), _certificate_file(certificate_file), _ca_location(ca_location),
        _verification_mode(verification_mode), _verification_depth(verification_depth), _load_default_cas(load_default_cas),
        _cipher_list(cipher_list), _valid()
   {
   }
};

//-------------------------------------------------------------------------------------------------
class Configuration
{
   static RegExp _ipexp;

   const XmlElement *_root, *_default;
   using ConfigMap = std::map<const std::string, const XmlElement *>;
   std::vector<ConfigMap> _groups;
   std::vector<const XmlElement *> _allsessions;

   const XmlElement *find_element(const std::string& tag, const ConfigMap& from) const
      { ConfigMap::const_iterator itr(from.find(tag)); return itr != from.end() ? itr->second : nullptr; }

public:
   enum group_types
   {
      g_sessions, g_persisters, g_loggers, g_server_group,
      g_ssl_context, g_schedules, g_logins, g_client_group,
      g_count
   };

   const XmlElement *find_group(group_types type, const std::string& tag) const
      { return find_element(tag, _groups[type]); }

protected:
   bool from_or_default(const XmlElement *from, const f8String& tag, f8String& target) const
      { return (from && from->GetAttr(tag, target)) || (_default && _default->GetAttr(tag, target)); }

   template<typename T>
   T& get_string_field(const XmlElement *from, const std::string& tag, T& to) const
   {
      std::string val;
      if (from_or_default(from, tag, val))
         to.set(val);
      return to;
   }

   Tickval::ticks get_time_field(const XmlElement *from, const std::string& tag, bool timeonly=false) const
   {
      std::string time_str;
      return from && from->GetAttr(tag, time_str) && time_str.size() == 8
         ? time_parse(time_str.c_str(), 8, timeonly) : Tickval::errorticks();
   }

   template<typename T>
   T find_or_default(const XmlElement *from, const std::string& tag, const T def) const
   {
      if (from)
      {
         if (from->HasAttr(tag))
            return from->FindAttr(tag, def);
         if (_default)
            return _default->FindAttr(tag, def);
      }
      return def;
   }

private:
   unsigned load_map(const std::string& tag, ConfigMap& map_name, const bool is_session=false)
   {
      XmlElement::XmlSet slist;
      if (_root->find(tag, slist))
      {
         for(const auto *pp : slist)
         {
            std::string name;
            if (pp->GetAttr("name", name) && is_session ? pp->FindAttr("active", false) : true)
            {
               map_name.insert({name, pp});
               if (is_session)
                  _allsessions.push_back(pp);
            }
         }
      }

      return static_cast<unsigned>(map_name.size());
   }

public:
   enum Logtype { session_log, protocol_log };

   Configuration(const std::string& xmlfile, bool do_process=false)
      : _root(XmlElement::Factory(xmlfile)),
      _default(_root ? _root->find("fix8/default") : nullptr),
      _groups(g_count)
   {
      if (!exist(xmlfile))
         throw ConfigurationError("config file not found", xmlfile);
      if (do_process)
         process();
   }

   Configuration(std::istream& istr, bool do_process=false)
      : _root(XmlElement::Factory(istr, "stream")),
      _default(_root ? _root->find("fix8/default") : nullptr),
      _groups(g_count)
   {
      if (do_process)
         process();
   }

   virtual ~Configuration() {}

   F8API int process();

   const XmlElement *get_session(const unsigned num) const
      { return num < _allsessions.size() ? _allsessions[num] : nullptr; }

   F8API Connection::Role get_role(const XmlElement *from) const;

   F8API size_t get_addresses(const XmlElement *from, std::vector<Server>& target) const;

   F8API Poco::Net::SocketAddress get_address(const XmlElement *from) const;

   F8API Poco::Net::IPAddress get_ip(const XmlElement *from) const;

   template<typename T>
   T get_logflags(const std::string& tag, const std::vector<std::string>& names,
      const XmlElement *from, Logger::LogPositions *positions=nullptr) const;

   F8API std::string& get_logname(const XmlElement *from, std::string& to, const SessionID *sid=nullptr) const;

   unsigned get_connect_timeout(const XmlElement *from, const unsigned def=defaults::connect_timeout) const
      { return find_or_default(from, "connect_timeout", def); }

   unsigned get_retry_interval(const XmlElement *from, const unsigned def=defaults::retry_interval) const
      { return find_or_default(from, "login_retry_interval", def); }

   unsigned get_retry_count(const XmlElement *from, const int def=defaults::login_retries) const
   {
      const int rc(find_or_default(from, "login_retries", def));
      if (rc < 0)
         throw ConfigurationError("retry count must be >= 0");
      return rc;
   }

   unsigned get_tcp_recvbuf_sz(const XmlElement *from, const unsigned def=0) const
      { return find_or_default(from, "tcp_recv_buffer", def); }

   unsigned get_tcp_sendbuf_sz(const XmlElement *from, const unsigned def=0) const
      { return find_or_default(from, "tcp_send_buffer", def); }

   unsigned get_version(const XmlElement *from, const unsigned def=0) const
      { return find_or_default(from, "fix_version", def); }

   unsigned get_tabsize(const XmlElement *from, const unsigned def=defaults::tabsize) const
      { return find_or_default(from, "tabsize", def); }

   unsigned get_logfile_rotation(const XmlElement *from, const unsigned def=defaults::log_rotation) const
      { return find_or_default(from, "rotation", def); }

   unsigned get_heartbeat_interval(const XmlElement *from, const unsigned def=defaults::hb_interval) const
      { return find_or_default(from, "heartbeat_interval", def); }

   bool get_tcp_nodelay(const XmlElement *from, const bool def=true) const
      { return find_or_default(from, "tcp_nodelay", def); }

   bool get_tcp_keepalive(const XmlElement *from, const bool def=false) const
      { return find_or_default(from, "tcp_keepalive", def); }

   bool get_tcp_reuseaddr(const XmlElement *from, const bool def=false) const
      { return find_or_default(from, "tcp_reuseaddr", def); }

   int get_tcp_linger(const XmlElement *from, const int def=-1) const
      { return find_or_default(from, "tcp_linger", def); }

   bool get_silent_disconnect(const XmlElement *from, const bool def=false) const
      { return find_or_default(from, "silent_disconnect", def); }

   bool get_enforce_compids_flag(const XmlElement *from, const bool def=true) const
      { return find_or_default(from, "enforce_compids", def); }

   bool get_ignore_logon_sequence_check_flag(const XmlElement *from, const bool def=false) const
      { return find_or_default(from, "ignore_logon_sequence_check", def); }

   bool get_no_chksum_flag(const XmlElement *from, const bool def=false) const
      { return find_or_default(from, "no_chksum", def); }

   bool get_permissive_mode_flag(const XmlElement *from, const bool def=false) const
      { return find_or_default(from, "permissive_mode", def); }

   bool get_reset_sequence_number_flag(const XmlElement *from, const bool def=false) const
      { return find_or_default(from, "reset_sequence_numbers", def); }

   bool get_always_seqnum_assign(const XmlElement *from, const bool def=false) const
      { return find_or_default(from, "always_seqnum_assign", def); }

   F8API ProcessModel get_process_model(const XmlElement *from) const;

   default_appl_ver_id get_default_appl_ver_id(const XmlElement *from) const
      { default_appl_ver_id to; return get_string_field(from, "default_appl_ver_id", to); }

   sender_comp_id get_sender_comp_id(const XmlElement *from) const
      { sender_comp_id to; return get_string_field(from, "sender_comp_id", to); }

   target_comp_id get_target_comp_id(const XmlElement *from) const
      { target_comp_id to; return get_string_field(from, "target_comp_id", to); }

#ifdef FIX8_HAVE_OPENSSL

   F8API SslContext get_ssl_context(const XmlElement *from) const;
#endif

   F8API Persister *create_persister(const XmlElement *from, const SessionID *sid=nullptr, bool flag=false) const;

   F8API Logger *create_logger(const XmlElement *from, const Logtype ltype, const SessionID *sid=nullptr) const;

   F8API Schedule create_schedule(const XmlElement *from) const;

   F8API Clients create_clients(const XmlElement *from) const;

   F8API Schedule create_login_schedule(const XmlElement *from) const;

   F8API Session_Schedule *create_session_schedule(const XmlElement *from) const;

   F8API unsigned get_all_sessions(std::vector<const XmlElement *>& target, const Connection::Role role=Connection::cn_unknown) const;

   const XmlElement *get_root() const { return _root; }
};

//-------------------------------------------------------------------------------------------------

} // FIX8

#endif // FIX8_CONFIGURATION_HPP_