diff options
Diffstat (limited to 'examples/custom_stanzas')
| -rwxr-xr-x | examples/custom_stanzas/custom_stanza_provider.py | 106 | ||||
| -rwxr-xr-x | examples/custom_stanzas/custom_stanza_user.py | 111 | ||||
| -rw-r--r-- | examples/custom_stanzas/stanza.py | 16 |
3 files changed, 82 insertions, 151 deletions
diff --git a/examples/custom_stanzas/custom_stanza_provider.py b/examples/custom_stanzas/custom_stanza_provider.py index 0ebdb77e..9927c449 100755 --- a/examples/custom_stanzas/custom_stanza_provider.py +++ b/examples/custom_stanzas/custom_stanza_provider.py @@ -1,48 +1,37 @@ -#!/usr/bin/env python +#!/usr/bin/env python3 # -*- coding: utf-8 -*- """ - SleekXMPP: The Sleek XMPP Library + Slixmpp: The Slick XMPP Library Copyright (C) 2010 Nathanael C. Fritz - This file is part of SleekXMPP. + This file is part of Slixmpp. See the file LICENSE for copying permission. """ -import sys import logging -import getpass -from optparse import OptionParser +from getpass import getpass +from argparse import ArgumentParser -import sleekxmpp +import slixmpp -from sleekxmpp import ClientXMPP, Iq -from sleekxmpp.exceptions import IqError, IqTimeout, XMPPError -from sleekxmpp.xmlstream import register_stanza_plugin -from sleekxmpp.xmlstream.handler import Callback -from sleekxmpp.xmlstream.matcher import StanzaPath +from slixmpp import ClientXMPP, Iq +from slixmpp.exceptions import IqError, IqTimeout, XMPPError +from slixmpp.xmlstream import register_stanza_plugin +from slixmpp.xmlstream.handler import Callback +from slixmpp.xmlstream.matcher import StanzaPath from stanza import Action -# 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): - from sleekxmpp.util.misc_ops import setdefaultencoding - setdefaultencoding('utf8') -else: - raw_input = input - -class ActionBot(sleekxmpp.ClientXMPP): +class ActionBot(slixmpp.ClientXMPP): """ - A simple SleekXMPP bot that receives a custom stanza + A simple Slixmpp bot that receives a custom stanza from another client. """ def __init__(self, jid, password): - sleekxmpp.ClientXMPP.__init__(self, jid, password) + slixmpp.ClientXMPP.__init__(self, jid, password) # The session_start event will be triggered when # the bot establishes its connection with the server @@ -57,8 +46,7 @@ class ActionBot(sleekxmpp.ClientXMPP): self._handle_action)) self.add_event_handler('custom_action', - self._handle_action_event, - threaded=True) + self._handle_action_event) register_stanza_plugin(Iq, Action) @@ -88,10 +76,6 @@ class ActionBot(sleekxmpp.ClientXMPP): def _handle_action_event(self, iq): """ Respond to the custom action event. - - Since one of the actions is to disconnect, this - event handler needs to be run in threaded mode, by - using `threaded=True` in the `add_event_handler` call. """ method = iq['action']['method'] param = iq['action']['param'] @@ -112,62 +96,42 @@ class ActionBot(sleekxmpp.ClientXMPP): if __name__ == '__main__': # Setup the command line arguments. - optp = OptionParser() + parser = ArgumentParser() # 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) + parser.add_argument("-q", "--quiet", help="set logging to ERROR", + action="store_const", dest="loglevel", + const=logging.ERROR, default=logging.INFO) + parser.add_argument("-d", "--debug", help="set logging to DEBUG", + action="store_const", dest="loglevel", + const=logging.DEBUG, 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") + parser.add_argument("-j", "--jid", dest="jid", + help="JID to use") + parser.add_argument("-p", "--password", dest="password", + help="password to use") - opts, args = optp.parse_args() + args = parser.parse_args() # Setup logging. - logging.basicConfig(level=opts.loglevel, + logging.basicConfig(level=args.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 args.jid is None: + args.jid = input("Username: ") + if args.password is None: + args.password = getpass("Password: ") # Setup the CommandBot and register plugins. Note that while plugins may # have interdependencies, the order in which you register them does # not matter. - xmpp = ActionBot(opts.jid, opts.password) + xmpp = ActionBot(args.jid, args.password) xmpp.register_plugin('xep_0030') # Service Discovery xmpp.register_plugin('xep_0004') # Data Forms xmpp.register_plugin('xep_0050') # Adhoc Commands xmpp.register_plugin('xep_0199', {'keepalive': True, 'frequency':15}) - # 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.") + xmpp.connect() + xmpp.process() diff --git a/examples/custom_stanzas/custom_stanza_user.py b/examples/custom_stanzas/custom_stanza_user.py index 418e3218..c5630584 100755 --- a/examples/custom_stanzas/custom_stanza_user.py +++ b/examples/custom_stanzas/custom_stanza_user.py @@ -1,46 +1,35 @@ -#!/usr/bin/env python +#!/usr/bin/env python3 # -*- coding: utf-8 -*- """ - SleekXMPP: The Sleek XMPP Library + Slixmpp: The Slick XMPP Library Copyright (C) 2010 Nathanael C. Fritz - This file is part of SleekXMPP. + This file is part of Slixmpp. See the file LICENSE for copying permission. """ -import sys import logging -import getpass -from optparse import OptionParser +from getpass import getpass +from argparse import ArgumentParser -import sleekxmpp -from sleekxmpp import Iq -from sleekxmpp.exceptions import XMPPError -from sleekxmpp.xmlstream import register_stanza_plugin +import slixmpp +from slixmpp import Iq +from slixmpp.exceptions import XMPPError +from slixmpp.xmlstream import register_stanza_plugin from stanza import Action -# 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): - from sleekxmpp.util.misc_ops import setdefaultencoding - setdefaultencoding('utf8') -else: - raw_input = input - -class ActionUserBot(sleekxmpp.ClientXMPP): +class ActionUserBot(slixmpp.ClientXMPP): """ - A simple SleekXMPP bot that sends a custom action stanza + A simple Slixmpp bot that sends a custom action stanza to another client. """ def __init__(self, jid, password, other): - sleekxmpp.ClientXMPP.__init__(self, jid, password) + slixmpp.ClientXMPP.__init__(self, jid, password) self.action_provider = other @@ -49,7 +38,7 @@ class ActionUserBot(sleekxmpp.ClientXMPP): # 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, threaded=True) + self.add_event_handler("session_start", self.start) self.add_event_handler("message", self.message) register_stanza_plugin(Iq, Action) @@ -93,10 +82,8 @@ class ActionUserBot(sleekxmpp.ClientXMPP): iq2['type'] = 'set' iq2['action']['method'] = 'bye' iq2.send(block=False) - - # The wait=True delays the disconnect until the queue - # of stanzas to be sent becomes empty. - self.disconnect(wait=True) + + self.disconnect() except XMPPError: print('There was an error sending the custom action.') @@ -111,65 +98,45 @@ class ActionUserBot(sleekxmpp.ClientXMPP): if __name__ == '__main__': # Setup the command line arguments. - optp = OptionParser() + parser = ArgumentParser() # 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) + parser.add_argument("-q", "--quiet", help="set logging to ERROR", + action="store_const", dest="loglevel", + const=logging.ERROR, default=logging.INFO) + parser.add_argument("-d", "--debug", help="set logging to DEBUG", + action="store_const", dest="loglevel", + const=logging.DEBUG, 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("-o", "--other", dest="other", - help="JID providing custom stanza") + parser.add_argument("-j", "--jid", dest="jid", + help="JID to use") + parser.add_argument("-p", "--password", dest="password", + help="password to use") + parser.add_argument("-o", "--other", dest="other", + help="JID providing custom stanza") - opts, args = optp.parse_args() + args = parser.parse_args() # Setup logging. - logging.basicConfig(level=opts.loglevel, + logging.basicConfig(level=args.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.other is None: - opts.other = raw_input("JID Providing custom stanza: ") + if args.jid is None: + args.jid = input("Username: ") + if args.password is None: + args.password = getpass("Password: ") + if args.other is None: + args.other = input("JID Providing custom stanza: ") # Setup the CommandBot and register plugins. Note that while plugins may # have interdependencies, the order in which you register them does # not matter. - xmpp = ActionUserBot(opts.jid, opts.password, opts.other) + xmpp = ActionUserBot(args.jid, args.password, args.other) xmpp.register_plugin('xep_0030') # Service Discovery xmpp.register_plugin('xep_0004') # Data Forms xmpp.register_plugin('xep_0050') # Adhoc Commands - # 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.") + xmpp.connect() + xmpp.process() diff --git a/examples/custom_stanzas/stanza.py b/examples/custom_stanzas/stanza.py index 50d0f9f2..b2c6f766 100644 --- a/examples/custom_stanzas/stanza.py +++ b/examples/custom_stanzas/stanza.py @@ -1,30 +1,30 @@ -from sleekxmpp.xmlstream import ElementBase +from slixmpp.xmlstream import ElementBase class Action(ElementBase): """ A stanza class for XML content of the form: - <action xmlns="sleekxmpp:custom:actions"> + <action xmlns="slixmpp:custom:actions"> <method>X</method> <param>X</param> <status>X</status> </action> """ - + #: The `name` field refers to the basic XML tag name of the #: stanza. Here, the tag name will be 'action'. name = 'action' #: The namespace of the main XML tag. - namespace = 'sleekxmpp:custom:actions' + namespace = 'slixmpp:custom:actions' #: The `plugin_attrib` value is the name that can be used #: with a parent stanza to access this stanza. For example #: from an Iq stanza object, accessing: - #: + #: #: iq['action'] - #: + #: #: would reference an Action object, and will even create #: an Action object and append it to the Iq stanza if #: one doesn't already exist. @@ -49,8 +49,8 @@ class Action(ElementBase): #: the sub_interfaces set. For example, here all interfaces #: are marked as sub_interfaces, and so the XML produced will #: look like: - #: - #: <action xmlns="sleekxmpp:custom:actions"> + #: + #: <action xmlns="slixmpp:custom:actions"> #: <method>foo</method> #: </action> sub_interfaces = interfaces |