OksConfiguration.cpp File Reference

#include <errno.h>
#include <stdlib.h>
#include <sys/stat.h>
#include <unistd.h>
#include <algorithm>
#include <memory>
#include "ers/ers.hpp"
#include "oks/file.hpp"
#include "oks/kernel.hpp"
#include "oks/object.hpp"
#include "oks/query.hpp"
#include "oks/relationship.hpp"
#include "oksutils/oks/access.hpp"
#include "conffwk/Change.hpp"
#include "conffwk/ConfigObject.hpp"
#include "conffwk/Configuration.hpp"
#include "conffwk/Schema.hpp"
#include "oksconflibs/OksConfigObject.hpp"
#include "oksconflibs/OksConfiguration.hpp"

Include dependency graph for OksConfiguration.cpp:

Go to the source code of this file.

Classes
struct	dunedaq::oksconflibs::OksConfigurationCheckDB
class	dunedaq::oksconflibs::ResubscribeGuard
struct	InheritanceData
class	DestroyGuard1
class	DestroyGuard2

Namespaces
namespace	dunedaq
	The DUNE-DAQ namespace.
namespace	dunedaq::oksconflibs

Functions
conffwk::ConfigurationImpl *	_oksconflibs_creator_ (const std::string &spec)
bool	is_repo_name (const std::string &name)
static std::string	mk_no_file_error_text (const std::string &db)
static std::string	mk_add_include_error_text (const std::string &db, const std::string &include, const char *error=nullptr)
static void	throw_update_exception (const OksFile *file_h, const char *action, const char *reason)
static std::vector< dunedaq::conffwk::Version >	dunedaq::oksconflibs::oks2config (const std::vector< OksRepositoryVersion > &in)
static void	check (std::vector< conffwk::ConfigurationChange * > &changes, const InheritanceData &inheritance, const std::set< std::string > &class_names, const OksConfiguration::SMap &objects, const std::string &obj_class, const std::string &obj_id, const char action)
static std::string	mk_rm_include_error_text (const std::string &db, const std::string &include, const char *error=0)

Function Documentation

_oksconflibs_creator_()

conffwk::ConfigurationImpl * _oksconflibs_creator_

(

const std::string &

spec

)

Definition at line 42 of file OksConfiguration.cpp.

{
  try {
    std::unique_ptr<OksConfiguration> impl(new OksConfiguration());
    if (!spec.empty()) {
      impl->open_db(spec);
    }
    return impl.release();
  } catch (dunedaq::conffwk::Exception& ex) {
    throw dunedaq::conffwk::Generic(ERS_HERE, "oksconflibs initialization error", ex);
  } catch (...) {
    throw dunedaq::conffwk::Generic(ERS_HERE,
                                    "oksconflibs initialization error:\n***** caught unknown exception *****");
  }
}

check()

void check ( std::vector< conffwk::ConfigurationChange * > & changes, const InheritanceData & inheritance, const std::set< std::string > & class_names, const OksConfiguration::SMap & objects, const std::string & obj_class, const std::string & obj_id, const char action )

static

The function checks if the object satisfies the subscription and adds to changes. The actions could be: '+' - created '~' - changed '-' - deleted

Definition at line 903 of file OksConfiguration.cpp.

{
 
  bool any = (class_names.empty() && objects.empty());
 
  // check subscription on objects
  //
  // omi iterator in non-null, if on an object of class 'obj_class'
  // there is explicit subscription
 
  OksConfiguration::SMap::const_iterator omi = objects.end();
 
  if (action != '+') {
    omi = objects.find(obj_class);
    if (omi != objects.end()) {
      std::set<std::string>::const_iterator i = omi->second.find(obj_id);
 
      if (i != omi->second.end()) {
        conffwk::ConfigurationChange::add(changes, obj_class, obj_id, action);
      }
    }
  }
 
  // process the class
 
  if (action == '+' || omi == objects.end()) {
    if (any || class_names.find(obj_class) != class_names.end()) {
      conffwk::ConfigurationChange::add(changes, obj_class, obj_id, action);
    }
  }
 
  // process subclasses
 
  OksConfiguration::SMap::const_iterator it = inheritance.data().find(obj_class);
  if (it != inheritance.data().end()) {
    for (std::set<std::string>::const_iterator j = it->second.begin(); j != it->second.end(); ++j) {
      omi = (action != '+' ? objects.find(*j) : objects.end());
 
      // 1. add objects if criteria is 'any'
      // 2. add object of class which has subscription and has no explicit object subscription
      // 3. add explicitly subscribed object
 
      if (any || (omi == objects.end() && class_names.find(*j) != class_names.end()) ||
          (omi != objects.end() && omi->second.find(obj_id) != omi->second.end())) {
        conffwk::ConfigurationChange::add(changes, *j, obj_id, action);
      }
    }
  }
}

is_repo_name()

bool is_repo_name

(

const std::string &

name

)

Definition at line 108 of file OksConfiguration.cpp.

{
  if (!OksKernel::get_repository_root().empty()) {
    std::string s(name);
 
    Oks::substitute_variables(s);
 
    bool is_absolute_path = (s[0] == '/');
 
    if (!is_absolute_path)
      s = std::string(OksKernel::get_cwd()) + '/' + s;
 
    // if file system path exists
    if (Oks::real_path(s, true)) {
      if (!OksKernel::get_repository_mapping_dir().empty() && s.find(OksKernel::get_repository_mapping_dir()) == 0)
        return true;
 
      static std::string user_repo_dir;
      static std::once_flag flag;
 
      std::call_once(flag, []() {
        if (const char* s = getenv("TDAQ_DB_USER_REPOSITORY")) {
          user_repo_dir = s;
 
          try {
            Oks::real_path(user_repo_dir, false);
          } catch (oks::exception& ex) {
            TLOG_DEBUG(0) << "Failed to read TDAQ_DB_USER_REPOSITORY = \'" << s << "\':\n\tcaused by: " << ex.what();
          }
        }
      });
 
      if (!user_repo_dir.empty() && s.find(user_repo_dir) == 0)
        return true;
 
      return false;
    } else
      return true;
  }
 
  return false;
}

mk_add_include_error_text()

std::string mk_add_include_error_text ( const std::string & db, const std::string & include, const char * error = nullptr )

static

Definition at line 308 of file OksConfiguration.cpp.

{
  std::ostringstream text;
  text << "cannot add and load include file \'" << include << "\' to \'" << db << '\'';
  if (error)
    text << ":\n" << error;
  return text.str();
}

mk_no_file_error_text()

std::string mk_no_file_error_text ( const std::string & db )

static

Definition at line 300 of file OksConfiguration.cpp.

{
  std::ostringstream text;
  text << "cannot find file \'" << db << '\'';
  return text.str();
}

mk_rm_include_error_text()

std::string mk_rm_include_error_text ( const std::string & db, const std::string & include, const char * error = 0 )

static

Definition at line 1045 of file OksConfiguration.cpp.

{
  std::ostringstream text;
  text << "cannot remove include file \'" << include << "\' from \'" << db << '\'';
  if (error)
    text << ":\n" << error;
  return text.str();
}

throw_update_exception()

void throw_update_exception ( const OksFile * file_h, const char * action, const char * reason )

static

Definition at line 334 of file OksConfiguration.cpp.

{
  std::ostringstream text;
  text << "cannot " << action << " file \'" << file_h->get_full_file_name() << "\' since " << reason;
  throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
}