Relocating extras into lib/ansible/modules/ after merge

lib/ansible/modules/notification/irc.py

@@ -0,0 +1,315 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# (c) 2013, Jan-Piet Mens <jpmens () gmail.com>
+#
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+ANSIBLE_METADATA = {'status': ['stableinterface'],
+                    'supported_by': 'community',
+                    'version': '1.0'}
+
+DOCUMENTATION = '''
+---
+module: irc
+version_added: "1.2"
+short_description: Send a message to an IRC channel
+description:
+   - Send a message to an IRC channel. This is a very simplistic implementation.
+options:
+  server:
+    description:
+      - IRC server name/address
+    required: false
+    default: localhost
+  port:
+    description:
+      - IRC server port number
+    required: false
+    default: 6667
+  nick:
+    description:
+      - Nickname to send the message from. May be shortened, depending on server's NICKLEN setting.
+    required: false
+    default: ansible
+  msg:
+    description:
+      - The message body.
+    required: true
+    default: null
+  topic:
+    description:
+      - Set the channel topic
+    required: false
+    default: null
+    version_added: "2.0"
+  color:
+    description:
+      - Text color for the message. ("none" is a valid option in 1.6 or later, in 1.6 and prior, the default color is black, not "none"). 
+        Added 11 more colors in version 2.0.
+    required: false
+    default: "none"
+    choices: [ "none", "white", "black", "blue", "green", "red", "brown", "purple", "orange", "yellow", "light_green", "teal", "light_cyan",
+               "light_blue", "pink", "gray", "light_gray"]
+  channel:
+    description:
+      - Channel name.  One of nick_to or channel needs to be set.  When both are set, the message will be sent to both of them.
+    required: true
+  nick_to:
+    description:
+      - A list of nicknames to send the message to. One of nick_to or channel needs to be set.  When both are defined, the message will be sent to both of them.
+    required: false
+    default: null
+    version_added: "2.0"
+  key:
+    description:
+      - Channel key
+    required: false
+    version_added: "1.7"
+  passwd:
+    description:
+      - Server password
+    required: false
+  timeout:
+    description:
+      - Timeout to use while waiting for successful registration and join
+        messages, this is to prevent an endless loop
+    default: 30
+    version_added: "1.5"
+  use_ssl:
+    description:
+      - Designates whether TLS/SSL should be used when connecting to the IRC server
+    default: False
+    version_added: "1.8"
+  part:
+    description:
+      - Designates whether user should part from channel after sending message or not.
+        Useful for when using a faux bot and not wanting join/parts between messages.
+    default: True
+    version_added: "2.0"
+  style:
+    description:
+      - Text style for the message. Note italic does not work on some clients
+    default: None
+    required: False
+    choices: [ "bold", "underline", "reverse", "italic" ]
+    version_added: "2.0"
+
+# informational: requirements for nodes
+requirements: [ socket ]
+author:
+    - '"Jan-Piet Mens (@jpmens)"'
+    - '"Matt Martz (@sivel)"'
+'''
+
+EXAMPLES = '''
+- irc:
+    server: irc.example.net
+    channel: "#t1"
+    msg: "Hello world"
+
+- local_action:
+    module: irc
+    port: 6669
+    server: "irc.example.net"
+    channel: "#t1"
+    msg: "All finished at {{ ansible_date_time.iso8601 }}"
+    color: red
+    nick: ansibleIRC
+
+- local_action:
+    module: irc
+    port: 6669
+    server: "irc.example.net"
+    channel: "#t1"
+    nick_to: ["nick1", "nick2"]
+    msg: "All finished at {{ ansible_date_time.iso8601 }}"
+    color: red
+    nick: ansibleIRC
+'''
+
+# ===========================================
+# IRC module support methods.
+#
+
+import re
+import socket
+import ssl
+
+from time import sleep
+
+
+def send_msg(msg, server='localhost', port='6667', channel=None, nick_to=[], key=None, topic=None,
+             nick="ansible", color='none', passwd=False, timeout=30, use_ssl=False, part=True, style=None):
+    '''send message to IRC'''
+
+    colornumbers = {
+        'white': "00",
+        'black': "01",
+        'blue': "02",
+        'green': "03",
+        'red': "04",
+        'brown': "05",
+        'purple': "06",
+        'orange': "07",
+        'yellow': "08",
+        'light_green': "09",
+        'teal': "10",
+        'light_cyan': "11",
+        'light_blue': "12",
+        'pink': "13",
+        'gray': "14",
+        'light_gray': "15",
+    }
+
+    stylechoices = {
+        'bold': "\x02",
+        'underline': "\x1F",
+        'reverse': "\x16",
+        'italic': "\x1D",
+    }
+
+    try:
+        styletext = stylechoices[style]
+    except:
+        styletext = ""
+
+    try:
+        colornumber = colornumbers[color]
+        colortext = "\x03" + colornumber
+    except:
+        colortext = ""
+
+    message = styletext + colortext + msg
+
+    irc = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+    if use_ssl:
+        irc = ssl.wrap_socket(irc)
+    irc.connect((server, int(port)))
+    if passwd:
+        irc.send('PASS %s\r\n' % passwd)
+    irc.send('NICK %s\r\n' % nick)
+    irc.send('USER %s %s %s :ansible IRC\r\n' % (nick, nick, nick))
+    motd = ''
+    start = time.time()
+    while 1:
+        motd += irc.recv(1024)
+        # The server might send back a shorter nick than we specified (due to NICKLEN),
+        #  so grab that and use it from now on (assuming we find the 00[1-4] response).
+        match = re.search('^:\S+ 00[1-4] (?P<nick>\S+) :', motd, flags=re.M)
+        if match:
+            nick = match.group('nick')
+            break
+        elif time.time() - start > timeout:
+            raise Exception('Timeout waiting for IRC server welcome response')
+        sleep(0.5)
+
+    if key:
+        irc.send('JOIN %s %s\r\n' % (channel, key))
+    else:
+        irc.send('JOIN %s\r\n' % channel)
+
+    join = ''
+    start = time.time()
+    while 1:
+        join += irc.recv(1024)
+        if re.search('^:\S+ 366 %s %s :' % (nick, channel), join, flags=re.M):
+            break
+        elif time.time() - start > timeout:
+            raise Exception('Timeout waiting for IRC JOIN response')
+        sleep(0.5)
+
+    if topic is not None:
+        irc.send('TOPIC %s :%s\r\n' % (channel, topic))
+        sleep(1)
+
+    if nick_to:
+        for nick in nick_to:
+            irc.send('PRIVMSG %s :%s\r\n' % (nick, message))
+    if channel:
+        irc.send('PRIVMSG %s :%s\r\n' % (channel, message))
+    sleep(1)
+    if part:
+        irc.send('PART %s\r\n' % channel)
+        irc.send('QUIT\r\n')
+        sleep(1)
+    irc.close()
+
+# ===========================================
+# Main
+#
+
+
+def main():
+    module = AnsibleModule(
+        argument_spec=dict(
+            server=dict(default='localhost'),
+            port=dict(type='int', default=6667),
+            nick=dict(default='ansible'),
+            nick_to=dict(required=False, type='list'),
+            msg=dict(required=True),
+            color=dict(default="none", aliases=['colour'], choices=["white", "black", "blue",
+                                                "green", "red", "brown",
+                                                "purple", "orange", "yellow",
+                                                "light_green", "teal", "light_cyan",
+                                                "light_blue", "pink", "gray",
+                                                "light_gray", "none"]),
+            style=dict(default="none", choices=["underline", "reverse", "bold", "italic", "none"]),
+            channel=dict(required=False),
+            key=dict(no_log=True),
+            topic=dict(),
+            passwd=dict(no_log=True),
+            timeout=dict(type='int', default=30),
+            part=dict(type='bool', default=True),
+            use_ssl=dict(type='bool', default=False)
+        ),
+        supports_check_mode=True,
+        required_one_of=[['channel', 'nick_to']]
+    )
+
+    server = module.params["server"]
+    port = module.params["port"]
+    nick = module.params["nick"]
+    nick_to = module.params["nick_to"]
+    msg = module.params["msg"]
+    color = module.params["color"]
+    channel = module.params["channel"]
+    topic = module.params["topic"]
+    if topic and not channel:
+        module.fail_json(msg="When topic is specified, a channel is required.")
+    key = module.params["key"]
+    passwd = module.params["passwd"]
+    timeout = module.params["timeout"]
+    use_ssl = module.params["use_ssl"]
+    part = module.params["part"]
+    style = module.params["style"]
+
+    try:
+        send_msg(msg, server, port, channel, nick_to, key, topic, nick, color, passwd, timeout, use_ssl, part, style)
+    except Exception:
+        e = get_exception()
+        module.fail_json(msg="unable to send to IRC: %s" % e)
+
+    module.exit_json(changed=False, channel=channel, nick=nick,
+                     msg=msg)
+
+# import module snippets
+from ansible.module_utils.basic import *
+from ansible.module_utils.pycompat24 import get_exception
+
+if __name__ == '__main__':
+    main()