adminsys/welcomebot
adminsys/welcomebot
9
0
Fork 0
Code Issues Pull Requests Releases Activity

cleaned up, added nicks.csv & funcs to access it

Browse Source
This commit is contained in:
Shauna 2014-01-10 20:19:10 -05:00
parent a62790497d
commit 15a8da0a35
2 changed files with 71 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

116
bot.py
View File

@ -1,14 +1,16 @@
# Import some necessary libraries. # Import some necessary libraries.
import socket import socket
import time import time
import csv
import Queue import Queue
import random import random
from threading import Thread from threading import Thread
# Some basic variables used to configure the bot # Some basic variables used to configure the bot
server = "irc.freenode.net" # Server server = "irc.freenode.net"
channel = "#openscienceframework" # Channel channel = "#openhatch"
botnick = "ShaunaBot" # Your bots nick botnick = "WelcomeBot"
waitTime = 60 # Amount of time after joining before bot replies to someone
# Connects to server and joins channel # Connects to server and joins channel
ircsock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) ircsock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
@ -16,18 +18,18 @@ ircsock.connect((server, 6667)) # Here we connect to the server using the port 6
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("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("NICK "+ botnick +"\n") # here we actually assign the nick to the bot
def joinchan(chan): # This function is used to join channels. def joinchan(chan):
ircsock.send("JOIN "+ chan +"\n") ircsock.send("JOIN "+ chan +"\n")
joinchan(channel) joinchan(channel)
# Creates separate thread for reading messages from the server # Creates separate thread for reading messages from the server
def getIRC(): def getIRC():
while True: while True:
ircmsg = ircsock.recv(2048) # receive data from the server ircmsg = ircsock.recv(2048) # receive data from the server
ircmsg = ircmsg.strip('\n\r') # removing any unnecessary linebreaks. ircmsg = ircmsg.strip('\n\r') # removing any unnecessary linebreaks.
q.put(ircmsg) # Put in queue for main loop to read q.put(ircmsg) # Put in queue for main loop to read
print(ircmsg) print(ircmsg)
q = Queue.LifoQueue() q = Queue.LifoQueue()
t = Thread(target=getIRC) t = Thread(target=getIRC)
@ -37,63 +39,83 @@ t.start()
# Classes # Classes
class newcomer(object): # Newcomer class created when someone joins the room class newcomer(object): # Newcomer class created when someone joins the room
def __init__(self, nick): def __init__(self, nick):
self.nick = nick self.nick = nick
self.born = time.time() self.born = time.time()
self.status = 0 self.status = 0
def changeStatus(self,status): def updateStatus(self,status=0):
self.status = status # Right now there's just status 0 (not replied to) and 1 (replied to) self.status = status
def aroundFor(self): def aroundFor(self):
return time.time() - self.born return time.time() - self.born
# Functions # Functions
def ping(): # Responds to server Pings. def ping(): # Responds to server Pings.
ircsock.send("PONG :pingis\n") ircsock.send("PONG :pingis\n")
def hello(speaker,greeting): # This function responds to a user that inputs "Hello Mybot" def hello(actor,greeting): # This function responds to a user that inputs "Hello Mybot"
ircsock.send("PRIVMSG " + channel +" :" + greeting + " " + speaker + "\n") ircsock.send("PRIVMSG " + channel +" :" + greeting + " " + actor + "\n")
def help(speaker): # This function explains what the bot is when queried. def help(actor): # This function explains what the bot is when queried.
ircsock.send("PRIVMSG " + channel +" :I'm a bot! I'm from here: https://github.com/shaunagm/oh-irc-bot. You can change my behavior by submitting a pull request or by talking to shauna. \n") ircsock.send("PRIVMSG " + channel +" :I'm a bot! I'm from here: https://github.com/shaunagm/oh-irc-bot. You can change my behavior by submitting a pull request or by talking to shauna. \n")
def welcome(newcomer): # This welcomes a specific person. def welcome(newcomer): # This welcomes a specific person.
ircsock.send("PRIVMSG "+ channel +" :Welcome "+ newcomer + "!\n") ircsock.send("PRIVMSG "+ channel +" :Welcome "+ newcomer + "! The channel's pretty quiet right now, so I thought I'd say hello, and ping my maintainers(shauna, paulproteus) that you're here. If no one responds for a while, try emailing us at hello@openhatch.org or just coming back later.\n")
ircsock.send("PRIVMSG "+ channel +" :(pssst shauna there's someone here)\n")
def makeNickArray(): # On startup, makes array of nicks from Nicks.txt. New info will be written to both array and txt file.
nickArray = []
with open('nicks.csv', 'rb') as csvfile:
nicksData = csv.reader(csvfile, delimiter=',', quotechar='|')
for row in nicksData:
nickArray.append(row)
# Do I need to explicitly close this?
def addPerson(person): # After a newcomer has been greeted (either by the bot, or someone else) their information will be set recorded.
nicksData.append(person)
with open('nicks.csv', 'wb') as csvfile:
nickwriter = csv.writer(csvfile, delimiter=',', quotechar='|', quoting=csv.QUOTE_MINIMAL)
nickwriter.writerow([person])
#### Main function #### Main function
newList = [] newList = [] # This is the array of newcomer objects that people who join the room are added to.
helloArray = ['Hello','hello','Hi','hi','Hey','hey','Yo','yo ','Sup','sup'] helloArray = ['Hello','hello','Hi','hi','Hey','hey','Yo','yo ','Sup','sup']
helpArray = ['Help','help','Info','info','faq','FAQ','explain yourself','EXPLAIN YOURSELF'] helpArray = ['Help','help','Info','info','faq','FAQ','explain yourself','EXPLAIN YOURSELF']
while 1: while 1:
for i in newList: for i in newList:
if i.aroundFor() > 5 and i.status == 0: i.updateStatus()
print welcome(i.nick) if i.status == 0 and i.aroundFor > waitTime:
i.changeStatus(2) welcome(i.nick)
i.updateStatus(1)
addPerson(i)
if q.empty() == 0: if q.empty() == 0:
ircmsg = q.get() ircmsg = q.get()
speaker = ircmsg.split(":")[1].split("!")[0] actor = ircmsg.split(":")[1].split("!")[0]
if ircmsg.find("PRIVMSG "+ channel) != -1: # If someone has spoken into the channel # Welcome functions
for i in newList: if ircmsg.find("PRIVMSG "+ channel) != -1: # If someone has spoken into the channel
if speaker != i.nick: # Don't turn off response if the person speaking is the person who joined. for i in newList:
i.changeStatus(1) # set status to "someone has spoken in channel" for all waiting newcomers if actor != i.nick: # Don't turn off response if the person speaking is the person who joined.
i.updateStatus(1) # Sets status to 1
addPerson(i)
## Else: Do we want to do something if the person who joined the chat says something?
if ircmsg.find(botnick) != -1 and ircmsg.find("PRIVMSG #") != -1: # If someone talks to (or refers to) the bot if ircmsg.find("JOIN "+ channel) != -1: # If someone joins #channel
if any(x in ircmsg for x in helloArray): if actor != botnick: # Remove the case where the bot gets a message that the bot has joined.
hello(speaker,random.choice(helloArray)) if actor not in nickArray:
if any(y in ircmsg for y in helpArray): newList.append(newcomer(actor)) # Create a newcomer object and append to list.
help(speaker)
if ircmsg.find("PING :") != -1: # if the server pings us then we've got to respond! # Unwelcome functions
ping() if ircmsg.find(botnick) != -1 and ircmsg.find("PRIVMSG #") != -1: # If someone talks to (or refers to) the bot
if any(x in ircmsg for x in helloArray):
hello(actor,random.choice(helloArray))
if any(y in ircmsg for y in helpArray):
help(actor)
if ircmsg.find("JOIN "+ channel) != -1: # If someone joins #channel if ircmsg.find("PING :") != -1: # if the server pings us then we've got to respond!
if speaker != botnick: # Probably a cleaner way to do this ping()
newList.append(newcomer(speaker)) # Create a newcomer object and append to list.

2
nicks.csv Normal file
View File

@ -0,0 +1,2 @@
paulproteus, shauna, britta, skay
1 paulproteus shauna britta skay