Add XEP-0133 support, which just makes the appropriate XEP-0050 calls.
This commit is contained in:
Lance Stout
parent
459e1ed345
commit
fb221a8dc0
3 changed files with 233 additions and 0 deletions
178
examples/admin_commands.py
Executable file
178
examples/admin_commands.py
Executable file
|
|
@ -0,0 +1,178 @@
|
|||
#!/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
|
||||
|
||||
# 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 AdminCommands(sleekxmpp.ClientXMPP):
|
||||
|
||||
"""
|
||||
A simple SleekXMPP bot that uses admin commands to
|
||||
add a new user to a server.
|
||||
"""
|
||||
|
||||
def __init__(self, jid, password, command):
|
||||
sleekxmpp.ClientXMPP.__init__(self, jid, password)
|
||||
|
||||
self.command = command
|
||||
|
||||
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 initial
|
||||
presence stanza.
|
||||
|
||||
Arguments:
|
||||
event -- An empty dictionary. The session_start
|
||||
event does not provide any additional
|
||||
data.
|
||||
"""
|
||||
self.send_presence()
|
||||
self.get_roster()
|
||||
|
||||
def command_success(iq, session):
|
||||
print('Command completed')
|
||||
if iq['command']['form']:
|
||||
for var, field in iq['command']['form']['fields'].items():
|
||||
print('%s: %s' % (var, field['value']))
|
||||
if iq['command']['notes']:
|
||||
print('Command Notes:')
|
||||
for note in iq['command']['notes']:
|
||||
print('%s: %s' % note)
|
||||
self.disconnect()
|
||||
|
||||
def command_error(iq, session):
|
||||
print('Error completing command')
|
||||
print('%s: %s' % (iq['error']['condition'],
|
||||
iq['error']['text']))
|
||||
self['xep_0050'].terminate_command(session)
|
||||
self.disconnect()
|
||||
|
||||
def process_form(iq, session):
|
||||
form = iq['command']['form']
|
||||
answers = {}
|
||||
for var, field in form['fields'].items():
|
||||
if var != 'FORM_TYPE':
|
||||
if field['type'] == 'boolean':
|
||||
answers[var] = raw_input('%s (y/n): ' % field['label'])
|
||||
if answers[var].lower() in ('1', 'true', 'y', 'yes'):
|
||||
answers[var] = '1'
|
||||
else:
|
||||
answers[var] = '0'
|
||||
else:
|
||||
answers[var] = raw_input('%s: ' % field['label'])
|
||||
else:
|
||||
answers['FORM_TYPE'] = field['value']
|
||||
form['type'] = 'submit'
|
||||
form['values'] = answers
|
||||
|
||||
session['next'] = command_success
|
||||
session['payload'] = form
|
||||
|
||||
self['xep_0050'].complete_command(session)
|
||||
|
||||
session = {'next': process_form,
|
||||
'error': command_error}
|
||||
|
||||
command = self.command.replace('-', '_')
|
||||
handler = getattr(self['xep_0133'], command, None)
|
||||
|
||||
if handler:
|
||||
handler(session={
|
||||
'next': process_form,
|
||||
'error': command_error
|
||||
})
|
||||
else:
|
||||
print('Invalid command name: %s' % self.command)
|
||||
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")
|
||||
optp.add_option("-c", "--command", dest="command",
|
||||
help="admin command 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: ")
|
||||
if opts.command is None:
|
||||
opts.command = raw_input("Admin command: ")
|
||||
|
||||
# Setup the CommandBot and register plugins. Note that while plugins may
|
||||
# have interdependencies, the order in which you register them does
|
||||
# not matter.
|
||||
xmpp = AdminCommands(opts.jid, opts.password, opts.command)
|
||||
xmpp.register_plugin('xep_0133') # Service Administration
|
||||
|
||||
# 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.")
|
||||
|
|
@ -41,6 +41,7 @@ __all__ = [
|
|||
'xep_0115', # Entity Capabilities
|
||||
'xep_0118', # User Tune
|
||||
'xep_0128', # Extended Service Discovery
|
||||
'xep_0133', # Service Administration
|
||||
'xep_0153', # vCard-Based Avatars
|
||||
'xep_0163', # Personal Eventing Protocol
|
||||
'xep_0172', # User Nickname
|
||||
|
|
|
|||
54
sleekxmpp/plugins/xep_0133.py
Normal file
54
sleekxmpp/plugins/xep_0133.py
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
"""
|
||||
SleekXMPP: The Sleek XMPP Library
|
||||
Copyright (C) 2012 Nathanael C. Fritz, Lance J.T. Stout
|
||||
This file is part of SleekXMPP.
|
||||
|
||||
See the file LICENSE for copying permission.
|
||||
"""
|
||||
|
||||
|
||||
from sleekxmpp.plugins import BasePlugin, register_plugin
|
||||
|
||||
|
||||
class XEP_0133(BasePlugin):
|
||||
|
||||
name = 'xep_0133'
|
||||
description = 'XEP-0133: Service Administration'
|
||||
dependencies = set(['xep_0030', 'xep_0004', 'xep_0050'])
|
||||
commands = set(['add-user', 'delete-user', 'disable-user',
|
||||
'reenable-user', 'end-user-session', 'get-user-password',
|
||||
'change-user-password', 'get-user-roster',
|
||||
'get-user-lastlogin', 'user-stats', 'edit-blacklist',
|
||||
'edit-whitelist', 'get-registered-users-num',
|
||||
'get-disabled-users-num', 'get-online-users-num',
|
||||
'get-active-users-num', 'get-idle-users-num',
|
||||
'get-registered-users-list', 'get-disabled-users-list',
|
||||
'get-online-users-list', 'get-online-users',
|
||||
'get-active-users', 'get-idle-userslist', 'announce',
|
||||
'set-motd', 'edit-motd', 'delete-motd', 'set-welcome',
|
||||
'delete-welcome', 'edit-admin', 'restart', 'shutdown'])
|
||||
|
||||
def get_commands(self, jid=None, **kwargs):
|
||||
if jid is None:
|
||||
jid = self.xmpp.boundjid.server
|
||||
return self.xmpp['xep_0050'].get_commands(jid, **kwargs)
|
||||
|
||||
|
||||
def create_command(name):
|
||||
def admin_command(self, jid=None, session=None, ifrom=None, block=False):
|
||||
if jid is None:
|
||||
jid = self.xmpp.boundjid.server
|
||||
self.xmpp['xep_0050'].start_command(
|
||||
jid=jid,
|
||||
node='http://jabber.org/protocol/admin#%s' % name,
|
||||
session=session,
|
||||
ifrom=ifrom,
|
||||
block=block)
|
||||
return admin_command
|
||||
|
||||
|
||||
for cmd in XEP_0133.commands:
|
||||
setattr(XEP_0133, cmd.replace('-', '_'), create_command(cmd))
|
||||
|
||||
|
||||
register_plugin(XEP_0133)
|
||||
Loading…
Reference in a new issue