Merge lp:~awe/phablet-extras/ofono-nettime-plugin into lp:phablet-extras/ofono

[Tony Espy]

Added network time plugin which exposes RILD NITZ messages over DBus.

Add network time plugin.

This can be tested using a new test script get-network-time and modification to monitor-ofono.

[Tony Espy (awe)]

Note, as I'm going to have to re-merge once the IMEI MR lands, I'll deal with the changelog at the same time...

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:43
http://jenkins.qa.ubuntu.com/job/phablet-extras-ofono-ci/40/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-extras-ofono-saucy-armhf-ci/15
        deb: http://jenkins.qa.ubuntu.com/job/phablet-extras-ofono-saucy-armhf-ci/15/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins:8080/job/phablet-extras-ofono-ci/40/rebuild

review: Approve (continuous-integration)

[lp:~awe/phablet-extras/ofono-nettime-plugin]

44. By Tony Espy on 2013-06-25

Re-merge from trunk.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:44
http://jenkins.qa.ubuntu.com/job/phablet-extras-ofono-ci/45/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-extras-ofono-saucy-armhf-ci/20
        deb: http://jenkins.qa.ubuntu.com/job/phablet-extras-ofono-saucy-armhf-ci/20/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins:8080/job/phablet-extras-ofono-ci/45/rebuild

review: Approve (continuous-integration)

[Ricardo Salveti (rsalveti)]

476 + for member in ["NetworkTimeReceived"]:

This should be NetworkTimeChanged instead.

Other than that, code looks good.

review: Needs Fixing

[lp:~awe/phablet-extras/ofono-nettime-plugin]

45. By Tony Espy on 2013-06-26

[nettime] Fix NetworkTimeChanged signal in test/monitor-ofono.

[Tony Espy (awe)]

Nice catch... fixed.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:45
http://jenkins.qa.ubuntu.com/job/phablet-extras-ofono-ci/46/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-extras-ofono-saucy-armhf-ci/21
        deb: http://jenkins.qa.ubuntu.com/job/phablet-extras-ofono-saucy-armhf-ci/21/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins:8080/job/phablet-extras-ofono-ci/46/rebuild

review: Approve (continuous-integration)

[lp:~awe/phablet-extras/ofono-nettime-plugin]

46. By Tony Espy on 2013-06-26

Re-merge from trunk.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:46
http://jenkins.qa.ubuntu.com/job/phablet-extras-ofono-ci/48/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-extras-ofono-saucy-armhf-ci/23
        deb: http://jenkins.qa.ubuntu.com/job/phablet-extras-ofono-saucy-armhf-ci/23/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins:8080/job/phablet-extras-ofono-ci/48/rebuild

review: Approve (continuous-integration)

[Ricardo Salveti (rsalveti)]

Good.

review: Approve

=== modified file 'Makefile.am'
--- Makefile.am	2013-04-12 20:04:45 +0000
+++ Makefile.am	2013-06-26 17:26:23 +0000
@@ -466,6 +466,11 @@
 endif
 endif
 
+if NETTIME
+builtin_modules += nettime
+builtin_sources += plugins/nettime.c
+endif
+
 if PROVISION
 builtin_sources += plugins/mbpi.h plugins/mbpi.c
 
 
=== modified file 'configure.ac'
--- configure.ac	2013-03-28 12:50:26 +0000
+++ configure.ac	2013-06-26 17:26:23 +0000
@@ -188,6 +188,11 @@
 AC_SUBST(BLUEZ_LIBS)
 AM_CONDITIONAL(BLUETOOTH, test "${enable_bluetooth}" != "no")
 
+AC_ARG_ENABLE(nettime, AC_HELP_STRING([--disable-nettime],
+                                [disable Nettime plugin]),
+                                        [enable_nettime=${enableval}])
+AM_CONDITIONAL(NETTIME, test "${enable_netttime}" != "no")
+
 AC_ARG_WITH([provisiondb], AC_HELP_STRING([--with-provisiondb=FILE],
 	[location of provision database]), [path_provisiondb=${withval}])
 
 
=== modified file 'debian/changelog'
--- debian/changelog	2013-06-26 15:49:07 +0000
+++ debian/changelog	2013-06-26 17:26:23 +0000
@@ -1,7 +1,11 @@
-ofono (1.12phablet7) UNRELEASED; urgency=low
+ofono (1.12phablet7) saucy; urgency=low
 
+  [ Tony Espy ]
   * gril/gril.c: Exit on RILD socket failures.
 
+  [ Petri M. Gerdt <[e-mail]> ]
+  * plugins/nettime.c: Added nettime plugin.
+
  -- Tony Espy <[e-mail]>  Tue, 25 Jun 2013 15:14:13 -0400
 
 ofono (1.12phablet6) saucy; urgency=low
 
=== modified file 'include/dbus.h'
--- include/dbus.h	2012-08-22 19:59:08 +0000
+++ include/dbus.h	2013-06-26 17:26:23 +0000
@@ -59,6 +59,7 @@
 #define OFONO_GNSS_INTERFACE "org.ofono.AssistedSatelliteNavigation"
 #define OFONO_GNSS_POSR_AGENT_INTERFACE "org.ofono.PositioningRequestAgent"
 #define OFONO_HANDSFREE_INTERFACE OFONO_SERVICE ".Handsfree"
+#define OFONO_NETWORK_TIME_INTERFACE OFONO_SERVICE ".NetworkTime"
 
 /* CDMA Interfaces */
 #define OFONO_CDMA_VOICECALL_MANAGER_INTERFACE "org.ofono.cdma.VoiceCallManager"
 
=== added file 'plugins/nettime.c'
--- plugins/nettime.c	1970-01-01 00:00:00 +0000
+++ plugins/nettime.c	2013-06-26 17:26:23 +0000
@@ -0,0 +1,274 @@
+/*
+ *
+ *  oFono - Open Source Telephony
+ *
+ *  Copyright (C) 2012-2013  Jolla Ltd.
+ *
+ *  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 <glib.h>
+#include <gdbus.h>
+
+#define OFONO_API_SUBJECT_TO_CHANGE
+#include <ofono/plugin.h>
+#include <ofono/log.h>
+#include <ofono/nettime.h>
+#include <ofono/types.h>
+
+#include "ofono.h"
+
+#include "common.h"
+
+struct nt_data {
+	gboolean time_available;
+	gboolean time_pending;
+
+	time_t nw_time_utc;
+	time_t received;
+
+	int dst;
+	int time_zone;
+
+	const char *mcc;
+	const char *mnc;
+	const char *path;
+};
+
+static struct nt_data *ntd = NULL;
+
+
+static void init_time(void)
+{
+	ntd = g_new0(struct nt_data, 1);
+
+	ntd->time_available = FALSE;
+	ntd->time_pending = FALSE;
+	ntd->dst = 0;
+	ntd->time_zone = 0;
+}
+
+static gboolean encode_time_format(const struct ofono_network_time *time,
+				 struct tm *tm)
+{
+	if (time->year < 0)
+		return FALSE;
+
+	memset(tm, 0, sizeof(struct tm));
+	tm->tm_year = time->year - 1900;
+	tm->tm_mon = time->mon - 1;
+	tm->tm_mday = time->mday;
+	tm->tm_hour = time->hour;
+	tm->tm_min = time->min;
+	tm->tm_sec = time->sec;
+	tm->tm_gmtoff = time->utcoff;
+	tm->tm_isdst = time->dst;
+
+	return TRUE;
+}
+
+static time_t get_monotonic_time()
+{
+	struct timespec ts;
+	clock_gettime(CLOCK_MONOTONIC, &ts);
+	return ts.tv_sec;
+}
+
+static int fill_time_notification(DBusMessage *msg,
+					struct nt_data *ntd)
+{
+	DBusMessageIter iter, iter_array;
+	dbus_int64_t utc_long, received;
+	dbus_int32_t dst, timezone;
+	dbus_message_iter_init_append(msg, &iter);
+	dbus_message_iter_open_container(&iter,	DBUS_TYPE_ARRAY,
+						"{sv}",
+						&iter_array);
+	if (ntd->time_pending) {
+		if (ntd->time_available) {
+			utc_long = (dbus_int64_t) ntd->nw_time_utc;
+			ofono_dbus_dict_append(&iter_array,
+						"UTC",
+						DBUS_TYPE_INT64,
+						&utc_long);
+			dst = (dbus_int32_t) ntd->dst;
+			ofono_dbus_dict_append(&iter_array,
+						"DST",
+						DBUS_TYPE_UINT32,
+						&dst);
+			received = (dbus_int64_t) ntd->received;
+			ofono_dbus_dict_append(&iter_array,
+						"Received",
+						DBUS_TYPE_INT64,
+						&received);
+		}
+
+		timezone = (dbus_int32_t) ntd->time_zone;
+		ofono_dbus_dict_append(&iter_array,
+					"Timezone",
+					DBUS_TYPE_INT32,
+					&timezone);
+
+		ofono_dbus_dict_append(&iter_array,
+					"MobileCountryCode",
+					DBUS_TYPE_STRING,
+					&ntd->mcc);
+
+		ofono_dbus_dict_append(&iter_array,
+					"MobileNetworkCode",
+					DBUS_TYPE_STRING,
+					&ntd->mnc);
+	} else {
+		DBG("fill_time_notification: time not available");
+	}
+
+	dbus_message_iter_close_container(&iter, &iter_array);
+	return 0;
+}
+
+static DBusMessage *get_network_time(DBusConnection *conn,
+						DBusMessage *msg, void *data)
+{
+	DBusMessage *reply;
+
+	reply = dbus_message_new_method_return(msg);
+	if (reply == NULL)
+		return NULL;
+	fill_time_notification(reply, ntd);
+	return reply;
+}
+
+static const GDBusMethodTable nettime_methods[] = {
+	{ GDBUS_METHOD("GetNetworkTime",
+			NULL, GDBUS_ARGS({ "time", "a{sv}" }),
+			get_network_time) },
+	{ }
+};
+
+static const GDBusSignalTable nettime_signals[] = {
+	{ GDBUS_SIGNAL("NetworkTimeChanged",
+			GDBUS_ARGS({ "time", "a{sv}" })) },
+	{ }
+};
+
+static int nettime_probe(struct ofono_nettime_context *context)
+{
+	DBusConnection *conn = ofono_dbus_get_connection();
+	const char *path = ofono_modem_get_path(context->modem);
+	DBG("Network time probe for modem: %p (%s)", context->modem, path);
+	init_time();
+	if (!g_dbus_register_interface(conn, path,
+					OFONO_NETWORK_TIME_INTERFACE, // name
+					nettime_methods, // methods
+					nettime_signals, // signals
+					NULL, // GDBusPropertyTable *properties
+					NULL, // user data
+					NULL)) { // GDBusDestroyFunction destroy
+		ofono_error("Networkt time: Could not register interface %s, path %s",
+				OFONO_NETWORK_TIME_INTERFACE, path);
+		return 1;
+	} else {
+		ofono_info("Network time: Registered inteface %s, path %s",
+				OFONO_NETWORK_TIME_INTERFACE, path);
+	}
+
+	ofono_modem_add_interface(context->modem, OFONO_NETWORK_TIME_INTERFACE);
+	return 0;
+}
+
+static void nettime_remove(struct ofono_nettime_context *context)
+{
+	DBusConnection *conn = ofono_dbus_get_connection();
+	const char *path = ofono_modem_get_path(context->modem);
+	DBG("Network time remove for modem: %p (%s)", context->modem, path);
+	if (!g_dbus_unregister_interface(conn, path, OFONO_NETWORK_TIME_INTERFACE)) {
+		ofono_error("Network time: could not unregister interface %s, path %s",
+				OFONO_NETWORK_TIME_INTERFACE, path);
+	}
+
+	ofono_modem_remove_interface(context->modem, OFONO_NETWORK_TIME_INTERFACE);
+	g_free(ntd);
+}
+
+static void send_signal(struct nt_data *ntd)
+{
+	DBusConnection *conn = ofono_dbus_get_connection();
+	DBusMessage *signal = dbus_message_new_signal(ntd->path,
+							OFONO_NETWORK_TIME_INTERFACE,
+							"NetworkTimeChanged");
+	fill_time_notification(signal, ntd);
+	g_dbus_send_message(conn, signal);
+}
+
+static void nettime_info_received(struct ofono_nettime_context *context,
+					struct ofono_network_time *info)
+{
+	struct ofono_netreg *netreg;
+	struct tm t;
+
+	if (info == NULL)
+		return;
+
+	netreg = __ofono_atom_get_data(__ofono_modem_find_atom(
+						context->modem, OFONO_ATOM_TYPE_NETREG));
+	ntd->path = ofono_modem_get_path(context->modem);
+	ntd->mcc = ofono_netreg_get_mcc(netreg);
+	ntd->mnc = ofono_netreg_get_mnc(netreg);
+	ntd->received = get_monotonic_time();
+	ntd->time_pending = TRUE;
+	ntd->dst = info->dst;
+	ntd->time_zone = info->utcoff;
+
+	ntd->time_available = encode_time_format(info, &t);
+	if (ntd->time_available == TRUE)
+		ntd->nw_time_utc = timegm(&t);
+
+	send_signal(ntd);
+	DBG("modem: %p (%s)", context->modem, ofono_modem_get_path(context->modem));
+	DBG("time: %04d-%02d-%02d %02d:%02d:%02d%c%02d:%02d (DST=%d)",
+		info->year, info->mon, info->mday, info->hour,
+		info->min, info->sec, info->utcoff > 0 ? '+' : '-',
+		abs(info->utcoff) / 3600, (abs(info->utcoff) % 3600) / 60,
+		info->dst);
+	DBG("UTC timestamp: %li, Received (monotonic time): %li",
+		ntd->nw_time_utc, ntd->received);
+	DBG("MCC: %s, MNC: %s", ntd->mcc, ntd->mnc);
+}
+
+static struct ofono_nettime_driver driver = {
+	.name		= "Network Time",
+	.probe		= nettime_probe,
+	.remove		= nettime_remove,
+	.info_received	= nettime_info_received,
+};
+
+static int nettime_init(void)
+{
+	return ofono_nettime_driver_register(&driver);
+}
+
+static void nettime_exit(void)
+{
+	ofono_nettime_driver_unregister(&driver);
+}
+
+OFONO_PLUGIN_DEFINE(nettime, "Network Time Plugin",
+			VERSION, OFONO_PLUGIN_PRIORITY_DEFAULT,
+			nettime_init, nettime_exit)
 
=== added file 'test/get-network-time'
--- test/get-network-time	1970-01-01 00:00:00 +0000
+++ test/get-network-time	2013-06-26 17:26:23 +0000
@@ -0,0 +1,69 @@
+#!/usr/bin/python
+
+import dbus
+import sys
+_dbus2py = {
+	dbus.String : unicode,
+	dbus.UInt32 : int,
+	dbus.Int32 : int,
+	dbus.Int16 : int,
+	dbus.UInt16 : int,
+	dbus.UInt64 : int,
+	dbus.Int64 : int,
+	dbus.Byte : int,
+	dbus.Boolean : bool,
+	dbus.ByteArray : str,
+	dbus.ObjectPath : str
+    }
+
+def dbus2py(d):
+	t = type(d)
+	if t in _dbus2py:
+		return _dbus2py[t](d)
+	if t is dbus.Dictionary:
+		return dict([(dbus2py(k), dbus2py(v)) for k, v in d.items()])
+	if t is dbus.Array and d.signature == "y":
+		return "".join([chr(b) for b in d])
+	if t is dbus.Array or t is list:
+		return [dbus2py(v) for v in d]
+	if t is dbus.Struct or t is tuple:
+		return tuple([dbus2py(v) for v in d])
+	return d
+
+def pretty(d):
+	d = dbus2py(d)
+	t = type(d)
+
+	if t in (dict, tuple, list) and len(d) > 0:
+		if t is dict:
+			d = ", ".join(["%s = %s" % (k, pretty(v))
+					for k, v in d.items()])
+			return "{ %s }" % d
+
+		d = " ".join([pretty(e) for e in d])
+
+		if t is tuple:
+			return "( %s )" % d
+
+	if t is str:
+		return "%s" % d
+
+	return str(d)
+
+bus = dbus.SystemBus()
+
+manager = dbus.Interface(bus.get_object("org.ofono", "/"),
+							"org.ofono.Manager")
+
+modems = manager.GetModems()
+
+for path, properties in modems:
+	if "org.ofono.NetworkTime" in properties["Interfaces"]:
+		break
+
+net_time = dbus.Interface(bus.get_object('org.ofono', path),
+				'org.ofono.NetworkTime')
+
+time = net_time.GetNetworkTime()
+
+print pretty(time)
 
=== modified file 'test/monitor-ofono'
--- test/monitor-ofono	2013-01-28 16:25:32 +0000
+++ test/monitor-ofono	2013-06-26 17:26:23 +0000
@@ -74,6 +74,10 @@
 	print "{%s} [%s] %s %s (%s)" % (iface, path, member,
 					msg, pretty(args))
 
+def network_time_changed(time, member, path, interface):
+	iface = interface[interface.rfind(".") + 1:]
+	print "{%s} [%s] %s %s" % (iface, path, member, pretty(time))
+
 def ussd(msg, member, path, interface):
 	iface = interface[interface.rfind(".") + 1:]
 	print "{%s} [%s] %s %s" % (iface, path, member, msg)
@@ -150,5 +154,13 @@
 					path_keyword="path",
 					interface_keyword="interface")
 
+	for member in ["NetworkTimeChanged"]:
+		bus.add_signal_receiver(network_time_changed,
+					bus_name="org.ofono",
+					signal_name = member,
+					member_keyword="member",
+					path_keyword="path",
+					interface_keyword="interface")
+
 	mainloop = gobject.MainLoop()
 	mainloop.run()