From 0c24fbdb06ab3a6e243a98c70ee10b8e6ac41a29 Mon Sep 17 00:00:00 2001 From: Lance Stout Date: Fri, 16 Mar 2012 23:18:59 -0700 Subject: Add pubsub examples. Run pubsub commands via pubsub_client, and watch events as they come in with pubsub_events. --- examples/pubsub_client.py | 198 ++++++++++++++++++++++++++++++++++++++++++++++ examples/pubsub_events.py | 151 +++++++++++++++++++++++++++++++++++ 2 files changed, 349 insertions(+) create mode 100644 examples/pubsub_client.py create mode 100644 examples/pubsub_events.py (limited to 'examples') diff --git a/examples/pubsub_client.py b/examples/pubsub_client.py new file mode 100644 index 00000000..b0459c84 --- /dev/null +++ b/examples/pubsub_client.py @@ -0,0 +1,198 @@ +import sys +import logging +import getpass +from optparse import OptionParser + +import sleekxmpp +from sleekxmpp.xmlstream import ET, tostring + + +# Python versions before 3.0 do not use UTF-8 encoding +# by default. To ensure that Unicode is handled properly +# throughout SleekXMPP, we will set the default encoding +# ourselves to UTF-8. +if sys.version_info < (3, 0): + reload(sys) + sys.setdefaultencoding('utf8') +else: + raw_input = input + + +class PubsubClient(sleekxmpp.ClientXMPP): + + def __init__(self, jid, password, server, + node=None, action='list', data=''): + super(PubsubClient, self).__init__(jid, password) + + self.register_plugin('xep_0030') + self.register_plugin('xep_0059') + self.register_plugin('xep_0060') + + self.actions = ['nodes', 'create', 'delete', + 'publish', 'get', 'retract', + 'purge', 'subscribe', 'unsubscribe'] + + self.action = action + self.node = node + self.data = data + self.pubsub_server = server + + self.add_event_handler('session_start', self.start) + + def start(self, event): + self.get_roster() + self.send_presence() + + try: + getattr(self, self.action)() + except: + logging.error('Could not execute: %s' % self.action) + self.disconnect() + + def nodes(self): + try: + result = self['xep_0060'].get_nodes(self.pubsub_server, self.node) + for item in result['disco_items']['items']: + print(' - %s' % str(item)) + except: + logging.error('Could not retrieve node list.') + + def create(self): + try: + self['xep_0060'].create_node(self.pubsub_server, self.node) + except: + logging.error('Could not create node: %s' % self.node) + + def delete(self): + try: + self['xep_0060'].delete_node(self.pubsub_server, self.node) + print('Deleted node: %s' % self.node) + except: + logging.error('Could not delete node: %s' % self.node) + + def publish(self): + payload = ET.fromstring("%s" % self.data) + try: + result = self['xep_0060'].publish(self.pubsub_server, self.node, payload=payload) + id = result['pubsub']['publish']['item']['id'] + print('Published at item id: %s' % id) + except: + logging.error('Could not publish to: %s' % self.node) + + def get(self): + try: + result = self['xep_0060'].get_item(self.pubsub_server, self.node, self.data) + for item in result['pubsub']['items']['substanzas']: + print('Retrieved item %s: %s' % (item['id'], tostring(item['payload']))) + except: + logging.error('Could not retrieve item %s from node %s' % (self.data, self.node)) + + def retract(self): + try: + result = self['xep_0060'].retract(self.pubsub_server, self.node, self.data) + print('Retracted item %s from node %s' % (self.data, self.node)) + except: + logging.error('Could not retract item %s from node %s' % (self.data, self.node)) + + def purge(self): + try: + result = self['xep_0060'].purge(self.pubsub_server, self.node) + print('Purged all items from node %s' % self.node) + except: + logging.error('Could not purge items from node %s' % self.node) + + def subscribe(self): + try: + result = self['xep_0060'].subscribe(self.pubsub_server, self.node) + print('Subscribed %s to node %s' % (self.boundjid.bare, self.node)) + except: + logging.error('Could not subscribe %s to node %s' % (self.boundjid.bare, self.node)) + + def unsubscribe(self): + try: + result = self['xep_0060'].unsubscribe(self.pubsub_server, self.node) + print('Unsubscribed %s from node %s' % (self.boundjid.bare, self.node)) + except: + logging.error('Could not unsubscribe %s from node %s' % (self.boundjid.bare, self.node)) + + + + +if __name__ == '__main__': + # Setup the command line arguments. + optp = OptionParser() + optp.version = '%%prog 0.1' + optp.usage = "Usage: %%prog [options] " + \ + 'nodes|create|delete|purge|subscribe|unsubscribe|publish|retract|get' + \ + ' [ ]' + + optp.add_option('-q','--quiet', help='set logging to ERROR', + action='store_const', + dest='loglevel', + const=logging.ERROR, + default=logging.ERROR) + optp.add_option('-d','--debug', help='set logging to DEBUG', + action='store_const', + dest='loglevel', + const=logging.DEBUG, + default=logging.ERROR) + optp.add_option('-v','--verbose', help='set logging to COMM', + action='store_const', + dest='loglevel', + const=5, + default=logging.ERROR) + + # JID and password options. + optp.add_option("-j", "--jid", dest="jid", + help="JID to use") + optp.add_option("-p", "--password", dest="password", + help="password to use") + opts,args = optp.parse_args() + + # Setup logging. + logging.basicConfig(level=opts.loglevel, + format='%(levelname)-8s %(message)s') + + if len(args) < 2: + optp.print_help() + exit() + + if opts.jid is None: + opts.jid = raw_input("Username: ") + if opts.password is None: + opts.password = getpass.getpass("Password: ") + + if len(args) == 2: + args = (args[0], args[1], '', '', '') + elif len(args) == 3: + args = (args[0], args[1], args[2], '', '') + elif len(args) == 4: + args = (args[0], args[1], args[2], args[3], '') + + + # Setup the Pubsub client + xmpp = PubsubClient(opts.jid, opts.password, + server=args[0], + node=args[2], + action=args[1], + data=args[3]) + + # If you are working with an OpenFire server, you may need + # to adjust the SSL version used: + # xmpp.ssl_version = ssl.PROTOCOL_SSLv3 + + # If you want to verify the SSL certificates offered by a server: + # xmpp.ca_certs = "path/to/ca/cert" + + # Connect to the XMPP server and start processing XMPP stanzas. + if xmpp.connect(): + # If you do not have the dnspython library installed, you will need + # to manually specify the name of the server if it does not match + # the one in the JID. For example, to use Google Talk you would + # need to use: + # + # if xmpp.connect(('talk.google.com', 5222)): + # ... + xmpp.process(block=True) + else: + print("Unable to connect.") diff --git a/examples/pubsub_events.py b/examples/pubsub_events.py new file mode 100644 index 00000000..6fe7159b --- /dev/null +++ b/examples/pubsub_events.py @@ -0,0 +1,151 @@ +import sys +import logging +import getpass +from optparse import OptionParser + +import sleekxmpp +from sleekxmpp.xmlstream import ET, tostring +from sleekxmpp.xmlstream.matcher import StanzaPath +from sleekxmpp.xmlstream.handler import Callback + + +# Python versions before 3.0 do not use UTF-8 encoding +# by default. To ensure that Unicode is handled properly +# throughout SleekXMPP, we will set the default encoding +# ourselves to UTF-8. +if sys.version_info < (3, 0): + reload(sys) + sys.setdefaultencoding('utf8') +else: + raw_input = input + + +class PubsubEvents(sleekxmpp.ClientXMPP): + + def __init__(self, jid, password): + super(PubsubEvents, self).__init__(jid, password) + + self.register_plugin('xep_0030') + self.register_plugin('xep_0059') + self.register_plugin('xep_0060') + + self.add_event_handler('session_start', self.start) + + # Some services may require configuration to allow + # sending delete, configuration, or subscription events. + self.add_event_handler('pubsub_publish', self._publish) + self.add_event_handler('pubsub_retract', self._retract) + self.add_event_handler('pubsub_purge', self._purge) + self.add_event_handler('pubsub_delete', self._delete) + self.add_event_handler('pubsub_config', self._config) + self.add_event_handler('pubsub_subscription', self._subscription) + + # Want to use nicer, more specific pubsub event names? + # self['xep_0060'].map_node_event('node_name', 'event_prefix') + # self.add_event_handler('event_prefix_publish', handler) + # self.add_event_handler('event_prefix_retract', handler) + # self.add_event_handler('event_prefix_purge', handler) + # self.add_event_handler('event_prefix_delete', handler) + + def start(self, event): + self.get_roster() + self.send_presence() + + def _publish(self, msg): + """Handle receiving a publish item event.""" + print('Published item %s to %s:' % ( + msg['pubsub_event']['items']['item']['id'], + msg['pubsub_event']['items']['node'])) + data = msg['pubsub_event']['items']['item']['payload'] + if data is not None: + print(tostring(data)) + else: + print('No item content') + + def _retract(self, msg): + """Handle receiving a retract item event.""" + print('Retracted item %s from %s' % ( + msg['pubsub_event']['items']['retract']['id'], + msg['pubsub_event']['items']['node'])) + + def _purge(self, msg): + """Handle receiving a node purge event.""" + print('Purged all items from %s' % ( + msg['pubsub_event']['purge']['node'])) + + def _delete(self, msg): + """Handle receiving a node deletion event.""" + print('Deleted node %s' % ( + msg['pubsub_event']['delete']['node'])) + + def _config(self, msg): + """Handle receiving a node configuration event.""" + print('Configured node %s:' % ( + msg['pubsub_event']['configuration']['node'])) + print(msg['pubsub_event']['configuration']['form']) + + def _subscription(self, msg): + """Handle receiving a node subscription event.""" + print('Subscription change for node %s:' % ( + msg['pubsub_event']['subscription']['node'])) + print(msg['pubsub_event']['subscription']) + + +if __name__ == '__main__': + # Setup the command line arguments. + optp = OptionParser() + + # Output verbosity options. + optp.add_option('-q', '--quiet', help='set logging to ERROR', + action='store_const', dest='loglevel', + const=logging.ERROR, default=logging.INFO) + optp.add_option('-d', '--debug', help='set logging to DEBUG', + action='store_const', dest='loglevel', + const=logging.DEBUG, default=logging.INFO) + optp.add_option('-v', '--verbose', help='set logging to COMM', + action='store_const', dest='loglevel', + const=5, default=logging.INFO) + + # JID and password options. + optp.add_option("-j", "--jid", dest="jid", + help="JID to use") + optp.add_option("-p", "--password", dest="password", + help="password to use") + + opts, args = optp.parse_args() + + # Setup logging. + logging.basicConfig(level=opts.loglevel, + format='%(levelname)-8s %(message)s') + + if opts.jid is None: + opts.jid = raw_input("Username: ") + if opts.password is None: + opts.password = getpass.getpass("Password: ") + + logging.info("Run this in conjunction with the pubsub_client.py " + \ + "example to watch events happen as you give commands.") + + # Setup the PubsubEvents listener + xmpp = PubsubEvents(opts.jid, opts.password) + + # If you are working with an OpenFire server, you may need + # to adjust the SSL version used: + # xmpp.ssl_version = ssl.PROTOCOL_SSLv3 + + # If you want to verify the SSL certificates offered by a server: + # xmpp.ca_certs = "path/to/ca/cert" + + # Connect to the XMPP server and start processing XMPP stanzas. + if xmpp.connect(): + # If you do not have the dnspython library installed, you will need + # to manually specify the name of the server if it does not match + # the one in the JID. For example, to use Google Talk you would + # need to use: + # + # if xmpp.connect(('talk.google.com', 5222)): + # ... + xmpp.process(block=True) + print("Done") + else: + print("Unable to connect.") -- cgit v1.2.3