src/ctm.c

/*
 *
 *  oFono - Open Source Telephony
 *
 *  Copyright (C) 2010  Nokia Corporation and/or its subsidiary(-ies).
 *  Copyright (C) 2011  Intel Corporation. All rights reserved.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 2 as
 *  published by the Free Software Foundation.
 *
 *  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 <string.h>
#include <stdio.h>
#include <errno.h>

#include <glib.h>
#include <gdbus.h>

#include "ofono.h"
#include "common.h"

#define CTM_FLAG_CACHED 0x1

static GSList *g_drivers = NULL;

struct ofono_ctm {
	DBusMessage *pending;
	int flags;
	ofono_bool_t enabled;
	const struct ofono_ctm_driver *driver;
	void *driver_data;
	struct ofono_atom *atom;
};

static DBusMessage *ctm_get_properties_reply(DBusMessage *msg,
						struct ofono_ctm *ctm)
{
	DBusMessage *reply;
	DBusMessageIter iter;
	DBusMessageIter dict;
	dbus_bool_t value;

	reply = dbus_message_new_method_return(msg);
	if (reply == NULL)
		return NULL;

	dbus_message_iter_init_append(reply, &iter);
	dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY,
					OFONO_PROPERTIES_ARRAY_SIGNATURE,
					&dict);

	value = ctm->enabled;
	ofono_dbus_dict_append(&dict, "Enabled", DBUS_TYPE_BOOLEAN, &value);
	dbus_message_iter_close_container(&iter, &dict);

	return reply;
}

static void ctm_signal_enabled(struct ofono_ctm *ctm)
{
	DBusConnection *conn = ofono_dbus_get_connection();
	const char *path = __ofono_atom_get_path(ctm->atom);
	ofono_bool_t value = ctm->enabled;

	ofono_dbus_signal_property_changed(conn, path,
						OFONO_TEXT_TELEPHONY_INTERFACE,
						"Enabled",
						DBUS_TYPE_BOOLEAN, &value);
}

static void ctm_set_enabled_callback(const struct ofono_error *error,
					void *data)
{
	struct ofono_ctm *ctm = data;
	DBusMessage *reply;

	if (error->type != OFONO_ERROR_TYPE_NO_ERROR) {
		DBG("Error setting ctm enabled property");

		reply = __ofono_error_failed(ctm->pending);
		__ofono_dbus_pending_reply(&ctm->pending, reply);

		return;
	}

	ctm->enabled = !ctm->enabled;

	reply = dbus_message_new_method_return(ctm->pending);
	__ofono_dbus_pending_reply(&ctm->pending, reply);

	ctm_signal_enabled(ctm);
}

static void ctm_query_enabled_callback(const struct ofono_error *error,
						ofono_bool_t enable, void *data)
{
	struct ofono_ctm *ctm = data;
	DBusMessage *reply;
	ofono_bool_t enabled_old;

	if (error->type != OFONO_ERROR_TYPE_NO_ERROR) {
		DBG("Error during ctm enabled query");

		reply = __ofono_error_failed(ctm->pending);
		__ofono_dbus_pending_reply(&ctm->pending, reply);

		return;
	}

	ctm->flags |= CTM_FLAG_CACHED;

	enabled_old = ctm->enabled;
	ctm->enabled = enable;

	reply = ctm_get_properties_reply(ctm->pending, ctm);
	__ofono_dbus_pending_reply(&ctm->pending, reply);

	if (ctm->enabled != enabled_old)
		ctm_signal_enabled(ctm);
}

static DBusMessage *ctm_get_properties(DBusConnection *conn,
						DBusMessage *msg, void *data)
{
	struct ofono_ctm *ctm = data;

	if (ctm->flags & CTM_FLAG_CACHED)
		return ctm_get_properties_reply(msg, ctm);

	if (ctm->pending)
		return __ofono_error_busy(msg);

	ctm->pending = dbus_message_ref(msg);

	ctm->driver->query_tty(ctm, ctm_query_enabled_callback, ctm);

	return NULL;
}

static DBusMessage *ctm_set_property(DBusConnection *conn, DBusMessage *msg,
					void *data)
{
	struct ofono_ctm *ctm = data;
	DBusMessageIter iter;
	DBusMessageIter var;
	const char *property;

	if (ctm->pending)
		return __ofono_error_busy(msg);

	if (!dbus_message_iter_init(msg, &iter))
		return __ofono_error_invalid_args(msg);

	if (dbus_message_iter_get_arg_type(&iter) != DBUS_TYPE_STRING)
		return __ofono_error_invalid_args(msg);

	dbus_message_iter_get_basic(&iter, &property);
	dbus_message_iter_next(&iter);

	if (dbus_message_iter_get_arg_type(&iter) != DBUS_TYPE_VARIANT)
		return __ofono_error_invalid_args(msg);

	dbus_message_iter_recurse(&iter, &var);

	if (g_strcmp0(property, "Enabled") == 0) {
		dbus_bool_t value;
		int target;

		if (dbus_message_iter_get_arg_type(&var) != DBUS_TYPE_BOOLEAN)
			return __ofono_error_invalid_args(msg);

		dbus_message_iter_get_basic(&var, &value);
		target = value;

		if (ctm->enabled == target)
			return dbus_message_new_method_return(msg);

		ctm->pending = dbus_message_ref(msg);

		ctm->driver->set_tty(ctm, target,
					ctm_set_enabled_callback, ctm);
		return NULL;
	}

	return __ofono_error_invalid_args(msg);
}

static const GDBusMethodTable ctm_methods[] = {
	{ GDBUS_ASYNC_METHOD("GetProperties",
			NULL, GDBUS_ARGS({ "properties", "a{sv}" }),
			ctm_get_properties) },
	{ GDBUS_ASYNC_METHOD("SetProperty",
			GDBUS_ARGS({ "property", "s" }, { "value", "v" }), NULL,
			ctm_set_property) },
	{ }
};

static const GDBusSignalTable ctm_signals[] = {
	{ GDBUS_SIGNAL("PropertyChanged",
			GDBUS_ARGS({ "name", "s" }, { "value", "v" })) },
	{ }
};

int ofono_ctm_driver_register(const struct ofono_ctm_driver *d)
{
	DBG("driver: %p, name: %s", d, d->name);

	if (d == NULL || d->probe == NULL)
		return -EINVAL;

	g_drivers = g_slist_prepend(g_drivers, (void *)d);

	return 0;
}

void ofono_ctm_driver_unregister(const struct ofono_ctm_driver *d)
{
	DBG("driver: %p, name: %s", d, d->name);

	if (d == NULL)
		return;

	g_drivers = g_slist_remove(g_drivers, (void *)d);
}

static void text_telephony_unregister(struct ofono_atom *atom)
{
	struct ofono_ctm *ctm = __ofono_atom_get_data(atom);
	const char *path = __ofono_atom_get_path(ctm->atom);
	DBusConnection *conn = ofono_dbus_get_connection();
	struct ofono_modem *modem = __ofono_atom_get_modem(ctm->atom);

	ofono_modem_remove_interface(modem, OFONO_TEXT_TELEPHONY_INTERFACE);
	g_dbus_unregister_interface(conn, path, OFONO_TEXT_TELEPHONY_INTERFACE);
}

static void text_telephony_remove(struct ofono_atom *atom)
{
	struct ofono_ctm *ctm = __ofono_atom_get_data(atom);

	DBG("atom: %p", atom);

	if (ctm == NULL)
		return;

	if (ctm->driver && ctm->driver->remove)
		ctm->driver->remove(ctm);

	g_free(ctm);
}

struct ofono_ctm *ofono_ctm_create(struct ofono_modem *modem,
					unsigned int vendor,
					const char *driver, void *data)
{
	struct ofono_ctm *ctm;
	GSList *l;

	if (driver == NULL)
		return NULL;

	ctm = g_try_new0(struct ofono_ctm, 1);
	if (ctm == NULL)
		return NULL;

	ctm->atom = __ofono_modem_add_atom(modem, OFONO_ATOM_TYPE_CTM,
						text_telephony_remove, ctm);

	for (l = g_drivers; l; l = l->next) {
		const struct ofono_ctm_driver *drv = l->data;

		if (g_strcmp0(drv->name, driver) != 0)
			continue;

		if (drv->probe(ctm, vendor, data) < 0)
			continue;

		ctm->driver = drv;
		break;
	}

	return ctm;
}

void ofono_ctm_register(struct ofono_ctm *ctm)
{
	DBusConnection *conn = ofono_dbus_get_connection();
	struct ofono_modem *modem = __ofono_atom_get_modem(ctm->atom);
	const char *path = __ofono_atom_get_path(ctm->atom);

	if (!g_dbus_register_interface(conn, path,
					OFONO_TEXT_TELEPHONY_INTERFACE,
					ctm_methods, ctm_signals,
					NULL, ctm, NULL)) {
		ofono_error("Could not create %s interface",
				OFONO_TEXT_TELEPHONY_INTERFACE);

		return;
	}

	ofono_modem_add_interface(modem, OFONO_TEXT_TELEPHONY_INTERFACE);
	__ofono_atom_register(ctm->atom, text_telephony_unregister);
}

void ofono_ctm_remove(struct ofono_ctm *ctm)
{
	__ofono_atom_free(ctm->atom);
}

void ofono_ctm_set_data(struct ofono_ctm *ctm, void *data)
{
	ctm->driver_data = data;
}

void *ofono_ctm_get_data(struct ofono_ctm *ctm)
{
	return ctm->driver_data;
}