]> jfr.im git - erebus.git/blobdiff - modules/trivia.py
added ability for bot to update a trivia hall-of-fame
[erebus.git] / modules / trivia.py
index 28ba64d06be6cf5478e86f2c34b4c4bf77b8ac5c..7e9283c4cef13b621be5a85a6188adb9a0164fa0 100644 (file)
@@ -2,17 +2,6 @@
 # trivia module
 # This file is released into the public domain; see http://unlicense.org/
 
-#TODO:
-#      stop game after X unanswered questions
-#      bonus points
-#      v2
-#              team play
-#              statistics
-
-HINTTIMER = 15.0                  # how long between hints
-HINTNUM = 3                       # how many hints to give
-MAXMISSEDQUESTIONS = 5            # how many missed questions before game stops
-
 # module info
 modinfo = {
        'author': 'Erebus Team',
@@ -35,13 +24,11 @@ def modstop(*args, **kwargs):
        return lib.modstop(*args, **kwargs)
 
 # module code
-import json, random, threading, re, time
+import json, random, threading, re, time, datetime
 
 try:
-       import twitter
-       hastwitter = True
-except ImportError:
-       hastwitter = False
+       import twitter 
+except: pass # doesn't matter if we don't have twitter, updating the status just will fall through the try-except if so...
 
 def findnth(haystack, needle, n): #http://stackoverflow.com/a/1884151
        parts = haystack.split(needle, n+1)
@@ -50,7 +37,7 @@ def findnth(haystack, needle, n): #http://stackoverflow.com/a/1884151
        return len(haystack)-len(parts[-1])-len(needle)
 
 class TriviaState(object):
-       def __init__(self, questionfile, parent=None):
+       def __init__(self, questionfile, parent=None, pointvote=False):
                self.parent = parent
                self.questionfile = questionfile
                self.db = json.load(open(questionfile, "r"))
@@ -65,13 +52,25 @@ class TriviaState(object):
                self.gameover = False
                self.missedquestions = 0
 
+               if 'starttime' not in self.db or self.db['starttime'] is None:
+                       self.db['starttime'] = time.time()
+
+               if pointvote:
+                       self.getchan().msg("Vote for the next round target points! Options: %s. Vote using !vote <choice>" % (', '.join([str(x) for x in self.db['targetoptions']])))
+                       self.getchan().msg("You have %s seconds." % (self.db['votetimer']))
+                       self.voteamounts = dict([(x, 0) for x in self.db['targetoptions']]) # make a dict {pointsoptionA: 0, pointsoptionB: 0, ...}
+                       self.pointvote = threading.Timer(self.db['votetimer'], self.endPointVote)
+                       self.pointvote.start()
+               else:
+                       self.pointvote = None
+
        def __del__(self):
                self.closeshop()
        def closeshop(self):
                if threading is not None and threading._Timer is not None and isinstance(self.steptimer, threading._Timer):
                        self.steptimer.cancel()
                if json is not None and json.dump is not None:
-                       json.dump(self.db, open(self.questionfile, "w"), indent=4, separators=(',',': '))
+                       json.dump(self.db, open(self.questionfile, "w"))#, indent=4, separators=(',', ': '))
 
        def getchan(self):
                return self.parent.channel(self.chan)
@@ -91,21 +90,21 @@ class TriviaState(object):
                        revealloc = findnth(''.join(self.hintstr), '*', revealcount)
                        self.revealpossibilities.remove(revealcount)
                        self.hintstr[revealloc] = answer[revealloc]
-               self.parent.channel(self.chan).bot.msg(self.chan, "Here's a hint: %s" % (''.join(self.hintstr)))
+               self.parent.channel(self.chan).bot.msg(self.chan, "\00304,01Here's a hint: %s" % (''.join(self.hintstr)))
 
                self.hintsgiven += 1
 
-               if hintnum < HINTNUM:
-                       self.steptimer = threading.Timer(HINTTIMER, self.nexthint, args=[hintnum+1])
+               if hintnum < self.db['hintnum']:
+                       self.steptimer = threading.Timer(self.db['hinttimer'], self.nexthint, args=[hintnum+1])
                        self.steptimer.start()
                else:
-                       self.steptimer = threading.Timer(HINTTIMER, self.nextquestion, args=[True])
+                       self.steptimer = threading.Timer(self.db['hinttimer'], self.nextquestion, args=[True])
                        self.steptimer.start()
 
        def doGameOver(self):
-               def msg(line): self.getbot().msg(self.getchan(), line)
+               msg = self.getchan().msg
                def person(num): return self.db['users'][self.db['ranks'][num]]['realnick']
-               def pts(num): return self.db['users'][self.db['ranks'][num]]['points']
+               def pts(num): return str(self.db['users'][self.db['ranks'][num]]['points'])
                winner = person(0)
                try:
                        msg("\00312THE GAME IS OVER!!!")
@@ -116,25 +115,76 @@ class TriviaState(object):
                except IndexError: pass
                except Exception as e: msg("DERP! %r" % (e))
 
+               if self.db['hofpath'] is not None and self.db['hofpath'] != '':
+                       self.writeHof()
+
                self.db['users'] = {}
                self.db['ranks'] = []
                stop()
                self.closeshop()
 
-               if hastwitter:
+               try:
                        t = twitter.Twitter(auth=twitter.OAuth(self.getbot().parent.cfg.get('trivia', 'token'),
                                self.getbot().parent.cfg.get('trivia', 'token_sec'),
                                self.getbot().parent.cfg.get('trivia', 'con'),
                                self.getbot().parent.cfg.get('trivia', 'con_sec')))
                        t.statuses.update(status="Round is over! The winner was %s" % (winner))
+               except: pass #don't care if errors happen updating twitter.
+
+               self.__init__(self.questionfile, self.parent, True)
+
+       def writeHof(self):
+               def person(num):
+                       try: return self.db['users'][self.db['ranks'][num]]['realnick']
+                       except: return "none"
+               def pts(num):
+                       try: return str(self.db['users'][self.db['ranks'][num]]['points'])
+                       except: return 0
+
+               try:
+                       f = open(self.db['hofpath'], 'rb+')
+                       for i in range(self.db['hoflines']): #skip this many lines
+                               f.readline()
+                       insertpos = f.tell()
+                       fcontents = f.read()
+                       f.seek(insertpos)
+                       f.write((self.db['hofformat']+"\n") % {
+                               'date': time.strftime("%F", time.gmtime()),
+                               'duration': str(datetime.timedelta(seconds=time.time()-self.db['starttime'])),
+                               'targetscore': self.db['target'],
+                               'firstperson': person(0),
+                               'firstscore': pts(0),
+                               'secondperson': person(1),
+                               'secondscore': pts(1),
+                               'thirdperson': person(2),
+                               'thirdscore': pts(2),
+                       })
+                       f.write(fcontents)
+                       return True
+               except Exception as e:
+                       raise e
+                       return False
+               finally:
+                       f.close()
+
+       def endPointVote(self):
+               self.getchan().msg("Voting has ended!")
+               votelist = sorted(self.voteamounts.items(), key=lambda item: item[1]) #sort into list of tuples: [(option, number_of_votes), ...]
+               for i in range(len(votelist)-1):
+                       item = votelist[i]
+                       self.getchan().msg("%s place: %s (%s votes)" % (len(votelist)-i, item[0], item[1]))
+               self.getchan().msg("Aaaaand! The next round will be to \002%s\002 points! (%s votes)" % (votelist[-1][0], votelist[-1][1]))
 
-               self.__init__(self.questionfile, self.parent)
+               self.db['target'] = votelist[-1][0]
+               self.pointvote = None
+
+               self.nextquestion() #start the game!
 
        def nextquestion(self, qskipped=False, iteration=0):
                if self.gameover == True:
                        return self.doGameOver()
                if qskipped:
-                       self.getbot().msg(self.getchan(), "Fail! The correct answer was: %s" % (self.hintanswer))
+                       self.getchan().msg("\00304Fail! The correct answer was: %s" % (self.hintanswer))
                        self.missedquestions += 1
                else:
                        self.missedquestions = 0
@@ -147,7 +197,7 @@ class TriviaState(object):
                self.revealpossibilities = None
                self.reveal = None
 
-               if self.missedquestions > MAXMISSEDQUESTIONS:
+               if self.missedquestions > self.db['maxmissedquestions']:
                        stop()
                        self.getbot().msg(self.getchan(), "%d questions unanswered! Stopping the game.")
 
@@ -166,10 +216,10 @@ class TriviaState(object):
 
                nextq['answer'] = nextq['answer'].lower()
 
-               qtext = "\00300,01Next up: "
+               qtext = "\00304,01Next up: "
                qary = nextq['question'].split(None)
                for qword in qary:
-                       qtext += "\00300,01"+qword+"\00301,01"+chr(random.randrange(32,126))
+                       qtext += "\00304,01"+qword+"\00301,01"+chr(random.randrange(0x61,0x7A)) #a-z
                self.getbot().msg(self.chan, qtext)
 
                self.curq = nextq
@@ -177,7 +227,7 @@ class TriviaState(object):
                if isinstance(self.curq['answer'], basestring): self.hintanswer = self.curq['answer']
                else: self.hintanswer = random.choice(self.curq['answer'])
 
-               self.steptimer = threading.Timer(HINTTIMER, self.nexthint, args=[1])
+               self.steptimer = threading.Timer(self.db['hinttimer'], self.nexthint, args=[1])
                self.steptimer.start()
 
        def checkanswer(self, answer):
@@ -188,16 +238,19 @@ class TriviaState(object):
                else: # assume it's a list or something.
                        return answer.lower() in self.curq['answer']
 
-       def addpoint(self, _user, count=1):
-               _user = str(_user)
-               user = _user.lower()
+       def addpoint(self, user_obj, count=1):
+               user_nick = str(user_obj)
+               user = user_nick.lower() # save this separately as we use both
                if user in self.db['users']:
                        self.db['users'][user]['points'] += count
                else:
-                       self.db['users'][user] = {'points': count, 'realnick': _user, 'rank': len(self.db['ranks'])}
+                       self.db['users'][user] = {'points': count, 'realnick': user_nick, 'rank': len(self.db['ranks'])}
                        self.db['ranks'].append(user)
 
-               state.db['ranks'].sort(key=lambda nick: state.db['users'][nick]['points'], reverse=True)
+               self.db['ranks'].sort(key=lambda nick: state.db['users'][nick]['points'], reverse=True) #re-sort ranks, rather than dealing with anything more efficient
+               for i in range(0, len(self.db['ranks'])):
+                       nick = self.db['ranks'][i]
+                       self.db['users'][nick]['rank'] = i
 
                if self.db['users'][user]['points'] >= state.db['target']:
                        self.gameover = True
@@ -249,9 +302,9 @@ state = TriviaState("/home/jrunyon/erebus/modules/trivia.json") #TODO get path f
 def trivia_checkanswer(bot, user, chan, *args):
        line = ' '.join([str(arg) for arg in args])
        if state.checkanswer(line):
-               bot.msg(chan, "\00308%s\003 has it! The answer was \00308%s\003. New score: %d. Rank: %d. Target: %s (%s)." % (user, line, state.addpoint(user), state.rank(user), state.targetuser(user), state.targetpoints(user)))
+               bot.msg(chan, "\00312%s\003 has it! The answer was \00312%s\003. New score: %d. Rank: %d. Target: %s (%s)." % (user, line, state.addpoint(user), state.rank(user), state.targetuser(user), state.targetpoints(user)))
                if state.hintsgiven == 0:
-                       bot.msg(chan, "\00308%s\003 got an extra point for getting it before the hints! New score: %d." % (user, state.addpoint(user)))
+                       bot.msg(chan, "\00312%s\003 got an extra point for getting it before the hints! New score: %d." % (user, state.addpoint(user)))
                state.nextquestion()
 
 @lib.hook('points', needchan=False)
@@ -298,12 +351,15 @@ def cmd_start(bot, user, chan, realtarget, *args):
        if chan == realtarget: replyto = chan
        else: replyto = user
 
-       if state.curq is None:
+       if state.curq is None and state.pointvote is None:
                state.nextquestion()
+       elif state.pointvote is not None:
+               bot.msg(replyto, "There's a vote in progress!")
        else:
                bot.msg(replyto, "Game is already started!")
 
-@lib.hook('stop', clevel=lib.KNOWN, needchan=False)
+#FIXME @lib.hook('stop', clevel=lib.KNOWN, needchan=False)
+@lib.hook('stop', needchan=False) #FIXME
 def cmd_stop(bot, user, chan, realtarget, *args):
        if stop():
                bot.msg(state.chan, "Game stopped by %s" % (user))
@@ -347,24 +403,108 @@ def cmd_settarget(bot, user, chan, realtarget, *args):
        try:
                state.db['target'] = int(args[0])
                bot.msg(state.db['chan'], "Target has been changed to %s points!" % (state.db['target']))
-       except:
+
+               if state.pointvote is not None:
+                       state.pointvote.cancel()
+                       state.pointvote = None
+                       bot.msg(state.db['chan'], "Vote has been cancelled!")
+       except Exception as e:
+               print e
                bot.msg(user, "Failed to set target.")
 
+@lib.hook('vote', needchan=False)
+def cmd_vote(bot, user, chan, realtarget, *args):
+       if state.pointvote is not None:
+               if int(args[0]) in state.voteamounts:
+                       state.voteamounts[int(args[0])] += 1
+                       bot.msg(user, "Your vote has been recorded.")
+               else:
+                       bot.msg(user, "Sorry - that's not an option!")
+       else:
+               bot.msg(user, "There's no vote in progress.")
+
+@lib.hook('maxmissed', clevel=lib.MASTER, needchan=False)
+def cmd_maxmissed(bot, user, chan, realtarget, *args):
+       try:
+               state.db['maxmissedquestions'] = int(args[0])
+               bot.msg(state.db['chan'], "Max missed questions before round ends has been changed to %s." % (state.db['maxmissedquestions']))
+       except:
+               bot.msg(user, "Failed to set maxmissed.")
+
+@lib.hook('hinttimer', clevel=lib.MASTER, needchan=False)
+def cmd_hinttimer(bot, user, chan, realtarget, *args):
+       try:
+               state.db['hinttimer'] = float(args[0])
+               bot.msg(state.db['chan'], "Time between hints has been changed to %s." % (state.db['hinttimer']))
+       except:
+               bot.msg(user, "Failed to set hint timer.")
+
+@lib.hook('hintnum', clevel=lib.MASTER, needchan=False)
+def cmd_hintnum(bot, user, chan, realtarget, *args):
+       try:
+               state.db['hintnum'] = int(args[0])
+               bot.msg(state.db['chan'], "Max number of hints has been changed to %s." % (state.db['hintnum']))
+       except:
+               bot.msg(user, "Failed to set hintnum.")
+
+@lib.hook('findq', clevel=lib.KNOWN, needchan=False)
+def cmd_findquestion(bot, user, chan, realtarget, *args):
+       matches = [str(i) for i in range(len(state.db['questions'])) if state.db['questions'][i]['question'] == ' '.join(args)] #FIXME: looser equality check
+       if len(matches) > 1:
+               bot.msg(user, "Multiple matches: %s" % (', '.join(matches)))
+       elif len(matches) == 1:
+               bot.msg(user, "One match: %s" % (matches[0]))
+       else:
+               bot.msg(user, "No match.")
+
+@lib.hook('delq', clevel=lib.OP, needchan=False)
+@lib.hook('deleteq', clevel=lib.OP, needchan=False)
+def cmd_deletequestion(bot, user, chan, realtarget, *args):
+       try:
+               backup = state.db['questions'][int(args[0])]
+               del state.db['questions'][int(args[0])]
+               bot.msg(user, "Deleted %s*%s" % (backup['question'], backup['answer']))
+       except:
+               bot.msg(user, "Couldn't delete that question.")
+
+@lib.hook('addq', clevel=lib.OP, needchan=False)
+def cmd_addquestion(bot, user, chan, realtarget, *args):
+       line = ' '.join([str(arg) for arg in args])
+       linepieces = line.split('*')
+       if len(linepieces) < 2:
+               bot.msg(user, "Error: need <question>*<answer>")
+               return
+       question = linepieces[0].strip()
+       answer = linepieces[1].strip()
+       state.db['questions'].append({'question':question,'answer':answer})
+       bot.msg(user, "Done. Question is #%s" % (len(state.db['questions'])-1))
+
+
 @lib.hook('triviahelp', needchan=False)
 def cmd_triviahelp(bot, user, chan, realtarget, *args):
-       bot.msg(user, "POINTS [<user>]")
-       bot.msg(user, "START")
-       bot.msg(user, "RANK [<user>]")
-       bot.msg(user, "TOP10")
-
+       bot.msg(user,             "START")
+       bot.msg(user,             "TOP10")
+       bot.msg(user,             "POINTS    [<user>]")
+       bot.msg(user,             "RANK      [<user>]")
        if bot.parent.channel(state.db['chan']).levelof(user.auth) >= lib.KNOWN:
-               bot.msg(user, "SKIP                      (>=KNOWN )")
-               bot.msg(user, "STOP                      (>=KNOWN )")
+               bot.msg(user,         "SKIP                        (>=KNOWN )")
+               bot.msg(user,         "STOP                        (>=KNOWN )")
+               bot.msg(user,         "FINDQ     <question>     (>=KNOWN )")
                if bot.parent.channel(state.db['chan']).levelof(user.auth) >= lib.OP:
-                       bot.msg(user, "GIVE <user> [<points>]    (>=OP    )")
-                       bot.msg(user, "SETNEXT <q>*<a>           (>=OP    )")
+                       bot.msg(user,     "GIVE      <user> [<points>] (>=OP    )")
+                       bot.msg(user,     "SETNEXT   <q>*<a>           (>=OP    )")
+                       bot.msg(user,     "ADDQ      <q>*<a>           (>=OP    )")
+                       bot.msg(user,     "DELETEQ   <q>*<a>           (>=OP    )  [aka DELQ]")
                        if bot.parent.channel(state.db['chan']).levelof(user.auth) >= lib.MASTER:
-                               bot.msg(user, "SETTARGET <points>        (>=MASTER)")
+                               bot.msg(user, "SETTARGET <points>          (>=MASTER)")
+                               bot.msg(user, "MAXMISSED <questions>       (>=MASTER)")
+                               bot.msg(user, "HINTTIMER <float seconds>   (>=MASTER)")
+                               bot.msg(user, "HINTNUM   <hints>           (>=MASTER)")
+
+@lib.hooknum(417)
+def num_417(bot, textline):
+       bot.msg(state.db['chan'], "Whoops, it looks like that question didn't quite go through! (E:417). Let's try another...")
+       state.nextquestion(False)
 
 
 def specialQuestion(oldq):
@@ -373,7 +513,7 @@ def specialQuestion(oldq):
 
        if qtype == "!MONTH":
                newq['question'] = "What month is it currently (in UTC)?"
-               newq['answer'] = time.strftime("%B").lower()
+               newq['answer'] = time.strftime("%B", time.gmtime()).lower()
        elif qtype == "!MATH+":
                randnum1 = random.randrange(0, 11)
                randnum2 = random.randrange(0, 11)