[Telepathy-commits] [telepathy-doc/master] Example using the Messages interface

[Davyd Madeley]

---
 docs/examples/python_iface_messaging/example.py |  176 +++++++++++++++++++++++
 1 files changed, 176 insertions(+), 0 deletions(-)
 create mode 100755 docs/examples/python_iface_messaging/example.py

diff --git a/docs/examples/python_iface_messaging/example.py b/docs/examples/python_iface_messaging/example.py
new file mode 100755
index 0000000..136ffee
--- /dev/null
+++ b/docs/examples/python_iface_messaging/example.py
@@ -0,0 +1,176 @@
+#!/usr/bin/env python
+
+import sys
+
+import gobject
+import dbus.mainloop.glib
+dbus.mainloop.glib.DBusGMainLoop(set_as_default = True)
+
+import telepathy
+import telepathy.client
+from telepathy.interfaces import CONNECTION_MANAGER, \
+                                 CONNECTION, \
+                                 CONNECTION_INTERFACE_REQUESTS, \
+                                 CHANNEL, \
+                                 CHANNEL_TYPE_TEXT, \
+                                 CHANNEL_INTERFACE_MESSAGES, \
+                                 CHANNEL_INTERFACE_GROUP
+from telepathy.constants import CONNECTION_STATUS_CONNECTED, \
+                                CONNECTION_STATUS_DISCONNECTED, \
+                                HANDLE_TYPE_CONTACT
+
+DBUS_PROPERTIES = 'org.freedesktop.DBus.Properties'
+
+class EnsureChannel (object):
+    def __init__ (self, parent, channel_type, handle_type, target_id,
+                  reply_handler, error_handler = None):
+        self.parent = parent
+        self.conn = conn = parent.conn
+        self._reply_handler = reply_handler
+
+        if error_handler is None: error_handler = self.parent.error_cb
+
+        conn[CONNECTION_INTERFACE_REQUESTS].EnsureChannel({
+            CHANNEL + '.ChannelType'     : channel_type,
+            CHANNEL + '.TargetHandleType': handle_type,
+            CHANNEL + '.TargetID'        : target_id,
+            },
+            reply_handler = self.ensure_channel_cb,
+            error_handler = error_handler)
+
+    def ensure_channel_cb (self, yours, path, properties):
+        self.channel = telepathy.client.Channel (self.conn.service_name,
+                                                 path)
+
+        self._reply_handler (yours, self.channel, properties)
+
+class TextChannel (EnsureChannel):
+    def __init__ (self, parent, handle_type, target_id):
+        super (TextChannel, self).__init__ (parent,
+                                            CHANNEL_TYPE_TEXT,
+                                            handle_type, target_id,
+                                            self.channel_cb)
+
+    def channel_cb (self, yours, channel, properties):
+        # get the interfaces on this channel
+        channel[DBUS_PROPERTIES].Get(CHANNEL, 'Interfaces',
+                                     reply_handler = self.interfaces_cb,
+                                     error_handler = self.parent.error_cb)
+
+    def interfaces_cb (self, interfaces):
+        channel = self.channel
+
+        print "Channel Interfaces:"
+        for interface in interfaces:
+            print " - %s" % interface
+
+        if CHANNEL_INTERFACE_MESSAGES in interfaces:
+            channel[CHANNEL_INTERFACE_MESSAGES].connect_to_signal(
+                'MessageReceived', self.message_received_cb)
+            channel[CHANNEL_INTERFACE_MESSAGES].connect_to_signal(
+                'PendingMessagesRemoved', self.pending_messages_removed_cb)
+
+    def message_received_cb (self, message):
+        channel = self.channel
+
+        # we need to acknowledge the message
+        msg_id = message[0]['pending-message-id']
+        channel[CHANNEL_TYPE_TEXT].AcknowledgePendingMessages([msg_id],
+            reply_handler = self.parent.generic_reply,
+            error_handler = self.parent.error_cb)
+
+        print '-' * 78
+        print 'Received Message:'
+        for d in message:
+            print '{'
+            for k, v in d.iteritems():
+                print '  %s: %s' % (k, v)
+            print '}'
+        print '-' * 78
+
+    def pending_messages_removed_cb (self, message_ids):
+        print "Acked messages %s" % message_ids
+
+class Example (object):
+    def __init__ (self, account, password):
+        """e.g. account  = 'bob at example.com/test'
+                password = 'bigbob'
+        """
+
+        reg = telepathy.client.ManagerRegistry()
+        reg.LoadManagers()
+
+        # get the gabble Connection Manager
+        self.cm = cm = reg.GetManager('gabble')
+
+        # get the parameters required to make a Jabber connection
+        cm[CONNECTION_MANAGER].RequestConnection('jabber',
+            {
+                'account':  account,
+                'password': password,
+            },
+            reply_handler = self.request_connection_cb,
+            error_handler = self.error_cb)
+
+        self.loop = gobject.MainLoop()
+        try:
+            self.loop.run()
+        except KeyboardInterrupt:
+            print "Terminating connection..."
+            self.disconnect()
+            # reengage the mainloop so that we can disconnect cleanly
+            self.loop.run()
+
+    def generic_reply (self, *args): pass
+
+    def error_cb (self, error):
+        print "Error:", error
+        self.disconnect()
+
+    def disconnect (self):
+        self.conn[CONNECTION].Disconnect(reply_handler = self.generic_reply,
+                                         error_handler = self.error_cb)
+
+    def request_connection_cb (self, bus_name, object_path):
+        print bus_name, object_path
+        self.conn = conn = telepathy.client.Connection(bus_name, object_path)
+
+        conn[CONNECTION].connect_to_signal('StatusChanged',
+            self.status_changed_cb)
+
+        print "Establishing connection..."
+        conn[CONNECTION].Connect(reply_handler = self.generic_reply,
+                                 error_handler = self.error_cb)
+
+    def status_changed_cb (self, status, reason):
+        conn = self.conn
+
+        if status == CONNECTION_STATUS_DISCONNECTED:
+            print "Disconnected!"
+            self.loop.quit()
+
+        if status != CONNECTION_STATUS_CONNECTED: return
+
+        print 'Carrier Detected' # remember dialup modems?
+        print 'Ctrl-C to disconnect'
+
+        # get a list of interfaces on this connection
+        conn[CONNECTION].GetInterfaces(reply_handler = self.get_interfaces_cb,
+                                       error_handler = self.error_cb)
+
+    def get_interfaces_cb (self, interfaces):
+        conn = self.conn
+
+        print "Connection Interfaces:"
+        for interface in interfaces:
+            print " - %s" % interface
+
+        if CONNECTION_INTERFACE_REQUESTS in interfaces:
+            # set up a channel
+            TextChannel (self, HANDLE_TYPE_CONTACT,
+                               "davyd.madeley at collabora.co.uk")
+
+if __name__ == '__main__':
+    import getpass
+    password = getpass.getpass()
+    Example(sys.argv[1], password)
-- 
1.5.6.5