summaryrefslogtreecommitdiff
path: root/examples/proxy_echo_client.py
diff options
context:
space:
mode:
authorLance Stout <lancestout@gmail.com>2011-07-27 19:36:04 -0700
committerLance Stout <lancestout@gmail.com>2011-07-27 19:36:04 -0700
commitd7fe724145c2e01d1028dab773fb49414c6856dd (patch)
tree460331e5949b92637c79275aed001c85125f7afe /examples/proxy_echo_client.py
parent20df6348a4c8262a40578d84c934f9a15431d925 (diff)
parente022b2a36c342b6a83d7c7f0a39dfb851cdfd2de (diff)
downloadslixmpp-d7fe724145c2e01d1028dab773fb49414c6856dd.tar.gz
slixmpp-d7fe724145c2e01d1028dab773fb49414c6856dd.tar.bz2
slixmpp-d7fe724145c2e01d1028dab773fb49414c6856dd.tar.xz
slixmpp-d7fe724145c2e01d1028dab773fb49414c6856dd.zip
Merge branch 'develop' into exceptions
Diffstat (limited to 'examples/proxy_echo_client.py')
-rwxr-xr-xexamples/proxy_echo_client.py167
1 files changed, 167 insertions, 0 deletions
diff --git a/examples/proxy_echo_client.py b/examples/proxy_echo_client.py
new file mode 100755
index 00000000..4db9a552
--- /dev/null
+++ b/examples/proxy_echo_client.py
@@ -0,0 +1,167 @@
+#!/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 time
+import getpass
+from optparse import OptionParser
+
+import sleekxmpp
+
+# 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 EchoBot(sleekxmpp.ClientXMPP):
+
+ """
+ A simple SleekXMPP bot that will echo messages it
+ receives, along with a short thank you message.
+ """
+
+ 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.
+ self.add_event_handler("session_start", self.start)
+
+ # The message event is triggered whenever a message
+ # stanza is received. Be aware that that includes
+ # MUC messages and error messages.
+ self.add_event_handler("message", self.message)
+
+ 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.
+ """
+ self.send_presence()
+ self.get_roster()
+
+ def message(self, msg):
+ """
+ Process incoming message stanzas. Be aware that this also
+ includes MUC messages and error messages. It is usually
+ a good idea to check the messages's type before processing
+ or sending replies.
+
+ Arguments:
+ msg -- The received message stanza. See the documentation
+ for stanza objects and the Message stanza to see
+ how it may be used.
+ """
+ msg.reply("Thanks for sending\n%(body)s" % msg).send()
+
+
+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")
+ optp.add_option("--phost", dest="proxy_host",
+ help="Proxy hostname")
+ optp.add_option("--pport", dest="proxy_port",
+ help="Proxy port")
+ optp.add_option("--puser", dest="proxy_user",
+ help="Proxy username")
+ optp.add_option("--ppass", dest="proxy_pass",
+ help="Proxy password")
+
+
+
+ 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: ")
+ if opts.proxy_host is None:
+ opts.proxy_host = raw_input("Proxy host: ")
+ if opts.proxy_port is None:
+ opts.proxy_port = raw_input("Proxy port: ")
+ if opts.proxy_user is None:
+ opts.proxy_user = raw_input("Proxy username: ")
+ if opts.proxy_pass is None and opts.proxy_user:
+ opts.proxy_pass = getpass.getpass("Proxy password: ")
+
+ # Setup the EchoBot and register plugins. Note that while plugins may
+ # have interdependencies, the order in which you register them does
+ # not matter.
+ xmpp = EchoBot(opts.jid, opts.password)
+ xmpp.register_plugin('xep_0030') # Service Discovery
+ xmpp.register_plugin('xep_0004') # Data Forms
+ xmpp.register_plugin('xep_0060') # PubSub
+ xmpp.register_plugin('xep_0199') # XMPP Ping
+
+ # 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"
+
+ xmpp.use_proxy = True
+ xmpp.proxy_config = {
+ 'host': opts.proxy_host,
+ 'port': int(opts.proxy_port),
+ 'username': opts.proxy_user,
+ 'password': opts.proxy_pass}
+
+ # 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)
+ print("Done")
+ else:
+ print("Unable to connect.")