mirror of
https://github.com/correl/SleekXMPP.git
synced 2024-12-30 19:10:41 +00:00
a3d111be12
Backward incompatibility alert!
Please see examples/adhoc_provider.py for how to use the new
plugin implementation, or the test examples in the files
tests/test_stream_xep_0050.py and tests/test_stanza_xep_0050.py.
Major changes:
- May now have zero-step commands. Useful if a command is
intended to be a dynamic status report that doesn't
require any user input.
- May use payloads other than data forms, such as a
completely custom stanza type.
- May include multiple payload items, such as multiple
data forms, or a form and a custom stanza type.
- Includes a command user API for calling adhoc commands
on remote agents and managing the workflow.
- Added support for note elements.
Todo:
- Add prev action support.
You may use register_plugin('old_0050') to continue using the
previous XEP-0050 implementation.
199 lines
7.1 KiB
Python
Executable file
199 lines
7.1 KiB
Python
Executable file
#!/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 CommandBot(sleekxmpp.ClientXMPP):
|
|
|
|
"""
|
|
A simple SleekXMPP bot that provides a basic
|
|
adhoc command.
|
|
"""
|
|
|
|
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)
|
|
|
|
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()
|
|
|
|
# We add the command after session_start has fired
|
|
# to ensure that the correct full JID is used.
|
|
|
|
# If using a component, may also pass jid keyword parameter.
|
|
|
|
self['xep_0050'].add_command(node='greeting',
|
|
name='Greeting',
|
|
handler=self._handle_command)
|
|
|
|
def _handle_command(self, iq, session):
|
|
"""
|
|
Respond to the intial request for a command.
|
|
|
|
Arguments:
|
|
iq -- The iq stanza containing the command request.
|
|
session -- A dictionary of data relevant to the command
|
|
session. Additional, custom data may be saved
|
|
here to persist across handler callbacks.
|
|
"""
|
|
form = self['xep_0004'].makeForm('form', 'Greeting')
|
|
form.addField(var='greeting',
|
|
ftype='text-single',
|
|
label='Your greeting')
|
|
|
|
session['payload'] = form
|
|
session['next'] = self._handle_command_complete
|
|
session['has_next'] = False
|
|
|
|
# Other useful session values:
|
|
# session['to'] -- The JID that received the
|
|
# command request.
|
|
# session['from'] -- The JID that sent the
|
|
# command request.
|
|
# session['has_next'] = True -- There are more steps to complete
|
|
# session['allow_complete'] = True -- Allow user to finish immediately
|
|
# and possibly skip steps
|
|
# session['cancel'] = handler -- Assign a handler for if the user
|
|
# cancels the command.
|
|
# session['notes'] = [ -- Add informative notes about the
|
|
# ('info', 'Info message'), command's results.
|
|
# ('warning', 'Warning message'),
|
|
# ('error', 'Error message')]
|
|
|
|
return session
|
|
|
|
def _handle_command_complete(self, payload, session):
|
|
"""
|
|
Process a command result from the user.
|
|
|
|
Arguments:
|
|
payload -- Either a single item, such as a form, or a list
|
|
of items or forms if more than one form was
|
|
provided to the user. The payload may be any
|
|
stanza, such as jabber:x:oob for out of band
|
|
data, or jabber:x:data for typical data forms.
|
|
session -- A dictionary of data relevant to the command
|
|
session. Additional, custom data may be saved
|
|
here to persist across handler callbacks.
|
|
"""
|
|
|
|
# In this case (as is typical), the payload is a form
|
|
form = payload
|
|
|
|
greeting = form['values']['greeting']
|
|
self.send_message(mto=session['from'],
|
|
mbody="%s, World!" % greeting)
|
|
|
|
# Having no return statement is the same as unsetting the 'payload'
|
|
# and 'next' session values and returning the session.
|
|
|
|
# Unless it is the final step, always return the session dictionary.
|
|
|
|
session['payload'] = None
|
|
session['next'] = None
|
|
|
|
return session
|
|
|
|
|
|
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 CommandBot and register plugins. Note that while plugins may
|
|
# have interdependencies, the order in which you register them does
|
|
# not matter.
|
|
xmpp = CommandBot(opts.jid, opts.password)
|
|
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 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.")
|