summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--examples/roster_browser.py171
1 files changed, 171 insertions, 0 deletions
diff --git a/examples/roster_browser.py b/examples/roster_browser.py
new file mode 100644
index 00000000..d699d3cb
--- /dev/null
+++ b/examples/roster_browser.py
@@ -0,0 +1,171 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+ SleekXMPP: The Sleek XMPP Library
+ Copyright (C) 2011 Nathanael C. Fritz
+ This file is part of SleekXMPP.
+
+ See the file LICENSE for copying permission.
+"""
+
+import sys
+import time
+import logging
+import getpass
+import threading
+from optparse import OptionParser
+
+import sleekxmpp
+from sleekxmpp.exceptions import IqError, IqTimeout
+
+
+# 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')
+
+
+class RosterBrowser(sleekxmpp.ClientXMPP):
+
+ """
+ A basic script for dumping a client's roster to
+ the command line.
+ """
+
+ def __init__(self, jid, password):
+ sleekxmpp.ClientXMPP.__init__(self, jid, password)
+ # The session_start event will be triggered when
+ # the bot establishes its connection with the server
+ # and the XML streams are ready for use. We want to
+ # listen for this event so that we we can intialize
+ # our roster. We need threaded=True so that the
+ # session_start handler doesn't block event processing
+ # while we wait for presence stanzas to arrive.
+ self.add_event_handler("session_start", self.start, threaded=True)
+ self.add_event_handler("changed_status", self.wait_for_presences)
+
+ self.received = set()
+ self.presences_received = threading.Event()
+
+ def start(self, event):
+ """
+ Process the session_start event.
+
+ Typical actions for the session_start event are
+ requesting the roster and broadcasting an intial
+ presence stanza.
+
+ Arguments:
+ event -- An empty dictionary. The session_start
+ event does not provide any additional
+ data.
+ """
+ try:
+ self.get_roster()
+ except IqError as err:
+ print('Error: %' % err.iq['error']['condition'])
+ except IqTimeout:
+ print('Error: Request timed out')
+ self.send_presence()
+
+
+ print('Waiting for presence updates...\n')
+ self.presences_received.wait(5)
+
+ print('Roster for %s' % self.boundjid.bare)
+ groups = self.client_roster.groups()
+ for group in groups:
+ print('\n%s' % group)
+ print('-' * 72)
+ for jid in groups[group]:
+ sub = self.client_roster[jid]['subscription']
+ name = self.client_roster[jid]['name']
+ if self.client_roster[jid]['name']:
+ print(' %s (%s) [%s]' % (name, jid, sub))
+ else:
+ print(' %s [%s]' % (jid, sub))
+
+ connections = self.client_roster.presence(jid)
+ for res, pres in connections.items():
+ show = 'available'
+ if pres['show']:
+ show = pres['show']
+ print(' - %s (%s)' % (res, show))
+ if pres['status']:
+ print(' %s' % pres['status'])
+
+ self.disconnect()
+
+ def wait_for_presences(self, pres):
+ """
+ Track how many roster entries have received presence updates.
+ """
+ self.received.add(pres['from'].bare)
+ if len(self.received) >= len(self.client_roster.keys()):
+ self.presences_received.set()
+ else:
+ self.presences_received.clear()
+
+
+
+if __name__ == '__main__':
+ # Setup the command line arguments.
+ optp = OptionParser()
+ 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 opts.jid is None:
+ opts.jid = input("Username: ")
+ if opts.password is None:
+ opts.password = getpass.getpass("Password: ")
+
+ xmpp = RosterBrowser(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 pydns 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(threaded=False)
+ else:
+ print("Unable to connect.")
+