home · contact · privacy
Re-organize code for better extendibility.
[plomlombot-irc.git] / plomlombot.py
1 #!/usr/bin/python3
2
3 import argparse
4 import socket
5 import datetime
6 import select
7 import time
8 import re
9 import requests
10 import bs4
11 import random
12 import hashlib
13 import os
14 import plomsearch
15
16 # Defaults, may be overwritten by command line arguments.
17 SERVER = "irc.freenode.net"
18 PORT = 6667
19 TIMEOUT = 240
20 USERNAME = "plomlombot"
21 NICKNAME = USERNAME
22
23
24 class ExceptionForRestart(Exception):
25     pass
26
27
28 class IO:
29
30     def __init__(self, server, port, timeout):
31         self.timeout = timeout
32         self.socket = socket.socket()
33         self.socket.connect((server, port))
34         self.socket.setblocking(0)
35         self.line_buffer = []
36         self.rune_buffer = ""
37         self.last_pong = time.time()
38         self.servername = self.recv_line(send_ping=False).split(" ")[0][1:]
39
40     def _pingtest(self, send_ping=True):
41         if self.last_pong + self.timeout < time.time():
42             print("SERVER NOT ANSWERING")
43             raise ExceptionForRestart
44         if send_ping:
45             self.send_line("PING " + self.servername)
46
47     def send_line(self, msg):
48         msg = msg.replace("\r", " ")
49         msg = msg.replace("\n", " ")
50         if len(msg.encode("utf-8")) > 510:
51             print("NOT SENT LINE TO SERVER (too long): " + msg)
52         print("LINE TO SERVER: "
53               + str(datetime.datetime.now()) + ": " + msg)
54         msg = msg + "\r\n"
55         msg_len = len(msg)
56         total_sent_len = 0
57         while total_sent_len < msg_len:
58             sent_len = self.socket.send(bytes(msg[total_sent_len:], "UTF-8"))
59             if sent_len == 0:
60                 print("SOCKET CONNECTION BROKEN")
61                 raise ExceptionForRestart
62             total_sent_len += sent_len
63
64     def _recv_line_wrapped(self, send_ping=True):
65         if len(self.line_buffer) > 0:
66             return self.line_buffer.pop(0)
67         while True:
68             ready = select.select([self.socket], [], [], int(self.timeout / 2))
69             if not ready[0]:
70                 self._pingtest(send_ping)
71                 return None
72             self.last_pong = time.time()
73             received_bytes = self.socket.recv(1024)
74             try:
75                 received_runes = received_bytes.decode("UTF-8")
76             except UnicodeDecodeError:
77                 received_runes = received_bytes.decode("latin1")
78             if len(received_runes) == 0:
79                 print("SOCKET CONNECTION BROKEN")
80                 raise ExceptionForRestart
81             self.rune_buffer += received_runes
82             lines_split = str.split(self.rune_buffer, "\r\n")
83             self.line_buffer += lines_split[:-1]
84             self.rune_buffer = lines_split[-1]
85             if len(self.line_buffer) > 0:
86                 return self.line_buffer.pop(0)
87
88     def recv_line(self, send_ping=True):
89         line = self._recv_line_wrapped(send_ping)
90         if line:
91             print("LINE FROM SERVER " + str(datetime.datetime.now()) + ": " +
92                   line)
93         return line
94
95
96 def handle_command(command, argument, notice, target):
97     hash_string = hashlib.md5(target.encode("utf-8")).hexdigest()
98     quotesfile_name = "quotes_" + hash_string
99
100     def addquote():
101         if not os.access(quotesfile_name, os.F_OK):
102             quotesfile = open(quotesfile_name, "w")
103             quotesfile.write("QUOTES FOR " + target + ":\n")
104             quotesfile.close()
105         quotesfile = open(quotesfile_name, "a")
106         quotesfile.write(argument + "\n")
107         quotesfile.close()
108         quotesfile = open(quotesfile_name, "r")
109         lines = quotesfile.readlines()
110         quotesfile.close()
111         notice("ADDED QUOTE #" + str(len(lines) - 1))
112
113     def quote():
114
115         def help():
116             notice("SYNTAX: !quote [int] OR !quote search QUERY")
117             notice("QUERY may be a boolean grouping of quoted or unquoted " +
118                    "search terms, examples:")
119             notice("!quote search foo")
120             notice("!quote search foo AND (bar OR NOT baz)")
121             notice("!quote search \"foo\\\"bar\" AND ('NOT\"' AND \"'foo'\"" +
122                    " OR 'bar\\'baz')")
123
124         if "" == argument:
125             tokens = []
126         else:
127             tokens = argument.split(" ")
128         if (len(tokens) > 1 and tokens[0] != "search") or \
129             (len(tokens) == 1 and
130                 (tokens[0] == "search" or not tokens[0].isdigit())):
131             help()
132             return
133         if not os.access(quotesfile_name, os.F_OK):
134             notice("NO QUOTES AVAILABLE")
135             return
136         quotesfile = open(quotesfile_name, "r")
137         lines = quotesfile.readlines()
138         quotesfile.close()
139         lines = lines[1:]
140         if len(tokens) == 1:
141             i = int(tokens[0])
142             if i == 0 or i > len(lines):
143                 notice("THERE'S NO QUOTE OF THAT INDEX")
144                 return
145             i = i - 1
146         elif len(tokens) > 1:
147             query = str.join(" ", tokens[1:])
148             try:
149                 results = plomsearch.search(query, lines)
150             except plomsearch.LogicParserError as err:
151                 notice("FAILED QUERY PARSING: " + str(err))
152                 return
153             if len(results) == 0:
154                 notice("NO QUOTES MATCHING QUERY")
155             else:
156                 for result in results:
157                     notice("QUOTE #" + str(result[0] + 1) + " : " + result[1])
158             return
159         else:
160             i = random.randrange(len(lines))
161         notice("QUOTE #" + str(i + 1) + ": " + lines[i])
162
163     if "addquote" == command:
164         addquote()
165     elif "quote" == command:
166         quote()
167
168
169 def handle_url(url, notice, show_url=False):
170
171     def mobile_twitter_hack(url):
172         re1 = 'https?://(mobile.twitter.com/)[^/]+(/status/)'
173         re2 = 'https?://mobile.twitter.com/([^/]+)/status/([^\?/]+)'
174         m = re.search(re1, url)
175         if m and m.group(1) == 'mobile.twitter.com/' \
176                 and m.group(2) == '/status/':
177             m = re.search(re2, url)
178             url = 'https://twitter.com/' + m.group(1) + '/status/' + m.group(2)
179             handle_url(url, notice, True)
180             return True
181
182     try:
183         r = requests.get(url, timeout=15)
184     except (requests.exceptions.TooManyRedirects,
185             requests.exceptions.ConnectionError,
186             requests.exceptions.InvalidURL,
187             requests.exceptions.InvalidSchema) as error:
188         notice("TROUBLE FOLLOWING URL: " + str(error))
189         return
190     if mobile_twitter_hack(url):
191         return
192     title = bs4.BeautifulSoup(r.text).title
193     if title:
194         prefix = "PAGE TITLE: "
195         if show_url:
196             prefix = "PAGE TITLE FOR <" + url + ">: "
197         notice(prefix + title.string.strip())
198     else:
199         notice("PAGE HAS NO TITLE TAG")
200
201
202 class Session:
203
204     def __init__(self, io, username, nickname, channel):
205         self.io = io
206         self.nickname = nickname
207         self.io.send_line("NICK " + self.nickname)
208         self.io.send_line("USER " + username + " 0 * : ")
209         self.io.send_line("JOIN " + channel)
210
211     def loop(self):
212
213         def handle_privmsg(tokens):
214
215             def handle_input(msg, target):
216
217                 def notice(msg):
218                     self.io.send_line("NOTICE " + target + " :" + msg)
219
220                 matches = re.findall("(https?://[^\s>]+)", msg)
221                 for i in range(len(matches)):
222                     handle_url(matches[i], notice)
223                 if "!" == msg[0]:
224                     tokens = msg[1:].split()
225                     argument = str.join(" ", tokens[1:])
226                     handle_command(tokens[0], argument, notice, target)
227
228             sender = ""
229             for rune in tokens[0]:
230                 if rune == "!":
231                     break
232                 if rune != ":":
233                     sender += rune
234             receiver = ""
235             for rune in tokens[2]:
236                 if rune == "!":
237                     break
238                 if rune != ":":
239                     receiver += rune
240             target = sender
241             if receiver != self.nickname:
242                 target = receiver
243             msg = str.join(" ", tokens[3:])[1:]
244             handle_input(msg, target)
245
246         while True:
247             line = self.io.recv_line()
248             if not line:
249                 continue
250             tokens = line.split(" ")
251             if len(tokens) > 1:
252                 if tokens[0] == "PING":
253                     self.io.send_line("PONG " + tokens[1])
254                 elif tokens[1] == "PRIVMSG":
255                     handle_privmsg(tokens)
256
257
258 def parse_command_line_arguments():
259     parser = argparse.ArgumentParser()
260     parser.add_argument("-s, --server", action="store", dest="server",
261                         default=SERVER,
262                         help="server or server net to connect to (default: "
263                         + SERVER + ")")
264     parser.add_argument("-p, --port", action="store", dest="port", type=int,
265                         default=PORT, help="port to connect to (default : "
266                         + str(PORT) + ")")
267     parser.add_argument("-t, --timeout", action="store", dest="timeout",
268                         type=int, default=TIMEOUT,
269                         help="timeout in seconds after which to attempt " +
270                         "reconnect (default: " + str(TIMEOUT) + ")")
271     parser.add_argument("-u, --username", action="store", dest="username",
272                         default=USERNAME, help="username to use (default: "
273                         + USERNAME + ")")
274     parser.add_argument("-n, --nickname", action="store", dest="nickname",
275                         default=NICKNAME, help="nickname to use (default: "
276                         + NICKNAME + ")")
277     parser.add_argument("CHANNEL", action="store", help="channel to join")
278     opts, unknown = parser.parse_known_args()
279     return opts
280
281
282 opts = parse_command_line_arguments()
283 while True:
284     try:
285         io = IO(opts.server, opts.port, opts.timeout)
286         session = Session(io, opts.username, opts.nickname, opts.CHANNEL)
287         session.loop()
288     except ExceptionForRestart:
289         io.socket.close()
290         continue