[telepathy-mission-control/master] fd.o #22169: allow PreferredHandler to be empty when requesting a channel

Simon McVittie simon.mcvittie at collabora.co.uk
Wed Jun 10 04:20:00 PDT 2009


---
 src/mcd-dispatcher.c                               |   35 +++--
 test/twisted/Makefile.am                           |    1 +
 .../dispatcher/create-no-preferred-handler.py      |  170 ++++++++++++++++++++
 3 files changed, 192 insertions(+), 14 deletions(-)
 create mode 100644 test/twisted/dispatcher/create-no-preferred-handler.py

diff --git a/src/mcd-dispatcher.c b/src/mcd-dispatcher.c
index 64c6fb6..d9539a5 100644
--- a/src/mcd-dispatcher.c
+++ b/src/mcd-dispatcher.c
@@ -3534,6 +3534,10 @@ dispatcher_request_channel (McdDispatcher *self,
     GError *error = NULL;
     const gchar *path;
 
+    g_return_if_fail (account_path != NULL);
+    g_return_if_fail (requested_properties != NULL);
+    g_return_if_fail (preferred_handler != NULL);
+
     g_object_get (self->priv->master,
                   "account-manager", &am,
                   NULL);
@@ -3550,22 +3554,25 @@ dispatcher_request_channel (McdDispatcher *self,
         goto despair;
     }
 
-    if (!tp_dbus_check_valid_bus_name (preferred_handler,
-                                       TP_DBUS_NAME_TYPE_WELL_KNOWN,
-                                       &error))
+    if (preferred_handler[0] != '\0')
     {
-        /* The error is TP_DBUS_ERROR_INVALID_BUS_NAME, which has no D-Bus
-         * representation; re-map to InvalidArgument. */
-        error->domain = TP_ERRORS;
-        error->code = TP_ERROR_INVALID_ARGUMENT;
-        goto despair;
-    }
+        if (!tp_dbus_check_valid_bus_name (preferred_handler,
+                                           TP_DBUS_NAME_TYPE_WELL_KNOWN,
+                                           &error))
+        {
+            /* The error is TP_DBUS_ERROR_INVALID_BUS_NAME, which has no D-Bus
+             * representation; re-map to InvalidArgument. */
+            error->domain = TP_ERRORS;
+            error->code = TP_ERROR_INVALID_ARGUMENT;
+            goto despair;
+        }
 
-    if (!g_str_has_prefix (preferred_handler, MC_CLIENT_BUS_NAME_BASE))
-    {
-        g_set_error (&error, TP_ERRORS, TP_ERROR_INVALID_ARGUMENT,
-                     "Not a Telepathy Client: %s", preferred_handler);
-        goto despair;
+        if (!g_str_has_prefix (preferred_handler, MC_CLIENT_BUS_NAME_BASE))
+        {
+            g_set_error (&error, TP_ERRORS, TP_ERROR_INVALID_ARGUMENT,
+                         "Not a Telepathy Client: %s", preferred_handler);
+            goto despair;
+        }
     }
 
     channel = _mcd_account_create_request (account, requested_properties,
diff --git a/test/twisted/Makefile.am b/test/twisted/Makefile.am
index fff7a97..54f56fb 100644
--- a/test/twisted/Makefile.am
+++ b/test/twisted/Makefile.am
@@ -21,6 +21,7 @@ TWISTED_BASIC_TESTS = \
 	dispatcher/cancel.py \
 	dispatcher/capture-bundle.py \
 	dispatcher/create-handler-fails.py \
+	dispatcher/create-no-preferred-handler.py \
 	dispatcher/create-text.py \
 	dispatcher/dispatch-activatable.py \
 	dispatcher/dispatch-obsolete.py \
diff --git a/test/twisted/dispatcher/create-no-preferred-handler.py b/test/twisted/dispatcher/create-no-preferred-handler.py
new file mode 100644
index 0000000..44e45f1
--- /dev/null
+++ b/test/twisted/dispatcher/create-no-preferred-handler.py
@@ -0,0 +1,170 @@
+"""Regression test for https://bugs.freedesktop.org/show_bug.cgi?id=22169
+"""
+
+import dbus
+import dbus.service
+
+from servicetest import EventPattern, tp_name_prefix, tp_path_prefix, \
+        call_async
+from mctest import exec_test, SimulatedConnection, SimulatedClient, \
+        create_fakecm_account, enable_fakecm_account, SimulatedChannel, \
+        expect_client_setup
+import constants as cs
+
+def test(q, bus, mc):
+    params = dbus.Dictionary({"account": "someguy at example.com",
+        "password": "secrecy"}, signature='sv')
+    cm_name_ref, account = create_fakecm_account(q, bus, mc, params)
+    conn = enable_fakecm_account(q, bus, mc, account, params)
+
+    text_fixed_properties = dbus.Dictionary({
+        cs.CHANNEL + '.TargetHandleType': cs.HT_CONTACT,
+        cs.CHANNEL + '.ChannelType': cs.CHANNEL_TYPE_TEXT,
+        }, signature='sv')
+
+    client = SimulatedClient(q, bus, 'Empathy',
+            observe=[text_fixed_properties], approve=[text_fixed_properties],
+            handle=[text_fixed_properties], bypass_approval=False)
+
+    # No Approver should be invoked at any point during this test, because the
+    # Channel was Requested
+    def fail_on_approval(e):
+        raise AssertionError('Approver should not be invoked')
+    q.add_dbus_method_impl(fail_on_approval, path=client.object_path,
+            interface=cs.APPROVER, method='AddDispatchOperation')
+
+    # wait for MC to download the properties
+    expect_client_setup(q, [client])
+
+    test_channel_creation(q, bus, account, client, conn, False)
+    test_channel_creation(q, bus, account, client, conn, True)
+
+def test_channel_creation(q, bus, account, client, conn, ensure):
+    user_action_time = dbus.Int64(1238582606)
+
+    cd = bus.get_object(cs.CD, cs.CD_PATH)
+    cd_props = dbus.Interface(cd, cs.PROPERTIES_IFACE)
+
+    # chat UI calls ChannelDispatcher.EnsureChannel or CreateChannel
+    request = dbus.Dictionary({
+            cs.CHANNEL + '.ChannelType': cs.CHANNEL_TYPE_TEXT,
+            cs.CHANNEL + '.TargetHandleType': cs.HT_CONTACT,
+            cs.CHANNEL + '.TargetID': 'juliet',
+            }, signature='sv')
+    account_requests = dbus.Interface(account,
+            cs.ACCOUNT_IFACE_NOKIA_REQUESTS)
+    call_async(q, cd,
+            (ensure and 'EnsureChannel' or 'CreateChannel'),
+            account.object_path, request, user_action_time, "",
+            dbus_interface=cs.CD)
+    ret = q.expect('dbus-return',
+            method=(ensure and 'EnsureChannel' or 'CreateChannel'))
+    request_path = ret.value[0]
+
+    # chat UI connects to signals and calls ChannelRequest.Proceed()
+
+    cr = bus.get_object(cs.AM, request_path)
+    request_props = cr.GetAll(cs.CR, dbus_interface=cs.PROPERTIES_IFACE)
+    assert request_props['Account'] == account.object_path
+    assert request_props['Requests'] == [request]
+    assert request_props['UserActionTime'] == user_action_time
+    assert request_props['PreferredHandler'] == ""
+    assert request_props['Interfaces'] == []
+
+    cr.Proceed(dbus_interface=cs.CR)
+
+    # FIXME: should the EnsureChannel/CreateChannel call, and the AddRequest
+    # call, be in a defined order? Probably not though, since CMs and Clients
+    # aren't meant to be the same process!
+
+    cm_request_call, add_request_call = q.expect_many(
+            EventPattern('dbus-method-call',
+                interface=cs.CONN_IFACE_REQUESTS,
+                method=(ensure and 'EnsureChannel' or 'CreateChannel'),
+                path=conn.object_path, args=[request], handled=False),
+            EventPattern('dbus-method-call', handled=False,
+                interface=cs.CLIENT_IFACE_REQUESTS,
+                method='AddRequest', path=client.object_path),
+            )
+
+    assert add_request_call.args[0] == request_path
+    request_props = add_request_call.args[1]
+    assert request_props[cs.CR + '.Account'] == account.object_path
+    assert request_props[cs.CR + '.Requests'] == [request]
+    assert request_props[cs.CR + '.UserActionTime'] == user_action_time
+    assert request_props[cs.CR + '.PreferredHandler'] == ""
+    assert request_props[cs.CR + '.Interfaces'] == []
+
+    q.dbus_return(add_request_call.message, signature='')
+
+    # Time passes. A channel is returned.
+
+    channel_immutable = dbus.Dictionary(request)
+    channel_immutable[cs.CHANNEL + '.InitiatorID'] = conn.self_ident
+    channel_immutable[cs.CHANNEL + '.InitiatorHandle'] = conn.self_handle
+    channel_immutable[cs.CHANNEL + '.Requested'] = True
+    channel_immutable[cs.CHANNEL + '.Interfaces'] = \
+        dbus.Array([], signature='s')
+    channel_immutable[cs.CHANNEL + '.TargetHandle'] = \
+        conn.ensure_handle(cs.HT_CONTACT, 'juliet')
+    channel = SimulatedChannel(conn, channel_immutable)
+
+    # this order of events is guaranteed by telepathy-spec (since 0.17.14)
+    if ensure:
+        q.dbus_return(cm_request_call.message, True, # <- Yours
+                channel.object_path, channel.immutable, signature='boa{sv}')
+    else:   # Create
+        q.dbus_return(cm_request_call.message,
+                channel.object_path, channel.immutable, signature='oa{sv}')
+    channel.announce()
+
+    # Observer should get told, processing waits for it
+    e = q.expect('dbus-method-call',
+            path=client.object_path,
+            interface=cs.OBSERVER, method='ObserveChannels',
+            handled=False)
+    assert e.args[0] == account.object_path, e.args
+    assert e.args[1] == conn.object_path, e.args
+    assert e.args[3] == '/', e.args         # no dispatch operation
+    assert e.args[4] == [request_path], e.args
+    channels = e.args[2]
+    assert len(channels) == 1, channels
+    assert channels[0][0] == channel.object_path, channels
+    assert channels[0][1] == channel_immutable, channels
+
+    # Observer says "OK, go"
+    q.dbus_return(e.message, signature='')
+
+    # Handler is next
+    e = q.expect('dbus-method-call',
+            path=client.object_path,
+            interface=cs.HANDLER, method='HandleChannels',
+            handled=False)
+    assert e.args[0] == account.object_path, e.args
+    assert e.args[1] == conn.object_path, e.args
+    channels = e.args[2]
+    assert len(channels) == 1, channels
+    assert channels[0][0] == channel.object_path, channels
+    assert channels[0][1] == channel_immutable, channels
+    assert e.args[3] == [request_path], e.args
+    assert e.args[4] == user_action_time
+    assert isinstance(e.args[5], dict)
+    assert len(e.args) == 6
+
+    # Handler accepts the Channels
+    q.dbus_return(e.message, signature='')
+
+    # CR emits Succeeded (or in Mardy's version, Account emits Succeeded)
+    q.expect_many(
+            EventPattern('dbus-signal', path=account.object_path,
+                interface=cs.ACCOUNT_IFACE_NOKIA_REQUESTS, signal='Succeeded',
+                args=[request_path]),
+            EventPattern('dbus-signal', path=request_path,
+                interface=cs.CR, signal='Succeeded'),
+            )
+
+    # Close the channel
+    channel.close()
+
+if __name__ == '__main__':
+    exec_test(test, {})
-- 
1.5.6.5



More information about the telepathy-commits mailing list