home · contact · privacy
Make python file executable.
[plomlombot-irc.git] / plomlombot.py
old mode 100644 (file)
new mode 100755 (executable)
index 31ea88f..9a8a853
@@ -1,3 +1,6 @@
+#!/usr/bin/python3
+
+import argparse
 import socket
 import datetime
 import select
@@ -6,32 +9,34 @@ import re
 import urllib.request
 import html
 
-servernet = "irc.freenode.net"
-port = 6667
-servername = ""
-timeout = 240
-username = "plomlombot"
-nickname = username
-channel = "#zrolaps"
+# Defaults, may be overwritten by command line arguments.
+SERVER = "irc.freenode.net"
+PORT = 6667
+TIMEOUT = 240
+USERNAME = "plomlombot"
+NICKNAME = USERNAME
 
 class ExceptionForRestart(Exception):
     pass
 
 class IO:
 
-    def __init__(self, server, port):
+    def __init__(self, server, port, timeout):
+        self.timeout = timeout
         self.socket = socket.socket()
         self.socket.connect((server, port))
         self.socket.setblocking(0)
         self.line_buffer = []
         self.rune_buffer = ""
         self.last_pong = time.time()
+        self.servername = self.recv_line(send_ping=False).split(" ")[0][1:]
 
-    def _pingtest(self):
-        if self.last_pong + timeout < time.time():
-            print("SERVER NOT ANSWERING TO PING")
+    def _pingtest(self, send_ping=True):
+        if self.last_pong + self.timeout < time.time():
+            print("SERVER NOT ANSWERING")
             raise ExceptionForRestart
-        self.send_line("PING " + nickname + " " + servername)
+        if send_ping:
+            self.send_line("PING " + self.servername)
 
     def send_line(self, msg):
         msg = msg.replace("\r", " ")
@@ -50,13 +55,13 @@ class IO:
                 raise ExceptionForRestart
             total_sent_len += sent_len
 
-    def recv_line_wrapped(self):
+    def _recv_line_wrapped(self, send_ping=True):
         if len(self.line_buffer) > 0:
             return self.line_buffer.pop(0)
         while True:
-            ready = select.select([self.socket], [], [], int(timeout / 2))
+            ready = select.select([self.socket], [], [], int(self.timeout / 2))
             if not ready[0]:
-                self._pingtest()
+                self._pingtest(send_ping)
                 return None
             self.last_pong = time.time()
             received_runes = self.socket.recv(1024).decode("UTF-8")
@@ -70,23 +75,22 @@ class IO:
             if len(self.line_buffer) > 0:
                 return self.line_buffer.pop(0)
 
-    def recv_line(self):
-        line = self.recv_line_wrapped()
+    def recv_line(self, send_ping=True):
+        line = self._recv_line_wrapped(send_ping)
         if line:
             print("LINE FROM SERVER " + str(datetime.datetime.now()) + ": " +
             line)
         return line
 
-def init_connection():
-    print("CONNECTING TO " + servernet)
-    io = IO(servernet, port)
+def init_session(server, port, timeout, nickname, username, channel):
+    print("CONNECTING TO " + server)
+    io = IO(server, port, timeout)
     io.send_line("NICK " + nickname)
     io.send_line("USER " + username + " 0 * : ")
     io.send_line("JOIN " + channel)
-    servername = io.recv_line().split(" ")[0][1:]
     return io
 
-def lineparser_loop():
+def lineparser_loop(io, nickname):
 
     def act_on_privmsg(tokens):
 
@@ -143,10 +147,35 @@ def lineparser_loop():
             if tokens[0] == "PING":
                 io.send_line("PONG " + tokens[1])
 
+def parse_command_line_arguments():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("-s, --server", action="store", dest="server",
+            default=SERVER,
+            help="server or server net to connect to (default: " + SERVER +
+            ")")
+    parser.add_argument("-p, --port", action="store", dest="port", type=int,
+            default=PORT, help="port to connect to (default : " + str(PORT) +
+            ")")
+    parser.add_argument("-t, --timeout", action="store", dest="timeout",
+            type=int, default=TIMEOUT,
+            help="timeout in seconds after which to attempt reconnect " +
+            "(default: " + str(TIMEOUT) + ")")
+    parser.add_argument("-u, --username", action="store", dest="username",
+            default=USERNAME, help="username to use (default: " + USERNAME +
+            ")")
+    parser.add_argument("-n, --nickname", action="store", dest="nickname",
+            default=NICKNAME, help="nickname to use (default: " + NICKNAME +
+            ")")
+    parser.add_argument("CHANNEL", action="store", help="channel to join")
+    opts, unknown = parser.parse_known_args()
+    return opts
+
+opts = parse_command_line_arguments()
 while 1:
     try:
-        io = init_connection()
-        lineparser_loop()
+        io = init_session(opts.server, opts.port, opts.timeout, opts.nickname,
+                opts.username, opts.CHANNEL)
+        lineparser_loop(io, opts.nickname)
     except ExceptionForRestart:
         io.socket.close()
         continue