Merge pull request #1 from Orderchaos/dev

Dev

OC-bot-v001.py

@@ -8,99 +8,132 @@
 channel = "" # Channel
 botnick = "" # Your bots nick
 lines = 0
-regexes = [".*"]
-combined = "(" + ")|(".join(regexes) + ")"
-log = []
-varstartup = 0
-def ping(): # This is our first function! It will respond to server Pings.
+ircsock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+# connect to the server using the port 6667
+ircsock.connect((server, 6667)) 
+ircsock.send("USER "+ botnick +" "+ botnick +" "+ botnick + " " + botnick + "\n") # user authentication
+ircsock.send("NICK "+ botnick +"\n") # assign the nick to the bot
+ircsock.send("nickserv identify " + password + " \r\n")
+def ping(): # respond to server Pings.
   ircsock.send("PONG :pingis\n")  
 
-def sendmsg(msg): # This is the send message function, it simply sends messages to the channel.
+def sendmsg(msg): # sends messages to the channel.
   ircsock.send("PRIVMSG "+ channel +" :"+ msg +"\n") 
 
-def joinchan(chan): # This function is used to join channels.
+def joinchan(chan): # join channel(s).
   ircsock.send("JOIN "+ chan +"\n")
 
-def whisper(msg, user): # This function sends a whisper to a user 
+def whisper(msg, user): # whisper a user 
   ircsock.send("PRIVMSG " + user + ' :' + msg.strip('\n\r') + '\n')
 
+# Plaintext Find/Replace.
 def sed(msg):
+  # detect if there are fewer than 2 '/' in the message. If so, not a valid find/replace pair, do nothing.
   if msg.count('/') < 2:
     print("not enough arguments")
     return
+  # get the text between the first and last '/' as the 'find' portion
   sedtest=msg.split('/',1)[1].rsplit('/',1)[0]
+  # if there is no text between the first and last '/' (as in 's//somethin') do nothing because there is nothing to find.
   if sedtest == '':
     print("Nothing to find")
     return
+  # set the replace text to everything after the last '/'
   sreplace=msg.split('/',1)[1].rsplit('/',1)[1]
+  # set the default replaced text to a known, default value
   replaced = ".__not found__."
+  # read in the chat log file
   with open("ircchat.log", "r") as ircchat:
     content = ircchat.readlines() 
+  # loop through the chat log and search through the messages for a match to the 'find' string. Ignore any errors -- to be fixed.
   for i in content:
     try:
       if i.split(':',1)[1].find(sedtest) != -1:
         replaced = i
     except Exception:
       pass
+  # if the default replaced text was not changed, no matches were found in the log, do nothing.
   if replaced == ".__not found__.":
     print("not found")
     return
   else:
+  # if the default replaced text was found, perform a replace on the text, strip any newlines, and send to checksend method for verification before sending to channel.
     name = replaced.split(':', 1)[0]
     replaced = replaced.split(':',1)[1].replace(sedtest, sreplace)
     replaced = replaced.strip('\n\r')
     checksend(name,sedtest, replaced)
-ircsock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
-ircsock.connect((server, 6667)) # Here we connect to the server using the port 6667
-ircsock.send("USER "+ botnick +" "+ botnick +" "+ botnick +" :This bot is a result of a tutoral covered on http://shellium.org/wiki.\n") # user authentication
-ircsock.send("NICK "+ botnick +"\n") # here we actually assign the nick to the bot
-ircsock.send("nickserv identify" + password + " \r\n")
+
+# Regex Find/Replace
 def regex(msg):
+  #detect if there are fewer than 2 '|' in the message. If so, not a valid find/replace pair, do nothing.
   if msg.count('|') < 2:
     print("Not enough arguments")
     return
+  # get the text between the first and last '|' as the 'find portion
   sedtest = msg.split('|',1)[1].rsplit('|',1)[0]
+  # if there is no text between the first and last '|' (as in 's||somethin') do nothing because there is nothing to find.
+  if sedtest == '':
+    print("Nothing to find")
+    return
+  # set the replace text to everything after the last '|'
   sreplace = msg.split('|',1)[1].rsplit('|',1)[1]
+  # set the default replaced text to a known, default value
   replaced = ".__not found__."
+  # escape any '*' wildcards as they are too broad so assume they are literal. Needs testing for '\*' searches.
   if (sedtest.find("*") != -1):
     findme = sedtest.replace('*','\*')
+  # if find is a single character, escape it because it any regex would be too broad.
   elif len(sedtest) == 1:
     findme = re.escape(sedtest)
   else:
+  # if neither of the other two are true, set the find string.
     findme = sedtest
   try:
+  # set the pattern to find 
     pattern = re.compile("(%s)" % findme)
   except Exception:
+  # if there is an error, escape the find string and try again. --Needs further testing.
     findme = re.escape(findme)
     pattern = re.compile("(%s)" % findme)
     pass
+  # Read in the chat log
   with open("ircchat.log", "r") as ircchat:
     content = ircchat.readlines()
+  # set default replaced text, username, and found string
   repltext = ('',0)
   name = ''
   found = ''
+  # loop through chat log
   for i in content:
     try:
+      # set text equal to just the message, no username.
       text = i.split(":",1)[1]
+      # search the text for regex pattern, if found, set found equal to the text and replace it with replace string. Set name equal to the username of found message.
       if pattern.search(text):
         text = text.strip('\n\r')
         found = text
         repltext = re.subn(pattern, sreplace, text)
         name = i.split(":",1)[0]
+    # ignore errors and continue. --Needs further testing
     except Exception:
       print('error in search')
       pass
+  # if the regex found more than 10 matches, assume it was too broad and let the user know. --Change to whisper?
   if repltext[1] > 10:
     sendmsg("Too many matches, refine your correction")
     return
+  # set replaced string equal to just the new message and strip newlines, then send to checksend for verification before sending to channel.
   replaced = repltext[0]
   replaced = replaced.strip('\n\r')
   checksend(name,found, replaced, findme)
 
+# log chat messages
 def logger(msg):
+  # open existing chat log and read in the content.
   irclog = open("ircchat.log", 'r')
   content = irclog.readlines()
   irclog.close()
+  # loop through the content of the chat log and reduce to 100 lines, starting with oldest. --Definitely a better way to do this, needs improvement.
   irclog = open("ircchat.log", "w")
   while len(content) > 100:
     content.remove(content[0])
@@ -109,75 +142,102 @@ def logger(msg):
       irclog.write(i.strip('\n\r') + '\n')
     if len(i.strip('\n\r')) == 0:
       irclog.write(":delete\n")
+  # write newest messge to log.
   irclog.write(msg.strip('\n\r') + '\n')
   irclog.close()
 
+# checks messages from find/replace before sending to the channel.
 def checksend(name,orig,new,pattern=''):
-  print(pattern)
+  # if the original message and new message are the same then do nothing.
   if orig == new:
     whisper("No text would be changed.", name)
     return 
+  # if the find used very broad wildcards then do nothing. May need to add more or think of new method for this.
   if pattern in {'\\s','\\S','\\D','\\W', '\\w'}:
     whisper("Wildcard(s) not allowed because they are too broad. If you meant to seach plaintext use 's/[find]/[replace]' or delimit the wildcard (like s|\\\\s|!s", name)
     return 
+  # if new message would be over 200 characters then do not send.
   if len(new) > 200:
     whisper("Resulting message is too long (200 char max)", name)
     return
+  # if new message is empty string do not send.
   if len(new) == 0:
     whisper("Replace resulted in empty messge. Nothing to send", name)
     return
+  # if message isn't caught by one of the checks, send to channel and log the message.
   message="Correction, <" + name + ">: " + new
   sendmsg(message.strip('\r\n'))
   logger(name + ':' +  new)
 
+# send help message to users
 def help(name,topic=''):
+  # set default help message to blank.
   message = ''
+  # if no help topic is specified, send general help message about the bot.
   if topic == '':
     message = "Hi! I am an irc bot created by OrderChaos. Currentl function is find and replace. You can perform a plain text find/replace on recent chat by typing in \'s/[find]/[replace]\' (no quotes) or a regex based find/replace with \'s|[find]|[replace]\'. Note that some wildcards are disabled because they result in too many matches. Please report any bugs or suggestions here: https://github.com/Orderchaos/ircbot/issues" 
+  # if a help message is specified, let the user know it's not coded yet.
   else:
     message = "Feature not yet implemented, sorry. Please see the main help (message me with \'.help\')"
   print(topic)
+  # send help message in whisper to user.
   whisper(message, name)
 
+# main functions of the bot
 def main():
-  joinchan(channel) # Join the channel using the functions we previously defined
+  # start by joining the channel. --TO DO: allow joining list of channels
+  joinchan(channel)
+  # open the chat log file if it exists and delete it to start fresh.
   with open("ircchat.log", "w") as temp:
     temp.write("")
-  start_time = time.time()
-  while 1: # Be careful with these! it might send you to an infinite loop
+  # start infinite loop to continually check for and receive new info from server
+  while 1: 
+    # clear ircmsg value every time
     ircmsg = ""
-    ircmsg = ircsock.recv(2048) # receive data from the server
-    ircmsg = ircmsg.strip('\n\r') # removing any unnecessary linebreaks.
-    print(ircmsg) # Here we print what's coming from the server
-    strmsg = str(ircmsg)
-    if strmsg.find("PING :") != -1: # if the server pings us then we've got to respond!
+    # set ircmsg to new data received from server
+    ircmsg = ircsock.recv(2048)
+    # remove any line breaks
+    ircmsg = ircmsg.strip('\n\r') 
+    # print received message to stdout (mostly for debugging).
+    print(ircmsg) 
+    # repsond to pings so server doesn't think we've disconnected
+    if ircmsg.find("PING :") != -1: 
       ping()
-    if strmsg.find("PRIVMSG") != -1:
-      splitmsg=strmsg.split(':',2)
-      name=strmsg.split('!',1)[0][1:]
+    # look for PRIVMSG lines as these are messages in the channel or sent to the bot
+    if ircmsg.find("PRIVMSG") != -1:
+      # split the message on the first two ':' to get the user and message in separate areas. --Currently does not work with IPv6. Needs rework.
+      splitmsg=ircmsg.split(':',2)
+      # save user name into name variable
+      name=ircmsg.split('!',1)[0][1:]
+      # look for commands and send to appropriate function.
       if splitmsg[2][:2] == 's|':
-        regex(strmsg)
+        regex(ircmsg)
       elif splitmsg[2][:2] == 's/':
-        sed(strmsg)
+        sed(ircmsg)
       elif splitmsg[2][:5] == '.help':
         help(name,splitmsg[2][5:])
       else:
-        name=strmsg.split('!')
+      # if no command found, get 
+        name=ircmsg.split('!')
         finalname=name[0][1:]
         combo=""
+        # hacky method to properly log ':' in messages. Needs rework.
         privmsgfound = "false"
         for combine in splitmsg[1:]:
           if privmsgfound != "false":
             combo=combo + ":" + combine
           if combine.find("PRIVMSG") != -1:
             privmsgfound = "true"
+        # if the parsed user name is longer than 17 characters it's not a valid username so don't log the message.
         if len(finalname) < 17:
           final=finalname+combo
           logger(final)
+          # if the final message is from me and says 'gtfo [bot]' stop the bot and exit. Needs adjustment so it works for main user account and not hardcoded username.
           if final.find("OrderChaos:gtfo %s" % botnick) != -1:
             sendmsg("Oh...okay... :'(")
             ircsock.send("PART " + channel + "\r\n")
             sys.exit()
 
+#start main functioin
 main()