]> jfr.im git - erebus.git/blobdiff - modules/trivia.py
add watchdog timer. fixes #12
[erebus.git] / modules / trivia.py
index 3e2b093f481aaeb15f7a26eae1bd588c3ba46b4f..cb77be77d990a2388e03415ed6b0b1b1e74f8379 100644 (file)
@@ -6,8 +6,9 @@
 modinfo = {
        'author': 'Erebus Team',
        'license': 'public domain',
-       'compatible': [1], # compatible module API versions
-       'depends': ['userinfo'], # other modules required to work properly?
+       'compatible': [1,2],
+       'depends': ['userinfo'],
+       'softdeps': ['help'],
 }
 
 # preamble
@@ -27,7 +28,7 @@ def modstop(*args, **kwargs):
        return lib.modstop(*args, **kwargs)
 
 # module code
-import json, random, threading, re, time, datetime
+import json, random, threading, re, time, datetime, os
 
 try:
        import twitter
@@ -71,6 +72,7 @@ class TriviaState(object):
                self.parent              = parent
                self.questionfile        = self.parent.cfg.get('trivia', 'jsonpath', default="./modules/trivia.json")
                self.db                  = json.load(open(self.questionfile, "r"))
+               self.questions           = self.db['questions'][self.db['category']]
                self.chan                = self.db['chan']
                self.curq                = None
                self.nextq               = None
@@ -100,17 +102,36 @@ class TriviaState(object):
        def __del__(self):
                self.closeshop()
        def closeshop(self):
-               if threading is not None and threading._Timer is not None:
-                       if isinstance(self.steptimer, threading._Timer):
-                               self.steptimer.cancel()
-                       if isinstance(self.nextquestiontimer, threading._Timer):
-                               self.nextquestiontimer.cancel()
-                               self.nextquestiontimer = None
-               self.savedb()
+               try:
+                       self.steptimer.cancel()
+                       self.steptimer = None
+               except: pass
+               try:
+                       self.nextquestiontimer.cancel()
+                       self.nextquestiontimer = None
+               except: pass
 
-       def savedb(self):
+       def savedb(self): #returns whether or not it was able to save
                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=(',', ': '))
+                       dbjson = json.dumps(self.db)
+                       if len(dbjson) > 0:
+                               os.rename(self.questionfile, self.questionfile+".auto.bak")
+                               tmpfn = os.tempnam('.', 'trivia')
+                               try:
+                                       f = open(tmpfn, "w")
+                                       f.write(dbjson)
+                                       f.close()
+                                       os.rename(tmpfn, self.questionfile)
+                                       return True
+                               except: #if something happens, restore the backup
+                                       os.rename(self.questionfile+".auto.bak", self.questionfile)
+                                       try:
+                                               os.unlink(tmpfn)
+                                       except OSError: # temp file is already gone
+                                               pass
+                                       raise # we may be better off just swallowing exceptions?
+               return False
 
        def getchan(self):
                return self.parent.channel(self.chan)
@@ -186,6 +207,7 @@ class TriviaState(object):
                        try: return str(self.db['users'][self.db['ranks'][num]]['points'])
                        except: return 0
 
+               status = False
                try:
                        f = open(self.db['hofpath'], 'rb+')
                        for i in range(self.db['hoflines']): #skip this many lines
@@ -205,12 +227,12 @@ class TriviaState(object):
                                'thirdscore': pts(2),
                        })
                        f.write(fcontents)
-                       return True
+                       status = True
                except Exception as e:
-                       raise e #FIXME wtf???
-                       return False
+                       status = False
                finally:
                        f.close()
+                       return status
 
        def endPointVote(self):
                self.getchan().msg("Voting has ended!")
@@ -239,9 +261,9 @@ class TriviaState(object):
                        if 'topicformat' in self.db and self.db['topicformat'] is not None:
                                self.getbot().conn.send("TOPIC %s" % (self.db['chan']))
 
-               if isinstance(self.steptimer, threading._Timer):
+               if isinstance(self.steptimer, MyTimer):
                        self.steptimer.cancel()
-               if isinstance(self.nextquestiontimer, threading._Timer):
+               if isinstance(self.nextquestiontimer, MyTimer):
                        self.nextquestiontimer.cancel()
                        self.nextquestiontimer = None
 
@@ -250,6 +272,8 @@ class TriviaState(object):
                self.revealpossibilities = None
                self.reveal = None
 
+               self.savedb()
+
                if self.missedquestions > self.db['maxmissedquestions']:
                        stop()
                        self.getbot().msg(self.getchan(), "%d questions unanswered! Stopping the game." % (self.missedquestions))
@@ -267,8 +291,8 @@ class TriviaState(object):
                        nextq = self.nextq
                        self.nextq = None
                else:
-                       nextqid = random.randrange(0, len(self.db['questions']))
-                       nextq = self.db['questions'][nextqid]
+                       nextqid = random.randrange(0, len(self.questions))
+                       nextq = self.questions[nextqid]
 
                if nextq[0][0] == "!":
                        nextqid = None
@@ -291,7 +315,10 @@ class TriviaState(object):
                qary = nextq[0].split(None)
                qtext += " "
                for qword in qary:
-                       qtext += "\00304,01"+qword+"\00301,01"+chr(random.randrange(0x61,0x7A)) #a-z
+                       spacer = random.choice(
+                               range(0x61,0x7A) + ([0x20]*4)
+                       )
+                       qtext += "\00304,01"+qword+"\00301,01"+chr(spacer) #a-z
                self.getbot().fastmsg(self.chan, qtext)
 
                self.curq = nextq
@@ -363,11 +390,11 @@ class TriviaState(object):
                if user in self.db['users']:
                        rank = self.db['users'][user]['rank']
                        if rank == 0:
-                               return "N/A"
+                               return ""
                        else:
-                               return self.db['users'][self.db['ranks'][rank-1]]['points']
+                               return "("+str(self.db['users'][self.db['ranks'][rank-1]]['points'])+")"
                else:
-                       return self.db['users'][self.db['ranks'][-1]]['points']
+                       return "("+str(self.db['users'][self.db['ranks'][-1]]['points'])+")"
 
 state = TriviaState()
 
@@ -377,14 +404,26 @@ def trivia_checkanswer(bot, user, chan, *args):
        if state.checkanswer(line):
                state.curq = None
                if state.hintanswer.lower() == line.lower():
-                       bot.fastmsg(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)))
+                       bot.fastmsg(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)))
                else:
-                       bot.fastmsg(chan, "\00312%s\003 has it! The answer was \00312%s\003 (hinted answer: %s). New score: %d. Rank: %d. Target: %s (%s)." % (user, line, state.hintanswer, state.addpoint(user), state.rank(user), state.targetuser(user), state.targetpoints(user)))
+                       bot.fastmsg(chan, "\00312%s\003 has it! The answer was \00312%s\003 (hinted answer: %s). New score: %d. Rank: %d. Target: %s%s" % (user, line, state.hintanswer, state.addpoint(user), state.rank(user), state.targetuser(user), state.targetpoints(user)))
                if state.hintsgiven == 0:
                        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(glevel=1, needchan=False)
+@lib.help(None, "saves the trivia database")
+def save(bot, user, chan, realtarget, *args):
+       if chan is not None and realtarget == chan.name: replyto = chan
+       else: replyto = user
+
+       if state.savedb():
+               bot.msg(replyto, "Save successful.")
+       else:
+               bot.msg(replyto, "Save failed!")
+
 @lib.hook(needchan=False)
+@lib.help("[<user>]", "shows how many points you or someone has")
 def points(bot, user, chan, realtarget, *args):
        if chan is not None and realtarget == chan.name: replyto = chan
        else: replyto = user
@@ -395,6 +434,7 @@ def points(bot, user, chan, realtarget, *args):
        bot.msg(replyto, "%s has %d points." % (who, state.points(who)))
 
 @lib.hook(glevel=lib.STAFF, needchan=False)
+@lib.help("<user> [<amount>]", "gives someone points", "defaults to 1 point")
 @lib.argsGE(1)
 def give(bot, user, chan, realtarget, *args):
        whoto = args[0]
@@ -407,10 +447,12 @@ def give(bot, user, chan, realtarget, *args):
        bot.msg(chan, "%s gave %s %d points. New balance: %d" % (user, whoto, numpoints, balance))
 
 @lib.hook(glevel=1, needchan=False)
+@lib.help("<qid>", "sets next question to one in the database")
+@lib.argsEQ(1)
 def setnextid(bot, user, chan, realtarget, *args):
        try:
                qid = int(args[0])
-               state.nextq = state.db['questions'][qid]
+               state.nextq = state.questions[qid]
                if user.glevel >= lib.STAFF:
                        respstr = "Done. Next question is: %s" % (state.nextq[0])
                else:
@@ -420,6 +462,7 @@ def setnextid(bot, user, chan, realtarget, *args):
                bot.msg(user, "Error: %s" % (e))
 
 @lib.hook(glevel=lib.STAFF, needchan=False)
+@lib.help("<q>*<a>", "sets next question to one not in database")
 @lib.argsGE(1)
 def setnext(bot, user, chan, realtarget, *args):
        line = ' '.join([str(arg) for arg in args])
@@ -433,10 +476,12 @@ def setnext(bot, user, chan, realtarget, *args):
        bot.msg(user, "Done.")
 
 @lib.hook(glevel=1, needchan=False)
+@lib.help(None, "skips to next question")
 def skip(bot, user, chan, realtarget, *args):
        state.nextquestion(qskipped=True, skipwait=True)
 
 @lib.hook(needchan=False)
+@lib.help(None, "starts the trivia game")
 def start(bot, user, chan, realtarget, *args):
        if chan is not None and realtarget == chan.name: replyto = chan
        else: replyto = user
@@ -454,6 +499,7 @@ def start(bot, user, chan, realtarget, *args):
                bot.msg(user, "Game is already started!")
 
 @lib.hook('stop', glevel=1, needchan=False)
+@lib.help(None, "stops the trivia game")
 def cmd_stop(bot, user, chan, realtarget, *args):
        if stop():
                bot.msg(state.chan, "Game stopped by %s" % (user))
@@ -476,17 +522,18 @@ def stop():
        return True
 
 @lib.hook(needchan=False)
+@lib.help("<reason>", "reports a bad question to the admins")
 @lib.argsGE(1)
 def badq(bot, user, chan, realtarget, *args):
        lastqid = state.lastqid
        curqid = state.curqid
 
        reason = ' '.join(args)
-       state.db['badqs'].append([lastqid, curqid, reason])
-       state.savedb()
+       state.db['badqs'].append([state.db['category'], lastqid, curqid, reason])
        bot.msg(user, "Reported bad question.")
 
 @lib.hook(glevel=lib.STAFF, needchan=False)
+@lib.help(None, "shows a list of BADQ reports")
 def badqs(bot, user, chan, realtarget, *args):
        if len(state.db['badqs']) == 0:
                bot.msg(user, "No reports.")
@@ -494,10 +541,10 @@ def badqs(bot, user, chan, realtarget, *args):
        for i in range(len(state.db['badqs'])):
                try:
                        report = state.db['badqs'][i]
-                       bot.msg(user, "Report #%d: LastQ=%r CurQ=%r: %s" % (i, report[0], report[1], report[2]))
-                       try: lq = state.db['questions'][int(report[0])]
+                       bot.msg(user, "Report #%d: Cat=%s LastQ=%r CurQ=%r: %s" % (i, report[0], report[1], report[2], report[3]))
+                       try: lq = state.db['questions'][report[0]][int(report[1])]
                        except Exception as e: lq = (None,None)
-                       try: cq = state.db['questions'][int(report[1])]
+                       try: cq = state.db['questions'][report[0]][int(report[2])]
                        except Exception as e: cq = (None, None)
                        bot.msg(user, "- Last: %s*%s" % (lq[0], lq[1]))
                        bot.msg(user, "- Curr: %s*%s" % (cq[0], cq[1]))
@@ -505,23 +552,24 @@ def badqs(bot, user, chan, realtarget, *args):
                        bot.msg(user, "- Exception: %r" % (e))
 
 @lib.hook(glevel=lib.STAFF, needchan=False)
+@lib.hook(None, "clears list of BADQ reports")
 def clearbadqs(bot, user, chan, realtarget, *args):
        state.db['badqs'] = []
-       state.savedb()
        bot.msg(user, "Cleared reports.")
 
 @lib.hook(glevel=lib.STAFF, needchan=False)
+@lib.hook("<badqid>", "removes a BADQ report")
 @lib.argsEQ(1)
 def delbadq(bot, user, chan, realtarget, *args):
        try:
                qid = int(args[0])
                del state.db['badqs'][qid]
-               state.savedb()
                bot.msg(user, "Removed report #%d" % (qid))
        except:
                bot.msg(user, "Failed!")
 
 @lib.hook(needchan=False)
+@lib.help("[<user>]", "shows you or someone else's rank")
 def rank(bot, user, chan, realtarget, *args):
        if chan is not None and realtarget == chan.name: replyto = chan
        else: replyto = user
@@ -529,9 +577,10 @@ def rank(bot, user, chan, realtarget, *args):
        if len(args) != 0: who = args[0]
        else: who = user
 
-       bot.msg(replyto, "%s is in %d place (%s points). Target is: %s (%s points)." % (who, state.rank(who), state.points(who), state.targetuser(who), state.targetpoints(who)))
+       bot.msg(replyto, "%s is in %d place (%s points). Target is: %s %s" % (who, state.rank(who), state.points(who), state.targetuser(who), state.targetpoints(who)))
 
 @lib.hook(needchan=False)
+@lib.help(None, "shows top10 list")
 def top10(bot, user, chan, realtarget, *args):
        if len(state.db['ranks']) == 0:
                return bot.msg(state.db['chan'], "No one is ranked!")
@@ -543,6 +592,7 @@ def top10(bot, user, chan, realtarget, *args):
        bot.msg(state.db['chan'], "Top 10: %s" % (replylist))
 
 @lib.hook(glevel=lib.ADMIN, needchan=False)
+@lib.help("<target score>", "changes the target score for this round")
 def settarget(bot, user, chan, realtarget, *args):
        try:
                state.db['target'] = int(args[0])
@@ -557,6 +607,7 @@ def settarget(bot, user, chan, realtarget, *args):
                bot.msg(user, "Failed to set target.")
 
 @lib.hook(needchan=False)
+@lib.help("<option>", "votes for a trarget score for next round")
 def vote(bot, user, chan, realtarget, *args):
        if state.pointvote is not None:
                if int(args[0]) in state.voteamounts:
@@ -568,6 +619,7 @@ def vote(bot, user, chan, realtarget, *args):
                bot.msg(user, "There's no vote in progress.")
 
 @lib.hook(glevel=lib.ADMIN, needchan=False)
+@lib.help("<number>", "sets the max missed question before game stops")
 def maxmissed(bot, user, chan, realtarget, *args):
        try:
                state.db['maxmissedquestions'] = int(args[0])
@@ -576,6 +628,7 @@ def maxmissed(bot, user, chan, realtarget, *args):
                bot.msg(user, "Failed to set maxmissed.")
 
 @lib.hook(glevel=lib.ADMIN, needchan=False)
+@lib.help("<seconds>", "sets the time between hints")
 def hinttimer(bot, user, chan, realtarget, *args):
        try:
                state.db['hinttimer'] = float(args[0])
@@ -584,6 +637,7 @@ def hinttimer(bot, user, chan, realtarget, *args):
                bot.msg(user, "Failed to set hint timer.")
 
 @lib.hook(glevel=lib.ADMIN, needchan=False)
+@lib.help("<number>", "sets the number of hints given")
 def hintnum(bot, user, chan, realtarget, *args):
        try:
                state.db['hintnum'] = int(args[0])
@@ -592,6 +646,7 @@ def hintnum(bot, user, chan, realtarget, *args):
                bot.msg(user, "Failed to set hintnum.")
 
 @lib.hook(glevel=lib.ADMIN, needchan=False)
+@lib.help("<seconds>", "sets the pause between questions")
 def questionpause(bot, user, chan, realtarget, *args):
        try:
                state.db['questionpause'] = float(args[0])
@@ -600,13 +655,21 @@ def questionpause(bot, user, chan, realtarget, *args):
                bot.msg(user, "Failed to set questionpause.")
 
 @lib.hook(glevel=1, needchan=False)
+@lib.help("<full question>", "finds a qid given a complete question")
 def findq(bot, user, chan, realtarget, *args):
+       args = list(args)
+       if args[0][0] == "@":
+               cat = args.pop(0)[1:].lower()
+               questions = state.db['questions'][cat]
+       else:
+               questions = state.questions
+
        if len(args) == 0:
                bot.msg(user, "You need to specify the question.")
                return
 
        searchkey = ' '.join(args).lower()
-       matches = [str(i) for i in range(len(state.db['questions'])) if state.db['questions'][i][0].lower() == searchkey]
+       matches = [str(i) for i in range(len(questions)) if questions[i][0].lower() == searchkey]
        if len(matches) > 1:
                bot.msg(user, "Multiple matches: %s" % (', '.join(matches)))
        elif len(matches) == 1:
@@ -615,13 +678,21 @@ def findq(bot, user, chan, realtarget, *args):
                bot.msg(user, "No match.")
 
 @lib.hook(glevel=1, needchan=False)
+@lib.help("[@<category>] <regex>", "finds a qid given a regex or partial question")
 def findqre(bot, user, chan, realtarget, *args):
+       args = list(args)
+       if args[0][0] == "@":
+               cat = args.pop(0)[1:].lower()
+               questions = state.db['questions'][cat]
+       else:
+               questions = state.questions
+
        if len(args) == 0:
                bot.msg(user, "You need to specify a search string.")
                return
 
        searcher = re.compile(' '.join(args), re.IGNORECASE)
-       matches = [str(i) for i in range(len(state.db['questions'])) if searcher.search(state.db['questions'][i][0]) is not None]
+       matches = [str(i) for i in range(len(questions)) if searcher.search(questions[i][0]) is not None]
        if len(matches) > 25:
                bot.msg(user, "Too many matches! (>25)")
        elif len(matches) > 1:
@@ -632,31 +703,54 @@ def findqre(bot, user, chan, realtarget, *args):
                bot.msg(user, "No match.")
 
 @lib.hook(glevel=lib.STAFF, needchan=False)
+@lib.help("[@<category>] <qid>", "displays the q*a for a qid", "category defaults to current")
 def showq(bot, user, chan, realtarget, *args):
+       args = list(args)
+       if args[0][0] == "@":
+               cat = args.pop(0)[1:].lower()
+               questions = state.db['questions'][cat]
+       else:
+               questions = state.questions
+
        try:
                qid = int(args[0])
        except:
                bot.msg(user, "Specify a numeric question ID.")
                return
        try:
-               q = state.db['questions'][qid]
+               q = questions[qid]
        except:
                bot.msg(user, "ID not valid.")
                return
        bot.msg(user, "%s: %s*%s" % (qid, q[0], q[1]))
 
 @lib.hook(('delq', 'deleteq'), glevel=lib.STAFF, needchan=False)
+@lib.help("[@<category>] <qid>", "removes a question from the database")
 def delq(bot, user, chan, realtarget, *args):
+       args = list(args)
+       if args[0][0] == "@":
+               cat = args.pop(0)[1:].lower()
+               questions = state.db['questions'][cat]
+       else:
+               questions = state.questions
+
        try:
-               backup = state.db['questions'][int(args[0])]
-               del state.db['questions'][int(args[0])]
-               state.savedb()
+               backup = questions[int(args[0])]
+               del questions[int(args[0])]
                bot.msg(user, "Deleted %s*%s" % (backup[0], backup[1]))
        except:
                bot.msg(user, "Couldn't delete that question. %r" % (e))
 
 @lib.hook(glevel=lib.STAFF, needchan=False)
+@lib.help("[@<category>] <q>*<a>", "adds a question")
 def addq(bot, user, chan, realtarget, *args):
+       args = list(args)
+       if args[0][0] == "@":
+               cat = args.pop(0)[1:].lower()
+               questions = state.db['questions'][cat]
+       else:
+               questions = state.questions
+
        line = ' '.join([str(arg) for arg in args])
        linepieces = line.split('*')
        if len(linepieces) < 2:
@@ -664,10 +758,48 @@ def addq(bot, user, chan, realtarget, *args):
                return
        question = linepieces[0].strip()
        answer = linepieces[1].strip()
-       state.db['questions'].append([question, answer])
-       state.savedb()
-       bot.msg(user, "Done. Question is #%s" % (len(state.db['questions'])-1))
+       questions.append([question, answer])
+       bot.msg(user, "Done. Question is #%s" % (len(questions)-1))
 
+@lib.hook(glevel=1, needchan=False)
+@lib.help("<category>", "change category")
+def setcat(bot, user, chan, realtarget, *args):
+       category = args[0].lower()
+       if category in state.db['questions']:
+               state.db['category'] = category
+               state.questions = state.db['questions'][category]
+               bot.msg(user, "Changed category to %s" % (category))
+       else:
+               bot.msg(user, "That category doesn't exist.")
+
+@lib.hook(needchan=False)
+@lib.help(None, "list categories")
+def listcats(bot, user, chan, realtarget, *args):
+       cats = ["%s (%d)" % (c, len(state.db['questions'][c])) for c in state.db['questions'].keys()]
+       bot.msg(user, "Categories: %s" % (', '.join(cats)))
+
+@lib.hook(glevel=lib.STAFF, needchan=False)
+@lib.help("<category>", "adds an empty category")
+def addcat(bot, user, chan, realtarget, *args):
+       category = args[0].lower()
+       if category not in state.db['questions']:
+               state.db['questions'][category] = []
+               bot.msg(user, "Added category %s" % (category))
+       else:
+               bot.msg(user, "Category already exists.")
+
+@lib.hook(glevel=lib.MANAGER, needchan=False)
+@lib.help("<category>", "deletes an entire category")
+def delcat(bot, user, chan, realtarget, *args):
+       category = args[0].lower()
+       if category == state.db['category']:
+               bot.msg(user, "Category currently in use!")
+       elif category in state.db['questions']:
+               length = len(state.db['questions'][category])
+               del state.db['questions'][category]
+               bot.msg(user, "Deleted category %s (%d questions)" % (category, length))
+       else:
+               bot.msg(user, "Category does not exist.")
 
 @lib.hook(needchan=False)
 def triviahelp(bot, user, chan, realtarget, *args):
@@ -718,8 +850,8 @@ def num_TOPIC(bot, textline):
                        "%s (%s)" % (person(x), pts(x))
                        for x in range(3) if x < len(state.db['ranks'])
                ]),
-               'top3c': ' '.join([
-                       "%s (%s, %s)" % (person(x), pts(x), country(x))
+               'top3c': ', '.join([
+                       "%s (%s) %s" % (person(x), country(x), pts(x))
                        for x in range(3) if x < len(state.db['ranks'])
                ]),
                'top10': ' '.join([
@@ -750,6 +882,7 @@ def specialQuestion(oldq):
                randnum2 = random.randrange(0, 11)
                newq[0] = "What is %d + %d?" % (randnum1, randnum2)
                newq[1] = spellout(randnum1+randnum2)
+       else: pass #default to not modifying
        return newq
 
 def spellout(num):