icinga2/base/configobject.cpp

/******************************************************************************
 * Icinga 2                                                                   *
 * Copyright (C) 2012 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 "i2-base.h"

using namespace icinga;

map<pair<string, string>, Dictionary::Ptr> ConfigObject::m_PersistentTags;

ConfigObject::ConfigObject(Dictionary::Ptr properties, const ConfigObject::Set::Ptr& container)
	: m_Container(container ? container : GetAllObjects()),
	m_Properties(properties), m_Tags(boost::make_shared<Dictionary>())
{
	/* restore the object's tags */
	map<pair<string, string>, Dictionary::Ptr>::iterator it;
	it = m_PersistentTags.find(make_pair(GetType(), GetName()));
	if (it != m_PersistentTags.end()) {
		m_Tags = it->second;
		m_PersistentTags.erase(it);
	}
}

void ConfigObject::SetProperties(const Dictionary::Ptr& properties)
{
	m_Properties = properties;
}

Dictionary::Ptr ConfigObject::GetProperties(void) const
{
	return m_Properties;
}

void ConfigObject::SetTags(const Dictionary::Ptr& tags)
{
	m_Tags = tags;
}

Dictionary::Ptr ConfigObject::GetTags(void) const
{
	return m_Tags;
}

string ConfigObject::GetType(void) const
{
	string type;
	GetProperties()->Get("__type", &type);
	return type;
}

string ConfigObject::GetName(void) const
{
	string name;
	GetProperties()->Get("__name", &name);
	return name;
}

bool ConfigObject::IsLocal(void) const
{
	bool value = false;
	GetProperties()->Get("__local", &value);
	return value;
}

bool ConfigObject::IsAbstract(void) const
{
	bool value = false;
	GetProperties()->Get("__abstract", &value);
	return value;
}

void ConfigObject::SetSource(const string& value)
{
	GetProperties()->Set("__source", value);
}

string ConfigObject::GetSource(void) const
{
	string value;
	GetProperties()->Get("__source", &value);
	return value;
}

void ConfigObject::SetCommitTimestamp(double ts)
{
	GetProperties()->Set("__tx", ts);
}

double ConfigObject::GetCommitTimestamp(void) const
{
	double value = 0;
	GetProperties()->Get("__tx", &value);
	return value;
}

void ConfigObject::Commit(void)
{
	assert(Application::IsMainThread());

	ConfigObject::Ptr dobj = GetObject(GetType(), GetName());
	ConfigObject::Ptr self = GetSelf();
	assert(!dobj || dobj == self);
	m_Container->CheckObject(self);

	SetCommitTimestamp(Utility::GetTime());
}

void ConfigObject::Unregister(void)
{
	assert(Application::IsMainThread());

	ConfigObject::Ptr self = GetSelf();
	m_Container->RemoveObject(self);
}

ObjectSet<ConfigObject::Ptr>::Ptr ConfigObject::GetAllObjects(void)
{
	static ObjectSet<ConfigObject::Ptr>::Ptr allObjects;

	if (!allObjects) {
		allObjects = boost::make_shared<ObjectSet<ConfigObject::Ptr> >();
		allObjects->Start();
	}

	return allObjects;
}

ConfigObject::TNMap::Ptr ConfigObject::GetObjectsByTypeAndName(void)
{
	static ConfigObject::TNMap::Ptr tnmap;

	if (!tnmap) {
		tnmap = boost::make_shared<ConfigObject::TNMap>(GetAllObjects(), &ConfigObject::TypeAndNameGetter);
		tnmap->Start();
	}

	return tnmap;
}

ConfigObject::Ptr ConfigObject::GetObject(string type, string name)
{
	ConfigObject::TNMap::Range range;
	range = GetObjectsByTypeAndName()->GetRange(make_pair(type, name));

	assert(distance(range.first, range.second) <= 1);

	if (range.first == range.second)
		return ConfigObject::Ptr();
	else
		return range.first->second;
}

bool ConfigObject::TypeAndNameGetter(const ConfigObject::Ptr& object, pair<string, string> *key)
{
	*key = make_pair(object->GetType(), object->GetName());

	return true;
}

function<bool (ConfigObject::Ptr)> ConfigObject::MakeTypePredicate(string type)
{
	return boost::bind(&ConfigObject::TypePredicate, _1, type);
}

bool ConfigObject::TypePredicate(const ConfigObject::Ptr& object, string type)
{
	return (object->GetType() == type);
}

ConfigObject::TMap::Ptr ConfigObject::GetObjectsByType(void)
{
	static ObjectMap<string, ConfigObject::Ptr>::Ptr tmap;

	if (!tmap) {
		tmap = boost::make_shared<ConfigObject::TMap>(GetAllObjects(), &ConfigObject::TypeGetter);
		tmap->Start();
	}

	return tmap;
}

bool ConfigObject::TypeGetter(const ConfigObject::Ptr& object, string *key)
{
	*key = object->GetType();
	return true;
}

ConfigObject::TMap::Range ConfigObject::GetObjects(string type)
{
	return GetObjectsByType()->GetRange(type);
}

void ConfigObject::RemoveTag(const string& key)
{
	GetTags()->Remove(key);
}

ScriptTask::Ptr ConfigObject::InvokeMethod(const string& method,
    const vector<Variant>& arguments, ScriptTask::CompletionCallback callback)
{
	Dictionary::Ptr methods;
	string funcName;
	if (!GetProperty("methods", &methods) || !methods->Get(method, &funcName))
		return ScriptTask::Ptr();

	ScriptFunction::Ptr func = ScriptFunction::GetByName(funcName);

	if (!func)
		throw_exception(invalid_argument("Function '" + funcName + "' does not exist."));

	ScriptTask::Ptr task = boost::make_shared<ScriptTask>(func, arguments);
	task->Start(callback);

	return task;
}

void ConfigObject::DumpObjects(const string& filename)
{
	Logger::Write(LogInformation, "base", "Dumping program state to file '" + filename + "'");

	ofstream fp;
	fp.open(filename.c_str());

	if (!fp)
		throw_exception(runtime_error("Could not open '" + filename + "' file"));

	FIFO::Ptr fifo = boost::make_shared<FIFO>();

	BOOST_FOREACH(const ConfigObject::Ptr object, ConfigObject::GetAllObjects()) {
		Dictionary::Ptr persistentObject = boost::make_shared<Dictionary>();

		persistentObject->Set("type", object->GetType());
		persistentObject->Set("name", object->GetName());

		/* only persist properties for replicated objects or for objects
		 * that are marked as persistent */
		if (!object->GetSource().empty() /*|| object->IsPersistent()*/)
			persistentObject->Set("properties", object->GetProperties());

		persistentObject->Set("tags", object->GetTags());

		Variant value = persistentObject;
		string json = value.Serialize();

		/* This is quite ugly, unfortunatelly Netstring requires an IOQueue object */
		Netstring::WriteStringToIOQueue(fifo.get(), json);

		size_t count;
		while ((count = fifo->GetAvailableBytes()) > 0) {
			char buffer[1024];
			
			if (count > sizeof(buffer))
				count = sizeof(buffer);

			fifo->Read(buffer, count);
			fp.write(buffer, count);
		}
	}
}

void ConfigObject::RestoreObjects(const string& filename)
{
	assert(GetAllObjects()->Begin() == GetAllObjects()->End());

	Logger::Write(LogInformation, "base", "Restoring program state from file '" + filename + "'");

	std::ifstream fp;
	fp.open(filename.c_str());

	/* TODO: Fix this horrible mess. */
	FIFO::Ptr fifo = boost::make_shared<FIFO>();
	while (fp) {
		char buffer[1024];

		fp.read(buffer, sizeof(buffer));
		fifo->Write(buffer, fp.gcount());
	}

	string message;
	while (Netstring::ReadStringFromIOQueue(fifo.get(), &message)) {
		Variant value = Variant::Deserialize(message);

		if (!value.IsObjectType<Dictionary>())
			throw_exception(runtime_error("JSON objects in the program state file must be dictionaries."));

		Dictionary::Ptr persistentObject = value;

		string type;
		if (!persistentObject->Get("type", &type))
			continue;

		string name;
		if (!persistentObject->Get("name", &name))
			continue;

		Dictionary::Ptr tags;
		if (!persistentObject->Get("tags", &tags))
			continue;

		Dictionary::Ptr properties;
		if (persistentObject->Get("properties", &properties)) {
			ConfigObject::Ptr object = boost::make_shared<ConfigObject>(properties);
			object->SetTags(tags);
			object->Commit();
		} else {
			/* keep non-replicated objects until another config object with
			 * the same name is created (which is when we restore its tags) */
			m_PersistentTags[make_pair(type, name)] = tags;
		}
	}
}