#!/usr/bin/env python
# -*- coding: utf-8 -*-

import sys, socket, shelve, time, traceback, random

#EDIT the lines that follow
#Also remember to create two files in the same directory as the script. They should be named 'passwd' and 'owners'. 'passwd' should contain the password #for the nick the bot will be using. If you didn't register the nick, please still create a file and in there put (secret) WITH the parenthesis.
#On the 'owners' file, put a single nickname that will have the abilities of owner. To add other owners it is recommended to do it via IRC.
HOST="irc.freenode.net"
PORT=6667
NICK="PedroBot"
USERNAME="PedroBot"
REALNAME="PedroBot"
CHANNEL="##pedro3005"
#COMMENT (add a # to the beginning) the two following lines. they are here to warn a user if he didn't edit the lines properly."
#print "Open the script and edit the first few lines accordingly. Instructions are provided in it."
#exit()
#editing beyond this line is NOT necessary


tries = 0 #this is related to the roulette function.
recv="" #this is the variable that will receive from the socket
bot_is_opped = 0
passwd = open("passwd", "r")
PASSWORD = passwd.read().split("\n")[0]
owners = []
owners_get = open("owners", "r")
for line in owners_get :
    owners.append(line.split('\n')[0])
log_enabled = 0
factoids = shelve.open("factoids", writeback=True)

def parsemsg(s) :
    # this function takes a normal IRC message such as :
    # :pedro3005!~pedro@xxx.xxx.xxx.xxx PRIVMSG ##pedro3005 :yay
    #and defines:
    #prefix = pedro3005!~pedro@xxx.xxx.xxx.xxx
    #command = PRIVMSG
    #args = ['##pedro3005', 'yay']
    #the actual message will always be args[-1], but don't worry since we define that later. use the variable 'message'. also don't worry about the variable trailing.
    trailing = 0
    prefix = 0
    if s[0] == ":" :
        s = s[1:].split(' ', 1)
        prefix = s[0]
        s = s[1]
    if " :" in s :
        s = s.split(" :")
        trailing = s[1]
        s = s[0]
    args = s.split()
    command = args.pop(0)
    if trailing != 0 :
        args.append(trailing)
    return prefix, command, args

def chanmsg(*msgs) :
    #this function will make the bot send a message to the channel. in-code, simply call it with chanmsg("message"). you can also call it via IRC with the command !say, but only if you're an owner.
    if nick in owners :
        msg = " ".join(msgs)
        socket.send("PRIVMSG %s :%s\r\n" % (CHANNEL, msg))
    else :
        chanmsg("Permission denied.")

def chanact(*acts) :
    # similar to the above function but makes the bot act, i.e. /me. in code, call it with chanact("aaaa"), on IRC there is !act. works only for owners.
    if nick in owners :
        act = " ".join(acts)
        socket.send("PRIVMSG %s :\x01ACTION %s\x01\r\n" % (CHANNEL, act))
    else :
        chanmsg("Permission denied.")

def kill(nick) :
    if not nick in owners :
        chanact("kills %s unmercifully!" % (nick))
    else :
        chanmsg("I shall not kill my master.")

def read_factoids() :
    fact_list = []
    for item in factoids :
        fact_list.append(item[1:]) #this simply takes out the '!' from the name
    chanmsg("Available factoids: %s" % (", ".join(fact_list)))

def new_factoid(name, nothing, *definitions) :
    if not name.startswith("!") : #avoids someone trying to create a factoid with ! on the beginning (could confuse the bot)
        definition = " ".join(definitions)
        factoids["!" + name] = definition
        chanmsg("Factoid %s added successfuly" % (name))
    else :
        chanmsg("You're not going to break me")
def del_factoid(*names) :
    factoids_deleted = []
    factoids_notfound = []
    name = " ".join(names).split()
    if nick in owners :
        for factoid in name :
            try :
                del factoids["!" + factoid]
            except :
                factoids_notfound.append(factoid)
            else :
                factoids_deleted.append(factoid)
        if len(factoids_deleted) > 0 :
            chanmsg("Successfuly deleted factoids: %s" % (", ".join(factoids_deleted)))
        if len(factoids_notfound) > 0 :
            chanmsg("Factoids not found: %s" % (", ".join(factoids_notfound)))

def add_owner(name) :
    if nick in owners :
        owners.append(name)
        write = open("owners", "a")
        write.write(name + '\n')
    if name in owners :
        chanmsg("Owner %s added successfuly." % (name))

def read_owners() :
    rowners = ", ".join(owners) #rowners is from r(ead)owners :P
    chanmsg("Owners: %s" % (rowners))

def kick(name, nothing, *reasons) :
    reason = " ".join(reasons)
    if nick in owners :
        socket.send("KICK %s %s :%s\r\n" % (CHANNEL, name, reason))
        if not bot_is_opped == 1 :
            chanmsg("I'm not an OP.")
    else :
        chanmsg("Permission denied.")

def ismsg(msg) :
    if command == "PRIVMSG" and args[0] == CHANNEL : #see the parsemsg function if in doubt
        return True

def log_on() :
    global log_enabled, log #necessary to work with functions defined elsewhere inside a function
    if nick in owners :
        if log_enabled == 0 : #checks if it isn't already logging
            log = open(CHANNEL, "a")
            log.write(time.strftime("%a, %d %b %Y %H:%M:%S", time.localtime()) + '\n' + '----------------------------' + '\n')
            log_enabled = 1
            chanmsg("Logging started")
            log.flush()
        else :
            chanmsg("I am already logging.")
    else :
        chanmsg("Permission denied.")
def log_off() :
    global log_enabled, log
    if nick in owners :
        if log_enabled == 1 :
            log_enabled = 0
            log.write("-------END OF LOG-----\n")
            log.flush()
            chanmsg("Stopped logging")
        else :
            chanmsg("I am not logging anything.")

def ircroulette() :
    global tries
    chance = random.choice(range(1, 5)) #the range is (1, 5) but the possible numbers are [1, 2, 3, 4]. you can increase the range, i'm not sure which is correct
    if tries == 4 or chance == 4 :
        kick(nick, "because", "*BAM*")
        tries = 0
    else :
        tries = tries + 1
        chanmsg("*tick*")

def topic(*ntpcs) : #ntpcs is from n(ew)t(o)p(i)cs
    ntpc = " ".join(ntpcs)
    if nick in owners :
        socket.send("TOPIC %s :%s\r\n" % (CHANNEL, ntpc))
        if not bot_is_opped == 1 :
            chanmsg("I'm not an OP.")
    else :
        chanmsg("Permission denied.")

commands = { #this dict is extremely important. in here, assign a command which preceded by ! on irc will call the function. ex: "a": a -> if someone types !a it'll call the function a
    "kill": kill,
    "factoids": read_factoids,
    "add": new_factoid,
    "del": del_factoid,
    "add_owner": add_owner,
    "owners": read_owners,
    "kick": kick,
    "log": log_on,
    "log_off": log_off,
    "roulette": ircroulette,
    "say": chanmsg,
    "act": chanact,
    "topic": topic
}


socket = socket.socket()
socket.connect((HOST, PORT))
if PASSWORD != "(secret)" : #this is to check if the person actually set a password
    socket.send("PASS %s\r\n" % (PASSWORD))
socket.send("NICK %s\r\n" % (NICK))
socket.send("USER %s * * :%s\r\n" % (USERNAME, REALNAME))
socket.send("JOIN %s\r\n" % (CHANNEL))

while True :
    recv = recv + socket.recv(4096)
    s = recv.split("\r\n")
    recv = s.pop() #this simply takes the part before the \r\n
    for msg in s :
        print msg
        prefix, command, args = parsemsg(msg)
        try : #here we assign some basic variables. message is whatever someone typed. if someone typed !kill, bot_cmd will be kill. bot_cmd_args will be a list of whatever is after bot_cmd. nick will be the person's nick.
            message = args[-1]
            bot_cmd = message.split()[0][1:]
            bot_cmd_args = message.split()[1:]
            nick = prefix.split("!")[0]
        except :
            pass
        if command == "MODE" and "+o" in args and NICK in args : #detect ops and deops of the bot
            bot_is_opped = 1
        elif command == "MODE" and "-o" in args and NICK in args :
            bot_is_opped = 0
        if command == "KICK" and NICK in args : #detects kicks
            socket.send("JOIN %s\r\n" % (CHANNEL))
        if log_enabled == 1 and ismsg(msg) : #if logging is enabled and the msg is a real message by someone, it writes to the log life.
            log.write("%s: %s\n" % (nick, message))
            log.flush()
        if command == "PING" : #this is to respond for pings, necessary or you will get kicked out of the network eventually.
            socket.send("PONG\r\n")
        elif bot_cmd in commands and message.startswith("!") :
            try :
                commands[bot_cmd](*bot_cmd_args) #this is necessary or someone can give too many arguments for a function and break the bot
            except :
                chanmsg("Error encountered. You probably didn't provide enough or provided too much arguments for a function. Try again")
        elif message.startswith("!") and "!" + bot_cmd in factoids.keys() :
            socket.send("PRIVMSG %s :%s\r\n" % (CHANNEL, factoids["!" + bot_cmd]))