From a1f26d3141089b16d789f413adca9d3def003bba Mon Sep 17 00:00:00 2001 From: Brian Coca Date: Sun, 5 May 2013 19:34:06 -0400 Subject: [PATCH] new module to do notifications over jabber (xmpp) Signed-off-by: Brian Coca --- library/notification/jabber | 115 ++++++++++++++++++++++++++++++++++++ 1 file changed, 115 insertions(+) create mode 100644 library/notification/jabber diff --git a/library/notification/jabber b/library/notification/jabber new file mode 100644 index 00000000000..482182f31c1 --- /dev/null +++ b/library/notification/jabber @@ -0,0 +1,115 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- + +DOCUMENTATION = ''' +--- +module: jabber +short_description: Send a message to jabber user or chat room +description: + - Send a message to jabber +options: + user: + description: + User as which to connect + required: true + password: + description: + password for user to connect + required: true + to: + description: + user ID or name of the room. + required: true + msg: + description: + - The message body. + required: true + default: null + host: + description: + host to connect, overrides user info + required: false + port: + description: + port to connect to, overrides default + required: false + default: 5222 + encoding: + description: + message encoding + required: false + +# informational: requirements for nodes +requirements: [ xmpp ] +author: Brian Coca +''' + +EXAMPLES = ''' +- description: message to jabber user/room + code: jabber: user=mybot@chatserver.tld password=secret to=mychaps@chatserver.tld msg="Ansible task finished" + +- description: message specifying host and port + code: jabber user=mybot@chatserver.tld host=talk.chatserver.tld port=5223 password=secret to=mychaps@chatserver.tld msg="Ansible task finished" +''' + +import os +import time + +HAS_XMPP = True +try: + import xmpp +except ImportError: + HAS_XMPP = False + +def main(): + + module = AnsibleModule( + argument_spec=dict( + user=dict(required=True), + password=dict(required=True), + to=dict(required=True), + msg=dict(required=True), + host=dict(required=False), + port=dict(required=False,default=5222), + encoding=dict(required=False), + ), + supports_check_mode=True + ) + + if not HAS_XMPP: + module.fail_json(msg="xmpp is not installed") + + jid = xmpp.JID(module.params['user']) + user = jid.getNode() + server = jid.getDomain() + port = module.params['port'] + if module.params['host']: + host = module.params['host'] + else: + host = server + password = module.params['password'] + if module.params['encoding']: + xmpp.simplexml.ENCODING = params['encoding'] + + try: + conn=xmpp.Client(server) + if not conn.connect(server=(host,port)): + module.fail_json(rc=1, msg='Failed to connect to server: %s' % (server)) + if not conn.auth(user,password,'Ansible'): + module.fail_json(rc=1, msg='Failed to authorize %s on: %s' % (user,server)) + + # some old servers require this, also the sleep following send + conn.sendInitPresence(requestRoster=0) + if not module.check_mode: + conn.send(xmpp.Message(module.params['to'], module.params['msg'])) + time.sleep(1) + conn.disconnect() + except Exception, e: + module.fail_json(msg="unable to send msg: %s" % e) + + changed = True + module.exit_json(changed=changed, to=module.params['to'], user=module.params['user'], msg=module.params['msg']) + +# this is magic, see lib/ansible/module_common.py +#<> +main()