/****************************************************************************** * Icinga 2 * * Copyright (C) 2012-present Icinga Development Team (http://www.icinga.org) * * * * This program is free software; you can redistribute it and/or * * modify it under the terms of the GNU General Public License * * as published by the Free Software Foundation; either version 2 * * of the License, or (at your option) any later version. * * * * This program 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. See the * * GNU General Public License for more details. * * * * You should have received a copy of the GNU General Public License * * along with this program; if not, write to the Free Software Foundation * * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. * ******************************************************************************/ #include "config/configitem.h" #include "config/configcompilercontext.h" #include "base/application.h" #include "base/dynamictype.h" #include "base/objectlock.h" #include "base/convert.h" #include "base/logger_fwd.h" #include "base/debug.h" #include "base/workqueue.h" #include #include using namespace icinga; boost::mutex ConfigItem::m_Mutex; ConfigItem::ItemMap ConfigItem::m_Items; /** * Constructor for the ConfigItem class. * * @param type The object type. * @param name The name of the item. * @param unit The unit of the item. * @param abstract Whether the item is a template. * @param exprl Expression list for the item. * @param parents Parent objects for the item. * @param debuginfo Debug information. */ ConfigItem::ConfigItem(const String& type, const String& name, bool abstract, const ExpressionList::Ptr& exprl, const std::vector& parents, const DebugInfo& debuginfo) : m_Type(type), m_Name(name), m_Abstract(abstract), m_Validated(false), m_ExpressionList(exprl), m_ParentNames(parents), m_DebugInfo(debuginfo) { } /** * Retrieves the type of the configuration item. * * @returns The type. */ String ConfigItem::GetType(void) const { return m_Type; } /** * Retrieves the name of the configuration item. * * @returns The name. */ String ConfigItem::GetName(void) const { return m_Name; } /** * Checks whether the item is abstract. * * @returns true if the item is abstract, false otherwise. */ bool ConfigItem::IsAbstract(void) const { return m_Abstract; } /** * Retrieves the debug information for the configuration item. * * @returns The debug information. */ DebugInfo ConfigItem::GetDebugInfo(void) const { return m_DebugInfo; } /** * Retrieves the expression list for the configuration item. * * @returns The expression list. */ ExpressionList::Ptr ConfigItem::GetExpressionList(void) const { return m_ExpressionList; } ExpressionList::Ptr ConfigItem::GetLinkedExpressionList(void) { ASSERT(OwnsLock()); if (m_LinkedExpressionList) return m_LinkedExpressionList; m_LinkedExpressionList = make_shared(); BOOST_FOREACH(const String& name, m_ParentNames) { ConfigItem::Ptr parent = ConfigItem::GetObject(m_Type, name); if (!parent) { std::ostringstream message; message << "Parent object '" << name << "' does not" " exist (" << m_DebugInfo << ")"; ConfigCompilerContext::GetInstance()->AddMessage(true, message.str()); } else { ExpressionList::Ptr pexprl; { ObjectLock olock(parent); pexprl = parent->GetLinkedExpressionList(); } m_LinkedExpressionList->AddExpression(Expression("", OperatorExecute, pexprl, m_DebugInfo)); } } m_LinkedExpressionList->AddExpression(Expression("", OperatorExecute, m_ExpressionList, m_DebugInfo)); return m_LinkedExpressionList; } Dictionary::Ptr ConfigItem::GetProperties(void) { ASSERT(OwnsLock()); Dictionary::Ptr properties = make_shared(); GetLinkedExpressionList()->Execute(properties); return properties; } /** * Commits the configuration item by creating a DynamicObject * object. * * @returns The DynamicObject that was created/updated. */ DynamicObject::Ptr ConfigItem::Commit(void) { ASSERT(!OwnsLock()); #ifdef _DEBUG Log(LogDebug, "base", "Commit called for ConfigItem Type=" + GetType() + ", Name=" + GetName()); #endif /* _DEBUG */ /* Make sure the type is valid. */ DynamicType::Ptr dtype = DynamicType::GetByName(GetType()); if (!dtype) BOOST_THROW_EXCEPTION(std::runtime_error("Type '" + GetType() + "' does not exist.")); if (dtype->GetObject(GetName())) BOOST_THROW_EXCEPTION(std::runtime_error("An object with type '" + GetType() + "' and name '" + GetName() + "' already exists.")); if (IsAbstract()) return DynamicObject::Ptr(); Dictionary::Ptr properties; { ObjectLock olock(this); properties = GetProperties(); } DynamicObject::Ptr dobj = dtype->CreateObject(properties); dobj->Register(); m_Object = dobj; return dobj; } /** * Registers the configuration item. */ void ConfigItem::Register(void) { std::pair key = std::make_pair(m_Type, m_Name); ConfigItem::Ptr self = GetSelf(); boost::mutex::scoped_lock lock(m_Mutex); m_Items[key] = self; } /** * Retrieves a configuration item by type and name. * * @param type The type of the ConfigItem that is to be looked up. * @param name The name of the ConfigItem that is to be looked up. * @returns The configuration item. */ ConfigItem::Ptr ConfigItem::GetObject(const String& type, const String& name) { std::pair key = std::make_pair(type, name); ConfigItem::ItemMap::iterator it; { boost::mutex::scoped_lock lock(m_Mutex); it = m_Items.find(key); } if (it != m_Items.end()) return it->second; return ConfigItem::Ptr(); } bool ConfigItem::HasObject(const String& type, const String& name) { std::pair key = std::make_pair(type, name); ConfigItem::ItemMap::iterator it; { boost::mutex::scoped_lock lock(m_Mutex); it = m_Items.find(key); } return (it != m_Items.end()); } void ConfigItem::ValidateItem(void) { if (m_Validated) return; ConfigType::Ptr ctype = ConfigType::GetByName(GetType()); if (!ctype) { ConfigCompilerContext::GetInstance()->AddMessage(false, "No validation type found for object '" + GetName() + "' of type '" + GetType() + "'"); return; } ctype->ValidateItem(GetSelf()); m_Validated = true; } bool ConfigItem::ActivateItems(bool validateOnly) { if (ConfigCompilerContext::GetInstance()->HasErrors()) return false; if (ConfigCompilerContext::GetInstance()->HasErrors()) return false; Log(LogInformation, "config", "Validating config items (step 1)..."); ParallelWorkQueue upq; BOOST_FOREACH(const ItemMap::value_type& kv, m_Items) { upq.Enqueue(boost::bind(&ConfigItem::ValidateItem, kv.second)); } upq.Join(); if (ConfigCompilerContext::GetInstance()->HasErrors()) return false; Log(LogInformation, "config", "Committing config items"); BOOST_FOREACH(const ItemMap::value_type& kv, m_Items) { upq.Enqueue(boost::bind(&ConfigItem::Commit, kv.second)); } upq.Join(); std::vector objects; BOOST_FOREACH(const ItemMap::value_type& kv, m_Items) { DynamicObject::Ptr object = kv.second->m_Object; if (object) objects.push_back(object); } Log(LogInformation, "config", "Triggering OnConfigLoaded signal for config items"); BOOST_FOREACH(const DynamicObject::Ptr& object, objects) { upq.Enqueue(boost::bind(&DynamicObject::OnConfigLoaded, object)); } upq.Join(); Log(LogInformation, "config", "Validating config items (step 2)..."); BOOST_FOREACH(const ItemMap::value_type& kv, m_Items) { upq.Enqueue(boost::bind(&ConfigItem::ValidateItem, kv.second)); } upq.Join(); ConfigItem::DiscardItems(); ConfigType::DiscardTypes(); /* log stats for external parsers */ BOOST_FOREACH(const DynamicType::Ptr& type, DynamicType::GetTypes()) { if (type->GetObjects().size() > 0) Log(LogInformation, "config", "Checked " + Convert::ToString(type->GetObjects().size()) + " " + type->GetName() + "(s)."); } if (ConfigCompilerContext::GetInstance()->HasErrors()) return false; if (validateOnly) return true; /* restore the previous program state */ DynamicObject::RestoreObjects(Application::GetStatePath()); Log(LogInformation, "config", "Triggering Start signal for config items"); BOOST_FOREACH(const DynamicType::Ptr& type, DynamicType::GetTypes()) { BOOST_FOREACH(const DynamicObject::Ptr& object, type->GetObjects()) { if (object->IsActive()) continue; #ifdef _DEBUG Log(LogDebug, "config", "Activating object '" + object->GetName() + "' of type '" + object->GetType()->GetName() + "'"); #endif /* _DEBUG */ upq.Enqueue(boost::bind(&DynamicObject::Activate, object)); } } upq.Join(); #ifdef _DEBUG BOOST_FOREACH(const DynamicType::Ptr& type, DynamicType::GetTypes()) { BOOST_FOREACH(const DynamicObject::Ptr& object, type->GetObjects()) { ASSERT(object->IsActive()); } } #endif /* _DEBUG */ Log(LogInformation, "config", "Activated all objects."); return true; } void ConfigItem::DiscardItems(void) { boost::mutex::scoped_lock lock(m_Mutex); m_Items.clear(); }