aboutsummaryrefslogtreecommitdiffstats
path: root/reaktor/config.py
blob: dbe5ec396210c5b6dc79e4e5572609598597d5f6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
import os
import re
from os.path import abspath, dirname, expanduser, join

import reaktor  # to get the path to the reaktor basedir

env = os.environ

# TODO: put this somewhere else


def str2bool(v):
    return v.lower() in ("yes", "true", "t", "1")


# ENVIRON CONFIG
# this provides a simple means of reconfiguring this config without the need to
# copy-paste the whole thing
debug = str2bool(env.get('REAKTOR_DEBUG', "False"))
# IRC_NICKNAME is set if the nick changes and the config is getting reloaded
name = env.get('REAKTOR_NICKNAME', 'crabmanner')
irc_server = env.get('REAKTOR_HOST', 'irc.freenode.org')
irc_port = int(env.get('REAKTOR_PORT', 6667))
# TODO: do not implement functionality in the config :\
workdir = env.get('REAKTOR_STATEDIR', expanduser('~') + '/state')
irc_channels = env.get('REAKTOR_CHANNELS', '#krebs').split(',')
try:
    nickserv_password = open(
        env.get('REAKTOR_NICKSERV_PASSWORD')
    ).read().strip()
except:  # noqa: E722
    nickserv_password = None

# static config
# if you want to change this part you have to copy the config
irc_alarm_timeout = 300
irc_hammer_interval = 10
irc_kill_timeout = 360
irc_nickname = name
irc_restart_timeout = 5

# IMPLEMENTATION
# this config contains the implementation of how commands should match

# TODO: YAY more functionality in config.py ..
# create the workdir somewhere # else in the code ...
# if this fails the bot will fail (which is ok)
if not os.path.isdir(workdir):
    os.makedirs(workdir)


admin_file = workdir+'/admin.lst'
auth_file = workdir+'/auth.lst'

config_filename = abspath(__file__)
mod_dir = dirname(abspath(reaktor.__file__))
# the commands dirname (
dist_dir = abspath(join(mod_dir))

# me is used, so name cannot kill our patterns below

# TODO: name may change after reconnect, then this pattern fails to match
# this may need a complete refactor of how to create patterns and matches

# IMPLEMENTATION
me = '\\b' + re.escape(name) + '\\b'
me_or_us = '(?:' + me + '|\\*)'
indirect_pattern = '^'+me_or_us+':\\s*{}\\s*(?:\\s+(?P<args>.*))?$'


def distc(cmd):
    """
    builds a path to a cmd in the command folder of the Reaktor distribution
    """
    return join(dist_dir, "commands", cmd)


def default_command(cap, cmd=None, env=None):
    """ (botname|*): cmd args

    query the bot in the channel, e.g.:
      crabmanner: hello
      *: hello
    """
    if not env:
        env = {}
    if cmd is None:
        cmd = cap
    return {
        'capname': cap,
        'pattern': indirect_pattern.format(cap),
        'argv': [distc(cmd)],
        'env': env
    }


direct_pattern = '^{}\\s*(?:\\s+(?P<args>.*))?$'


def simple_command(cap, cmd=None, env=None):
    """ cmd args

    query the bot directly, e.g.: /msg crabmanner identity dick butt
    """
    if not env:
        env = {}
    if cmd is None:
        cmd = cap
    return {
        'capname': cap,
        'pattern': direct_pattern.format(cap),
        'argv': [distc(cmd)],
        'env': env
    }


# unauthenticated commands
public_commands = [
    default_command('caps', env={
        'config_filename': config_filename
    }),
    default_command('hello'),
    default_command('badcommand'),
    # default_command('rev'), # TODO: when uploaded to pypi the rev gets lost
    default_command('version'),
    default_command('uptime'),
    default_command('nocommand'),
    default_command('tell', cmd='tell-on_privmsg', env={
        'state_file': workdir + '/tell.txt'
    }),
    simple_command('identify', env={
        'config_filename': config_filename
    }),
    # command not found
    # { 'pattern': '^' + me_or_us + ':.*',
    #  'argv': [ distc('respond'),'You are made of stupid!'] },
    # "highlight"
    {'pattern': '.*' + me + '.*',
        'argv': [distc('say'), 'I\'m famous']},
    # identify via direct connect
]

# authenticated commands
commands = [
    default_command('reload'),
]

on_join = [
    {
        'capname': 'tell',
        'argv': [distc('tell-on_join')],
        'env': {'state_file': workdir + '/tell.txt'}
    }
]

# Timer
on_ping = []

# END IMPLEMENTATION