Current File : //lib/python2.7/site-packages/salt/engines/ircbot.pyc
�
���^c @@ s d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l
m Z d d l Z
d d l Z
d d l Z e j e � Z d d l Z d d l m Z e d d � Z e d d � Z d
e f d � � YZ d d d d e e d
e e e d �
Z d S( u
IRC Bot engine
.. versionadded:: 2017.7.0
Example Configuration
.. code-block:: yaml
engines:
- ircbot:
nick: <nick>
username: <username>
password: <password>
host: chat.freenode.net
port: 7000
channels:
- salt-test
- '##something'
use_ssl: True
use_sasl: True
disable_query: True
allow_hosts:
- salt/engineer/.*
allow_nicks:
- gtmanfred
Available commands on irc are:
ping
return pong
echo <stuff>
return <stuff> targeted at the user who sent the commands
event <tag> [<extra>, <data>]
fire event on the master or minion event stream with the tag `salt/engines/ircbot/<tag>` and a data object with a
list of everything else sent in the message
Example of usage
.. code-block:: text
08:33:57 @gtmanfred > !ping
08:33:57 gtmanbot > gtmanfred: pong
08:34:02 @gtmanfred > !echo ping
08:34:02 gtmanbot > ping
08:34:17 @gtmanfred > !event test/tag/ircbot irc is useful
08:34:17 gtmanbot > gtmanfred: TaDa!
.. code-block:: text
[DEBUG ] Sending event: tag = salt/engines/ircbot/test/tag/ircbot; data = {'_stamp': '2016-11-28T14:34:16.633623', 'data': ['irc', 'is', 'useful']}
i ( t absolute_importt print_functiont unicode_literalsN( t
namedtuple( t sixu Eventu source code lineu PrivEventu/ source nick user host code channel command linet IRCClientc B@ s� e Z d d d d e e d e e e d �
Z d � Z d � Z e d � � Z d � Z
d � Z d � Z d � Z
d
� Z d � Z d � Z d
� Z d � Z d � Z d � Z RS( i u !c
C@ s� | | _ | | _ | | _ | p$ | | _ | | _ | p< g | _ | | _ | | _ | | _ |
| _ | | _
| | _ t j
j d t � | _ | j j � | j � d S( Nt make_current( t nickt hostt portt usernamet passwordt channelst sslt saslt chart allow_hostst allow_nickst
disable_queryt tornadot ioloopt IOLoopt Falset io_loopR t _connect(
t selfR R R R
R R t use_sslt use_saslR R R R ( ( s7 /usr/lib/python2.7/site-packages/salt/engines/ircbot.pyt __init__U s
c C@ s� t j t j t j d � } | j t k rR t j j | d i t j d 6�| _ n t j j
| � | _ | j j | j � | j j
| j | j f | j � d S( Ni t ssl_optionsu cert_reqs( t sockett AF_INETt SOCK_STREAMR
t TrueR t iostreamt SSLIOStreamt CERT_NONEt _streamt IOStreamt set_close_callbackt on_closedt connectR R t
on_connect( R t _sock( ( s7 /usr/lib/python2.7/site-packages/salt/engines/ircbot.pyR g s (c C@ s | j j d | j � d S( Nu
( R% t
read_untilt _message( R ( ( s7 /usr/lib/python2.7/site-packages/salt/engines/ircbot.pyt
read_messagesp s c C@ sa t j d | � t j d | � } | j d � | j d � | j d � } } } t | | | � S( Nu Received: %su; ^(?:(?P<source>:[^ ]+) )?(?P<code>[^ ]+)(?: (?P<line>.*))?$u sourceu codeu line( t logt debugt ret matcht groupt Event( t linet searcht sourcet code( ( s7 /usr/lib/python2.7/site-packages/salt/engines/ircbot.pyt _events s /c C@ sI t | j t � r | j St g | j D] } t j | | � ^ q& � Sd S( N( t
isinstanceR t boolt anyR1 R2 ( R R R2 ( ( s7 /usr/lib/python2.7/site-packages/salt/engines/ircbot.pyt _allow_hostz s c C@ sI t | j t � r | j St g | j D] } t j | | � ^ q& � Sd S( N( R: R R; R< R1 R2 ( R R R2 ( ( s7 /usr/lib/python2.7/site-packages/salt/engines/ircbot.pyt _allow_nick� s c
C@ sX t j d | j � } | j d � | j d � | j d � } } } t j d j | j � | j � } | rT| j d � | j d � | j d � } } } | j t k r� | j d � r� d S| | j
k r� | } n t | j | | | | j | | | � } | j
| � s| j | � rTt | d
j | � � rTt | d
j | � � | � qTn d S( Nu/ ^:(?P<nick>[^!]+)!(?P<user>[^@]+)@(?P<host>.*)$u nicku useru hostuB ^(?P<channel>[^ ]+) :(?:{0}(?P<command>[^ ]+)(?: (?P<line>.*))?)?$u channelu commandu lineu #u _command_{0}( R1 R2 R7 R3 t formatR R5 R R! t
startswithR t PrivEventR8 R> R= t hasattrt getattr(
R t eventR6 R t userR t channelt commandR5 t privevent( ( s7 /usr/lib/python2.7/site-packages/salt/engines/ircbot.pyt _privmsg� s /!/ '6c C@ s) d j | j | j � } | j | � d S( Nu PRIVMSG {0} :{1}( R? RF R5 t send_message( R RD t message( ( s7 /usr/lib/python2.7/site-packages/salt/engines/ircbot.pyt
_command_echo� s c C@ s) d j | j | j � } | j | � d S( Nu PRIVMSG {0} :{1}: pong( R? RF R RJ ( R RD RK ( ( s7 /usr/lib/python2.7/site-packages/salt/engines/ircbot.pyt
_command_ping� s c @ s� t j d � d k r7 t j j j t t d � j � n d � � f d � } | j j d � } | d } t
| � d k r� i | d d 6} n
i g d 6} | d | | � d
j | j | j
� } | j | � d S( Nu __roleu masteru sock_dirc @ s+ � r � | | � n t d | | � d S( u/
How to fire the event
u
event.sendN( t __salt__( t tagt msg( t fire_master( s7 /usr/lib/python2.7/site-packages/salt/engines/ircbot.pyt fire� s u i i u datau salt/engines/ircbot/u PRIVMSG {0} :{1}: TaDa!( t __opts__t gett saltt utilsRD t get_master_eventt
fire_eventt NoneR5 t splitt lenR? RF R RJ ( R RD RR t argsRO t payloadRK ( ( RQ s7 /usr/lib/python2.7/site-packages/salt/engines/ircbot.pyt _command_event� s "
c C@ s� | j d � j d � } | j | � } | j d k rd t j j j � j | j d j
| j � � n1 | j d k r� t j j j � j | j | � n | j
� d S( Ns
u utf-8u PINGu PONG {0}u PRIVMSG( t rstript decodeR9 R8 R R R t currentt spawn_callbackRJ R? R5 RI R. ( R t rawRD ( ( s7 /usr/lib/python2.7/site-packages/salt/engines/ircbot.pyR- � s ."c C@ s6 | j d � s d | } n | j d j | � � d S( Nu #u JOIN {0}( R@ RJ R? ( R RF ( ( s7 /usr/lib/python2.7/site-packages/salt/engines/ircbot.pyt join_channel� s
c C@ s t j d � | j t k r, | j d � n | j d j | j � � | j d � | j r� | j t k r� t j d j | j
| j � j � � } | j d � | j d j | � � | j d � q� | j d j | j
| j � � n x | j D] } | j
| � q� W| j � d S(
Nu
on_connectu
CAP REQ :saslu NICK {0}u USER saltstack 0 * :saltstacku {0} {0} {1}u AUTHENTICATE PLAINu AUTHENTICATE {0}u CAP ENDu" PRIVMSG NickServ :IDENTIFY {0} {1}( t loggingt infoR R! RJ R? R R t base64t b64encodeR
t encodeR Rd R. ( R t
authstringRF ( ( s7 /usr/lib/python2.7/site-packages/salt/engines/ircbot.pyR* � s
'
"c C@ s t j d � d S( Nu on_closed( Re Rf ( R ( ( s7 /usr/lib/python2.7/site-packages/salt/engines/ircbot.pyR( � s c C@ sL t | t j � r$ | j d � } n t j d | � | j j | d � d S( Nu utf-8u Sending: %ss
( R: R t string_typesRi R/ R0 R% t write( R R5 ( ( s7 /usr/lib/python2.7/site-packages/salt/engines/ircbot.pyRJ � s N( t __name__t
__module__RY R R! R R R. t staticmethodR9 R= R> RI RL RM R^ R- Rd R* R( RJ ( ( ( s7 /usr/lib/python2.7/site-packages/salt/engines/ircbot.pyR T s
i u !c
C@ sD t | | | | | | p g | | | | |
| � } | j j � d S( uo
IRC Bot for interacting with salt.
nick
Nickname of the connected Bot.
host
irc server (example - chat.freenode.net).
port
irc port. Default: 6667
password
password for authenticating. If not provided, user will not authenticate on the irc server.
channels
channels to join.
use_ssl
connect to server using ssl. Default: False
use_sasl
authenticate using sasl, instead of messaging NickServ. Default: False
.. note:: This will allow the bot user to be fully authenticated before joining any channels
char
command character to look for. Default: !
allow_hosts
hostmasks allowed to use commands on the bot. Default: False
True to allow all
False to allow none
List of regexes to allow matching
allow_nicks
Nicks that are allowed to use commands on the bot. Default: False
True to allow all
False to allow none
List of regexes to allow matching
disable_query
Disable commands from being sent through private queries. Require they be sent to a channel, so that all
communication can be controlled by access to the channel. Default: True
.. warning:: Unauthenticated Access to event stream
This engine sends events calls to the event stream without authenticating them in salt. Authentication will
need to be configured and enforced on the irc server or enforced in the irc channel. The engine only accepts
commands from channels, so non authenticated users could be banned or quieted in the channel.
/mode +q $~a # quiet all users who are not authenticated
/mode +r # do not allow unauthenticated users into the channel
It would also be possible to add a password to the irc channel, or only allow invited users to join.
N( R R t start(
R R R R
R R R R R R R R t client( ( s7 /usr/lib/python2.7/site-packages/salt/engines/ircbot.pyRp � s :$( t __doc__t
__future__R R R Rg Re R1 R R
t collectionsR t tornado.ioloopR t tornado.iostreamt getLoggerRm R/ t salt.utils.eventRU t salt.extR R4 RA t objectR RY R R! Rp ( ( ( s7 /usr/lib/python2.7/site-packages/salt/engines/ircbot.pyt <module>8 s$ �
Mini Shell