14 #include <boost/algorithm/string/split.hpp> 15 #include <boost/algorithm/string/classification.hpp> 16 #include <boost/make_shared.hpp> 27 OptionDescriptor::create(
const OptionPtr& opt,
bool persist,
28 const std::string& formatted_value,
30 return (boost::make_shared<OptionDescriptor>(opt, persist, formatted_value,
35 OptionDescriptor::create(
bool persist) {
36 return (boost::make_shared<OptionDescriptor>(persist));
41 return (boost::make_shared<OptionDescriptor>(desc));
49 option_->equals(other.
option_));
52 CfgOption::CfgOption() {
56 CfgOption::empty()
const {
57 return (options_.empty() && vendor_options_.empty());
62 return (options_.equals(other.options_) &&
63 vendor_options_.equals(other.vendor_options_));
67 CfgOption::add(
const OptionPtr& option,
const bool persistent,
68 const std::string& option_space,
74 add(desc, option_space);
82 }
else if (!OptionSpace::validateName(option_space)) {
84 << option_space <<
"'");
87 const uint32_t vendor_id = LibDHCP::optionSpaceToVendorId(option_space);
89 vendor_options_.addItem(desc, vendor_id);
91 options_.addItem(desc, option_space);
105 <<
" does not exist");
110 auto const& od_itr = idx.find(desc.
option_->getType());
111 if (od_itr == idx.end()) {
113 << option_space <<
":" << desc.
option_->getType()
114 <<
", it does not exist");
117 idx.replace(od_itr, desc);
120 std::list<std::string>
121 CfgOption::getVendorIdsSpaceNames()
const {
122 std::list<uint32_t> ids = getVendorIds();
123 std::list<std::string> names;
124 for (
auto const&
id : ids) {
125 std::ostringstream s;
128 s <<
"vendor-" << id;
129 names.push_back(s.str());
154 for (
auto space : getOptionSpaceNames()) {
155 for (
auto opt_desc : *(getAll(space))) {
156 if (createDescriptorOption(cfg_def, space, opt_desc)) {
158 replace(opt_desc,space);
169 "validateCreateOption: descriptor has no option instance");
173 uint16_t code = opt_desc.
option_->getType();
182 uint32_t vendor_id = LibDHCP::optionSpaceToVendorId(space);
184 def = LibDHCP::getVendorOptionDef(universe, vendor_id, code);
191 def = cfg_def->get(space, code);
196 if (!formatted_value.empty()) {
198 <<
" has a formatted value: '" << formatted_value
199 <<
"' but no option definition");
211 if (formatted_value.empty()) {
213 opt_desc.
option_ = def->optionFactory(universe, code, opt_desc.
option_->getData());
216 std::vector<std::string> split_vec;
217 boost::split(split_vec, formatted_value, boost::is_any_of(
","));
218 opt_desc.
option_ = def->optionFactory(universe, code, split_vec);
220 }
catch (
const std::exception& ex) {
222 <<
" from data specified, reason: " << ex.
what());
232 mergeInternal(options_, other.options_);
234 mergeInternal(vendor_options_, other.vendor_options_);
246 CfgOption::encapsulate() {
254 CfgOption::encapsulateInternal(
const std::string& option_space) {
259 for (
auto const& opt : *options) {
260 encapsulateInternal(opt.option_);
265 CfgOption::encapsulateInternal(
const OptionPtr& option) {
267 const std::string& encap_space = option->getEncapsulatedSpace();
269 if (!encap_space.empty()) {
272 for (
auto const& encap_opt : *encap_options) {
274 if (!option->getOption(encap_opt.option_->getType())) {
275 option->addOption(encap_opt.option_);
282 encapsulateInternal(encap_opt.option_);
288 template <
typename Selector>
295 std::list<Selector> selectors = src_container.getOptionSpaceNames();
300 for (
auto const& it : selectors) {
308 for (
auto const& src_opt : *src_all) {
311 idx.equal_range(src_opt.option_->getType());
314 if (std::distance(range.first, range.second) == 0) {
322 CfgOption::getAll(
const std::string& option_space)
const {
323 return (options_.getItems(option_space));
327 CfgOption::getAll(
const uint32_t vendor_id)
const {
328 return (vendor_options_.getItems(vendor_id));
332 CfgOption::del(
const std::string& option_space,
const uint16_t option_code) {
335 if (!options || options->empty()) {
346 auto option_space_names = getOptionSpaceNames();
347 for (
auto option_space_from_list : option_space_names) {
349 auto options_in_space = getAll(option_space_from_list);
350 for (
auto option_it = options_in_space->begin();
351 option_it != options_in_space->end();
356 if (option_it->option_ &&
357 (option_it->option_->getEncapsulatedSpace() == option_space)) {
358 option_it->option_->delOption(option_code);
364 auto& idx = options->get<1>();
365 return (idx.erase(option_code));
369 CfgOption::del(
const uint32_t vendor_id,
const uint16_t option_code) {
372 if (!vendor_options || vendor_options->empty()) {
377 auto& idx = vendor_options->get<1>();
378 return (idx.erase(option_code));
382 CfgOption::del(
const uint64_t
id) {
386 for (
auto space_name : getOptionSpaceNames()) {
388 auto options = getAll(space_name);
389 for (
auto option_it = options->begin(); option_it != options->end();
391 if (!option_it->option_) {
397 auto sub_options = option_it->option_->getOptions();
398 for (
auto sub = sub_options.begin(); sub != sub_options.end();
401 option_it->option_->delOption(sub->second->getType());
408 size_t num_deleted = options_.deleteItems(
id) + vendor_options_.deleteItems(
id);
414 return (num_deleted);
418 CfgOption::toElement()
const {
419 return (toElementWithMetadata(
false));
423 CfgOption::toElementWithMetadata(
const bool include_metadata)
const {
427 const std::list<std::string>& names = options_.getOptionSpaceNames();
428 for (
auto const& name : names) {
430 for (
auto const& opt : *opts) {
434 opt.contextToElement(map);
438 uint16_t code = opt.option_->getType();
443 def = LibDHCP::getRuntimeOptionDef(name, code);
446 def = LibDHCP::getLastResortOptionDef(name, code);
452 if (!opt.formatted_value_.empty()) {
457 std::vector<uint8_t> bin = opt.option_->toBinary();
465 if (include_metadata) {
466 map->set(
"metadata", opt.getMetadata());
474 const std::list<uint32_t>& ids = vendor_options_.getOptionSpaceNames();
475 for (
auto const&
id : ids) {
477 for (
auto const& opt : *opts) {
481 opt.contextToElement(map);
483 std::ostringstream oss;
484 oss <<
"vendor-" << id;
487 uint16_t code = opt.option_->getType();
492 LibDHCP::getVendorOptionDef(universe,
id, code);
495 def = LibDHCP::getRuntimeOptionDef(oss.str(), code);
501 if (!opt.formatted_value_.empty()) {
506 std::vector<uint8_t> bin = opt.option_->toBinary();
Simple container for option spaces holding various items.
OptionContainer::nth_index< 1 >::type OptionContainerTypeIndex
Type of the index #1 - option type.
void copyTo(CfgOption &other) const
Copies this configuration to another configuration.
boost::shared_ptr< OptionDescriptor > OptionDescriptorPtr
A pointer to option descriptor.
boost::shared_ptr< Option > OptionPtr
Universe
defines option universe DHCPv4 or DHCPv6
boost::shared_ptr< Element > ElementPtr
boost::shared_ptr< CfgOptionDef > CfgOptionDefPtr
Non-const pointer.
static ElementPtr createMap(const Position &pos=ZERO_POSITION())
Creates an empty MapElement type ElementPtr.
static ElementPtr createList(const Position &pos=ZERO_POSITION())
Creates an empty ListElement type ElementPtr.
virtual const char * what() const
Returns a C-style character string of the cause of the exception.
std::pair< OptionContainerTypeIndex::const_iterator, OptionContainerTypeIndex::const_iterator > OptionContainerTypeRange
Pair of iterators to represent the range of options having the same option type value.
#define isc_throw(type, stream)
A shortcut macro to insert known values into exception arguments.
A generic exception that is thrown if a parameter given to a method is considered invalid in that con...
std::string formatted_value_
Option value in textual (CSV) format.
Represents option data configuration for the DHCP server.
bool persistent_
Persistence flag.
boost::shared_ptr< const Element > ConstElementPtr
void createOptions(CfgOptionDefPtr cfg_def)
Re-create the option in each descriptor based on given definitions.
std::string space_name_
Option space name.
OptionPtr option_
Option instance.
void clearItems()
Remove all items from the container.
Defines the logger used by the top-level component of kea-lfc.
string encodeHex(const vector< uint8_t > &binary)
Encode binary data in the base16 ('hex') format.
void merge(ElementPtr element, ConstElementPtr other)
Merges the data from other into element.
static ElementPtr create(const Position &pos=ZERO_POSITION())
void setId(const uint64_t id)
Sets element's database identifier.
#define DHCP6_OPTION_SPACE
boost::multi_index_container< OptionDescriptor, boost::multi_index::indexed_by< boost::multi_index::sequenced<>, boost::multi_index::hashed_non_unique< KeyFromKeyExtractor< boost::multi_index::const_mem_fun< Option, uint16_t, &Option::getType >, boost::multi_index::member< OptionDescriptor, OptionPtr, &OptionDescriptor::option_ > > >, boost::multi_index::hashed_non_unique< boost::multi_index::member< OptionDescriptor, bool, &OptionDescriptor::persistent_ > >, boost::multi_index::ordered_non_unique< boost::multi_index::const_mem_fun< data::BaseStampedElement, boost::posix_time::ptime, &data::BaseStampedElement::getModificationTime > >, boost::multi_index::hashed_non_unique< boost::multi_index::tag< OptionIdIndexTag >, boost::multi_index::const_mem_fun< data::BaseStampedElement, uint64_t, &data::BaseStampedElement::getId > > >> OptionContainer
Multi index container for DHCP option descriptors.
A generic exception that is thrown if a function is called in a prohibited way.
#define DHCP4_OPTION_SPACE
global std option spaces
boost::shared_ptr< OptionContainer > OptionContainerPtr
Pointer to the OptionContainer object.
boost::shared_ptr< OptionDefinition > OptionDefinitionPtr
Pointer to option definition object.