ansible/library/notification/irc

206 lines
5.6 KiB
Text
Raw Normal View History

#!/usr/bin/python
2013-05-08 13:24:31 +02:00
# -*- 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/>.
#
DOCUMENTATION = '''
---
module: irc
version_added: "1.2"
2013-05-08 13:24:31 +02:00
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. May be shortened, depending on server's NICKLEN setting.
2013-05-08 13:24:31 +02:00
required: false
default: ansible
msg:
description:
- The message body.
required: true
default: null
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").
2013-05-08 13:24:31 +02:00
required: false
default: "none"
choices: [ "none", "yellow", "red", "green", "blue", "black" ]
2013-05-08 13:24:31 +02:00
channel:
description:
- Channel name
required: true
2014-07-16 12:42:21 +02:00
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
2013-05-08 13:24:31 +02:00
# informational: requirements for nodes
requirements: [ socket ]
author: Jan-Piet Mens, Matt Martz
2013-05-08 13:24:31 +02:00
'''
EXAMPLES = '''
- irc: server=irc.example.net channel="#t1" msg="Hello world"
2013-05-11 22:25:22 +02:00
- local_action: irc port=6669
channel="#t1"
msg="All finished at {{ ansible_date_time.iso8601 }}"
color=red
nick=ansibleIRC
2013-05-08 13:24:31 +02:00
'''
# ===========================================
# IRC module support methods.
#
import re
2013-05-08 13:24:31 +02:00
import socket
from time import sleep
2014-07-16 12:42:21 +02:00
def send_msg(channel, msg, server='localhost', port='6667', key=None,
nick="ansible", color='none', passwd=False, timeout=30):
2013-05-08 13:24:31 +02:00
'''send message to IRC'''
colornumbers = {
'black': "01",
'red': "04",
'green': "09",
'yellow': "08",
'blue': "12",
2013-05-08 13:24:31 +02:00
}
try:
colornumber = colornumbers[color]
colortext = "\x03" + colornumber
2013-05-08 13:24:31 +02:00
except:
colortext = ""
2013-05-08 13:24:31 +02:00
message = colortext + msg
2013-05-08 13:24:31 +02:00
irc = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
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)
2014-03-05 05:12:21 +01:00
# 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)
2014-07-16 12:42:21 +02:00
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)
irc.send('PRIVMSG %s :%s\r\n' % (channel, message))
sleep(1)
irc.send('PART %s\r\n' % channel)
irc.send('QUIT\r\n')
sleep(1)
2013-05-08 13:24:31 +02:00
irc.close()
# ===========================================
# Main
#
def main():
2013-05-08 13:24:31 +02:00
module = AnsibleModule(
argument_spec=dict(
server=dict(default='localhost'),
port=dict(default=6667),
nick=dict(default='ansible'),
msg=dict(required=True),
color=dict(default="none", choices=["yellow", "red", "green",
"blue", "black", "none"]),
channel=dict(required=True),
2014-07-16 12:42:21 +02:00
key=dict(),
passwd=dict(),
timeout=dict(type='int', default=30)
2013-05-08 13:24:31 +02:00
),
supports_check_mode=True
)
server = module.params["server"]
port = module.params["port"]
nick = module.params["nick"]
msg = module.params["msg"]
color = module.params["color"]
2013-05-08 13:24:31 +02:00
channel = module.params["channel"]
2014-07-16 12:42:21 +02:00
key = module.params["key"]
passwd = module.params["passwd"]
timeout = module.params["timeout"]
2013-05-08 13:24:31 +02:00
try:
2014-07-16 12:42:21 +02:00
send_msg(channel, msg, server, port, key, nick, color, passwd, timeout)
2013-05-08 13:24:31 +02:00
except Exception, e:
module.fail_json(msg="unable to send to IRC: %s" % e)
module.exit_json(changed=False, channel=channel, nick=nick,
2013-05-08 13:24:31 +02:00
msg=msg)
2013-12-02 21:13:49 +01:00
# import module snippets
from ansible.module_utils.basic import *
2013-05-08 13:24:31 +02:00
main()