Adding execution and state modules for xmpp

salt/modules/xmpp.py

@@ -0,0 +1,91 @@
+'''
+Module for sending messages via xmpp (aka, jabber)
+
+:depends:   - sleekxmpp python module
+:configuration: This module can be used by either passing a jid and password
+    directly to send_message, or by specifying the name of a configuration
+    profile in the minion config, minion pillar, or master config.
+
+    For example::
+
+        my-xmpp-login:
+            xmpp.jid: myuser@jabber.example.org/resourcename
+            xmpp.password: verybadpass
+
+    The resourcename refers to the resource that is using this account. It is
+    user-definable, and optional. The following configurations are both valid:
+
+        my-xmpp-login:
+            xmpp.jid: myuser@jabber.example.org/salt
+            xmpp.password: verybadpass
+
+        my-xmpp-login:
+            xmpp.jid: myuser@jabber.example.org
+            xmpp.password: verybadpass
+
+'''
+
+HAS_LIBS = False
+try:
+    import sleekxmpp
+    HAS_LIBS = True
+except ImportError:
+    pass
+
+__virtualname__ = 'xmpp'
+
+
+def __virtual__():
+    '''
+    Only load this module if sleekxmpp is installed on this minion.
+    '''
+    if HAS_LIBS:
+        return __virtualname__
+    return False
+
+
+class SendMsgBot(sleekxmpp.ClientXMPP):
+
+    def __init__(self, jid, password, recipient, msg):
+        super(SendMsgBot, self).__init__(jid, password)
+
+        self.recipient = recipient
+        self.msg = msg
+
+        self.add_event_handler('session_start', self.start)
+
+    def start(self, event):
+        self.send_presence()
+        self.get_roster()
+
+        self.send_message(mto=self.recipient,
+                          mbody=self.msg,
+                          mtype='chat')
+
+        self.disconnect(wait=True)
+
+
+def send_msg(recipient, message, jid=None, password=None, profile=None):
+    '''
+    Send a message to an XMPP recipient. Designed for use in states.
+
+    CLI Examples::
+
+        xmpp.send_msg 'admins@xmpp.example.com' 'This is a salt module test' \
+            profile='my-xmpp-account'
+        xmpp.send_msg 'admins@xmpp.example.com' 'This is a salt module test' \
+            jid='myuser@xmpp.example.com/salt' password='verybadpass'
+    '''
+    if profile:
+        creds = __salt__['config.option'](profile)
+        jid = creds.get('xmpp.jid')
+        password = creds.get('xmpp.password')
+
+    xmpp = SendMsgBot(jid, password, recipient, message)
+    xmpp.register_plugin('xep_0030') # Service Discovery
+    xmpp.register_plugin('xep_0199') # XMPP Ping
+
+    if xmpp.connect():
+        xmpp.process(block=True)
+        return True
+    return False

salt/states/xmpp.py

@@ -0,0 +1,58 @@
+# -*- coding: utf-8 -*-
+'''
+Sending Messages over XMPP
+==========================
+
+This state is useful for firing messages during state runs, using the XMPP
+protocol
+
+.. code-block:: yaml
+
+    server-warning-message:
+      xmpp.send_msg:
+        - name: 'This is a server warning message'
+        - profile: my-xmpp-account
+        - recipient: admins@xmpp.example.com/salt
+'''
+
+
+def __virtual__():
+    '''
+    Only load if the XMPP module is available in __salt__
+    '''
+    return 'xmpp' if 'xmpp.send_msg' in __salt__ else False
+
+
+def send_msg(name, recipient, profile):
+    '''
+    Send a message to an XMPP user
+
+    .. code-block:: yaml
+    
+        server-warning-message:
+          xmpp.send_msg:
+            - name: 'This is a server warning message'
+            - profile: my-xmpp-account
+            - recipient: admins@xmpp.example.com/salt
+
+    name
+        The message to send to the XMPP user
+    '''
+    ret = {'name': name,
+           'changes': {},
+           'result': None,
+           'comment': ''}
+    if __opts__['test']:
+        ret['comment'] = 'Need to send message to {0}: {1}'.format(
+            recipient,
+            name,
+        )
+        return ret
+    __salt__['xmpp.send_msg'](
+        message=name,
+        recipient=recipient,
+        profile=profile,
+    )
+    ret['result'] = True
+    ret['comment'] = 'Sent message to {0}: {1}'.format(recipient, name)
+    return ret