summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rwxr-xr-xexamples/admin_commands.py178
-rw-r--r--sleekxmpp/basexmpp.py2
-rw-r--r--sleekxmpp/plugins/__init__.py1
-rw-r--r--sleekxmpp/plugins/xep_0027/gpg.py2
-rw-r--r--sleekxmpp/plugins/xep_0133.py54
-rw-r--r--sleekxmpp/plugins/xep_0222.py2
6 files changed, 236 insertions, 3 deletions
diff --git a/examples/admin_commands.py b/examples/admin_commands.py
new file mode 100755
index 00000000..13b1b179
--- /dev/null
+++ b/examples/admin_commands.py
@@ -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.")
diff --git a/sleekxmpp/basexmpp.py b/sleekxmpp/basexmpp.py
index 90134c4d..9e5b9bbf 100644
--- a/sleekxmpp/basexmpp.py
+++ b/sleekxmpp/basexmpp.py
@@ -598,7 +598,7 @@ class BaseXMPP(XMLStream):
@resource.setter
def resource(self, value):
- log.warning("fulljid property deprecated. Use boundjid.full")
+ log.warning("fulljid property deprecated. Use boundjid.resource")
self.boundjid.resource = value
@property
diff --git a/sleekxmpp/plugins/__init__.py b/sleekxmpp/plugins/__init__.py
index 04db0d6e..dbab2d1c 100644
--- a/sleekxmpp/plugins/__init__.py
+++ b/sleekxmpp/plugins/__init__.py
@@ -42,6 +42,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
diff --git a/sleekxmpp/plugins/xep_0027/gpg.py b/sleekxmpp/plugins/xep_0027/gpg.py
index 9c6ca078..3ca9c36d 100644
--- a/sleekxmpp/plugins/xep_0027/gpg.py
+++ b/sleekxmpp/plugins/xep_0027/gpg.py
@@ -24,7 +24,7 @@ def _extract_data(data, kind):
if not begin_headers and 'BEGIN PGP %s' % kind in line:
begin_headers = True
continue
- if begin_headers and line == '':
+ if begin_headers and line.stripped() == '':
begin_data = True
continue
if 'END PGP %s' % kind in line:
diff --git a/sleekxmpp/plugins/xep_0133.py b/sleekxmpp/plugins/xep_0133.py
new file mode 100644
index 00000000..7bbe4c3c
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0133.py
@@ -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)
diff --git a/sleekxmpp/plugins/xep_0222.py b/sleekxmpp/plugins/xep_0222.py
index 724ef968..1073c1a1 100644
--- a/sleekxmpp/plugins/xep_0222.py
+++ b/sleekxmpp/plugins/xep_0222.py
@@ -22,7 +22,7 @@ class XEP_0222(BasePlugin):
"""
name = 'xep_0222'
- description = 'XEP-0222: Persistent Storage of Private Data via PubSub'
+ description = 'XEP-0222: Persistent Storage of Public Data via PubSub'
dependencies = set(['xep_0163', 'xep_0060', 'xep_0004'])
profile = {'pubsub#persist_items': True,