]> jfr.im git - erebus.git/blobdiff - modules/trivia.py
help - make response format match for cmd list vs single cmd
[erebus.git] / modules / trivia.py
index 4adff017aaf4762eea2df2bb5064398dbe3fdc39..61997905b36fb1e663411dc5e5a2d2db3a2ba786 100644 (file)
@@ -53,8 +53,9 @@ def pts(num):
                return str(state.db['users'][state.db['ranks'][num]]['points'])
        except IndexError:
                return 0
+
 def country(num, default="??"):
-       return lib.mod('userinfo')._get(person(num), 'country', default=default)
+       return lib.mod('userinfo')._get(person(num), 'country', default=default).upper()
 
 class MyTimer(threading._Timer):
        def __init__(self, *args, **kwargs):
@@ -105,6 +106,9 @@ class TriviaState(object):
                        if isinstance(self.nextquestiontimer, threading._Timer):
                                self.nextquestiontimer.cancel()
                                self.nextquestiontimer = None
+               self.savedb()
+
+       def savedb(self):
                if json is not None and json.dump is not None:
                        json.dump(self.db, open(self.questionfile, "w"))#, indent=4, separators=(',', ': '))
 
@@ -117,16 +121,19 @@ class TriviaState(object):
                answer = self.hintanswer
 
                if self.hintstr is None or self.revealpossibilities is None or self.reveal is None:
+                       oldhintstr = ""
                        self.hintstr = list(re.sub(r'[a-zA-Z0-9]', '*', answer))
                        self.revealpossibilities = range(''.join(self.hintstr).count('*'))
-                       self.reveal = int(''.join(self.hintstr).count('*') * (7/24.0))
+                       self.reveal = int(round(''.join(self.hintstr).count('*') * (7/24.0)))
+               else:
+                       oldhintstr = ''.join(self.hintstr)
 
                for i in range(self.reveal):
                        revealcount = random.choice(self.revealpossibilities)
                        revealloc = findnth(''.join(self.hintstr), '*', revealcount)
                        self.revealpossibilities.remove(revealcount)
                        self.hintstr[revealloc] = answer[revealloc]
-               self.parent.channel(self.chan).bot.fastmsg(self.chan, "\00304,01Here's a hint: %s" % (''.join(self.hintstr)))
+               if oldhintstr != ''.join(self.hintstr): self.getchan().fastmsg("\00304,01Here's a hint: %s" % (''.join(self.hintstr)))
 
                self.hintsgiven += 1
 
@@ -147,7 +154,8 @@ class TriviaState(object):
                        msg("3RD PLACE: %s (%s)" % (person(2, True), pts(2)))
                        [msg("%dth place: %s (%s)" % (i+1, person(i, True), pts(i))) for i in range(3,10)]
                except IndexError: pass
-               except Exception as e: msg("DERP! %r" % (e))
+               except Exception as e:
+                       msg("DERP! %r" % (e))
 
                self.db['lastwinner'] = winner
                self.db['lastwon'] = time.time()
@@ -178,6 +186,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
@@ -197,12 +206,12 @@ class TriviaState(object):
                                'thirdscore': pts(2),
                        })
                        f.write(fcontents)
-                       return True
+                       status = True
                except Exception as e:
-                       raise e
-                       return False
+                       status = False
                finally:
                        f.close()
+                       return status
 
        def endPointVote(self):
                self.getchan().msg("Voting has ended!")
@@ -273,7 +282,10 @@ class TriviaState(object):
                else:
                        nextq.append(time.time())
 
-               nextq[1] = nextq[1].lower()
+               if isinstance(nextq[1], basestring):
+                       nextq[1] = nextq[1].lower()
+               else:
+                       nextq[1] = [s.lower() for s in nextq[1]]
 
                qtext = "\00312,01Next up: "
                qtext += "(%5d)" % (random.randint(0,99999))
@@ -365,12 +377,16 @@ def trivia_checkanswer(bot, user, chan, *args):
        line = ' '.join([str(arg) for arg in args])
        if state.checkanswer(line):
                state.curq = None
-               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)))
+               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)))
+               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)))
                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(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
@@ -381,6 +397,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]
@@ -393,6 +410,8 @@ 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])
@@ -406,6 +425,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])
@@ -419,10 +439,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
@@ -440,28 +462,30 @@ 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))
        else:
                bot.msg(user, "Game isn't running.")
 
-@lib.hook('exception')
-def cmd_exception(*args, **kwargs):
-       raise Exception()
-
 def stop():
        state.curq = None
        state.nextq = None
-       try: state.steptimer.cancel()
-       except Exception as e: print "!!! steptimer.cancel(): %s %r" % (e,e)
+       try:
+               state.steptimer.cancel()
+       except Exception as e:
+               print "!!! steptimer.cancel(): %s %r" % (e,e)
        state.steptimer = None
-       try: state.nextquestiontimer.cancel()
-       except Exception as e: print "!!! nextquestiontimer.cancel(): %s %r" % (e,e)
+       try:
+               state.nextquestiontimer.cancel()
+       except Exception as e:
+               print "!!! nextquestiontimer.cancel(): %s %r" % (e,e)
        state.nextquestiontimer = None
        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
@@ -469,9 +493,11 @@ def badq(bot, user, chan, realtarget, *args):
 
        reason = ' '.join(args)
        state.db['badqs'].append([lastqid, curqid, reason])
+       state.savedb()
        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.")
@@ -490,18 +516,26 @@ 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):
-       qid = int(args[0])
-       del state.db['badqs'][qid]
-       bot.msg(user, "Removed report #%d" % (qid))
+       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
@@ -512,6 +546,7 @@ def rank(bot, user, chan, realtarget, *args):
        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)))
 
 @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!")
@@ -519,10 +554,11 @@ def top10(bot, user, chan, realtarget, *args):
        max = len(state.db['ranks'])
        if max > 10:
                max = 10
-       replylist = ', '.join(["%s (%s) %s" % (person(x), country(x, "unknown"), pts(x)) for x in range(max)])
+       replylist = ', '.join(["%s (%s) %s" % (person(x), country(x), pts(x)) for x in range(max)])
        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])
@@ -537,6 +573,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:
@@ -548,6 +585,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])
@@ -556,6 +594,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])
@@ -564,6 +603,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])
@@ -572,6 +612,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])
@@ -580,12 +621,29 @@ 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):
+       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]
+       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(glevel=1, needchan=False)
+@lib.help("<regex>", "finds a qid given a regex or partial question")
+def findqre(bot, user, chan, realtarget, *args):
        if len(args) == 0:
                bot.msg(user, "You need to specify a search string.")
                return
 
-       searcher = re.compile(' '.join(args))
+       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]
        if len(matches) > 25:
                bot.msg(user, "Too many matches! (>25)")
@@ -596,16 +654,34 @@ def findq(bot, user, chan, realtarget, *args):
        else:
                bot.msg(user, "No match.")
 
+@lib.hook(glevel=lib.STAFF, needchan=False)
+@lib.help("<qid>", "displays the q*a for a qid")
+def showq(bot, user, chan, realtarget, *args):
+       try:
+               qid = int(args[0])
+       except:
+               bot.msg(user, "Specify a numeric question ID.")
+               return
+       try:
+               q = state.db['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("<qid>", "removes a question from the database")
 def delq(bot, user, chan, realtarget, *args):
        try:
                backup = state.db['questions'][int(args[0])]
                del state.db['questions'][int(args[0])]
+               state.savedb()
                bot.msg(user, "Deleted %s*%s" % (backup[0], backup[1]))
        except:
-               bot.msg(user, "Couldn't delete that question.")
+               bot.msg(user, "Couldn't delete that question. %r" % (e))
 
 @lib.hook(glevel=lib.STAFF, needchan=False)
+@lib.help("<q>*<a>", "adds a question")
 def addq(bot, user, chan, realtarget, *args):
        line = ' '.join([str(arg) for arg in args])
        linepieces = line.split('*')
@@ -615,38 +691,42 @@ def addq(bot, user, chan, realtarget, *args):
        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))
 
 
 @lib.hook(needchan=False)
 def triviahelp(bot, user, chan, realtarget, *args):
-       bot.msg(user,             "START")
-       bot.msg(user,             "TOP10")
-       bot.msg(user,             "POINTS        [<user>]")
-       bot.msg(user,             "RANK          [<user>]")
-       bot.msg(user,             "BADQ          <reason> (include info to identify question)")
+       bot.slowmsg(user,             "START")
+       bot.slowmsg(user,             "TOP10")
+       bot.slowmsg(user,             "POINTS        [<user>]")
+       bot.slowmsg(user,             "RANK          [<user>]")
+       bot.slowmsg(user,             "BADQ          <reason> (include info to identify question)")
        if user.glevel >= 1:
-               bot.msg(user,         "SKIP                            (>=KNOWN)")
-               bot.msg(user,         "STOP                            (>=KNOWN)")
-               bot.msg(user,         "FINDQ         <question>        (>=KNOWN)")
+               bot.slowmsg(user,         "SKIP                            (KNOWN)")
+               bot.slowmsg(user,         "STOP                            (KNOWN)")
+               bot.slowmsg(user,         "FINDQ         <full question>   (KNOWN)")
+               bot.slowmsg(user,         "FINDQRE       <regex>           (KNOWN)")
+               bot.slowmsg(user,         "SETNEXTID     <qid>             (KNOWN)")
                if user.glevel >= lib.STAFF:
-                       bot.msg(user,     "GIVE          <user> [<points>] (>=STAFF)")
-                       bot.msg(user,     "SETNEXT       <q>*<a>           (>=STAFF)")
-                       bot.msg(user,     "ADDQ          <q>*<a>           (>=STAFF)")
-                       bot.msg(user,     "DELETEQ       <q>*<a>           (>=STAFF)  [aka DELQ]")
-                       bot.msg(user,     "BADQS                           (>=STAFF)")
-                       bot.msg(user,     "CLEARBADQS                      (>=STAFF)")
-                       bot.msg(user,     "DELBADQ       <reportid>        (>=STAFF)")
+                       bot.slowmsg(user,     "GIVE          <user> [<points>] (STAFF)")
+                       bot.slowmsg(user,     "SETNEXT       <q>*<a>           (STAFF)")
+                       bot.slowmsg(user,     "ADDQ          <q>*<a>           (STAFF)")
+                       bot.slowmsg(user,     "DELQ          <q>*<a>           (STAFF)  [aka DELETEQ]")
+                       bot.slowmsg(user,     "SHOWQ         <qid>             (STAFF)")
+                       bot.slowmsg(user,     "BADQS                           (STAFF)")
+                       bot.slowmsg(user,     "CLEARBADQS                      (STAFF)")
+                       bot.slowmsg(user,     "DELBADQ       <reportid>        (STAFF)")
                        if user.glevel >= lib.ADMIN:
-                               bot.msg(user, "SETTARGET     <points>          (>=ADMIN)")
-                               bot.msg(user, "MAXMISSED     <questions>       (>=ADMIN)")
-                               bot.msg(user, "HINTTIMER     <float seconds>   (>=ADMIN)")
-                               bot.msg(user, "HINTNUM       <hints>           (>=ADMIN)")
-                               bot.msg(user, "QUESTIONPAUSE <float seconds>   (>=ADMIN)")
+                               bot.slowmsg(user, "SETTARGET     <points>          (ADMIN)")
+                               bot.slowmsg(user, "MAXMISSED     <questions>       (ADMIN)")
+                               bot.slowmsg(user, "HINTTIMER     <float seconds>   (ADMIN)")
+                               bot.slowmsg(user, "HINTNUM       <hints>           (ADMIN)")
+                               bot.slowmsg(user, "QUESTIONPAUSE <float seconds>   (ADMIN)")
 
 @lib.hooknum(417)
 def num_417(bot, textline):
-       bot.fastmsg(state.db['chan'], "Whoops, it looks like that question didn't quite go through! (E:417). Let's try another...")
+#      bot.fastmsg(state.db['chan'], "Whoops, it looks like that question didn't quite go through! (E:417). Let's try another...")
        state.nextquestion(qskipped=False, skipwait=True)
 
 @lib.hooknum(332)