summaryrefslogtreecommitdiff
path: root/examples/pubsub_events.py
diff options
context:
space:
mode:
authorLance Stout <lancestout@gmail.com>2012-03-16 23:18:59 -0700
committerLance Stout <lancestout@gmail.com>2012-03-16 23:18:59 -0700
commit0c24fbdb06ab3a6e243a98c70ee10b8e6ac41a29 (patch)
treec18928698c34d26501f01891c9c2b6d0b70136f6 /examples/pubsub_events.py
parenteb25998e72d728b16d75f5d70cf930da16ec7cf0 (diff)
downloadslixmpp-0c24fbdb06ab3a6e243a98c70ee10b8e6ac41a29.tar.gz
slixmpp-0c24fbdb06ab3a6e243a98c70ee10b8e6ac41a29.tar.bz2
slixmpp-0c24fbdb06ab3a6e243a98c70ee10b8e6ac41a29.tar.xz
slixmpp-0c24fbdb06ab3a6e243a98c70ee10b8e6ac41a29.zip
Add pubsub examples.
Run pubsub commands via pubsub_client, and watch events as they come in with pubsub_events.
Diffstat (limited to 'examples/pubsub_events.py')
-rw-r--r--examples/pubsub_events.py151
1 files changed, 151 insertions, 0 deletions
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.")