path: root/hcid/dbus-service.c

/*
 *
 *  BlueZ - Bluetooth protocol stack for Linux
 *
 *  Copyright (C) 2004-2006  Marcel Holtmann <marcel@holtmann.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
 *
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <stdio.h>
#include <errno.h>
#include <unistd.h>
#include <stdlib.h>

#include <dbus/dbus.h>

#include "hcid.h"
#include "dbus.h"
#include "dbus-common.h"
#include "dbus-error.h"
#include "dbus-manager.h"
#include "dbus-service.h"
#include "dbus-hci.h"

static GSList *services = NULL;

struct binary_record *binary_record_new()
{
	struct binary_record *rec;
	rec = malloc(sizeof(struct binary_record));
	if (!rec)
		return NULL;

	memset(rec, 0, sizeof(struct binary_record));
	rec->ext_handle = 0xffffffff;
	rec->handle = 0xffffffff;

	return rec;
}

void binary_record_free(struct binary_record *rec)
{
	if (!rec)
		return;

	if (rec->buf) {
		if (rec->buf->data)
			free(rec->buf->data);
		free(rec->buf);
	}
	
	free(rec);
}

int binary_record_cmp(struct binary_record *rec, uint32_t *handle)
{
	return (rec->ext_handle - *handle);
}


struct service_call *service_call_new(DBusConnection *conn, DBusMessage *msg,
					struct service_agent *agent)
{
	struct service_call *call;
	call = malloc(sizeof(struct service_call));
	if (!call)
		return NULL;
	memset(call, 0, sizeof(struct service_call));
	call->conn = dbus_connection_ref(conn);
	call->msg = dbus_message_ref(msg);
	call->agent = agent;

	return call;
}

void service_call_free(void *data)
{
	struct service_call *call = data;

	if (!call)
		return;

	if (call->conn)
		dbus_connection_unref(call->conn);

	if(call->msg)
		dbus_message_unref(call->msg);
	
	free(call);
}

#if 0
static int service_agent_cmp(const struct service_agent *a, const struct service_agent *b)
{
	int ret;

	if (b->id) {
		if (!a->id)
			return -1;
		ret = strcmp(a->id, b->id);
		if (ret)
			return ret;
	}

	if (b->name) {
		if (!a->name)
			return -1;
		ret = strcmp(a->name, b->name);
		if (ret)
			return ret;
	}

	if (b->description) {
		if (!a->description)
			return -1;
		ret = strcmp(a->description, b->description);
		if (ret)
			return ret;
	}

	return 0;
}
#endif

static void service_agent_free(struct service_agent *agent)
{
	if (!agent)
		return;

	if (agent->id)
		free(agent->id);

	if (agent->name)
		free(agent->name);

	if (agent->description)
		free(agent->description);

	if (agent->trusted_devices) {
		g_slist_foreach(agent->trusted_devices, (GFunc) free, NULL);
		g_slist_free(agent->trusted_devices);
	}

	if (agent->records) {
		g_slist_foreach(agent->records, (GFunc) binary_record_free, NULL);
		g_slist_free(agent->records);
	}

	free(agent);
}

static struct service_agent *service_agent_new(const char *id, const char *name, const char *description)
{
	struct service_agent *agent = malloc(sizeof(struct service_agent));

	if (!agent)
		return NULL;

	memset(agent, 0, sizeof(struct service_agent));

	if (id) {	
		agent->id = strdup(id);
		if (!agent->id)
			goto mem_fail;
	}

	if (name) {
		agent->name = strdup(name);
		if (!agent->name)
			goto mem_fail;
	}

	if (description) {
		agent->description = strdup(description);
		if (!agent->description)
			goto mem_fail;
	}

	/* by default when the service agent registers the service must not be running */
	agent->running = SERVICE_NOT_RUNNING;

	return agent;

mem_fail:
	service_agent_free(agent);
	return NULL;
}

int register_agent_records(GSList *lrecords)
{
	while (lrecords) {
		struct binary_record *rec = lrecords->data;
		lrecords = lrecords->next;
		uint32_t handle = 0;

		if (!rec || !rec->buf || rec->handle != 0xffffffff)
			continue;

		if (register_sdp_record(rec->buf->data, rec->buf->data_size, &handle) < 0) {
			/* FIXME: If just one of the service record registration fails */
			error("Service Record registration failed:(%s, %d)",
				strerror(errno), errno);
		}

		rec->handle = handle;
	}

	return 0;
}

static int unregister_agent_records(GSList *lrecords)
{
	while (lrecords) {
		struct binary_record *rec = lrecords->data;
		lrecords = lrecords->next;

		if (!rec || rec->handle == 0xffffffff)
			continue;

		if (unregister_sdp_record(rec->handle) < 0) {
			/* FIXME: If just one of the service record registration fails */
			error("Service Record unregistration failed:(%s, %d)",
				strerror(errno), errno);
		}

		rec->handle = 0xffffffff;
	}

	return 0;
}

static void service_agent_exit(const char *name, void *data)
{
	DBusConnection *conn = data;
	DBusMessage *message;
	GSList *l, *lremove = NULL;
	struct service_agent *agent;
	const char *path;
	
	debug("Service Agent exited:%s", name);

	/* Remove all service agents assigned to this owner */
	for (l = services; l; l = l->next) {
		path = l->data;

		if (!dbus_connection_get_object_path_data(conn, path, (void *) &agent))
			continue;

		if (!agent || strcmp(name, agent->id))
			continue;

		if (agent->records)
			unregister_agent_records(agent->records);

		service_agent_free(agent);

		dbus_connection_unregister_object_path(conn, path);

		message = dbus_message_new_signal(BASE_PATH, MANAGER_INTERFACE,
						"ServiceUnregistered");
		dbus_message_append_args(message, DBUS_TYPE_STRING, &path,
						DBUS_TYPE_INVALID);
		send_message_and_unref(conn, message);

		lremove = g_slist_append(lremove, l->data);
		services = g_slist_remove(services, l->data);
	}

	g_slist_foreach(lremove, (GFunc) free, NULL);
	g_slist_free(lremove);
}

static void forward_reply(DBusPendingCall *call, void *udata)
{
	struct service_call *call_data = udata;
	DBusMessage *reply = dbus_pending_call_steal_reply(call);
	DBusMessage *source_reply;
	const char *sender;

	sender = dbus_message_get_sender(call_data->msg);

	source_reply = dbus_message_copy(reply);
	dbus_message_set_destination(source_reply, sender);
	dbus_message_set_no_reply(source_reply, TRUE);
	dbus_message_set_reply_serial(source_reply, dbus_message_get_serial(call_data->msg));

	send_message_and_unref(call_data->conn, source_reply);

	dbus_message_unref(reply);
	dbus_pending_call_unref(call);
}

static DBusHandlerResult get_connection_name(DBusConnection *conn,
						DBusMessage *msg, void *data)
{
	struct service_agent *agent = data;
	DBusMessage *reply;

	reply = dbus_message_new_method_return(msg);
	if (!reply)
		return DBUS_HANDLER_RESULT_NEED_MEMORY;

	dbus_message_append_args(reply,
			DBUS_TYPE_STRING, &agent->id,
			DBUS_TYPE_INVALID);

	return send_message_and_unref(conn, reply);
}

static DBusHandlerResult get_name(DBusConnection *conn,
					DBusMessage *msg, void *data)
{

	struct service_agent *agent = data;
	DBusMessage *reply;
	const char *name = "";

	reply = dbus_message_new_method_return(msg);
	if (!reply)
		return DBUS_HANDLER_RESULT_NEED_MEMORY;

	if (agent->name)
		name = agent->name;
	
	dbus_message_append_args(reply,
			DBUS_TYPE_STRING, &name,
			DBUS_TYPE_INVALID);

	return send_message_and_unref(conn, reply);
}

static DBusHandlerResult get_description(DBusConnection *conn,
						DBusMessage *msg, void *data)
{
	struct service_agent *agent = data;
	DBusMessage *reply;
	const char *description = "";

	reply = dbus_message_new_method_return(msg);
	if (!reply)
		return DBUS_HANDLER_RESULT_NEED_MEMORY;

	if (agent->description)
		description = agent->description;
	
	dbus_message_append_args(reply,
			DBUS_TYPE_STRING, &description,
			DBUS_TYPE_INVALID);

	return send_message_and_unref(conn, reply);
}

static void start_reply(DBusPendingCall *call, void *udata)
{
	struct service_call *call_data = udata;
	DBusMessage *agent_reply = dbus_pending_call_steal_reply(call);
	DBusMessage *source_reply;
	DBusError err;

	dbus_error_init(&err);
	if (dbus_set_error_from_message(&err, agent_reply)) {
		call_data->agent->running = SERVICE_NOT_RUNNING;
		dbus_error_free(&err);
		/* Forward the error to the requestor */
	} else {
		DBusMessage *message;

		if (register_agent_records(call_data->agent->records) < 0) {
			/* FIXME: define a better error name */
			source_reply = dbus_message_new_error(call_data->msg,
					ERROR_INTERFACE ".Failed", strerror(errno));
			goto fail;
		}

		call_data->agent->running = SERVICE_RUNNING;

		/* Send a signal to indicate that the service started properly */
		message = dbus_message_new_signal(dbus_message_get_path(call_data->msg),
							"org.bluez.Service",
							"Started");

		send_message_and_unref(call_data->conn, message);
	}

	/* Copy the service agent reply: error message or any reply content */
	source_reply = dbus_message_copy(agent_reply);
fail:
	dbus_message_set_destination(source_reply, dbus_message_get_sender(call_data->msg));
	dbus_message_set_no_reply(source_reply, TRUE);
	dbus_message_set_reply_serial(source_reply, dbus_message_get_serial(call_data->msg));

	send_message_and_unref(call_data->conn, source_reply);

	dbus_message_unref(agent_reply);
	dbus_pending_call_unref(call);
}

static DBusHandlerResult start(DBusConnection *conn,
				DBusMessage *msg, void *data)
{
	DBusPendingCall *pending;
	struct service_call *call_data;
	struct service_agent *agent  = data;
	DBusMessage *forward;

	if (agent->running)
		return error_failed(conn, msg, EPERM);

	forward = dbus_message_copy(msg);
	if (!forward)
		return DBUS_HANDLER_RESULT_NEED_MEMORY;

	dbus_message_set_destination(forward, agent->id);
	dbus_message_set_interface(forward, "org.bluez.ServiceAgent");
	dbus_message_set_path(forward, dbus_message_get_path(msg));

	call_data = service_call_new(conn, msg, agent);
	if (!call_data) {
		dbus_message_unref(forward);
		return DBUS_HANDLER_RESULT_NEED_MEMORY;
	}

	if (dbus_connection_send_with_reply(conn, forward, &pending, START_REPLY_TIMEOUT) == FALSE) {
		service_call_free(call_data);
		dbus_message_unref(forward);
		return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
	}

	dbus_pending_call_set_notify(pending, start_reply, call_data, service_call_free);
	dbus_message_unref(forward);

	return DBUS_HANDLER_RESULT_HANDLED;
}

static void stop_reply(DBusPendingCall *call, void *udata)
{
	struct service_call *call_data = udata;
	DBusMessage *agent_reply = dbus_pending_call_steal_reply(call);
	DBusMessage *source_reply;
	DBusError err;

	dbus_error_init(&err);
	if (dbus_set_error_from_message(&err, agent_reply)) {
		/* Keep the old running value */
		dbus_error_free(&err);
	} else {
		DBusMessage *message;
		call_data->agent->running = SERVICE_NOT_RUNNING;

		/* Send a signal to indicate that the service stopped properly */
		message = dbus_message_new_signal(dbus_message_get_path(call_data->msg),
							"org.bluez.Service",
							"Stopped");

		send_message_and_unref(call_data->conn, message);
		unregister_agent_records(call_data->agent->records);

	}

	source_reply = dbus_message_copy(agent_reply);
	dbus_message_set_destination(source_reply, dbus_message_get_sender(call_data->msg));
	dbus_message_set_no_reply(source_reply, TRUE);
	dbus_message_set_reply_serial(source_reply, dbus_message_get_serial(call_data->msg));

	send_message_and_unref(call_data->conn, source_reply);

	dbus_message_unref(agent_reply);
	dbus_pending_call_unref(call);
}

static DBusHandlerResult stop(DBusConnection *conn,
				DBusMessage *msg, void *data)
{
	DBusPendingCall *pending;
	struct service_call *call_data;
	struct service_agent *agent  = data;
	DBusMessage *forward;

	if (!agent->running)
		return error_failed(conn, msg, EPERM);

	forward = dbus_message_copy(msg);
	if (!forward)
		return DBUS_HANDLER_RESULT_NEED_MEMORY;

	dbus_message_set_destination(forward, agent->id);
	dbus_message_set_interface(forward, "org.bluez.ServiceAgent");
	dbus_message_set_path(forward, dbus_message_get_path(msg));

	call_data = service_call_new(conn, msg, agent);
	if (!call_data) {
		dbus_message_unref(forward);
		return DBUS_HANDLER_RESULT_NEED_MEMORY;
	}

	if (dbus_connection_send_with_reply(conn, forward, &pending, START_REPLY_TIMEOUT) == FALSE) {
		service_call_free(call_data);
		dbus_message_unref(forward);
		return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
	}

	dbus_pending_call_set_notify(pending, stop_reply, call_data, service_call_free);
	dbus_message_unref(forward);

	return DBUS_HANDLER_RESULT_HANDLED;
}

static DBusHandlerResult is_running(DBusConnection *conn,
					DBusMessage *msg, void *data)
{
	struct service_agent *agent = data;
	DBusMessage *reply;
	dbus_bool_t running;

	reply = dbus_message_new_method_return(msg);
	if (!reply)
		return DBUS_HANDLER_RESULT_NEED_MEMORY;

	running = (agent->running == SERVICE_RUNNING ? TRUE : FALSE);

	dbus_message_append_args(reply,
			DBUS_TYPE_BOOLEAN, &running,
			DBUS_TYPE_INVALID);

	return send_message_and_unref(conn, reply);
}

static DBusHandlerResult list_users(DBusConnection *conn,
					DBusMessage *msg, void *data)
{
	return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
}

static DBusHandlerResult remove_user(DBusConnection *conn,
					DBusMessage *msg, void *data)
{
	return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
}

static DBusHandlerResult set_trusted(DBusConnection *conn,
					DBusMessage *msg, void *data)
{
	struct service_agent *agent = data;
	GSList *l;
	DBusMessage *reply;
	const char *address;

	if (!dbus_message_get_args(msg, NULL,
			DBUS_TYPE_STRING, &address,
			DBUS_TYPE_INVALID))
		return error_invalid_arguments(conn, msg);

	if (check_address(address) < 0)
		return error_invalid_arguments(conn, msg);

	l = g_slist_find_custom(agent->trusted_devices, address, (GCompareFunc) strcasecmp);
	if (l)
		return error_trusted_device_already_exists(conn, msg);

	reply = dbus_message_new_method_return(msg);
	if (!reply)
		return DBUS_HANDLER_RESULT_NEED_MEMORY;

	agent->trusted_devices = g_slist_append(agent->trusted_devices, strdup(address));

	return send_message_and_unref(conn, reply);
}

static DBusHandlerResult is_trusted(DBusConnection *conn,
					DBusMessage *msg, void *data)
{
	struct service_agent *agent = data;
	GSList *l;
	DBusMessage *reply;
	const char *address;
	dbus_bool_t trusted;

	if (!dbus_message_get_args(msg, NULL,
			DBUS_TYPE_STRING, &address,
			DBUS_TYPE_INVALID))
		return error_invalid_arguments(conn, msg);

	l = g_slist_find_custom(agent->trusted_devices, address, (GCompareFunc) strcasecmp);
	trusted = (l? TRUE : FALSE);

	reply = dbus_message_new_method_return(msg);
	if (!reply)
		return DBUS_HANDLER_RESULT_NEED_MEMORY;

	dbus_message_append_args(msg,
				DBUS_TYPE_BOOLEAN, &trusted,
				DBUS_TYPE_INVALID);

	return send_message_and_unref(conn, reply);
}

static DBusHandlerResult remove_trust(DBusConnection *conn,
					DBusMessage *msg, void *data)
{
	struct service_agent *agent = data;
	GSList *l;
	DBusMessage *reply;
	const char *address;
	void *paddress;

	if (!dbus_message_get_args(msg, NULL,
			DBUS_TYPE_STRING, &address,
			DBUS_TYPE_INVALID))
		return error_invalid_arguments(conn, msg);

	l = g_slist_find_custom(agent->trusted_devices, address, (GCompareFunc) strcasecmp);
	if (!l)
		return error_trusted_device_does_not_exists(conn, msg);

	reply = dbus_message_new_method_return(msg);
	if (!reply)
		return DBUS_HANDLER_RESULT_NEED_MEMORY;

	paddress = l->data;
	agent->trusted_devices = g_slist_remove(agent->trusted_devices, l->data);
	free(paddress);

	return send_message_and_unref(conn, reply);
}

static struct service_data services_methods[] = {
	{ "GetName",		get_name		},
	{ "GetDescription",	get_description		},
	{ "GetConnectionName",	get_connection_name	},
	{ "Start",		start			},
	{ "Stop",		stop			},
	{ "IsRunning",		is_running		},
	{ "ListUsers",		list_users		},
	{ "RemoveUser",		remove_user		},
	{ "SetTrusted",		set_trusted		},
	{ "IsTrusted",		is_trusted		},
	{ "RemoveTrust",	remove_trust		},
	{ NULL, NULL }
};

static DBusHandlerResult msg_func_services(DBusConnection *conn,
					DBusMessage *msg, void *data)
{
	struct service_agent *agent = data;
	service_handler_func_t handler;
	DBusPendingCall *pending;
	DBusMessage *forward;
	struct service_call *call_data;
	const char *iface;

	if (!hcid_dbus_use_experimental())
		return error_unknown_method(conn, msg);

	iface = dbus_message_get_interface(msg);

	if (!strcmp(DBUS_INTERFACE_INTROSPECTABLE, iface) &&
			!strcmp("Introspect", dbus_message_get_member(msg))) {
		return simple_introspect(conn, msg, data);
	} else if (strcmp("org.bluez.Service", iface) == 0) {

		handler = find_service_handler(services_methods, msg);
		if (handler)
			return handler(conn, msg, data);

		forward = dbus_message_copy(msg);
		if(!forward)
			return DBUS_HANDLER_RESULT_NEED_MEMORY;

		dbus_message_set_destination(forward, agent->id);
		dbus_message_set_path(forward, dbus_message_get_path(msg));

		call_data = service_call_new(conn, msg, agent);
		if (!call_data) {
			dbus_message_unref(forward);
			return DBUS_HANDLER_RESULT_NEED_MEMORY;
		}

		if (dbus_connection_send_with_reply(conn, forward, &pending, -1) == FALSE) {
			service_call_free(call_data);
			dbus_message_unref(forward);
			return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
		}

		dbus_pending_call_set_notify(pending, forward_reply, call_data, service_call_free);

		dbus_message_unref(forward);

		return DBUS_HANDLER_RESULT_HANDLED;
	} else
		return error_unknown_method(conn, msg);
}

static const DBusObjectPathVTable services_vtable = {
	.message_function	= &msg_func_services,
	.unregister_function	= NULL
};

int register_service_agent(DBusConnection *conn, const char *sender,
				const char *path, const char *name, const char *description)
{
	struct service_agent *agent;
	GSList *l;

	debug("Registering service object: %s", path);

	/* Check if the name is already used? */
	agent = service_agent_new(sender, name, description);
	if (!agent)
		return -ENOMEM;

	l = g_slist_find_custom(services, path, (GCompareFunc) strcmp);
	if (l)
		return -EADDRNOTAVAIL;

	if (!dbus_connection_register_object_path(conn, path, &services_vtable, agent)) {
		free(agent);
		return -ENOMEM;
	}

	services = g_slist_append(services, strdup(path));

	name_listener_add(conn, sender, (name_cb_t) service_agent_exit, conn);

	return 0;
}

int unregister_service_agent(DBusConnection *conn, const char *sender, const char *path)
{
	struct service_agent *agent;
	GSList *l;

	debug("Unregistering service object: %s", path);

	if (dbus_connection_get_object_path_data(conn, path, (void *) &agent)) {
		/* No data assigned to this path or it is not the owner */
		if (!agent || strcmp(sender, agent->id))
			return -EPERM;

		if (agent->records)
			unregister_agent_records(agent->records);

		service_agent_free(agent);
	}

	if (!dbus_connection_unregister_object_path(conn, path))
		return -ENOMEM;

	name_listener_remove(conn, sender, (name_cb_t) service_agent_exit, conn);

	l = g_slist_find_custom(services, path, (GCompareFunc) strcmp);
	if (l) {
		void *p = l->data;
		services = g_slist_remove(services, l->data);
		free(p);
	}

	return 0;
}

void send_release(DBusConnection *conn, const char *id, const char *path)
{
	DBusMessage *msg;

	msg = dbus_message_new_method_call(id, path,
				"org.bluez.ServiceAgent", "Release");
	if (!msg)
		return;

	dbus_message_set_no_reply(msg, TRUE);
	send_message_and_unref(conn, msg);
}

void release_service_agents(DBusConnection *conn)
{
	GSList *l = services;
	struct service_agent *agent;
	const char *path;

	while (l) {
		path = l->data;

		l = l->next;

		if (dbus_connection_get_object_path_data(conn, path, (void *) &agent)) {
			if (!agent)
				continue;

			if (agent->records)
				unregister_agent_records(agent->records);

			send_release(conn, agent->id, path);
			service_agent_free(agent);
		}

		dbus_connection_unregister_object_path(conn, path);
	}

	g_slist_foreach(services, (GFunc) free, NULL);
	g_slist_free(services);
	services = NULL;
}

void append_available_services(DBusMessageIter *array_iter)
{
	GSList *l = services;
	const char *path;

	while (l) {
		path = l->data;
		dbus_message_iter_append_basic(array_iter,
					DBUS_TYPE_STRING, &path);
		l = l->next;
	}
}