summaryrefslogtreecommitdiff
path: root/examples/register_account.py
diff options
context:
space:
mode:
authorLance Stout <lancestout@gmail.com>2012-01-19 02:37:36 -0800
committerLance Stout <lancestout@gmail.com>2012-01-19 02:37:36 -0800
commit02f400615334806fc531c149d85fe6f9a06d3e1e (patch)
tree28c96f1355e4576afd6e9a6c89bb6625144f695d /examples/register_account.py
parentb25668b5b7264bafeeeaeeb0efd6e911036d2d30 (diff)
downloadslixmpp-02f400615334806fc531c149d85fe6f9a06d3e1e.tar.gz
slixmpp-02f400615334806fc531c149d85fe6f9a06d3e1e.tar.bz2
slixmpp-02f400615334806fc531c149d85fe6f9a06d3e1e.tar.xz
slixmpp-02f400615334806fc531c149d85fe6f9a06d3e1e.zip
Add basic start for a client side XEP-0077 plugin.
Diffstat (limited to 'examples/register_account.py')
-rw-r--r--examples/register_account.py175
1 files changed, 175 insertions, 0 deletions
diff --git a/examples/register_account.py b/examples/register_account.py
new file mode 100644
index 00000000..530afaec
--- /dev/null
+++ b/examples/register_account.py
@@ -0,0 +1,175 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+ SleekXMPP: The Sleek XMPP Library
+ Copyright (C) 2010 Nathanael C. Fritz
+ This file is part of SleekXMPP.
+
+ See the file LICENSE for copying permission.
+"""
+
+import sys
+import logging
+import getpass
+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')
+else:
+ raw_input = input
+
+
+class RegisterBot(sleekxmpp.ClientXMPP):
+
+ """
+ A basic bot that will attempt to register an account
+ with an XMPP server.
+
+ NOTE: This follows the very basic registration workflow
+ from XEP-0077. More advanced server registration
+ workflows will need to check for data forms, etc.
+ """
+
+ 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 initialize
+ # our roster.
+ self.add_event_handler("session_start", self.start)
+
+ # The register event provides an Iq result stanza with
+ # a registration form from the server. This may include
+ # the basic registration fields, a data form, an
+ # out-of-band URL, or any combination. For more advanced
+ # cases, you will need to examine the fields provided
+ # and respond accordingly. SleekXMPP provides plugins
+ # for data forms and OOB links that will make that easier.
+ self.add_event_handler("register", self.register)
+
+ def start(self, event):
+ """
+ Process the session_start event.
+
+ Typical actions for the session_start event are
+ requesting the roster and broadcasting an initial
+ presence stanza.
+
+ Arguments:
+ event -- An empty dictionary. The session_start
+ event does not provide any additional
+ data.
+ """
+ self.send_presence()
+ self.get_roster()
+
+ # We're only concerned about registering, so nothing more to do here.
+ self.disconnect()
+
+ def register(self, iq):
+ """
+ Fill out and submit a registration form.
+
+ The form may be composed of basic registration fields, a data form,
+ an out-of-band link, or any combination thereof. Data forms and OOB
+ links can be checked for as so:
+
+ if iq.match('iq/register/form'):
+ # do stuff with data form
+ # iq['register']['form']['fields']
+ if iq.match('iq/register/oob'):
+ # do stuff with OOB URL
+ # iq['register']['oob']['url']
+
+ To get the list of basic registration fields, you can use:
+ iq['register']['fields']
+ """
+ resp = self.Iq()
+ resp['type'] = 'set'
+ resp['register']['username'] = self.boundjid.user
+ resp['register']['password'] = self.password
+
+ try:
+ resp.send()
+ logging.info("Account created for %s!" % self.boundjid)
+ except IqError as e:
+ logging.error("Could not register account: %s" %
+ e.iq['error']['text'])
+ self.disconnect()
+ except IqTimeout:
+ logging.error("No response from server.")
+ self.disconnect()
+
+
+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: ")
+
+ # Setup the RegisterBot and register plugins. Note that while plugins may
+ # have interdependencies, the order in which you register them does
+ # not matter.
+ xmpp = RegisterBot(opts.jid, opts.password)
+ xmpp.register_plugin('xep_0030') # Service Discovery
+ xmpp.register_plugin('xep_0004') # Data forms
+ xmpp.register_plugin('xep_0066') # Out-of-band Data
+ xmpp.register_plugin('xep_0077') # In-band Registration
+
+ # 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.")