summaryrefslogtreecommitdiff
path: root/examples
diff options
context:
space:
mode:
authorEmmanuel Gil Peyrot <linkmauve@linkmauve.fr>2017-11-23 12:10:39 +0000
committerEmmanuel Gil Peyrot <linkmauve@linkmauve.fr>2017-11-23 12:18:01 +0000
commit7c7f4308c5ac7c50cd22444779a95189c93fc79a (patch)
treeea5bf6db3a6b139861db55ec2c17c3bfbeaab080 /examples
parenteab8c265f42f1bb0f6f77b2dda7c8f249a56ee9e (diff)
downloadslixmpp-7c7f4308c5ac7c50cd22444779a95189c93fc79a.tar.gz
slixmpp-7c7f4308c5ac7c50cd22444779a95189c93fc79a.tar.bz2
slixmpp-7c7f4308c5ac7c50cd22444779a95189c93fc79a.tar.xz
slixmpp-7c7f4308c5ac7c50cd22444779a95189c93fc79a.zip
Add a Markup plugin.
Diffstat (limited to 'examples')
-rwxr-xr-xexamples/markup.py120
1 files changed, 120 insertions, 0 deletions
diff --git a/examples/markup.py b/examples/markup.py
new file mode 100755
index 00000000..a72cbdb8
--- /dev/null
+++ b/examples/markup.py
@@ -0,0 +1,120 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""
+ Slixmpp: The Slick XMPP Library
+ Copyright (C) 2010 Nathanael C. Fritz
+ This file is part of Slixmpp.
+
+ See the file LICENSE for copying permission.
+"""
+
+import logging
+from getpass import getpass
+from argparse import ArgumentParser
+
+import slixmpp
+from slixmpp.plugins.xep_0394 import stanza as markup_stanza
+
+
+class EchoBot(slixmpp.ClientXMPP):
+
+ """
+ A simple Slixmpp bot that will echo messages it
+ receives, along with a short thank you message.
+ """
+
+ def __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
+ # 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)
+
+ # 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 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 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.
+ """
+ body = msg['body']
+ new_body = self['xep_0394'].to_plain_text(body, msg['markup'])
+ xhtml = self['xep_0394'].to_xhtml_im(body, msg['markup'])
+ print('Plain text:', new_body)
+ print('XHTML-IM:', xhtml['body'])
+ message = msg.reply()
+ message['body'] = new_body
+ message['html']['body'] = xhtml['body']
+ self.send(message)
+
+
+if __name__ == '__main__':
+ # Setup the command line arguments.
+ parser = ArgumentParser(description=EchoBot.__doc__)
+
+ # Output verbosity options.
+ 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.
+ parser.add_argument("-j", "--jid", dest="jid",
+ help="JID to use")
+ parser.add_argument("-p", "--password", dest="password",
+ help="password to use")
+
+ args = parser.parse_args()
+
+ # Setup logging.
+ logging.basicConfig(level=args.loglevel,
+ format='%(levelname)-8s %(message)s')
+
+ if args.jid is None:
+ args.jid = input("Username: ")
+ if args.password is None:
+ args.password = getpass("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(args.jid, args.password)
+ xmpp.register_plugin('xep_0030') # Service Discovery
+ xmpp.register_plugin('xep_0199') # XMPP Ping
+ xmpp.register_plugin('xep_0394') # Message Markup
+
+ # Connect to the XMPP server and start processing XMPP stanzas.
+ xmpp.connect()
+ xmpp.process()